pv/data/decodesignal.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <limits>
  21
  22 #include <QDebug>
  23
  24 #include "logic.hpp"
  25 #include "logicsegment.hpp"
  26 #include "decodesignal.hpp"
  27 #include "signaldata.hpp"
  28
  29 #include <pv/binding/decoder.hpp>
  30 #include <pv/data/decode/decoder.hpp>
  31 #include <pv/data/decode/row.hpp>
  32 #include <pv/globalsettings.hpp>
  33 #include <pv/session.hpp>
  34
  35 using std::lock_guard;
  36 using std::make_pair;
  37 using std::make_shared;
  38 using std::min;
  39 using std::shared_ptr;
  40 using std::unique_lock;
  41 using pv::data::decode::Annotation;
  42 using pv::data::decode::Decoder;
  43 using pv::data::decode::Row;
  44
  45 namespace pv {
  46 namespace data {
  47
  48 const double DecodeSignal::DecodeMargin = 1.0;
  49 const double DecodeSignal::DecodeThreshold = 0.2;
  50 const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
  51
  52
  53 DecodeSignal::DecodeSignal(pv::Session &session) :
  54         SignalBase(nullptr, SignalBase::DecodeChannel),
  55         session_(session),
  56         srd_session_(nullptr),
  57         logic_mux_data_invalid_(false),
  58         start_time_(0),
  59         samplerate_(0),
  60         samples_decoded_(0),
  61         frame_complete_(false)
  62 {
  63         connect(&session_, SIGNAL(capture_state_changed(int)),
  64                 this, SLOT(on_capture_state_changed(int)));
  65 }
  66
  67 DecodeSignal::~DecodeSignal()
  68 {
  69         reset_decode();
  70 }
  71
  72 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
  73 {
  74         return stack_;
  75 }
  76
  77 void DecodeSignal::stack_decoder(const srd_decoder *decoder)
  78 {
  79         assert(decoder);
  80         const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
  81
  82         stack_.push_back(dec);
  83
  84         // Set name if this decoder is the first in the list
  85         if (stack_.size() == 1)
  86                 set_name(QString::fromUtf8(decoder->name));
  87
  88         // Include the newly created decode channels in the channel lists
  89         update_channel_list();
  90
  91         auto_assign_signals(dec);
  92         commit_decoder_channels();
  93         begin_decode();
  94 }
  95
  96 void DecodeSignal::remove_decoder(int index)
  97 {
  98         assert(index >= 0);
  99         assert(index < (int)stack_.size());
 100
 101         // Find the decoder in the stack
 102         auto iter = stack_.begin();
 103         for (int i = 0; i < index; i++, iter++)
 104                 assert(iter != stack_.end());
 105
 106         // Delete the element
 107         stack_.erase(iter);
 108
 109         // Update channels and decoded data
 110         update_channel_list();
 111         begin_decode();
 112 }
 113
 114 bool DecodeSignal::toggle_decoder_visibility(int index)
 115 {
 116         auto iter = stack_.cbegin();
 117         for (int i = 0; i < index; i++, iter++)
 118                 assert(iter != stack_.end());
 119
 120         shared_ptr<Decoder> dec = *iter;
 121
 122         // Toggle decoder visibility
 123         bool state = false;
 124         if (dec) {
 125                 state = !dec->shown();
 126                 dec->show(state);
 127         }
 128
 129         return state;
 130 }
 131
 132 void DecodeSignal::reset_decode()
 133 {
 134         if (decode_thread_.joinable()) {
 135                 decode_interrupt_ = true;
 136                 decode_input_cond_.notify_one();
 137                 decode_thread_.join();
 138         }
 139
 140         if (logic_mux_thread_.joinable()) {
 141                 logic_mux_interrupt_ = true;
 142                 logic_mux_cond_.notify_one();
 143                 logic_mux_thread_.join();
 144         }
 145
 146         stop_srd_session();
 147
 148         frame_complete_ = false;
 149         samples_decoded_ = 0;
 150         error_message_ = QString();
 151
 152         rows_.clear();
 153         current_rows_= nullptr;
 154         class_rows_.clear();
 155
 156         logic_mux_data_.reset();
 157         logic_mux_data_invalid_ = true;
 158
 159         decode_reset();
 160 }
 161
 162 void DecodeSignal::begin_decode()
 163 {
 164         if (decode_thread_.joinable()) {
 165                 decode_interrupt_ = true;
 166                 decode_input_cond_.notify_one();
 167                 decode_thread_.join();
 168         }
 169
 170         if (logic_mux_thread_.joinable()) {
 171                 logic_mux_interrupt_ = true;
 172                 logic_mux_cond_.notify_one();
 173                 logic_mux_thread_.join();
 174         }
 175
 176         reset_decode();
 177
 178         if (stack_.size() == 0) {
 179                 error_message_ = tr("No decoders");
 180                 return;
 181         }
 182
 183         assert(channels_.size() > 0);
 184
 185         if (get_assigned_signal_count() == 0) {
 186                 error_message_ = tr("There are no channels assigned to this decoder");
 187                 return;
 188         }
 189
 190         // Make sure that all assigned channels still provide logic data
 191         // (can happen when a converted signal was assigned but the
 192         // conversion removed in the meanwhile)
 193         for (data::DecodeChannel &ch : channels_)
 194                 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
 195                         ch.assigned_signal = nullptr;
 196
 197         // Check that all decoders have the required channels
 198         for (const shared_ptr<decode::Decoder> &dec : stack_)
 199                 if (!dec->have_required_channels()) {
 200                         error_message_ = tr("One or more required channels "
 201                                 "have not been specified");
 202                         return;
 203                 }
 204
 205         // Map out all the annotation classes
 206         for (const shared_ptr<decode::Decoder> &dec : stack_) {
 207                 assert(dec);
 208                 const srd_decoder *const decc = dec->decoder();
 209                 assert(dec->decoder());
 210
 211                 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
 212                         const srd_decoder_annotation_row *const ann_row =
 213                                 (srd_decoder_annotation_row *)l->data;
 214                         assert(ann_row);
 215
 216                         const Row row(decc, ann_row);
 217
 218                         for (const GSList *ll = ann_row->ann_classes;
 219                                 ll; ll = ll->next)
 220                                 class_rows_[make_pair(decc,
 221                                         GPOINTER_TO_INT(ll->data))] = row;
 222                 }
 223         }
 224
 225         prepare_annotation_segment();
 226
 227         // Free the logic data and its segment(s) if it needs to be updated
 228         if (logic_mux_data_invalid_)
 229                 logic_mux_data_.reset();
 230
 231         if (!logic_mux_data_) {
 232                 const int64_t ch_count = get_assigned_signal_count();
 233                 const int64_t unit_size = (ch_count + 7) / 8;
 234                 logic_mux_data_ = make_shared<Logic>(ch_count);
 235                 logic_mux_segment_ = make_shared<LogicSegment>(*logic_mux_data_, unit_size, samplerate_);
 236                 logic_mux_data_->push_segment(logic_mux_segment_);
 237         }
 238
 239         // Make sure the logic output data is complete and up-to-date
 240         logic_mux_interrupt_ = false;
 241         logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
 242
 243         // Decode the muxed logic data
 244         decode_interrupt_ = false;
 245         decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
 246
 247         // Receive notifications when new sample data is available
 248         connect_input_notifiers();
 249 }
 250
 251 QString DecodeSignal::error_message() const
 252 {
 253         lock_guard<mutex> lock(output_mutex_);
 254         return error_message_;
 255 }
 256
 257 const vector<data::DecodeChannel> DecodeSignal::get_channels() const
 258 {
 259         return channels_;
 260 }
 261
 262 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
 263 {
 264         bool new_assignment = false;
 265
 266         // Try to auto-select channels that don't have signals assigned yet
 267         for (data::DecodeChannel &ch : channels_) {
 268                 // If a decoder is given, auto-assign only its channels
 269                 if (dec && (ch.decoder_ != dec))
 270                         continue;
 271
 272                 if (ch.assigned_signal)
 273                         continue;
 274
 275                 for (shared_ptr<data::SignalBase> s : session_.signalbases()) {
 276                         const QString ch_name = ch.name.toLower();
 277                         const QString s_name = s->name().toLower();
 278
 279                         if (s->logic_data() &&
 280                                 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
 281                                 ch.assigned_signal = s.get();
 282                                 new_assignment = true;
 283                         }
 284                 }
 285         }
 286
 287         if (new_assignment) {
 288                 logic_mux_data_invalid_ = true;
 289                 commit_decoder_channels();
 290                 channels_updated();
 291         }
 292 }
 293
 294 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
 295 {
 296         for (data::DecodeChannel &ch : channels_)
 297                 if (ch.id == channel_id) {
 298                         ch.assigned_signal = signal;
 299                         logic_mux_data_invalid_ = true;
 300                 }
 301
 302         commit_decoder_channels();
 303         channels_updated();
 304         begin_decode();
 305 }
 306
 307 int DecodeSignal::get_assigned_signal_count() const
 308 {
 309         // Count all channels that have a signal assigned to them
 310         return count_if(channels_.begin(), channels_.end(),
 311                 [](data::DecodeChannel ch) { return ch.assigned_signal; });
 312 }
 313
 314 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
 315 {
 316         for (data::DecodeChannel &ch : channels_)
 317                 if (ch.id == channel_id)
 318                         ch.initial_pin_state = init_state;
 319
 320         channels_updated();
 321
 322         begin_decode();
 323 }
 324
 325 double DecodeSignal::samplerate() const
 326 {
 327         return samplerate_;
 328 }
 329
 330 const pv::util::Timestamp& DecodeSignal::start_time() const
 331 {
 332         return start_time_;
 333 }
 334
 335 int64_t DecodeSignal::get_working_sample_count() const
 336 {
 337         // The working sample count is the highest sample number for
 338         // which all used signals have data available, so go through
 339         // all channels and use the lowest overall sample count of the
 340         // current segment
 341
 342         // TODO Currently, we assume only a single segment exists
 343
 344         int64_t count = std::numeric_limits<int64_t>::max();
 345         bool no_signals_assigned = true;
 346
 347         for (const data::DecodeChannel &ch : channels_)
 348                 if (ch.assigned_signal) {
 349                         no_signals_assigned = false;
 350
 351                         const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
 352                         if (!logic_data || logic_data->logic_segments().empty())
 353                                 return 0;
 354
 355                         const shared_ptr<LogicSegment> segment = logic_data->logic_segments().front();
 356                         count = min(count, (int64_t)segment->get_sample_count());
 357                 }
 358
 359         return (no_signals_assigned ? 0 : count);
 360 }
 361
 362 int64_t DecodeSignal::get_decoded_sample_count() const
 363 {
 364         lock_guard<mutex> decode_lock(output_mutex_);
 365         return samples_decoded_;
 366 }
 367
 368 vector<Row> DecodeSignal::visible_rows() const
 369 {
 370         lock_guard<mutex> lock(output_mutex_);
 371
 372         vector<Row> rows;
 373
 374         for (const shared_ptr<decode::Decoder> &dec : stack_) {
 375                 assert(dec);
 376                 if (!dec->shown())
 377                         continue;
 378
 379                 const srd_decoder *const decc = dec->decoder();
 380                 assert(dec->decoder());
 381
 382                 // Add a row for the decoder if it doesn't have a row list
 383                 if (!decc->annotation_rows)
 384                         rows.emplace_back(decc);
 385
 386                 // Add the decoder rows
 387                 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
 388                         const srd_decoder_annotation_row *const ann_row =
 389                                 (srd_decoder_annotation_row *)l->data;
 390                         assert(ann_row);
 391                         rows.emplace_back(decc, ann_row);
 392                 }
 393         }
 394
 395         return rows;
 396 }
 397
 398 void DecodeSignal::get_annotation_subset(
 399         vector<pv::data::decode::Annotation> &dest,
 400         const decode::Row &row, uint64_t start_sample,
 401         uint64_t end_sample) const
 402 {
 403         lock_guard<mutex> lock(output_mutex_);
 404
 405         if (!current_rows_)
 406                 return;
 407
 408         // TODO Instead of current_rows_, use rows_ and the ID of the segment
 409
 410         const auto iter = current_rows_->find(row);
 411         if (iter != current_rows_->end())
 412                 (*iter).second.get_annotation_subset(dest,
 413                         start_sample, end_sample);
 414 }
 415
 416 void DecodeSignal::save_settings(QSettings &settings) const
 417 {
 418         SignalBase::save_settings(settings);
 419
 420         settings.setValue("decoders", (int)(stack_.size()));
 421
 422         // Save decoder stack
 423         int decoder_idx = 0;
 424         for (shared_ptr<decode::Decoder> decoder : stack_) {
 425                 settings.beginGroup("decoder" + QString::number(decoder_idx++));
 426
 427                 settings.setValue("id", decoder->decoder()->id);
 428
 429                 // Save decoder options
 430                 const map<string, GVariant*>& options = decoder->options();
 431
 432                 settings.setValue("options", (int)options.size());
 433
 434                 // Note: decode::Decoder::options() returns only the options
 435                 // that differ from the default. See binding::Decoder::getter()
 436                 int i = 0;
 437                 for (auto option : options) {
 438                         settings.beginGroup("option" + QString::number(i));
 439                         settings.setValue("name", QString::fromStdString(option.first));
 440                         GlobalSettings::store_gvariant(settings, option.second);
 441                         settings.endGroup();
 442                         i++;
 443                 }
 444
 445                 settings.endGroup();
 446         }
 447
 448         // Save channel mapping
 449         settings.setValue("channels", (int)channels_.size());
 450
 451         for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
 452                 auto channel = find_if(channels_.begin(), channels_.end(),
 453                         [&](data::DecodeChannel ch) { return ch.id == channel_id; });
 454
 455                 if (channel == channels_.end()) {
 456                         qDebug() << "ERROR: Gap in channel index:" << channel_id;
 457                         continue;
 458                 }
 459
 460                 settings.beginGroup("channel" + QString::number(channel_id));
 461
 462                 settings.setValue("name", channel->name);  // Useful for debugging
 463                 settings.setValue("initial_pin_state", channel->initial_pin_state);
 464
 465                 if (channel->assigned_signal)
 466                         settings.setValue("assigned_signal_name", channel->assigned_signal->name());
 467
 468                 settings.endGroup();
 469         }
 470 }
 471
 472 void DecodeSignal::restore_settings(QSettings &settings)
 473 {
 474         SignalBase::restore_settings(settings);
 475
 476         // Restore decoder stack
 477         GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
 478
 479         int decoders = settings.value("decoders").toInt();
 480
 481         for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
 482                 settings.beginGroup("decoder" + QString::number(decoder_idx));
 483
 484                 QString id = settings.value("id").toString();
 485
 486                 for (GSList *entry = dec_list; entry; entry = entry->next) {
 487                         const srd_decoder *dec = (srd_decoder*)entry->data;
 488                         if (!dec)
 489                                 continue;
 490
 491                         if (QString::fromUtf8(dec->id) == id) {
 492                                 shared_ptr<decode::Decoder> decoder =
 493                                         make_shared<decode::Decoder>(dec);
 494
 495                                 stack_.push_back(decoder);
 496
 497                                 // Restore decoder options that differ from their default
 498                                 int options = settings.value("options").toInt();
 499
 500                                 for (int i = 0; i < options; i++) {
 501                                         settings.beginGroup("option" + QString::number(i));
 502                                         QString name = settings.value("name").toString();
 503                                         GVariant *value = GlobalSettings::restore_gvariant(settings);
 504                                         decoder->set_option(name.toUtf8(), value);
 505                                         settings.endGroup();
 506                                 }
 507
 508                                 // Include the newly created decode channels in the channel lists
 509                                 update_channel_list();
 510                                 commit_decoder_channels();
 511                                 break;
 512                         }
 513                 }
 514
 515                 settings.endGroup();
 516                 channels_updated();
 517         }
 518
 519         // Restore channel mapping
 520         unsigned int channels = settings.value("channels").toInt();
 521
 522         const unordered_set< shared_ptr<data::SignalBase> > signalbases =
 523                 session_.signalbases();
 524
 525         for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
 526                 auto channel = find_if(channels_.begin(), channels_.end(),
 527                         [&](data::DecodeChannel ch) { return ch.id == channel_id; });
 528
 529                 if (channel == channels_.end()) {
 530                         qDebug() << "ERROR: Non-existant channel index:" << channel_id;
 531                         continue;
 532                 }
 533
 534                 settings.beginGroup("channel" + QString::number(channel_id));
 535
 536                 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
 537
 538                 for (shared_ptr<data::SignalBase> signal : signalbases)
 539                         if (signal->name() == assigned_signal_name)
 540                                 channel->assigned_signal = signal.get();
 541
 542                 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
 543
 544                 settings.endGroup();
 545         }
 546
 547         begin_decode();
 548 }
 549
 550 void DecodeSignal::update_channel_list()
 551 {
 552         vector<data::DecodeChannel> prev_channels = channels_;
 553         channels_.clear();
 554
 555         uint16_t id = 0;
 556
 557         // Copy existing entries, create new as needed
 558         for (shared_ptr<Decoder> decoder : stack_) {
 559                 const srd_decoder* srd_d = decoder->decoder();
 560                 const GSList *l;
 561
 562                 // Mandatory channels
 563                 for (l = srd_d->channels; l; l = l->next) {
 564                         const struct srd_channel *const pdch = (struct srd_channel *)l->data;
 565                         bool ch_added = false;
 566
 567                         // Copy but update ID if this channel was in the list before
 568                         for (data::DecodeChannel &ch : prev_channels)
 569                                 if (ch.pdch_ == pdch) {
 570                                         ch.id = id++;
 571                                         channels_.push_back(ch);
 572                                         ch_added = true;
 573                                         break;
 574                                 }
 575
 576                         if (!ch_added) {
 577                                 // Create new entry without a mapped signal
 578                                 data::DecodeChannel ch = {id++, 0, false, nullptr,
 579                                         QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
 580                                         SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
 581                                 channels_.push_back(ch);
 582                         }
 583                 }
 584
 585                 // Optional channels
 586                 for (l = srd_d->opt_channels; l; l = l->next) {
 587                         const struct srd_channel *const pdch = (struct srd_channel *)l->data;
 588                         bool ch_added = false;
 589
 590                         // Copy but update ID if this channel was in the list before
 591                         for (data::DecodeChannel &ch : prev_channels)
 592                                 if (ch.pdch_ == pdch) {
 593                                         ch.id = id++;
 594                                         channels_.push_back(ch);
 595                                         ch_added = true;
 596                                         break;
 597                                 }
 598
 599                         if (!ch_added) {
 600                                 // Create new entry without a mapped signal
 601                                 data::DecodeChannel ch = {id++, 0, true, nullptr,
 602                                         QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
 603                                         SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
 604                                 channels_.push_back(ch);
 605                         }
 606                 }
 607         }
 608
 609         // Invalidate the logic output data if the channel assignment changed
 610         if (prev_channels.size() != channels_.size()) {
 611                 // The number of channels changed, there's definitely a difference
 612                 logic_mux_data_invalid_ = true;
 613         } else {
 614                 // Same number but assignment may still differ, so compare all channels
 615                 for (size_t i = 0; i < channels_.size(); i++) {
 616                         const data::DecodeChannel &p_ch = prev_channels[i];
 617                         const data::DecodeChannel &ch = channels_[i];
 618
 619                         if ((p_ch.pdch_ != ch.pdch_) ||
 620                                 (p_ch.assigned_signal != ch.assigned_signal)) {
 621                                 logic_mux_data_invalid_ = true;
 622                                 break;
 623                         }
 624                 }
 625
 626         }
 627
 628         channels_updated();
 629 }
 630
 631 void DecodeSignal::commit_decoder_channels()
 632 {
 633         // Submit channel list to every decoder, containing only the relevant channels
 634         for (shared_ptr<decode::Decoder> dec : stack_) {
 635                 vector<data::DecodeChannel*> channel_list;
 636
 637                 for (data::DecodeChannel &ch : channels_)
 638                         if (ch.decoder_ == dec)
 639                                 channel_list.push_back(&ch);
 640
 641                 dec->set_channels(channel_list);
 642         }
 643 }
 644
 645 void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end)
 646 {
 647         // Enforce end to be greater than start
 648         if (end <= start)
 649                 return;
 650
 651         // Fetch all segments and their data
 652         // TODO Currently, we assume only a single segment exists
 653         vector<shared_ptr<LogicSegment> > segments;
 654         vector<const uint8_t*> signal_data;
 655         vector<uint8_t> signal_in_bytepos;
 656         vector<uint8_t> signal_in_bitpos;
 657
 658         int id = 0;
 659         for (data::DecodeChannel &ch : channels_)
 660                 if (ch.assigned_signal) {
 661                         ch.bit_id = id++;
 662
 663                         const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
 664                         const shared_ptr<LogicSegment> segment = logic_data->logic_segments().front();
 665                         segments.push_back(segment);
 666
 667                         uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
 668                         segment->get_samples(start, end, data);
 669                         signal_data.push_back(data);
 670
 671                         const int bitpos = ch.assigned_signal->logic_bit_index();
 672                         signal_in_bytepos.push_back(bitpos / 8);
 673                         signal_in_bitpos.push_back(bitpos % 8);
 674                 }
 675
 676         // Perform the muxing of signal data into the output data
 677         uint8_t* output = new uint8_t[(end - start) * logic_mux_segment_->unit_size()];
 678         unsigned int signal_count = signal_data.size();
 679
 680         for (int64_t sample_cnt = 0; sample_cnt < (end - start); sample_cnt++) {
 681                 int bitpos = 0;
 682                 uint8_t bytepos = 0;
 683
 684                 const int out_sample_pos = sample_cnt * logic_mux_segment_->unit_size();
 685                 for (unsigned int i = 0; i < logic_mux_segment_->unit_size(); i++)
 686                         output[out_sample_pos + i] = 0;
 687
 688                 for (unsigned int i = 0; i < signal_count; i++) {
 689                         const int in_sample_pos = sample_cnt * segments[i]->unit_size();
 690                         const uint8_t in_sample = 1 &
 691                                 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
 692
 693                         const uint8_t out_sample = output[out_sample_pos + bytepos];
 694
 695                         output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
 696
 697                         bitpos++;
 698                         if (bitpos > 7) {
 699                                 bitpos = 0;
 700                                 bytepos++;
 701                         }
 702                 }
 703         }
 704
 705         logic_mux_segment_->append_payload(output, (end - start) * logic_mux_segment_->unit_size());
 706         delete[] output;
 707
 708         for (const uint8_t* data : signal_data)
 709                 delete[] data;
 710 }
 711
 712 void DecodeSignal::logic_mux_proc()
 713 {
 714         do {
 715                 const uint64_t input_sample_count = get_working_sample_count();
 716                 const uint64_t output_sample_count = logic_mux_segment_->get_sample_count();
 717
 718                 const uint64_t samples_to_process =
 719                         (input_sample_count > output_sample_count) ?
 720                         (input_sample_count - output_sample_count) : 0;
 721
 722                 // Process the samples if necessary...
 723                 if (samples_to_process > 0) {
 724                         const uint64_t unit_size = logic_mux_segment_->unit_size();
 725                         const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
 726
 727                         uint64_t processed_samples = 0;
 728                         do {
 729                                 const uint64_t start_sample = output_sample_count + processed_samples;
 730                                 const uint64_t sample_count =
 731                                         min(samples_to_process - processed_samples,     chunk_sample_count);
 732
 733                                 mux_logic_samples(start_sample, start_sample + sample_count);
 734                                 processed_samples += sample_count;
 735
 736                                 // ...and process the newly muxed logic data
 737                                 decode_input_cond_.notify_one();
 738                         } while (processed_samples < samples_to_process);
 739                 }
 740
 741                 if (samples_to_process == 0) {
 742                         // Wait for more input
 743                         unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
 744                         logic_mux_cond_.wait(logic_mux_lock);
 745                 }
 746         } while (!logic_mux_interrupt_);
 747 }
 748
 749 void DecodeSignal::query_input_metadata()
 750 {
 751         // Update the samplerate and start time because we cannot start
 752         // the libsrd session without the current samplerate
 753
 754         // TODO Currently we assume all channels have the same sample rate
 755         // and start time
 756         bool samplerate_valid = false;
 757         data::DecodeChannel *any_channel;
 758         shared_ptr<Logic> logic_data;
 759
 760         do {
 761                 any_channel = &(*find_if(channels_.begin(), channels_.end(),
 762                         [](data::DecodeChannel ch) { return ch.assigned_signal; }));
 763
 764                 logic_data = any_channel->assigned_signal->logic_data();
 765
 766                 if (!logic_data) {
 767                         // Wait until input data is available or an interrupt was requested
 768                         unique_lock<mutex> input_wait_lock(input_mutex_);
 769                         decode_input_cond_.wait(input_wait_lock);
 770                 }
 771         } while (!logic_data && !decode_interrupt_);
 772
 773         if (decode_interrupt_)
 774                 return;
 775
 776         do {
 777                 if (!logic_data->logic_segments().empty()) {
 778                         shared_ptr<LogicSegment> first_segment =
 779                                 any_channel->assigned_signal->logic_data()->logic_segments().front();
 780                         start_time_ = first_segment->start_time();
 781                         samplerate_ = first_segment->samplerate();
 782                         if (samplerate_ > 0)
 783                                 samplerate_valid = true;
 784                 }
 785
 786                 if (!samplerate_valid) {
 787                         // Wait until input data is available or an interrupt was requested
 788                         unique_lock<mutex> input_wait_lock(input_mutex_);
 789                         decode_input_cond_.wait(input_wait_lock);
 790                 }
 791         } while (!samplerate_valid && !decode_interrupt_);
 792 }
 793
 794 void DecodeSignal::decode_data(
 795         const int64_t abs_start_samplenum, const int64_t sample_count)
 796 {
 797         const int64_t unit_size = logic_mux_segment_->unit_size();
 798         const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
 799
 800         for (int64_t i = abs_start_samplenum;
 801                 !decode_interrupt_ && (i < (abs_start_samplenum + sample_count));
 802                 i += chunk_sample_count) {
 803
 804                 const int64_t chunk_end = min(i + chunk_sample_count,
 805                         abs_start_samplenum + sample_count);
 806
 807                 int64_t data_size = (chunk_end - i) * unit_size;
 808                 uint8_t* chunk = new uint8_t[data_size];
 809                 logic_mux_segment_->get_samples(i, chunk_end, chunk);
 810
 811                 if (srd_session_send(srd_session_, i, chunk_end, chunk,
 812                                 data_size, unit_size) != SRD_OK) {
 813                         error_message_ = tr("Decoder reported an error");
 814                         delete[] chunk;
 815                         break;
 816                 }
 817
 818                 delete[] chunk;
 819
 820                 {
 821                         lock_guard<mutex> lock(output_mutex_);
 822                         samples_decoded_ = chunk_end;
 823                 }
 824
 825                 // Notify the frontend that we processed some data and
 826                 // possibly have new annotations as well
 827                 new_annotations();
 828         }
 829 }
 830
 831 void DecodeSignal::decode_proc()
 832 {
 833         query_input_metadata();
 834
 835         if (decode_interrupt_)
 836                 return;
 837
 838         start_srd_session();
 839
 840         uint64_t sample_count;
 841         uint64_t abs_start_samplenum = 0;
 842         do {
 843                 // Keep processing new samples until we exhaust the input data
 844                 do {
 845                         lock_guard<mutex> input_lock(input_mutex_);
 846                         sample_count = logic_mux_segment_->get_sample_count() - abs_start_samplenum;
 847
 848                         if (sample_count > 0) {
 849                                 decode_data(abs_start_samplenum, sample_count);
 850                                 abs_start_samplenum += sample_count;
 851                         }
 852                 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
 853
 854                 if (error_message_.isEmpty() && !decode_interrupt_) {
 855                         if (sample_count == 0)
 856                                 decode_finished();
 857
 858                         // Wait for new input data or an interrupt was requested
 859                         unique_lock<mutex> input_wait_lock(input_mutex_);
 860                         decode_input_cond_.wait(input_wait_lock);
 861                 }
 862         } while (error_message_.isEmpty() && !decode_interrupt_);
 863 }
 864
 865 void DecodeSignal::start_srd_session()
 866 {
 867         if (srd_session_)
 868                 stop_srd_session();
 869
 870         // Create the session
 871         srd_session_new(&srd_session_);
 872         assert(srd_session_);
 873
 874         // Create the decoders
 875         srd_decoder_inst *prev_di = nullptr;
 876         for (const shared_ptr<decode::Decoder> &dec : stack_) {
 877                 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
 878
 879                 if (!di) {
 880                         error_message_ = tr("Failed to create decoder instance");
 881                         srd_session_destroy(srd_session_);
 882                         return;
 883                 }
 884
 885                 if (prev_di)
 886                         srd_inst_stack(srd_session_, prev_di, di);
 887
 888                 prev_di = di;
 889         }
 890
 891         // Start the session
 892         srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
 893                 g_variant_new_uint64(samplerate_));
 894
 895         srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
 896                 DecodeSignal::annotation_callback, this);
 897
 898         srd_session_start(srd_session_);
 899 }
 900
 901 void DecodeSignal::stop_srd_session()
 902 {
 903         if (srd_session_) {
 904                 // Destroy the session
 905                 srd_session_destroy(srd_session_);
 906                 srd_session_ = nullptr;
 907         }
 908 }
 909
 910 void DecodeSignal::connect_input_notifiers()
 911 {
 912         // Disconnect the notification slot from the previous set of signals
 913         disconnect(this, SLOT(on_data_cleared()));
 914         disconnect(this, SLOT(on_data_received()));
 915
 916         // Connect the currently used signals to our slot
 917         for (data::DecodeChannel &ch : channels_) {
 918                 if (!ch.assigned_signal)
 919                         continue;
 920
 921                 const data::SignalBase *signal = ch.assigned_signal;
 922                 connect(signal, SIGNAL(samples_cleared()),
 923                         this, SLOT(on_data_cleared()));
 924                 connect(signal, SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
 925                         this, SLOT(on_data_received()));
 926         }
 927 }
 928
 929 void DecodeSignal::prepare_annotation_segment()
 930 {
 931         // TODO Won't work for multiple segments
 932         rows_.emplace_back(map<const decode::Row, decode::RowData>());
 933         current_rows_ = &(rows_.back());
 934
 935         // Add annotation classes
 936         for (const shared_ptr<decode::Decoder> &dec : stack_) {
 937                 assert(dec);
 938                 const srd_decoder *const decc = dec->decoder();
 939                 assert(dec->decoder());
 940
 941                 // Add a row for the decoder if it doesn't have a row list
 942                 if (!decc->annotation_rows)
 943                         (*current_rows_)[Row(decc)] = decode::RowData();
 944
 945                 // Add the decoder rows
 946                 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
 947                         const srd_decoder_annotation_row *const ann_row =
 948                                 (srd_decoder_annotation_row *)l->data;
 949                         assert(ann_row);
 950
 951                         const Row row(decc, ann_row);
 952
 953                         // Add a new empty row data object
 954                         (*current_rows_)[row] = decode::RowData();
 955                 }
 956         }
 957 }
 958
 959 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
 960 {
 961         assert(pdata);
 962         assert(decode_signal);
 963
 964         DecodeSignal *const ds = (DecodeSignal*)decode_signal;
 965         assert(ds);
 966
 967         lock_guard<mutex> lock(ds->output_mutex_);
 968
 969         // Find the row
 970         assert(pdata->pdo);
 971         assert(pdata->pdo->di);
 972         const srd_decoder *const decc = pdata->pdo->di->decoder;
 973         assert(decc);
 974         assert(ds->current_rows_);
 975
 976         const srd_proto_data_annotation *const pda =
 977                 (const srd_proto_data_annotation*)pdata->data;
 978         assert(pda);
 979
 980         auto row_iter = ds->current_rows_->end();
 981
 982         // Try looking up the sub-row of this class
 983         const auto format = pda->ann_class;
 984         const auto r = ds->class_rows_.find(make_pair(decc, format));
 985         if (r != ds->class_rows_.end())
 986                 row_iter = ds->current_rows_->find((*r).second);
 987         else {
 988                 // Failing that, use the decoder as a key
 989                 row_iter = ds->current_rows_->find(Row(decc));
 990         }
 991
 992         if (row_iter == ds->current_rows_->end()) {
 993                 qDebug() << "Unexpected annotation: decoder = " << decc <<
 994                         ", format = " << format;
 995                 assert(false);
 996                 return;
 997         }
 998
 999         // Add the annotation
1000         (*row_iter).second.emplace_annotation(pdata);
1001 }
1002
1003 void DecodeSignal::on_capture_state_changed(int state)
1004 {
1005         // If a new acquisition was started, we need to start decoding from scratch
1006         if (state == Session::Running)
1007                 begin_decode();
1008 }
1009
1010 void DecodeSignal::on_data_cleared()
1011 {
1012         reset_decode();
1013 }
1014
1015 void DecodeSignal::on_data_received()
1016 {
1017         if (!logic_mux_thread_.joinable())
1018                 begin_decode();
1019         else
1020                 logic_mux_cond_.notify_one();
1021 }
1022
1023 } // namespace data
1024 } // namespace pv