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