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