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