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