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/>.
31 #include "devicemanager.hpp"
32 #include "mainwindow.hpp"
33 #include "session.hpp"
36 #include "data/analog.hpp"
37 #include "data/analogsegment.hpp"
38 #include "data/decode/decoder.hpp"
39 #include "data/logic.hpp"
40 #include "data/logicsegment.hpp"
41 #include "data/mathsignal.hpp"
42 #include "data/signalbase.hpp"
44 #include "devices/hardwaredevice.hpp"
45 #include "devices/inputfile.hpp"
46 #include "devices/sessionfile.hpp"
48 #include "toolbars/mainbar.hpp"
50 #include "views/trace/analogsignal.hpp"
51 #include "views/trace/decodetrace.hpp"
52 #include "views/trace/logicsignal.hpp"
53 #include "views/trace/signal.hpp"
54 #include "views/trace/view.hpp"
56 #include <libsigrokcxx/libsigrokcxx.hpp>
59 #include <gstreamermm.h>
60 #include <libsigrokflow/libsigrokflow.hpp>
64 #include <libsigrokdecode/libsigrokdecode.h>
65 #include "data/decodesignal.hpp"
69 using std::dynamic_pointer_cast;
73 using std::lock_guard;
75 using std::make_shared;
81 using std::recursive_mutex;
82 using std::runtime_error;
83 using std::shared_ptr;
86 using std::unique_lock;
88 using std::unique_ptr;
92 using sigrok::Channel;
93 using sigrok::ConfigKey;
94 using sigrok::DatafeedCallbackFunction;
96 using sigrok::InputFormat;
100 using sigrok::Session;
102 using Glib::VariantBase;
106 using Gst::ElementFactory;
110 using pv::data::SignalGroup;
111 using pv::util::Timestamp;
112 using pv::views::trace::Signal;
113 using pv::views::trace::AnalogSignal;
114 using pv::views::trace::LogicSignal;
118 shared_ptr<sigrok::Context> Session::sr_context;
120 Session::Session(DeviceManager &device_manager, QString name) :
121 shutting_down_(false),
122 device_manager_(device_manager),
125 capture_state_(Stopped),
133 shutting_down_ = true;
135 // Stop and join to the thread
138 for (SignalGroup* group : signal_groups_) {
144 DeviceManager& Session::device_manager()
146 return device_manager_;
149 const DeviceManager& Session::device_manager() const
151 return device_manager_;
154 shared_ptr<sigrok::Session> Session::session() const
157 return shared_ptr<sigrok::Session>();
158 return device_->session();
161 shared_ptr<devices::Device> Session::device() const
166 QString Session::name() const
171 void Session::set_name(QString name)
173 if (default_name_.isEmpty())
174 default_name_ = name;
181 QString Session::save_path() const
186 void Session::set_save_path(QString path)
191 const vector< shared_ptr<views::ViewBase> > Session::views() const
196 shared_ptr<views::ViewBase> Session::main_view() const
201 void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
203 main_bar_ = main_bar;
206 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
211 bool Session::data_saved() const
216 void Session::save_setup(QSettings &settings) const
219 int decode_signal_count = 0;
220 int gen_signal_count = 0;
222 // Save channels and decoders
223 for (const shared_ptr<data::SignalBase>& base : signalbases_) {
225 if (base->is_decode_signal()) {
226 settings.beginGroup("decode_signal" + QString::number(decode_signal_count++));
227 base->save_settings(settings);
231 if (base->is_generated()) {
232 settings.beginGroup("generated_signal" + QString::number(gen_signal_count++));
233 settings.setValue("type", base->type());
234 base->save_settings(settings);
237 settings.beginGroup(base->internal_name());
238 base->save_settings(settings);
243 settings.setValue("decode_signals", decode_signal_count);
244 settings.setValue("generated_signals", gen_signal_count);
246 // Save view states and their signal settings
247 // Note: main_view must be saved as view0
249 settings.beginGroup("view" + QString::number(i++));
250 main_view_->save_settings(settings);
253 for (const shared_ptr<views::ViewBase>& view : views_) {
254 if (view != main_view_) {
255 settings.beginGroup("view" + QString::number(i++));
256 settings.setValue("type", view->get_type());
257 view->save_settings(settings);
262 settings.setValue("views", i);
266 for (const shared_ptr<views::ViewBase>& vb : views_) {
267 shared_ptr<views::trace::View> tv = dynamic_pointer_cast<views::trace::View>(vb);
269 for (const shared_ptr<views::trace::TimeItem>& time_item : tv->time_items()) {
271 const shared_ptr<views::trace::Flag> flag =
272 dynamic_pointer_cast<views::trace::Flag>(time_item);
274 if (!flag->enabled())
277 settings.beginGroup("meta_obj" + QString::number(i++));
278 settings.setValue("type", "time_marker");
279 settings.setValue("assoc_view", view_id);
280 GlobalSettings::store_timestamp(settings, "time", flag->time());
281 settings.setValue("text", flag->get_text());
286 if (tv->cursors_shown()) {
287 settings.beginGroup("meta_obj" + QString::number(i++));
288 settings.setValue("type", "selection");
289 settings.setValue("assoc_view", view_id);
290 const shared_ptr<views::trace::CursorPair> cp = tv->cursors();
291 GlobalSettings::store_timestamp(settings, "start_time", cp->first()->time());
292 GlobalSettings::store_timestamp(settings, "end_time", cp->second()->time());
300 settings.setValue("meta_objs", i);
303 void Session::save_settings(QSettings &settings) const
305 map<string, string> dev_info;
306 list<string> key_list;
309 shared_ptr<devices::HardwareDevice> hw_device =
310 dynamic_pointer_cast< devices::HardwareDevice >(device_);
313 settings.setValue("device_type", "hardware");
314 settings.beginGroup("device");
316 key_list.emplace_back("vendor");
317 key_list.emplace_back("model");
318 key_list.emplace_back("version");
319 key_list.emplace_back("serial_num");
320 key_list.emplace_back("connection_id");
322 dev_info = device_manager_.get_device_info(device_);
324 for (string& key : key_list) {
325 if (dev_info.count(key))
326 settings.setValue(QString::fromUtf8(key.c_str()),
327 QString::fromUtf8(dev_info.at(key).c_str()));
329 settings.remove(QString::fromUtf8(key.c_str()));
335 // Having saved the data to srzip overrides the current device. This is
336 // a crappy hack around the fact that saving e.g. an imported file to
337 // srzip would require changing the underlying libsigrok device
338 if (!save_path_.isEmpty()) {
339 QFileInfo fi = QFileInfo(QDir(save_path_), name_);
340 settings.setValue("device_type", "sessionfile");
341 settings.beginGroup("device");
342 settings.setValue("filename", fi.absoluteFilePath());
345 shared_ptr<devices::SessionFile> sessionfile_device =
346 dynamic_pointer_cast<devices::SessionFile>(device_);
348 if (sessionfile_device) {
349 settings.setValue("device_type", "sessionfile");
350 settings.beginGroup("device");
351 settings.setValue("filename", QString::fromStdString(
352 sessionfile_device->full_name()));
356 shared_ptr<devices::InputFile> inputfile_device =
357 dynamic_pointer_cast<devices::InputFile>(device_);
359 if (inputfile_device) {
360 settings.setValue("device_type", "inputfile");
361 settings.beginGroup("device");
362 inputfile_device->save_meta_to_settings(settings);
367 save_setup(settings);
371 void Session::restore_setup(QSettings &settings)
374 for (shared_ptr<data::SignalBase> base : signalbases_) {
375 settings.beginGroup(base->internal_name());
376 base->restore_settings(settings);
380 // Restore generated signals
381 int gen_signal_count = settings.value("generated_signals").toInt();
383 for (int i = 0; i < gen_signal_count; i++) {
384 settings.beginGroup("generated_signal" + QString::number(i));
385 SignalBase::ChannelType type = (SignalBase::ChannelType)settings.value("type").toInt();
386 shared_ptr<data::SignalBase> signal;
388 if (type == SignalBase::MathChannel)
389 signal = make_shared<data::MathSignal>(*this);
391 qWarning() << tr("Can't restore generated signal of unknown type %1 (%2)") \
393 .arg(settings.value("name").toString());
396 add_generated_signal(signal);
397 signal->restore_settings(settings);
405 int decode_signal_count = settings.value("decode_signals").toInt();
407 for (int i = 0; i < decode_signal_count; i++) {
408 settings.beginGroup("decode_signal" + QString::number(i));
409 shared_ptr<data::DecodeSignal> signal = add_decode_signal();
410 signal->restore_settings(settings);
416 int views = settings.value("views").toInt();
418 for (int i = 0; i < views; i++) {
419 settings.beginGroup("view" + QString::number(i));
422 views::ViewType type = (views::ViewType)settings.value("type").toInt();
423 add_view(type, this);
424 views_.back()->restore_settings(settings);
426 main_view_->restore_settings(settings);
431 // Restore meta objects like markers and cursors
432 int meta_objs = settings.value("meta_objs").toInt();
434 for (int i = 0; i < meta_objs; i++) {
435 settings.beginGroup("meta_obj" + QString::number(i));
437 shared_ptr<views::ViewBase> vb;
438 shared_ptr<views::trace::View> tv;
439 if (settings.contains("assoc_view"))
440 vb = views_.at(settings.value("assoc_view").toInt());
443 tv = dynamic_pointer_cast<views::trace::View>(vb);
445 const QString type = settings.value("type").toString();
447 if ((type == "time_marker") && tv) {
448 Timestamp ts = GlobalSettings::restore_timestamp(settings, "time");
449 shared_ptr<views::trace::Flag> flag = tv->add_flag(ts);
450 flag->set_text(settings.value("text").toString());
453 if ((type == "selection") && tv) {
454 Timestamp start = GlobalSettings::restore_timestamp(settings, "start_time");
455 Timestamp end = GlobalSettings::restore_timestamp(settings, "end_time");
456 tv->set_cursors(start, end);
464 void Session::restore_settings(QSettings &settings)
466 shared_ptr<devices::Device> device;
468 const QString device_type = settings.value("device_type").toString();
470 if (device_type == "hardware") {
471 map<string, string> dev_info;
472 list<string> key_list;
474 // Re-select last used device if possible but only if it's not demo
475 settings.beginGroup("device");
476 key_list.emplace_back("vendor");
477 key_list.emplace_back("model");
478 key_list.emplace_back("version");
479 key_list.emplace_back("serial_num");
480 key_list.emplace_back("connection_id");
482 for (string key : key_list) {
483 const QString k = QString::fromStdString(key);
484 if (!settings.contains(k))
487 const string value = settings.value(k).toString().toStdString();
489 dev_info.insert(make_pair(key, value));
492 if (dev_info.count("model") > 0)
493 device = device_manager_.find_device_from_info(dev_info);
501 restore_setup(settings);
505 if ((device_type == "sessionfile") || (device_type == "inputfile")) {
506 if (device_type == "sessionfile") {
507 settings.beginGroup("device");
508 filename = settings.value("filename").toString();
511 if (QFileInfo(filename).isReadable())
512 device = make_shared<devices::SessionFile>(device_manager_.context(),
513 filename.toStdString());
516 if (device_type == "inputfile") {
517 settings.beginGroup("device");
518 device = make_shared<devices::InputFile>(device_manager_.context(),
526 restore_setup(settings);
528 start_capture([](QString infoMessage) {
529 // TODO Emulate noquote()
530 qDebug() << "Session error:" << infoMessage; });
532 set_name(QString::fromStdString(
533 dynamic_pointer_cast<devices::File>(device)->display_name(device_manager_)));
535 if (!filename.isEmpty()) {
536 // Only set the save path if we load an srzip file
537 if (device_type == "sessionfile")
538 set_save_path(QFileInfo(filename).absolutePath());
540 set_name(QFileInfo(filename).fileName());
546 void Session::select_device(shared_ptr<devices::Device> device)
552 set_default_device();
553 } catch (const QString &e) {
554 MainWindow::show_session_error(tr("Failed to select device"), e);
558 void Session::set_device(shared_ptr<devices::Device> device)
562 // Ensure we are not capturing before setting the device
570 // Revert name back to default name (e.g. "Session 1") as the data is gone
571 name_ = default_name_;
574 // Remove all stored data and reset all views
575 for (shared_ptr<views::ViewBase> view : views_) {
576 view->clear_signalbases();
578 view->clear_decode_signals();
580 view->reset_view_state();
583 for (SignalGroup* group : signal_groups_) {
587 signal_groups_.clear();
589 for (const shared_ptr<data::SignalData>& d : all_signal_data_)
592 all_signal_data_.clear();
593 signalbases_.clear();
594 cur_logic_segment_.reset();
596 for (auto& entry : cur_analog_segments_) {
597 shared_ptr<sigrok::Channel>(entry.first).reset();
598 shared_ptr<data::AnalogSegment>(entry.second).reset();
605 device_ = move(device);
609 } catch (const QString &e) {
611 MainWindow::show_session_error(tr("Failed to open device"), e);
615 device_->session()->add_datafeed_callback([=]
616 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
617 data_feed_in(device, packet);
626 void Session::set_default_device()
628 const list< shared_ptr<devices::HardwareDevice> > &devices =
629 device_manager_.devices();
634 // Try and find the demo device and select that by default
635 const auto iter = find_if(devices.begin(), devices.end(),
636 [] (const shared_ptr<devices::HardwareDevice> &d) {
637 return d->hardware_device()->driver()->name() == "demo"; });
638 set_device((iter == devices.end()) ? devices.front() : *iter);
641 bool Session::using_file_device() const
643 shared_ptr<devices::SessionFile> sessionfile_device =
644 dynamic_pointer_cast<devices::SessionFile>(device_);
646 shared_ptr<devices::InputFile> inputfile_device =
647 dynamic_pointer_cast<devices::InputFile>(device_);
649 return (sessionfile_device || inputfile_device);
653 * Convert generic options to data types that are specific to InputFormat.
655 * @param[in] user_spec Vector of tokenized words, string format.
656 * @param[in] fmt_opts Input format's options, result of InputFormat::options().
658 * @return Map of options suitable for InputFormat::create_input().
660 map<string, Glib::VariantBase>
661 Session::input_format_options(vector<string> user_spec,
662 map<string, shared_ptr<Option>> fmt_opts)
664 map<string, Glib::VariantBase> result;
666 for (auto& entry : user_spec) {
668 * Split key=value specs. Accept entries without separator
669 * (for simplified boolean specifications).
672 size_t pos = entry.find("=");
673 if (pos == std::string::npos) {
677 key = entry.substr(0, pos);
678 val = entry.substr(pos + 1);
682 * Skip user specifications that are not a member of the
683 * format's set of supported options. Have the text input
684 * spec converted to the required input format specific
687 auto found = fmt_opts.find(key);
688 if (found == fmt_opts.end()) {
689 qCritical() << "Supplied input option" << QString::fromStdString(key) <<
690 "is not a valid option for this input module, it will be ignored!";
694 shared_ptr<Option> opt = found->second;
695 result[key] = opt->parse_string(val);
701 void Session::load_init_file(const string &file_name,
702 const string &format, const string &setup_file_name)
704 shared_ptr<InputFormat> input_format;
705 map<string, Glib::VariantBase> input_opts;
707 if (!format.empty()) {
708 const map<string, shared_ptr<InputFormat> > formats =
709 device_manager_.context()->input_formats();
710 auto user_opts = pv::util::split_string(format, ":");
711 string user_name = user_opts.front();
712 user_opts.erase(user_opts.begin());
713 const auto iter = find_if(formats.begin(), formats.end(),
714 [&](const pair<string, shared_ptr<InputFormat> > f) {
715 return f.first == user_name; });
716 if (iter == formats.end()) {
717 MainWindow::show_session_error(tr("Error"),
718 tr("Unexpected input format: %1").arg(QString::fromStdString(format)));
721 input_format = (*iter).second;
722 input_opts = input_format_options(user_opts,
723 input_format->options());
726 load_file(QString::fromStdString(file_name), QString::fromStdString(setup_file_name),
727 input_format, input_opts);
730 void Session::load_file(QString file_name, QString setup_file_name,
731 shared_ptr<sigrok::InputFormat> format, const map<string, Glib::VariantBase> &options)
733 const QString errorMessage(
734 QString("Failed to load file %1").arg(file_name));
736 // In the absence of a caller's format spec, try to auto detect.
737 // Assume "sigrok session file" upon lookup miss.
739 format = device_manager_.context()->input_format_match(file_name.toStdString());
742 set_device(shared_ptr<devices::Device>(
743 new devices::InputFile(
744 device_manager_.context(),
745 file_name.toStdString(),
748 set_device(shared_ptr<devices::Device>(
749 new devices::SessionFile(
750 device_manager_.context(),
751 file_name.toStdString())));
753 MainWindow::show_session_error(tr("Failed to load %1").arg(file_name), e.what());
754 set_default_device();
755 main_bar_->update_device_list();
759 // Use the input file with .pvs extension if no setup file was given
760 if (setup_file_name.isEmpty()) {
761 setup_file_name = file_name;
762 setup_file_name.truncate(setup_file_name.lastIndexOf('.'));
763 setup_file_name.append(".pvs");
766 if (QFileInfo::exists(setup_file_name) && QFileInfo(setup_file_name).isReadable()) {
767 QSettings settings_storage(setup_file_name, QSettings::IniFormat);
768 restore_setup(settings_storage);
771 main_bar_->update_device_list();
773 start_capture([&, errorMessage](QString infoMessage) {
774 MainWindow::show_session_error(errorMessage, infoMessage); });
776 // Only set save path if we loaded an srzip file
777 if (dynamic_pointer_cast<devices::SessionFile>(device_))
778 set_save_path(QFileInfo(file_name).absolutePath());
780 set_name(QFileInfo(file_name).fileName());
783 Session::capture_state Session::get_capture_state() const
785 lock_guard<mutex> lock(sampling_mutex_);
786 return capture_state_;
789 void Session::start_capture(function<void (const QString)> error_handler)
792 error_handler(tr("No active device set, can't start acquisition."));
798 // Check that at least one channel is enabled
799 const shared_ptr<sigrok::Device> sr_dev = device_->device();
801 const auto channels = sr_dev->channels();
802 if (!any_of(channels.begin(), channels.end(),
803 [](shared_ptr<Channel> channel) {
804 return channel->enabled(); })) {
805 error_handler(tr("No channels enabled."));
811 for (const shared_ptr<data::SignalData>& d : all_signal_data_)
814 trigger_list_.clear();
815 segment_sample_count_.clear();
817 // Revert name back to default name (e.g. "Session 1") for real devices
818 // as the (possibly saved) data is gone. File devices keep their name.
819 shared_ptr<devices::HardwareDevice> hw_device =
820 dynamic_pointer_cast< devices::HardwareDevice >(device_);
823 name_ = default_name_;
828 sampling_thread_ = std::thread(&Session::sample_thread_proc, this, error_handler);
831 void Session::stop_capture()
833 if (get_capture_state() != Stopped)
836 // Check that sampling stopped
837 if (sampling_thread_.joinable())
838 sampling_thread_.join();
841 void Session::register_view(shared_ptr<views::ViewBase> view)
846 views_.push_back(view);
848 // Add all device signals
851 // Add all other signals
852 vector< shared_ptr<data::SignalBase> > view_signalbases = view->signalbases();
854 for (const shared_ptr<data::SignalBase>& signalbase : signalbases_) {
855 const int sb_exists = count_if(
856 view_signalbases.cbegin(), view_signalbases.cend(),
857 [&](const shared_ptr<data::SignalBase> &sb) {
858 return sb == signalbase;
861 // Add the signal to the view if it doesn't have it yet
863 switch (signalbase->type()) {
864 case data::SignalBase::AnalogChannel:
865 case data::SignalBase::LogicChannel:
866 case data::SignalBase::MathChannel:
867 view->add_signalbase(signalbase);
869 case data::SignalBase::DecodeChannel:
871 view->add_decode_signal(dynamic_pointer_cast<data::DecodeSignal>(signalbase));
880 void Session::deregister_view(shared_ptr<views::ViewBase> view)
882 views_.erase(std::remove_if(views_.begin(), views_.end(),
883 [&](shared_ptr<views::ViewBase> v) { return v == view; }),
886 if (views_.empty()) {
889 // Without a view there can be no main bar
894 bool Session::has_view(shared_ptr<views::ViewBase> view)
896 for (shared_ptr<views::ViewBase>& v : views_)
903 double Session::get_samplerate() const
905 double samplerate = 0.0;
907 for (const shared_ptr<pv::data::SignalData>& d : all_signal_data_) {
909 const vector< shared_ptr<pv::data::Segment> > segments =
911 for (const shared_ptr<pv::data::Segment>& s : segments)
912 samplerate = max(samplerate, s->samplerate());
914 // If there is no sample rate given we use samples as unit
915 if (samplerate == 0.0)
921 uint32_t Session::get_highest_segment_id() const
923 return highest_segment_id_;
926 uint64_t Session::get_segment_sample_count(uint32_t segment_id) const
928 if (segment_id < segment_sample_count_.size())
929 return segment_sample_count_[segment_id];
934 vector<util::Timestamp> Session::get_triggers(uint32_t segment_id) const
936 vector<util::Timestamp> result;
938 for (const pair<uint32_t, util::Timestamp>& entry : trigger_list_)
939 if (entry.first == segment_id)
940 result.push_back(entry.second);
945 const vector< shared_ptr<data::SignalBase> > Session::signalbases() const
950 uint32_t Session::get_signal_count(data::SignalBase::ChannelType type) const
952 return count_if(signalbases_.begin(), signalbases_.end(),
953 [&] (shared_ptr<SignalBase> sb) { return sb->type() == type; });
956 uint32_t Session::get_next_signal_index(data::SignalBase::ChannelType type)
958 next_index_list_[type]++;
959 return next_index_list_[type];
962 void Session::add_generated_signal(shared_ptr<data::SignalBase> signal)
964 signalbases_.push_back(signal);
966 for (shared_ptr<views::ViewBase>& view : views_)
967 view->add_signalbase(signal);
972 void Session::remove_generated_signal(shared_ptr<data::SignalBase> signal)
977 signalbases_.erase(std::remove_if(signalbases_.begin(), signalbases_.end(),
978 [&](shared_ptr<data::SignalBase> s) { return s == signal; }),
981 for (shared_ptr<views::ViewBase>& view : views_)
982 view->remove_signalbase(signal);
988 shared_ptr<data::DecodeSignal> Session::add_decode_signal()
990 shared_ptr<data::DecodeSignal> signal;
993 // Create the decode signal
994 signal = make_shared<data::DecodeSignal>(*this);
996 signalbases_.push_back(signal);
998 // Add the decode signal to all views
999 for (shared_ptr<views::ViewBase>& view : views_)
1000 view->add_decode_signal(signal);
1001 } catch (runtime_error& e) {
1002 remove_decode_signal(signal);
1011 void Session::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
1016 signalbases_.erase(std::remove_if(signalbases_.begin(), signalbases_.end(),
1017 [&](shared_ptr<data::SignalBase> s) { return s == signal; }),
1018 signalbases_.end());
1020 for (shared_ptr<views::ViewBase>& view : views_)
1021 view->remove_decode_signal(signal);
1027 bool Session::all_segments_complete(uint32_t segment_id) const
1029 bool all_complete = true;
1031 for (const shared_ptr<data::SignalBase>& base : signalbases_)
1032 if (!base->segment_is_complete(segment_id))
1033 all_complete = false;
1035 return all_complete;
1038 MetadataObjManager* Session::metadata_obj_manager()
1040 return &metadata_obj_manager_;
1043 void Session::set_capture_state(capture_state state)
1045 if (state == capture_state_)
1048 if (state == Running)
1049 acq_time_.restart();
1050 if (state == Stopped)
1051 qDebug("Acquisition took %.2f s", acq_time_.elapsed() / 1000.);
1054 lock_guard<mutex> lock(sampling_mutex_);
1055 capture_state_ = state;
1058 capture_state_changed(state);
1061 void Session::update_signals()
1064 signalbases_.clear();
1065 logic_data_.reset();
1066 for (shared_ptr<views::ViewBase>& view : views_) {
1067 view->clear_signalbases();
1068 #ifdef ENABLE_DECODE
1069 view->clear_decode_signals();
1075 lock_guard<recursive_mutex> lock(data_mutex_);
1077 const shared_ptr<sigrok::Device> sr_dev = device_->device();
1079 signalbases_.clear();
1080 logic_data_.reset();
1081 for (shared_ptr<views::ViewBase>& view : views_) {
1082 view->clear_signalbases();
1083 #ifdef ENABLE_DECODE
1084 view->clear_decode_signals();
1090 // Detect what data types we will receive
1091 auto channels = sr_dev->channels();
1092 unsigned int logic_channel_count = count_if(
1093 channels.begin(), channels.end(),
1094 [] (shared_ptr<Channel> channel) {
1095 return channel->type() == sigrok::ChannelType::LOGIC; });
1097 // Create a common data container for the logic signalbases
1099 lock_guard<recursive_mutex> data_lock(data_mutex_);
1101 if (logic_channel_count == 0) {
1102 logic_data_.reset();
1103 } else if (!logic_data_ ||
1104 logic_data_->num_channels() != logic_channel_count) {
1105 logic_data_.reset(new data::Logic(logic_channel_count));
1106 assert(logic_data_);
1110 // Create signalbases if necessary
1111 for (auto channel : sr_dev->channels()) {
1113 // Try to find the channel in the list of existing signalbases
1114 const auto iter = find_if(signalbases_.cbegin(), signalbases_.cend(),
1115 [&](const shared_ptr<SignalBase> &sb) { return sb->channel() == channel; });
1117 // Not found, let's make a signalbase for it
1118 if (iter == signalbases_.cend()) {
1119 shared_ptr<SignalBase> signalbase;
1120 switch(channel->type()->id()) {
1121 case SR_CHANNEL_LOGIC:
1122 signalbase = make_shared<data::SignalBase>(channel, data::SignalBase::LogicChannel);
1123 signalbases_.push_back(signalbase);
1125 all_signal_data_.insert(logic_data_);
1126 signalbase->set_data(logic_data_);
1128 connect(this, SIGNAL(capture_state_changed(int)),
1129 signalbase.get(), SLOT(on_capture_state_changed(int)));
1132 case SR_CHANNEL_ANALOG:
1133 signalbase = make_shared<data::SignalBase>(channel, data::SignalBase::AnalogChannel);
1134 signalbases_.push_back(signalbase);
1136 shared_ptr<data::Analog> data(new data::Analog());
1137 all_signal_data_.insert(data);
1138 signalbase->set_data(data);
1140 connect(this, SIGNAL(capture_state_changed(int)),
1141 signalbase.get(), SLOT(on_capture_state_changed(int)));
1147 // Create and assign default signal groups if needed
1148 if (signal_groups_.empty()) {
1149 for (auto& entry : sr_dev->channel_groups()) {
1150 const shared_ptr<sigrok::ChannelGroup>& group = entry.second;
1152 if (group->channels().size() <= 1)
1155 SignalGroup* sg = new SignalGroup(QString::fromStdString(entry.first));
1156 for (const shared_ptr<sigrok::Channel>& channel : group->channels()) {
1157 for (shared_ptr<data::SignalBase> s : signalbases_) {
1158 if (s->channel() == channel) {
1159 sg->append_signal(s);
1164 signal_groups_.emplace_back(sg);
1169 for (shared_ptr<views::ViewBase>& viewbase : views_) {
1170 vector< shared_ptr<SignalBase> > view_signalbases =
1171 viewbase->signalbases();
1173 // Add all non-decode signalbases that don't yet exist in the view
1174 for (shared_ptr<SignalBase>& session_sb : signalbases_) {
1175 if (session_sb->type() == SignalBase::DecodeChannel)
1178 const auto iter = find_if(view_signalbases.cbegin(), view_signalbases.cend(),
1179 [&](const shared_ptr<SignalBase> &sb) { return sb == session_sb; });
1181 if (iter == view_signalbases.cend())
1182 viewbase->add_signalbase(session_sb);
1185 // Remove all non-decode signalbases that no longer exist
1186 for (shared_ptr<SignalBase>& view_sb : view_signalbases) {
1187 if (view_sb->type() == SignalBase::DecodeChannel)
1190 const auto iter = find_if(signalbases_.cbegin(), signalbases_.cend(),
1191 [&](const shared_ptr<SignalBase> &sb) { return sb == view_sb; });
1193 if (iter == signalbases_.cend())
1194 viewbase->remove_signalbase(view_sb);
1201 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
1202 shared_ptr<sigrok::Channel> channel) const
1204 for (shared_ptr<data::SignalBase> sig : signalbases_) {
1206 if (sig->channel() == channel)
1209 return shared_ptr<data::SignalBase>();
1212 void Session::sample_thread_proc(function<void (const QString)> error_handler)
1214 assert(error_handler);
1217 pipeline_ = Pipeline::create();
1219 source_ = ElementFactory::create_element("filesrc", "source");
1220 sink_ = RefPtr<AppSink>::cast_dynamic(ElementFactory::create_element("appsink", "sink"));
1222 pipeline_->add(source_)->add(sink_);
1223 source_->link(sink_);
1225 source_->set_property("location", Glib::ustring("/tmp/dummy_binary"));
1227 sink_->set_property("emit-signals", TRUE);
1228 sink_->signal_new_sample().connect(sigc::mem_fun(*this, &Session::on_gst_new_sample));
1230 // Get the bus from the pipeline and add a bus watch to the default main context
1231 RefPtr<Bus> bus = pipeline_->get_bus();
1232 bus->add_watch(sigc::mem_fun(this, &Session::on_gst_bus_message));
1234 // Start pipeline and Wait until it finished processing
1235 pipeline_done_interrupt_ = false;
1236 pipeline_->set_state(Gst::STATE_PLAYING);
1238 unique_lock<mutex> pipeline_done_lock_(pipeline_done_mutex_);
1239 pipeline_done_cond_.wait(pipeline_done_lock_);
1241 // Let the pipeline free all resources
1242 pipeline_->set_state(Gst::STATE_NULL);
1249 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1250 } catch (Error& e) {
1251 cur_samplerate_ = 0;
1254 out_of_memory_ = false;
1257 lock_guard<recursive_mutex> lock(data_mutex_);
1258 cur_logic_segment_.reset();
1259 cur_analog_segments_.clear();
1260 for (shared_ptr<data::SignalBase> sb : signalbases_)
1261 sb->clear_sample_data();
1263 highest_segment_id_ = -1;
1264 frame_began_ = false;
1268 } catch (Error& e) {
1269 error_handler(e.what());
1273 set_capture_state(device_->session()->trigger() ?
1274 AwaitingTrigger : Running);
1278 } catch (Error& e) {
1279 error_handler(e.what());
1280 set_capture_state(Stopped);
1282 } catch (QString& e) {
1284 set_capture_state(Stopped);
1288 set_capture_state(Stopped);
1290 // Confirm that SR_DF_END was received
1291 if (cur_logic_segment_)
1292 qDebug() << "WARNING: SR_DF_END was not received.";
1295 // Optimize memory usage
1296 free_unused_memory();
1298 // We now have unsaved data unless we just "captured" from a file
1299 shared_ptr<devices::File> file_device =
1300 dynamic_pointer_cast<devices::File>(device_);
1303 data_saved_ = false;
1306 error_handler(tr("Out of memory, acquisition stopped."));
1309 void Session::free_unused_memory()
1311 for (const shared_ptr<data::SignalData>& data : all_signal_data_) {
1312 const vector< shared_ptr<data::Segment> > segments = data->segments();
1314 for (const shared_ptr<data::Segment>& segment : segments)
1315 segment->free_unused_memory();
1319 void Session::signal_new_segment()
1321 int new_segment_id = 0;
1323 if ((cur_logic_segment_ != nullptr) || !cur_analog_segments_.empty()) {
1325 // Determine new frame/segment number, assuming that all
1326 // signals have the same number of frames/segments
1327 if (cur_logic_segment_) {
1328 new_segment_id = logic_data_->get_segment_count() - 1;
1330 shared_ptr<sigrok::Channel> any_channel =
1331 (*cur_analog_segments_.begin()).first;
1333 shared_ptr<data::SignalBase> base = signalbase_from_channel(any_channel);
1336 shared_ptr<data::Analog> data(base->analog_data());
1339 new_segment_id = data->get_segment_count() - 1;
1343 if (new_segment_id > highest_segment_id_) {
1344 highest_segment_id_ = new_segment_id;
1345 segment_sample_count_.emplace_back(0);
1346 new_segment(highest_segment_id_);
1350 void Session::signal_segment_completed()
1354 for (const shared_ptr<data::SignalBase>& signalbase : signalbases_) {
1355 // We only care about analog and logic channels, not derived ones
1356 if (signalbase->type() == data::SignalBase::AnalogChannel) {
1357 segment_id = signalbase->analog_data()->get_segment_count() - 1;
1361 if (signalbase->type() == data::SignalBase::LogicChannel) {
1362 segment_id = signalbase->logic_data()->get_segment_count() - 1;
1367 if (segment_id >= 0)
1368 segment_completed(segment_id);
1372 bool Session::on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message)
1376 if ((message->get_source() == pipeline_) && \
1377 ((message->get_message_type() == Gst::MESSAGE_EOS)))
1378 pipeline_done_cond_.notify_one();
1380 // TODO Also evaluate MESSAGE_STREAM_STATUS to receive error notifications
1385 Gst::FlowReturn Session::on_gst_new_sample()
1387 RefPtr<Gst::Sample> sample = sink_->pull_sample();
1388 RefPtr<Gst::Buffer> buf = sample->get_buffer();
1390 for (uint32_t block_id = 0; block_id < buf->n_memory(); block_id++) {
1391 RefPtr<Gst::Memory> buf_mem = buf->get_memory(block_id);
1392 Gst::MapInfo mapinfo;
1393 buf_mem->map(mapinfo, Gst::MAP_READ);
1395 shared_ptr<sigrok::Packet> logic_packet =
1396 sr_context->create_logic_packet(mapinfo.get_data(), buf->get_size(), 1);
1399 feed_in_logic(dynamic_pointer_cast<sigrok::Logic>(logic_packet->payload()));
1400 } catch (bad_alloc&) {
1401 out_of_memory_ = true;
1403 buf_mem->unmap(mapinfo);
1404 return Gst::FLOW_ERROR;
1407 buf_mem->unmap(mapinfo);
1410 return Gst::FLOW_OK;
1414 void Session::feed_in_header()
1416 // Nothing to do here for now
1419 void Session::feed_in_meta(shared_ptr<Meta> meta)
1421 for (auto& entry : meta->config()) {
1422 switch (entry.first->id()) {
1423 case SR_CONF_SAMPLERATE:
1424 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
1427 qDebug() << "Received meta data key" << entry.first->id() << ", ignoring.";
1435 void Session::feed_in_trigger()
1437 // The channel containing most samples should be most accurate
1438 uint64_t sample_count = 0;
1441 for (const shared_ptr<pv::data::SignalData>& d : all_signal_data_) {
1443 uint64_t temp_count = 0;
1445 const vector< shared_ptr<pv::data::Segment> > segments =
1447 for (const shared_ptr<pv::data::Segment> &s : segments)
1448 temp_count += s->get_sample_count();
1450 if (temp_count > sample_count)
1451 sample_count = temp_count;
1455 uint32_t segment_id = 0; // Default segment when no frames are used
1457 // If a frame began, we'd ideally be able to use the highest segment ID for
1458 // the trigger. However, as new segments are only created when logic or
1459 // analog data comes in, this doesn't work if the trigger appears right
1460 // after the beginning of the frame, before any sample data.
1461 // For this reason, we use highest segment ID + 1 if no sample data came in
1462 // yet and the highest segment ID otherwise.
1464 segment_id = highest_segment_id_;
1465 if (!cur_logic_segment_ && (cur_analog_segments_.size() == 0))
1469 // TODO Create timestamp from segment start time + segment's current sample count
1470 util::Timestamp timestamp = sample_count / get_samplerate();
1471 trigger_list_.emplace_back(segment_id, timestamp);
1472 trigger_event(segment_id, timestamp);
1475 void Session::feed_in_frame_begin()
1477 frame_began_ = true;
1480 void Session::feed_in_frame_end()
1486 lock_guard<recursive_mutex> lock(data_mutex_);
1488 if (cur_logic_segment_)
1489 cur_logic_segment_->set_complete();
1491 for (auto& entry : cur_analog_segments_) {
1492 shared_ptr<data::AnalogSegment> segment = entry.second;
1493 segment->set_complete();
1496 cur_logic_segment_.reset();
1497 cur_analog_segments_.clear();
1500 frame_began_ = false;
1502 signal_segment_completed();
1505 void Session::feed_in_logic(shared_ptr<sigrok::Logic> logic)
1507 if (logic->data_length() == 0) {
1508 qDebug() << "WARNING: Received logic packet with 0 samples.";
1512 if (logic->unit_size() > 8)
1513 throw QString(tr("Can't handle more than 64 logic channels."));
1515 if (!cur_samplerate_)
1517 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1518 } catch (Error& e) {
1522 lock_guard<recursive_mutex> lock(data_mutex_);
1525 // The only reason logic_data_ would not have been created is
1526 // if it was not possible to determine the signals when the
1527 // device was created.
1531 if (!cur_logic_segment_) {
1532 // This could be the first packet after a trigger
1533 set_capture_state(Running);
1535 // Create a new data segment
1536 cur_logic_segment_ = make_shared<data::LogicSegment>(
1537 *logic_data_, logic_data_->get_segment_count(),
1538 logic->unit_size(), cur_samplerate_);
1539 logic_data_->push_segment(cur_logic_segment_);
1541 signal_new_segment();
1544 cur_logic_segment_->append_payload(logic);
1546 segment_sample_count_[highest_segment_id_] =
1547 max(segment_sample_count_[highest_segment_id_], cur_logic_segment_->get_sample_count());
1552 void Session::feed_in_analog(shared_ptr<sigrok::Analog> analog)
1554 if (analog->num_samples() == 0) {
1555 qDebug() << "WARNING: Received analog packet with 0 samples.";
1559 if (!cur_samplerate_)
1561 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1562 } catch (Error& e) {
1566 lock_guard<recursive_mutex> lock(data_mutex_);
1568 const vector<shared_ptr<Channel>> channels = analog->channels();
1569 bool sweep_beginning = false;
1571 unique_ptr<float[]> data(new float[analog->num_samples() * channels.size()]);
1572 analog->get_data_as_float(data.get());
1574 if (signalbases_.empty())
1577 float *channel_data = data.get();
1578 for (auto& channel : channels) {
1579 shared_ptr<data::AnalogSegment> segment;
1581 // Try to get the segment of the channel
1582 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
1583 iterator iter = cur_analog_segments_.find(channel);
1584 if (iter != cur_analog_segments_.end())
1585 segment = (*iter).second;
1587 // If no segment was found, this means we haven't
1588 // created one yet. i.e. this is the first packet
1589 // in the sweep containing this segment.
1590 sweep_beginning = true;
1592 // Find the analog data associated with the channel
1593 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1596 shared_ptr<data::Analog> data(base->analog_data());
1599 // Create a segment, keep it in the maps of channels
1600 segment = make_shared<data::AnalogSegment>(
1601 *data, data->get_segment_count(), cur_samplerate_);
1602 cur_analog_segments_[channel] = segment;
1604 // Push the segment into the analog data.
1605 data->push_segment(segment);
1607 signal_new_segment();
1612 // Append the samples in the segment
1613 segment->append_interleaved_samples(channel_data++, analog->num_samples(),
1616 segment_sample_count_[highest_segment_id_] =
1617 max(segment_sample_count_[highest_segment_id_], segment->get_sample_count());
1620 if (sweep_beginning) {
1621 // This could be the first packet after a trigger
1622 set_capture_state(Running);
1628 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1629 shared_ptr<Packet> packet)
1634 assert(device == device_->device());
1637 switch (packet->type()->id()) {
1643 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1652 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1653 } catch (bad_alloc&) {
1654 out_of_memory_ = true;
1661 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1662 } catch (bad_alloc&) {
1663 out_of_memory_ = true;
1668 case SR_DF_FRAME_BEGIN:
1669 feed_in_frame_begin();
1672 case SR_DF_FRAME_END:
1673 feed_in_frame_end();
1677 // Strictly speaking, this is performed when a frame end marker was
1678 // received, so there's no point doing this again. However, not all
1679 // devices use frames, and for those devices, we need to do it here.
1681 lock_guard<recursive_mutex> lock(data_mutex_);
1683 if (cur_logic_segment_)
1684 cur_logic_segment_->set_complete();
1686 for (auto& entry : cur_analog_segments_) {
1687 shared_ptr<data::AnalogSegment> segment = entry.second;
1688 segment->set_complete();
1691 cur_logic_segment_.reset();
1692 cur_analog_segments_.clear();
1701 void Session::on_data_saved()
1706 #ifdef ENABLE_DECODE
1707 void Session::on_new_decoders_selected(vector<const srd_decoder*> decoders)
1709 assert(decoders.size() > 0);
1711 shared_ptr<data::DecodeSignal> signal = add_decode_signal();
1714 for (unsigned int i = 0; i < decoders.size(); i++) {
1715 const srd_decoder* d = decoders[i];
1716 signal->stack_decoder(d, !(i < decoders.size() - 1));