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 <cstring>
  21 #include <forward_list>
  22 #include <limits>
  23
  24 #include <QDebug>
  25
  26 #include "logic.hpp"
  27 #include "logicsegment.hpp"
  28 #include "decodesignal.hpp"
  29 #include "signaldata.hpp"
  30
  31 #include <pv/data/decode/decoder.hpp>
  32 #include <pv/data/decode/row.hpp>
  33 #include <pv/globalsettings.hpp>
  34 #include <pv/session.hpp>
  35
  36 using std::forward_list;
  37 using std::lock_guard;
  38 using std::make_pair;
  39 using std::make_shared;
  40 using std::min;
  41 using std::out_of_range;
  42 using std::shared_ptr;
  43 using std::unique_lock;
  44 using pv::data::decode::Annotation;
  45 using pv::data::decode::DecodeChannel;
  46 using pv::data::decode::Decoder;
  47 using pv::data::decode::Row;
  48
  49 namespace pv {
  50 namespace data {
  51
  52 const double DecodeSignal::DecodeMargin = 1.0;
  53 const double DecodeSignal::DecodeThreshold = 0.2;
  54 const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
  55
  56
  57 DecodeSignal::DecodeSignal(pv::Session &session) :
  58         SignalBase(nullptr, SignalBase::DecodeChannel),
  59         session_(session),
  60         srd_session_(nullptr),
  61         logic_mux_data_invalid_(false),
  62         stack_config_changed_(true),
  63         current_segment_id_(0)
  64 {
  65         connect(&session_, SIGNAL(capture_state_changed(int)),
  66                 this, SLOT(on_capture_state_changed(int)));
  67 }
  68
  69 DecodeSignal::~DecodeSignal()
  70 {
  71         reset_decode(true);
  72 }
  73
  74 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
  75 {
  76         return stack_;
  77 }
  78
  79 void DecodeSignal::stack_decoder(const srd_decoder *decoder)
  80 {
  81         assert(decoder);
  82
  83         // Set name if this decoder is the first in the list or the name is unchanged
  84         const srd_decoder* prev_dec =
  85                 stack_.empty() ? nullptr : stack_.back()->decoder();
  86         const QString prev_dec_name =
  87                 prev_dec ? QString::fromUtf8(prev_dec->name) : QString();
  88
  89         if ((stack_.empty()) || ((stack_.size() > 0) && (name() == prev_dec_name)))
  90                 set_name(QString::fromUtf8(decoder->name));
  91
  92         const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
  93         stack_.push_back(dec);
  94
  95         // Include the newly created decode channels in the channel lists
  96         update_channel_list();
  97
  98         stack_config_changed_ = true;
  99         auto_assign_signals(dec);
 100         commit_decoder_channels();
 101
 102         decoder_stacked((void*)dec.get());
 103
 104         begin_decode();
 105 }
 106
 107 void DecodeSignal::remove_decoder(int index)
 108 {
 109         assert(index >= 0);
 110         assert(index < (int)stack_.size());
 111
 112         // Find the decoder in the stack
 113         auto iter = stack_.begin();
 114         for (int i = 0; i < index; i++, iter++)
 115                 assert(iter != stack_.end());
 116
 117         decoder_removed(iter->get());
 118
 119         // Delete the element
 120         stack_.erase(iter);
 121
 122         // Update channels and decoded data
 123         stack_config_changed_ = true;
 124         update_channel_list();
 125         begin_decode();
 126 }
 127
 128 bool DecodeSignal::toggle_decoder_visibility(int index)
 129 {
 130         auto iter = stack_.cbegin();
 131         for (int i = 0; i < index; i++, iter++)
 132                 assert(iter != stack_.end());
 133
 134         shared_ptr<Decoder> dec = *iter;
 135
 136         // Toggle decoder visibility
 137         bool state = false;
 138         if (dec) {
 139                 state = !dec->shown();
 140                 dec->show(state);
 141         }
 142
 143         return state;
 144 }
 145
 146 void DecodeSignal::reset_decode(bool shutting_down)
 147 {
 148         if (stack_config_changed_ || shutting_down)
 149                 stop_srd_session();
 150         else
 151                 terminate_srd_session();
 152
 153         if (decode_thread_.joinable()) {
 154                 decode_interrupt_ = true;
 155                 decode_input_cond_.notify_one();
 156                 decode_thread_.join();
 157         }
 158
 159         if (logic_mux_thread_.joinable()) {
 160                 logic_mux_interrupt_ = true;
 161                 logic_mux_cond_.notify_one();
 162                 logic_mux_thread_.join();
 163         }
 164
 165         resume_decode();  // Make sure the decode thread isn't blocked by pausing
 166
 167         class_rows_.clear();
 168         current_segment_id_ = 0;
 169         segments_.clear();
 170
 171         logic_mux_data_.reset();
 172         logic_mux_data_invalid_ = true;
 173
 174         if (!error_message_.isEmpty()) {
 175                 error_message_ = QString();
 176                 // TODO Emulate noquote()
 177                 qDebug().nospace() << name() << ": Error cleared";
 178         }
 179
 180         decode_reset();
 181 }
 182
 183 void DecodeSignal::begin_decode()
 184 {
 185         if (decode_thread_.joinable()) {
 186                 decode_interrupt_ = true;
 187                 decode_input_cond_.notify_one();
 188                 decode_thread_.join();
 189         }
 190
 191         if (logic_mux_thread_.joinable()) {
 192                 logic_mux_interrupt_ = true;
 193                 logic_mux_cond_.notify_one();
 194                 logic_mux_thread_.join();
 195         }
 196
 197         reset_decode();
 198
 199         if (stack_.size() == 0) {
 200                 set_error_message(tr("No decoders"));
 201                 return;
 202         }
 203
 204         assert(channels_.size() > 0);
 205
 206         if (get_assigned_signal_count() == 0) {
 207                 set_error_message(tr("There are no channels assigned to this decoder"));
 208                 return;
 209         }
 210
 211         // Make sure that all assigned channels still provide logic data
 212         // (can happen when a converted signal was assigned but the
 213         // conversion removed in the meanwhile)
 214         for (decode::DecodeChannel& ch : channels_)
 215                 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
 216                         ch.assigned_signal = nullptr;
 217
 218         // Check that all decoders have the required channels
 219         for (const shared_ptr<decode::Decoder>& dec : stack_)
 220                 if (!dec->have_required_channels()) {
 221                         set_error_message(tr("One or more required channels "
 222                                 "have not been specified"));
 223                         return;
 224                 }
 225
 226         // Map out all the annotation classes
 227         int row_index = 0;
 228         for (const shared_ptr<decode::Decoder>& dec : stack_) {
 229                 assert(dec);
 230                 const srd_decoder *const decc = dec->decoder();
 231                 assert(dec->decoder());
 232
 233                 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
 234                         const srd_decoder_annotation_row *const ann_row =
 235                                 (srd_decoder_annotation_row *)l->data;
 236                         assert(ann_row);
 237
 238                         const Row row(row_index++, decc, ann_row);
 239
 240                         for (const GSList *ll = ann_row->ann_classes;
 241                                 ll; ll = ll->next)
 242                                 class_rows_[make_pair(decc,
 243                                         GPOINTER_TO_INT(ll->data))] = row;
 244                 }
 245         }
 246
 247         // Free the logic data and its segment(s) if it needs to be updated
 248         if (logic_mux_data_invalid_)
 249                 logic_mux_data_.reset();
 250
 251         if (!logic_mux_data_) {
 252                 const uint32_t ch_count = get_assigned_signal_count();
 253                 logic_mux_unit_size_ = (ch_count + 7) / 8;
 254                 logic_mux_data_ = make_shared<Logic>(ch_count);
 255         }
 256
 257         // Receive notifications when new sample data is available
 258         connect_input_notifiers();
 259
 260         if (get_input_segment_count() == 0) {
 261                 set_error_message(tr("No input data"));
 262                 return;
 263         }
 264
 265         // Make sure the logic output data is complete and up-to-date
 266         logic_mux_interrupt_ = false;
 267         logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
 268
 269         // Decode the muxed logic data
 270         decode_interrupt_ = false;
 271         decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
 272 }
 273
 274 void DecodeSignal::pause_decode()
 275 {
 276         decode_paused_ = true;
 277 }
 278
 279 void DecodeSignal::resume_decode()
 280 {
 281         // Manual unlocking is done before notifying, to avoid waking up the
 282         // waiting thread only to block again (see notify_one for details)
 283         decode_pause_mutex_.unlock();
 284         decode_pause_cond_.notify_one();
 285         decode_paused_ = false;
 286 }
 287
 288 bool DecodeSignal::is_paused() const
 289 {
 290         return decode_paused_;
 291 }
 292
 293 QString DecodeSignal::error_message() const
 294 {
 295         lock_guard<mutex> lock(output_mutex_);
 296         return error_message_;
 297 }
 298
 299 const vector<decode::DecodeChannel> DecodeSignal::get_channels() const
 300 {
 301         return channels_;
 302 }
 303
 304 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
 305 {
 306         bool new_assignment = false;
 307
 308         // Try to auto-select channels that don't have signals assigned yet
 309         for (decode::DecodeChannel& ch : channels_) {
 310                 // If a decoder is given, auto-assign only its channels
 311                 if (dec && (ch.decoder_ != dec))
 312                         continue;
 313
 314                 if (ch.assigned_signal)
 315                         continue;
 316
 317                 QString ch_name = ch.name.toLower();
 318                 ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
 319
 320                 shared_ptr<data::SignalBase> match;
 321                 for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
 322                         if (!s->enabled())
 323                                 continue;
 324
 325                         QString s_name = s->name().toLower();
 326                         s_name = s_name.replace(QRegExp("[-_.]"), " ");
 327
 328                         if (s->logic_data() &&
 329                                 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
 330                                 if (!match)
 331                                         match = s;
 332                                 else {
 333                                         // Only replace an existing match if it matches more characters
 334                                         int old_unmatched = ch_name.length() - match->name().length();
 335                                         int new_unmatched = ch_name.length() - s->name().length();
 336                                         if (abs(new_unmatched) < abs(old_unmatched))
 337                                                 match = s;
 338                                 }
 339                         }
 340                 }
 341
 342                 if (match) {
 343                         ch.assigned_signal = match.get();
 344                         new_assignment = true;
 345                 }
 346         }
 347
 348         if (new_assignment) {
 349                 logic_mux_data_invalid_ = true;
 350                 stack_config_changed_ = true;
 351                 commit_decoder_channels();
 352                 channels_updated();
 353         }
 354 }
 355
 356 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
 357 {
 358         for (decode::DecodeChannel& ch : channels_)
 359                 if (ch.id == channel_id) {
 360                         ch.assigned_signal = signal;
 361                         logic_mux_data_invalid_ = true;
 362                 }
 363
 364         stack_config_changed_ = true;
 365         commit_decoder_channels();
 366         channels_updated();
 367         begin_decode();
 368 }
 369
 370 int DecodeSignal::get_assigned_signal_count() const
 371 {
 372         // Count all channels that have a signal assigned to them
 373         return count_if(channels_.begin(), channels_.end(),
 374                 [](decode::DecodeChannel ch) { return ch.assigned_signal; });
 375 }
 376
 377 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
 378 {
 379         for (decode::DecodeChannel& ch : channels_)
 380                 if (ch.id == channel_id)
 381                         ch.initial_pin_state = init_state;
 382
 383         stack_config_changed_ = true;
 384         channels_updated();
 385         begin_decode();
 386 }
 387
 388 double DecodeSignal::samplerate() const
 389 {
 390         double result = 0;
 391
 392         // TODO For now, we simply return the first samplerate that we have
 393         if (segments_.size() > 0)
 394                 result = segments_.front().samplerate;
 395
 396         return result;
 397 }
 398
 399 const pv::util::Timestamp DecodeSignal::start_time() const
 400 {
 401         pv::util::Timestamp result;
 402
 403         // TODO For now, we simply return the first start time that we have
 404         if (segments_.size() > 0)
 405                 result = segments_.front().start_time;
 406
 407         return result;
 408 }
 409
 410 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
 411 {
 412         // The working sample count is the highest sample number for
 413         // which all used signals have data available, so go through all
 414         // channels and use the lowest overall sample count of the segment
 415
 416         int64_t count = std::numeric_limits<int64_t>::max();
 417         bool no_signals_assigned = true;
 418
 419         for (const decode::DecodeChannel& ch : channels_)
 420                 if (ch.assigned_signal) {
 421                         no_signals_assigned = false;
 422
 423                         const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
 424                         if (!logic_data || logic_data->logic_segments().empty())
 425                                 return 0;
 426
 427                         try {
 428                                 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
 429                                 count = min(count, (int64_t)segment->get_sample_count());
 430                         } catch (out_of_range&) {
 431                                 return 0;
 432                         }
 433                 }
 434
 435         return (no_signals_assigned ? 0 : count);
 436 }
 437
 438 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
 439         bool include_processing) const
 440 {
 441         lock_guard<mutex> decode_lock(output_mutex_);
 442
 443         int64_t result = 0;
 444
 445         try {
 446                 const DecodeSegment *segment = &(segments_.at(segment_id));
 447                 if (include_processing)
 448                         result = segment->samples_decoded_incl;
 449                 else
 450                         result = segment->samples_decoded_excl;
 451         } catch (out_of_range&) {
 452                 // Do nothing
 453         }
 454
 455         return result;
 456 }
 457
 458 vector<Row> DecodeSignal::get_rows(bool visible_only) const
 459 {
 460         lock_guard<mutex> lock(output_mutex_);
 461
 462         vector<Row> rows;
 463
 464         for (const shared_ptr<decode::Decoder>& dec : stack_) {
 465                 assert(dec);
 466                 if (visible_only && !dec->shown())
 467                         continue;
 468
 469                 const srd_decoder *const decc = dec->decoder();
 470                 assert(dec->decoder());
 471
 472                 int row_index = 0;
 473                 // Add a row for the decoder if it doesn't have a row list
 474                 if (!decc->annotation_rows)
 475                         rows.emplace_back(row_index++, decc);
 476
 477                 // Add the decoder rows
 478                 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
 479                         const srd_decoder_annotation_row *const ann_row =
 480                                 (srd_decoder_annotation_row *)l->data;
 481                         assert(ann_row);
 482                         rows.emplace_back(row_index++, decc, ann_row);
 483                 }
 484         }
 485
 486         return rows;
 487 }
 488
 489 void DecodeSignal::get_annotation_subset(
 490         vector<pv::data::decode::Annotation> &dest,
 491         const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
 492         uint64_t end_sample) const
 493 {
 494         lock_guard<mutex> lock(output_mutex_);
 495
 496         try {
 497                 const DecodeSegment *segment = &(segments_.at(segment_id));
 498                 const map<const decode::Row, decode::RowData> *rows =
 499                         &(segment->annotation_rows);
 500
 501                 const auto iter = rows->find(row);
 502                 if (iter != rows->end())
 503                         (*iter).second.get_annotation_subset(dest,
 504                                 start_sample, end_sample);
 505         } catch (out_of_range&) {
 506                 // Do nothing
 507         }
 508 }
 509
 510 void DecodeSignal::get_annotation_subset(
 511         vector<pv::data::decode::Annotation> &dest,
 512         uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
 513 {
 514         // Note: We put all vectors and lists on the heap, not the stack
 515
 516         const vector<Row> rows = get_rows(true);
 517
 518         // Use forward_lists for faster merging
 519         forward_list<Annotation> *all_ann_list = new forward_list<Annotation>();
 520
 521         for (const Row& row : rows) {
 522                 vector<Annotation> *ann_vector = new vector<Annotation>();
 523                 get_annotation_subset(*ann_vector, row, segment_id, start_sample, end_sample);
 524
 525                 forward_list<Annotation> *ann_list =
 526                         new forward_list<Annotation>(ann_vector->begin(), ann_vector->end());
 527                 delete ann_vector;
 528
 529                 all_ann_list->merge(*ann_list);
 530                 delete ann_list;
 531         }
 532
 533         move(all_ann_list->begin(), all_ann_list->end(), back_inserter(dest));
 534         delete all_ann_list;
 535 }
 536
 537 uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id,
 538         const Decoder* dec, uint32_t bin_class_id) const
 539 {
 540         try {
 541                 const DecodeSegment *segment = &(segments_.at(segment_id));
 542
 543                 for (const DecodeBinaryClass& bc : segment->binary_classes)
 544                         if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
 545                                 return bc.chunks.size();
 546         } catch (out_of_range&) {
 547                 // Do nothing
 548         }
 549
 550         return 0;
 551 }
 552
 553 void DecodeSignal::get_binary_data_chunk(uint32_t segment_id,
 554         const  Decoder* dec, uint32_t bin_class_id, uint32_t chunk_id,
 555         const vector<uint8_t> **dest, uint64_t *size)
 556 {
 557         try {
 558                 const DecodeSegment *segment = &(segments_.at(segment_id));
 559
 560                 for (const DecodeBinaryClass& bc : segment->binary_classes)
 561                         if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) {
 562                                 if (dest) *dest = &(bc.chunks.at(chunk_id).data);
 563                                 if (size) *size = bc.chunks.at(chunk_id).data.size();
 564                                 return;
 565                         }
 566         } catch (out_of_range&) {
 567                 // Do nothing
 568         }
 569 }
 570
 571 void DecodeSignal::get_binary_data_chunks_merged(uint32_t segment_id,
 572         const Decoder* dec, uint32_t bin_class_id, uint64_t start_sample,
 573         uint64_t end_sample, vector<uint8_t> *dest) const
 574 {
 575         assert(dest != nullptr);
 576
 577         try {
 578                 const DecodeSegment *segment = &(segments_.at(segment_id));
 579
 580                 const DecodeBinaryClass* bin_class = nullptr;
 581                 for (const DecodeBinaryClass& bc : segment->binary_classes)
 582                         if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
 583                                 bin_class = &bc;
 584
 585                 // Determine overall size before copying to resize dest vector only once
 586                 uint64_t size = 0;
 587                 uint64_t matches = 0;
 588                 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
 589                         if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
 590                                 size += chunk.data.size();
 591                                 matches++;
 592                         }
 593                 dest->resize(size);
 594
 595                 uint64_t offset = 0;
 596                 uint64_t matches2 = 0;
 597                 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
 598                         if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
 599                                 memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size());
 600                                 offset += chunk.data.size();
 601                                 matches2++;
 602
 603                                 // Make sure we don't overwrite memory if the array grew in the meanwhile
 604                                 if (matches2 == matches)
 605                                         break;
 606                         }
 607         } catch (out_of_range&) {
 608                 // Do nothing
 609         }
 610 }
 611
 612 const DecodeBinaryClass* DecodeSignal::get_binary_data_class(uint32_t segment_id,
 613         const data::decode::Decoder* dec, uint32_t bin_class_id) const
 614 {
 615         try {
 616                 const DecodeSegment *segment = &(segments_.at(segment_id));
 617
 618                 for (const DecodeBinaryClass& bc : segment->binary_classes)
 619                         if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
 620                                 return &bc;
 621         } catch (out_of_range&) {
 622                 // Do nothing
 623         }
 624
 625         return nullptr;
 626 }
 627
 628 void DecodeSignal::save_settings(QSettings &settings) const
 629 {
 630         SignalBase::save_settings(settings);
 631
 632         settings.setValue("decoders", (int)(stack_.size()));
 633
 634         // Save decoder stack
 635         int decoder_idx = 0;
 636         for (const shared_ptr<decode::Decoder>& decoder : stack_) {
 637                 settings.beginGroup("decoder" + QString::number(decoder_idx++));
 638
 639                 settings.setValue("id", decoder->decoder()->id);
 640                 settings.setValue("shown", decoder->shown());
 641
 642                 // Save decoder options
 643                 const map<string, GVariant*>& options = decoder->options();
 644
 645                 settings.setValue("options", (int)options.size());
 646
 647                 // Note: decode::Decoder::options() returns only the options
 648                 // that differ from the default. See binding::Decoder::getter()
 649                 int i = 0;
 650                 for (auto& option : options) {
 651                         settings.beginGroup("option" + QString::number(i));
 652                         settings.setValue("name", QString::fromStdString(option.first));
 653                         GlobalSettings::store_gvariant(settings, option.second);
 654                         settings.endGroup();
 655                         i++;
 656                 }
 657
 658                 settings.endGroup();
 659         }
 660
 661         // Save channel mapping
 662         settings.setValue("channels", (int)channels_.size());
 663
 664         for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
 665                 auto channel = find_if(channels_.begin(), channels_.end(),
 666                         [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
 667
 668                 if (channel == channels_.end()) {
 669                         qDebug() << "ERROR: Gap in channel index:" << channel_id;
 670                         continue;
 671                 }
 672
 673                 settings.beginGroup("channel" + QString::number(channel_id));
 674
 675                 settings.setValue("name", channel->name);  // Useful for debugging
 676                 settings.setValue("initial_pin_state", channel->initial_pin_state);
 677
 678                 if (channel->assigned_signal)
 679                         settings.setValue("assigned_signal_name", channel->assigned_signal->name());
 680
 681                 settings.endGroup();
 682         }
 683 }
 684
 685 void DecodeSignal::restore_settings(QSettings &settings)
 686 {
 687         SignalBase::restore_settings(settings);
 688
 689         // Restore decoder stack
 690         GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
 691
 692         int decoders = settings.value("decoders").toInt();
 693
 694         for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
 695                 settings.beginGroup("decoder" + QString::number(decoder_idx));
 696
 697                 QString id = settings.value("id").toString();
 698
 699                 for (GSList *entry = dec_list; entry; entry = entry->next) {
 700                         const srd_decoder *dec = (srd_decoder*)entry->data;
 701                         if (!dec)
 702                                 continue;
 703
 704                         if (QString::fromUtf8(dec->id) == id) {
 705                                 shared_ptr<decode::Decoder> decoder =
 706                                         make_shared<decode::Decoder>(dec);
 707
 708                                 stack_.push_back(decoder);
 709                                 decoder->show(settings.value("shown", true).toBool());
 710
 711                                 // Restore decoder options that differ from their default
 712                                 int options = settings.value("options").toInt();
 713
 714                                 for (int i = 0; i < options; i++) {
 715                                         settings.beginGroup("option" + QString::number(i));
 716                                         QString name = settings.value("name").toString();
 717                                         GVariant *value = GlobalSettings::restore_gvariant(settings);
 718                                         decoder->set_option(name.toUtf8(), value);
 719                                         settings.endGroup();
 720                                 }
 721
 722                                 // Include the newly created decode channels in the channel lists
 723                                 update_channel_list();
 724                                 break;
 725                         }
 726                 }
 727
 728                 settings.endGroup();
 729                 channels_updated();
 730         }
 731
 732         // Restore channel mapping
 733         unsigned int channels = settings.value("channels").toInt();
 734
 735         const unordered_set< shared_ptr<data::SignalBase> > signalbases =
 736                 session_.signalbases();
 737
 738         for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
 739                 auto channel = find_if(channels_.begin(), channels_.end(),
 740                         [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
 741
 742                 if (channel == channels_.end()) {
 743                         qDebug() << "ERROR: Non-existant channel index:" << channel_id;
 744                         continue;
 745                 }
 746
 747                 settings.beginGroup("channel" + QString::number(channel_id));
 748
 749                 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
 750
 751                 for (const shared_ptr<data::SignalBase>& signal : signalbases)
 752                         if (signal->name() == assigned_signal_name)
 753                                 channel->assigned_signal = signal.get();
 754
 755                 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
 756
 757                 settings.endGroup();
 758         }
 759
 760         // Update the internal structures
 761         stack_config_changed_ = true;
 762         update_channel_list();
 763         commit_decoder_channels();
 764
 765         begin_decode();
 766 }
 767
 768 void DecodeSignal::set_error_message(QString msg)
 769 {
 770         error_message_ = msg;
 771         // TODO Emulate noquote()
 772         qDebug().nospace() << name() << ": " << msg;
 773 }
 774
 775 uint32_t DecodeSignal::get_input_segment_count() const
 776 {
 777         uint64_t count = std::numeric_limits<uint64_t>::max();
 778         bool no_signals_assigned = true;
 779
 780         for (const decode::DecodeChannel& ch : channels_)
 781                 if (ch.assigned_signal) {
 782                         no_signals_assigned = false;
 783
 784                         const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
 785                         if (!logic_data || logic_data->logic_segments().empty())
 786                                 return 0;
 787
 788                         // Find the min value of all segment counts
 789                         if ((uint64_t)(logic_data->logic_segments().size()) < count)
 790                                 count = logic_data->logic_segments().size();
 791                 }
 792
 793         return (no_signals_assigned ? 0 : count);
 794 }
 795
 796 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
 797 {
 798         double samplerate = 0;
 799
 800         for (const decode::DecodeChannel& ch : channels_)
 801                 if (ch.assigned_signal) {
 802                         const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
 803                         if (!logic_data || logic_data->logic_segments().empty())
 804                                 continue;
 805
 806                         try {
 807                                 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
 808                                 samplerate = segment->samplerate();
 809                         } catch (out_of_range&) {
 810                                 // Do nothing
 811                         }
 812                         break;
 813                 }
 814
 815         return samplerate;
 816 }
 817
 818 void DecodeSignal::update_channel_list()
 819 {
 820         vector<decode::DecodeChannel> prev_channels = channels_;
 821         channels_.clear();
 822
 823         uint16_t id = 0;
 824
 825         // Copy existing entries, create new as needed
 826         for (shared_ptr<Decoder>& decoder : stack_) {
 827                 const srd_decoder* srd_d = decoder->decoder();
 828                 const GSList *l;
 829
 830                 // Mandatory channels
 831                 for (l = srd_d->channels; l; l = l->next) {
 832                         const struct srd_channel *const pdch = (struct srd_channel *)l->data;
 833                         bool ch_added = false;
 834
 835                         // Copy but update ID if this channel was in the list before
 836                         for (decode::DecodeChannel& ch : prev_channels)
 837                                 if (ch.pdch_ == pdch) {
 838                                         ch.id = id++;
 839                                         channels_.push_back(ch);
 840                                         ch_added = true;
 841                                         break;
 842                                 }
 843
 844                         if (!ch_added) {
 845                                 // Create new entry without a mapped signal
 846                                 decode::DecodeChannel ch = {id++, 0, false, nullptr,
 847                                         QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
 848                                         SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
 849                                 channels_.push_back(ch);
 850                         }
 851                 }
 852
 853                 // Optional channels
 854                 for (l = srd_d->opt_channels; l; l = l->next) {
 855                         const struct srd_channel *const pdch = (struct srd_channel *)l->data;
 856                         bool ch_added = false;
 857
 858                         // Copy but update ID if this channel was in the list before
 859                         for (decode::DecodeChannel& ch : prev_channels)
 860                                 if (ch.pdch_ == pdch) {
 861                                         ch.id = id++;
 862                                         channels_.push_back(ch);
 863                                         ch_added = true;
 864                                         break;
 865                                 }
 866
 867                         if (!ch_added) {
 868                                 // Create new entry without a mapped signal
 869                                 decode::DecodeChannel ch = {id++, 0, true, nullptr,
 870                                         QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
 871                                         SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
 872                                 channels_.push_back(ch);
 873                         }
 874                 }
 875         }
 876
 877         // Invalidate the logic output data if the channel assignment changed
 878         if (prev_channels.size() != channels_.size()) {
 879                 // The number of channels changed, there's definitely a difference
 880                 logic_mux_data_invalid_ = true;
 881         } else {
 882                 // Same number but assignment may still differ, so compare all channels
 883                 for (size_t i = 0; i < channels_.size(); i++) {
 884                         const decode::DecodeChannel& p_ch = prev_channels[i];
 885                         const decode::DecodeChannel& ch = channels_[i];
 886
 887                         if ((p_ch.pdch_ != ch.pdch_) ||
 888                                 (p_ch.assigned_signal != ch.assigned_signal)) {
 889                                 logic_mux_data_invalid_ = true;
 890                                 break;
 891                         }
 892                 }
 893
 894         }
 895
 896         channels_updated();
 897 }
 898
 899 void DecodeSignal::commit_decoder_channels()
 900 {
 901         // Submit channel list to every decoder, containing only the relevant channels
 902         for (shared_ptr<decode::Decoder> dec : stack_) {
 903                 vector<decode::DecodeChannel*> channel_list;
 904
 905                 for (decode::DecodeChannel& ch : channels_)
 906                         if (ch.decoder_ == dec)
 907                                 channel_list.push_back(&ch);
 908
 909                 dec->set_channels(channel_list);
 910         }
 911
 912         // Channel bit IDs must be in sync with the channel's apperance in channels_
 913         int id = 0;
 914         for (decode::DecodeChannel& ch : channels_)
 915                 if (ch.assigned_signal)
 916                         ch.bit_id = id++;
 917 }
 918
 919 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
 920 {
 921         // Enforce end to be greater than start
 922         if (end <= start)
 923                 return;
 924
 925         // Fetch the channel segments and their data
 926         vector<shared_ptr<LogicSegment> > segments;
 927         vector<const uint8_t*> signal_data;
 928         vector<uint8_t> signal_in_bytepos;
 929         vector<uint8_t> signal_in_bitpos;
 930
 931         for (decode::DecodeChannel& ch : channels_)
 932                 if (ch.assigned_signal) {
 933                         const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
 934
 935                         shared_ptr<LogicSegment> segment;
 936                         try {
 937                                 segment = logic_data->logic_segments().at(segment_id);
 938                         } catch (out_of_range&) {
 939                                 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
 940                                         << "has no logic segment" << segment_id;
 941                                 return;
 942                         }
 943                         segments.push_back(segment);
 944
 945                         uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
 946                         segment->get_samples(start, end, data);
 947                         signal_data.push_back(data);
 948
 949                         const int bitpos = ch.assigned_signal->logic_bit_index();
 950                         signal_in_bytepos.push_back(bitpos / 8);
 951                         signal_in_bitpos.push_back(bitpos % 8);
 952                 }
 953
 954
 955         shared_ptr<LogicSegment> output_segment;
 956         try {
 957                 output_segment = logic_mux_data_->logic_segments().at(segment_id);
 958         } catch (out_of_range&) {
 959                 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
 960                         << segment_id << "in mux_logic_samples(), mux segments size is" \
 961                         << logic_mux_data_->logic_segments().size();
 962                 return;
 963         }
 964
 965         // Perform the muxing of signal data into the output data
 966         uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
 967         unsigned int signal_count = signal_data.size();
 968
 969         for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
 970                 sample_cnt++) {
 971
 972                 int bitpos = 0;
 973                 uint8_t bytepos = 0;
 974
 975                 const int out_sample_pos = sample_cnt * output_segment->unit_size();
 976                 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
 977                         output[out_sample_pos + i] = 0;
 978
 979                 for (unsigned int i = 0; i < signal_count; i++) {
 980                         const int in_sample_pos = sample_cnt * segments[i]->unit_size();
 981                         const uint8_t in_sample = 1 &
 982                                 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
 983
 984                         const uint8_t out_sample = output[out_sample_pos + bytepos];
 985
 986                         output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
 987
 988                         bitpos++;
 989                         if (bitpos > 7) {
 990                                 bitpos = 0;
 991                                 bytepos++;
 992                         }
 993                 }
 994         }
 995
 996         output_segment->append_payload(output, (end - start) * output_segment->unit_size());
 997         delete[] output;
 998
 999         for (const uint8_t* data : signal_data)
1000                 delete[] data;
1001 }
1002
1003 void DecodeSignal::logic_mux_proc()
1004 {
1005         uint32_t segment_id = 0;
1006
1007         assert(logic_mux_data_);
1008
1009         // Create initial logic mux segment
1010         shared_ptr<LogicSegment> output_segment =
1011                 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1012                         logic_mux_unit_size_, 0);
1013         logic_mux_data_->push_segment(output_segment);
1014
1015         output_segment->set_samplerate(get_input_samplerate(0));
1016
1017         do {
1018                 const uint64_t input_sample_count = get_working_sample_count(segment_id);
1019                 const uint64_t output_sample_count = output_segment->get_sample_count();
1020
1021                 const uint64_t samples_to_process =
1022                         (input_sample_count > output_sample_count) ?
1023                         (input_sample_count - output_sample_count) : 0;
1024
1025                 // Process the samples if necessary...
1026                 if (samples_to_process > 0) {
1027                         const uint64_t unit_size = output_segment->unit_size();
1028                         const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
1029
1030                         uint64_t processed_samples = 0;
1031                         do {
1032                                 const uint64_t start_sample = output_sample_count + processed_samples;
1033                                 const uint64_t sample_count =
1034                                         min(samples_to_process - processed_samples,     chunk_sample_count);
1035
1036                                 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
1037                                 processed_samples += sample_count;
1038
1039                                 // ...and process the newly muxed logic data
1040                                 decode_input_cond_.notify_one();
1041                         } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
1042                 }
1043
1044                 if (samples_to_process == 0) {
1045                         // TODO Optimize this by caching the input segment count and only
1046                         // querying it when the cached value was reached
1047                         if (segment_id < get_input_segment_count() - 1) {
1048                                 // Process next segment
1049                                 segment_id++;
1050
1051                                 output_segment =
1052                                         make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1053                                                 logic_mux_unit_size_, 0);
1054                                 logic_mux_data_->push_segment(output_segment);
1055
1056                                 output_segment->set_samplerate(get_input_samplerate(segment_id));
1057
1058                         } else {
1059                                 // All segments have been processed
1060                                 logic_mux_data_invalid_ = false;
1061
1062                                 // Wait for more input
1063                                 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1064                                 logic_mux_cond_.wait(logic_mux_lock);
1065                         }
1066                 }
1067
1068         } while (!logic_mux_interrupt_);
1069 }
1070
1071 void DecodeSignal::decode_data(
1072         const int64_t abs_start_samplenum, const int64_t sample_count,
1073         const shared_ptr<LogicSegment> input_segment)
1074 {
1075         const int64_t unit_size = input_segment->unit_size();
1076         const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
1077
1078         for (int64_t i = abs_start_samplenum;
1079                 error_message_.isEmpty() && !decode_interrupt_ &&
1080                         (i < (abs_start_samplenum + sample_count));
1081                 i += chunk_sample_count) {
1082
1083                 const int64_t chunk_end = min(i + chunk_sample_count,
1084                         abs_start_samplenum + sample_count);
1085
1086                 {
1087                         lock_guard<mutex> lock(output_mutex_);
1088                         // Update the sample count showing the samples including currently processed ones
1089                         segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
1090                 }
1091
1092                 int64_t data_size = (chunk_end - i) * unit_size;
1093                 uint8_t* chunk = new uint8_t[data_size];
1094                 input_segment->get_samples(i, chunk_end, chunk);
1095
1096                 if (srd_session_send(srd_session_, i, chunk_end, chunk,
1097                                 data_size, unit_size) != SRD_OK)
1098                         set_error_message(tr("Decoder reported an error"));
1099
1100                 delete[] chunk;
1101
1102                 {
1103                         lock_guard<mutex> lock(output_mutex_);
1104                         // Now that all samples are processed, the exclusive sample count catches up
1105                         segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1106                 }
1107
1108                 // Notify the frontend that we processed some data and
1109                 // possibly have new annotations as well
1110                 new_annotations();
1111
1112                 if (decode_paused_) {
1113                         unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1114                         decode_pause_cond_.wait(pause_wait_lock);
1115                 }
1116         }
1117 }
1118
1119 void DecodeSignal::decode_proc()
1120 {
1121         current_segment_id_ = 0;
1122
1123         // If there is no input data available yet, wait until it is or we're interrupted
1124         if (logic_mux_data_->logic_segments().size() == 0) {
1125                 unique_lock<mutex> input_wait_lock(input_mutex_);
1126                 decode_input_cond_.wait(input_wait_lock);
1127         }
1128
1129         if (decode_interrupt_)
1130                 return;
1131
1132         shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
1133         assert(input_segment);
1134
1135         // Create the initial segment and set its sample rate so that we can pass it to SRD
1136         create_decode_segment();
1137         segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1138         segments_.at(current_segment_id_).start_time = input_segment->start_time();
1139
1140         start_srd_session();
1141
1142         uint64_t sample_count = 0;
1143         uint64_t abs_start_samplenum = 0;
1144         do {
1145                 // Keep processing new samples until we exhaust the input data
1146                 do {
1147                         lock_guard<mutex> input_lock(input_mutex_);
1148                         sample_count = input_segment->get_sample_count() - abs_start_samplenum;
1149
1150                         if (sample_count > 0) {
1151                                 decode_data(abs_start_samplenum, sample_count, input_segment);
1152                                 abs_start_samplenum += sample_count;
1153                         }
1154                 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
1155
1156                 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
1157                         if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
1158                                 // Process next segment
1159                                 current_segment_id_++;
1160
1161                                 try {
1162                                         input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1163                                 } catch (out_of_range&) {
1164                                         qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1165                                                 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1166                                                 << logic_mux_data_->logic_segments().size();
1167                                         return;
1168                                 }
1169                                 abs_start_samplenum = 0;
1170
1171                                 // Create the next segment and set its metadata
1172                                 create_decode_segment();
1173                                 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1174                                 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1175
1176                                 // Reset decoder state but keep the decoder stack intact
1177                                 terminate_srd_session();
1178                         } else {
1179                                 // All segments have been processed
1180                                 decode_finished();
1181
1182                                 // Wait for new input data or an interrupt was requested
1183                                 unique_lock<mutex> input_wait_lock(input_mutex_);
1184                                 decode_input_cond_.wait(input_wait_lock);
1185                         }
1186                 }
1187         } while (error_message_.isEmpty() && !decode_interrupt_);
1188
1189         // Potentially reap decoders when the application no longer is
1190         // interested in their (pending) results.
1191         if (decode_interrupt_)
1192                 terminate_srd_session();
1193 }
1194
1195 void DecodeSignal::start_srd_session()
1196 {
1197         // If there were stack changes, the session has been destroyed by now, so if
1198         // it hasn't been destroyed, we can just reset and re-use it
1199         if (srd_session_) {
1200                 // When a decoder stack was created before, re-use it
1201                 // for the next stream of input data, after terminating
1202                 // potentially still executing operations, and resetting
1203                 // internal state. Skip the rather expensive (teardown
1204                 // and) construction of another decoder stack.
1205
1206                 // TODO Reduce redundancy, use a common code path for
1207                 // the meta/start sequence?
1208                 terminate_srd_session();
1209
1210                 // Metadata is cleared also, so re-set it
1211                 uint64_t samplerate = 0;
1212                 if (segments_.size() > 0)
1213                         samplerate = segments_.at(current_segment_id_).samplerate;
1214                 if (samplerate)
1215                         srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1216                                 g_variant_new_uint64(samplerate));
1217                 for (const shared_ptr<decode::Decoder>& dec : stack_)
1218                         dec->apply_all_options();
1219                 srd_session_start(srd_session_);
1220
1221                 return;
1222         }
1223
1224         // Create the session
1225         srd_session_new(&srd_session_);
1226         assert(srd_session_);
1227
1228         // Create the decoders
1229         srd_decoder_inst *prev_di = nullptr;
1230         for (const shared_ptr<decode::Decoder>& dec : stack_) {
1231                 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1232
1233                 if (!di) {
1234                         set_error_message(tr("Failed to create decoder instance"));
1235                         srd_session_destroy(srd_session_);
1236                         srd_session_ = nullptr;
1237                         return;
1238                 }
1239
1240                 if (prev_di)
1241                         srd_inst_stack(srd_session_, prev_di, di);
1242
1243                 prev_di = di;
1244         }
1245
1246         // Start the session
1247         if (segments_.size() > 0)
1248                 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1249                         g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1250
1251         srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1252                 DecodeSignal::annotation_callback, this);
1253
1254         srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
1255                 DecodeSignal::binary_callback, this);
1256
1257         srd_session_start(srd_session_);
1258
1259         // We just recreated the srd session, so all stack changes are applied now
1260         stack_config_changed_ = false;
1261 }
1262
1263 void DecodeSignal::terminate_srd_session()
1264 {
1265         // Call the "terminate and reset" routine for the decoder stack
1266         // (if available). This does not harm those stacks which already
1267         // have completed their operation, and reduces response time for
1268         // those stacks which still are processing data while the
1269         // application no longer wants them to.
1270         if (srd_session_) {
1271                 srd_session_terminate_reset(srd_session_);
1272
1273                 // Metadata is cleared also, so re-set it
1274                 uint64_t samplerate = 0;
1275                 if (segments_.size() > 0)
1276                         samplerate = segments_.at(current_segment_id_).samplerate;
1277                 if (samplerate)
1278                         srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1279                                 g_variant_new_uint64(samplerate));
1280                 for (const shared_ptr<decode::Decoder>& dec : stack_)
1281                         dec->apply_all_options();
1282         }
1283 }
1284
1285 void DecodeSignal::stop_srd_session()
1286 {
1287         if (srd_session_) {
1288                 // Destroy the session
1289                 srd_session_destroy(srd_session_);
1290                 srd_session_ = nullptr;
1291
1292                 // Mark the decoder instances as non-existant since they were deleted
1293                 for (const shared_ptr<decode::Decoder>& dec : stack_)
1294                         dec->invalidate_decoder_inst();
1295         }
1296 }
1297
1298 void DecodeSignal::connect_input_notifiers()
1299 {
1300         // Disconnect the notification slot from the previous set of signals
1301         disconnect(this, SLOT(on_data_cleared()));
1302         disconnect(this, SLOT(on_data_received()));
1303
1304         // Connect the currently used signals to our slot
1305         for (decode::DecodeChannel& ch : channels_) {
1306                 if (!ch.assigned_signal)
1307                         continue;
1308
1309                 const data::SignalBase *signal = ch.assigned_signal;
1310                 connect(signal, SIGNAL(samples_cleared()),
1311                         this, SLOT(on_data_cleared()));
1312                 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1313                         this, SLOT(on_data_received()));
1314         }
1315 }
1316
1317 void DecodeSignal::create_decode_segment()
1318 {
1319         // Create annotation segment
1320         segments_.emplace_back(DecodeSegment());
1321
1322         // Add annotation classes
1323         for (const shared_ptr<decode::Decoder>& dec : stack_) {
1324                 assert(dec);
1325                 const srd_decoder *const decc = dec->decoder();
1326                 assert(dec->decoder());
1327
1328                 int row_index = 0;
1329                 // Add a row for the decoder if it doesn't have a row list
1330                 if (!decc->annotation_rows)
1331                         (segments_.back().annotation_rows)[Row(row_index++, decc)] =
1332                                 decode::RowData();
1333
1334                 // Add the decoder rows
1335                 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
1336                         const srd_decoder_annotation_row *const ann_row =
1337                                 (srd_decoder_annotation_row *)l->data;
1338                         assert(ann_row);
1339
1340                         const Row row(row_index++, decc, ann_row);
1341
1342                         // Add a new empty row data object
1343                         (segments_.back().annotation_rows)[row] =
1344                                 decode::RowData();
1345                 }
1346         }
1347
1348         // Prepare our binary output classes
1349         for (const shared_ptr<decode::Decoder>& dec : stack_) {
1350                 uint32_t n = dec->get_binary_class_count();
1351
1352                 for (uint32_t i = 0; i < n; i++)
1353                         segments_.back().binary_classes.push_back(
1354                                 {dec.get(), dec->get_binary_class(i), vector<DecodeBinaryDataChunk>()});
1355         }
1356 }
1357
1358 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1359 {
1360         assert(pdata);
1361         assert(decode_signal);
1362
1363         DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1364         assert(ds);
1365
1366         if (ds->decode_interrupt_)
1367                 return;
1368
1369         lock_guard<mutex> lock(ds->output_mutex_);
1370
1371         // Get the decoder and the annotation data
1372         assert(pdata->pdo);
1373         assert(pdata->pdo->di);
1374         const srd_decoder *const decc = pdata->pdo->di->decoder;
1375         assert(decc);
1376
1377         const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data;
1378         assert(pda);
1379
1380         // Find the row
1381         auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end();
1382
1383         // Try finding a better row match than the default by looking up the sub-row of this class
1384         const auto format = pda->ann_class;
1385         const auto r = ds->class_rows_.find(make_pair(decc, format));
1386         if (r != ds->class_rows_.end())
1387                 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second);
1388         else {
1389                 // Failing that, use the decoder as a key
1390                 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(0, decc));
1391         }
1392
1393         if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) {
1394                 qDebug() << "Unexpected annotation: decoder = " << decc <<
1395                         ", format = " << format;
1396                 assert(false);
1397                 return;
1398         }
1399
1400         // Add the annotation
1401         (*row_iter).second.emplace_annotation(pdata, &((*row_iter).first));
1402 }
1403
1404 void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
1405 {
1406         assert(pdata);
1407         assert(decode_signal);
1408
1409         DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1410         assert(ds);
1411
1412         if (ds->decode_interrupt_)
1413                 return;
1414
1415         // Get the decoder and the binary data
1416         assert(pdata->pdo);
1417         assert(pdata->pdo->di);
1418         const srd_decoder *const decc = pdata->pdo->di->decoder;
1419         assert(decc);
1420
1421         const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data;
1422         assert(pdb);
1423
1424         // Find the matching DecodeBinaryClass
1425         DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_));
1426
1427         DecodeBinaryClass* bin_class = nullptr;
1428         for (DecodeBinaryClass& bc : segment->binary_classes)
1429                 if ((bc.decoder->decoder() == decc) && (bc.info->bin_class_id == pdb->bin_class))
1430                         bin_class = &bc;
1431
1432         if (!bin_class) {
1433                 qWarning() << "Could not find valid DecodeBinaryClass in segment" <<
1434                                 ds->current_segment_id_ << "for binary class ID" << pdb->bin_class <<
1435                                 ", segment only knows" << segment->binary_classes.size() << "classes";
1436                 return;
1437         }
1438
1439         // Add the data chunk
1440         bin_class->chunks.emplace_back();
1441         DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back());
1442
1443         chunk->sample = pdata->start_sample;
1444         chunk->data.resize(pdb->size);
1445         memcpy(chunk->data.data(), pdb->data, pdb->size);
1446
1447         // Find decoder class instance
1448         Decoder* dec = nullptr;
1449         for (const shared_ptr<decode::Decoder>& d : ds->decoder_stack())
1450                 if (d->decoder() == decc) {
1451                         dec = d.get();
1452                         break;
1453                 }
1454
1455         ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class);
1456 }
1457
1458 void DecodeSignal::on_capture_state_changed(int state)
1459 {
1460         // If a new acquisition was started, we need to start decoding from scratch
1461         if (state == Session::Running) {
1462                 logic_mux_data_invalid_ = true;
1463                 begin_decode();
1464         }
1465 }
1466
1467 void DecodeSignal::on_data_cleared()
1468 {
1469         reset_decode();
1470 }
1471
1472 void DecodeSignal::on_data_received()
1473 {
1474         // If we detected a lack of input data when trying to start decoding,
1475         // we have set an error message. Only try again if we now have data
1476         // to work with
1477         if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1478                 return;
1479
1480         if (!logic_mux_thread_.joinable())
1481                 begin_decode();
1482         else
1483                 logic_mux_cond_.notify_one();
1484 }
1485
1486 } // namespace data
1487 } // namespace pv