]> sigrok.org Git - pulseview.git/blame - pv/session.cpp
device manager: Move filter for supported devices to the scan routine
[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>
56#endif
57
6f925ba9 58using std::bad_alloc;
f9abf97e 59using std::dynamic_pointer_cast;
6f925ba9 60using std::find_if;
d2344534 61using std::function;
3b68d03d 62using std::lock_guard;
d873f4d6 63using std::list;
6f925ba9
UH
64using std::make_pair;
65using std::make_shared;
819f4c25 66using std::map;
6f925ba9
UH
67using std::max;
68using std::move;
aca64cac 69using std::mutex;
fd22c71c 70using std::pair;
8524a597 71using std::recursive_mutex;
6f925ba9 72using std::runtime_error;
f9abf97e 73using std::shared_ptr;
819f4c25 74using std::string;
303eec78 75using std::unique_ptr;
78b0af3e 76using std::unordered_set;
819f4c25 77using std::vector;
28a4c9c5 78
e8d00928
ML
79using sigrok::Analog;
80using sigrok::Channel;
e8d00928
ML
81using sigrok::ConfigKey;
82using sigrok::DatafeedCallbackFunction;
e8d00928 83using sigrok::Error;
fd22c71c 84using sigrok::InputFormat;
e8d00928
ML
85using sigrok::Logic;
86using sigrok::Meta;
87using sigrok::Packet;
e8d00928 88using sigrok::Session;
e8d00928
ML
89
90using Glib::VariantBase;
51e77110 91
e8d00928 92namespace pv {
101e7a9b 93Session::Session(DeviceManager &device_manager, QString name) :
8dbbc7f0 94 device_manager_(device_manager),
33e1afbe 95 default_name_(name),
101e7a9b 96 name_(name),
ff008de6 97 capture_state_(Stopped),
5ccfc97e
SA
98 cur_samplerate_(0),
99 data_saved_(true)
2953961c 100{
2953961c
JH
101}
102
2b81ae46 103Session::~Session()
2953961c 104{
04463625 105 // Stop and join to the thread
5b7cf66c 106 stop_capture();
2953961c
JH
107}
108
2b81ae46 109DeviceManager& Session::device_manager()
4cb0b033 110{
8dbbc7f0 111 return device_manager_;
4cb0b033
JH
112}
113
2b81ae46 114const DeviceManager& Session::device_manager() const
4cb0b033 115{
8dbbc7f0 116 return device_manager_;
4cb0b033
JH
117}
118
da30ecb7 119shared_ptr<sigrok::Session> Session::session() const
1f4caa77 120{
da30ecb7
JH
121 if (!device_)
122 return shared_ptr<sigrok::Session>();
123 return device_->session();
1f4caa77
JH
124}
125
da30ecb7 126shared_ptr<devices::Device> Session::device() const
dc0867ff 127{
8dbbc7f0 128 return device_;
dc0867ff
JH
129}
130
101e7a9b
SA
131QString Session::name() const
132{
133 return name_;
134}
135
136void Session::set_name(QString name)
137{
138 if (default_name_.isEmpty())
139 default_name_ = name;
140
141 name_ = name;
142
143 name_changed();
144}
145
6f925ba9 146const list< shared_ptr<views::ViewBase> > Session::views() const
36a8185e
SA
147{
148 return views_;
149}
150
6f925ba9 151shared_ptr<views::ViewBase> Session::main_view() const
0f8f8c18
SA
152{
153 return main_view_;
154}
155
6f925ba9 156void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
0f8f8c18
SA
157{
158 main_bar_ = main_bar;
159}
160
161shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
162{
163 return main_bar_;
164}
165
5ccfc97e
SA
166bool Session::data_saved() const
167{
168 return data_saved_;
169}
170
101e7a9b
SA
171void Session::save_settings(QSettings &settings) const
172{
173 map<string, string> dev_info;
174 list<string> key_list;
3a21afa6 175 int stacks = 0, views = 0;
101e7a9b
SA
176
177 if (device_) {
43017494
SA
178 shared_ptr<devices::HardwareDevice> hw_device =
179 dynamic_pointer_cast< devices::HardwareDevice >(device_);
180
181 if (hw_device) {
182 settings.setValue("device_type", "hardware");
183 settings.beginGroup("device");
184
326cf6fe
UH
185 key_list.emplace_back("vendor");
186 key_list.emplace_back("model");
187 key_list.emplace_back("version");
188 key_list.emplace_back("serial_num");
189 key_list.emplace_back("connection_id");
43017494
SA
190
191 dev_info = device_manager_.get_device_info(device_);
192
193 for (string key : key_list) {
194 if (dev_info.count(key))
195 settings.setValue(QString::fromUtf8(key.c_str()),
196 QString::fromUtf8(dev_info.at(key).c_str()));
197 else
198 settings.remove(QString::fromUtf8(key.c_str()));
199 }
101e7a9b 200
43017494
SA
201 settings.endGroup();
202 }
101e7a9b 203
43017494
SA
204 shared_ptr<devices::SessionFile> sessionfile_device =
205 dynamic_pointer_cast< devices::SessionFile >(device_);
206
207 if (sessionfile_device) {
208 settings.setValue("device_type", "sessionfile");
209 settings.beginGroup("device");
210 settings.setValue("filename", QString::fromStdString(
211 sessionfile_device->full_name()));
212 settings.endGroup();
101e7a9b
SA
213 }
214
aecae05c
SA
215 // Save channels and decoders
216 for (shared_ptr<data::SignalBase> base : signalbases_) {
217#ifdef ENABLE_DECODE
218 if (base->is_decode_signal()) {
219 shared_ptr<pv::data::DecoderStack> decoder_stack =
220 base->decoder_stack();
6f925ba9 221 shared_ptr<data::decode::Decoder> top_decoder =
aecae05c
SA
222 decoder_stack->stack().front();
223
224 settings.beginGroup("decoder_stack" + QString::number(stacks++));
225 settings.setValue("id", top_decoder->decoder()->id);
226 settings.setValue("name", top_decoder->decoder()->name);
227 settings.endGroup();
228 } else
229#endif
230 {
231 settings.beginGroup(base->internal_name());
6de38b17 232 base->save_settings(settings);
aecae05c
SA
233 settings.endGroup();
234 }
235 }
101e7a9b 236
aecae05c 237 settings.setValue("decoder_stacks", stacks);
3a21afa6
SA
238
239 // Save view states and their signal settings
240 // Note: main_view must be saved as view0
241 settings.beginGroup("view" + QString::number(views++));
242 main_view_->save_settings(settings);
243 settings.endGroup();
244
f4e57597 245 for (shared_ptr<views::ViewBase> view : views_) {
3a21afa6
SA
246 if (view != main_view_) {
247 settings.beginGroup("view" + QString::number(views++));
248 view->save_settings(settings);
249 settings.endGroup();
250 }
251 }
252
253 settings.setValue("views", views);
101e7a9b
SA
254 }
255}
256
257void Session::restore_settings(QSettings &settings)
258{
43017494
SA
259 shared_ptr<devices::Device> device;
260
261 QString device_type = settings.value("device_type").toString();
262
263 if (device_type == "hardware") {
264 map<string, string> dev_info;
265 list<string> key_list;
266
267 // Re-select last used device if possible but only if it's not demo
268 settings.beginGroup("device");
326cf6fe
UH
269 key_list.emplace_back("vendor");
270 key_list.emplace_back("model");
271 key_list.emplace_back("version");
272 key_list.emplace_back("serial_num");
273 key_list.emplace_back("connection_id");
43017494
SA
274
275 for (string key : key_list) {
276 const QString k = QString::fromStdString(key);
277 if (!settings.contains(k))
278 continue;
279
280 const string value = settings.value(k).toString().toStdString();
281 if (!value.empty())
6f925ba9 282 dev_info.insert(make_pair(key, value));
43017494
SA
283 }
284
285 if (dev_info.count("model") > 0)
286 device = device_manager_.find_device_from_info(dev_info);
287
288 if (device)
289 set_device(device);
290
291 settings.endGroup();
101e7a9b
SA
292 }
293
43017494
SA
294 if (device_type == "sessionfile") {
295 settings.beginGroup("device");
296 QString filename = settings.value("filename").toString();
297 settings.endGroup();
101e7a9b 298
43017494 299 if (QFileInfo(filename).isReadable()) {
067bb624 300 device = make_shared<devices::SessionFile>(device_manager_.context(),
43017494
SA
301 filename.toStdString());
302 set_device(device);
101e7a9b 303
43017494
SA
304 // TODO Perform error handling
305 start_capture([](QString infoMessage) { (void)infoMessage; });
33e1afbe
SA
306
307 set_name(QFileInfo(filename).fileName());
43017494
SA
308 }
309 }
310
311 if (device) {
aecae05c
SA
312 // Restore channels
313 for (shared_ptr<data::SignalBase> base : signalbases_) {
314 settings.beginGroup(base->internal_name());
6de38b17 315 base->restore_settings(settings);
aecae05c
SA
316 settings.endGroup();
317 }
318
319 // Restore decoders
320#ifdef ENABLE_DECODE
321 int stacks = settings.value("decoder_stacks").toInt();
322
323 for (int i = 0; i < stacks; i++) {
324 settings.beginGroup("decoder_stack" + QString::number(i++));
325
326 QString id = settings.value("id").toString();
327 add_decoder(srd_decoder_get_by_id(id.toStdString().c_str()));
328
329 settings.endGroup();
330 }
331#endif
3a21afa6
SA
332
333 // Restore views
334 int views = settings.value("views").toInt();
335
336 for (int i = 0; i < views; i++) {
337 settings.beginGroup("view" + QString::number(i));
338
339 if (i > 0) {
f4e57597 340 views::ViewType type = (views::ViewType)settings.value("type").toInt();
3a21afa6
SA
341 add_view(name_, type, this);
342 views_.back()->restore_settings(settings);
343 } else
344 main_view_->restore_settings(settings);
345
346 settings.endGroup();
347 }
101e7a9b 348 }
101e7a9b
SA
349}
350
fd22c71c
SA
351void Session::select_device(shared_ptr<devices::Device> device)
352{
353 try {
354 if (device)
355 set_device(device);
356 else
357 set_default_device();
358 } catch (const QString &e) {
359 main_bar_->session_error(tr("Failed to Select Device"),
360 tr("Failed to Select Device"));
361 }
362}
363
da30ecb7 364void Session::set_device(shared_ptr<devices::Device> device)
d64d1596 365{
da30ecb7
JH
366 assert(device);
367
82596f46
JH
368 // Ensure we are not capturing before setting the device
369 stop_capture();
370
4d6c6ea3
SA
371 if (device_)
372 device_->close();
373
86123e2e
SA
374 device_.reset();
375
7b254679 376 // Revert name back to default name (e.g. "Session 1") as the data is gone
101e7a9b
SA
377 name_ = default_name_;
378 name_changed();
379
cc9a7898 380 // Remove all stored data
6f925ba9 381 for (shared_ptr<views::ViewBase> view : views_) {
47e9e7bb 382 view->clear_signals();
bb7dd726 383#ifdef ENABLE_DECODE
f4e57597 384 view->clear_decode_signals();
bb7dd726
SA
385#endif
386 }
47e9e7bb
SA
387 for (const shared_ptr<data::SignalData> d : all_signal_data_)
388 d->clear();
cc9a7898 389 all_signal_data_.clear();
47e9e7bb 390 signalbases_.clear();
4b0d7046
SA
391 cur_logic_segment_.reset();
392
393 for (auto entry : cur_analog_segments_) {
394 shared_ptr<sigrok::Channel>(entry.first).reset();
395 shared_ptr<data::AnalogSegment>(entry.second).reset();
396 }
397
398 logic_data_.reset();
4b0d7046 399
86123e2e
SA
400 signals_changed();
401
6f925ba9 402 device_ = move(device);
7e0c99bf
SA
403
404 try {
405 device_->open();
406 } catch (const QString &e) {
407 device_.reset();
7e0c99bf
SA
408 }
409
bcd64b9b
SA
410 if (device_) {
411 device_->session()->add_datafeed_callback([=]
412 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
413 data_feed_in(device, packet);
414 });
415
416 update_signals();
417 }
ae2d1bc5 418
91f8fe8c 419 device_changed();
ae2d1bc5 420}
85843b14 421
2b81ae46 422void Session::set_default_device()
6fd0b639 423{
da30ecb7 424 const list< shared_ptr<devices::HardwareDevice> > &devices =
8dbbc7f0 425 device_manager_.devices();
6fd0b639 426
da30ecb7
JH
427 if (devices.empty())
428 return;
dc0867ff 429
da30ecb7 430 // Try and find the demo device and select that by default
6f925ba9 431 const auto iter = find_if(devices.begin(), devices.end(),
da30ecb7 432 [] (const shared_ptr<devices::HardwareDevice> &d) {
6f925ba9 433 return d->hardware_device()->driver()->name() == "demo"; });
da30ecb7 434 set_device((iter == devices.end()) ? devices.front() : *iter);
dc0867ff
JH
435}
436
724f29f3
GS
437/**
438 * Convert generic options to data types that are specific to InputFormat.
439 *
440 * @param[in] user_spec vector of tokenized words, string format
441 * @param[in] fmt_opts input format's options, result of InputFormat::options()
442 *
443 * @return map of options suitable for InputFormat::create_input()
444 */
445map<string, Glib::VariantBase>
446Session::input_format_options(vector<string> user_spec,
447 map<string, shared_ptr<Option>> fmt_opts)
448{
449 map<string, Glib::VariantBase> result;
450
451 for (auto entry : user_spec) {
452 /*
453 * Split key=value specs. Accept entries without separator
454 * (for simplified boolean specifications).
455 */
456 string key, val;
457 size_t pos = entry.find("=");
458 if (pos == std::string::npos) {
459 key = entry;
460 val = "";
461 } else {
462 key = entry.substr(0, pos);
463 val = entry.substr(pos + 1);
464 }
465
466 /*
467 * Skip user specifications that are not a member of the
468 * format's set of supported options. Have the text input
469 * spec converted to the required input format specific
470 * data type.
471 */
472 auto found = fmt_opts.find(key);
473 if (found == fmt_opts.end())
474 continue;
475 shared_ptr<Option> opt = found->second;
476 result[key] = opt->parse_string(val);
477 }
478
479 return result;
480}
481
6f925ba9 482void Session::load_init_file(const string &file_name, const string &format)
fd22c71c
SA
483{
484 shared_ptr<InputFormat> input_format;
724f29f3 485 map<string, Glib::VariantBase> input_opts;
fd22c71c
SA
486
487 if (!format.empty()) {
488 const map<string, shared_ptr<InputFormat> > formats =
489 device_manager_.context()->input_formats();
724f29f3
GS
490 auto user_opts = pv::util::split_string(format, ":");
491 string user_name = user_opts.front();
492 user_opts.erase(user_opts.begin());
fd22c71c
SA
493 const auto iter = find_if(formats.begin(), formats.end(),
494 [&](const pair<string, shared_ptr<InputFormat> > f) {
724f29f3 495 return f.first == user_name; });
fd22c71c
SA
496 if (iter == formats.end()) {
497 main_bar_->session_error(tr("Error"),
498 tr("Unexpected input format: %s").arg(QString::fromStdString(format)));
499 return;
500 }
fd22c71c 501 input_format = (*iter).second;
724f29f3
GS
502 input_opts = input_format_options(user_opts,
503 input_format->options());
fd22c71c
SA
504 }
505
724f29f3 506 load_file(QString::fromStdString(file_name), input_format, input_opts);
fd22c71c
SA
507}
508
509void Session::load_file(QString file_name,
6f925ba9
UH
510 shared_ptr<sigrok::InputFormat> format,
511 const map<string, Glib::VariantBase> &options)
fd22c71c
SA
512{
513 const QString errorMessage(
514 QString("Failed to load file %1").arg(file_name));
515
516 try {
517 if (format)
518 set_device(shared_ptr<devices::Device>(
519 new devices::InputFile(
520 device_manager_.context(),
521 file_name.toStdString(),
522 format, options)));
523 else
524 set_device(shared_ptr<devices::Device>(
525 new devices::SessionFile(
526 device_manager_.context(),
527 file_name.toStdString())));
528 } catch (Error e) {
529 main_bar_->session_error(tr("Failed to load ") + file_name, e.what());
530 set_default_device();
531 main_bar_->update_device_list();
532 return;
533 }
534
535 main_bar_->update_device_list();
536
537 start_capture([&, errorMessage](QString infoMessage) {
538 main_bar_->session_error(errorMessage, infoMessage); });
539
540 set_name(QFileInfo(file_name).fileName());
541}
542
2b81ae46 543Session::capture_state Session::get_capture_state() const
5b7cf66c 544{
8dbbc7f0
JH
545 lock_guard<mutex> lock(sampling_mutex_);
546 return capture_state_;
5b7cf66c
JH
547}
548
2b81ae46 549void Session::start_capture(function<void (const QString)> error_handler)
2e2946fe 550{
34c11fa7
SA
551 if (!device_) {
552 error_handler(tr("No active device set, can't start acquisition."));
553 return;
554 }
555
5b7cf66c
JH
556 stop_capture();
557
6ac6242b 558 // Check that at least one channel is enabled
e6c1382e
JH
559 const shared_ptr<sigrok::Device> sr_dev = device_->device();
560 if (sr_dev) {
561 const auto channels = sr_dev->channels();
6f925ba9 562 if (!any_of(channels.begin(), channels.end(),
e6c1382e
JH
563 [](shared_ptr<Channel> channel) {
564 return channel->enabled(); })) {
565 error_handler(tr("No channels enabled."));
566 return;
567 }
9c48fa57
JH
568 }
569
53ea4c6c 570 // Clear signal data
47e9e7bb
SA
571 for (const shared_ptr<data::SignalData> d : all_signal_data_)
572 d->clear();
53ea4c6c 573
53bb2e1d
SA
574 // Revert name back to default name (e.g. "Session 1") for real devices
575 // as the (possibly saved) data is gone. File devices keep their name.
576 shared_ptr<devices::HardwareDevice> hw_device =
577 dynamic_pointer_cast< devices::HardwareDevice >(device_);
578
579 if (hw_device) {
580 name_ = default_name_;
581 name_changed();
582 }
101e7a9b 583
9c48fa57 584 // Begin the session
8dbbc7f0 585 sampling_thread_ = std::thread(
2b05d311 586 &Session::sample_thread_proc, this, error_handler);
2e2946fe
JH
587}
588
2b81ae46 589void Session::stop_capture()
5b7cf66c 590{
04463625 591 if (get_capture_state() != Stopped)
da30ecb7 592 device_->stop();
5b7cf66c
JH
593
594 // Check that sampling stopped
8dbbc7f0
JH
595 if (sampling_thread_.joinable())
596 sampling_thread_.join();
5b7cf66c
JH
597}
598
6f925ba9 599void Session::register_view(shared_ptr<views::ViewBase> view)
47e9e7bb 600{
0f8f8c18
SA
601 if (views_.empty()) {
602 main_view_ = view;
603 }
604
3a21afa6 605 views_.push_back(view);
53e8927d
SA
606
607 update_signals();
47e9e7bb
SA
608}
609
6f925ba9 610void Session::deregister_view(shared_ptr<views::ViewBase> view)
47e9e7bb 611{
6f925ba9 612 views_.remove_if([&](shared_ptr<views::ViewBase> v) { return v == view; });
0f8f8c18
SA
613
614 if (views_.empty()) {
615 main_view_.reset();
616
617 // Without a view there can be no main bar
618 main_bar_.reset();
619 }
47e9e7bb
SA
620}
621
6f925ba9 622bool Session::has_view(shared_ptr<views::ViewBase> view)
101e7a9b 623{
6f925ba9 624 for (shared_ptr<views::ViewBase> v : views_)
3a21afa6
SA
625 if (v == view)
626 return true;
627
628 return false;
101e7a9b
SA
629}
630
2220e942
SA
631double Session::get_samplerate() const
632{
633 double samplerate = 0.0;
634
47e9e7bb
SA
635 for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
636 assert(d);
637 const vector< shared_ptr<pv::data::Segment> > segments =
638 d->segments();
639 for (const shared_ptr<pv::data::Segment> &s : segments)
6f925ba9 640 samplerate = max(samplerate, s->samplerate());
2220e942 641 }
2220e942
SA
642 // If there is no sample rate given we use samples as unit
643 if (samplerate == 0.0)
644 samplerate = 1.0;
645
646 return samplerate;
647}
648
6f925ba9 649const unordered_set< shared_ptr<data::SignalBase> > Session::signalbases() const
2e2946fe 650{
47e9e7bb 651 return signalbases_;
2e2946fe
JH
652}
653
269528f5 654#ifdef ENABLE_DECODE
2b81ae46 655bool Session::add_decoder(srd_decoder *const dec)
82c7f640 656{
a7336fb2
SA
657 if (!dec)
658 return false;
659
04394ded 660 map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
7491a29f 661 shared_ptr<data::DecoderStack> decoder_stack;
4e5a4405 662
2ad82c2e 663 try {
4e5a4405 664 // Create the decoder
067bb624 665 decoder_stack = make_shared<data::DecoderStack>(*this, dec);
4e5a4405 666
6ac6242b 667 // Make a list of all the channels
6f925ba9 668 vector<const srd_channel*> all_channels;
f3290553 669 for (const GSList *i = dec->channels; i; i = i->next)
6ac6242b 670 all_channels.push_back((const srd_channel*)i->data);
f3290553 671 for (const GSList *i = dec->opt_channels; i; i = i->next)
6ac6242b 672 all_channels.push_back((const srd_channel*)i->data);
d2f46d27 673
6ac6242b
ML
674 // Auto select the initial channels
675 for (const srd_channel *pdch : all_channels)
04394ded 676 for (shared_ptr<data::SignalBase> b : signalbases_) {
79c4a9c8 677 if (b->logic_data()) {
04394ded
SA
678 if (QString::fromUtf8(pdch->name).toLower().
679 contains(b->name().toLower()))
680 channels[pdch] = b;
681 }
4e5a4405 682 }
4e5a4405 683
7491a29f
JH
684 assert(decoder_stack);
685 assert(!decoder_stack->stack().empty());
686 assert(decoder_stack->stack().front());
6ac6242b 687 decoder_stack->stack().front()->set_channels(channels);
4e5a4405
JH
688
689 // Create the decode signal
bf0edd2b 690 shared_ptr<data::SignalBase> signalbase =
472a80c5 691 make_shared<data::SignalBase>(nullptr, data::SignalBase::DecodeChannel);
bf0edd2b 692
bb7dd726 693 signalbase->set_decoder_stack(decoder_stack);
aecae05c 694 signalbases_.insert(signalbase);
bb7dd726 695
6f925ba9 696 for (shared_ptr<views::ViewBase> view : views_)
f4e57597 697 view->add_decode_signal(signalbase);
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
bb7dd726 710void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
38eeddea 711{
2d25fc47
SA
712 signalbases_.erase(signalbase);
713
6f925ba9 714 for (shared_ptr<views::ViewBase> view : views_)
f4e57597 715 view->remove_decode_signal(signalbase);
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