Fix #1629 more by fixing the notification handling
[pulseview.git] / pv / data / decodesignal.cpp
blobe076e8c0532e94da8283a916f5a178854a040cfc
1 /*
2 * This file is part of the PulseView project.
4 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
20 #include <cstring>
21 #include <forward_list>
22 #include <limits>
24 #include <QDebug>
26 #include "logic.hpp"
27 #include "logicsegment.hpp"
28 #include "decodesignal.hpp"
29 #include "signaldata.hpp"
31 #include <pv/data/decode/decoder.hpp>
32 #include <pv/data/decode/row.hpp>
33 #include <pv/globalsettings.hpp>
34 #include <pv/session.hpp>
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;
45 namespace pv {
46 namespace data {
48 const double DecodeSignal::DecodeMargin = 1.0;
49 const double DecodeSignal::DecodeThreshold = 0.2;
50 const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
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)
61 connect(&session_, SIGNAL(capture_state_changed(int)),
62 this, SLOT(on_capture_state_changed(int)));
65 DecodeSignal::~DecodeSignal()
67 reset_decode(true);
70 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
72 return stack_;
75 void DecodeSignal::stack_decoder(const srd_decoder *decoder, bool restart_decode)
77 assert(decoder);
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();
83 if ((stack_.empty()) || ((stack_.size() > 0) && (name() == prev_dec_name)))
84 set_name(QString::fromUtf8(decoder->name));
86 const shared_ptr<Decoder> dec = make_shared<Decoder>(decoder, stack_.size());
87 stack_.push_back(dec);
89 connect(dec.get(), SIGNAL(annotation_visibility_changed()),
90 this, SLOT(on_annotation_visibility_changed()));
92 // Include the newly created decode channels in the channel lists
93 update_channel_list();
95 stack_config_changed_ = true;
96 auto_assign_signals(dec);
97 commit_decoder_channels();
99 decoder_stacked((void*)dec.get());
101 if (restart_decode)
102 begin_decode();
105 void DecodeSignal::remove_decoder(int index)
107 assert(index >= 0);
108 assert(index < (int)stack_.size());
110 // Find the decoder in the stack
111 auto iter = stack_.begin() + index;
112 assert(iter != stack_.end());
114 shared_ptr<Decoder> dec = *iter;
116 decoder_removed(dec.get());
118 // Delete the element
119 stack_.erase(iter);
121 // Update channels and decoded data
122 stack_config_changed_ = true;
123 update_channel_list();
124 begin_decode();
127 bool DecodeSignal::toggle_decoder_visibility(int index)
129 auto iter = stack_.cbegin();
130 for (int i = 0; i < index; i++, iter++)
131 assert(iter != stack_.end());
133 shared_ptr<Decoder> dec = *iter;
135 // Toggle decoder visibility
136 bool state = false;
137 if (dec) {
138 state = !dec->visible();
139 dec->set_visible(state);
142 return state;
145 void DecodeSignal::reset_decode(bool shutting_down)
147 resume_decode(); // Make sure the decode thread isn't blocked by pausing
149 if (stack_config_changed_ || shutting_down)
150 stop_srd_session();
151 else
152 terminate_srd_session();
154 if (decode_thread_.joinable()) {
155 decode_interrupt_ = true;
156 decode_input_cond_.notify_one();
157 decode_thread_.join();
160 if (logic_mux_thread_.joinable()) {
161 logic_mux_interrupt_ = true;
162 logic_mux_cond_.notify_one();
163 logic_mux_thread_.join();
166 current_segment_id_ = 0;
167 segments_.clear();
169 logic_mux_data_.reset();
170 logic_mux_data_invalid_ = true;
172 if (!error_message_.isEmpty()) {
173 error_message_.clear();
174 // TODO Emulate noquote()
175 qDebug().nospace() << name() << ": Error cleared";
178 decode_reset();
181 void DecodeSignal::begin_decode()
183 if (decode_thread_.joinable()) {
184 decode_interrupt_ = true;
185 decode_input_cond_.notify_one();
186 decode_thread_.join();
189 if (logic_mux_thread_.joinable()) {
190 logic_mux_interrupt_ = true;
191 logic_mux_cond_.notify_one();
192 logic_mux_thread_.join();
195 reset_decode();
197 if (stack_.size() == 0) {
198 set_error_message(tr("No decoders"));
199 return;
202 assert(channels_.size() > 0);
204 if (get_assigned_signal_count() == 0) {
205 set_error_message(tr("There are no channels assigned to this decoder"));
206 return;
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;
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;
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();
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);
234 if (get_input_segment_count() == 0)
235 set_error_message(tr("No input data"));
237 // Make sure the logic output data is complete and up-to-date
238 logic_mux_interrupt_ = false;
239 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
241 // Decode the muxed logic data
242 decode_interrupt_ = false;
243 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
246 void DecodeSignal::pause_decode()
248 decode_paused_ = true;
251 void DecodeSignal::resume_decode()
253 // Manual unlocking is done before notifying, to avoid waking up the
254 // waiting thread only to block again (see notify_one for details)
255 decode_pause_mutex_.unlock();
256 decode_pause_cond_.notify_one();
257 decode_paused_ = false;
260 bool DecodeSignal::is_paused() const
262 return decode_paused_;
265 const vector<decode::DecodeChannel> DecodeSignal::get_channels() const
267 return channels_;
270 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
272 bool new_assignment = false;
274 // Disconnect all input signal notifications so we don't have duplicate connections
275 disconnect_input_notifiers();
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;
283 if (ch.assigned_signal)
284 continue;
286 QString ch_name = ch.name.toLower();
287 ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
289 shared_ptr<data::SignalBase> match;
290 for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
291 if (!s->enabled())
292 continue;
294 QString s_name = s->name().toLower();
295 s_name = s_name.replace(QRegExp("[-_.]"), " ");
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;
311 // Prevent using a signal more than once as D1 would match e.g. D1 and D10
312 bool signal_not_already_used = true;
313 for (decode::DecodeChannel& ch : channels_)
314 if (ch.assigned_signal && (ch.assigned_signal == match))
315 signal_not_already_used = false;
317 if (match && signal_not_already_used) {
318 ch.assigned_signal = match;
319 new_assignment = true;
323 if (new_assignment) {
324 // Receive notifications when new sample data is available
325 connect_input_notifiers();
327 logic_mux_data_invalid_ = true;
328 stack_config_changed_ = true;
329 commit_decoder_channels();
330 channels_updated();
334 void DecodeSignal::assign_signal(const uint16_t channel_id, shared_ptr<const SignalBase> signal)
336 // Disconnect all input signal notifications so we don't have duplicate connections
337 disconnect_input_notifiers();
339 for (decode::DecodeChannel& ch : channels_)
340 if (ch.id == channel_id) {
341 ch.assigned_signal = signal;
342 logic_mux_data_invalid_ = true;
345 // Receive notifications when new sample data is available
346 connect_input_notifiers();
348 stack_config_changed_ = true;
349 commit_decoder_channels();
350 channels_updated();
351 begin_decode();
354 int DecodeSignal::get_assigned_signal_count() const
356 // Count all channels that have a signal assigned to them
357 return count_if(channels_.begin(), channels_.end(),
358 [](decode::DecodeChannel ch) { return ch.assigned_signal.get(); });
361 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
363 for (decode::DecodeChannel& ch : channels_)
364 if (ch.id == channel_id)
365 ch.initial_pin_state = init_state;
367 stack_config_changed_ = true;
368 channels_updated();
369 begin_decode();
372 double DecodeSignal::get_samplerate() const
374 double result = 0;
376 // TODO For now, we simply return the first samplerate that we have
377 if (segments_.size() > 0)
378 result = segments_.front().samplerate;
380 return result;
383 const pv::util::Timestamp DecodeSignal::start_time() const
385 pv::util::Timestamp result;
387 // TODO For now, we simply return the first start time that we have
388 if (segments_.size() > 0)
389 result = segments_.front().start_time;
391 return result;
394 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
396 // The working sample count is the highest sample number for
397 // which all used signals have data available, so go through all
398 // channels and use the lowest overall sample count of the segment
400 int64_t count = std::numeric_limits<int64_t>::max();
401 bool no_signals_assigned = true;
403 for (const decode::DecodeChannel& ch : channels_)
404 if (ch.assigned_signal) {
405 if (!ch.assigned_signal->logic_data())
406 return 0;
408 no_signals_assigned = false;
410 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
411 if (logic_data->logic_segments().empty())
412 return 0;
414 if (segment_id >= logic_data->logic_segments().size())
415 return 0;
417 const shared_ptr<const LogicSegment> segment = logic_data->logic_segments()[segment_id]->get_shared_ptr();
418 if (segment)
419 count = min(count, (int64_t)segment->get_sample_count());
422 return (no_signals_assigned ? 0 : count);
425 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
426 bool include_processing) const
428 lock_guard<mutex> decode_lock(output_mutex_);
430 int64_t result = 0;
432 if (segment_id >= segments_.size())
433 return result;
435 if (include_processing)
436 result = segments_[segment_id].samples_decoded_incl;
437 else
438 result = segments_[segment_id].samples_decoded_excl;
440 return result;
443 vector<Row*> DecodeSignal::get_rows(bool visible_only)
445 vector<Row*> rows;
447 for (const shared_ptr<Decoder>& dec : stack_) {
448 assert(dec);
449 if (visible_only && !dec->visible())
450 continue;
452 for (Row* row : dec->get_rows())
453 rows.push_back(row);
456 return rows;
459 vector<const Row*> DecodeSignal::get_rows(bool visible_only) const
461 vector<const Row*> rows;
463 for (const shared_ptr<Decoder>& dec : stack_) {
464 assert(dec);
465 if (visible_only && !dec->visible())
466 continue;
468 for (const Row* row : dec->get_rows())
469 rows.push_back(row);
472 return rows;
476 uint64_t DecodeSignal::get_annotation_count(const Row* row, uint32_t segment_id) const
478 if (segment_id >= segments_.size())
479 return 0;
481 const DecodeSegment* segment = &(segments_.at(segment_id));
483 auto row_it = segment->annotation_rows.find(row);
485 const RowData* rd;
486 if (row_it == segment->annotation_rows.end())
487 return 0;
488 else
489 rd = &(row_it->second);
491 return rd->get_annotation_count();
494 void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
495 const Row* row, uint32_t segment_id, uint64_t start_sample,
496 uint64_t end_sample) const
498 lock_guard<mutex> lock(output_mutex_);
500 if (segment_id >= segments_.size())
501 return;
503 const DecodeSegment* segment = &(segments_.at(segment_id));
505 auto row_it = segment->annotation_rows.find(row);
507 const RowData* rd;
508 if (row_it == segment->annotation_rows.end())
509 return;
510 else
511 rd = &(row_it->second);
513 rd->get_annotation_subset(dest, start_sample, end_sample);
516 void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
517 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
519 for (const Row* row : get_rows())
520 get_annotation_subset(dest, row, segment_id, start_sample, end_sample);
523 uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id,
524 const Decoder* dec, uint32_t bin_class_id) const
526 if ((segments_.size() == 0) || (segment_id >= segments_.size()))
527 return 0;
529 const DecodeSegment *segment = &(segments_[segment_id]);
531 for (const DecodeBinaryClass& bc : segment->binary_classes)
532 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
533 return bc.chunks.size();
535 return 0;
538 void DecodeSignal::get_binary_data_chunk(uint32_t segment_id,
539 const Decoder* dec, uint32_t bin_class_id, uint32_t chunk_id,
540 const vector<uint8_t> **dest, uint64_t *size)
542 if (segment_id >= segments_.size())
543 return;
545 const DecodeSegment *segment = &(segments_[segment_id]);
547 for (const DecodeBinaryClass& bc : segment->binary_classes)
548 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) {
549 if (dest) *dest = &(bc.chunks.at(chunk_id).data);
550 if (size) *size = bc.chunks.at(chunk_id).data.size();
551 return;
555 void DecodeSignal::get_merged_binary_data_chunks_by_sample(uint32_t segment_id,
556 const Decoder* dec, uint32_t bin_class_id, uint64_t start_sample,
557 uint64_t end_sample, vector<uint8_t> *dest) const
559 assert(dest != nullptr);
561 if (segment_id >= segments_.size())
562 return;
564 const DecodeSegment *segment = &(segments_[segment_id]);
566 const DecodeBinaryClass* bin_class = nullptr;
567 for (const DecodeBinaryClass& bc : segment->binary_classes)
568 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
569 bin_class = &bc;
571 // Determine overall size before copying to resize dest vector only once
572 uint64_t size = 0;
573 uint64_t matches = 0;
574 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
575 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
576 size += chunk.data.size();
577 matches++;
579 dest->resize(size);
581 uint64_t offset = 0;
582 uint64_t matches2 = 0;
583 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
584 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
585 memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size());
586 offset += chunk.data.size();
587 matches2++;
589 // Make sure we don't overwrite memory if the array grew in the meanwhile
590 if (matches2 == matches)
591 break;
595 void DecodeSignal::get_merged_binary_data_chunks_by_offset(uint32_t segment_id,
596 const Decoder* dec, uint32_t bin_class_id, uint64_t start, uint64_t end,
597 vector<uint8_t> *dest) const
599 assert(dest != nullptr);
601 if (segment_id >= segments_.size())
602 return;
604 const DecodeSegment *segment = &(segments_[segment_id]);
606 const DecodeBinaryClass* bin_class = nullptr;
607 for (const DecodeBinaryClass& bc : segment->binary_classes)
608 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
609 bin_class = &bc;
611 // Determine overall size before copying to resize dest vector only once
612 uint64_t size = 0;
613 uint64_t offset = 0;
614 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
615 if (offset >= start)
616 size += chunk.data.size();
617 offset += chunk.data.size();
618 if (offset >= end)
619 break;
621 dest->resize(size);
623 offset = 0;
624 uint64_t dest_offset = 0;
625 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
626 if (offset >= start) {
627 memcpy(dest->data() + dest_offset, chunk.data.data(), chunk.data.size());
628 dest_offset += chunk.data.size();
630 offset += chunk.data.size();
631 if (offset >= end)
632 break;
636 const DecodeBinaryClass* DecodeSignal::get_binary_data_class(uint32_t segment_id,
637 const Decoder* dec, uint32_t bin_class_id) const
639 if (segment_id >= segments_.size())
640 return nullptr;
642 const DecodeSegment *segment = &(segments_[segment_id]);
644 for (const DecodeBinaryClass& bc : segment->binary_classes)
645 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
646 return &bc;
648 return nullptr;
651 const deque<const Annotation*>* DecodeSignal::get_all_annotations_by_segment(
652 uint32_t segment_id) const
654 if (segment_id >= segments_.size())
655 return nullptr;
657 const DecodeSegment *segment = &(segments_[segment_id]);
659 return &(segment->all_annotations);
662 void DecodeSignal::save_settings(QSettings &settings) const
664 SignalBase::save_settings(settings);
666 settings.setValue("decoders", (int)(stack_.size()));
668 // Save decoder stack
669 int decoder_idx = 0;
670 for (const shared_ptr<Decoder>& decoder : stack_) {
671 settings.beginGroup("decoder" + QString::number(decoder_idx++));
673 settings.setValue("id", decoder->get_srd_decoder()->id);
674 settings.setValue("visible", decoder->visible());
676 // Save decoder options
677 const map<string, GVariant*>& options = decoder->options();
679 settings.setValue("options", (int)options.size());
681 // Note: Decoder::options() returns only the options
682 // that differ from the default. See binding::Decoder::getter()
683 int i = 0;
684 for (auto& option : options) {
685 settings.beginGroup("option" + QString::number(i));
686 settings.setValue("name", QString::fromStdString(option.first));
687 GlobalSettings::store_gvariant(settings, option.second);
688 settings.endGroup();
689 i++;
692 // Save row properties
693 i = 0;
694 for (const Row* row : decoder->get_rows()) {
695 settings.beginGroup("row" + QString::number(i));
696 settings.setValue("visible", row->visible());
697 settings.endGroup();
698 i++;
701 // Save class properties
702 i = 0;
703 for (const AnnotationClass* ann_class : decoder->ann_classes()) {
704 settings.beginGroup("ann_class" + QString::number(i));
705 settings.setValue("visible", ann_class->visible());
706 settings.endGroup();
707 i++;
710 settings.endGroup();
713 // Save channel mapping
714 settings.setValue("channels", (int)channels_.size());
716 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
717 auto channel = find_if(channels_.begin(), channels_.end(),
718 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
720 if (channel == channels_.end()) {
721 qDebug() << "ERROR: Gap in channel index:" << channel_id;
722 continue;
725 settings.beginGroup("channel" + QString::number(channel_id));
727 settings.setValue("name", channel->name); // Useful for debugging
728 settings.setValue("initial_pin_state", channel->initial_pin_state);
730 if (channel->assigned_signal)
731 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
733 settings.endGroup();
737 void DecodeSignal::restore_settings(QSettings &settings)
739 SignalBase::restore_settings(settings);
741 // Restore decoder stack
742 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
744 int decoders = settings.value("decoders").toInt();
746 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
747 settings.beginGroup("decoder" + QString::number(decoder_idx));
749 QString id = settings.value("id").toString();
751 for (GSList *entry = dec_list; entry; entry = entry->next) {
752 const srd_decoder *dec = (srd_decoder*)entry->data;
753 if (!dec)
754 continue;
756 if (QString::fromUtf8(dec->id) == id) {
757 shared_ptr<Decoder> decoder = make_shared<Decoder>(dec, stack_.size());
759 connect(decoder.get(), SIGNAL(annotation_visibility_changed()),
760 this, SLOT(on_annotation_visibility_changed()));
762 stack_.push_back(decoder);
763 decoder->set_visible(settings.value("visible", true).toBool());
765 // Restore decoder options that differ from their default
766 int options = settings.value("options").toInt();
768 for (int i = 0; i < options; i++) {
769 settings.beginGroup("option" + QString::number(i));
770 QString name = settings.value("name").toString();
771 GVariant *value = GlobalSettings::restore_gvariant(settings);
772 decoder->set_option(name.toUtf8(), value);
773 settings.endGroup();
776 // Include the newly created decode channels in the channel lists
777 update_channel_list();
779 // Restore row properties
780 int i = 0;
781 for (Row* row : decoder->get_rows()) {
782 settings.beginGroup("row" + QString::number(i));
783 row->set_visible(settings.value("visible", true).toBool());
784 settings.endGroup();
785 i++;
788 // Restore class properties
789 i = 0;
790 for (AnnotationClass* ann_class : decoder->ann_classes()) {
791 settings.beginGroup("ann_class" + QString::number(i));
792 ann_class->set_visible(settings.value("visible", true).toBool());
793 settings.endGroup();
794 i++;
797 break;
801 settings.endGroup();
802 channels_updated();
805 // Restore channel mapping
806 unsigned int channels = settings.value("channels").toInt();
808 const vector< shared_ptr<data::SignalBase> > signalbases =
809 session_.signalbases();
811 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
812 auto channel = find_if(channels_.begin(), channels_.end(),
813 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
815 if (channel == channels_.end()) {
816 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
817 continue;
820 settings.beginGroup("channel" + QString::number(channel_id));
822 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
824 for (const shared_ptr<data::SignalBase>& signal : signalbases)
825 if ((signal->name() == assigned_signal_name) && (signal->type() != SignalBase::DecodeChannel))
826 channel->assigned_signal = signal;
828 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
830 settings.endGroup();
833 // Update the internal structures
834 stack_config_changed_ = true;
835 update_channel_list();
836 commit_decoder_channels();
838 begin_decode();
841 bool DecodeSignal::all_input_segments_complete(uint32_t segment_id) const
843 bool all_complete = true;
845 for (const decode::DecodeChannel& ch : channels_)
846 if (ch.assigned_signal) {
847 if (!ch.assigned_signal->logic_data())
848 continue;
850 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
851 if (logic_data->logic_segments().empty())
852 return false;
854 if (segment_id >= logic_data->logic_segments().size())
855 return false;
857 const shared_ptr<const LogicSegment> segment = logic_data->logic_segments()[segment_id]->get_shared_ptr();
858 if (segment && !segment->is_complete())
859 all_complete = false;
862 return all_complete;
865 uint32_t DecodeSignal::get_input_segment_count() const
867 uint64_t count = std::numeric_limits<uint64_t>::max();
868 bool no_signals_assigned = true;
870 for (const decode::DecodeChannel& ch : channels_)
871 if (ch.assigned_signal) {
872 no_signals_assigned = false;
874 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
875 if (!logic_data || logic_data->logic_segments().empty())
876 return 0;
878 // Find the min value of all segment counts
879 if ((uint64_t)(logic_data->logic_segments().size()) < count)
880 count = logic_data->logic_segments().size();
883 return (no_signals_assigned ? 0 : count);
886 double DecodeSignal::get_input_samplerate(uint32_t segment_id) const
888 double samplerate = 0;
890 for (const decode::DecodeChannel& ch : channels_)
891 if (ch.assigned_signal) {
892 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
893 if (!logic_data || logic_data->logic_segments().empty())
894 continue;
896 try {
897 const shared_ptr<const LogicSegment> segment =
898 logic_data->logic_segments().at(segment_id)->get_shared_ptr();
899 if (segment)
900 samplerate = segment->samplerate();
901 } catch (out_of_range&) {
902 // Do nothing
904 break;
907 return samplerate;
910 Decoder* DecodeSignal::get_decoder_by_instance(const srd_decoder *const srd_dec)
912 for (shared_ptr<Decoder>& d : stack_)
913 if (d->get_srd_decoder() == srd_dec)
914 return d.get();
916 return nullptr;
919 void DecodeSignal::update_channel_list()
921 vector<decode::DecodeChannel> prev_channels = channels_;
922 channels_.clear();
924 uint16_t id = 0;
926 // Copy existing entries, create new as needed
927 for (shared_ptr<Decoder>& decoder : stack_) {
928 const srd_decoder* srd_dec = decoder->get_srd_decoder();
929 const GSList *l;
931 // Mandatory channels
932 for (l = srd_dec->channels; l; l = l->next) {
933 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
934 bool ch_added = false;
936 // Copy but update ID if this channel was in the list before
937 for (decode::DecodeChannel& ch : prev_channels)
938 if (ch.pdch_ == pdch) {
939 ch.id = id++;
940 channels_.push_back(ch);
941 ch_added = true;
942 break;
945 if (!ch_added) {
946 // Create new entry without a mapped signal
947 decode::DecodeChannel ch = {id++, 0, false, nullptr,
948 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
949 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
950 channels_.push_back(ch);
954 // Optional channels
955 for (l = srd_dec->opt_channels; l; l = l->next) {
956 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
957 bool ch_added = false;
959 // Copy but update ID if this channel was in the list before
960 for (decode::DecodeChannel& ch : prev_channels)
961 if (ch.pdch_ == pdch) {
962 ch.id = id++;
963 channels_.push_back(ch);
964 ch_added = true;
965 break;
968 if (!ch_added) {
969 // Create new entry without a mapped signal
970 decode::DecodeChannel ch = {id++, 0, true, nullptr,
971 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
972 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
973 channels_.push_back(ch);
978 // Invalidate the logic output data if the channel assignment changed
979 if (prev_channels.size() != channels_.size()) {
980 // The number of channels changed, there's definitely a difference
981 logic_mux_data_invalid_ = true;
982 } else {
983 // Same number but assignment may still differ, so compare all channels
984 for (size_t i = 0; i < channels_.size(); i++) {
985 const decode::DecodeChannel& p_ch = prev_channels[i];
986 const decode::DecodeChannel& ch = channels_[i];
988 if ((p_ch.pdch_ != ch.pdch_) ||
989 (p_ch.assigned_signal != ch.assigned_signal)) {
990 logic_mux_data_invalid_ = true;
991 break;
997 channels_updated();
1000 void DecodeSignal::commit_decoder_channels()
1002 // Submit channel list to every decoder, containing only the relevant channels
1003 for (shared_ptr<Decoder> dec : stack_) {
1004 vector<decode::DecodeChannel*> channel_list;
1006 for (decode::DecodeChannel& ch : channels_)
1007 if (ch.decoder_ == dec)
1008 channel_list.push_back(&ch);
1010 dec->set_channels(channel_list);
1013 // Channel bit IDs must be in sync with the channel's apperance in channels_
1014 int id = 0;
1015 for (decode::DecodeChannel& ch : channels_)
1016 if (ch.assigned_signal)
1017 ch.bit_id = id++;
1020 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
1022 // Enforce end to be greater than start
1023 if (end <= start)
1024 return;
1026 // Fetch the channel segments and their data
1027 vector<shared_ptr<const LogicSegment> > segments;
1028 vector<const uint8_t*> signal_data;
1029 vector<uint8_t> signal_in_bytepos;
1030 vector<uint8_t> signal_in_bitpos;
1032 for (decode::DecodeChannel& ch : channels_)
1033 if (ch.assigned_signal) {
1034 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
1036 shared_ptr<const LogicSegment> segment;
1037 if (segment_id < logic_data->logic_segments().size()) {
1038 segment = logic_data->logic_segments().at(segment_id)->get_shared_ptr();
1039 } else {
1040 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
1041 << "has no logic segment" << segment_id;
1042 logic_mux_interrupt_ = true;
1043 return;
1046 if (!segment)
1047 return;
1049 segments.push_back(segment);
1051 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
1052 segment->get_samples(start, end, data);
1053 signal_data.push_back(data);
1055 const int bitpos = ch.assigned_signal->logic_bit_index();
1056 signal_in_bytepos.push_back(bitpos / 8);
1057 signal_in_bitpos.push_back(bitpos % 8);
1060 shared_ptr<LogicSegment> output_segment;
1061 try {
1062 output_segment = logic_mux_data_->logic_segments().at(segment_id);
1063 } catch (out_of_range&) {
1064 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
1065 << segment_id << "in mux_logic_samples(), mux segments size is" \
1066 << logic_mux_data_->logic_segments().size();
1067 logic_mux_interrupt_ = true;
1068 return;
1071 // Perform the muxing of signal data into the output data
1072 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
1073 unsigned int signal_count = signal_data.size();
1075 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
1076 sample_cnt++) {
1078 int bitpos = 0;
1079 uint8_t bytepos = 0;
1081 const int out_sample_pos = sample_cnt * output_segment->unit_size();
1082 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
1083 output[out_sample_pos + i] = 0;
1085 for (unsigned int i = 0; i < signal_count; i++) {
1086 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
1087 const uint8_t in_sample = 1 &
1088 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
1090 const uint8_t out_sample = output[out_sample_pos + bytepos];
1092 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
1094 bitpos++;
1095 if (bitpos > 7) {
1096 bitpos = 0;
1097 bytepos++;
1102 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
1103 delete[] output;
1105 for (const uint8_t* data : signal_data)
1106 delete[] data;
1109 void DecodeSignal::logic_mux_proc()
1111 uint32_t input_segment_count;
1112 do {
1113 input_segment_count = get_input_segment_count();
1114 if (input_segment_count == 0) {
1115 // Wait for input data
1116 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1117 logic_mux_cond_.wait(logic_mux_lock);
1119 } while ((!logic_mux_interrupt_) && (input_segment_count == 0));
1121 if (logic_mux_interrupt_)
1122 return;
1124 assert(logic_mux_data_);
1126 uint32_t segment_id = 0;
1128 // Create initial logic mux segment
1129 shared_ptr<LogicSegment> output_segment =
1130 make_shared<LogicSegment>(*logic_mux_data_, segment_id, logic_mux_unit_size_, 0);
1131 logic_mux_data_->push_segment(output_segment);
1133 output_segment->set_samplerate(get_input_samplerate(0));
1135 // Logic mux data is being updated
1136 logic_mux_data_invalid_ = false;
1138 connect_input_segment_notifiers(segment_id);
1140 uint64_t samples_to_process;
1141 do {
1142 do {
1143 const uint64_t input_sample_count = get_working_sample_count(segment_id);
1144 const uint64_t output_sample_count = output_segment->get_sample_count();
1146 samples_to_process =
1147 (input_sample_count > output_sample_count) ?
1148 (input_sample_count - output_sample_count) : 0;
1150 if (samples_to_process > 0) {
1151 const uint64_t unit_size = output_segment->unit_size();
1152 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
1154 uint64_t processed_samples = 0;
1155 do {
1156 const uint64_t start_sample = output_sample_count + processed_samples;
1157 const uint64_t sample_count =
1158 min(samples_to_process - processed_samples, chunk_sample_count);
1160 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
1161 processed_samples += sample_count;
1163 // ...and process the newly muxed logic data
1164 decode_input_cond_.notify_one();
1165 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
1167 } while (!logic_mux_interrupt_ && (samples_to_process > 0));
1169 if (!logic_mux_interrupt_) {
1170 // samples_to_process is now 0, we've exhausted the currently available input data
1172 // If the input segments are complete, we've completed this segment
1173 if (all_input_segments_complete(segment_id)) {
1174 if (!output_segment->is_complete())
1175 output_segment->set_complete();
1177 if (segment_id < get_input_segment_count() - 1) {
1179 disconnect_input_segment_notifiers(segment_id);
1181 // Process next segment
1182 segment_id++;
1184 output_segment =
1185 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1186 logic_mux_unit_size_, 0);
1187 logic_mux_data_->push_segment(output_segment);
1189 output_segment->set_samplerate(get_input_samplerate(segment_id));
1191 connect_input_segment_notifiers(segment_id);
1192 } else {
1193 // Wait for more input data if we're processing the currently last segment
1194 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1195 logic_mux_cond_.wait(logic_mux_lock);
1197 } else {
1198 // Input segments aren't all complete yet but samples_to_process is 0, wait for more input data
1199 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1200 logic_mux_cond_.wait(logic_mux_lock);
1203 } while (!logic_mux_interrupt_);
1205 disconnect_input_segment_notifiers(segment_id);
1208 void DecodeSignal::decode_data(
1209 const int64_t abs_start_samplenum, const int64_t sample_count,
1210 const shared_ptr<const LogicSegment> input_segment)
1212 const int64_t unit_size = input_segment->unit_size();
1213 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
1215 for (int64_t i = abs_start_samplenum;
1216 !decode_interrupt_ && (i < (abs_start_samplenum + sample_count));
1217 i += chunk_sample_count) {
1219 const int64_t chunk_end = min(i + chunk_sample_count,
1220 abs_start_samplenum + sample_count);
1223 lock_guard<mutex> lock(output_mutex_);
1224 // Update the sample count showing the samples including currently processed ones
1225 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
1228 int64_t data_size = (chunk_end - i) * unit_size;
1229 uint8_t* chunk = new uint8_t[data_size];
1230 input_segment->get_samples(i, chunk_end, chunk);
1232 if (srd_session_send(srd_session_, i, chunk_end, chunk,
1233 data_size, unit_size) != SRD_OK) {
1234 set_error_message(tr("Decoder reported an error"));
1235 decode_interrupt_ = true;
1238 delete[] chunk;
1241 lock_guard<mutex> lock(output_mutex_);
1242 // Now that all samples are processed, the exclusive sample count catches up
1243 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1246 // Notify the frontend that we processed some data and
1247 // possibly have new annotations as well
1248 new_annotations();
1250 if (decode_paused_) {
1251 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1252 decode_pause_cond_.wait(pause_wait_lock);
1257 void DecodeSignal::decode_proc()
1259 current_segment_id_ = 0;
1261 // If there is no input data available yet, wait until it is or we're interrupted
1262 do {
1263 if (logic_mux_data_->logic_segments().size() == 0) {
1264 // Wait for input data
1265 unique_lock<mutex> input_wait_lock(input_mutex_);
1266 decode_input_cond_.wait(input_wait_lock);
1268 } while ((!decode_interrupt_) && (logic_mux_data_->logic_segments().size() == 0));
1270 if (decode_interrupt_)
1271 return;
1273 shared_ptr<const LogicSegment> input_segment = logic_mux_data_->logic_segments().front()->get_shared_ptr();
1274 if (!input_segment)
1275 return;
1277 // Create the initial segment and set its sample rate so that we can pass it to SRD
1278 create_decode_segment();
1279 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1280 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1282 start_srd_session();
1284 uint64_t samples_to_process = 0;
1285 uint64_t abs_start_samplenum = 0;
1286 do {
1287 // Keep processing new samples until we exhaust the input data
1288 do {
1289 samples_to_process = input_segment->get_sample_count() - abs_start_samplenum;
1291 if (samples_to_process > 0) {
1292 decode_data(abs_start_samplenum, samples_to_process, input_segment);
1293 abs_start_samplenum += samples_to_process;
1295 } while (!decode_interrupt_ && (samples_to_process > 0));
1297 if (!decode_interrupt_) {
1298 // samples_to_process is now 0, we've exhausted the currently available input data
1300 // If the input segment is complete, we've exhausted this segment
1301 if (input_segment->is_complete()) {
1302 if (current_segment_id_ < (logic_mux_data_->logic_segments().size() - 1)) {
1303 // Process next segment
1304 current_segment_id_++;
1306 try {
1307 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1308 } catch (out_of_range&) {
1309 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1310 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1311 << logic_mux_data_->logic_segments().size();
1312 decode_interrupt_ = true;
1313 return;
1315 abs_start_samplenum = 0;
1317 // Create the next segment and set its metadata
1318 create_decode_segment();
1319 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1320 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1322 // Reset decoder state but keep the decoder stack intact
1323 terminate_srd_session();
1324 } else {
1325 // All segments have been processed
1326 if (!decode_interrupt_)
1327 decode_finished();
1329 // Wait for more input data
1330 unique_lock<mutex> input_wait_lock(input_mutex_);
1331 decode_input_cond_.wait(input_wait_lock);
1333 } else {
1334 // Input segment isn't complete yet but samples_to_process is 0, wait for more input data
1335 unique_lock<mutex> input_wait_lock(input_mutex_);
1336 decode_input_cond_.wait(input_wait_lock);
1340 } while (!decode_interrupt_);
1343 void DecodeSignal::start_srd_session()
1345 // If there were stack changes, the session has been destroyed by now, so if
1346 // it hasn't been destroyed, we can just reset and re-use it
1347 if (srd_session_) {
1348 // When a decoder stack was created before, re-use it
1349 // for the next stream of input data, after terminating
1350 // potentially still executing operations, and resetting
1351 // internal state. Skip the rather expensive (teardown
1352 // and) construction of another decoder stack.
1354 // TODO Reduce redundancy, use a common code path for
1355 // the meta/start sequence?
1356 terminate_srd_session();
1358 // Metadata is cleared also, so re-set it
1359 uint64_t samplerate = 0;
1360 if (segments_.size() > 0)
1361 samplerate = segments_.at(current_segment_id_).samplerate;
1362 if (samplerate)
1363 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1364 g_variant_new_uint64(samplerate));
1365 for (const shared_ptr<Decoder>& dec : stack_)
1366 dec->apply_all_options();
1367 srd_session_start(srd_session_);
1369 return;
1372 // Create the session
1373 srd_session_new(&srd_session_);
1374 assert(srd_session_);
1376 // Create the decoders
1377 srd_decoder_inst *prev_di = nullptr;
1378 for (const shared_ptr<Decoder>& dec : stack_) {
1379 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1381 if (!di) {
1382 set_error_message(tr("Failed to create decoder instance"));
1383 srd_session_destroy(srd_session_);
1384 srd_session_ = nullptr;
1385 return;
1388 if (prev_di)
1389 srd_inst_stack(srd_session_, prev_di, di);
1391 prev_di = di;
1394 // Start the session
1395 if (segments_.size() > 0)
1396 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1397 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1399 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1400 DecodeSignal::annotation_callback, this);
1402 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
1403 DecodeSignal::binary_callback, this);
1405 srd_session_start(srd_session_);
1407 // We just recreated the srd session, so all stack changes are applied now
1408 stack_config_changed_ = false;
1411 void DecodeSignal::terminate_srd_session()
1413 // Call the "terminate and reset" routine for the decoder stack
1414 // (if available). This does not harm those stacks which already
1415 // have completed their operation, and reduces response time for
1416 // those stacks which still are processing data while the
1417 // application no longer wants them to.
1418 if (srd_session_) {
1419 srd_session_terminate_reset(srd_session_);
1421 // Metadata is cleared also, so re-set it
1422 uint64_t samplerate = 0;
1423 if (segments_.size() > 0)
1424 samplerate = segments_.at(current_segment_id_).samplerate;
1425 if (samplerate)
1426 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1427 g_variant_new_uint64(samplerate));
1428 for (const shared_ptr<Decoder>& dec : stack_)
1429 dec->apply_all_options();
1433 void DecodeSignal::stop_srd_session()
1435 if (srd_session_) {
1436 // Destroy the session
1437 srd_session_destroy(srd_session_);
1438 srd_session_ = nullptr;
1440 // Mark the decoder instances as non-existant since they were deleted
1441 for (const shared_ptr<Decoder>& dec : stack_)
1442 dec->invalidate_decoder_inst();
1446 void DecodeSignal::connect_input_notifiers()
1448 // Connect the currently used signals to our slot
1449 for (decode::DecodeChannel& ch : channels_) {
1450 if (!ch.assigned_signal)
1451 continue;
1452 const data::SignalBase *signal = ch.assigned_signal.get();
1453 connect(signal, SIGNAL(samples_cleared()),
1454 this, SLOT(on_data_cleared()));
1455 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1456 this, SLOT(on_data_received()));
1460 void DecodeSignal::disconnect_input_notifiers()
1462 // Disconnect the notification slot from the previous set of signals
1463 for (decode::DecodeChannel& ch : channels_) {
1464 if (!ch.assigned_signal)
1465 continue;
1466 const data::SignalBase *signal = ch.assigned_signal.get();
1467 disconnect(signal, nullptr, this, SLOT(on_data_cleared()));
1468 disconnect(signal, nullptr, this, SLOT(on_data_received()));
1472 void DecodeSignal::connect_input_segment_notifiers(uint32_t segment_id)
1474 for (decode::DecodeChannel& ch : channels_)
1475 if (ch.assigned_signal) {
1476 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
1478 shared_ptr<const LogicSegment> segment;
1479 if (segment_id < logic_data->logic_segments().size()) {
1480 segment = logic_data->logic_segments().at(segment_id)->get_shared_ptr();
1481 } else {
1482 qWarning() << "Signal" << name() << ":" << ch.assigned_signal->name() \
1483 << "has no logic segment, can't connect notifier" << segment_id;
1484 continue;
1487 if (!segment)
1488 continue;
1490 connect(segment.get(), SIGNAL(completed()), this, SLOT(on_input_segment_completed()));
1494 void DecodeSignal::disconnect_input_segment_notifiers(uint32_t segment_id)
1496 for (decode::DecodeChannel& ch : channels_)
1497 if (ch.assigned_signal) {
1498 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
1500 shared_ptr<const LogicSegment> segment;
1501 if (segment_id < logic_data->logic_segments().size()) {
1502 segment = logic_data->logic_segments().at(segment_id)->get_shared_ptr();
1503 } else {
1504 continue;
1507 if (!segment)
1508 continue;
1510 disconnect(segment.get(), SIGNAL(completed()), this, SLOT(on_input_segment_completed()));
1514 void DecodeSignal::create_decode_segment()
1516 // Create annotation segment
1517 segments_.emplace_back();
1519 // Add annotation classes
1520 for (const shared_ptr<Decoder>& dec : stack_)
1521 for (Row* row : dec->get_rows())
1522 segments_.back().annotation_rows.emplace(row, RowData(row));
1524 // Prepare our binary output classes
1525 for (const shared_ptr<Decoder>& dec : stack_) {
1526 uint32_t n = dec->get_binary_class_count();
1528 for (uint32_t i = 0; i < n; i++)
1529 segments_.back().binary_classes.push_back(
1530 {dec.get(), dec->get_binary_class(i), deque<DecodeBinaryDataChunk>()});
1534 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1536 assert(pdata);
1537 assert(decode_signal);
1539 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1540 assert(ds);
1542 if (ds->decode_interrupt_)
1543 return;
1545 if (ds->segments_.empty())
1546 return;
1548 lock_guard<mutex> lock(ds->output_mutex_);
1550 // Get the decoder and the annotation data
1551 assert(pdata->pdo);
1552 assert(pdata->pdo->di);
1553 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1554 assert(srd_dec);
1556 const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data;
1557 assert(pda);
1559 // Find the row
1560 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
1561 assert(dec);
1563 AnnotationClass* ann_class = dec->get_ann_class_by_id(pda->ann_class);
1564 if (!ann_class) {
1565 qWarning() << "Decoder" << ds->display_name() << "wanted to add annotation" <<
1566 "with class ID" << pda->ann_class << "but there are only" <<
1567 dec->ann_classes().size() << "known classes";
1568 return;
1571 const Row* row = ann_class->row;
1573 if (!row)
1574 row = dec->get_row_by_id(0);
1576 RowData& row_data = ds->segments_[ds->current_segment_id_].annotation_rows.at(row);
1578 // Add the annotation to the row
1579 const Annotation* ann = row_data.emplace_annotation(pdata);
1581 // We insert the annotation into the global annotation list in a way so that
1582 // the annotation list is sorted by start sample and length. Otherwise, we'd
1583 // have to sort the model, which is expensive
1584 deque<const Annotation*>& all_annotations =
1585 ds->segments_[ds->current_segment_id_].all_annotations;
1587 if (all_annotations.empty()) {
1588 all_annotations.emplace_back(ann);
1589 } else {
1590 const uint64_t new_ann_len = (pdata->end_sample - pdata->start_sample);
1591 bool ann_has_earlier_start = (pdata->start_sample < all_annotations.back()->start_sample());
1592 bool ann_is_longer = (new_ann_len >
1593 (all_annotations.back()->end_sample() - all_annotations.back()->start_sample()));
1595 if (ann_has_earlier_start && ann_is_longer) {
1596 bool ann_has_same_start;
1597 auto it = all_annotations.end();
1599 do {
1600 it--;
1601 ann_has_earlier_start = (pdata->start_sample < (*it)->start_sample());
1602 ann_has_same_start = (pdata->start_sample == (*it)->start_sample());
1603 ann_is_longer = (new_ann_len > (*it)->length());
1604 } while ((ann_has_earlier_start || (ann_has_same_start && ann_is_longer)) && (it != all_annotations.begin()));
1606 // Allow inserting at the front
1607 if (it != all_annotations.begin())
1608 it++;
1610 all_annotations.emplace(it, ann);
1611 } else
1612 all_annotations.emplace_back(ann);
1615 // When emplace_annotation() inserts instead of appends an annotation,
1616 // the pointers in all_annotations that follow the inserted annotation and
1617 // point to annotations for this row are off by one and must be updated
1618 if (&(row_data.annotations().back()) != ann) {
1619 // Search backwards until we find the annotation we just added
1620 auto row_it = row_data.annotations().end();
1621 auto all_it = all_annotations.end();
1622 do {
1623 all_it--;
1624 if ((*all_it)->row_data() == &row_data)
1625 row_it--;
1626 } while (&(*row_it) != ann);
1628 // Update the annotation addresses for this row's annotations until the end
1629 do {
1630 if ((*all_it)->row_data() == &row_data) {
1631 *all_it = &(*row_it);
1632 row_it++;
1634 all_it++;
1635 } while (all_it != all_annotations.end());
1639 void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
1641 assert(pdata);
1642 assert(decode_signal);
1644 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1645 assert(ds);
1647 if (ds->decode_interrupt_)
1648 return;
1650 // Get the decoder and the binary data
1651 assert(pdata->pdo);
1652 assert(pdata->pdo->di);
1653 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1654 assert(srd_dec);
1656 const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data;
1657 assert(pdb);
1659 // Find the matching DecodeBinaryClass
1660 DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_));
1662 DecodeBinaryClass* bin_class = nullptr;
1663 for (DecodeBinaryClass& bc : segment->binary_classes)
1664 if ((bc.decoder->get_srd_decoder() == srd_dec) &&
1665 (bc.info->bin_class_id == (uint32_t)pdb->bin_class))
1666 bin_class = &bc;
1668 if (!bin_class) {
1669 qWarning() << "Could not find valid DecodeBinaryClass in segment" <<
1670 ds->current_segment_id_ << "for binary class ID" << pdb->bin_class <<
1671 ", segment only knows" << segment->binary_classes.size() << "classes";
1672 return;
1675 // Add the data chunk
1676 bin_class->chunks.emplace_back();
1677 DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back());
1679 chunk->sample = pdata->start_sample;
1680 chunk->data.resize(pdb->size);
1681 memcpy(chunk->data.data(), pdb->data, pdb->size);
1683 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
1685 ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class);
1688 void DecodeSignal::on_capture_state_changed(int state)
1690 // If a new acquisition was started, we need to start decoding from scratch
1691 if (state == Session::Running) {
1692 logic_mux_data_invalid_ = true;
1693 begin_decode();
1697 void DecodeSignal::on_data_cleared()
1699 reset_decode();
1702 void DecodeSignal::on_data_received()
1704 // If we detected a lack of input data when trying to start decoding,
1705 // we have set an error message. Only try again if we now have data
1706 // to work with
1707 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1708 return;
1709 else {
1710 error_message_.clear();
1711 // TODO Emulate noquote()
1712 qDebug().nospace() << name() << ": Error cleared";
1715 if (!logic_mux_thread_.joinable())
1716 begin_decode();
1717 else
1718 logic_mux_cond_.notify_one();
1721 void DecodeSignal::on_input_segment_completed()
1723 if (!logic_mux_thread_.joinable())
1724 logic_mux_cond_.notify_one();
1727 void DecodeSignal::on_annotation_visibility_changed()
1729 annotation_visibility_changed();
1732 } // namespace data
1733 } // namespace pv