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"
34 #include "data/analog.hpp"
35 #include "data/analogsegment.hpp"
36 #include "data/decode/decoder.hpp"
37 #include "data/logic.hpp"
38 #include "data/logicsegment.hpp"
39 #include "data/signalbase.hpp"
41 #include "devices/hardwaredevice.hpp"
42 #include "devices/inputfile.hpp"
43 #include "devices/sessionfile.hpp"
45 #include "toolbars/mainbar.hpp"
47 #include "views/trace/analogsignal.hpp"
48 #include "views/trace/decodetrace.hpp"
49 #include "views/trace/logicsignal.hpp"
50 #include "views/trace/signal.hpp"
51 #include "views/trace/view.hpp"
53 #include <libsigrokcxx/libsigrokcxx.hpp>
56 #include <gstreamermm.h>
57 #include <libsigrokflow/libsigrokflow.hpp>
61 #include <libsigrokdecode/libsigrokdecode.h>
62 #include "data/decodesignal.hpp"
66 using std::dynamic_pointer_cast;
69 using std::lock_guard;
72 using std::make_shared;
78 using std::recursive_mutex;
79 using std::runtime_error;
80 using std::shared_ptr;
83 using std::unique_lock;
85 using std::unique_ptr;
86 using std::unordered_set;
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::views::trace::Signal;
109 using pv::views::trace::AnalogSignal;
110 using pv::views::trace::LogicSignal;
114 shared_ptr<sigrok::Context> Session::sr_context;
116 Session::Session(DeviceManager &device_manager, QString name) :
117 device_manager_(device_manager),
120 capture_state_(Stopped),
128 // Stop and join to the thread
132 DeviceManager& Session::device_manager()
134 return device_manager_;
137 const DeviceManager& Session::device_manager() const
139 return device_manager_;
142 shared_ptr<sigrok::Session> Session::session() const
145 return shared_ptr<sigrok::Session>();
146 return device_->session();
149 shared_ptr<devices::Device> Session::device() const
154 QString Session::name() const
159 void Session::set_name(QString name)
161 if (default_name_.isEmpty())
162 default_name_ = name;
169 const list< shared_ptr<views::ViewBase> > Session::views() const
174 shared_ptr<views::ViewBase> Session::main_view() const
179 void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
181 main_bar_ = main_bar;
184 shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
189 bool Session::data_saved() const
194 void Session::save_setup(QSettings &settings) const
196 int decode_signals = 0, views = 0;
198 // Save channels and decoders
199 for (const shared_ptr<data::SignalBase>& base : signalbases_) {
201 if (base->is_decode_signal()) {
202 settings.beginGroup("decode_signal" + QString::number(decode_signals++));
203 base->save_settings(settings);
208 settings.beginGroup(base->internal_name());
209 base->save_settings(settings);
214 settings.setValue("decode_signals", decode_signals);
216 // Save view states and their signal settings
217 // Note: main_view must be saved as view0
218 settings.beginGroup("view" + QString::number(views++));
219 main_view_->save_settings(settings);
222 for (const shared_ptr<views::ViewBase>& view : views_) {
223 if (view != main_view_) {
224 settings.beginGroup("view" + QString::number(views++));
225 settings.setValue("type", view->get_type());
226 view->save_settings(settings);
231 settings.setValue("views", views);
234 void Session::save_settings(QSettings &settings) const
236 map<string, string> dev_info;
237 list<string> key_list;
240 shared_ptr<devices::HardwareDevice> hw_device =
241 dynamic_pointer_cast< devices::HardwareDevice >(device_);
244 settings.setValue("device_type", "hardware");
245 settings.beginGroup("device");
247 key_list.emplace_back("vendor");
248 key_list.emplace_back("model");
249 key_list.emplace_back("version");
250 key_list.emplace_back("serial_num");
251 key_list.emplace_back("connection_id");
253 dev_info = device_manager_.get_device_info(device_);
255 for (string& key : key_list) {
256 if (dev_info.count(key))
257 settings.setValue(QString::fromUtf8(key.c_str()),
258 QString::fromUtf8(dev_info.at(key).c_str()));
260 settings.remove(QString::fromUtf8(key.c_str()));
266 shared_ptr<devices::SessionFile> sessionfile_device =
267 dynamic_pointer_cast<devices::SessionFile>(device_);
269 if (sessionfile_device) {
270 settings.setValue("device_type", "sessionfile");
271 settings.beginGroup("device");
272 settings.setValue("filename", QString::fromStdString(
273 sessionfile_device->full_name()));
277 shared_ptr<devices::InputFile> inputfile_device =
278 dynamic_pointer_cast<devices::InputFile>(device_);
280 if (inputfile_device) {
281 settings.setValue("device_type", "inputfile");
282 settings.beginGroup("device");
283 inputfile_device->save_meta_to_settings(settings);
287 save_setup(settings);
291 void Session::restore_setup(QSettings &settings)
294 for (shared_ptr<data::SignalBase> base : signalbases_) {
295 settings.beginGroup(base->internal_name());
296 base->restore_settings(settings);
302 int decode_signals = settings.value("decode_signals").toInt();
304 for (int i = 0; i < decode_signals; i++) {
305 settings.beginGroup("decode_signal" + QString::number(i));
306 shared_ptr<data::DecodeSignal> signal = add_decode_signal();
307 signal->restore_settings(settings);
313 int views = settings.value("views").toInt();
315 for (int i = 0; i < views; i++) {
316 settings.beginGroup("view" + QString::number(i));
319 views::ViewType type = (views::ViewType)settings.value("type").toInt();
320 add_view(type, this);
321 views_.back()->restore_settings(settings);
323 main_view_->restore_settings(settings);
329 void Session::restore_settings(QSettings &settings)
331 shared_ptr<devices::Device> device;
333 QString device_type = settings.value("device_type").toString();
335 if (device_type == "hardware") {
336 map<string, string> dev_info;
337 list<string> key_list;
339 // Re-select last used device if possible but only if it's not demo
340 settings.beginGroup("device");
341 key_list.emplace_back("vendor");
342 key_list.emplace_back("model");
343 key_list.emplace_back("version");
344 key_list.emplace_back("serial_num");
345 key_list.emplace_back("connection_id");
347 for (string key : key_list) {
348 const QString k = QString::fromStdString(key);
349 if (!settings.contains(k))
352 const string value = settings.value(k).toString().toStdString();
354 dev_info.insert(make_pair(key, value));
357 if (dev_info.count("model") > 0)
358 device = device_manager_.find_device_from_info(dev_info);
366 if ((device_type == "sessionfile") || (device_type == "inputfile")) {
367 if (device_type == "sessionfile") {
368 settings.beginGroup("device");
369 QString filename = settings.value("filename").toString();
372 if (QFileInfo(filename).isReadable()) {
373 device = make_shared<devices::SessionFile>(device_manager_.context(),
374 filename.toStdString());
378 if (device_type == "inputfile") {
379 settings.beginGroup("device");
380 device = make_shared<devices::InputFile>(device_manager_.context(),
388 start_capture([](QString infoMessage) {
389 // TODO Emulate noquote()
390 qDebug() << "Session error:" << infoMessage; });
392 set_name(QString::fromStdString(
393 dynamic_pointer_cast<devices::File>(device)->display_name(device_manager_)));
398 restore_setup(settings);
401 void Session::select_device(shared_ptr<devices::Device> device)
407 set_default_device();
408 } catch (const QString &e) {
409 MainWindow::show_session_error(tr("Failed to select device"), e);
413 void Session::set_device(shared_ptr<devices::Device> device)
417 // Ensure we are not capturing before setting the device
425 // Revert name back to default name (e.g. "Session 1") as the data is gone
426 name_ = default_name_;
429 // Remove all stored data and reset all views
430 for (shared_ptr<views::ViewBase> view : views_) {
431 view->clear_signals();
433 view->clear_decode_signals();
435 view->reset_view_state();
437 for (const shared_ptr<data::SignalData>& d : all_signal_data_)
439 all_signal_data_.clear();
440 signalbases_.clear();
441 cur_logic_segment_.reset();
443 for (auto& entry : cur_analog_segments_) {
444 shared_ptr<sigrok::Channel>(entry.first).reset();
445 shared_ptr<data::AnalogSegment>(entry.second).reset();
452 device_ = move(device);
456 } catch (const QString &e) {
458 MainWindow::show_session_error(tr("Failed to open device"), e);
462 device_->session()->add_datafeed_callback([=]
463 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
464 data_feed_in(device, packet);
473 void Session::set_default_device()
475 const list< shared_ptr<devices::HardwareDevice> > &devices =
476 device_manager_.devices();
481 // Try and find the demo device and select that by default
482 const auto iter = find_if(devices.begin(), devices.end(),
483 [] (const shared_ptr<devices::HardwareDevice> &d) {
484 return d->hardware_device()->driver()->name() == "demo"; });
485 set_device((iter == devices.end()) ? devices.front() : *iter);
489 * Convert generic options to data types that are specific to InputFormat.
491 * @param[in] user_spec Vector of tokenized words, string format.
492 * @param[in] fmt_opts Input format's options, result of InputFormat::options().
494 * @return Map of options suitable for InputFormat::create_input().
496 map<string, Glib::VariantBase>
497 Session::input_format_options(vector<string> user_spec,
498 map<string, shared_ptr<Option>> fmt_opts)
500 map<string, Glib::VariantBase> result;
502 for (auto& entry : user_spec) {
504 * Split key=value specs. Accept entries without separator
505 * (for simplified boolean specifications).
508 size_t pos = entry.find("=");
509 if (pos == std::string::npos) {
513 key = entry.substr(0, pos);
514 val = entry.substr(pos + 1);
518 * Skip user specifications that are not a member of the
519 * format's set of supported options. Have the text input
520 * spec converted to the required input format specific
523 auto found = fmt_opts.find(key);
524 if (found == fmt_opts.end())
526 shared_ptr<Option> opt = found->second;
527 result[key] = opt->parse_string(val);
533 void Session::load_init_file(const string &file_name,
534 const string &format, const string &setup_file_name)
536 shared_ptr<InputFormat> input_format;
537 map<string, Glib::VariantBase> input_opts;
539 if (!format.empty()) {
540 const map<string, shared_ptr<InputFormat> > formats =
541 device_manager_.context()->input_formats();
542 auto user_opts = pv::util::split_string(format, ":");
543 string user_name = user_opts.front();
544 user_opts.erase(user_opts.begin());
545 const auto iter = find_if(formats.begin(), formats.end(),
546 [&](const pair<string, shared_ptr<InputFormat> > f) {
547 return f.first == user_name; });
548 if (iter == formats.end()) {
549 MainWindow::show_session_error(tr("Error"),
550 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
553 input_format = (*iter).second;
554 input_opts = input_format_options(user_opts,
555 input_format->options());
558 load_file(QString::fromStdString(file_name), QString::fromStdString(setup_file_name),
559 input_format, input_opts);
562 void Session::load_file(QString file_name, QString setup_file_name,
563 shared_ptr<sigrok::InputFormat> format, const map<string, Glib::VariantBase> &options)
565 const QString errorMessage(
566 QString("Failed to load file %1").arg(file_name));
568 // In the absence of a caller's format spec, try to auto detect.
569 // Assume "sigrok session file" upon lookup miss.
571 format = device_manager_.context()->input_format_match(file_name.toStdString());
574 set_device(shared_ptr<devices::Device>(
575 new devices::InputFile(
576 device_manager_.context(),
577 file_name.toStdString(),
580 set_device(shared_ptr<devices::Device>(
581 new devices::SessionFile(
582 device_manager_.context(),
583 file_name.toStdString())));
585 MainWindow::show_session_error(tr("Failed to load ") + file_name, e.what());
586 set_default_device();
587 main_bar_->update_device_list();
591 // Use the input file with .pvs extension if no setup file was given
592 if (setup_file_name.isEmpty()) {
593 setup_file_name = file_name;
594 setup_file_name.truncate(setup_file_name.lastIndexOf('.'));
595 setup_file_name.append(".pvs");
598 if (QFileInfo::exists(setup_file_name) && QFileInfo(setup_file_name).isReadable()) {
599 QSettings settings_storage(setup_file_name, QSettings::IniFormat);
600 restore_setup(settings_storage);
603 main_bar_->update_device_list();
605 start_capture([&, errorMessage](QString infoMessage) {
606 MainWindow::show_session_error(errorMessage, infoMessage); });
608 set_name(QFileInfo(file_name).fileName());
611 Session::capture_state Session::get_capture_state() const
613 lock_guard<mutex> lock(sampling_mutex_);
614 return capture_state_;
617 void Session::start_capture(function<void (const QString)> error_handler)
620 error_handler(tr("No active device set, can't start acquisition."));
626 // Check that at least one channel is enabled
627 const shared_ptr<sigrok::Device> sr_dev = device_->device();
629 const auto channels = sr_dev->channels();
630 if (!any_of(channels.begin(), channels.end(),
631 [](shared_ptr<Channel> channel) {
632 return channel->enabled(); })) {
633 error_handler(tr("No channels enabled."));
639 for (const shared_ptr<data::SignalData>& d : all_signal_data_)
642 trigger_list_.clear();
644 // Revert name back to default name (e.g. "Session 1") for real devices
645 // as the (possibly saved) data is gone. File devices keep their name.
646 shared_ptr<devices::HardwareDevice> hw_device =
647 dynamic_pointer_cast< devices::HardwareDevice >(device_);
650 name_ = default_name_;
655 sampling_thread_ = std::thread(
656 &Session::sample_thread_proc, this, error_handler);
659 void Session::stop_capture()
661 if (get_capture_state() != Stopped)
664 // Check that sampling stopped
665 if (sampling_thread_.joinable())
666 sampling_thread_.join();
669 void Session::register_view(shared_ptr<views::ViewBase> view)
674 views_.push_back(view);
676 // Add all device signals
679 // Add all other signals
680 unordered_set< shared_ptr<data::SignalBase> > view_signalbases = view->signalbases();
682 for (const shared_ptr<data::SignalBase>& signalbase : signalbases_) {
683 const int sb_exists = count_if(
684 view_signalbases.cbegin(), view_signalbases.cend(),
685 [&](const shared_ptr<data::SignalBase> &sb) {
686 return sb == signalbase;
689 // Add the signal to the view if it doesn't have it yet
691 switch (signalbase->type()) {
692 case data::SignalBase::AnalogChannel:
693 case data::SignalBase::LogicChannel:
694 case data::SignalBase::MathChannel:
695 view->add_signalbase(signalbase);
697 case data::SignalBase::DecodeChannel:
699 view->add_decode_signal(dynamic_pointer_cast<data::DecodeSignal>(signalbase));
708 void Session::deregister_view(shared_ptr<views::ViewBase> view)
710 views_.remove_if([&](shared_ptr<views::ViewBase> v) { return v == view; });
712 if (views_.empty()) {
715 // Without a view there can be no main bar
720 bool Session::has_view(shared_ptr<views::ViewBase> view)
722 for (shared_ptr<views::ViewBase>& v : views_)
729 double Session::get_samplerate() const
731 double samplerate = 0.0;
733 for (const shared_ptr<pv::data::SignalData>& d : all_signal_data_) {
735 const vector< shared_ptr<pv::data::Segment> > segments =
737 for (const shared_ptr<pv::data::Segment>& s : segments)
738 samplerate = max(samplerate, s->samplerate());
740 // If there is no sample rate given we use samples as unit
741 if (samplerate == 0.0)
747 uint32_t Session::get_segment_count() const
751 // Find the highest number of segments
752 for (const shared_ptr<data::SignalData>& data : all_signal_data_)
753 if (data->get_segment_count() > value)
754 value = data->get_segment_count();
759 vector<util::Timestamp> Session::get_triggers(uint32_t segment_id) const
761 vector<util::Timestamp> result;
763 for (const pair<uint32_t, util::Timestamp>& entry : trigger_list_)
764 if (entry.first == segment_id)
765 result.push_back(entry.second);
770 const unordered_set< shared_ptr<data::SignalBase> > Session::signalbases() const
775 bool Session::all_segments_complete(uint32_t segment_id) const
777 bool all_complete = true;
779 for (const shared_ptr<data::SignalBase>& base : signalbases_)
780 if (!base->segment_is_complete(segment_id))
781 all_complete = false;
787 shared_ptr<data::DecodeSignal> Session::add_decode_signal()
789 shared_ptr<data::DecodeSignal> signal;
792 // Create the decode signal
793 signal = make_shared<data::DecodeSignal>(*this);
795 signalbases_.insert(signal);
797 // Add the decode signal to all views
798 for (shared_ptr<views::ViewBase>& view : views_)
799 view->add_decode_signal(signal);
800 } catch (runtime_error& e) {
801 remove_decode_signal(signal);
810 void Session::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
812 signalbases_.erase(signal);
814 for (shared_ptr<views::ViewBase>& view : views_)
815 view->remove_decode_signal(signal);
821 void Session::set_capture_state(capture_state state)
825 if (state == Running)
827 if (state == Stopped)
828 qDebug("Acquisition took %.2f s", acq_time_.elapsed() / 1000.);
831 lock_guard<mutex> lock(sampling_mutex_);
832 changed = capture_state_ != state;
833 capture_state_ = state;
837 capture_state_changed(state);
840 void Session::update_signals()
843 signalbases_.clear();
845 for (shared_ptr<views::ViewBase>& view : views_) {
846 view->clear_signals();
848 view->clear_decode_signals();
854 lock_guard<recursive_mutex> lock(data_mutex_);
856 const shared_ptr<sigrok::Device> sr_dev = device_->device();
858 signalbases_.clear();
860 for (shared_ptr<views::ViewBase>& view : views_) {
861 view->clear_signals();
863 view->clear_decode_signals();
869 // Detect what data types we will receive
870 auto channels = sr_dev->channels();
871 unsigned int logic_channel_count = count_if(
872 channels.begin(), channels.end(),
873 [] (shared_ptr<Channel> channel) {
874 return channel->type() == sigrok::ChannelType::LOGIC; });
876 // Create data containers for the logic data segments
878 lock_guard<recursive_mutex> data_lock(data_mutex_);
880 if (logic_channel_count == 0) {
882 } else if (!logic_data_ ||
883 logic_data_->num_channels() != logic_channel_count) {
884 logic_data_.reset(new data::Logic(
885 logic_channel_count));
890 // Make the signals list
891 for (shared_ptr<views::ViewBase>& viewbase : views_) {
892 views::trace::View *trace_view =
893 qobject_cast<views::trace::View*>(viewbase.get());
896 unordered_set< shared_ptr<Signal> > prev_sigs(trace_view->signals());
897 trace_view->clear_signals();
899 for (auto channel : sr_dev->channels()) {
900 shared_ptr<data::SignalBase> signalbase;
901 shared_ptr<Signal> signal;
903 // Find the channel in the old signals
904 const auto iter = find_if(
905 prev_sigs.cbegin(), prev_sigs.cend(),
906 [&](const shared_ptr<Signal> &s) {
907 return s->base()->channel() == channel;
909 if (iter != prev_sigs.end()) {
910 // Copy the signal from the old set to the new
912 trace_view->add_signal(signal);
914 // Find the signalbase for this channel if possible
916 for (const shared_ptr<data::SignalBase>& b : signalbases_)
917 if (b->channel() == channel)
920 shared_ptr<Signal> signal;
922 switch(channel->type()->id()) {
923 case SR_CHANNEL_LOGIC:
925 signalbase = make_shared<data::SignalBase>(channel,
926 data::SignalBase::LogicChannel);
927 signalbases_.insert(signalbase);
929 all_signal_data_.insert(logic_data_);
930 signalbase->set_data(logic_data_);
932 connect(this, SIGNAL(capture_state_changed(int)),
933 signalbase.get(), SLOT(on_capture_state_changed(int)));
936 signal = shared_ptr<Signal>(new LogicSignal(*this, device_, signalbase));
939 case SR_CHANNEL_ANALOG:
942 signalbase = make_shared<data::SignalBase>(channel,
943 data::SignalBase::AnalogChannel);
944 signalbases_.insert(signalbase);
946 shared_ptr<data::Analog> data(new data::Analog());
947 all_signal_data_.insert(data);
948 signalbase->set_data(data);
950 connect(this, SIGNAL(capture_state_changed(int)),
951 signalbase.get(), SLOT(on_capture_state_changed(int)));
954 signal = shared_ptr<Signal>(new AnalogSignal(*this, signalbase));
963 // New views take their signal settings from the main view
964 if (!viewbase->is_main_view()) {
965 shared_ptr<pv::views::trace::View> main_tv =
966 dynamic_pointer_cast<pv::views::trace::View>(main_view_);
967 shared_ptr<Signal> main_signal =
968 main_tv->get_signal_by_signalbase(signalbase);
969 signal->restore_settings(main_signal->save_settings());
972 trace_view->add_signal(signal);
981 shared_ptr<data::SignalBase> Session::signalbase_from_channel(
982 shared_ptr<sigrok::Channel> channel) const
984 for (shared_ptr<data::SignalBase> sig : signalbases_) {
986 if (sig->channel() == channel)
989 return shared_ptr<data::SignalBase>();
992 void Session::sample_thread_proc(function<void (const QString)> error_handler)
994 assert(error_handler);
997 pipeline_ = Pipeline::create();
999 source_ = ElementFactory::create_element("filesrc", "source");
1000 sink_ = RefPtr<AppSink>::cast_dynamic(ElementFactory::create_element("appsink", "sink"));
1002 pipeline_->add(source_)->add(sink_);
1003 source_->link(sink_);
1005 source_->set_property("location", Glib::ustring("/tmp/dummy_binary"));
1007 sink_->set_property("emit-signals", TRUE);
1008 sink_->signal_new_sample().connect(sigc::mem_fun(*this, &Session::on_gst_new_sample));
1010 // Get the bus from the pipeline and add a bus watch to the default main context
1011 RefPtr<Bus> bus = pipeline_->get_bus();
1012 bus->add_watch(sigc::mem_fun(this, &Session::on_gst_bus_message));
1014 // Start pipeline and Wait until it finished processing
1015 pipeline_done_interrupt_ = false;
1016 pipeline_->set_state(Gst::STATE_PLAYING);
1018 unique_lock<mutex> pipeline_done_lock_(pipeline_done_mutex_);
1019 pipeline_done_cond_.wait(pipeline_done_lock_);
1021 // Let the pipeline free all resources
1022 pipeline_->set_state(Gst::STATE_NULL);
1029 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1030 } catch (Error& e) {
1031 cur_samplerate_ = 0;
1034 out_of_memory_ = false;
1037 lock_guard<recursive_mutex> lock(data_mutex_);
1038 cur_logic_segment_.reset();
1039 cur_analog_segments_.clear();
1041 highest_segment_id_ = -1;
1042 frame_began_ = false;
1046 } catch (Error& e) {
1047 error_handler(e.what());
1051 set_capture_state(device_->session()->trigger() ?
1052 AwaitingTrigger : Running);
1056 } catch (Error& e) {
1057 error_handler(e.what());
1058 set_capture_state(Stopped);
1060 } catch (QString& e) {
1062 set_capture_state(Stopped);
1066 set_capture_state(Stopped);
1068 // Confirm that SR_DF_END was received
1069 if (cur_logic_segment_)
1070 qDebug() << "WARNING: SR_DF_END was not received.";
1073 // Optimize memory usage
1074 free_unused_memory();
1076 // We now have unsaved data unless we just "captured" from a file
1077 shared_ptr<devices::File> file_device =
1078 dynamic_pointer_cast<devices::File>(device_);
1081 data_saved_ = false;
1084 error_handler(tr("Out of memory, acquisition stopped."));
1087 void Session::free_unused_memory()
1089 for (const shared_ptr<data::SignalData>& data : all_signal_data_) {
1090 const vector< shared_ptr<data::Segment> > segments = data->segments();
1092 for (const shared_ptr<data::Segment>& segment : segments)
1093 segment->free_unused_memory();
1097 void Session::signal_new_segment()
1099 int new_segment_id = 0;
1101 if ((cur_logic_segment_ != nullptr) || !cur_analog_segments_.empty()) {
1103 // Determine new frame/segment number, assuming that all
1104 // signals have the same number of frames/segments
1105 if (cur_logic_segment_) {
1106 new_segment_id = logic_data_->get_segment_count() - 1;
1108 shared_ptr<sigrok::Channel> any_channel =
1109 (*cur_analog_segments_.begin()).first;
1111 shared_ptr<data::SignalBase> base = signalbase_from_channel(any_channel);
1114 shared_ptr<data::Analog> data(base->analog_data());
1117 new_segment_id = data->get_segment_count() - 1;
1121 if (new_segment_id > highest_segment_id_) {
1122 highest_segment_id_ = new_segment_id;
1123 new_segment(highest_segment_id_);
1127 void Session::signal_segment_completed()
1131 for (const shared_ptr<data::SignalBase>& signalbase : signalbases_) {
1132 // We only care about analog and logic channels, not derived ones
1133 if (signalbase->type() == data::SignalBase::AnalogChannel) {
1134 segment_id = signalbase->analog_data()->get_segment_count() - 1;
1138 if (signalbase->type() == data::SignalBase::LogicChannel) {
1139 segment_id = signalbase->logic_data()->get_segment_count() - 1;
1144 if (segment_id >= 0)
1145 segment_completed(segment_id);
1149 bool Session::on_gst_bus_message(const Glib::RefPtr<Gst::Bus>& bus, const Glib::RefPtr<Gst::Message>& message)
1153 if ((message->get_source() == pipeline_) && \
1154 ((message->get_message_type() == Gst::MESSAGE_EOS)))
1155 pipeline_done_cond_.notify_one();
1157 // TODO Also evaluate MESSAGE_STREAM_STATUS to receive error notifications
1162 Gst::FlowReturn Session::on_gst_new_sample()
1164 RefPtr<Gst::Sample> sample = sink_->pull_sample();
1165 RefPtr<Gst::Buffer> buf = sample->get_buffer();
1167 for (uint32_t block_id = 0; block_id < buf->n_memory(); block_id++) {
1168 RefPtr<Gst::Memory> buf_mem = buf->get_memory(block_id);
1169 Gst::MapInfo mapinfo;
1170 buf_mem->map(mapinfo, Gst::MAP_READ);
1172 shared_ptr<sigrok::Packet> logic_packet =
1173 sr_context->create_logic_packet(mapinfo.get_data(), buf->get_size(), 1);
1176 feed_in_logic(dynamic_pointer_cast<sigrok::Logic>(logic_packet->payload()));
1177 } catch (bad_alloc&) {
1178 out_of_memory_ = true;
1180 buf_mem->unmap(mapinfo);
1181 return Gst::FLOW_ERROR;
1184 buf_mem->unmap(mapinfo);
1187 return Gst::FLOW_OK;
1191 void Session::feed_in_header()
1193 // Nothing to do here for now
1196 void Session::feed_in_meta(shared_ptr<Meta> meta)
1198 for (auto& entry : meta->config()) {
1199 switch (entry.first->id()) {
1200 case SR_CONF_SAMPLERATE:
1201 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
1204 qDebug() << "Received meta data key" << entry.first->id() << ", ignoring.";
1212 void Session::feed_in_trigger()
1214 // The channel containing most samples should be most accurate
1215 uint64_t sample_count = 0;
1218 for (const shared_ptr<pv::data::SignalData>& d : all_signal_data_) {
1220 uint64_t temp_count = 0;
1222 const vector< shared_ptr<pv::data::Segment> > segments =
1224 for (const shared_ptr<pv::data::Segment> &s : segments)
1225 temp_count += s->get_sample_count();
1227 if (temp_count > sample_count)
1228 sample_count = temp_count;
1232 uint32_t segment_id = 0; // Default segment when no frames are used
1234 // If a frame began, we'd ideally be able to use the highest segment ID for
1235 // the trigger. However, as new segments are only created when logic or
1236 // analog data comes in, this doesn't work if the trigger appears right
1237 // after the beginning of the frame, before any sample data.
1238 // For this reason, we use highest segment ID + 1 if no sample data came in
1239 // yet and the highest segment ID otherwise.
1241 segment_id = highest_segment_id_;
1242 if (!cur_logic_segment_ && (cur_analog_segments_.size() == 0))
1246 // TODO Create timestamp from segment start time + segment's current sample count
1247 util::Timestamp timestamp = sample_count / get_samplerate();
1248 trigger_list_.emplace_back(segment_id, timestamp);
1249 trigger_event(segment_id, timestamp);
1252 void Session::feed_in_frame_begin()
1254 frame_began_ = true;
1257 void Session::feed_in_frame_end()
1263 lock_guard<recursive_mutex> lock(data_mutex_);
1265 if (cur_logic_segment_)
1266 cur_logic_segment_->set_complete();
1268 for (auto& entry : cur_analog_segments_) {
1269 shared_ptr<data::AnalogSegment> segment = entry.second;
1270 segment->set_complete();
1273 cur_logic_segment_.reset();
1274 cur_analog_segments_.clear();
1277 frame_began_ = false;
1279 signal_segment_completed();
1282 void Session::feed_in_logic(shared_ptr<Logic> logic)
1284 if (logic->data_length() == 0) {
1285 qDebug() << "WARNING: Received logic packet with 0 samples.";
1289 if (logic->unit_size() > 8)
1290 throw QString(tr("Can't handle more than 64 logic channels."));
1292 if (!cur_samplerate_)
1294 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1295 } catch (Error& e) {
1299 lock_guard<recursive_mutex> lock(data_mutex_);
1302 // The only reason logic_data_ would not have been created is
1303 // if it was not possible to determine the signals when the
1304 // device was created.
1308 if (!cur_logic_segment_) {
1309 // This could be the first packet after a trigger
1310 set_capture_state(Running);
1312 // Create a new data segment
1313 cur_logic_segment_ = make_shared<data::LogicSegment>(
1314 *logic_data_, logic_data_->get_segment_count(),
1315 logic->unit_size(), cur_samplerate_);
1316 logic_data_->push_segment(cur_logic_segment_);
1318 signal_new_segment();
1321 cur_logic_segment_->append_payload(logic);
1326 void Session::feed_in_analog(shared_ptr<Analog> analog)
1328 if (analog->num_samples() == 0) {
1329 qDebug() << "WARNING: Received analog packet with 0 samples.";
1333 if (!cur_samplerate_)
1335 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
1336 } catch (Error& e) {
1340 lock_guard<recursive_mutex> lock(data_mutex_);
1342 const vector<shared_ptr<Channel>> channels = analog->channels();
1343 bool sweep_beginning = false;
1345 unique_ptr<float[]> data(new float[analog->num_samples() * channels.size()]);
1346 analog->get_data_as_float(data.get());
1348 if (signalbases_.empty())
1351 float *channel_data = data.get();
1352 for (auto& channel : channels) {
1353 shared_ptr<data::AnalogSegment> segment;
1355 // Try to get the segment of the channel
1356 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
1357 iterator iter = cur_analog_segments_.find(channel);
1358 if (iter != cur_analog_segments_.end())
1359 segment = (*iter).second;
1361 // If no segment was found, this means we haven't
1362 // created one yet. i.e. this is the first packet
1363 // in the sweep containing this segment.
1364 sweep_beginning = true;
1366 // Find the analog data associated with the channel
1367 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1370 shared_ptr<data::Analog> data(base->analog_data());
1373 // Create a segment, keep it in the maps of channels
1374 segment = make_shared<data::AnalogSegment>(
1375 *data, data->get_segment_count(), cur_samplerate_);
1376 cur_analog_segments_[channel] = segment;
1378 // Push the segment into the analog data.
1379 data->push_segment(segment);
1381 signal_new_segment();
1386 // Append the samples in the segment
1387 segment->append_interleaved_samples(channel_data++, analog->num_samples(),
1391 if (sweep_beginning) {
1392 // This could be the first packet after a trigger
1393 set_capture_state(Running);
1399 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1400 shared_ptr<Packet> packet)
1405 assert(device == device_->device());
1408 switch (packet->type()->id()) {
1414 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1423 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1424 } catch (bad_alloc&) {
1425 out_of_memory_ = true;
1432 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1433 } catch (bad_alloc&) {
1434 out_of_memory_ = true;
1439 case SR_DF_FRAME_BEGIN:
1440 feed_in_frame_begin();
1443 case SR_DF_FRAME_END:
1444 feed_in_frame_end();
1448 // Strictly speaking, this is performed when a frame end marker was
1449 // received, so there's no point doing this again. However, not all
1450 // devices use frames, and for those devices, we need to do it here.
1452 lock_guard<recursive_mutex> lock(data_mutex_);
1454 if (cur_logic_segment_)
1455 cur_logic_segment_->set_complete();
1457 for (auto& entry : cur_analog_segments_) {
1458 shared_ptr<data::AnalogSegment> segment = entry.second;
1459 segment->set_complete();
1462 cur_logic_segment_.reset();
1463 cur_analog_segments_.clear();
1472 void Session::on_data_saved()
1477 #ifdef ENABLE_DECODE
1478 void Session::on_new_decoders_selected(vector<const srd_decoder*> decoders)
1480 assert(decoders.size() > 0);
1482 shared_ptr<data::DecodeSignal> signal = add_decode_signal();
1485 for (unsigned int i = 0; i < decoders.size(); i++) {
1486 const srd_decoder* d = decoders[i];
1487 signal->stack_decoder(d, !(i < decoders.size() - 1));