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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifdef _WIN32
  22 // Windows: Avoid boost/thread namespace pollution (which includes windows.h).
  23 #define NOGDI
  24 #define NORESOURCE
  25 #endif
  26 #include <boost/thread/locks.hpp>
  27 #include <boost/thread/shared_mutex.hpp>
  28
  29 #ifdef ENABLE_DECODE
  30 #include <libsigrokdecode/libsigrokdecode.h>
  31 #endif
  32
  33 #include "session.hpp"
  34
  35 #include "devicemanager.hpp"
  36
  37 #include "data/analog.hpp"
  38 #include "data/analogsegment.hpp"
  39 #include "data/decoderstack.hpp"
  40 #include "data/logic.hpp"
  41 #include "data/logicsegment.hpp"
  42 #include "data/decode/decoder.hpp"
  43
  44 #include "devices/hardwaredevice.hpp"
  45 #include "devices/sessionfile.hpp"
  46
  47 #include "view/analogsignal.hpp"
  48 #include "view/decodetrace.hpp"
  49 #include "view/logicsignal.hpp"
  50
  51 #include <cassert>
  52 #include <mutex>
  53 #include <stdexcept>
  54
  55 #include <sys/stat.h>
  56
  57 #include <QDebug>
  58
  59 #include <libsigrokcxx/libsigrokcxx.hpp>
  60
  61 using boost::shared_lock;
  62 using boost::shared_mutex;
  63 using boost::unique_lock;
  64
  65 using std::dynamic_pointer_cast;
  66 using std::function;
  67 using std::lock_guard;
  68 using std::list;
  69 using std::map;
  70 using std::mutex;
  71 using std::recursive_mutex;
  72 using std::set;
  73 using std::shared_ptr;
  74 using std::string;
  75 using std::unordered_set;
  76 using std::vector;
  77
  78 using sigrok::Analog;
  79 using sigrok::Channel;
  80 using sigrok::ChannelType;
  81 using sigrok::ConfigKey;
  82 using sigrok::DatafeedCallbackFunction;
  83 using sigrok::Error;
  84 using sigrok::Header;
  85 using sigrok::Logic;
  86 using sigrok::Meta;
  87 using sigrok::Packet;
  88 using sigrok::PacketPayload;
  89 using sigrok::Session;
  90 using sigrok::SessionDevice;
  91
  92 using Glib::VariantBase;
  93 using Glib::Variant;
  94
  95 namespace pv {
  96 Session::Session(DeviceManager &device_manager) :
  97         device_manager_(device_manager),
  98         capture_state_(Stopped),
  99         cur_samplerate_(0)
 100 {
 101 }
 102
 103 Session::~Session()
 104 {
 105         // Stop and join to the thread
 106         stop_capture();
 107 }
 108
 109 DeviceManager& Session::device_manager()
 110 {
 111         return device_manager_;
 112 }
 113
 114 const DeviceManager& Session::device_manager() const
 115 {
 116         return device_manager_;
 117 }
 118
 119 shared_ptr<sigrok::Session> Session::session() const
 120 {
 121         if (!device_)
 122                 return shared_ptr<sigrok::Session>();
 123         return device_->session();
 124 }
 125
 126 shared_ptr<devices::Device> Session::device() const
 127 {
 128         return device_;
 129 }
 130
 131 void Session::set_device(shared_ptr<devices::Device> device)
 132 {
 133         assert(device);
 134
 135         // Ensure we are not capturing before setting the device
 136         stop_capture();
 137
 138         if (device_)
 139                 device_->close();
 140
 141         device_.reset();
 142
 143         // Remove all traces
 144         signals_.clear();
 145         decode_traces_.clear();
 146         signals_changed();
 147
 148         device_ = std::move(device);
 149         device_->open();
 150         device_->session()->add_datafeed_callback([=]
 151                 (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
 152                         data_feed_in(device, packet);
 153                 });
 154
 155         update_signals();
 156         device_selected();
 157 }
 158
 159 void Session::set_default_device()
 160 {
 161         const list< shared_ptr<devices::HardwareDevice> > &devices =
 162                 device_manager_.devices();
 163
 164         if (devices.empty())
 165                 return;
 166
 167         // Try and find the demo device and select that by default
 168         const auto iter = std::find_if(devices.begin(), devices.end(),
 169                 [] (const shared_ptr<devices::HardwareDevice> &d) {
 170                         return d->hardware_device()->driver()->name() ==
 171                         "demo"; });
 172         set_device((iter == devices.end()) ? devices.front() : *iter);
 173 }
 174
 175 Session::capture_state Session::get_capture_state() const
 176 {
 177         lock_guard<mutex> lock(sampling_mutex_);
 178         return capture_state_;
 179 }
 180
 181 void Session::start_capture(function<void (const QString)> error_handler)
 182 {
 183         stop_capture();
 184
 185         // Check that at least one channel is enabled
 186         assert(device_);
 187         const shared_ptr<sigrok::Device> sr_dev = device_->device();
 188         if (sr_dev) {
 189                 const auto channels = sr_dev->channels();
 190                 if (!std::any_of(channels.begin(), channels.end(),
 191                         [](shared_ptr<Channel> channel) {
 192                                 return channel->enabled(); })) {
 193                         error_handler(tr("No channels enabled."));
 194                         return;
 195                 }
 196         }
 197
 198         // Clear signal data
 199         for (const shared_ptr<data::SignalData> d : get_data())
 200                 d->clear();
 201
 202         // Begin the session
 203         sampling_thread_ = std::thread(
 204                 &Session::sample_thread_proc, this, device_,
 205                         error_handler);
 206 }
 207
 208 void Session::stop_capture()
 209 {
 210         if (get_capture_state() != Stopped)
 211                 device_->stop();
 212
 213         // Check that sampling stopped
 214         if (sampling_thread_.joinable())
 215                 sampling_thread_.join();
 216 }
 217
 218 set< shared_ptr<data::SignalData> > Session::get_data() const
 219 {
 220         shared_lock<shared_mutex> lock(signals_mutex_);
 221         set< shared_ptr<data::SignalData> > data;
 222         for (const shared_ptr<view::Signal> sig : signals_) {
 223                 assert(sig);
 224                 data.insert(sig->data());
 225         }
 226
 227         return data;
 228 }
 229
 230 double Session::get_samplerate() const
 231 {
 232         double samplerate = 0.0;
 233
 234         for (const shared_ptr<pv::data::SignalData> d : get_data()) {
 235                 assert(d);
 236                 const vector< shared_ptr<pv::data::Segment> > segments =
 237                         d->segments();
 238                 for (const shared_ptr<pv::data::Segment> &s : segments)
 239                         samplerate = std::max(samplerate, s->samplerate());
 240         }
 241
 242         // If there is no sample rate given we use samples as unit
 243         if (samplerate == 0.0)
 244                 samplerate = 1.0;
 245
 246         return samplerate;
 247 }
 248
 249 const unordered_set< shared_ptr<view::Signal> > Session::signals() const
 250 {
 251         shared_lock<shared_mutex> lock(signals_mutex_);
 252         return signals_;
 253 }
 254
 255 #ifdef ENABLE_DECODE
 256 bool Session::add_decoder(srd_decoder *const dec)
 257 {
 258         map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
 259         shared_ptr<data::DecoderStack> decoder_stack;
 260
 261         try {
 262                 lock_guard<boost::shared_mutex> lock(signals_mutex_);
 263
 264                 // Create the decoder
 265                 decoder_stack = shared_ptr<data::DecoderStack>(
 266                         new data::DecoderStack(*this, dec));
 267
 268                 // Make a list of all the channels
 269                 std::vector<const srd_channel*> all_channels;
 270                 for (const GSList *i = dec->channels; i; i = i->next)
 271                         all_channels.push_back((const srd_channel*)i->data);
 272                 for (const GSList *i = dec->opt_channels; i; i = i->next)
 273                         all_channels.push_back((const srd_channel*)i->data);
 274
 275                 // Auto select the initial channels
 276                 for (const srd_channel *pdch : all_channels)
 277                         for (shared_ptr<view::Signal> s : signals_) {
 278                                 shared_ptr<view::LogicSignal> l =
 279                                         dynamic_pointer_cast<view::LogicSignal>(s);
 280                                 if (l && QString::fromUtf8(pdch->name).
 281                                         toLower().contains(
 282                                         l->name().toLower()))
 283                                         channels[pdch] = l;
 284                         }
 285
 286                 assert(decoder_stack);
 287                 assert(!decoder_stack->stack().empty());
 288                 assert(decoder_stack->stack().front());
 289                 decoder_stack->stack().front()->set_channels(channels);
 290
 291                 // Create the decode signal
 292                 shared_ptr<view::DecodeTrace> d(
 293                         new view::DecodeTrace(*this, decoder_stack,
 294                                 decode_traces_.size()));
 295                 decode_traces_.push_back(d);
 296         } catch (std::runtime_error e) {
 297                 return false;
 298         }
 299
 300         signals_changed();
 301
 302         // Do an initial decode
 303         decoder_stack->begin_decode();
 304
 305         return true;
 306 }
 307
 308 vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
 309 {
 310         shared_lock<shared_mutex> lock(signals_mutex_);
 311         return decode_traces_;
 312 }
 313
 314 void Session::remove_decode_signal(view::DecodeTrace *signal)
 315 {
 316         for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
 317                 if ((*i).get() == signal) {
 318                         decode_traces_.erase(i);
 319                         signals_changed();
 320                         return;
 321                 }
 322 }
 323 #endif
 324
 325 void Session::set_capture_state(capture_state state)
 326 {
 327         bool changed;
 328
 329         {
 330                 lock_guard<mutex> lock(sampling_mutex_);
 331                 changed = capture_state_ != state;
 332                 capture_state_ = state;
 333         }
 334
 335         if (changed)
 336                 capture_state_changed(state);
 337 }
 338
 339 void Session::update_signals()
 340 {
 341         if (!device_) {
 342                 signals_.clear();
 343                 logic_data_.reset();
 344                 return;
 345         }
 346
 347         lock_guard<recursive_mutex> lock(data_mutex_);
 348
 349         const shared_ptr<sigrok::Device> sr_dev = device_->device();
 350         if (!sr_dev) {
 351                 signals_.clear();
 352                 logic_data_.reset();
 353                 return;
 354         }
 355
 356         // Detect what data types we will receive
 357         auto channels = sr_dev->channels();
 358         unsigned int logic_channel_count = std::count_if(
 359                 channels.begin(), channels.end(),
 360                 [] (shared_ptr<Channel> channel) {
 361                         return channel->type() == ChannelType::LOGIC; });
 362
 363         // Create data containers for the logic data segments
 364         {
 365                 lock_guard<recursive_mutex> data_lock(data_mutex_);
 366
 367                 if (logic_channel_count == 0) {
 368                         logic_data_.reset();
 369                 } else if (!logic_data_ ||
 370                         logic_data_->num_channels() != logic_channel_count) {
 371                         logic_data_.reset(new data::Logic(
 372                                 logic_channel_count));
 373                         assert(logic_data_);
 374                 }
 375         }
 376
 377         // Make the Signals list
 378         {
 379                 unique_lock<shared_mutex> lock(signals_mutex_);
 380
 381                 unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
 382                 signals_.clear();
 383
 384                 for (auto channel : sr_dev->channels()) {
 385                         shared_ptr<view::Signal> signal;
 386
 387                         // Find the channel in the old signals
 388                         const auto iter = std::find_if(
 389                                 prev_sigs.cbegin(), prev_sigs.cend(),
 390                                 [&](const shared_ptr<view::Signal> &s) {
 391                                         return s->channel() == channel;
 392                                 });
 393                         if (iter != prev_sigs.end()) {
 394                                 // Copy the signal from the old set to the new
 395                                 signal = *iter;
 396                                 auto logic_signal = dynamic_pointer_cast<
 397                                         view::LogicSignal>(signal);
 398                                 if (logic_signal)
 399                                         logic_signal->set_logic_data(
 400                                                 logic_data_);
 401                         } else {
 402                                 // Create a new signal
 403                                 switch(channel->type()->id()) {
 404                                 case SR_CHANNEL_LOGIC:
 405                                         signal = shared_ptr<view::Signal>(
 406                                                 new view::LogicSignal(*this,
 407                                                         device_, channel,
 408                                                         logic_data_));
 409                                         break;
 410
 411                                 case SR_CHANNEL_ANALOG:
 412                                 {
 413                                         shared_ptr<data::Analog> data(
 414                                                 new data::Analog());
 415                                         signal = shared_ptr<view::Signal>(
 416                                                 new view::AnalogSignal(
 417                                                         *this, channel, data));
 418                                         break;
 419                                 }
 420
 421                                 default:
 422                                         assert(0);
 423                                         break;
 424                                 }
 425                         }
 426
 427                         assert(signal);
 428                         signals_.insert(signal);
 429                 }
 430         }
 431
 432         signals_changed();
 433 }
 434
 435 shared_ptr<view::Signal> Session::signal_from_channel(
 436         shared_ptr<Channel> channel) const
 437 {
 438         lock_guard<boost::shared_mutex> lock(signals_mutex_);
 439         for (shared_ptr<view::Signal> sig : signals_) {
 440                 assert(sig);
 441                 if (sig->channel() == channel)
 442                         return sig;
 443         }
 444         return shared_ptr<view::Signal>();
 445 }
 446
 447 void Session::sample_thread_proc(shared_ptr<devices::Device> device,
 448         function<void (const QString)> error_handler)
 449 {
 450         assert(device);
 451         assert(error_handler);
 452
 453         (void)device;
 454
 455         cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
 456
 457         out_of_memory_ = false;
 458
 459         try {
 460                 device_->start();
 461         } catch (Error e) {
 462                 error_handler(e.what());
 463                 return;
 464         }
 465
 466         set_capture_state(device_->session()->trigger() ?
 467                 AwaitingTrigger : Running);
 468
 469         device_->run();
 470         set_capture_state(Stopped);
 471
 472         // Confirm that SR_DF_END was received
 473         if (cur_logic_segment_) {
 474                 qDebug("SR_DF_END was not received.");
 475                 assert(0);
 476         }
 477
 478         if (out_of_memory_)
 479                 error_handler(tr("Out of memory, acquisition stopped."));
 480 }
 481
 482 void Session::feed_in_header()
 483 {
 484         cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
 485 }
 486
 487 void Session::feed_in_meta(shared_ptr<Meta> meta)
 488 {
 489         for (auto entry : meta->config()) {
 490                 switch (entry.first->id()) {
 491                 case SR_CONF_SAMPLERATE:
 492                         // We can't rely on the header to always contain the sample rate,
 493                         // so in case it's supplied via a meta packet, we use it.
 494                         if (!cur_samplerate_)
 495                                 cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
 496
 497                         /// @todo handle samplerate changes
 498                         break;
 499                 default:
 500                         // Unknown metadata is not an error.
 501                         break;
 502                 }
 503         }
 504
 505         signals_changed();
 506 }
 507
 508 void Session::feed_in_trigger()
 509 {
 510         // The channel containing most samples should be most accurate
 511         uint64_t sample_count = 0;
 512
 513         for (const shared_ptr<pv::data::SignalData> d : get_data()) {
 514                 assert(d);
 515                 uint64_t temp_count = 0;
 516
 517                 const vector< shared_ptr<pv::data::Segment> > segments =
 518                         d->segments();
 519                 for (const shared_ptr<pv::data::Segment> &s : segments)
 520                         temp_count += s->get_sample_count();
 521
 522                 if (temp_count > sample_count)
 523                         sample_count = temp_count;
 524         }
 525
 526         trigger_event(sample_count / get_samplerate());
 527 }
 528
 529 void Session::feed_in_frame_begin()
 530 {
 531         if (cur_logic_segment_ || !cur_analog_segments_.empty())
 532                 frame_began();
 533 }
 534
 535 void Session::feed_in_logic(shared_ptr<Logic> logic)
 536 {
 537         lock_guard<recursive_mutex> lock(data_mutex_);
 538
 539         const size_t sample_count = logic->data_length() / logic->unit_size();
 540
 541         if (!logic_data_) {
 542                 // The only reason logic_data_ would not have been created is
 543                 // if it was not possible to determine the signals when the
 544                 // device was created.
 545                 update_signals();
 546         }
 547
 548         if (!cur_logic_segment_) {
 549                 // This could be the first packet after a trigger
 550                 set_capture_state(Running);
 551
 552                 // Create a new data segment
 553                 cur_logic_segment_ = shared_ptr<data::LogicSegment>(
 554                         new data::LogicSegment(
 555                                 logic, cur_samplerate_, sample_count));
 556                 logic_data_->push_segment(cur_logic_segment_);
 557
 558                 // @todo Putting this here means that only listeners querying
 559                 // for logic will be notified. Currently the only user of
 560                 // frame_began is DecoderStack, but in future we need to signal
 561                 // this after both analog and logic sweeps have begun.
 562                 frame_began();
 563         } else {
 564                 // Append to the existing data segment
 565                 cur_logic_segment_->append_payload(logic);
 566         }
 567
 568         data_received();
 569 }
 570
 571 void Session::feed_in_analog(shared_ptr<Analog> analog)
 572 {
 573         lock_guard<recursive_mutex> lock(data_mutex_);
 574
 575         const vector<shared_ptr<Channel>> channels = analog->channels();
 576         const unsigned int channel_count = channels.size();
 577         const size_t sample_count = analog->num_samples() / channel_count;
 578         const float *data = static_cast<const float *>(analog->data_pointer());
 579         bool sweep_beginning = false;
 580
 581         if (signals_.empty())
 582                 update_signals();
 583
 584         for (auto channel : channels) {
 585                 shared_ptr<data::AnalogSegment> segment;
 586
 587                 // Try to get the segment of the channel
 588                 const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >::
 589                         iterator iter = cur_analog_segments_.find(channel);
 590                 if (iter != cur_analog_segments_.end())
 591                         segment = (*iter).second;
 592                 else {
 593                         // If no segment was found, this means we haven't
 594                         // created one yet. i.e. this is the first packet
 595                         // in the sweep containing this segment.
 596                         sweep_beginning = true;
 597
 598                         // Create a segment, keep it in the maps of channels
 599                         segment = shared_ptr<data::AnalogSegment>(
 600                                 new data::AnalogSegment(
 601                                         cur_samplerate_, sample_count));
 602                         cur_analog_segments_[channel] = segment;
 603
 604                         // Find the analog data associated with the channel
 605                         shared_ptr<view::AnalogSignal> sig =
 606                                 dynamic_pointer_cast<view::AnalogSignal>(
 607                                         signal_from_channel(channel));
 608                         assert(sig);
 609
 610                         shared_ptr<data::Analog> data(sig->analog_data());
 611                         assert(data);
 612
 613                         // Push the segment into the analog data.
 614                         data->push_segment(segment);
 615                 }
 616
 617                 assert(segment);
 618
 619                 // Append the samples in the segment
 620                 segment->append_interleaved_samples(data++, sample_count,
 621                         channel_count);
 622         }
 623
 624         if (sweep_beginning) {
 625                 // This could be the first packet after a trigger
 626                 set_capture_state(Running);
 627         }
 628
 629         data_received();
 630 }
 631
 632 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
 633         shared_ptr<Packet> packet)
 634 {
 635         (void)device;
 636
 637         assert(device);
 638         assert(device == device_->device());
 639         assert(packet);
 640
 641         switch (packet->type()->id()) {
 642         case SR_DF_HEADER:
 643                 feed_in_header();
 644                 break;
 645
 646         case SR_DF_META:
 647                 feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
 648                 break;
 649
 650         case SR_DF_TRIGGER:
 651                 feed_in_trigger();
 652                 break;
 653
 654         case SR_DF_FRAME_BEGIN:
 655                 feed_in_frame_begin();
 656                 break;
 657
 658         case SR_DF_LOGIC:
 659                 try {
 660                         feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
 661                 } catch (std::bad_alloc) {
 662                         out_of_memory_ = true;
 663                         device_->stop();
 664                 }
 665                 break;
 666
 667         case SR_DF_ANALOG:
 668                 try {
 669                         feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
 670                 } catch (std::bad_alloc) {
 671                         out_of_memory_ = true;
 672                         device_->stop();
 673                 }
 674                 break;
 675
 676         case SR_DF_END:
 677         {
 678                 {
 679                         lock_guard<recursive_mutex> lock(data_mutex_);
 680                         cur_logic_segment_.reset();
 681                         cur_analog_segments_.clear();
 682                 }
 683                 frame_ended();
 684                 break;
 685         }
 686         default:
 687                 break;
 688         }
 689 }
 690
 691 } // namespace pv