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::ChannelType;
93 using sigrok::ConfigKey;
94 using sigrok::DatafeedCallbackFunction;
97 using sigrok::InputFormat;
100 using sigrok::OutputFormat;
101 using sigrok::Packet;
102 using sigrok::PacketPayload;
103 using sigrok::Session;
104 using sigrok::SessionDevice;
106 using Glib::VariantBase;
110 Session::Session(DeviceManager &device_manager, QString name) :
111 device_manager_(device_manager),
114 capture_state_(Stopped),
122 // Stop and join to the thread
126 DeviceManager& Session::device_manager()
128 return device_manager_;
131 const DeviceManager& Session::device_manager() const
133 return device_manager_;
136 shared_ptr<sigrok::Session> Session::session() const
139 return shared_ptr<sigrok::Session>();
140 return device_->session();
143 shared_ptr<devices::Device> Session::device() const
148 QString Session::name() const
153 void Session::set_name(QString name)
155 if (default_name_.isEmpty())
156 default_name_ = name;
163 const list< shared_ptr<views::ViewBase> > Session::views() const
168 shared_ptr<views::ViewBase> Session::main_view() const
173 void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
175 main_bar_ = main_bar;
178 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
183 bool Session::data_saved() const
188 void Session::save_settings(QSettings &settings) const
190 map<string, string> dev_info;
191 list<string> key_list;
192 int stacks = 0, views = 0;
195 shared_ptr<devices::HardwareDevice> hw_device =
196 dynamic_pointer_cast< devices::HardwareDevice >(device_);
199 settings.setValue("device_type", "hardware");
200 settings.beginGroup("device");
202 key_list.emplace_back("vendor");
203 key_list.emplace_back("model");
204 key_list.emplace_back("version");
205 key_list.emplace_back("serial_num");
206 key_list.emplace_back("connection_id");
208 dev_info = device_manager_.get_device_info(device_);
210 for (string key : key_list) {
211 if (dev_info.count(key))
212 settings.setValue(QString::fromUtf8(key.c_str()),
213 QString::fromUtf8(dev_info.at(key).c_str()));
215 settings.remove(QString::fromUtf8(key.c_str()));
221 shared_ptr<devices::SessionFile> sessionfile_device =
222 dynamic_pointer_cast< devices::SessionFile >(device_);
224 if (sessionfile_device) {
225 settings.setValue("device_type", "sessionfile");
226 settings.beginGroup("device");
227 settings.setValue("filename", QString::fromStdString(
228 sessionfile_device->full_name()));
232 // Save channels and decoders
233 for (shared_ptr<data::SignalBase> base : signalbases_) {
235 if (base->is_decode_signal()) {
236 shared_ptr<pv::data::DecoderStack> decoder_stack =
237 base->decoder_stack();
238 shared_ptr<data::decode::Decoder> top_decoder =
239 decoder_stack->stack().front();
241 settings.beginGroup("decoder_stack" + QString::number(stacks++));
242 settings.setValue("id", top_decoder->decoder()->id);
243 settings.setValue("name", top_decoder->decoder()->name);
248 settings.beginGroup(base->internal_name());
249 base->save_settings(settings);
254 settings.setValue("decoder_stacks", stacks);
256 // Save view states and their signal settings
257 // Note: main_view must be saved as view0
258 settings.beginGroup("view" + QString::number(views++));
259 main_view_->save_settings(settings);
262 for (shared_ptr<views::ViewBase> view : views_) {
263 if (view != main_view_) {
264 settings.beginGroup("view" + QString::number(views++));
265 view->save_settings(settings);
270 settings.setValue("views", views);
274 void Session::restore_settings(QSettings &settings)
276 shared_ptr<devices::Device> device;
278 QString device_type = settings.value("device_type").toString();
280 if (device_type == "hardware") {
281 map<string, string> dev_info;
282 list<string> key_list;
284 // Re-select last used device if possible but only if it's not demo
285 settings.beginGroup("device");
286 key_list.emplace_back("vendor");
287 key_list.emplace_back("model");
288 key_list.emplace_back("version");
289 key_list.emplace_back("serial_num");
290 key_list.emplace_back("connection_id");
292 for (string key : key_list) {
293 const QString k = QString::fromStdString(key);
294 if (!settings.contains(k))
297 const string value = settings.value(k).toString().toStdString();
299 dev_info.insert(make_pair(key, value));
302 if (dev_info.count("model") > 0)
303 device = device_manager_.find_device_from_info(dev_info);
311 if (device_type == "sessionfile") {
312 settings.beginGroup("device");
313 QString filename = settings.value("filename").toString();
316 if (QFileInfo(filename).isReadable()) {
317 device = make_shared<devices::SessionFile>(device_manager_.context(),
318 filename.toStdString());
321 // TODO Perform error handling
322 start_capture([](QString infoMessage) { (void)infoMessage; });
324 set_name(QFileInfo(filename).fileName());
330 for (shared_ptr<data::SignalBase> base : signalbases_) {
331 settings.beginGroup(base->internal_name());
332 base->restore_settings(settings);
338 int stacks = settings.value("decoder_stacks").toInt();
340 for (int i = 0; i < stacks; i++) {
341 settings.beginGroup("decoder_stack" + QString::number(i++));
343 QString id = settings.value("id").toString();
344 add_decoder(srd_decoder_get_by_id(id.toStdString().c_str()));
351 int views = settings.value("views").toInt();
353 for (int i = 0; i < views; i++) {
354 settings.beginGroup("view" + QString::number(i));
357 views::ViewType type = (views::ViewType)settings.value("type").toInt();
358 add_view(name_, type, this);
359 views_.back()->restore_settings(settings);
361 main_view_->restore_settings(settings);
368 void Session::select_device(shared_ptr<devices::Device> device)
374 set_default_device();
375 } catch (const QString &e) {
376 main_bar_->session_error(tr("Failed to Select Device"),
377 tr("Failed to Select Device"));
381 void Session::set_device(shared_ptr<devices::Device> device)
385 // Ensure we are not capturing before setting the device
393 // Revert name back to default name (e.g. "Session 1") as the data is gone
394 name_ = default_name_;
397 // Remove all stored data
398 for (shared_ptr<views::ViewBase> view : views_) {
399 view->clear_signals();
401 view->clear_decode_signals();
404 for (const shared_ptr<data::SignalData> d : all_signal_data_)
406 all_signal_data_.clear();
407 signalbases_.clear();
408 cur_logic_segment_.reset();
410 for (auto entry : cur_analog_segments_) {
411 shared_ptr<sigrok::Channel>(entry.first).reset();
412 shared_ptr<data::AnalogSegment>(entry.second).reset();
419 device_ = move(device);
423 } catch (const QString &e) {
428 device_->session()->add_datafeed_callback([=]
429 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
430 data_feed_in(device, packet);
439 void Session::set_default_device()
441 const list< shared_ptr<devices::HardwareDevice> > &devices =
442 device_manager_.devices();
447 // Try and find the demo device and select that by default
448 const auto iter = find_if(devices.begin(), devices.end(),
449 [] (const shared_ptr<devices::HardwareDevice> &d) {
450 return d->hardware_device()->driver()->name() == "demo"; });
451 set_device((iter == devices.end()) ? devices.front() : *iter);
454 void Session::load_init_file(const string &file_name, const string &format)
456 shared_ptr<InputFormat> input_format;
458 if (!format.empty()) {
459 const map<string, shared_ptr<InputFormat> > formats =
460 device_manager_.context()->input_formats();
461 const auto iter = find_if(formats.begin(), formats.end(),
462 [&](const pair<string, shared_ptr<InputFormat> > f) {
463 return f.first == format; });
464 if (iter == formats.end()) {
465 main_bar_->session_error(tr("Error"),
466 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
470 input_format = (*iter).second;
473 load_file(QString::fromStdString(file_name), input_format);
476 void Session::load_file(QString file_name,
477 shared_ptr<sigrok::InputFormat> format,
478 const map<string, Glib::VariantBase> &options)
480 const QString errorMessage(
481 QString("Failed to load file %1").arg(file_name));
485 set_device(shared_ptr<devices::Device>(
486 new devices::InputFile(
487 device_manager_.context(),
488 file_name.toStdString(),
491 set_device(shared_ptr<devices::Device>(
492 new devices::SessionFile(
493 device_manager_.context(),
494 file_name.toStdString())));
496 main_bar_->session_error(tr("Failed to load ") + file_name, e.what());
497 set_default_device();
498 main_bar_->update_device_list();
502 main_bar_->update_device_list();
504 start_capture([&, errorMessage](QString infoMessage) {
505 main_bar_->session_error(errorMessage, infoMessage); });
507 set_name(QFileInfo(file_name).fileName());
510 Session::capture_state Session::get_capture_state() const
512 lock_guard<mutex> lock(sampling_mutex_);
513 return capture_state_;
516 void Session::start_capture(function<void (const QString)> error_handler)
519 error_handler(tr("No active device set, can't start acquisition."));
525 // Check that at least one channel is enabled
526 const shared_ptr<sigrok::Device> sr_dev = device_->device();
528 const auto channels = sr_dev->channels();
529 if (!any_of(channels.begin(), channels.end(),
530 [](shared_ptr<Channel> channel) {
531 return channel->enabled(); })) {
532 error_handler(tr("No channels enabled."));
538 for (const shared_ptr<data::SignalData> d : all_signal_data_)
541 // Revert name back to default name (e.g. "Session 1") for real devices
542 // as the (possibly saved) data is gone. File devices keep their name.
543 shared_ptr<devices::HardwareDevice> hw_device =
544 dynamic_pointer_cast< devices::HardwareDevice >(device_);
547 name_ = default_name_;
552 sampling_thread_ = std::thread(
553 &Session::sample_thread_proc, this, error_handler);
556 void Session::stop_capture()
558 if (get_capture_state() != Stopped)
561 // Check that sampling stopped
562 if (sampling_thread_.joinable())
563 sampling_thread_.join();
566 void Session::register_view(shared_ptr<views::ViewBase> view)
568 if (views_.empty()) {
572 views_.push_back(view);
577 void Session::deregister_view(shared_ptr<views::ViewBase> view)
579 views_.remove_if([&](shared_ptr<views::ViewBase> v) { return v == view; });
581 if (views_.empty()) {
584 // Without a view there can be no main bar
589 bool Session::has_view(shared_ptr<views::ViewBase> view)
591 for (shared_ptr<views::ViewBase> v : views_)
598 double Session::get_samplerate() const
600 double samplerate = 0.0;
602 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
604 const vector< shared_ptr<pv::data::Segment> > segments =
606 for (const shared_ptr<pv::data::Segment> &s : segments)
607 samplerate = max(samplerate, s->samplerate());
609 // If there is no sample rate given we use samples as unit
610 if (samplerate == 0.0)
616 const unordered_set< shared_ptr<data::SignalBase> > Session::signalbases() const
622 bool Session::add_decoder(srd_decoder *const dec)
624 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
625 shared_ptr<data::DecoderStack> decoder_stack;
628 // Create the decoder
629 decoder_stack = make_shared<data::DecoderStack>(*this, dec);
631 // Make a list of all the channels
632 vector<const srd_channel*> all_channels;
633 for (const GSList *i = dec->channels; i; i = i->next)
634 all_channels.push_back((const srd_channel*)i->data);
635 for (const GSList *i = dec->opt_channels; i; i = i->next)
636 all_channels.push_back((const srd_channel*)i->data);
638 // Auto select the initial channels
639 for (const srd_channel *pdch : all_channels)
640 for (shared_ptr<data::SignalBase> b : signalbases_) {
641 if (b->type() == ChannelType::LOGIC) {
642 if (QString::fromUtf8(pdch->name).toLower().
643 contains(b->name().toLower()))
648 assert(decoder_stack);
649 assert(!decoder_stack->stack().empty());
650 assert(decoder_stack->stack().front());
651 decoder_stack->stack().front()->set_channels(channels);
653 // Create the decode signal
654 shared_ptr<data::SignalBase> signalbase =
655 make_shared<data::SignalBase>(nullptr);
657 signalbase->set_decoder_stack(decoder_stack);
658 signalbases_.insert(signalbase);
660 for (shared_ptr<views::ViewBase> view : views_)
661 view->add_decode_signal(signalbase);
662 } catch (runtime_error e) {
668 // Do an initial decode
669 decoder_stack->begin_decode();
674 void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
676 signalbases_.erase(signalbase);
678 for (shared_ptr<views::ViewBase> view : views_)
679 view->remove_decode_signal(signalbase);
685 void Session::set_capture_state(capture_state state)
690 lock_guard<mutex> lock(sampling_mutex_);
691 changed = capture_state_ != state;
692 capture_state_ = state;
696 capture_state_changed(state);
699 void Session::update_signals()
702 signalbases_.clear();
704 for (shared_ptr<views::ViewBase> view : views_) {
705 view->clear_signals();
707 view->clear_decode_signals();
713 lock_guard<recursive_mutex> lock(data_mutex_);
715 const shared_ptr<sigrok::Device> sr_dev = device_->device();
717 signalbases_.clear();
719 for (shared_ptr<views::ViewBase> view : views_) {
720 view->clear_signals();
722 view->clear_decode_signals();
728 // Detect what data types we will receive
729 auto channels = sr_dev->channels();
730 unsigned int logic_channel_count = count_if(
731 channels.begin(), channels.end(),
732 [] (shared_ptr<Channel> channel) {
733 return channel->type() == ChannelType::LOGIC; });
735 // Create data containers for the logic data segments
737 lock_guard<recursive_mutex> data_lock(data_mutex_);
739 if (logic_channel_count == 0) {
741 } else if (!logic_data_ ||
742 logic_data_->num_channels() != logic_channel_count) {
743 logic_data_.reset(new data::Logic(
744 logic_channel_count));
749 // Make the signals list
750 for (shared_ptr<views::ViewBase> viewbase : views_) {
751 views::TraceView::View *trace_view =
752 qobject_cast<views::TraceView::View*>(viewbase.get());
755 unordered_set< shared_ptr<views::TraceView::Signal> >
756 prev_sigs(trace_view->signals());
757 trace_view->clear_signals();
759 for (auto channel : sr_dev->channels()) {
760 shared_ptr<data::SignalBase> signalbase;
761 shared_ptr<views::TraceView::Signal> signal;
763 // Find the channel in the old signals
764 const auto iter = find_if(
765 prev_sigs.cbegin(), prev_sigs.cend(),
766 [&](const shared_ptr<views::TraceView::Signal> &s) {
767 return s->base()->channel() == channel;
769 if (iter != prev_sigs.end()) {
770 // Copy the signal from the old set to the new
772 trace_view->add_signal(signal);
774 // Find the signalbase for this channel if possible
776 for (const shared_ptr<data::SignalBase> b : signalbases_)
777 if (b->channel() == channel)
780 switch(channel->type()->id()) {
781 case SR_CHANNEL_LOGIC:
783 signalbase = make_shared<data::SignalBase>(channel);
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 signalbases_.insert(signalbase);
802 shared_ptr<data::Analog> data(new data::Analog());
803 all_signal_data_.insert(data);
804 signalbase->set_data(data);
807 signal = shared_ptr<views::TraceView::Signal>(
808 new views::TraceView::AnalogSignal(
810 trace_view->add_signal(signal);
826 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
827 shared_ptr<sigrok::Channel> channel) const
829 for (shared_ptr<data::SignalBase> sig : signalbases_) {
831 if (sig->channel() == channel)
834 return shared_ptr<data::SignalBase>();
837 void Session::sample_thread_proc(function<void (const QString)> error_handler)
839 assert(error_handler);
844 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
846 out_of_memory_ = false;
851 error_handler(e.what());
855 set_capture_state(device_->session()->trigger() ?
856 AwaitingTrigger : Running);
859 set_capture_state(Stopped);
861 // Confirm that SR_DF_END was received
862 if (cur_logic_segment_) {
863 qDebug("SR_DF_END was not received.");
867 // Optimize memory usage
868 free_unused_memory();
870 // We now have unsaved data unless we just "captured" from a file
871 shared_ptr<devices::File> file_device =
872 dynamic_pointer_cast<devices::File>(device_);
878 error_handler(tr("Out of memory, acquisition stopped."));
881 void Session::free_unused_memory()
883 for (shared_ptr<data::SignalData> data : all_signal_data_) {
884 const vector< shared_ptr<data::Segment> > segments = data->segments();
886 for (shared_ptr<data::Segment> segment : segments) {
887 segment->free_unused_memory();
892 void Session::feed_in_header()
894 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
897 void Session::feed_in_meta(shared_ptr<Meta> meta)
899 for (auto entry : meta->config()) {
900 switch (entry.first->id()) {
901 case SR_CONF_SAMPLERATE:
902 // We can't rely on the header to always contain the sample rate,
903 // so in case it's supplied via a meta packet, we use it.
904 if (!cur_samplerate_)
905 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
907 /// @todo handle samplerate changes
910 // Unknown metadata is not an error.
918 void Session::feed_in_trigger()
920 // The channel containing most samples should be most accurate
921 uint64_t sample_count = 0;
924 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
926 uint64_t temp_count = 0;
928 const vector< shared_ptr<pv::data::Segment> > segments =
930 for (const shared_ptr<pv::data::Segment> &s : segments)
931 temp_count += s->get_sample_count();
933 if (temp_count > sample_count)
934 sample_count = temp_count;
938 trigger_event(sample_count / get_samplerate());
941 void Session::feed_in_frame_begin()
943 if (cur_logic_segment_ || !cur_analog_segments_.empty())
947 void Session::feed_in_logic(shared_ptr<Logic> logic)
949 lock_guard<recursive_mutex> lock(data_mutex_);
952 // The only reason logic_data_ would not have been created is
953 // if it was not possible to determine the signals when the
954 // device was created.
958 if (!cur_logic_segment_) {
959 // This could be the first packet after a trigger
960 set_capture_state(Running);
962 // Create a new data segment
963 cur_logic_segment_ = make_shared<data::LogicSegment>(
964 *logic_data_, logic, cur_samplerate_);
965 logic_data_->push_segment(cur_logic_segment_);
967 // @todo Putting this here means that only listeners querying
968 // for logic will be notified. Currently the only user of
969 // frame_began is DecoderStack, but in future we need to signal
970 // this after both analog and logic sweeps have begun.
973 // Append to the existing data segment
974 cur_logic_segment_->append_payload(logic);
980 void Session::feed_in_analog(shared_ptr<Analog> analog)
982 lock_guard<recursive_mutex> lock(data_mutex_);
984 const vector<shared_ptr<Channel>> channels = analog->channels();
985 const unsigned int channel_count = channels.size();
986 const size_t sample_count = analog->num_samples() / channel_count;
987 const float *data = static_cast<const float *>(analog->data_pointer());
988 bool sweep_beginning = false;
990 if (signalbases_.empty())
993 for (auto channel : channels) {
994 shared_ptr<data::AnalogSegment> segment;
996 // Try to get the segment of the channel
997 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
998 iterator iter = cur_analog_segments_.find(channel);
999 if (iter != cur_analog_segments_.end())
1000 segment = (*iter).second;
1002 // If no segment was found, this means we haven't
1003 // created one yet. i.e. this is the first packet
1004 // in the sweep containing this segment.
1005 sweep_beginning = true;
1007 // Find the analog data associated with the channel
1008 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1011 shared_ptr<data::Analog> data(base->analog_data());
1014 // Create a segment, keep it in the maps of channels
1015 segment = make_shared<data::AnalogSegment>(
1016 *data, cur_samplerate_);
1017 cur_analog_segments_[channel] = segment;
1019 // Push the segment into the analog data.
1020 data->push_segment(segment);
1025 // Append the samples in the segment
1026 segment->append_interleaved_samples(data++, sample_count,
1030 if (sweep_beginning) {
1031 // This could be the first packet after a trigger
1032 set_capture_state(Running);
1038 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1039 shared_ptr<Packet> packet)
1041 static bool frame_began=false;
1046 assert(device == device_->device());
1049 switch (packet->type()->id()) {
1055 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1062 case SR_DF_FRAME_BEGIN:
1063 feed_in_frame_begin();
1069 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1070 } catch (bad_alloc) {
1071 out_of_memory_ = true;
1078 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1079 } catch (bad_alloc) {
1080 out_of_memory_ = true;
1085 case SR_DF_FRAME_END:
1089 lock_guard<recursive_mutex> lock(data_mutex_);
1090 cur_logic_segment_.reset();
1091 cur_analog_segments_.clear();
1094 frame_began = false;
1104 void Session::on_data_saved()