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