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