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
  29 #include "data/analog.h"
  30 #include "data/analogsnapshot.h"
  31 #include "data/decoderstack.h"
  32 #include "data/logic.h"
  33 #include "data/logicsnapshot.h"
  34 #include "data/decode/decoder.h"
  35
  36 #include "view/analogsignal.h"
  37 #include "view/decodetrace.h"
  38 #include "view/logicsignal.h"
  39
  40 #include <assert.h>
  41
  42 #include <stdexcept>
  43
  44 #include <boost/foreach.hpp>
  45
  46 #include <sys/stat.h>
  47
  48 #include <QDebug>
  49
  50 using boost::dynamic_pointer_cast;
  51 using boost::function;
  52 using boost::lock_guard;
  53 using boost::mutex;
  54 using boost::shared_ptr;
  55 using std::map;
  56 using std::set;
  57 using std::string;
  58 using std::vector;
  59
  60 namespace pv {
  61
  62 // TODO: This should not be necessary
  63 SigSession* SigSession::_session = NULL;
  64
  65 SigSession::SigSession(DeviceManager &device_manager) :
  66         _device_manager(device_manager),
  67         _sdi(NULL),
  68         _capture_state(Stopped)
  69 {
  70         // TODO: This should not be necessary
  71         _session = this;
  72 }
  73
  74 SigSession::~SigSession()
  75 {
  76         stop_capture();
  77
  78         _sampling_thread.join();
  79
  80         if (_sdi)
  81                 _device_manager.release_device(_sdi);
  82         _sdi = NULL;
  83
  84         // TODO: This should not be necessary
  85         _session = NULL;
  86 }
  87
  88 struct sr_dev_inst* SigSession::get_device() const
  89 {
  90         return _sdi;
  91 }
  92
  93 void SigSession::set_device(struct sr_dev_inst *sdi)
  94 {
  95         // Ensure we are not capturing before setting the device
  96         stop_capture();
  97
  98         if (_sdi)
  99                 _device_manager.release_device(_sdi);
 100         if (sdi)
 101                 _device_manager.use_device(sdi, this);
 102         _sdi = sdi;
 103         update_signals(sdi);
 104 }
 105
 106 void SigSession::release_device(struct sr_dev_inst *sdi)
 107 {
 108         (void)sdi;
 109
 110         assert(_capture_state == Stopped);
 111         _sdi = NULL;
 112         update_signals(NULL);
 113 }
 114
 115 void SigSession::load_file(const string &name,
 116         function<void (const QString)> error_handler)
 117 {
 118         stop_capture();
 119
 120         if (sr_session_load(name.c_str()) == SR_OK) {
 121                 GSList *devlist = NULL;
 122                 sr_session_dev_list(&devlist);
 123
 124                 if (!devlist || !devlist->data ||
 125                         sr_session_start() != SR_OK) {
 126                         error_handler(tr("Failed to start session."));
 127                         return;
 128                 }
 129
 130                 sr_dev_inst *const sdi = (sr_dev_inst*)devlist->data;
 131                 g_slist_free(devlist);
 132
 133                 _decode_traces.clear();
 134                 update_signals(sdi);
 135                 read_sample_rate(sdi);
 136
 137                 _sampling_thread = boost::thread(
 138                         &SigSession::load_session_thread_proc, this,
 139                         error_handler);
 140
 141         } else {
 142                 sr_input *in = NULL;
 143
 144                 if (!(in = load_input_file_format(name.c_str(),
 145                         error_handler)))
 146                         return;
 147
 148                 _decode_traces.clear();
 149                 update_signals(in->sdi);
 150                 read_sample_rate(in->sdi);
 151
 152                 _sampling_thread = boost::thread(
 153                         &SigSession::load_input_thread_proc, this,
 154                         name, in, error_handler);
 155         }
 156 }
 157
 158 SigSession::capture_state SigSession::get_capture_state() const
 159 {
 160         lock_guard<mutex> lock(_sampling_mutex);
 161         return _capture_state;
 162 }
 163
 164 void SigSession::start_capture(uint64_t record_length,
 165         function<void (const QString)> error_handler)
 166 {
 167         stop_capture();
 168
 169         // Check that a device instance has been selected.
 170         if (!_sdi) {
 171                 qDebug() << "No device selected";
 172                 return;
 173         }
 174
 175         // Check that at least one probe is enabled
 176         const GSList *l;
 177         for (l = _sdi->probes; l; l = l->next) {
 178                 sr_probe *const probe = (sr_probe*)l->data;
 179                 assert(probe);
 180                 if (probe->enabled)
 181                         break;
 182         }
 183
 184         if (!l) {
 185                 error_handler(tr("No probes enabled."));
 186                 return;
 187         }
 188
 189         // Begin the session
 190         _sampling_thread = boost::thread(
 191                 &SigSession::sample_thread_proc, this, _sdi,
 192                 record_length, error_handler);
 193 }
 194
 195 void SigSession::stop_capture()
 196 {
 197         if (get_capture_state() == Stopped)
 198                 return;
 199
 200         sr_session_stop();
 201
 202         // Check that sampling stopped
 203         _sampling_thread.join();
 204 }
 205
 206 set< shared_ptr<data::SignalData> > SigSession::get_data() const
 207 {
 208         lock_guard<mutex> lock(_signals_mutex);
 209         set< shared_ptr<data::SignalData> > data;
 210         BOOST_FOREACH(const shared_ptr<view::Signal> sig, _signals) {
 211                 assert(sig);
 212                 data.insert(sig->data());
 213         }
 214
 215         return data;
 216 }
 217
 218 vector< shared_ptr<view::Signal> > SigSession::get_signals() const
 219 {
 220         lock_guard<mutex> lock(_signals_mutex);
 221         return _signals;
 222 }
 223
 224 #ifdef ENABLE_DECODE
 225 bool SigSession::add_decoder(srd_decoder *const dec)
 226 {
 227         map<const srd_probe*, shared_ptr<view::LogicSignal> > probes;
 228         shared_ptr<data::DecoderStack> decoder_stack;
 229
 230         try
 231         {
 232                 lock_guard<mutex> lock(_signals_mutex);
 233
 234                 // Create the decoder
 235                 decoder_stack = shared_ptr<data::DecoderStack>(
 236                         new data::DecoderStack(dec));
 237
 238                 // Auto select the initial probes
 239                 for(const GSList *i = dec->probes; i; i = i->next)
 240                 {
 241                         const srd_probe *const probe = (const srd_probe*)i->data;
 242                         BOOST_FOREACH(shared_ptr<view::Signal> s, _signals)
 243                         {
 244                                 shared_ptr<view::LogicSignal> l =
 245                                         dynamic_pointer_cast<view::LogicSignal>(s);
 246                                 if (l && QString::fromUtf8(probe->name).
 247                                         toLower().contains(
 248                                         l->get_name().toLower()))
 249                                         probes[probe] = l;
 250                         }
 251                 }
 252
 253                 assert(decoder_stack);
 254                 assert(!decoder_stack->stack().empty());
 255                 assert(decoder_stack->stack().front());
 256                 decoder_stack->stack().front()->set_probes(probes);
 257
 258                 // Create the decode signal
 259                 shared_ptr<view::DecodeTrace> d(
 260                         new view::DecodeTrace(*this, decoder_stack,
 261                                 _decode_traces.size()));
 262                 _decode_traces.push_back(d);
 263         }
 264         catch(std::runtime_error e)
 265         {
 266                 return false;
 267         }
 268
 269         signals_changed();
 270
 271         // Do an initial decode
 272         decoder_stack->begin_decode();
 273
 274         return true;
 275 }
 276
 277 vector< shared_ptr<view::DecodeTrace> > SigSession::get_decode_signals() const
 278 {
 279         lock_guard<mutex> lock(_signals_mutex);
 280         return _decode_traces;
 281 }
 282
 283 void SigSession::remove_decode_signal(view::DecodeTrace *signal)
 284 {
 285         for (vector< shared_ptr<view::DecodeTrace> >::iterator i =
 286                 _decode_traces.begin();
 287                 i != _decode_traces.end();
 288                 i++)
 289                 if ((*i).get() == signal)
 290                 {
 291                         _decode_traces.erase(i);
 292                         signals_changed();
 293                         return;
 294                 }
 295 }
 296 #endif
 297
 298 void SigSession::set_capture_state(capture_state state)
 299 {
 300         lock_guard<mutex> lock(_sampling_mutex);
 301         const bool changed = _capture_state != state;
 302         _capture_state = state;
 303         if(changed)
 304                 capture_state_changed(state);
 305 }
 306
 307 /**
 308  * Attempts to autodetect the format. Failing that
 309  * @param filename The filename of the input file.
 310  * @return A pointer to the 'struct sr_input_format' that should be used,
 311  *         or NULL if no input format was selected or auto-detected.
 312  */
 313 sr_input_format* SigSession::determine_input_file_format(
 314         const string &filename)
 315 {
 316         int i;
 317
 318         /* If there are no input formats, return NULL right away. */
 319         sr_input_format *const *const inputs = sr_input_list();
 320         if (!inputs) {
 321                 g_critical("No supported input formats available.");
 322                 return NULL;
 323         }
 324
 325         /* Otherwise, try to find an input module that can handle this file. */
 326         for (i = 0; inputs[i]; i++) {
 327                 if (inputs[i]->format_match(filename.c_str()))
 328                         break;
 329         }
 330
 331         /* Return NULL if no input module wanted to touch this. */
 332         if (!inputs[i]) {
 333                 g_critical("Error: no matching input module found.");
 334                 return NULL;
 335         }
 336
 337         return inputs[i];
 338 }
 339
 340 sr_input* SigSession::load_input_file_format(const string &filename,
 341         function<void (const QString)> error_handler,
 342         sr_input_format *format)
 343 {
 344         struct stat st;
 345         sr_input *in;
 346
 347         if (!format && !(format =
 348                 determine_input_file_format(filename.c_str()))) {
 349                 /* The exact cause was already logged. */
 350                 return NULL;
 351         }
 352
 353         if (stat(filename.c_str(), &st) == -1) {
 354                 error_handler(tr("Failed to load file"));
 355                 return NULL;
 356         }
 357
 358         /* Initialize the input module. */
 359         if (!(in = new sr_input)) {
 360                 qDebug("Failed to allocate input module.\n");
 361                 return NULL;
 362         }
 363
 364         in->format = format;
 365         in->param = NULL;
 366         if (in->format->init &&
 367                 in->format->init(in, filename.c_str()) != SR_OK) {
 368                 qDebug("Input format init failed.\n");
 369                 return NULL;
 370         }
 371
 372         sr_session_new();
 373
 374         if (sr_session_dev_add(in->sdi) != SR_OK) {
 375                 qDebug("Failed to use device.\n");
 376                 sr_session_destroy();
 377                 return NULL;
 378         }
 379
 380         return in;
 381 }
 382
 383 void SigSession::update_signals(const sr_dev_inst *const sdi)
 384 {
 385         assert(_capture_state == Stopped);
 386
 387         unsigned int logic_probe_count = 0;
 388         unsigned int analog_probe_count = 0;
 389
 390         // Clear the decode traces
 391         _decode_traces.clear();
 392
 393         // Detect what data types we will receive
 394         if(sdi) {
 395                 for (const GSList *l = sdi->probes; l; l = l->next) {
 396                         const sr_probe *const probe = (const sr_probe *)l->data;
 397                         if (!probe->enabled)
 398                                 continue;
 399
 400                         switch(probe->type) {
 401                         case SR_PROBE_LOGIC:
 402                                 logic_probe_count++;
 403                                 break;
 404
 405                         case SR_PROBE_ANALOG:
 406                                 analog_probe_count++;
 407                                 break;
 408                         }
 409                 }
 410         }
 411
 412         // Create data containers for the data snapshots
 413         {
 414                 lock_guard<mutex> data_lock(_data_mutex);
 415
 416                 _logic_data.reset();
 417                 if (logic_probe_count != 0) {
 418                         _logic_data.reset(new data::Logic(
 419                                 logic_probe_count));
 420                         assert(_logic_data);
 421                 }
 422
 423                 _analog_data.reset();
 424                 if (analog_probe_count != 0) {
 425                         _analog_data.reset(new data::Analog());
 426                         assert(_analog_data);
 427                 }
 428         }
 429
 430         // Make the Signals list
 431         do {
 432                 lock_guard<mutex> lock(_signals_mutex);
 433
 434                 _signals.clear();
 435
 436                 if(!sdi)
 437                         break;
 438
 439                 for (const GSList *l = sdi->probes; l; l = l->next) {
 440                         shared_ptr<view::Signal> signal;
 441                         sr_probe *const probe = (sr_probe *)l->data;
 442                         assert(probe);
 443
 444                         switch(probe->type) {
 445                         case SR_PROBE_LOGIC:
 446                                 signal = shared_ptr<view::Signal>(
 447                                         new view::LogicSignal(*this, probe,
 448                                                 _logic_data));
 449                                 break;
 450
 451                         case SR_PROBE_ANALOG:
 452                                 signal = shared_ptr<view::Signal>(
 453                                         new view::AnalogSignal(*this, probe,
 454                                                 _analog_data));
 455                                 break;
 456
 457                         default:
 458                                 assert(0);
 459                                 break;
 460                         }
 461
 462                         assert(signal);
 463                         _signals.push_back(signal);
 464                 }
 465
 466         } while(0);
 467
 468         signals_changed();
 469 }
 470
 471 bool SigSession::is_trigger_enabled() const
 472 {
 473         assert(_sdi);
 474         for (const GSList *l = _sdi->probes; l; l = l->next) {
 475                 const sr_probe *const p = (const sr_probe *)l->data;
 476                 assert(p);
 477                 if (p->trigger && p->trigger[0] != '\0')
 478                         return true;
 479         }
 480
 481         return false;
 482 }
 483
 484 void SigSession::read_sample_rate(const sr_dev_inst *const sdi)
 485 {
 486         GVariant *gvar;
 487         uint64_t sample_rate = 0;
 488
 489         // Read out the sample rate
 490         if(sdi->driver)
 491         {
 492                 const int ret = sr_config_get(sdi->driver, sdi, NULL,
 493                         SR_CONF_SAMPLERATE, &gvar);
 494                 if (ret != SR_OK) {
 495                         qDebug("Failed to get samplerate\n");
 496                         return;
 497                 }
 498
 499                 sample_rate = g_variant_get_uint64(gvar);
 500                 g_variant_unref(gvar);
 501         }
 502
 503         if(_analog_data)
 504                 _analog_data->set_samplerate(sample_rate);
 505         if(_logic_data)
 506                 _logic_data->set_samplerate(sample_rate);
 507 }
 508
 509 void SigSession::load_session_thread_proc(
 510         function<void (const QString)> error_handler)
 511 {
 512         (void)error_handler;
 513
 514         sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
 515
 516         set_capture_state(Running);
 517
 518         sr_session_run();
 519
 520         sr_session_destroy();
 521         set_capture_state(Stopped);
 522
 523         // Confirm that SR_DF_END was received
 524         assert(!_cur_logic_snapshot);
 525         assert(!_cur_analog_snapshot);
 526 }
 527
 528 void SigSession::load_input_thread_proc(const string name,
 529         sr_input *in, function<void (const QString)> error_handler)
 530 {
 531         (void)error_handler;
 532
 533         assert(in);
 534         assert(in->format);
 535
 536         sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
 537
 538         set_capture_state(Running);
 539
 540         in->format->loadfile(in, name.c_str());
 541
 542         sr_session_destroy();
 543         set_capture_state(Stopped);
 544
 545         // Confirm that SR_DF_END was received
 546         assert(!_cur_logic_snapshot);
 547         assert(!_cur_analog_snapshot);
 548
 549         delete in;
 550 }
 551
 552 void SigSession::sample_thread_proc(struct sr_dev_inst *sdi,
 553         uint64_t record_length,
 554         function<void (const QString)> error_handler)
 555 {
 556         assert(sdi);
 557         assert(error_handler);
 558
 559         sr_session_new();
 560         sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
 561
 562         if (sr_session_dev_add(sdi) != SR_OK) {
 563                 error_handler(tr("Failed to use device."));
 564                 sr_session_destroy();
 565                 return;
 566         }
 567
 568         // Set the sample limit
 569         if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES,
 570                 g_variant_new_uint64(record_length)) != SR_OK) {
 571                 error_handler(tr("Failed to configure "
 572                         "time-based sample limit."));
 573                 sr_session_destroy();
 574                 return;
 575         }
 576
 577         if (sr_session_start() != SR_OK) {
 578                 error_handler(tr("Failed to start session."));
 579                 return;
 580         }
 581
 582         set_capture_state(is_trigger_enabled() ? AwaitingTrigger : Running);
 583
 584         sr_session_run();
 585         sr_session_destroy();
 586
 587         set_capture_state(Stopped);
 588
 589         // Confirm that SR_DF_END was received
 590         assert(!_cur_logic_snapshot);
 591         assert(!_cur_analog_snapshot);
 592 }
 593
 594 void SigSession::feed_in_header(const sr_dev_inst *sdi)
 595 {
 596         read_sample_rate(sdi);
 597 }
 598
 599 void SigSession::feed_in_meta(const sr_dev_inst *sdi,
 600         const sr_datafeed_meta &meta)
 601 {
 602         (void)sdi;
 603
 604         for (const GSList *l = meta.config; l; l = l->next) {
 605                 const sr_config *const src = (const sr_config*)l->data;
 606                 switch (src->key) {
 607                 case SR_CONF_SAMPLERATE:
 608                         /// @todo handle samplerate changes
 609                         /// samplerate = (uint64_t *)src->value;
 610                         break;
 611                 default:
 612                         // Unknown metadata is not an error.
 613                         break;
 614                 }
 615         }
 616
 617         signals_changed();
 618 }
 619
 620 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
 621 {
 622         lock_guard<mutex> lock(_data_mutex);
 623
 624         if (!_logic_data)
 625         {
 626                 qDebug() << "Unexpected logic packet";
 627                 return;
 628         }
 629
 630         if (!_cur_logic_snapshot)
 631         {
 632                 set_capture_state(Running);
 633
 634                 // Create a new data snapshot
 635                 _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
 636                         new data::LogicSnapshot(logic));
 637                 _logic_data->push_snapshot(_cur_logic_snapshot);
 638         }
 639         else
 640         {
 641                 // Append to the existing data snapshot
 642                 _cur_logic_snapshot->append_payload(logic);
 643         }
 644
 645         data_updated();
 646 }
 647
 648 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
 649 {
 650         lock_guard<mutex> lock(_data_mutex);
 651
 652         if(!_analog_data)
 653         {
 654                 qDebug() << "Unexpected analog packet";
 655                 return; // This analog packet was not expected.
 656         }
 657
 658         if (!_cur_analog_snapshot)
 659         {
 660                 set_capture_state(Running);
 661
 662                 // Create a new data snapshot
 663                 _cur_analog_snapshot = shared_ptr<data::AnalogSnapshot>(
 664                         new data::AnalogSnapshot(analog));
 665                 _analog_data->push_snapshot(_cur_analog_snapshot);
 666         }
 667         else
 668         {
 669                 // Append to the existing data snapshot
 670                 _cur_analog_snapshot->append_payload(analog);
 671         }
 672
 673         data_updated();
 674 }
 675
 676 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
 677         const struct sr_datafeed_packet *packet)
 678 {
 679         assert(sdi);
 680         assert(packet);
 681
 682         switch (packet->type) {
 683         case SR_DF_HEADER:
 684                 feed_in_header(sdi);
 685                 break;
 686
 687         case SR_DF_META:
 688                 assert(packet->payload);
 689                 feed_in_meta(sdi,
 690                         *(const sr_datafeed_meta*)packet->payload);
 691                 break;
 692
 693         case SR_DF_LOGIC:
 694                 assert(packet->payload);
 695                 feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
 696                 break;
 697
 698         case SR_DF_ANALOG:
 699                 assert(packet->payload);
 700                 feed_in_analog(*(const sr_datafeed_analog*)packet->payload);
 701                 break;
 702
 703         case SR_DF_END:
 704         {
 705                 {
 706                         lock_guard<mutex> lock(_data_mutex);
 707                         _cur_logic_snapshot.reset();
 708                         _cur_analog_snapshot.reset();
 709                 }
 710                 data_updated();
 711                 break;
 712         }
 713         }
 714 }
 715
 716 void SigSession::data_feed_in_proc(const struct sr_dev_inst *sdi,
 717         const struct sr_datafeed_packet *packet, void *cb_data)
 718 {
 719         (void) cb_data;
 720         assert(_session);
 721         _session->data_feed_in(sdi, packet);
 722 }
 723
 724 } // namespace pv