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