2 * This file is part of the PulseView project.
4 * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
25 #include <boost/thread/locks.hpp>
26 #include <boost/thread/shared_mutex.hpp>
36 #include "session.hpp"
37 #include "devicemanager.hpp"
39 #include "data/analog.hpp"
40 #include "data/analogsegment.hpp"
41 #include "data/decoderstack.hpp"
42 #include "data/logic.hpp"
43 #include "data/logicsegment.hpp"
44 #include "data/signalbase.hpp"
45 #include "data/decode/decoder.hpp"
47 #include "devices/hardwaredevice.hpp"
48 #include "devices/inputfile.hpp"
49 #include "devices/sessionfile.hpp"
51 #include "toolbars/mainbar.hpp"
53 #include "view/analogsignal.hpp"
54 #include "view/decodetrace.hpp"
55 #include "view/logicsignal.hpp"
56 #include "view/signal.hpp"
57 #include "view/view.hpp"
59 #include <libsigrokcxx/libsigrokcxx.hpp>
62 #include <libsigrokdecode/libsigrokdecode.h>
65 using boost::shared_lock;
66 using boost::shared_mutex;
67 using boost::unique_lock;
70 using std::dynamic_pointer_cast;
73 using std::lock_guard;
76 using std::make_shared;
82 using std::recursive_mutex;
83 using std::runtime_error;
85 using std::shared_ptr;
87 using std::unordered_set;
91 using sigrok::Channel;
92 using sigrok::ConfigKey;
93 using sigrok::DatafeedCallbackFunction;
96 using sigrok::InputFormat;
99 using sigrok::OutputFormat;
100 using sigrok::Packet;
101 using sigrok::PacketPayload;
102 using sigrok::Session;
103 using sigrok::SessionDevice;
105 using Glib::VariantBase;
109 Session::Session(DeviceManager &device_manager, QString name) :
110 device_manager_(device_manager),
113 capture_state_(Stopped),
121 // Stop and join to the thread
125 DeviceManager& Session::device_manager()
127 return device_manager_;
130 const DeviceManager& Session::device_manager() const
132 return device_manager_;
135 shared_ptr<sigrok::Session> Session::session() const
138 return shared_ptr<sigrok::Session>();
139 return device_->session();
142 shared_ptr<devices::Device> Session::device() const
147 QString Session::name() const
152 void Session::set_name(QString name)
154 if (default_name_.isEmpty())
155 default_name_ = name;
162 const list< shared_ptr<views::ViewBase> > Session::views() const
167 shared_ptr<views::ViewBase> Session::main_view() const
172 void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
174 main_bar_ = main_bar;
177 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
182 bool Session::data_saved() const
187 void Session::save_settings(QSettings &settings) const
189 map<string, string> dev_info;
190 list<string> key_list;
191 int stacks = 0, views = 0;
194 shared_ptr<devices::HardwareDevice> hw_device =
195 dynamic_pointer_cast< devices::HardwareDevice >(device_);
198 settings.setValue("device_type", "hardware");
199 settings.beginGroup("device");
201 key_list.emplace_back("vendor");
202 key_list.emplace_back("model");
203 key_list.emplace_back("version");
204 key_list.emplace_back("serial_num");
205 key_list.emplace_back("connection_id");
207 dev_info = device_manager_.get_device_info(device_);
209 for (string key : key_list) {
210 if (dev_info.count(key))
211 settings.setValue(QString::fromUtf8(key.c_str()),
212 QString::fromUtf8(dev_info.at(key).c_str()));
214 settings.remove(QString::fromUtf8(key.c_str()));
220 shared_ptr<devices::SessionFile> sessionfile_device =
221 dynamic_pointer_cast< devices::SessionFile >(device_);
223 if (sessionfile_device) {
224 settings.setValue("device_type", "sessionfile");
225 settings.beginGroup("device");
226 settings.setValue("filename", QString::fromStdString(
227 sessionfile_device->full_name()));
231 // Save channels and decoders
232 for (shared_ptr<data::SignalBase> base : signalbases_) {
234 if (base->is_decode_signal()) {
235 shared_ptr<pv::data::DecoderStack> decoder_stack =
236 base->decoder_stack();
237 shared_ptr<data::decode::Decoder> top_decoder =
238 decoder_stack->stack().front();
240 settings.beginGroup("decoder_stack" + QString::number(stacks++));
241 settings.setValue("id", top_decoder->decoder()->id);
242 settings.setValue("name", top_decoder->decoder()->name);
247 settings.beginGroup(base->internal_name());
248 base->save_settings(settings);
253 settings.setValue("decoder_stacks", stacks);
255 // Save view states and their signal settings
256 // Note: main_view must be saved as view0
257 settings.beginGroup("view" + QString::number(views++));
258 main_view_->save_settings(settings);
261 for (shared_ptr<views::ViewBase> view : views_) {
262 if (view != main_view_) {
263 settings.beginGroup("view" + QString::number(views++));
264 view->save_settings(settings);
269 settings.setValue("views", views);
273 void Session::restore_settings(QSettings &settings)
275 shared_ptr<devices::Device> device;
277 QString device_type = settings.value("device_type").toString();
279 if (device_type == "hardware") {
280 map<string, string> dev_info;
281 list<string> key_list;
283 // Re-select last used device if possible but only if it's not demo
284 settings.beginGroup("device");
285 key_list.emplace_back("vendor");
286 key_list.emplace_back("model");
287 key_list.emplace_back("version");
288 key_list.emplace_back("serial_num");
289 key_list.emplace_back("connection_id");
291 for (string key : key_list) {
292 const QString k = QString::fromStdString(key);
293 if (!settings.contains(k))
296 const string value = settings.value(k).toString().toStdString();
298 dev_info.insert(make_pair(key, value));
301 if (dev_info.count("model") > 0)
302 device = device_manager_.find_device_from_info(dev_info);
310 if (device_type == "sessionfile") {
311 settings.beginGroup("device");
312 QString filename = settings.value("filename").toString();
315 if (QFileInfo(filename).isReadable()) {
316 device = make_shared<devices::SessionFile>(device_manager_.context(),
317 filename.toStdString());
320 // TODO Perform error handling
321 start_capture([](QString infoMessage) { (void)infoMessage; });
323 set_name(QFileInfo(filename).fileName());
329 for (shared_ptr<data::SignalBase> base : signalbases_) {
330 settings.beginGroup(base->internal_name());
331 base->restore_settings(settings);
337 int stacks = settings.value("decoder_stacks").toInt();
339 for (int i = 0; i < stacks; i++) {
340 settings.beginGroup("decoder_stack" + QString::number(i++));
342 QString id = settings.value("id").toString();
343 add_decoder(srd_decoder_get_by_id(id.toStdString().c_str()));
350 int views = settings.value("views").toInt();
352 for (int i = 0; i < views; i++) {
353 settings.beginGroup("view" + QString::number(i));
356 views::ViewType type = (views::ViewType)settings.value("type").toInt();
357 add_view(name_, type, this);
358 views_.back()->restore_settings(settings);
360 main_view_->restore_settings(settings);
367 void Session::select_device(shared_ptr<devices::Device> device)
373 set_default_device();
374 } catch (const QString &e) {
375 main_bar_->session_error(tr("Failed to Select Device"),
376 tr("Failed to Select Device"));
380 void Session::set_device(shared_ptr<devices::Device> device)
384 // Ensure we are not capturing before setting the device
392 // Revert name back to default name (e.g. "Session 1") as the data is gone
393 name_ = default_name_;
396 // Remove all stored data
397 for (shared_ptr<views::ViewBase> view : views_) {
398 view->clear_signals();
400 view->clear_decode_signals();
403 for (const shared_ptr<data::SignalData> d : all_signal_data_)
405 all_signal_data_.clear();
406 signalbases_.clear();
407 cur_logic_segment_.reset();
409 for (auto entry : cur_analog_segments_) {
410 shared_ptr<sigrok::Channel>(entry.first).reset();
411 shared_ptr<data::AnalogSegment>(entry.second).reset();
418 device_ = move(device);
422 } catch (const QString &e) {
427 device_->session()->add_datafeed_callback([=]
428 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
429 data_feed_in(device, packet);
438 void Session::set_default_device()
440 const list< shared_ptr<devices::HardwareDevice> > &devices =
441 device_manager_.devices();
446 // Try and find the demo device and select that by default
447 const auto iter = find_if(devices.begin(), devices.end(),
448 [] (const shared_ptr<devices::HardwareDevice> &d) {
449 return d->hardware_device()->driver()->name() == "demo"; });
450 set_device((iter == devices.end()) ? devices.front() : *iter);
453 void Session::load_init_file(const string &file_name, const string &format)
455 shared_ptr<InputFormat> input_format;
457 if (!format.empty()) {
458 const map<string, shared_ptr<InputFormat> > formats =
459 device_manager_.context()->input_formats();
460 const auto iter = find_if(formats.begin(), formats.end(),
461 [&](const pair<string, shared_ptr<InputFormat> > f) {
462 return f.first == format; });
463 if (iter == formats.end()) {
464 main_bar_->session_error(tr("Error"),
465 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
469 input_format = (*iter).second;
472 load_file(QString::fromStdString(file_name), input_format);
475 void Session::load_file(QString file_name,
476 shared_ptr<sigrok::InputFormat> format,
477 const map<string, Glib::VariantBase> &options)
479 const QString errorMessage(
480 QString("Failed to load file %1").arg(file_name));
484 set_device(shared_ptr<devices::Device>(
485 new devices::InputFile(
486 device_manager_.context(),
487 file_name.toStdString(),
490 set_device(shared_ptr<devices::Device>(
491 new devices::SessionFile(
492 device_manager_.context(),
493 file_name.toStdString())));
495 main_bar_->session_error(tr("Failed to load ") + file_name, e.what());
496 set_default_device();
497 main_bar_->update_device_list();
501 main_bar_->update_device_list();
503 start_capture([&, errorMessage](QString infoMessage) {
504 main_bar_->session_error(errorMessage, infoMessage); });
506 set_name(QFileInfo(file_name).fileName());
509 Session::capture_state Session::get_capture_state() const
511 lock_guard<mutex> lock(sampling_mutex_);
512 return capture_state_;
515 void Session::start_capture(function<void (const QString)> error_handler)
518 error_handler(tr("No active device set, can't start acquisition."));
524 // Check that at least one channel is enabled
525 const shared_ptr<sigrok::Device> sr_dev = device_->device();
527 const auto channels = sr_dev->channels();
528 if (!any_of(channels.begin(), channels.end(),
529 [](shared_ptr<Channel> channel) {
530 return channel->enabled(); })) {
531 error_handler(tr("No channels enabled."));
537 for (const shared_ptr<data::SignalData> d : all_signal_data_)
540 // Revert name back to default name (e.g. "Session 1") for real devices
541 // as the (possibly saved) data is gone. File devices keep their name.
542 shared_ptr<devices::HardwareDevice> hw_device =
543 dynamic_pointer_cast< devices::HardwareDevice >(device_);
546 name_ = default_name_;
551 sampling_thread_ = std::thread(
552 &Session::sample_thread_proc, this, error_handler);
555 void Session::stop_capture()
557 if (get_capture_state() != Stopped)
560 // Check that sampling stopped
561 if (sampling_thread_.joinable())
562 sampling_thread_.join();
565 void Session::register_view(shared_ptr<views::ViewBase> view)
567 if (views_.empty()) {
571 views_.push_back(view);
576 void Session::deregister_view(shared_ptr<views::ViewBase> view)
578 views_.remove_if([&](shared_ptr<views::ViewBase> v) { return v == view; });
580 if (views_.empty()) {
583 // Without a view there can be no main bar
588 bool Session::has_view(shared_ptr<views::ViewBase> view)
590 for (shared_ptr<views::ViewBase> v : views_)
597 double Session::get_samplerate() const
599 double samplerate = 0.0;
601 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
603 const vector< shared_ptr<pv::data::Segment> > segments =
605 for (const shared_ptr<pv::data::Segment> &s : segments)
606 samplerate = max(samplerate, s->samplerate());
608 // If there is no sample rate given we use samples as unit
609 if (samplerate == 0.0)
615 const unordered_set< shared_ptr<data::SignalBase> > Session::signalbases() const
621 bool Session::add_decoder(srd_decoder *const dec)
623 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
624 shared_ptr<data::DecoderStack> decoder_stack;
627 // Create the decoder
628 decoder_stack = make_shared<data::DecoderStack>(*this, dec);
630 // Make a list of all the channels
631 vector<const srd_channel*> all_channels;
632 for (const GSList *i = dec->channels; i; i = i->next)
633 all_channels.push_back((const srd_channel*)i->data);
634 for (const GSList *i = dec->opt_channels; i; i = i->next)
635 all_channels.push_back((const srd_channel*)i->data);
637 // Auto select the initial channels
638 for (const srd_channel *pdch : all_channels)
639 for (shared_ptr<data::SignalBase> b : signalbases_) {
640 if (b->logic_data()) {
641 if (QString::fromUtf8(pdch->name).toLower().
642 contains(b->name().toLower()))
647 assert(decoder_stack);
648 assert(!decoder_stack->stack().empty());
649 assert(decoder_stack->stack().front());
650 decoder_stack->stack().front()->set_channels(channels);
652 // Create the decode signal
653 shared_ptr<data::SignalBase> signalbase =
654 make_shared<data::SignalBase>(nullptr, data::SignalBase::DecodeChannel);
656 signalbase->set_decoder_stack(decoder_stack);
657 signalbases_.insert(signalbase);
659 for (shared_ptr<views::ViewBase> view : views_)
660 view->add_decode_signal(signalbase);
661 } catch (runtime_error e) {
667 // Do an initial decode
668 decoder_stack->begin_decode();
673 void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
675 signalbases_.erase(signalbase);
677 for (shared_ptr<views::ViewBase> view : views_)
678 view->remove_decode_signal(signalbase);
684 void Session::set_capture_state(capture_state state)
689 lock_guard<mutex> lock(sampling_mutex_);
690 changed = capture_state_ != state;
691 capture_state_ = state;
695 capture_state_changed(state);
698 void Session::update_signals()
701 signalbases_.clear();
703 for (shared_ptr<views::ViewBase> view : views_) {
704 view->clear_signals();
706 view->clear_decode_signals();
712 lock_guard<recursive_mutex> lock(data_mutex_);
714 const shared_ptr<sigrok::Device> sr_dev = device_->device();
716 signalbases_.clear();
718 for (shared_ptr<views::ViewBase> view : views_) {
719 view->clear_signals();
721 view->clear_decode_signals();
727 // Detect what data types we will receive
728 auto channels = sr_dev->channels();
729 unsigned int logic_channel_count = count_if(
730 channels.begin(), channels.end(),
731 [] (shared_ptr<Channel> channel) {
732 return channel->type() == sigrok::ChannelType::LOGIC; });
734 // Create data containers for the logic data segments
736 lock_guard<recursive_mutex> data_lock(data_mutex_);
738 if (logic_channel_count == 0) {
740 } else if (!logic_data_ ||
741 logic_data_->num_channels() != logic_channel_count) {
742 logic_data_.reset(new data::Logic(
743 logic_channel_count));
748 // Make the signals list
749 for (shared_ptr<views::ViewBase> viewbase : views_) {
750 views::TraceView::View *trace_view =
751 qobject_cast<views::TraceView::View*>(viewbase.get());
754 unordered_set< shared_ptr<views::TraceView::Signal> >
755 prev_sigs(trace_view->signals());
756 trace_view->clear_signals();
758 for (auto channel : sr_dev->channels()) {
759 shared_ptr<data::SignalBase> signalbase;
760 shared_ptr<views::TraceView::Signal> signal;
762 // Find the channel in the old signals
763 const auto iter = find_if(
764 prev_sigs.cbegin(), prev_sigs.cend(),
765 [&](const shared_ptr<views::TraceView::Signal> &s) {
766 return s->base()->channel() == channel;
768 if (iter != prev_sigs.end()) {
769 // Copy the signal from the old set to the new
771 trace_view->add_signal(signal);
773 // Find the signalbase for this channel if possible
775 for (const shared_ptr<data::SignalBase> b : signalbases_)
776 if (b->channel() == channel)
779 switch(channel->type()->id()) {
780 case SR_CHANNEL_LOGIC:
782 signalbase = make_shared<data::SignalBase>(channel,
783 data::SignalBase::LogicChannel);
784 signalbases_.insert(signalbase);
786 all_signal_data_.insert(logic_data_);
787 signalbase->set_data(logic_data_);
790 signal = shared_ptr<views::TraceView::Signal>(
791 new views::TraceView::LogicSignal(*this,
792 device_, signalbase));
793 trace_view->add_signal(signal);
796 case SR_CHANNEL_ANALOG:
799 signalbase = make_shared<data::SignalBase>(channel,
800 data::SignalBase::AnalogChannel);
801 signalbases_.insert(signalbase);
803 shared_ptr<data::Analog> data(new data::Analog());
804 all_signal_data_.insert(data);
805 signalbase->set_data(data);
808 signal = shared_ptr<views::TraceView::Signal>(
809 new views::TraceView::AnalogSignal(
811 trace_view->add_signal(signal);
827 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
828 shared_ptr<sigrok::Channel> channel) const
830 for (shared_ptr<data::SignalBase> sig : signalbases_) {
832 if (sig->channel() == channel)
835 return shared_ptr<data::SignalBase>();
838 void Session::sample_thread_proc(function<void (const QString)> error_handler)
840 assert(error_handler);
845 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
847 out_of_memory_ = false;
852 error_handler(e.what());
856 set_capture_state(device_->session()->trigger() ?
857 AwaitingTrigger : Running);
860 set_capture_state(Stopped);
862 // Confirm that SR_DF_END was received
863 if (cur_logic_segment_) {
864 qDebug("SR_DF_END was not received.");
868 // Optimize memory usage
869 free_unused_memory();
871 // We now have unsaved data unless we just "captured" from a file
872 shared_ptr<devices::File> file_device =
873 dynamic_pointer_cast<devices::File>(device_);
879 error_handler(tr("Out of memory, acquisition stopped."));
882 void Session::free_unused_memory()
884 for (shared_ptr<data::SignalData> data : all_signal_data_) {
885 const vector< shared_ptr<data::Segment> > segments = data->segments();
887 for (shared_ptr<data::Segment> segment : segments) {
888 segment->free_unused_memory();
893 void Session::feed_in_header()
895 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
898 void Session::feed_in_meta(shared_ptr<Meta> meta)
900 for (auto entry : meta->config()) {
901 switch (entry.first->id()) {
902 case SR_CONF_SAMPLERATE:
903 // We can't rely on the header to always contain the sample rate,
904 // so in case it's supplied via a meta packet, we use it.
905 if (!cur_samplerate_)
906 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
908 /// @todo handle samplerate changes
911 // Unknown metadata is not an error.
919 void Session::feed_in_trigger()
921 // The channel containing most samples should be most accurate
922 uint64_t sample_count = 0;
925 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
927 uint64_t temp_count = 0;
929 const vector< shared_ptr<pv::data::Segment> > segments =
931 for (const shared_ptr<pv::data::Segment> &s : segments)
932 temp_count += s->get_sample_count();
934 if (temp_count > sample_count)
935 sample_count = temp_count;
939 trigger_event(sample_count / get_samplerate());
942 void Session::feed_in_frame_begin()
944 if (cur_logic_segment_ || !cur_analog_segments_.empty())
948 void Session::feed_in_logic(shared_ptr<Logic> logic)
950 lock_guard<recursive_mutex> lock(data_mutex_);
953 // The only reason logic_data_ would not have been created is
954 // if it was not possible to determine the signals when the
955 // device was created.
959 if (!cur_logic_segment_) {
960 // This could be the first packet after a trigger
961 set_capture_state(Running);
963 // Create a new data segment
964 cur_logic_segment_ = make_shared<data::LogicSegment>(
965 *logic_data_, logic, cur_samplerate_);
966 logic_data_->push_segment(cur_logic_segment_);
968 // @todo Putting this here means that only listeners querying
969 // for logic will be notified. Currently the only user of
970 // frame_began is DecoderStack, but in future we need to signal
971 // this after both analog and logic sweeps have begun.
974 // Append to the existing data segment
975 cur_logic_segment_->append_payload(logic);
981 void Session::feed_in_analog(shared_ptr<Analog> analog)
983 lock_guard<recursive_mutex> lock(data_mutex_);
985 const vector<shared_ptr<Channel>> channels = analog->channels();
986 const unsigned int channel_count = channels.size();
987 const size_t sample_count = analog->num_samples() / channel_count;
988 const float *data = static_cast<const float *>(analog->data_pointer());
989 bool sweep_beginning = false;
991 if (signalbases_.empty())
994 for (auto channel : channels) {
995 shared_ptr<data::AnalogSegment> segment;
997 // Try to get the segment of the channel
998 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
999 iterator iter = cur_analog_segments_.find(channel);
1000 if (iter != cur_analog_segments_.end())
1001 segment = (*iter).second;
1003 // If no segment was found, this means we haven't
1004 // created one yet. i.e. this is the first packet
1005 // in the sweep containing this segment.
1006 sweep_beginning = true;
1008 // Find the analog data associated with the channel
1009 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1012 shared_ptr<data::Analog> data(base->analog_data());
1015 // Create a segment, keep it in the maps of channels
1016 segment = make_shared<data::AnalogSegment>(
1017 *data, cur_samplerate_);
1018 cur_analog_segments_[channel] = segment;
1020 // Push the segment into the analog data.
1021 data->push_segment(segment);
1026 // Append the samples in the segment
1027 segment->append_interleaved_samples(data++, sample_count,
1031 if (sweep_beginning) {
1032 // This could be the first packet after a trigger
1033 set_capture_state(Running);
1039 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1040 shared_ptr<Packet> packet)
1042 static bool frame_began=false;
1047 assert(device == device_->device());
1050 switch (packet->type()->id()) {
1056 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1063 case SR_DF_FRAME_BEGIN:
1064 feed_in_frame_begin();
1070 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1071 } catch (bad_alloc) {
1072 out_of_memory_ = true;
1079 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1080 } catch (bad_alloc) {
1081 out_of_memory_ = true;
1086 case SR_DF_FRAME_END:
1090 lock_guard<recursive_mutex> lock(data_mutex_);
1091 cur_logic_segment_.reset();
1092 cur_analog_segments_.clear();
1095 frame_began = false;
1105 void Session::on_data_saved()