]> sigrok.org Git - pulseview.git/blame_incremental - pv/session.cpp
Decode: Improve signaling
[pulseview.git] / pv / session.cpp
... / ...
CommitLineData
1/*
2 * This file is part of the PulseView project.
3 *
4 * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
20#include <QDebug>
21#include <QFileInfo>
22
23#include <cassert>
24#include <memory>
25#include <mutex>
26#include <stdexcept>
27
28#include <sys/stat.h>
29
30#include "devicemanager.hpp"
31#include "session.hpp"
32
33#include "data/analog.hpp"
34#include "data/analogsegment.hpp"
35#include "data/decode/decoder.hpp"
36#include "data/logic.hpp"
37#include "data/logicsegment.hpp"
38#include "data/signalbase.hpp"
39
40#include "devices/hardwaredevice.hpp"
41#include "devices/inputfile.hpp"
42#include "devices/sessionfile.hpp"
43
44#include "toolbars/mainbar.hpp"
45
46#include "views/trace/analogsignal.hpp"
47#include "views/trace/decodetrace.hpp"
48#include "views/trace/logicsignal.hpp"
49#include "views/trace/signal.hpp"
50#include "views/trace/view.hpp"
51
52#include <libsigrokcxx/libsigrokcxx.hpp>
53
54#ifdef ENABLE_DECODE
55#include <libsigrokdecode/libsigrokdecode.h>
56#include "data/decodesignal.hpp"
57#endif
58
59using std::bad_alloc;
60using std::dynamic_pointer_cast;
61using std::find_if;
62using std::function;
63using std::lock_guard;
64using std::list;
65using std::make_pair;
66using std::make_shared;
67using std::map;
68using std::max;
69using std::move;
70using std::mutex;
71using std::pair;
72using std::recursive_mutex;
73using std::runtime_error;
74using std::shared_ptr;
75using std::string;
76using std::unique_ptr;
77using std::unordered_set;
78using std::vector;
79
80using sigrok::Analog;
81using sigrok::Channel;
82using sigrok::ConfigKey;
83using sigrok::DatafeedCallbackFunction;
84using sigrok::Error;
85using sigrok::InputFormat;
86using sigrok::Logic;
87using sigrok::Meta;
88using sigrok::Packet;
89using sigrok::Session;
90
91using Glib::VariantBase;
92
93namespace pv {
94Session::Session(DeviceManager &device_manager, QString name) :
95 device_manager_(device_manager),
96 default_name_(name),
97 name_(name),
98 capture_state_(Stopped),
99 cur_samplerate_(0),
100 data_saved_(true)
101{
102}
103
104Session::~Session()
105{
106 // Stop and join to the thread
107 stop_capture();
108}
109
110DeviceManager& Session::device_manager()
111{
112 return device_manager_;
113}
114
115const DeviceManager& Session::device_manager() const
116{
117 return device_manager_;
118}
119
120shared_ptr<sigrok::Session> Session::session() const
121{
122 if (!device_)
123 return shared_ptr<sigrok::Session>();
124 return device_->session();
125}
126
127shared_ptr<devices::Device> Session::device() const
128{
129 return device_;
130}
131
132QString Session::name() const
133{
134 return name_;
135}
136
137void Session::set_name(QString name)
138{
139 if (default_name_.isEmpty())
140 default_name_ = name;
141
142 name_ = name;
143
144 name_changed();
145}
146
147const list< shared_ptr<views::ViewBase> > Session::views() const
148{
149 return views_;
150}
151
152shared_ptr<views::ViewBase> Session::main_view() const
153{
154 return main_view_;
155}
156
157void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
158{
159 main_bar_ = main_bar;
160}
161
162shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
163{
164 return main_bar_;
165}
166
167bool Session::data_saved() const
168{
169 return data_saved_;
170}
171
172void Session::save_settings(QSettings &settings) const
173{
174 map<string, string> dev_info;
175 list<string> key_list;
176 int decode_signals = 0, views = 0;
177
178 if (device_) {
179 shared_ptr<devices::HardwareDevice> hw_device =
180 dynamic_pointer_cast< devices::HardwareDevice >(device_);
181
182 if (hw_device) {
183 settings.setValue("device_type", "hardware");
184 settings.beginGroup("device");
185
186 key_list.emplace_back("vendor");
187 key_list.emplace_back("model");
188 key_list.emplace_back("version");
189 key_list.emplace_back("serial_num");
190 key_list.emplace_back("connection_id");
191
192 dev_info = device_manager_.get_device_info(device_);
193
194 for (string key : key_list) {
195 if (dev_info.count(key))
196 settings.setValue(QString::fromUtf8(key.c_str()),
197 QString::fromUtf8(dev_info.at(key).c_str()));
198 else
199 settings.remove(QString::fromUtf8(key.c_str()));
200 }
201
202 settings.endGroup();
203 }
204
205 shared_ptr<devices::SessionFile> sessionfile_device =
206 dynamic_pointer_cast< devices::SessionFile >(device_);
207
208 if (sessionfile_device) {
209 settings.setValue("device_type", "sessionfile");
210 settings.beginGroup("device");
211 settings.setValue("filename", QString::fromStdString(
212 sessionfile_device->full_name()));
213 settings.endGroup();
214 }
215
216 // Save channels and decoders
217 for (shared_ptr<data::SignalBase> base : signalbases_) {
218#ifdef ENABLE_DECODE
219 if (base->is_decode_signal()) {
220 settings.beginGroup("decode_signal" + QString::number(decode_signals++));
221 base->save_settings(settings);
222 settings.endGroup();
223 } else
224#endif
225 {
226 settings.beginGroup(base->internal_name());
227 base->save_settings(settings);
228 settings.endGroup();
229 }
230 }
231
232 settings.setValue("decode_signals", decode_signals);
233
234 // Save view states and their signal settings
235 // Note: main_view must be saved as view0
236 settings.beginGroup("view" + QString::number(views++));
237 main_view_->save_settings(settings);
238 settings.endGroup();
239
240 for (shared_ptr<views::ViewBase> view : views_) {
241 if (view != main_view_) {
242 settings.beginGroup("view" + QString::number(views++));
243 view->save_settings(settings);
244 settings.endGroup();
245 }
246 }
247
248 settings.setValue("views", views);
249 }
250}
251
252void Session::restore_settings(QSettings &settings)
253{
254 shared_ptr<devices::Device> device;
255
256 QString device_type = settings.value("device_type").toString();
257
258 if (device_type == "hardware") {
259 map<string, string> dev_info;
260 list<string> key_list;
261
262 // Re-select last used device if possible but only if it's not demo
263 settings.beginGroup("device");
264 key_list.emplace_back("vendor");
265 key_list.emplace_back("model");
266 key_list.emplace_back("version");
267 key_list.emplace_back("serial_num");
268 key_list.emplace_back("connection_id");
269
270 for (string key : key_list) {
271 const QString k = QString::fromStdString(key);
272 if (!settings.contains(k))
273 continue;
274
275 const string value = settings.value(k).toString().toStdString();
276 if (!value.empty())
277 dev_info.insert(make_pair(key, value));
278 }
279
280 if (dev_info.count("model") > 0)
281 device = device_manager_.find_device_from_info(dev_info);
282
283 if (device)
284 set_device(device);
285
286 settings.endGroup();
287 }
288
289 if (device_type == "sessionfile") {
290 settings.beginGroup("device");
291 QString filename = settings.value("filename").toString();
292 settings.endGroup();
293
294 if (QFileInfo(filename).isReadable()) {
295 device = make_shared<devices::SessionFile>(device_manager_.context(),
296 filename.toStdString());
297 set_device(device);
298
299 // TODO Perform error handling
300 start_capture([](QString infoMessage) { (void)infoMessage; });
301
302 set_name(QFileInfo(filename).fileName());
303 }
304 }
305
306 if (device) {
307 // Restore channels
308 for (shared_ptr<data::SignalBase> base : signalbases_) {
309 settings.beginGroup(base->internal_name());
310 base->restore_settings(settings);
311 settings.endGroup();
312 }
313
314 // Restore decoders
315#ifdef ENABLE_DECODE
316 int decode_signals = settings.value("decode_signals").toInt();
317
318 for (int i = 0; i < decode_signals; i++) {
319 settings.beginGroup("decode_signal" + QString::number(i++));
320 // TODO Split up add_decoder() into add_decode_signal() and add_decoder(),
321 // then call add_decode_signal() and signal->restore_settings() here
322 settings.endGroup();
323 }
324#endif
325
326 // Restore views
327 int views = settings.value("views").toInt();
328
329 for (int i = 0; i < views; i++) {
330 settings.beginGroup("view" + QString::number(i));
331
332 if (i > 0) {
333 views::ViewType type = (views::ViewType)settings.value("type").toInt();
334 add_view(name_, type, this);
335 views_.back()->restore_settings(settings);
336 } else
337 main_view_->restore_settings(settings);
338
339 settings.endGroup();
340 }
341 }
342}
343
344void Session::select_device(shared_ptr<devices::Device> device)
345{
346 try {
347 if (device)
348 set_device(device);
349 else
350 set_default_device();
351 } catch (const QString &e) {
352 main_bar_->session_error(tr("Failed to Select Device"),
353 tr("Failed to Select Device"));
354 }
355}
356
357void Session::set_device(shared_ptr<devices::Device> device)
358{
359 assert(device);
360
361 // Ensure we are not capturing before setting the device
362 stop_capture();
363
364 if (device_)
365 device_->close();
366
367 device_.reset();
368
369 // Revert name back to default name (e.g. "Session 1") as the data is gone
370 name_ = default_name_;
371 name_changed();
372
373 // Remove all stored data
374 for (shared_ptr<views::ViewBase> view : views_) {
375 view->clear_signals();
376#ifdef ENABLE_DECODE
377 view->clear_decode_signals();
378#endif
379 }
380 for (const shared_ptr<data::SignalData> d : all_signal_data_)
381 d->clear();
382 all_signal_data_.clear();
383 signalbases_.clear();
384 cur_logic_segment_.reset();
385
386 for (auto entry : cur_analog_segments_) {
387 shared_ptr<sigrok::Channel>(entry.first).reset();
388 shared_ptr<data::AnalogSegment>(entry.second).reset();
389 }
390
391 logic_data_.reset();
392
393 signals_changed();
394
395 device_ = move(device);
396
397 try {
398 device_->open();
399 } catch (const QString &e) {
400 device_.reset();
401 }
402
403 if (device_) {
404 device_->session()->add_datafeed_callback([=]
405 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
406 data_feed_in(device, packet);
407 });
408
409 update_signals();
410 }
411
412 device_changed();
413}
414
415void Session::set_default_device()
416{
417 const list< shared_ptr<devices::HardwareDevice> > &devices =
418 device_manager_.devices();
419
420 if (devices.empty())
421 return;
422
423 // Try and find the demo device and select that by default
424 const auto iter = find_if(devices.begin(), devices.end(),
425 [] (const shared_ptr<devices::HardwareDevice> &d) {
426 return d->hardware_device()->driver()->name() == "demo"; });
427 set_device((iter == devices.end()) ? devices.front() : *iter);
428}
429
430/**
431 * Convert generic options to data types that are specific to InputFormat.
432 *
433 * @param[in] user_spec Vector of tokenized words, string format.
434 * @param[in] fmt_opts Input format's options, result of InputFormat::options().
435 *
436 * @return Map of options suitable for InputFormat::create_input().
437 */
438map<string, Glib::VariantBase>
439Session::input_format_options(vector<string> user_spec,
440 map<string, shared_ptr<Option>> fmt_opts)
441{
442 map<string, Glib::VariantBase> result;
443
444 for (auto entry : user_spec) {
445 /*
446 * Split key=value specs. Accept entries without separator
447 * (for simplified boolean specifications).
448 */
449 string key, val;
450 size_t pos = entry.find("=");
451 if (pos == std::string::npos) {
452 key = entry;
453 val = "";
454 } else {
455 key = entry.substr(0, pos);
456 val = entry.substr(pos + 1);
457 }
458
459 /*
460 * Skip user specifications that are not a member of the
461 * format's set of supported options. Have the text input
462 * spec converted to the required input format specific
463 * data type.
464 */
465 auto found = fmt_opts.find(key);
466 if (found == fmt_opts.end())
467 continue;
468 shared_ptr<Option> opt = found->second;
469 result[key] = opt->parse_string(val);
470 }
471
472 return result;
473}
474
475void Session::load_init_file(const string &file_name, const string &format)
476{
477 shared_ptr<InputFormat> input_format;
478 map<string, Glib::VariantBase> input_opts;
479
480 if (!format.empty()) {
481 const map<string, shared_ptr<InputFormat> > formats =
482 device_manager_.context()->input_formats();
483 auto user_opts = pv::util::split_string(format, ":");
484 string user_name = user_opts.front();
485 user_opts.erase(user_opts.begin());
486 const auto iter = find_if(formats.begin(), formats.end(),
487 [&](const pair<string, shared_ptr<InputFormat> > f) {
488 return f.first == user_name; });
489 if (iter == formats.end()) {
490 main_bar_->session_error(tr("Error"),
491 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
492 return;
493 }
494 input_format = (*iter).second;
495 input_opts = input_format_options(user_opts,
496 input_format->options());
497 }
498
499 load_file(QString::fromStdString(file_name), input_format, input_opts);
500}
501
502void Session::load_file(QString file_name,
503 shared_ptr<sigrok::InputFormat> format,
504 const map<string, Glib::VariantBase> &options)
505{
506 const QString errorMessage(
507 QString("Failed to load file %1").arg(file_name));
508
509 try {
510 if (format)
511 set_device(shared_ptr<devices::Device>(
512 new devices::InputFile(
513 device_manager_.context(),
514 file_name.toStdString(),
515 format, options)));
516 else
517 set_device(shared_ptr<devices::Device>(
518 new devices::SessionFile(
519 device_manager_.context(),
520 file_name.toStdString())));
521 } catch (Error e) {
522 main_bar_->session_error(tr("Failed to load ") + file_name, e.what());
523 set_default_device();
524 main_bar_->update_device_list();
525 return;
526 }
527
528 main_bar_->update_device_list();
529
530 start_capture([&, errorMessage](QString infoMessage) {
531 main_bar_->session_error(errorMessage, infoMessage); });
532
533 set_name(QFileInfo(file_name).fileName());
534}
535
536Session::capture_state Session::get_capture_state() const
537{
538 lock_guard<mutex> lock(sampling_mutex_);
539 return capture_state_;
540}
541
542void Session::start_capture(function<void (const QString)> error_handler)
543{
544 if (!device_) {
545 error_handler(tr("No active device set, can't start acquisition."));
546 return;
547 }
548
549 stop_capture();
550
551 // Check that at least one channel is enabled
552 const shared_ptr<sigrok::Device> sr_dev = device_->device();
553 if (sr_dev) {
554 const auto channels = sr_dev->channels();
555 if (!any_of(channels.begin(), channels.end(),
556 [](shared_ptr<Channel> channel) {
557 return channel->enabled(); })) {
558 error_handler(tr("No channels enabled."));
559 return;
560 }
561 }
562
563 // Clear signal data
564 for (const shared_ptr<data::SignalData> d : all_signal_data_)
565 d->clear();
566
567 // Revert name back to default name (e.g. "Session 1") for real devices
568 // as the (possibly saved) data is gone. File devices keep their name.
569 shared_ptr<devices::HardwareDevice> hw_device =
570 dynamic_pointer_cast< devices::HardwareDevice >(device_);
571
572 if (hw_device) {
573 name_ = default_name_;
574 name_changed();
575 }
576
577 // Begin the session
578 sampling_thread_ = std::thread(
579 &Session::sample_thread_proc, this, error_handler);
580}
581
582void Session::stop_capture()
583{
584 if (get_capture_state() != Stopped)
585 device_->stop();
586
587 // Check that sampling stopped
588 if (sampling_thread_.joinable())
589 sampling_thread_.join();
590}
591
592void Session::register_view(shared_ptr<views::ViewBase> view)
593{
594 if (views_.empty()) {
595 main_view_ = view;
596 }
597
598 views_.push_back(view);
599
600 // Add all device signals
601 update_signals();
602
603 // Add all other signals
604 unordered_set< shared_ptr<data::SignalBase> > view_signalbases =
605 view->signalbases();
606
607 views::trace::View *trace_view =
608 qobject_cast<views::trace::View*>(view.get());
609
610 if (trace_view) {
611 for (shared_ptr<data::SignalBase> signalbase : signalbases_) {
612 const int sb_exists = count_if(
613 view_signalbases.cbegin(), view_signalbases.cend(),
614 [&](const shared_ptr<data::SignalBase> &sb) {
615 return sb == signalbase;
616 });
617 // Add the signal to the view as it doesn't have it yet
618 if (!sb_exists)
619 switch (signalbase->type()) {
620 case data::SignalBase::AnalogChannel:
621 case data::SignalBase::LogicChannel:
622 case data::SignalBase::A2LChannel:
623 break;
624 case data::SignalBase::DecodeChannel:
625#ifdef ENABLE_DECODE
626 trace_view->add_decode_signal(
627 dynamic_pointer_cast<data::DecodeSignal>(signalbase));
628#endif
629 break;
630 case data::SignalBase::MathChannel:
631 // TBD
632 break;
633 }
634 }
635 }
636
637 signals_changed();
638}
639
640void Session::deregister_view(shared_ptr<views::ViewBase> view)
641{
642 views_.remove_if([&](shared_ptr<views::ViewBase> v) { return v == view; });
643
644 if (views_.empty()) {
645 main_view_.reset();
646
647 // Without a view there can be no main bar
648 main_bar_.reset();
649 }
650}
651
652bool Session::has_view(shared_ptr<views::ViewBase> view)
653{
654 for (shared_ptr<views::ViewBase> v : views_)
655 if (v == view)
656 return true;
657
658 return false;
659}
660
661double Session::get_samplerate() const
662{
663 double samplerate = 0.0;
664
665 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
666 assert(d);
667 const vector< shared_ptr<pv::data::Segment> > segments =
668 d->segments();
669 for (const shared_ptr<pv::data::Segment> &s : segments)
670 samplerate = max(samplerate, s->samplerate());
671 }
672 // If there is no sample rate given we use samples as unit
673 if (samplerate == 0.0)
674 samplerate = 1.0;
675
676 return samplerate;
677}
678
679const unordered_set< shared_ptr<data::SignalBase> > Session::signalbases() const
680{
681 return signalbases_;
682}
683
684#ifdef ENABLE_DECODE
685bool Session::add_decoder(srd_decoder *const dec)
686{
687 if (!dec)
688 return false;
689
690 try {
691 // Create the decode signal
692 shared_ptr<data::DecodeSignal> signal =
693 make_shared<data::DecodeSignal>(*this);
694
695 signalbases_.insert(signal);
696
697 // Add the decode signal to all views
698 for (shared_ptr<views::ViewBase> view : views_)
699 view->add_decode_signal(signal);
700
701 // Add decoder
702 signal->stack_decoder(dec);
703 } catch (runtime_error e) {
704 return false;
705 }
706
707 signals_changed();
708
709 return true;
710}
711
712void Session::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
713{
714 signalbases_.erase(signal);
715
716 for (shared_ptr<views::ViewBase> view : views_)
717 view->remove_decode_signal(signal);
718
719 signals_changed();
720}
721#endif
722
723void Session::set_capture_state(capture_state state)
724{
725 bool changed;
726
727 {
728 lock_guard<mutex> lock(sampling_mutex_);
729 changed = capture_state_ != state;
730 capture_state_ = state;
731 }
732
733 if (changed)
734 capture_state_changed(state);
735}
736
737void Session::update_signals()
738{
739 if (!device_) {
740 signalbases_.clear();
741 logic_data_.reset();
742 for (shared_ptr<views::ViewBase> view : views_) {
743 view->clear_signals();
744#ifdef ENABLE_DECODE
745 view->clear_decode_signals();
746#endif
747 }
748 return;
749 }
750
751 lock_guard<recursive_mutex> lock(data_mutex_);
752
753 const shared_ptr<sigrok::Device> sr_dev = device_->device();
754 if (!sr_dev) {
755 signalbases_.clear();
756 logic_data_.reset();
757 for (shared_ptr<views::ViewBase> view : views_) {
758 view->clear_signals();
759#ifdef ENABLE_DECODE
760 view->clear_decode_signals();
761#endif
762 }
763 return;
764 }
765
766 // Detect what data types we will receive
767 auto channels = sr_dev->channels();
768 unsigned int logic_channel_count = count_if(
769 channels.begin(), channels.end(),
770 [] (shared_ptr<Channel> channel) {
771 return channel->type() == sigrok::ChannelType::LOGIC; });
772
773 // Create data containers for the logic data segments
774 {
775 lock_guard<recursive_mutex> data_lock(data_mutex_);
776
777 if (logic_channel_count == 0) {
778 logic_data_.reset();
779 } else if (!logic_data_ ||
780 logic_data_->num_channels() != logic_channel_count) {
781 logic_data_.reset(new data::Logic(
782 logic_channel_count));
783 assert(logic_data_);
784 }
785 }
786
787 // Make the signals list
788 for (shared_ptr<views::ViewBase> viewbase : views_) {
789 views::trace::View *trace_view =
790 qobject_cast<views::trace::View*>(viewbase.get());
791
792 if (trace_view) {
793 unordered_set< shared_ptr<views::trace::Signal> >
794 prev_sigs(trace_view->signals());
795 trace_view->clear_signals();
796
797 for (auto channel : sr_dev->channels()) {
798 shared_ptr<data::SignalBase> signalbase;
799 shared_ptr<views::trace::Signal> signal;
800
801 // Find the channel in the old signals
802 const auto iter = find_if(
803 prev_sigs.cbegin(), prev_sigs.cend(),
804 [&](const shared_ptr<views::trace::Signal> &s) {
805 return s->base()->channel() == channel;
806 });
807 if (iter != prev_sigs.end()) {
808 // Copy the signal from the old set to the new
809 signal = *iter;
810 trace_view->add_signal(signal);
811 } else {
812 // Find the signalbase for this channel if possible
813 signalbase.reset();
814 for (const shared_ptr<data::SignalBase> b : signalbases_)
815 if (b->channel() == channel)
816 signalbase = b;
817
818 switch(channel->type()->id()) {
819 case SR_CHANNEL_LOGIC:
820 if (!signalbase) {
821 signalbase = make_shared<data::SignalBase>(channel,
822 data::SignalBase::LogicChannel);
823 signalbases_.insert(signalbase);
824
825 all_signal_data_.insert(logic_data_);
826 signalbase->set_data(logic_data_);
827
828 connect(this, SIGNAL(capture_state_changed(int)),
829 signalbase.get(), SLOT(on_capture_state_changed(int)));
830 }
831
832 signal = shared_ptr<views::trace::Signal>(
833 new views::trace::LogicSignal(*this,
834 device_, signalbase));
835 trace_view->add_signal(signal);
836 break;
837
838 case SR_CHANNEL_ANALOG:
839 {
840 if (!signalbase) {
841 signalbase = make_shared<data::SignalBase>(channel,
842 data::SignalBase::AnalogChannel);
843 signalbases_.insert(signalbase);
844
845 shared_ptr<data::Analog> data(new data::Analog());
846 all_signal_data_.insert(data);
847 signalbase->set_data(data);
848
849 connect(this, SIGNAL(capture_state_changed(int)),
850 signalbase.get(), SLOT(on_capture_state_changed(int)));
851 }
852
853 signal = shared_ptr<views::trace::Signal>(
854 new views::trace::AnalogSignal(
855 *this, signalbase));
856 trace_view->add_signal(signal);
857 break;
858 }
859
860 default:
861 assert(false);
862 break;
863 }
864 }
865 }
866 }
867 }
868
869 signals_changed();
870}
871
872shared_ptr<data::SignalBase> Session::signalbase_from_channel(
873 shared_ptr<sigrok::Channel> channel) const
874{
875 for (shared_ptr<data::SignalBase> sig : signalbases_) {
876 assert(sig);
877 if (sig->channel() == channel)
878 return sig;
879 }
880 return shared_ptr<data::SignalBase>();
881}
882
883void Session::sample_thread_proc(function<void (const QString)> error_handler)
884{
885 assert(error_handler);
886
887 if (!device_)
888 return;
889
890 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
891
892 out_of_memory_ = false;
893
894 try {
895 device_->start();
896 } catch (Error e) {
897 error_handler(e.what());
898 return;
899 }
900
901 set_capture_state(device_->session()->trigger() ?
902 AwaitingTrigger : Running);
903
904 try {
905 device_->run();
906 } catch (Error e) {
907 error_handler(e.what());
908 set_capture_state(Stopped);
909 return;
910 }
911
912 set_capture_state(Stopped);
913
914 // Confirm that SR_DF_END was received
915 if (cur_logic_segment_) {
916 qDebug("SR_DF_END was not received.");
917 assert(false);
918 }
919
920 // Optimize memory usage
921 free_unused_memory();
922
923 // We now have unsaved data unless we just "captured" from a file
924 shared_ptr<devices::File> file_device =
925 dynamic_pointer_cast<devices::File>(device_);
926
927 if (!file_device)
928 data_saved_ = false;
929
930 if (out_of_memory_)
931 error_handler(tr("Out of memory, acquisition stopped."));
932}
933
934void Session::free_unused_memory()
935{
936 for (shared_ptr<data::SignalData> data : all_signal_data_) {
937 const vector< shared_ptr<data::Segment> > segments = data->segments();
938
939 for (shared_ptr<data::Segment> segment : segments) {
940 segment->free_unused_memory();
941 }
942 }
943}
944
945void Session::feed_in_header()
946{
947 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
948}
949
950void Session::feed_in_meta(shared_ptr<Meta> meta)
951{
952 for (auto entry : meta->config()) {
953 switch (entry.first->id()) {
954 case SR_CONF_SAMPLERATE:
955 // We can't rely on the header to always contain the sample rate,
956 // so in case it's supplied via a meta packet, we use it.
957 if (!cur_samplerate_)
958 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
959
960 /// @todo handle samplerate changes
961 break;
962 default:
963 // Unknown metadata is not an error.
964 break;
965 }
966 }
967
968 signals_changed();
969}
970
971void Session::feed_in_trigger()
972{
973 // The channel containing most samples should be most accurate
974 uint64_t sample_count = 0;
975
976 {
977 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
978 assert(d);
979 uint64_t temp_count = 0;
980
981 const vector< shared_ptr<pv::data::Segment> > segments =
982 d->segments();
983 for (const shared_ptr<pv::data::Segment> &s : segments)
984 temp_count += s->get_sample_count();
985
986 if (temp_count > sample_count)
987 sample_count = temp_count;
988 }
989 }
990
991 trigger_event(sample_count / get_samplerate());
992}
993
994void Session::feed_in_frame_begin()
995{
996 if (cur_logic_segment_ || !cur_analog_segments_.empty())
997 frame_began();
998}
999
1000void Session::feed_in_logic(shared_ptr<Logic> logic)
1001{
1002 lock_guard<recursive_mutex> lock(data_mutex_);
1003
1004 if (!logic_data_) {
1005 // The only reason logic_data_ would not have been created is
1006 // if it was not possible to determine the signals when the
1007 // device was created.
1008 update_signals();
1009 }
1010
1011 if (!cur_logic_segment_) {
1012 // This could be the first packet after a trigger
1013 set_capture_state(Running);
1014
1015 // Create a new data segment
1016 cur_logic_segment_ = make_shared<data::LogicSegment>(
1017 *logic_data_, logic->unit_size(), cur_samplerate_);
1018 logic_data_->push_segment(cur_logic_segment_);
1019
1020 // @todo Putting this here means that only listeners querying
1021 // for logic will be notified. Currently the only user of
1022 // frame_began is DecoderStack, but in future we need to signal
1023 // this after both analog and logic sweeps have begun.
1024 frame_began();
1025 }
1026
1027 cur_logic_segment_->append_payload(logic);
1028
1029 data_received();
1030}
1031
1032void Session::feed_in_analog(shared_ptr<Analog> analog)
1033{
1034 lock_guard<recursive_mutex> lock(data_mutex_);
1035
1036 const vector<shared_ptr<Channel>> channels = analog->channels();
1037 const unsigned int channel_count = channels.size();
1038 const size_t sample_count = analog->num_samples() / channel_count;
1039 bool sweep_beginning = false;
1040
1041 unique_ptr<float> data(new float[analog->num_samples()]);
1042 analog->get_data_as_float(data.get());
1043
1044 if (signalbases_.empty())
1045 update_signals();
1046
1047 float *channel_data = data.get();
1048 for (auto channel : channels) {
1049 shared_ptr<data::AnalogSegment> segment;
1050
1051 // Try to get the segment of the channel
1052 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
1053 iterator iter = cur_analog_segments_.find(channel);
1054 if (iter != cur_analog_segments_.end())
1055 segment = (*iter).second;
1056 else {
1057 // If no segment was found, this means we haven't
1058 // created one yet. i.e. this is the first packet
1059 // in the sweep containing this segment.
1060 sweep_beginning = true;
1061
1062 // Find the analog data associated with the channel
1063 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1064 assert(base);
1065
1066 shared_ptr<data::Analog> data(base->analog_data());
1067 assert(data);
1068
1069 // Create a segment, keep it in the maps of channels
1070 segment = make_shared<data::AnalogSegment>(
1071 *data, cur_samplerate_);
1072 cur_analog_segments_[channel] = segment;
1073
1074 // Push the segment into the analog data.
1075 data->push_segment(segment);
1076 }
1077
1078 assert(segment);
1079
1080 // Append the samples in the segment
1081 segment->append_interleaved_samples(channel_data++, sample_count,
1082 channel_count);
1083 }
1084
1085 if (sweep_beginning) {
1086 // This could be the first packet after a trigger
1087 set_capture_state(Running);
1088 }
1089
1090 data_received();
1091}
1092
1093void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1094 shared_ptr<Packet> packet)
1095{
1096 static bool frame_began = false;
1097
1098 (void)device;
1099
1100 assert(device);
1101 assert(device == device_->device());
1102 assert(packet);
1103
1104 switch (packet->type()->id()) {
1105 case SR_DF_HEADER:
1106 feed_in_header();
1107 break;
1108
1109 case SR_DF_META:
1110 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
1111 break;
1112
1113 case SR_DF_TRIGGER:
1114 feed_in_trigger();
1115 break;
1116
1117 case SR_DF_FRAME_BEGIN:
1118 feed_in_frame_begin();
1119 frame_began = true;
1120 break;
1121
1122 case SR_DF_LOGIC:
1123 try {
1124 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
1125 } catch (bad_alloc) {
1126 out_of_memory_ = true;
1127 device_->stop();
1128 }
1129 break;
1130
1131 case SR_DF_ANALOG:
1132 try {
1133 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
1134 } catch (bad_alloc) {
1135 out_of_memory_ = true;
1136 device_->stop();
1137 }
1138 break;
1139
1140 case SR_DF_FRAME_END:
1141 case SR_DF_END:
1142 {
1143 {
1144 lock_guard<recursive_mutex> lock(data_mutex_);
1145 cur_logic_segment_.reset();
1146 cur_analog_segments_.clear();
1147 }
1148 if (frame_began) {
1149 frame_began = false;
1150 frame_ended();
1151 }
1152 break;
1153 }
1154 default:
1155 break;
1156 }
1157}
1158
1159void Session::on_data_saved()
1160{
1161 data_saved_ = true;
1162}
1163
1164} // namespace pv