]> sigrok.org Git - pulseview.git/blame - pv/session.cpp
Introduce DecodeSignal class
[pulseview.git] / pv / session.cpp
CommitLineData
2953961c 1/*
b3f22de0 2 * This file is part of the PulseView project.
2953961c 3 *
1bc6525b 4 * Copyright (C) 2012-14 Joel Holdsworth <joel@airwebreathe.org.uk>
2953961c
JH
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
efdec55a 17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
2953961c
JH
18 */
19
43017494
SA
20#include <QFileInfo>
21
1e4d7c4d 22#include <cassert>
303eec78 23#include <memory>
1e4d7c4d
SA
24#include <mutex>
25#include <stdexcept>
4e5a4405 26
1e4d7c4d 27#include <sys/stat.h>
2953961c 28
2acdb232 29#include "devicemanager.hpp"
aca9aa83 30#include "session.hpp"
119aff65 31
2acdb232 32#include "data/analog.hpp"
f3d66e52 33#include "data/analogsegment.hpp"
aca9aa83 34#include "data/decode/decoder.hpp"
2acdb232
JH
35#include "data/decoderstack.hpp"
36#include "data/logic.hpp"
f3d66e52 37#include "data/logicsegment.hpp"
bf0edd2b 38#include "data/signalbase.hpp"
82c7f640 39
da30ecb7 40#include "devices/hardwaredevice.hpp"
fd22c71c 41#include "devices/inputfile.hpp"
da30ecb7
JH
42#include "devices/sessionfile.hpp"
43
0f8f8c18
SA
44#include "toolbars/mainbar.hpp"
45
1573bf16
SA
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"
28a4c9c5 51
fe3a1c21 52#include <libsigrokcxx/libsigrokcxx.hpp>
e8d00928 53
1e4d7c4d
SA
54#ifdef ENABLE_DECODE
55#include <libsigrokdecode/libsigrokdecode.h>
ad908057 56#include "data/decodesignal.hpp"
1e4d7c4d
SA
57#endif
58
6f925ba9 59using std::bad_alloc;
f9abf97e 60using std::dynamic_pointer_cast;
6f925ba9 61using std::find_if;
d2344534 62using std::function;
3b68d03d 63using std::lock_guard;
d873f4d6 64using std::list;
6f925ba9
UH
65using std::make_pair;
66using std::make_shared;
819f4c25 67using std::map;
6f925ba9
UH
68using std::max;
69using std::move;
aca64cac 70using std::mutex;
fd22c71c 71using std::pair;
8524a597 72using std::recursive_mutex;
6f925ba9 73using std::runtime_error;
f9abf97e 74using std::shared_ptr;
819f4c25 75using std::string;
303eec78 76using std::unique_ptr;
78b0af3e 77using std::unordered_set;
819f4c25 78using std::vector;
28a4c9c5 79
e8d00928
ML
80using sigrok::Analog;
81using sigrok::Channel;
e8d00928
ML
82using sigrok::ConfigKey;
83using sigrok::DatafeedCallbackFunction;
e8d00928 84using sigrok::Error;
fd22c71c 85using sigrok::InputFormat;
e8d00928
ML
86using sigrok::Logic;
87using sigrok::Meta;
88using sigrok::Packet;
e8d00928 89using sigrok::Session;
e8d00928
ML
90
91using Glib::VariantBase;
51e77110 92
e8d00928 93namespace pv {
101e7a9b 94Session::Session(DeviceManager &device_manager, QString name) :
8dbbc7f0 95 device_manager_(device_manager),
33e1afbe 96 default_name_(name),
101e7a9b 97 name_(name),
ff008de6 98 capture_state_(Stopped),
5ccfc97e
SA
99 cur_samplerate_(0),
100 data_saved_(true)
2953961c 101{
2953961c
JH
102}
103
2b81ae46 104Session::~Session()
2953961c 105{
04463625 106 // Stop and join to the thread
5b7cf66c 107 stop_capture();
2953961c
JH
108}
109
2b81ae46 110DeviceManager& Session::device_manager()
4cb0b033 111{
8dbbc7f0 112 return device_manager_;
4cb0b033
JH
113}
114
2b81ae46 115const DeviceManager& Session::device_manager() const
4cb0b033 116{
8dbbc7f0 117 return device_manager_;
4cb0b033
JH
118}
119
da30ecb7 120shared_ptr<sigrok::Session> Session::session() const
1f4caa77 121{
da30ecb7
JH
122 if (!device_)
123 return shared_ptr<sigrok::Session>();
124 return device_->session();
1f4caa77
JH
125}
126
da30ecb7 127shared_ptr<devices::Device> Session::device() const
dc0867ff 128{
8dbbc7f0 129 return device_;
dc0867ff
JH
130}
131
101e7a9b
SA
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
6f925ba9 147const list< shared_ptr<views::ViewBase> > Session::views() const
36a8185e
SA
148{
149 return views_;
150}
151
6f925ba9 152shared_ptr<views::ViewBase> Session::main_view() const
0f8f8c18
SA
153{
154 return main_view_;
155}
156
6f925ba9 157void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
0f8f8c18
SA
158{
159 main_bar_ = main_bar;
160}
161
162shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
163{
164 return main_bar_;
165}
166
5ccfc97e
SA
167bool Session::data_saved() const
168{
169 return data_saved_;
170}
171
101e7a9b
SA
172void Session::save_settings(QSettings &settings) const
173{
174 map<string, string> dev_info;
175 list<string> key_list;
3a21afa6 176 int stacks = 0, views = 0;
101e7a9b
SA
177
178 if (device_) {
43017494
SA
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
326cf6fe
UH
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");
43017494
SA
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 }
101e7a9b 201
43017494
SA
202 settings.endGroup();
203 }
101e7a9b 204
43017494
SA
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();
101e7a9b
SA
214 }
215
aecae05c
SA
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();
6f925ba9 222 shared_ptr<data::decode::Decoder> top_decoder =
aecae05c
SA
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());
6de38b17 233 base->save_settings(settings);
aecae05c
SA
234 settings.endGroup();
235 }
236 }
101e7a9b 237
aecae05c 238 settings.setValue("decoder_stacks", stacks);
3a21afa6
SA
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
f4e57597 246 for (shared_ptr<views::ViewBase> view : views_) {
3a21afa6
SA
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);
101e7a9b
SA
255 }
256}
257
258void Session::restore_settings(QSettings &settings)
259{
43017494
SA
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");
326cf6fe
UH
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");
43017494
SA
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())
6f925ba9 283 dev_info.insert(make_pair(key, value));
43017494
SA
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();
101e7a9b
SA
293 }
294
43017494
SA
295 if (device_type == "sessionfile") {
296 settings.beginGroup("device");
297 QString filename = settings.value("filename").toString();
298 settings.endGroup();
101e7a9b 299
43017494 300 if (QFileInfo(filename).isReadable()) {
067bb624 301 device = make_shared<devices::SessionFile>(device_manager_.context(),
43017494
SA
302 filename.toStdString());
303 set_device(device);
101e7a9b 304
43017494
SA
305 // TODO Perform error handling
306 start_capture([](QString infoMessage) { (void)infoMessage; });
33e1afbe
SA
307
308 set_name(QFileInfo(filename).fileName());
43017494
SA
309 }
310 }
311
312 if (device) {
aecae05c
SA
313 // Restore channels
314 for (shared_ptr<data::SignalBase> base : signalbases_) {
315 settings.beginGroup(base->internal_name());
6de38b17 316 base->restore_settings(settings);
aecae05c
SA
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
3a21afa6
SA
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) {
f4e57597 341 views::ViewType type = (views::ViewType)settings.value("type").toInt();
3a21afa6
SA
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 }
101e7a9b 349 }
101e7a9b
SA
350}
351
fd22c71c
SA
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
da30ecb7 365void Session::set_device(shared_ptr<devices::Device> device)
d64d1596 366{
da30ecb7
JH
367 assert(device);
368
82596f46
JH
369 // Ensure we are not capturing before setting the device
370 stop_capture();
371
4d6c6ea3
SA
372 if (device_)
373 device_->close();
374
86123e2e
SA
375 device_.reset();
376
7b254679 377 // Revert name back to default name (e.g. "Session 1") as the data is gone
101e7a9b
SA
378 name_ = default_name_;
379 name_changed();
380
cc9a7898 381 // Remove all stored data
6f925ba9 382 for (shared_ptr<views::ViewBase> view : views_) {
47e9e7bb 383 view->clear_signals();
bb7dd726 384#ifdef ENABLE_DECODE
f4e57597 385 view->clear_decode_signals();
bb7dd726
SA
386#endif
387 }
47e9e7bb
SA
388 for (const shared_ptr<data::SignalData> d : all_signal_data_)
389 d->clear();
cc9a7898 390 all_signal_data_.clear();
47e9e7bb 391 signalbases_.clear();
4b0d7046
SA
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();
4b0d7046 400
86123e2e
SA
401 signals_changed();
402
6f925ba9 403 device_ = move(device);
7e0c99bf
SA
404
405 try {
406 device_->open();
407 } catch (const QString &e) {
408 device_.reset();
7e0c99bf
SA
409 }
410
bcd64b9b
SA
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 }
ae2d1bc5 419
91f8fe8c 420 device_changed();
ae2d1bc5 421}
85843b14 422
2b81ae46 423void Session::set_default_device()
6fd0b639 424{
da30ecb7 425 const list< shared_ptr<devices::HardwareDevice> > &devices =
8dbbc7f0 426 device_manager_.devices();
6fd0b639 427
da30ecb7
JH
428 if (devices.empty())
429 return;
dc0867ff 430
da30ecb7 431 // Try and find the demo device and select that by default
6f925ba9 432 const auto iter = find_if(devices.begin(), devices.end(),
da30ecb7 433 [] (const shared_ptr<devices::HardwareDevice> &d) {
6f925ba9 434 return d->hardware_device()->driver()->name() == "demo"; });
da30ecb7 435 set_device((iter == devices.end()) ? devices.front() : *iter);
dc0867ff
JH
436}
437
724f29f3
GS
438/**
439 * Convert generic options to data types that are specific to InputFormat.
440 *
3083cda8
UH
441 * @param[in] user_spec Vector of tokenized words, string format.
442 * @param[in] fmt_opts Input format's options, result of InputFormat::options().
724f29f3 443 *
3083cda8 444 * @return Map of options suitable for InputFormat::create_input().
724f29f3
GS
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
6f925ba9 483void Session::load_init_file(const string &file_name, const string &format)
fd22c71c
SA
484{
485 shared_ptr<InputFormat> input_format;
724f29f3 486 map<string, Glib::VariantBase> input_opts;
fd22c71c
SA
487
488 if (!format.empty()) {
489 const map<string, shared_ptr<InputFormat> > formats =
490 device_manager_.context()->input_formats();
724f29f3
GS
491 auto user_opts = pv::util::split_string(format, ":");
492 string user_name = user_opts.front();
493 user_opts.erase(user_opts.begin());
fd22c71c
SA
494 const auto iter = find_if(formats.begin(), formats.end(),
495 [&](const pair<string, shared_ptr<InputFormat> > f) {
724f29f3 496 return f.first == user_name; });
fd22c71c
SA
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 }
fd22c71c 502 input_format = (*iter).second;
724f29f3
GS
503 input_opts = input_format_options(user_opts,
504 input_format->options());
fd22c71c
SA
505 }
506
724f29f3 507 load_file(QString::fromStdString(file_name), input_format, input_opts);
fd22c71c
SA
508}
509
510void Session::load_file(QString file_name,
6f925ba9
UH
511 shared_ptr<sigrok::InputFormat> format,
512 const map<string, Glib::VariantBase> &options)
fd22c71c
SA
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
2b81ae46 544Session::capture_state Session::get_capture_state() const
5b7cf66c 545{
8dbbc7f0
JH
546 lock_guard<mutex> lock(sampling_mutex_);
547 return capture_state_;
5b7cf66c
JH
548}
549
2b81ae46 550void Session::start_capture(function<void (const QString)> error_handler)
2e2946fe 551{
34c11fa7
SA
552 if (!device_) {
553 error_handler(tr("No active device set, can't start acquisition."));
554 return;
555 }
556
5b7cf66c
JH
557 stop_capture();
558
6ac6242b 559 // Check that at least one channel is enabled
e6c1382e
JH
560 const shared_ptr<sigrok::Device> sr_dev = device_->device();
561 if (sr_dev) {
562 const auto channels = sr_dev->channels();
6f925ba9 563 if (!any_of(channels.begin(), channels.end(),
e6c1382e
JH
564 [](shared_ptr<Channel> channel) {
565 return channel->enabled(); })) {
566 error_handler(tr("No channels enabled."));
567 return;
568 }
9c48fa57
JH
569 }
570
53ea4c6c 571 // Clear signal data
47e9e7bb
SA
572 for (const shared_ptr<data::SignalData> d : all_signal_data_)
573 d->clear();
53ea4c6c 574
53bb2e1d
SA
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 }
101e7a9b 584
9c48fa57 585 // Begin the session
8dbbc7f0 586 sampling_thread_ = std::thread(
2b05d311 587 &Session::sample_thread_proc, this, error_handler);
2e2946fe
JH
588}
589
2b81ae46 590void Session::stop_capture()
5b7cf66c 591{
04463625 592 if (get_capture_state() != Stopped)
da30ecb7 593 device_->stop();
5b7cf66c
JH
594
595 // Check that sampling stopped
8dbbc7f0
JH
596 if (sampling_thread_.joinable())
597 sampling_thread_.join();
5b7cf66c
JH
598}
599
6f925ba9 600void Session::register_view(shared_ptr<views::ViewBase> view)
47e9e7bb 601{
0f8f8c18
SA
602 if (views_.empty()) {
603 main_view_ = view;
604 }
605
3a21afa6 606 views_.push_back(view);
53e8927d
SA
607
608 update_signals();
47e9e7bb
SA
609}
610
6f925ba9 611void Session::deregister_view(shared_ptr<views::ViewBase> view)
47e9e7bb 612{
6f925ba9 613 views_.remove_if([&](shared_ptr<views::ViewBase> v) { return v == view; });
0f8f8c18
SA
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 }
47e9e7bb
SA
621}
622
6f925ba9 623bool Session::has_view(shared_ptr<views::ViewBase> view)
101e7a9b 624{
6f925ba9 625 for (shared_ptr<views::ViewBase> v : views_)
3a21afa6
SA
626 if (v == view)
627 return true;
628
629 return false;
101e7a9b
SA
630}
631
2220e942
SA
632double Session::get_samplerate() const
633{
634 double samplerate = 0.0;
635
47e9e7bb
SA
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)
6f925ba9 641 samplerate = max(samplerate, s->samplerate());
2220e942 642 }
2220e942
SA
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
6f925ba9 650const unordered_set< shared_ptr<data::SignalBase> > Session::signalbases() const
2e2946fe 651{
47e9e7bb 652 return signalbases_;
2e2946fe
JH
653}
654
269528f5 655#ifdef ENABLE_DECODE
2b81ae46 656bool Session::add_decoder(srd_decoder *const dec)
82c7f640 657{
a7336fb2
SA
658 if (!dec)
659 return false;
660
04394ded 661 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
7491a29f 662 shared_ptr<data::DecoderStack> decoder_stack;
4e5a4405 663
2ad82c2e 664 try {
4e5a4405 665 // Create the decoder
067bb624 666 decoder_stack = make_shared<data::DecoderStack>(*this, dec);
4e5a4405 667
6ac6242b 668 // Make a list of all the channels
6f925ba9 669 vector<const srd_channel*> all_channels;
f3290553 670 for (const GSList *i = dec->channels; i; i = i->next)
6ac6242b 671 all_channels.push_back((const srd_channel*)i->data);
f3290553 672 for (const GSList *i = dec->opt_channels; i; i = i->next)
6ac6242b 673 all_channels.push_back((const srd_channel*)i->data);
d2f46d27 674
6ac6242b
ML
675 // Auto select the initial channels
676 for (const srd_channel *pdch : all_channels)
04394ded 677 for (shared_ptr<data::SignalBase> b : signalbases_) {
79c4a9c8 678 if (b->logic_data()) {
04394ded
SA
679 if (QString::fromUtf8(pdch->name).toLower().
680 contains(b->name().toLower()))
681 channels[pdch] = b;
682 }
4e5a4405 683 }
4e5a4405 684
7491a29f
JH
685 assert(decoder_stack);
686 assert(!decoder_stack->stack().empty());
687 assert(decoder_stack->stack().front());
6ac6242b 688 decoder_stack->stack().front()->set_channels(channels);
4e5a4405
JH
689
690 // Create the decode signal
ad908057
SA
691 shared_ptr<data::DecodeSignal> signal =
692 make_shared<data::DecodeSignal>(decoder_stack);
bf0edd2b 693
ad908057 694 signalbases_.insert(signal);
bb7dd726 695
6f925ba9 696 for (shared_ptr<views::ViewBase> view : views_)
ad908057 697 view->add_decode_signal(signal);
6f925ba9 698 } catch (runtime_error e) {
e92cd4e4
JH
699 return false;
700 }
701
82c7f640 702 signals_changed();
e92cd4e4 703
7491a29f
JH
704 // Do an initial decode
705 decoder_stack->begin_decode();
706
e92cd4e4 707 return true;
82c7f640
JH
708}
709
ad908057 710void Session::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
38eeddea 711{
ad908057 712 signalbases_.erase(signal);
2d25fc47 713
6f925ba9 714 for (shared_ptr<views::ViewBase> view : views_)
ad908057 715 view->remove_decode_signal(signal);
2d25fc47
SA
716
717 signals_changed();
c51482b3 718}
269528f5 719#endif
c51482b3 720
2b81ae46 721void Session::set_capture_state(capture_state state)
6ac96c2e 722{
896936e5
TS
723 bool changed;
724
725 {
726 lock_guard<mutex> lock(sampling_mutex_);
727 changed = capture_state_ != state;
728 capture_state_ = state;
729 }
730
f3290553 731 if (changed)
2b49eeb0 732 capture_state_changed(state);
6ac96c2e
JH
733}
734
ffe00119 735void Session::update_signals()
b087ba7f 736{
076eefa4 737 if (!device_) {
47e9e7bb 738 signalbases_.clear();
076eefa4 739 logic_data_.reset();
6f925ba9 740 for (shared_ptr<views::ViewBase> view : views_) {
47e9e7bb 741 view->clear_signals();
bb7dd726 742#ifdef ENABLE_DECODE
f4e57597 743 view->clear_decode_signals();
bb7dd726
SA
744#endif
745 }
076eefa4
SA
746 return;
747 }
e6c1382e
JH
748
749 lock_guard<recursive_mutex> lock(data_mutex_);
b087ba7f 750
ffe00119 751 const shared_ptr<sigrok::Device> sr_dev = device_->device();
c6412b47 752 if (!sr_dev) {
47e9e7bb 753 signalbases_.clear();
c6412b47 754 logic_data_.reset();
6f925ba9 755 for (shared_ptr<views::ViewBase> view : views_) {
47e9e7bb 756 view->clear_signals();
bb7dd726 757#ifdef ENABLE_DECODE
f4e57597 758 view->clear_decode_signals();
bb7dd726
SA
759#endif
760 }
c6412b47
JH
761 return;
762 }
763
b087ba7f 764 // Detect what data types we will receive
c6412b47 765 auto channels = sr_dev->channels();
6f925ba9 766 unsigned int logic_channel_count = count_if(
e8d00928
ML
767 channels.begin(), channels.end(),
768 [] (shared_ptr<Channel> channel) {
472a80c5 769 return channel->type() == sigrok::ChannelType::LOGIC; });
b087ba7f 770
f3d66e52 771 // Create data containers for the logic data segments
b087ba7f 772 {
8524a597 773 lock_guard<recursive_mutex> data_lock(data_mutex_);
b087ba7f 774
3917ba77
JH
775 if (logic_channel_count == 0) {
776 logic_data_.reset();
777 } else if (!logic_data_ ||
778 logic_data_->num_channels() != logic_channel_count) {
8dbbc7f0 779 logic_data_.reset(new data::Logic(
6ac6242b 780 logic_channel_count));
8dbbc7f0 781 assert(logic_data_);
b087ba7f 782 }
b087ba7f
JH
783 }
784
47e9e7bb 785 // Make the signals list
6f925ba9 786 for (shared_ptr<views::ViewBase> viewbase : views_) {
f23c4692
SA
787 views::trace::View *trace_view =
788 qobject_cast<views::trace::View*>(viewbase.get());
f4e57597
SA
789
790 if (trace_view) {
f23c4692 791 unordered_set< shared_ptr<views::trace::Signal> >
f4e57597
SA
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;
f23c4692 797 shared_ptr<views::trace::Signal> signal;
f4e57597
SA
798
799 // Find the channel in the old signals
6f925ba9 800 const auto iter = find_if(
f4e57597 801 prev_sigs.cbegin(), prev_sigs.cend(),
f23c4692 802 [&](const shared_ptr<views::trace::Signal> &s) {
f4e57597
SA
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) {
472a80c5
SA
819 signalbase = make_shared<data::SignalBase>(channel,
820 data::SignalBase::LogicChannel);
f4e57597
SA
821 signalbases_.insert(signalbase);
822
823 all_signal_data_.insert(logic_data_);
824 signalbase->set_data(logic_data_);
12ea3616
SA
825
826 connect(this, SIGNAL(capture_state_changed(int)),
827 signalbase.get(), SLOT(on_capture_state_changed(int)));
f4e57597
SA
828 }
829
f23c4692
SA
830 signal = shared_ptr<views::trace::Signal>(
831 new views::trace::LogicSignal(*this,
f4e57597
SA
832 device_, signalbase));
833 trace_view->add_signal(signal);
834 break;
835
836 case SR_CHANNEL_ANALOG:
837 {
838 if (!signalbase) {
472a80c5
SA
839 signalbase = make_shared<data::SignalBase>(channel,
840 data::SignalBase::AnalogChannel);
f4e57597
SA
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);
12ea3616
SA
846
847 connect(this, SIGNAL(capture_state_changed(int)),
848 signalbase.get(), SLOT(on_capture_state_changed(int)));
f4e57597
SA
849 }
850
f23c4692
SA
851 signal = shared_ptr<views::trace::Signal>(
852 new views::trace::AnalogSignal(
f4e57597
SA
853 *this, signalbase));
854 trace_view->add_signal(signal);
855 break;
47e9e7bb
SA
856 }
857
f4e57597 858 default:
0402d7a3 859 assert(false);
f4e57597 860 break;
47e9e7bb 861 }
3917ba77 862 }
b087ba7f
JH
863 }
864 }
fbd3e234 865 }
b087ba7f
JH
866
867 signals_changed();
868}
869
cbd2a2de 870shared_ptr<data::SignalBase> Session::signalbase_from_channel(
bf0edd2b 871 shared_ptr<sigrok::Channel> channel) const
3ddcc083 872{
bf0edd2b 873 for (shared_ptr<data::SignalBase> sig : signalbases_) {
3ddcc083 874 assert(sig);
6ac6242b 875 if (sig->channel() == channel)
3ddcc083
JH
876 return sig;
877 }
bf0edd2b 878 return shared_ptr<data::SignalBase>();
3ddcc083
JH
879}
880
2b05d311 881void Session::sample_thread_proc(function<void (const QString)> error_handler)
274d4f13 882{
f2edb557 883 assert(error_handler);
be73bdfa 884
34c11fa7
SA
885 if (!device_)
886 return;
45f0c7c9 887
b48daed6 888 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
274d4f13 889
e7216ae0
SA
890 out_of_memory_ = false;
891
ae2d1bc5 892 try {
5237f0c5 893 device_->start();
2ad82c2e 894 } catch (Error e) {
e8d00928 895 error_handler(e.what());
eec446e1
JH
896 return;
897 }
898
da30ecb7 899 set_capture_state(device_->session()->trigger() ?
07dcf561 900 AwaitingTrigger : Running);
eec446e1 901
dc4ada2b
SA
902 try {
903 device_->run();
904 } catch (Error e) {
905 error_handler(e.what());
906 set_capture_state(Stopped);
907 return;
908 }
909
eec446e1 910 set_capture_state(Stopped);
1a2fe44c
JH
911
912 // Confirm that SR_DF_END was received
2ad82c2e 913 if (cur_logic_segment_) {
bb2cdfff 914 qDebug("SR_DF_END was not received.");
0402d7a3 915 assert(false);
bb2cdfff 916 }
e7216ae0 917
5e6967cb
SA
918 // Optimize memory usage
919 free_unused_memory();
920
5ccfc97e
SA
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
e7216ae0
SA
928 if (out_of_memory_)
929 error_handler(tr("Out of memory, acquisition stopped."));
eec446e1
JH
930}
931
5e6967cb
SA
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
da30ecb7 943void Session::feed_in_header()
eec446e1 944{
b48daed6 945 cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
be73bdfa
JH
946}
947
da30ecb7 948void Session::feed_in_meta(shared_ptr<Meta> meta)
be73bdfa 949{
e8d00928
ML
950 for (auto entry : meta->config()) {
951 switch (entry.first->id()) {
be73bdfa 952 case SR_CONF_SAMPLERATE:
8a7b603b
SA
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
be73bdfa 958 /// @todo handle samplerate changes
be73bdfa
JH
959 break;
960 default:
961 // Unknown metadata is not an error.
962 break;
963 }
aba1dd16 964 }
74043039
JH
965
966 signals_changed();
aba1dd16
JH
967}
968
48257a69
SA
969void Session::feed_in_trigger()
970{
971 // The channel containing most samples should be most accurate
972 uint64_t sample_count = 0;
973
cc9a7898 974 {
cc9a7898
SA
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 }
48257a69
SA
987 }
988
989 trigger_event(sample_count / get_samplerate());
990}
991
2b81ae46 992void Session::feed_in_frame_begin()
82f50b10 993{
f3d66e52 994 if (cur_logic_segment_ || !cur_analog_segments_.empty())
82f50b10
JH
995 frame_began();
996}
997
2b81ae46 998void Session::feed_in_logic(shared_ptr<Logic> logic)
9c112671 999{
8524a597 1000 lock_guard<recursive_mutex> lock(data_mutex_);
79efbc53 1001
2ad82c2e 1002 if (!logic_data_) {
e6c1382e
JH
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();
79efbc53 1007 }
be73bdfa 1008
2ad82c2e 1009 if (!cur_logic_segment_) {
bb2cdfff 1010 // This could be the first packet after a trigger
2b49eeb0
JH
1011 set_capture_state(Running);
1012
f3d66e52 1013 // Create a new data segment
067bb624 1014 cur_logic_segment_ = make_shared<data::LogicSegment>(
04e1acc2 1015 *logic_data_, logic->unit_size(), cur_samplerate_);
f3d66e52 1016 logic_data_->push_segment(cur_logic_segment_);
82f50b10
JH
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();
9c112671
JH
1023 }
1024
04e1acc2
SA
1025 cur_logic_segment_->append_payload(logic);
1026
1f374035 1027 data_received();
9c112671
JH
1028}
1029
2b81ae46 1030void Session::feed_in_analog(shared_ptr<Analog> analog)
aba1dd16 1031{
8524a597 1032 lock_guard<recursive_mutex> lock(data_mutex_);
79efbc53 1033
e8d00928
ML
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;
bb2cdfff 1037 bool sweep_beginning = false;
be73bdfa 1038
303eec78
SA
1039 unique_ptr<float> data(new float[analog->num_samples()]);
1040 analog->get_data_as_float(data.get());
1041
47e9e7bb 1042 if (signalbases_.empty())
a3f678a7 1043 update_signals();
a3f678a7 1044
303eec78 1045 float *channel_data = data.get();
2ad82c2e 1046 for (auto channel : channels) {
f3d66e52 1047 shared_ptr<data::AnalogSegment> segment;
2b49eeb0 1048
f3d66e52
JH
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;
2ad82c2e 1054 else {
39ccf9c3 1055 // If no segment was found, this means we haven't
bb2cdfff 1056 // created one yet. i.e. this is the first packet
f3d66e52 1057 // in the sweep containing this segment.
bb2cdfff
JH
1058 sweep_beginning = true;
1059
ff4bf6bd 1060 // Find the analog data associated with the channel
cbd2a2de
SA
1061 shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
1062 assert(base);
bb2cdfff 1063
cbd2a2de 1064 shared_ptr<data::Analog> data(base->analog_data());
bb2cdfff
JH
1065 assert(data);
1066
7db61e77 1067 // Create a segment, keep it in the maps of channels
067bb624
UH
1068 segment = make_shared<data::AnalogSegment>(
1069 *data, cur_samplerate_);
7db61e77
SA
1070 cur_analog_segments_[channel] = segment;
1071
f3d66e52
JH
1072 // Push the segment into the analog data.
1073 data->push_segment(segment);
bb2cdfff
JH
1074 }
1075
f3d66e52 1076 assert(segment);
bb2cdfff 1077
f3d66e52 1078 // Append the samples in the segment
303eec78 1079 segment->append_interleaved_samples(channel_data++, sample_count,
6ac6242b 1080 channel_count);
aba1dd16 1081 }
bb2cdfff
JH
1082
1083 if (sweep_beginning) {
1084 // This could be the first packet after a trigger
1085 set_capture_state(Running);
aba1dd16
JH
1086 }
1087
1f374035 1088 data_received();
aba1dd16 1089}
9c112671 1090
da30ecb7
JH
1091void Session::data_feed_in(shared_ptr<sigrok::Device> device,
1092 shared_ptr<Packet> packet)
b0e1d01d 1093{
c063290a 1094 static bool frame_began = false;
0a4162a4 1095
da30ecb7
JH
1096 (void)device;
1097
e8d00928 1098 assert(device);
da30ecb7 1099 assert(device == device_->device());
b0e1d01d
JH
1100 assert(packet);
1101
e8d00928 1102 switch (packet->type()->id()) {
b0e1d01d 1103 case SR_DF_HEADER:
da30ecb7 1104 feed_in_header();
b0e1d01d
JH
1105 break;
1106
be73bdfa 1107 case SR_DF_META:
da30ecb7 1108 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
aba1dd16
JH
1109 break;
1110
48257a69
SA
1111 case SR_DF_TRIGGER:
1112 feed_in_trigger();
1113 break;
1114
82f50b10
JH
1115 case SR_DF_FRAME_BEGIN:
1116 feed_in_frame_begin();
0a4162a4 1117 frame_began = true;
82f50b10
JH
1118 break;
1119
2e2946fe 1120 case SR_DF_LOGIC:
e7216ae0
SA
1121 try {
1122 feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
6f925ba9 1123 } catch (bad_alloc) {
e7216ae0
SA
1124 out_of_memory_ = true;
1125 device_->stop();
1126 }
2953961c
JH
1127 break;
1128
aba1dd16 1129 case SR_DF_ANALOG:
e7216ae0
SA
1130 try {
1131 feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
6f925ba9 1132 } catch (bad_alloc) {
e7216ae0
SA
1133 out_of_memory_ = true;
1134 device_->stop();
1135 }
aba1dd16
JH
1136 break;
1137
0a4162a4 1138 case SR_DF_FRAME_END:
2953961c 1139 case SR_DF_END:
2e2946fe
JH
1140 {
1141 {
8524a597 1142 lock_guard<recursive_mutex> lock(data_mutex_);
f3d66e52
JH
1143 cur_logic_segment_.reset();
1144 cur_analog_segments_.clear();
2e2946fe 1145 }
0a4162a4
SA
1146 if (frame_began) {
1147 frame_began = false;
1148 frame_ended();
1149 }
2953961c
JH
1150 break;
1151 }
adb0a983
ML
1152 default:
1153 break;
2e2946fe 1154 }
2953961c
JH
1155}
1156
5ccfc97e
SA
1157void Session::on_data_saved()
1158{
1159 data_saved_ = true;
1160}
1161
51e77110 1162} // namespace pv