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