pv/sigsession.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 ENABLE_DECODE
  22 #include <libsigrokdecode/libsigrokdecode.h>
  23 #endif
  24
  25 #include "sigsession.h"
  26
  27 #include "devicemanager.h"
  28 #include "device/device.h"
  29 #include "device/file.h"
  30
  31 #include "data/analog.h"
  32 #include "data/analogsnapshot.h"
  33 #include "data/decoderstack.h"
  34 #include "data/logic.h"
  35 #include "data/logicsnapshot.h"
  36 #include "data/decode/decoder.h"
  37
  38 #include "view/analogsignal.h"
  39 #include "view/decodetrace.h"
  40 #include "view/logicsignal.h"
  41
  42 #include <assert.h>
  43
  44 #include <stdexcept>
  45
  46 #include <boost/foreach.hpp>
  47
  48 #include <sys/stat.h>
  49
  50 #include <QDebug>
  51
  52 using boost::dynamic_pointer_cast;
  53 using boost::function;
  54 using boost::lock_guard;
  55 using boost::mutex;
  56 using boost::shared_ptr;
  57 using std::list;
  58 using std::map;
  59 using std::set;
  60 using std::string;
  61 using std::vector;
  62
  63 namespace pv {
  64
  65 // TODO: This should not be necessary
  66 SigSession* SigSession::_session = NULL;
  67
  68 SigSession::SigSession(DeviceManager &device_manager) :
  69         _device_manager(device_manager),
  70         _capture_state(Stopped)
  71 {
  72         // TODO: This should not be necessary
  73         _session = this;
  74
  75         set_default_device();
  76 }
  77
  78 SigSession::~SigSession()
  79 {
  80         using pv::device::Device;
  81
  82         stop_capture();
  83
  84         if (_sampling_thread.joinable())
  85                 _sampling_thread.join();
  86
  87         _dev_inst->release();
  88
  89         // TODO: This should not be necessary
  90         _session = NULL;
  91 }
  92
  93 shared_ptr<device::DevInst> SigSession::get_device() const
  94 {
  95         return _dev_inst;
  96 }
  97
  98 void SigSession::set_device(
  99         shared_ptr<device::DevInst> dev_inst) throw(QString)
 100 {
 101         using pv::device::Device;
 102
 103         // Ensure we are not capturing before setting the device
 104         stop_capture();
 105
 106         if (_dev_inst) {
 107                 sr_session_datafeed_callback_remove_all();
 108                 _dev_inst->release();
 109         }
 110
 111         _dev_inst = dev_inst;
 112         _decode_traces.clear();
 113
 114         if (dev_inst) {
 115                 dev_inst->use(this);
 116                 sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
 117                 update_signals(dev_inst);
 118         }
 119 }
 120
 121 void SigSession::set_file(const string &name) throw(QString)
 122 {
 123         // Deselect the old device, because file type detection in File::create
 124         // destroys the old session inside libsigrok.
 125         set_device(shared_ptr<device::DevInst>());
 126         set_device(shared_ptr<device::DevInst>(device::File::create(name)));
 127 }
 128
 129 void SigSession::set_default_device()
 130 {
 131         shared_ptr<pv::device::DevInst> default_device;
 132         const list< shared_ptr<device::Device> > &devices =
 133                 _device_manager.devices();
 134
 135         if (!devices.empty()) {
 136                 // Fall back to the first device in the list.
 137                 default_device = devices.front();
 138
 139                 // Try and find the demo device and select that by default
 140                 BOOST_FOREACH (shared_ptr<pv::device::Device> dev, devices)
 141                         if (strcmp(dev->dev_inst()->driver->name,
 142                                 "demo") == 0) {
 143                                 default_device = dev;
 144                                 break;
 145                         }
 146         }
 147
 148         set_device(default_device);
 149 }
 150
 151 void SigSession::release_device(device::DevInst *dev_inst)
 152 {
 153         (void)dev_inst;
 154         assert(_dev_inst.get() == dev_inst);
 155
 156         assert(_capture_state == Stopped);
 157         _dev_inst = shared_ptr<device::DevInst>();
 158 }
 159
 160 SigSession::capture_state SigSession::get_capture_state() const
 161 {
 162         lock_guard<mutex> lock(_sampling_mutex);
 163         return _capture_state;
 164 }
 165
 166 void SigSession::start_capture(function<void (const QString)> error_handler)
 167 {
 168         stop_capture();
 169
 170         // Check that a device instance has been selected.
 171         if (!_dev_inst) {
 172                 qDebug() << "No device selected";
 173                 return;
 174         }
 175
 176         assert(_dev_inst->dev_inst());
 177
 178         // Check that at least one probe is enabled
 179         const GSList *l;
 180         for (l = _dev_inst->dev_inst()->channels; l; l = l->next) {
 181                 sr_channel *const probe = (sr_channel*)l->data;
 182                 assert(probe);
 183                 if (probe->enabled)
 184                         break;
 185         }
 186
 187         if (!l) {
 188                 error_handler(tr("No channels enabled."));
 189                 return;
 190         }
 191
 192         // Begin the session
 193         _sampling_thread = boost::thread(
 194                 &SigSession::sample_thread_proc, this, _dev_inst,
 195                         error_handler);
 196 }
 197
 198 void SigSession::stop_capture()
 199 {
 200         if (get_capture_state() == Stopped)
 201                 return;
 202
 203         sr_session_stop();
 204
 205         // Check that sampling stopped
 206         if (_sampling_thread.joinable())
 207                 _sampling_thread.join();
 208 }
 209
 210 set< shared_ptr<data::SignalData> > SigSession::get_data() const
 211 {
 212         lock_guard<mutex> lock(_signals_mutex);
 213         set< shared_ptr<data::SignalData> > data;
 214         BOOST_FOREACH(const shared_ptr<view::Signal> sig, _signals) {
 215                 assert(sig);
 216                 data.insert(sig->data());
 217         }
 218
 219         return data;
 220 }
 221
 222 vector< shared_ptr<view::Signal> > SigSession::get_signals() const
 223 {
 224         lock_guard<mutex> lock(_signals_mutex);
 225         return _signals;
 226 }
 227
 228 #ifdef ENABLE_DECODE
 229 bool SigSession::add_decoder(srd_decoder *const dec)
 230 {
 231         map<const srd_channel*, shared_ptr<view::LogicSignal> > probes;
 232         shared_ptr<data::DecoderStack> decoder_stack;
 233
 234         try
 235         {
 236                 lock_guard<mutex> lock(_signals_mutex);
 237
 238                 // Create the decoder
 239                 decoder_stack = shared_ptr<data::DecoderStack>(
 240                         new data::DecoderStack(*this, dec));
 241
 242                 // Make a list of all the probes
 243                 std::vector<const srd_channel*> all_probes;
 244                 for(const GSList *i = dec->channels; i; i = i->next)
 245                         all_probes.push_back((const srd_channel*)i->data);
 246                 for(const GSList *i = dec->opt_channels; i; i = i->next)
 247                         all_probes.push_back((const srd_channel*)i->data);
 248
 249                 // Auto select the initial probes
 250                 BOOST_FOREACH(const srd_channel *pdch, all_probes)
 251                         BOOST_FOREACH(shared_ptr<view::Signal> s, _signals)
 252                         {
 253                                 shared_ptr<view::LogicSignal> l =
 254                                         dynamic_pointer_cast<view::LogicSignal>(s);
 255                                 if (l && QString::fromUtf8(pdch->name).
 256                                         toLower().contains(
 257                                         l->get_name().toLower()))
 258                                         probes[pdch] = l;
 259                         }
 260
 261                 assert(decoder_stack);
 262                 assert(!decoder_stack->stack().empty());
 263                 assert(decoder_stack->stack().front());
 264                 decoder_stack->stack().front()->set_probes(probes);
 265
 266                 // Create the decode signal
 267                 shared_ptr<view::DecodeTrace> d(
 268                         new view::DecodeTrace(*this, decoder_stack,
 269                                 _decode_traces.size()));
 270                 _decode_traces.push_back(d);
 271         }
 272         catch(std::runtime_error e)
 273         {
 274                 return false;
 275         }
 276
 277         signals_changed();
 278
 279         // Do an initial decode
 280         decoder_stack->begin_decode();
 281
 282         return true;
 283 }
 284
 285 vector< shared_ptr<view::DecodeTrace> > SigSession::get_decode_signals() const
 286 {
 287         lock_guard<mutex> lock(_signals_mutex);
 288         return _decode_traces;
 289 }
 290
 291 void SigSession::remove_decode_signal(view::DecodeTrace *signal)
 292 {
 293         for (auto i = _decode_traces.begin(); i != _decode_traces.end(); i++)
 294                 if ((*i).get() == signal)
 295                 {
 296                         _decode_traces.erase(i);
 297                         signals_changed();
 298                         return;
 299                 }
 300 }
 301 #endif
 302
 303 void SigSession::set_capture_state(capture_state state)
 304 {
 305         lock_guard<mutex> lock(_sampling_mutex);
 306         const bool changed = _capture_state != state;
 307         _capture_state = state;
 308         if(changed)
 309                 capture_state_changed(state);
 310 }
 311
 312 void SigSession::update_signals(shared_ptr<device::DevInst> dev_inst)
 313 {
 314         assert(dev_inst);
 315         assert(_capture_state == Stopped);
 316
 317         unsigned int logic_probe_count = 0;
 318
 319         // Clear the decode traces
 320         _decode_traces.clear();
 321
 322         // Detect what data types we will receive
 323         if(dev_inst) {
 324                 assert(dev_inst->dev_inst());
 325                 for (const GSList *l = dev_inst->dev_inst()->channels;
 326                         l; l = l->next) {
 327                         const sr_channel *const probe = (const sr_channel *)l->data;
 328                         if (!probe->enabled)
 329                                 continue;
 330
 331                         switch(probe->type) {
 332                         case SR_CHANNEL_LOGIC:
 333                                 logic_probe_count++;
 334                                 break;
 335                         }
 336                 }
 337         }
 338
 339         // Create data containers for the logic data snapshots
 340         {
 341                 lock_guard<mutex> data_lock(_data_mutex);
 342
 343                 _logic_data.reset();
 344                 if (logic_probe_count != 0) {
 345                         _logic_data.reset(new data::Logic(
 346                                 logic_probe_count));
 347                         assert(_logic_data);
 348                 }
 349         }
 350
 351         // Make the Signals list
 352         do {
 353                 lock_guard<mutex> lock(_signals_mutex);
 354
 355                 _signals.clear();
 356
 357                 if(!dev_inst)
 358                         break;
 359
 360                 assert(dev_inst->dev_inst());
 361                 for (const GSList *l = dev_inst->dev_inst()->channels;
 362                         l; l = l->next) {
 363                         shared_ptr<view::Signal> signal;
 364                         sr_channel *const probe = (sr_channel *)l->data;
 365                         assert(probe);
 366
 367                         switch(probe->type) {
 368                         case SR_CHANNEL_LOGIC:
 369                                 signal = shared_ptr<view::Signal>(
 370                                         new view::LogicSignal(dev_inst,
 371                                                 probe, _logic_data));
 372                                 break;
 373
 374                         case SR_CHANNEL_ANALOG:
 375                         {
 376                                 shared_ptr<data::Analog> data(
 377                                         new data::Analog());
 378                                 signal = shared_ptr<view::Signal>(
 379                                         new view::AnalogSignal(dev_inst,
 380                                                 probe, data));
 381                                 break;
 382                         }
 383
 384                         default:
 385                                 assert(0);
 386                                 break;
 387                         }
 388
 389                         assert(signal);
 390                         _signals.push_back(signal);
 391                 }
 392
 393         } while(0);
 394
 395         signals_changed();
 396 }
 397
 398 shared_ptr<view::Signal> SigSession::signal_from_probe(
 399         const sr_channel *probe) const
 400 {
 401         lock_guard<mutex> lock(_signals_mutex);
 402         BOOST_FOREACH(shared_ptr<view::Signal> sig, _signals) {
 403                 assert(sig);
 404                 if (sig->probe() == probe)
 405                         return sig;
 406         }
 407         return shared_ptr<view::Signal>();
 408 }
 409
 410 void SigSession::read_sample_rate(const sr_dev_inst *const sdi)
 411 {
 412         GVariant *gvar;
 413         uint64_t sample_rate = 0;
 414
 415         // Read out the sample rate
 416         if(sdi->driver)
 417         {
 418                 const int ret = sr_config_get(sdi->driver, sdi, NULL,
 419                         SR_CONF_SAMPLERATE, &gvar);
 420                 if (ret != SR_OK) {
 421                         qDebug("Failed to get samplerate\n");
 422                         return;
 423                 }
 424
 425                 sample_rate = g_variant_get_uint64(gvar);
 426                 g_variant_unref(gvar);
 427         }
 428
 429         // Set the sample rate of all data
 430         const set< shared_ptr<data::SignalData> > data_set = get_data();
 431         BOOST_FOREACH(shared_ptr<data::SignalData> data, data_set) {
 432                 assert(data);
 433                 data->set_samplerate(sample_rate);
 434         }
 435 }
 436
 437 void SigSession::sample_thread_proc(shared_ptr<device::DevInst> dev_inst,
 438         function<void (const QString)> error_handler)
 439 {
 440         assert(dev_inst);
 441         assert(dev_inst->dev_inst());
 442         assert(error_handler);
 443
 444         read_sample_rate(dev_inst->dev_inst());
 445
 446         try {
 447                 dev_inst->start();
 448         } catch(const QString e) {
 449                 error_handler(e);
 450                 return;
 451         }
 452
 453         set_capture_state(dev_inst->is_trigger_enabled() ?
 454                 AwaitingTrigger : Running);
 455
 456         dev_inst->run();
 457         set_capture_state(Stopped);
 458
 459         // Confirm that SR_DF_END was received
 460         if (_cur_logic_snapshot)
 461         {
 462                 qDebug("SR_DF_END was not received.");
 463                 assert(0);
 464         }
 465 }
 466
 467 void SigSession::feed_in_header(const sr_dev_inst *sdi)
 468 {
 469         read_sample_rate(sdi);
 470 }
 471
 472 void SigSession::feed_in_meta(const sr_dev_inst *sdi,
 473         const sr_datafeed_meta &meta)
 474 {
 475         (void)sdi;
 476
 477         for (const GSList *l = meta.config; l; l = l->next) {
 478                 const sr_config *const src = (const sr_config*)l->data;
 479                 switch (src->key) {
 480                 case SR_CONF_SAMPLERATE:
 481                         /// @todo handle samplerate changes
 482                         /// samplerate = (uint64_t *)src->value;
 483                         break;
 484                 default:
 485                         // Unknown metadata is not an error.
 486                         break;
 487                 }
 488         }
 489
 490         signals_changed();
 491 }
 492
 493 void SigSession::feed_in_frame_begin()
 494 {
 495         if (_cur_logic_snapshot || !_cur_analog_snapshots.empty())
 496                 frame_began();
 497 }
 498
 499 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
 500 {
 501         lock_guard<mutex> lock(_data_mutex);
 502
 503         if (!_logic_data)
 504         {
 505                 qDebug() << "Unexpected logic packet";
 506                 return;
 507         }
 508
 509         if (!_cur_logic_snapshot)
 510         {
 511                 // This could be the first packet after a trigger
 512                 set_capture_state(Running);
 513
 514                 // Create a new data snapshot
 515                 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
 516                         new data::LogicSnapshot(logic, _dev_inst->get_sample_limit()));
 517                 _logic_data->push_snapshot(_cur_logic_snapshot);
 518
 519                 // @todo Putting this here means that only listeners querying
 520                 // for logic will be notified. Currently the only user of
 521                 // frame_began is DecoderStack, but in future we need to signal
 522                 // this after both analog and logic sweeps have begun.
 523                 frame_began();
 524         }
 525         else
 526         {
 527                 // Append to the existing data snapshot
 528                 _cur_logic_snapshot->append_payload(logic);
 529         }
 530
 531         data_received();
 532 }
 533
 534 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
 535 {
 536         lock_guard<mutex> lock(_data_mutex);
 537
 538         const unsigned int probe_count = g_slist_length(analog.channels);
 539         const size_t sample_count = analog.num_samples / probe_count;
 540         const float *data = analog.data;
 541         bool sweep_beginning = false;
 542
 543         for (GSList *p = analog.channels; p; p = p->next)
 544         {
 545                 shared_ptr<data::AnalogSnapshot> snapshot;
 546
 547                 sr_channel *const probe = (sr_channel*)p->data;
 548                 assert(probe);
 549
 550                 // Try to get the snapshot of the probe
 551                 const map< const sr_channel*, shared_ptr<data::AnalogSnapshot> >::
 552                         iterator iter = _cur_analog_snapshots.find(probe);
 553                 if (iter != _cur_analog_snapshots.end())
 554                         snapshot = (*iter).second;
 555                 else
 556                 {
 557                         // If no snapshot was found, this means we havn't
 558                         // created one yet. i.e. this is the first packet
 559                         // in the sweep containing this snapshot.
 560                         sweep_beginning = true;
 561
 562                         // Create a snapshot, keep it in the maps of probes
 563                         snapshot = shared_ptr<data::AnalogSnapshot>(
 564                                 new data::AnalogSnapshot(_dev_inst->get_sample_limit()));
 565                         _cur_analog_snapshots[probe] = snapshot;
 566
 567                         // Find the annalog data associated with the probe
 568                         shared_ptr<view::AnalogSignal> sig =
 569                                 dynamic_pointer_cast<view::AnalogSignal>(
 570                                         signal_from_probe(probe));
 571                         assert(sig);
 572
 573                         shared_ptr<data::Analog> data(sig->analog_data());
 574                         assert(data);
 575
 576                         // Push the snapshot into the analog data.
 577                         data->push_snapshot(snapshot);
 578                 }
 579
 580                 assert(snapshot);
 581
 582                 // Append the samples in the snapshot
 583                 snapshot->append_interleaved_samples(data++, sample_count,
 584                         probe_count);
 585         }
 586
 587         if (sweep_beginning) {
 588                 // This could be the first packet after a trigger
 589                 set_capture_state(Running);
 590         }
 591
 592         data_received();
 593 }
 594
 595 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
 596         const struct sr_datafeed_packet *packet)
 597 {
 598         assert(sdi);
 599         assert(packet);
 600
 601         switch (packet->type) {
 602         case SR_DF_HEADER:
 603                 feed_in_header(sdi);
 604                 break;
 605
 606         case SR_DF_META:
 607                 assert(packet->payload);
 608                 feed_in_meta(sdi,
 609                         *(const sr_datafeed_meta*)packet->payload);
 610                 break;
 611
 612         case SR_DF_FRAME_BEGIN:
 613                 feed_in_frame_begin();
 614                 break;
 615
 616         case SR_DF_LOGIC:
 617                 assert(packet->payload);
 618                 feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
 619                 break;
 620
 621         case SR_DF_ANALOG:
 622                 assert(packet->payload);
 623                 feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
 624                 break;
 625
 626         case SR_DF_END:
 627         {
 628                 {
 629                         lock_guard<mutex> lock(_data_mutex);
 630                         _cur_logic_snapshot.reset();
 631                         _cur_analog_snapshots.clear();
 632                 }
 633                 frame_ended();
 634                 break;
 635         }
 636         }
 637 }
 638
 639 void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi,
 640         const struct sr_datafeed_packet *packet, void *cb_data)
 641 {
 642         (void) cb_data;
 643         assert(_session);
 644         _session->data_feed_in(sdi, packet);
 645 }
 646
 647 } // namespace pv