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/>.
30 #include "devicemanager.hpp"
31 #include "mainwindow.hpp"
32 #include "session.hpp"
35 #include "data/analog.hpp"
36 #include "data/analogsegment.hpp"
37 #include "data/decode/decoder.hpp"
38 #include "data/logic.hpp"
39 #include "data/logicsegment.hpp"
40 #include "data/signalbase.hpp"
42 #include "devices/hardwaredevice.hpp"
43 #include "devices/inputfile.hpp"
44 #include "devices/sessionfile.hpp"
46 #include "toolbars/mainbar.hpp"
48 #include "views/trace/analogsignal.hpp"
49 #include "views/trace/decodetrace.hpp"
50 #include "views/trace/logicsignal.hpp"
51 #include "views/trace/signal.hpp"
52 #include "views/trace/view.hpp"
54 #include <libsigrokcxx/libsigrokcxx.hpp>
57 #include <gstreamermm.h>
58 #include <libsigrokflow/libsigrokflow.hpp>
62 #include <libsigrokdecode/libsigrokdecode.h>
63 #include "data/decodesignal.hpp"
67 using std::dynamic_pointer_cast;
71 using std::lock_guard;
73 using std::make_shared;
79 using std::recursive_mutex;
80 using std::runtime_error;
81 using std::shared_ptr;
84 using std::unique_lock;
86 using std::unique_ptr;
90 using sigrok::Channel;
91 using sigrok::ConfigKey;
92 using sigrok::DatafeedCallbackFunction;
94 using sigrok::InputFormat;
98 using sigrok::Session;
100 using Glib::VariantBase;
104 using Gst::ElementFactory;
108 using pv::util::Timestamp;
109 using pv::views::trace::Signal;
110 using pv::views::trace::AnalogSignal;
111 using pv::views::trace::LogicSignal;
115 shared_ptr<sigrok::Context> Session::sr_context;
117 Session::Session(DeviceManager &device_manager, QString name) :
118 shutting_down_(false),
119 device_manager_(device_manager),
122 capture_state_(Stopped),
130 shutting_down_ = true;
132 // Stop and join to the thread
136 DeviceManager& Session::device_manager()
138 return device_manager_;
141 const DeviceManager& Session::device_manager() const
143 return device_manager_;
146 shared_ptr<sigrok::Session> Session::session() const
149 return shared_ptr<sigrok::Session>();
150 return device_->session();
153 shared_ptr<devices::Device> Session::device() const
158 QString Session::name() const
163 void Session::set_name(QString name)
165 if (default_name_.isEmpty())
166 default_name_ = name;
173 const vector< shared_ptr<views::ViewBase> > Session::views() const
178 shared_ptr<views::ViewBase> Session::main_view() const
183 void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
185 main_bar_ = main_bar;
188 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
193 bool Session::data_saved() const
198 void Session::save_setup(QSettings &settings) const
202 // Save channels and decoders
203 for (const shared_ptr<data::SignalBase>& base : signalbases_) {
205 if (base->is_decode_signal()) {
206 settings.beginGroup("decode_signal" + QString::number(i++));
207 base->save_settings(settings);
212 settings.beginGroup(base->internal_name());
213 base->save_settings(settings);
218 settings.setValue("decode_signals", i);
220 // Save view states and their signal settings
221 // Note: main_view must be saved as view0
223 settings.beginGroup("view" + QString::number(i++));
224 main_view_->save_settings(settings);
227 for (const shared_ptr<views::ViewBase>& view : views_) {
228 if (view != main_view_) {
229 settings.beginGroup("view" + QString::number(i++));
230 settings.setValue("type", view->get_type());
231 view->save_settings(settings);
236 settings.setValue("views", i);
240 for (const shared_ptr<views::ViewBase>& vb : views_) {
241 shared_ptr<views::trace::View> tv = dynamic_pointer_cast<views::trace::View>(vb);
243 for (const shared_ptr<views::trace::TimeItem>& time_item : tv->time_items()) {
245 const shared_ptr<views::trace::Flag> flag =
246 dynamic_pointer_cast<views::trace::Flag>(time_item);
248 if (!flag->enabled())
251 settings.beginGroup("meta_obj" + QString::number(i++));
252 settings.setValue("type", "time_marker");
253 settings.setValue("assoc_view", view_id);
254 GlobalSettings::store_timestamp(settings, "time", flag->time());
255 settings.setValue("text", flag->get_text());
260 if (tv->cursors_shown()) {
261 settings.beginGroup("meta_obj" + QString::number(i++));
262 settings.setValue("type", "selection");
263 settings.setValue("assoc_view", view_id);
264 const shared_ptr<views::trace::CursorPair> cp = tv->cursors();
265 GlobalSettings::store_timestamp(settings, "start_time", cp->first()->time());
266 GlobalSettings::store_timestamp(settings, "end_time", cp->second()->time());
274 settings.setValue("meta_objs", i);
277 void Session::save_settings(QSettings &settings) const
279 map<string, string> dev_info;
280 list<string> key_list;
283 shared_ptr<devices::HardwareDevice> hw_device =
284 dynamic_pointer_cast< devices::HardwareDevice >(device_);
287 settings.setValue("device_type", "hardware");
288 settings.beginGroup("device");
290 key_list.emplace_back("vendor");
291 key_list.emplace_back("model");
292 key_list.emplace_back("version");
293 key_list.emplace_back("serial_num");
294 key_list.emplace_back("connection_id");
296 dev_info = device_manager_.get_device_info(device_);
298 for (string& key : key_list) {
299 if (dev_info.count(key))
300 settings.setValue(QString::fromUtf8(key.c_str()),
301 QString::fromUtf8(dev_info.at(key).c_str()));
303 settings.remove(QString::fromUtf8(key.c_str()));
309 shared_ptr<devices::SessionFile> sessionfile_device =
310 dynamic_pointer_cast<devices::SessionFile>(device_);
312 if (sessionfile_device) {
313 settings.setValue("device_type", "sessionfile");
314 settings.beginGroup("device");
315 settings.setValue("filename", QString::fromStdString(
316 sessionfile_device->full_name()));
320 shared_ptr<devices::InputFile> inputfile_device =
321 dynamic_pointer_cast<devices::InputFile>(device_);
323 if (inputfile_device) {
324 settings.setValue("device_type", "inputfile");
325 settings.beginGroup("device");
326 inputfile_device->save_meta_to_settings(settings);
330 save_setup(settings);
334 void Session::restore_setup(QSettings &settings)
337 for (shared_ptr<data::SignalBase> base : signalbases_) {
338 settings.beginGroup(base->internal_name());
339 base->restore_settings(settings);
345 int decode_signals = settings.value("decode_signals").toInt();
347 for (int i = 0; i < decode_signals; i++) {
348 settings.beginGroup("decode_signal" + QString::number(i));
349 shared_ptr<data::DecodeSignal> signal = add_decode_signal();
350 signal->restore_settings(settings);
356 int views = settings.value("views").toInt();
358 for (int i = 0; i < views; i++) {
359 settings.beginGroup("view" + QString::number(i));
362 views::ViewType type = (views::ViewType)settings.value("type").toInt();
363 add_view(type, this);
364 views_.back()->restore_settings(settings);
366 main_view_->restore_settings(settings);
371 // Restore meta objects like markers and cursors
372 int meta_objs = settings.value("meta_objs").toInt();
374 for (int i = 0; i < meta_objs; i++) {
375 settings.beginGroup("meta_obj" + QString::number(i));
377 shared_ptr<views::ViewBase> vb;
378 shared_ptr<views::trace::View> tv;
379 if (settings.contains("assoc_view"))
380 vb = views_.at(settings.value("assoc_view").toInt());
383 tv = dynamic_pointer_cast<views::trace::View>(vb);
385 const QString type = settings.value("type").toString();
387 if ((type == "time_marker") && tv) {
388 Timestamp ts = GlobalSettings::restore_timestamp(settings, "time");
389 shared_ptr<views::trace::Flag> flag = tv->add_flag(ts);
390 flag->set_text(settings.value("text").toString());
393 if ((type == "selection") && tv) {
394 Timestamp start = GlobalSettings::restore_timestamp(settings, "start_time");
395 Timestamp end = GlobalSettings::restore_timestamp(settings, "end_time");
396 tv->set_cursors(start, end);
404 void Session::restore_settings(QSettings &settings)
406 shared_ptr<devices::Device> device;
408 const QString device_type = settings.value("device_type").toString();
410 if (device_type == "hardware") {
411 map<string, string> dev_info;
412 list<string> key_list;
414 // Re-select last used device if possible but only if it's not demo
415 settings.beginGroup("device");
416 key_list.emplace_back("vendor");
417 key_list.emplace_back("model");
418 key_list.emplace_back("version");
419 key_list.emplace_back("serial_num");
420 key_list.emplace_back("connection_id");
422 for (string key : key_list) {
423 const QString k = QString::fromStdString(key);
424 if (!settings.contains(k))
427 const string value = settings.value(k).toString().toStdString();
429 dev_info.insert(make_pair(key, value));
432 if (dev_info.count("model") > 0)
433 device = device_manager_.find_device_from_info(dev_info);
441 if ((device_type == "sessionfile") || (device_type == "inputfile")) {
442 if (device_type == "sessionfile") {
443 settings.beginGroup("device");
444 const QString filename = settings.value("filename").toString();
447 if (QFileInfo(filename).isReadable()) {
448 device = make_shared<devices::SessionFile>(device_manager_.context(),
449 filename.toStdString());
453 if (device_type == "inputfile") {
454 settings.beginGroup("device");
455 device = make_shared<devices::InputFile>(device_manager_.context(),
463 start_capture([](QString infoMessage) {
464 // TODO Emulate noquote()
465 qDebug() << "Session error:" << infoMessage; });
467 set_name(QString::fromStdString(
468 dynamic_pointer_cast<devices::File>(device)->display_name(device_manager_)));
473 restore_setup(settings);
476 void Session::select_device(shared_ptr<devices::Device> device)
482 set_default_device();
483 } catch (const QString &e) {
484 MainWindow::show_session_error(tr("Failed to select device"), e);
488 void Session::set_device(shared_ptr<devices::Device> device)
492 // Ensure we are not capturing before setting the device
500 // Revert name back to default name (e.g. "Session 1") as the data is gone
501 name_ = default_name_;
504 // Remove all stored data and reset all views
505 for (shared_ptr<views::ViewBase> view : views_) {
506 view->clear_signalbases();
508 view->clear_decode_signals();
510 view->reset_view_state();
512 for (const shared_ptr<data::SignalData>& d : all_signal_data_)
514 all_signal_data_.clear();
515 signalbases_.clear();
516 cur_logic_segment_.reset();
518 for (auto& entry : cur_analog_segments_) {
519 shared_ptr<sigrok::Channel>(entry.first).reset();
520 shared_ptr<data::AnalogSegment>(entry.second).reset();
527 device_ = move(device);
531 } catch (const QString &e) {
533 MainWindow::show_session_error(tr("Failed to open device"), e);
537 device_->session()->add_datafeed_callback([=]
538 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
539 data_feed_in(device, packet);
548 void Session::set_default_device()
550 const list< shared_ptr<devices::HardwareDevice> > &devices =
551 device_manager_.devices();
556 // Try and find the demo device and select that by default
557 const auto iter = find_if(devices.begin(), devices.end(),
558 [] (const shared_ptr<devices::HardwareDevice> &d) {
559 return d->hardware_device()->driver()->name() == "demo"; });
560 set_device((iter == devices.end()) ? devices.front() : *iter);
563 bool Session::using_file_device() const
565 shared_ptr<devices::SessionFile> sessionfile_device =
566 dynamic_pointer_cast<devices::SessionFile>(device_);
568 shared_ptr<devices::InputFile> inputfile_device =
569 dynamic_pointer_cast<devices::InputFile>(device_);
571 return (sessionfile_device || inputfile_device);
575 * Convert generic options to data types that are specific to InputFormat.
577 * @param[in] user_spec Vector of tokenized words, string format.
578 * @param[in] fmt_opts Input format's options, result of InputFormat::options().
580 * @return Map of options suitable for InputFormat::create_input().
582 map<string, Glib::VariantBase>
583 Session::input_format_options(vector<string> user_spec,
584 map<string, shared_ptr<Option>> fmt_opts)
586 map<string, Glib::VariantBase> result;
588 for (auto& entry : user_spec) {
590 * Split key=value specs. Accept entries without separator
591 * (for simplified boolean specifications).
594 size_t pos = entry.find("=");
595 if (pos == std::string::npos) {
599 key = entry.substr(0, pos);
600 val = entry.substr(pos + 1);
604 * Skip user specifications that are not a member of the
605 * format's set of supported options. Have the text input
606 * spec converted to the required input format specific
609 auto found = fmt_opts.find(key);
610 if (found == fmt_opts.end())
612 shared_ptr<Option> opt = found->second;
613 result[key] = opt->parse_string(val);
619 void Session::load_init_file(const string &file_name,
620 const string &format, const string &setup_file_name)
622 shared_ptr<InputFormat> input_format;
623 map<string, Glib::VariantBase> input_opts;
625 if (!format.empty()) {
626 const map<string, shared_ptr<InputFormat> > formats =
627 device_manager_.context()->input_formats();
628 auto user_opts = pv::util::split_string(format, ":");
629 string user_name = user_opts.front();
630 user_opts.erase(user_opts.begin());
631 const auto iter = find_if(formats.begin(), formats.end(),
632 [&](const pair<string, shared_ptr<InputFormat> > f) {
633 return f.first == user_name; });
634 if (iter == formats.end()) {
635 MainWindow::show_session_error(tr("Error"),
636 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
639 input_format = (*iter).second;
640 input_opts = input_format_options(user_opts,
641 input_format->options());
644 load_file(QString::fromStdString(file_name), QString::fromStdString(setup_file_name),
645 input_format, input_opts);
648 void Session::load_file(QString file_name, QString setup_file_name,
649 shared_ptr<sigrok::InputFormat> format, const map<string, Glib::VariantBase> &options)
651 const QString errorMessage(
652 QString("Failed to load file %1").arg(file_name));
654 // In the absence of a caller's format spec, try to auto detect.
655 // Assume "sigrok session file" upon lookup miss.
657 format = device_manager_.context()->input_format_match(file_name.toStdString());
660 set_device(shared_ptr<devices::Device>(
661 new devices::InputFile(
662 device_manager_.context(),
663 file_name.toStdString(),
666 set_device(shared_ptr<devices::Device>(
667 new devices::SessionFile(
668 device_manager_.context(),
669 file_name.toStdString())));
671 MainWindow::show_session_error(tr("Failed to load %1").arg(file_name), e.what());
672 set_default_device();
673 main_bar_->update_device_list();
677 // Use the input file with .pvs extension if no setup file was given
678 if (setup_file_name.isEmpty()) {
679 setup_file_name = file_name;
680 setup_file_name.truncate(setup_file_name.lastIndexOf('.'));
681 setup_file_name.append(".pvs");
684 if (QFileInfo::exists(setup_file_name) && QFileInfo(setup_file_name).isReadable()) {
685 QSettings settings_storage(setup_file_name, QSettings::IniFormat);
686 restore_setup(settings_storage);
689 main_bar_->update_device_list();
691 start_capture([&, errorMessage](QString infoMessage) {
692 MainWindow::show_session_error(errorMessage, infoMessage); });
694 set_name(QFileInfo(file_name).fileName());
697 Session::capture_state Session::get_capture_state() const
699 lock_guard<mutex> lock(sampling_mutex_);
700 return capture_state_;
703 void Session::start_capture(function<void (const QString)> error_handler)
706 error_handler(tr("No active device set, can't start acquisition."));
712 // Check that at least one channel is enabled
713 const shared_ptr<sigrok::Device> sr_dev = device_->device();
715 const auto channels = sr_dev->channels();
716 if (!any_of(channels.begin(), channels.end(),
717 [](shared_ptr<Channel> channel) {
718 return channel->enabled(); })) {
719 error_handler(tr("No channels enabled."));
725 for (const shared_ptr<data::SignalData>& d : all_signal_data_)
728 trigger_list_.clear();
730 // Revert name back to default name (e.g. "Session 1") for real devices
731 // as the (possibly saved) data is gone. File devices keep their name.
732 shared_ptr<devices::HardwareDevice> hw_device =
733 dynamic_pointer_cast< devices::HardwareDevice >(device_);
736 name_ = default_name_;
741 sampling_thread_ = std::thread(
742 &Session::sample_thread_proc, this, error_handler);
745 void Session::stop_capture()
747 if (get_capture_state() != Stopped)
750 // Check that sampling stopped
751 if (sampling_thread_.joinable())
752 sampling_thread_.join();
755 void Session::register_view(shared_ptr<views::ViewBase> view)
760 views_.push_back(view);
762 // Add all device signals
765 // Add all other signals
766 vector< shared_ptr<data::SignalBase> > view_signalbases = view->signalbases();
768 for (const shared_ptr<data::SignalBase>& signalbase : signalbases_) {
769 const int sb_exists = count_if(
770 view_signalbases.cbegin(), view_signalbases.cend(),
771 [&](const shared_ptr<data::SignalBase> &sb) {
772 return sb == signalbase;
775 // Add the signal to the view if it doesn't have it yet
777 switch (signalbase->type()) {
778 case data::SignalBase::AnalogChannel:
779 case data::SignalBase::LogicChannel:
780 case data::SignalBase::MathChannel:
781 view->add_signalbase(signalbase);
783 case data::SignalBase::DecodeChannel:
785 view->add_decode_signal(dynamic_pointer_cast<data::DecodeSignal>(signalbase));
794 void Session::deregister_view(shared_ptr<views::ViewBase> view)
796 views_.erase(std::remove_if(views_.begin(), views_.end(),
797 [&](shared_ptr<views::ViewBase> v) { return v == view; }),
800 if (views_.empty()) {
803 // Without a view there can be no main bar
808 bool Session::has_view(shared_ptr<views::ViewBase> view)
810 for (shared_ptr<views::ViewBase>& v : views_)
817 double Session::get_samplerate() const
819 double samplerate = 0.0;
821 for (const shared_ptr<pv::data::SignalData>& d : all_signal_data_) {
823 const vector< shared_ptr<pv::data::Segment> > segments =
825 for (const shared_ptr<pv::data::Segment>& s : segments)
826 samplerate = max(samplerate, s->samplerate());
828 // If there is no sample rate given we use samples as unit
829 if (samplerate == 0.0)
835 uint32_t Session::get_segment_count() const
839 // Find the highest number of segments
840 for (const shared_ptr<data::SignalData>& data : all_signal_data_)
841 if (data->get_segment_count() > value)
842 value = data->get_segment_count();
847 vector<util::Timestamp> Session::get_triggers(uint32_t segment_id) const
849 vector<util::Timestamp> result;
851 for (const pair<uint32_t, util::Timestamp>& entry : trigger_list_)
852 if (entry.first == segment_id)
853 result.push_back(entry.second);
858 const vector< shared_ptr<data::SignalBase> > Session::signalbases() const
863 void Session::add_generated_signal(shared_ptr<data::SignalBase> signal)
865 signalbases_.push_back(signal);
867 for (shared_ptr<views::ViewBase>& view : views_)
868 view->add_signalbase(signal);
873 void Session::remove_generated_signal(shared_ptr<data::SignalBase> signal)
878 signalbases_.erase(std::remove_if(signalbases_.begin(), signalbases_.end(),
879 [&](shared_ptr<data::SignalBase> s) { return s == signal; }),
882 for (shared_ptr<views::ViewBase>& view : views_)
883 view->remove_signalbase(signal);
888 bool Session::all_segments_complete(uint32_t segment_id) const
890 bool all_complete = true;
892 for (const shared_ptr<data::SignalBase>& base : signalbases_)
893 if (!base->segment_is_complete(segment_id))
894 all_complete = false;
900 shared_ptr<data::DecodeSignal> Session::add_decode_signal()
902 shared_ptr<data::DecodeSignal> signal;
905 // Create the decode signal
906 signal = make_shared<data::DecodeSignal>(*this);
908 signalbases_.push_back(signal);
910 // Add the decode signal to all views
911 for (shared_ptr<views::ViewBase>& view : views_)
912 view->add_decode_signal(signal);
913 } catch (runtime_error& e) {
914 remove_decode_signal(signal);
923 void Session::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
928 signalbases_.erase(std::remove_if(signalbases_.begin(), signalbases_.end(),
929 [&](shared_ptr<data::SignalBase> s) { return s == signal; }),
932 for (shared_ptr<views::ViewBase>& view : views_)
933 view->remove_decode_signal(signal);
939 MetadataObjManager* Session::metadata_obj_manager()
941 return &metadata_obj_manager_;
944 void Session::set_capture_state(capture_state state)
948 if (state == Running)
950 if (state == Stopped)
951 qDebug("Acquisition took %.2f s", acq_time_.elapsed() / 1000.);
954 lock_guard<mutex> lock(sampling_mutex_);
955 changed = capture_state_ != state;
956 capture_state_ = state;
960 capture_state_changed(state);
963 void Session::update_signals()
966 signalbases_.clear();
968 for (shared_ptr<views::ViewBase>& view : views_) {
969 view->clear_signalbases();
971 view->clear_decode_signals();
977 lock_guard<recursive_mutex> lock(data_mutex_);
979 const shared_ptr<sigrok::Device> sr_dev = device_->device();
981 signalbases_.clear();
983 for (shared_ptr<views::ViewBase>& view : views_) {
984 view->clear_signalbases();
986 view->clear_decode_signals();
992 // Detect what data types we will receive
993 auto channels = sr_dev->channels();
994 unsigned int logic_channel_count = count_if(
995 channels.begin(), channels.end(),
996 [] (shared_ptr<Channel> channel) {
997 return channel->type() == sigrok::ChannelType::LOGIC; });
999 // Create a common data container for the logic signalbases
1001 lock_guard<recursive_mutex> data_lock(data_mutex_);
1003 if (logic_channel_count == 0) {
1004 logic_data_.reset();
1005 } else if (!logic_data_ ||
1006 logic_data_->num_channels() != logic_channel_count) {
1007 logic_data_.reset(new data::Logic(logic_channel_count));
1008 assert(logic_data_);
1012 // Create signalbases if necessary
1013 for (auto channel : sr_dev->channels()) {
1015 // Try to find the channel in the list of existing signalbases
1016 const auto iter = find_if(signalbases_.cbegin(), signalbases_.cend(),
1017 [&](const shared_ptr<SignalBase> &sb) { return sb->channel() == channel; });
1019 // Not found, let's make a signalbase for it
1020 if (iter == signalbases_.cend()) {
1021 shared_ptr<SignalBase> signalbase;
1022 switch(channel->type()->id()) {
1023 case SR_CHANNEL_LOGIC:
1024 signalbase = make_shared<data::SignalBase>(channel, data::SignalBase::LogicChannel);
1025 signalbases_.push_back(signalbase);
1027 all_signal_data_.insert(logic_data_);
1028 signalbase->set_data(logic_data_);
1030 connect(this, SIGNAL(capture_state_changed(int)),
1031 signalbase.get(), SLOT(on_capture_state_changed(int)));
1034 case SR_CHANNEL_ANALOG:
1035 signalbase = make_shared<data::SignalBase>(channel, data::SignalBase::AnalogChannel);
1036 signalbases_.push_back(signalbase);
1038 shared_ptr<data::Analog> data(new data::Analog());
1039 all_signal_data_.insert(data);
1040 signalbase->set_data(data);
1042 connect(this, SIGNAL(capture_state_changed(int)),
1043 signalbase.get(), SLOT(on_capture_state_changed(int)));
1049 for (shared_ptr<views::ViewBase>& viewbase : views_) {
1050 vector< shared_ptr<SignalBase> > view_signalbases =
1051 viewbase->signalbases();
1053 // Add all non-decode signalbases that don't yet exist in the view
1054 for (shared_ptr<SignalBase>& session_sb : signalbases_) {
1055 if (session_sb->type() == SignalBase::DecodeChannel)
1058 const auto iter = find_if(view_signalbases.cbegin(), view_signalbases.cend(),
1059 [&](const shared_ptr<SignalBase> &sb) { return sb == session_sb; });
1061 if (iter == view_signalbases.cend())
1062 viewbase->add_signalbase(session_sb);
1065 // Remove all non-decode signalbases that no longer exist
1066 for (shared_ptr<SignalBase>& view_sb : view_signalbases) {
1067 if (view_sb->type() == SignalBase::DecodeChannel)
1070 const auto iter = find_if(signalbases_.cbegin(), signalbases_.cend(),
1071 [&](const shared_ptr<SignalBase> &sb) { return sb == view_sb; });
1073 if (iter == signalbases_.cend())
1074 viewbase->remove_signalbase(view_sb);
1081 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
1082 shared_ptr<sigrok::Channel> channel) const
1084 for (shared_ptr<data::SignalBase> sig : signalbases_) {
1086 if (sig->channel() == channel)
1089 return shared_ptr<data::SignalBase>();
1092 void Session::sample_thread_proc(function<void (const QString)> error_handler)
1094 assert(error_handler);
1097 pipeline_ = Pipeline::create();
1099 source_ = ElementFactory::create_element("filesrc", "source");
1100 sink_ = RefPtr<AppSink>::cast_dynamic(ElementFactory::create_element("appsink", "sink"));
1102 pipeline_->add(source_)->add(sink_);
1103 source_->link(sink_);
1105 source_->set_property("location", Glib::ustring("/tmp/dummy_binary"));
1107 sink_->set_property("emit-signals", TRUE);
1108 sink_->signal_new_sample().connect(sigc::mem_fun(*this, &Session::on_gst_new_sample));
1110 // Get the bus from the pipeline and add a bus watch to the default main context
1111 RefPtr<Bus> bus = pipeline_->get_bus();
1112 bus->add_watch(sigc::mem_fun(this, &Session::on_gst_bus_message));
1114 // Start pipeline and Wait until it finished processing
1115 pipeline_done_interrupt_ = false;
1116 pipeline_->set_state(Gst::STATE_PLAYING);
1118 unique_lock<mutex> pipeline_done_lock_(pipeline_done_mutex_);
1119 pipeline_done_cond_.wait(pipeline_done_lock_);
1121 // Let the pipeline free all resources
1122 pipeline_->set_state(Gst::STATE_NULL);
1129 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1130 } catch (Error& e) {
1131 cur_samplerate_ = 0;
1134 out_of_memory_ = false;
1137 lock_guard<recursive_mutex> lock(data_mutex_);
1138 cur_logic_segment_.reset();
1139 cur_analog_segments_.clear();
1140 for (shared_ptr<data::SignalBase> sb : signalbases_)
1141 sb->clear_sample_data();
1143 highest_segment_id_ = -1;
1144 frame_began_ = false;
1148 } catch (Error& e) {
1149 error_handler(e.what());
1153 set_capture_state(device_->session()->trigger() ?
1154 AwaitingTrigger : Running);
1158 } catch (Error& e) {
1159 error_handler(e.what());
1160 set_capture_state(Stopped);
1162 } catch (QString& e) {
1164 set_capture_state(Stopped);
1168 set_capture_state(Stopped);
1170 // Confirm that SR_DF_END was received
1171 if (cur_logic_segment_)
1172 qDebug() << "WARNING: SR_DF_END was not received.";
1175 // Optimize memory usage
1176 free_unused_memory();
1178 // We now have unsaved data unless we just "captured" from a file
1179 shared_ptr<devices::File> file_device =
1180 dynamic_pointer_cast<devices::File>(device_);
1183 data_saved_ = false;
1186 error_handler(tr("Out of memory, acquisition stopped."));
1189 void Session::free_unused_memory()
1191 for (const shared_ptr<data::SignalData>& data : all_signal_data_) {
1192 const vector< shared_ptr<data::Segment> > segments = data->segments();
1194 for (const shared_ptr<data::Segment>& segment : segments)
1195 segment->free_unused_memory();
1199 void Session::signal_new_segment()
1201 int new_segment_id = 0;
1203 if ((cur_logic_segment_ != nullptr) || !cur_analog_segments_.empty()) {
1205 // Determine new frame/segment number, assuming that all
1206 // signals have the same number of frames/segments
1207 if (cur_logic_segment_) {
1208 new_segment_id = logic_data_->get_segment_count() - 1;
1210 shared_ptr<sigrok::Channel> any_channel =
1211 (*cur_analog_segments_.begin()).first;
1213 shared_ptr<data::SignalBase> base = signalbase_from_channel(any_channel);
1216 shared_ptr<data::Analog> data(base->analog_data());
1219 new_segment_id = data->get_segment_count() - 1;
1223 if (new_segment_id > highest_segment_id_) {
1224 highest_segment_id_ = new_segment_id;
1225 new_segment(highest_segment_id_);
1229 void Session::signal_segment_completed()
1233 for (const shared_ptr<data::SignalBase>& signalbase : signalbases_) {
1234 // We only care about analog and logic channels, not derived ones
1235 if (signalbase->type() == data::SignalBase::AnalogChannel) {
1236 segment_id = signalbase->analog_data()->get_segment_count() - 1;
1240 if (signalbase->type() == data::SignalBase::LogicChannel) {
1241 segment_id = signalbase->logic_data()->get_segment_count() - 1;
1246 if (segment_id >= 0)
1247 segment_completed(segment_id);
1251 bool Session::on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message)
1255 if ((message->get_source() == pipeline_) && \
1256 ((message->get_message_type() == Gst::MESSAGE_EOS)))
1257 pipeline_done_cond_.notify_one();
1259 // TODO Also evaluate MESSAGE_STREAM_STATUS to receive error notifications
1264 Gst::FlowReturn Session::on_gst_new_sample()
1266 RefPtr<Gst::Sample> sample = sink_->pull_sample();
1267 RefPtr<Gst::Buffer> buf = sample->get_buffer();
1269 for (uint32_t block_id = 0; block_id < buf->n_memory(); block_id++) {
1270 RefPtr<Gst::Memory> buf_mem = buf->get_memory(block_id);
1271 Gst::MapInfo mapinfo;
1272 buf_mem->map(mapinfo, Gst::MAP_READ);
1274 shared_ptr<sigrok::Packet> logic_packet =
1275 sr_context->create_logic_packet(mapinfo.get_data(), buf->get_size(), 1);
1278 feed_in_logic(dynamic_pointer_cast<sigrok::Logic>(logic_packet->payload()));
1279 } catch (bad_alloc&) {
1280 out_of_memory_ = true;
1282 buf_mem->unmap(mapinfo);
1283 return Gst::FLOW_ERROR;
1286 buf_mem->unmap(mapinfo);
1289 return Gst::FLOW_OK;
1293 void Session::feed_in_header()
1295 // Nothing to do here for now
1298 void Session::feed_in_meta(shared_ptr<Meta> meta)
1300 for (auto& entry : meta->config()) {
1301 switch (entry.first->id()) {
1302 case SR_CONF_SAMPLERATE:
1303 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
1306 qDebug() << "Received meta data key" << entry.first->id() << ", ignoring.";
1314 void Session::feed_in_trigger()
1316 // The channel containing most samples should be most accurate
1317 uint64_t sample_count = 0;
1320 for (const shared_ptr<pv::data::SignalData>& d : all_signal_data_) {
1322 uint64_t temp_count = 0;
1324 const vector< shared_ptr<pv::data::Segment> > segments =
1326 for (const shared_ptr<pv::data::Segment> &s : segments)
1327 temp_count += s->get_sample_count();
1329 if (temp_count > sample_count)
1330 sample_count = temp_count;
1334 uint32_t segment_id = 0; // Default segment when no frames are used
1336 // If a frame began, we'd ideally be able to use the highest segment ID for
1337 // the trigger. However, as new segments are only created when logic or
1338 // analog data comes in, this doesn't work if the trigger appears right
1339 // after the beginning of the frame, before any sample data.
1340 // For this reason, we use highest segment ID + 1 if no sample data came in
1341 // yet and the highest segment ID otherwise.
1343 segment_id = highest_segment_id_;
1344 if (!cur_logic_segment_ && (cur_analog_segments_.size() == 0))
1348 // TODO Create timestamp from segment start time + segment's current sample count
1349 util::Timestamp timestamp = sample_count / get_samplerate();
1350 trigger_list_.emplace_back(segment_id, timestamp);
1351 trigger_event(segment_id, timestamp);
1354 void Session::feed_in_frame_begin()
1356 frame_began_ = true;
1359 void Session::feed_in_frame_end()
1365 lock_guard<recursive_mutex> lock(data_mutex_);
1367 if (cur_logic_segment_)
1368 cur_logic_segment_->set_complete();
1370 for (auto& entry : cur_analog_segments_) {
1371 shared_ptr<data::AnalogSegment> segment = entry.second;
1372 segment->set_complete();
1375 cur_logic_segment_.reset();
1376 cur_analog_segments_.clear();
1379 frame_began_ = false;
1381 signal_segment_completed();
1384 void Session::feed_in_logic(shared_ptr<sigrok::Logic> logic)
1386 if (logic->data_length() == 0) {
1387 qDebug() << "WARNING: Received logic packet with 0 samples.";
1391 if (logic->unit_size() > 8)
1392 throw QString(tr("Can't handle more than 64 logic channels."));
1394 if (!cur_samplerate_)
1396 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1397 } catch (Error& e) {
1401 lock_guard<recursive_mutex> lock(data_mutex_);
1404 // The only reason logic_data_ would not have been created is
1405 // if it was not possible to determine the signals when the
1406 // device was created.
1410 if (!cur_logic_segment_) {
1411 // This could be the first packet after a trigger
1412 set_capture_state(Running);
1414 // Create a new data segment
1415 cur_logic_segment_ = make_shared<data::LogicSegment>(
1416 *logic_data_, logic_data_->get_segment_count(),
1417 logic->unit_size(), cur_samplerate_);
1418 logic_data_->push_segment(cur_logic_segment_);
1420 signal_new_segment();
1423 cur_logic_segment_->append_payload(logic);
1428 void Session::feed_in_analog(shared_ptr<sigrok::Analog> analog)
1430 if (analog->num_samples() == 0) {
1431 qDebug() << "WARNING: Received analog packet with 0 samples.";
1435 if (!cur_samplerate_)
1437 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1438 } catch (Error& e) {
1442 lock_guard<recursive_mutex> lock(data_mutex_);
1444 const vector<shared_ptr<Channel>> channels = analog->channels();
1445 bool sweep_beginning = false;
1447 unique_ptr<float[]> data(new float[analog->num_samples() * channels.size()]);
1448 analog->get_data_as_float(data.get());
1450 if (signalbases_.empty())
1453 float *channel_data = data.get();
1454 for (auto& channel : channels) {
1455 shared_ptr<data::AnalogSegment> segment;
1457 // Try to get the segment of the channel
1458 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
1459 iterator iter = cur_analog_segments_.find(channel);
1460 if (iter != cur_analog_segments_.end())
1461 segment = (*iter).second;
1463 // If no segment was found, this means we haven't
1464 // created one yet. i.e. this is the first packet
1465 // in the sweep containing this segment.
1466 sweep_beginning = true;
1468 // Find the analog data associated with the channel
1469 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1472 shared_ptr<data::Analog> data(base->analog_data());
1475 // Create a segment, keep it in the maps of channels
1476 segment = make_shared<data::AnalogSegment>(
1477 *data, data->get_segment_count(), cur_samplerate_);
1478 cur_analog_segments_[channel] = segment;
1480 // Push the segment into the analog data.
1481 data->push_segment(segment);
1483 signal_new_segment();
1488 // Append the samples in the segment
1489 segment->append_interleaved_samples(channel_data++, analog->num_samples(),
1493 if (sweep_beginning) {
1494 // This could be the first packet after a trigger
1495 set_capture_state(Running);
1501 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1502 shared_ptr<Packet> packet)
1507 assert(device == device_->device());
1510 switch (packet->type()->id()) {
1516 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1525 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1526 } catch (bad_alloc&) {
1527 out_of_memory_ = true;
1534 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1535 } catch (bad_alloc&) {
1536 out_of_memory_ = true;
1541 case SR_DF_FRAME_BEGIN:
1542 feed_in_frame_begin();
1545 case SR_DF_FRAME_END:
1546 feed_in_frame_end();
1550 // Strictly speaking, this is performed when a frame end marker was
1551 // received, so there's no point doing this again. However, not all
1552 // devices use frames, and for those devices, we need to do it here.
1554 lock_guard<recursive_mutex> lock(data_mutex_);
1556 if (cur_logic_segment_)
1557 cur_logic_segment_->set_complete();
1559 for (auto& entry : cur_analog_segments_) {
1560 shared_ptr<data::AnalogSegment> segment = entry.second;
1561 segment->set_complete();
1564 cur_logic_segment_.reset();
1565 cur_analog_segments_.clear();
1574 void Session::on_data_saved()
1579 #ifdef ENABLE_DECODE
1580 void Session::on_new_decoders_selected(vector<const srd_decoder*> decoders)
1582 assert(decoders.size() > 0);
1584 shared_ptr<data::DecodeSignal> signal = add_decode_signal();
1587 for (unsigned int i = 0; i < decoders.size(); i++) {
1588 const srd_decoder* d = decoders[i];
1589 signal->stack_decoder(d, !(i < decoders.size() - 1));