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