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