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