pv/session.cpp

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