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/>.
21 #include <forward_list>
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;
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;
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),
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()
70 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
75 void DecodeSignal::stack_decoder(const srd_decoder *decoder, bool restart_decode)
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());
105 void DecodeSignal::remove_decoder(int index)
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
121 // Update channels and decoded data
122 stack_config_changed_ = true;
123 update_channel_list();
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
138 state = !dec->visible();
139 dec->set_visible(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)
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;
169 logic_mux_data_.reset();
170 logic_mux_data_invalid_ = true;
172 if (!error_message_.isEmpty()) {
173 error_message_ = QString();
174 // TODO Emulate noquote()
175 qDebug().nospace() << name() << ": Error cleared";
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();
197 if (stack_.size() == 0) {
198 set_error_message(tr("No decoders"));
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"));
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"));
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 // Receive notifications when new sample data is available
235 connect_input_notifiers();
237 if (get_input_segment_count() == 0) {
238 set_error_message(tr("No input data"));
242 // Make sure the logic output data is complete and up-to-date
243 logic_mux_interrupt_ = false;
244 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
246 // Decode the muxed logic data
247 decode_interrupt_ = false;
248 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
251 void DecodeSignal::pause_decode()
253 decode_paused_ = true;
256 void DecodeSignal::resume_decode()
258 // Manual unlocking is done before notifying, to avoid waking up the
259 // waiting thread only to block again (see notify_one for details)
260 decode_pause_mutex_.unlock();
261 decode_pause_cond_.notify_one();
262 decode_paused_ = false;
265 bool DecodeSignal::is_paused() const
267 return decode_paused_;
270 QString DecodeSignal::error_message() const
272 lock_guard<mutex> lock(output_mutex_);
273 return error_message_;
276 const vector<decode::DecodeChannel> DecodeSignal::get_channels() const
281 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
283 bool new_assignment = false;
285 // Try to auto-select channels that don't have signals assigned yet
286 for (decode::DecodeChannel& ch : channels_) {
287 // If a decoder is given, auto-assign only its channels
288 if (dec && (ch.decoder_ != dec))
291 if (ch.assigned_signal)
294 QString ch_name = ch.name.toLower();
295 ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
297 shared_ptr<data::SignalBase> match;
298 for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
302 QString s_name = s->name().toLower();
303 s_name = s_name.replace(QRegExp("[-_.]"), " ");
305 if (s->logic_data() &&
306 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
310 // Only replace an existing match if it matches more characters
311 int old_unmatched = ch_name.length() - match->name().length();
312 int new_unmatched = ch_name.length() - s->name().length();
313 if (abs(new_unmatched) < abs(old_unmatched))
320 ch.assigned_signal = match.get();
321 new_assignment = true;
325 if (new_assignment) {
326 logic_mux_data_invalid_ = true;
327 stack_config_changed_ = true;
328 commit_decoder_channels();
333 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
335 for (decode::DecodeChannel& ch : channels_)
336 if (ch.id == channel_id) {
337 ch.assigned_signal = signal;
338 logic_mux_data_invalid_ = true;
341 stack_config_changed_ = true;
342 commit_decoder_channels();
347 int DecodeSignal::get_assigned_signal_count() const
349 // Count all channels that have a signal assigned to them
350 return count_if(channels_.begin(), channels_.end(),
351 [](decode::DecodeChannel ch) { return ch.assigned_signal; });
354 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
356 for (decode::DecodeChannel& ch : channels_)
357 if (ch.id == channel_id)
358 ch.initial_pin_state = init_state;
360 stack_config_changed_ = true;
365 double DecodeSignal::get_samplerate() const
369 // TODO For now, we simply return the first samplerate that we have
370 if (segments_.size() > 0)
371 result = segments_.front().samplerate;
376 const pv::util::Timestamp DecodeSignal::start_time() const
378 pv::util::Timestamp result;
380 // TODO For now, we simply return the first start time that we have
381 if (segments_.size() > 0)
382 result = segments_.front().start_time;
387 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
389 // The working sample count is the highest sample number for
390 // which all used signals have data available, so go through all
391 // channels and use the lowest overall sample count of the segment
393 int64_t count = std::numeric_limits<int64_t>::max();
394 bool no_signals_assigned = true;
396 for (const decode::DecodeChannel& ch : channels_)
397 if (ch.assigned_signal) {
398 no_signals_assigned = false;
400 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
401 if (!logic_data || logic_data->logic_segments().empty())
405 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
406 count = min(count, (int64_t)segment->get_sample_count());
407 } catch (out_of_range&) {
412 return (no_signals_assigned ? 0 : count);
415 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
416 bool include_processing) const
418 lock_guard<mutex> decode_lock(output_mutex_);
422 if (segment_id >= segments_.size())
425 if (include_processing)
426 result = segments_[segment_id].samples_decoded_incl;
428 result = segments_[segment_id].samples_decoded_excl;
433 vector<Row*> DecodeSignal::get_rows(bool visible_only)
437 for (const shared_ptr<Decoder>& dec : stack_) {
439 if (visible_only && !dec->visible())
442 for (Row* row : dec->get_rows())
449 vector<const Row*> DecodeSignal::get_rows(bool visible_only) const
451 vector<const Row*> rows;
453 for (const shared_ptr<Decoder>& dec : stack_) {
455 if (visible_only && !dec->visible())
458 for (const Row* row : dec->get_rows())
466 uint64_t DecodeSignal::get_annotation_count(const Row* row, uint32_t segment_id) const
468 if (segment_id >= segments_.size())
471 const DecodeSegment* segment = &(segments_.at(segment_id));
473 auto row_it = segment->annotation_rows.find(row);
476 if (row_it == segment->annotation_rows.end())
479 rd = &(row_it->second);
481 return rd->get_annotation_count();
484 void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
485 const Row* row, uint32_t segment_id, uint64_t start_sample,
486 uint64_t end_sample) const
488 lock_guard<mutex> lock(output_mutex_);
490 if (segment_id >= segments_.size())
493 const DecodeSegment* segment = &(segments_.at(segment_id));
495 auto row_it = segment->annotation_rows.find(row);
498 if (row_it == segment->annotation_rows.end())
501 rd = &(row_it->second);
503 rd->get_annotation_subset(dest, start_sample, end_sample);
506 void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
507 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
509 for (const Row* row : get_rows())
510 get_annotation_subset(dest, row, segment_id, start_sample, end_sample);
513 uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id,
514 const Decoder* dec, uint32_t bin_class_id) const
516 if (segments_.size() == 0)
520 const DecodeSegment *segment = &(segments_.at(segment_id));
522 for (const DecodeBinaryClass& bc : segment->binary_classes)
523 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
524 return bc.chunks.size();
525 } catch (out_of_range&) {
532 void DecodeSignal::get_binary_data_chunk(uint32_t segment_id,
533 const Decoder* dec, uint32_t bin_class_id, uint32_t chunk_id,
534 const vector<uint8_t> **dest, uint64_t *size)
537 const DecodeSegment *segment = &(segments_.at(segment_id));
539 for (const DecodeBinaryClass& bc : segment->binary_classes)
540 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) {
541 if (dest) *dest = &(bc.chunks.at(chunk_id).data);
542 if (size) *size = bc.chunks.at(chunk_id).data.size();
545 } catch (out_of_range&) {
550 void DecodeSignal::get_merged_binary_data_chunks_by_sample(uint32_t segment_id,
551 const Decoder* dec, uint32_t bin_class_id, uint64_t start_sample,
552 uint64_t end_sample, vector<uint8_t> *dest) const
554 assert(dest != nullptr);
557 const DecodeSegment *segment = &(segments_.at(segment_id));
559 const DecodeBinaryClass* bin_class = nullptr;
560 for (const DecodeBinaryClass& bc : segment->binary_classes)
561 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
564 // Determine overall size before copying to resize dest vector only once
566 uint64_t matches = 0;
567 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
568 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
569 size += chunk.data.size();
575 uint64_t matches2 = 0;
576 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
577 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
578 memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size());
579 offset += chunk.data.size();
582 // Make sure we don't overwrite memory if the array grew in the meanwhile
583 if (matches2 == matches)
586 } catch (out_of_range&) {
591 void DecodeSignal::get_merged_binary_data_chunks_by_offset(uint32_t segment_id,
592 const Decoder* dec, uint32_t bin_class_id, uint64_t start, uint64_t end,
593 vector<uint8_t> *dest) const
595 assert(dest != nullptr);
598 const DecodeSegment *segment = &(segments_.at(segment_id));
600 const DecodeBinaryClass* bin_class = nullptr;
601 for (const DecodeBinaryClass& bc : segment->binary_classes)
602 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
605 // Determine overall size before copying to resize dest vector only once
608 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
610 size += chunk.data.size();
611 offset += chunk.data.size();
618 uint64_t dest_offset = 0;
619 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
620 if (offset >= start) {
621 memcpy(dest->data() + dest_offset, chunk.data.data(), chunk.data.size());
622 dest_offset += chunk.data.size();
624 offset += chunk.data.size();
628 } catch (out_of_range&) {
633 const DecodeBinaryClass* DecodeSignal::get_binary_data_class(uint32_t segment_id,
634 const Decoder* dec, uint32_t bin_class_id) const
637 const DecodeSegment *segment = &(segments_.at(segment_id));
639 for (const DecodeBinaryClass& bc : segment->binary_classes)
640 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
642 } catch (out_of_range&) {
649 const deque<const Annotation*>* DecodeSignal::get_all_annotations_by_segment(
650 uint32_t segment_id) const
653 const DecodeSegment *segment = &(segments_.at(segment_id));
654 return &(segment->all_annotations);
655 } catch (out_of_range&) {
662 void DecodeSignal::save_settings(QSettings &settings) const
664 SignalBase::save_settings(settings);
666 settings.setValue("decoders", (int)(stack_.size()));
668 // Save decoder stack
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()
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);
692 // Save row properties
694 for (const Row* row : decoder->get_rows()) {
695 settings.beginGroup("row" + QString::number(i));
696 settings.setValue("visible", row->visible());
701 // Save class properties
703 for (const AnnotationClass* ann_class : decoder->ann_classes()) {
704 settings.beginGroup("ann_class" + QString::number(i));
705 settings.setValue("visible", ann_class->visible());
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;
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());
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;
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);
776 // Include the newly created decode channels in the channel lists
777 update_channel_list();
779 // Restore row properties
781 for (Row* row : decoder->get_rows()) {
782 settings.beginGroup("row" + QString::number(i));
783 row->set_visible(settings.value("visible", true).toBool());
788 // Restore class properties
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());
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;
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.get();
828 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
833 // Update the internal structures
834 stack_config_changed_ = true;
835 update_channel_list();
836 commit_decoder_channels();
841 void DecodeSignal::set_error_message(QString msg)
843 error_message_ = msg;
844 // TODO Emulate noquote()
845 qDebug().nospace() << name() << ": " << msg;
848 uint32_t DecodeSignal::get_input_segment_count() const
850 uint64_t count = std::numeric_limits<uint64_t>::max();
851 bool no_signals_assigned = true;
853 for (const decode::DecodeChannel& ch : channels_)
854 if (ch.assigned_signal) {
855 no_signals_assigned = false;
857 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
858 if (!logic_data || logic_data->logic_segments().empty())
861 // Find the min value of all segment counts
862 if ((uint64_t)(logic_data->logic_segments().size()) < count)
863 count = logic_data->logic_segments().size();
866 return (no_signals_assigned ? 0 : count);
869 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
871 double samplerate = 0;
873 for (const decode::DecodeChannel& ch : channels_)
874 if (ch.assigned_signal) {
875 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
876 if (!logic_data || logic_data->logic_segments().empty())
880 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
881 samplerate = segment->samplerate();
882 } catch (out_of_range&) {
891 Decoder* DecodeSignal::get_decoder_by_instance(const srd_decoder *const srd_dec)
893 for (shared_ptr<Decoder>& d : stack_)
894 if (d->get_srd_decoder() == srd_dec)
900 void DecodeSignal::update_channel_list()
902 vector<decode::DecodeChannel> prev_channels = channels_;
907 // Copy existing entries, create new as needed
908 for (shared_ptr<Decoder>& decoder : stack_) {
909 const srd_decoder* srd_dec = decoder->get_srd_decoder();
912 // Mandatory channels
913 for (l = srd_dec->channels; l; l = l->next) {
914 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
915 bool ch_added = false;
917 // Copy but update ID if this channel was in the list before
918 for (decode::DecodeChannel& ch : prev_channels)
919 if (ch.pdch_ == pdch) {
921 channels_.push_back(ch);
927 // Create new entry without a mapped signal
928 decode::DecodeChannel ch = {id++, 0, false, nullptr,
929 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
930 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
931 channels_.push_back(ch);
936 for (l = srd_dec->opt_channels; l; l = l->next) {
937 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
938 bool ch_added = false;
940 // Copy but update ID if this channel was in the list before
941 for (decode::DecodeChannel& ch : prev_channels)
942 if (ch.pdch_ == pdch) {
944 channels_.push_back(ch);
950 // Create new entry without a mapped signal
951 decode::DecodeChannel ch = {id++, 0, true, nullptr,
952 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
953 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
954 channels_.push_back(ch);
959 // Invalidate the logic output data if the channel assignment changed
960 if (prev_channels.size() != channels_.size()) {
961 // The number of channels changed, there's definitely a difference
962 logic_mux_data_invalid_ = true;
964 // Same number but assignment may still differ, so compare all channels
965 for (size_t i = 0; i < channels_.size(); i++) {
966 const decode::DecodeChannel& p_ch = prev_channels[i];
967 const decode::DecodeChannel& ch = channels_[i];
969 if ((p_ch.pdch_ != ch.pdch_) ||
970 (p_ch.assigned_signal != ch.assigned_signal)) {
971 logic_mux_data_invalid_ = true;
981 void DecodeSignal::commit_decoder_channels()
983 // Submit channel list to every decoder, containing only the relevant channels
984 for (shared_ptr<Decoder> dec : stack_) {
985 vector<decode::DecodeChannel*> channel_list;
987 for (decode::DecodeChannel& ch : channels_)
988 if (ch.decoder_ == dec)
989 channel_list.push_back(&ch);
991 dec->set_channels(channel_list);
994 // Channel bit IDs must be in sync with the channel's apperance in channels_
996 for (decode::DecodeChannel& ch : channels_)
997 if (ch.assigned_signal)
1001 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
1003 // Enforce end to be greater than start
1007 // Fetch the channel segments and their data
1008 vector<shared_ptr<LogicSegment> > segments;
1009 vector<const uint8_t*> signal_data;
1010 vector<uint8_t> signal_in_bytepos;
1011 vector<uint8_t> signal_in_bitpos;
1013 for (decode::DecodeChannel& ch : channels_)
1014 if (ch.assigned_signal) {
1015 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
1017 shared_ptr<LogicSegment> segment;
1019 segment = logic_data->logic_segments().at(segment_id);
1020 } catch (out_of_range&) {
1021 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
1022 << "has no logic segment" << segment_id;
1025 segments.push_back(segment);
1027 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
1028 segment->get_samples(start, end, data);
1029 signal_data.push_back(data);
1031 const int bitpos = ch.assigned_signal->logic_bit_index();
1032 signal_in_bytepos.push_back(bitpos / 8);
1033 signal_in_bitpos.push_back(bitpos % 8);
1037 shared_ptr<LogicSegment> output_segment;
1039 output_segment = logic_mux_data_->logic_segments().at(segment_id);
1040 } catch (out_of_range&) {
1041 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
1042 << segment_id << "in mux_logic_samples(), mux segments size is" \
1043 << logic_mux_data_->logic_segments().size();
1047 // Perform the muxing of signal data into the output data
1048 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
1049 unsigned int signal_count = signal_data.size();
1051 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
1055 uint8_t bytepos = 0;
1057 const int out_sample_pos = sample_cnt * output_segment->unit_size();
1058 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
1059 output[out_sample_pos + i] = 0;
1061 for (unsigned int i = 0; i < signal_count; i++) {
1062 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
1063 const uint8_t in_sample = 1 &
1064 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
1066 const uint8_t out_sample = output[out_sample_pos + bytepos];
1068 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
1078 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
1081 for (const uint8_t* data : signal_data)
1085 void DecodeSignal::logic_mux_proc()
1087 uint32_t segment_id = 0;
1089 assert(logic_mux_data_);
1091 // Create initial logic mux segment
1092 shared_ptr<LogicSegment> output_segment =
1093 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1094 logic_mux_unit_size_, 0);
1095 logic_mux_data_->push_segment(output_segment);
1097 output_segment->set_samplerate(get_input_samplerate(0));
1100 const uint64_t input_sample_count = get_working_sample_count(segment_id);
1101 const uint64_t output_sample_count = output_segment->get_sample_count();
1103 const uint64_t samples_to_process =
1104 (input_sample_count > output_sample_count) ?
1105 (input_sample_count - output_sample_count) : 0;
1107 // Process the samples if necessary...
1108 if (samples_to_process > 0) {
1109 const uint64_t unit_size = output_segment->unit_size();
1110 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
1112 uint64_t processed_samples = 0;
1114 const uint64_t start_sample = output_sample_count + processed_samples;
1115 const uint64_t sample_count =
1116 min(samples_to_process - processed_samples, chunk_sample_count);
1118 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
1119 processed_samples += sample_count;
1121 // ...and process the newly muxed logic data
1122 decode_input_cond_.notify_one();
1123 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
1126 if (samples_to_process == 0) {
1127 // TODO Optimize this by caching the input segment count and only
1128 // querying it when the cached value was reached
1129 if (segment_id < get_input_segment_count() - 1) {
1130 // Process next segment
1134 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1135 logic_mux_unit_size_, 0);
1136 logic_mux_data_->push_segment(output_segment);
1138 output_segment->set_samplerate(get_input_samplerate(segment_id));
1141 // All segments have been processed
1142 logic_mux_data_invalid_ = false;
1144 // Wait for more input
1145 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1146 logic_mux_cond_.wait(logic_mux_lock);
1150 } while (!logic_mux_interrupt_);
1153 void DecodeSignal::decode_data(
1154 const int64_t abs_start_samplenum, const int64_t sample_count,
1155 const shared_ptr<LogicSegment> input_segment)
1157 const int64_t unit_size = input_segment->unit_size();
1158 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
1160 for (int64_t i = abs_start_samplenum;
1161 error_message_.isEmpty() && !decode_interrupt_ &&
1162 (i < (abs_start_samplenum + sample_count));
1163 i += chunk_sample_count) {
1165 const int64_t chunk_end = min(i + chunk_sample_count,
1166 abs_start_samplenum + sample_count);
1169 lock_guard<mutex> lock(output_mutex_);
1170 // Update the sample count showing the samples including currently processed ones
1171 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
1174 int64_t data_size = (chunk_end - i) * unit_size;
1175 uint8_t* chunk = new uint8_t[data_size];
1176 input_segment->get_samples(i, chunk_end, chunk);
1178 if (srd_session_send(srd_session_, i, chunk_end, chunk,
1179 data_size, unit_size) != SRD_OK)
1180 set_error_message(tr("Decoder reported an error"));
1185 lock_guard<mutex> lock(output_mutex_);
1186 // Now that all samples are processed, the exclusive sample count catches up
1187 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1190 // Notify the frontend that we processed some data and
1191 // possibly have new annotations as well
1194 if (decode_paused_) {
1195 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1196 decode_pause_cond_.wait(pause_wait_lock);
1201 void DecodeSignal::decode_proc()
1203 current_segment_id_ = 0;
1205 // If there is no input data available yet, wait until it is or we're interrupted
1206 if (logic_mux_data_->logic_segments().size() == 0) {
1207 unique_lock<mutex> input_wait_lock(input_mutex_);
1208 decode_input_cond_.wait(input_wait_lock);
1211 if (decode_interrupt_)
1214 shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
1215 assert(input_segment);
1217 // Create the initial segment and set its sample rate so that we can pass it to SRD
1218 create_decode_segment();
1219 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1220 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1222 start_srd_session();
1224 uint64_t sample_count = 0;
1225 uint64_t abs_start_samplenum = 0;
1227 // Keep processing new samples until we exhaust the input data
1229 lock_guard<mutex> input_lock(input_mutex_);
1230 sample_count = input_segment->get_sample_count() - abs_start_samplenum;
1232 if (sample_count > 0) {
1233 decode_data(abs_start_samplenum, sample_count, input_segment);
1234 abs_start_samplenum += sample_count;
1236 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
1238 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
1239 if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
1240 // Process next segment
1241 current_segment_id_++;
1244 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1245 } catch (out_of_range&) {
1246 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1247 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1248 << logic_mux_data_->logic_segments().size();
1251 abs_start_samplenum = 0;
1253 // Create the next segment and set its metadata
1254 create_decode_segment();
1255 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1256 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1258 // Reset decoder state but keep the decoder stack intact
1259 terminate_srd_session();
1261 // All segments have been processed
1264 // Wait for new input data or an interrupt was requested
1265 unique_lock<mutex> input_wait_lock(input_mutex_);
1266 decode_input_cond_.wait(input_wait_lock);
1269 } while (error_message_.isEmpty() && !decode_interrupt_);
1271 // Potentially reap decoders when the application no longer is
1272 // interested in their (pending) results.
1273 if (decode_interrupt_)
1274 terminate_srd_session();
1277 void DecodeSignal::start_srd_session()
1279 // If there were stack changes, the session has been destroyed by now, so if
1280 // it hasn't been destroyed, we can just reset and re-use it
1282 // When a decoder stack was created before, re-use it
1283 // for the next stream of input data, after terminating
1284 // potentially still executing operations, and resetting
1285 // internal state. Skip the rather expensive (teardown
1286 // and) construction of another decoder stack.
1288 // TODO Reduce redundancy, use a common code path for
1289 // the meta/start sequence?
1290 terminate_srd_session();
1292 // Metadata is cleared also, so re-set it
1293 uint64_t samplerate = 0;
1294 if (segments_.size() > 0)
1295 samplerate = segments_.at(current_segment_id_).samplerate;
1297 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1298 g_variant_new_uint64(samplerate));
1299 for (const shared_ptr<Decoder>& dec : stack_)
1300 dec->apply_all_options();
1301 srd_session_start(srd_session_);
1306 // Create the session
1307 srd_session_new(&srd_session_);
1308 assert(srd_session_);
1310 // Create the decoders
1311 srd_decoder_inst *prev_di = nullptr;
1312 for (const shared_ptr<Decoder>& dec : stack_) {
1313 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1316 set_error_message(tr("Failed to create decoder instance"));
1317 srd_session_destroy(srd_session_);
1318 srd_session_ = nullptr;
1323 srd_inst_stack(srd_session_, prev_di, di);
1328 // Start the session
1329 if (segments_.size() > 0)
1330 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1331 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1333 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1334 DecodeSignal::annotation_callback, this);
1336 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
1337 DecodeSignal::binary_callback, this);
1339 srd_session_start(srd_session_);
1341 // We just recreated the srd session, so all stack changes are applied now
1342 stack_config_changed_ = false;
1345 void DecodeSignal::terminate_srd_session()
1347 // Call the "terminate and reset" routine for the decoder stack
1348 // (if available). This does not harm those stacks which already
1349 // have completed their operation, and reduces response time for
1350 // those stacks which still are processing data while the
1351 // application no longer wants them to.
1353 srd_session_terminate_reset(srd_session_);
1355 // Metadata is cleared also, so re-set it
1356 uint64_t samplerate = 0;
1357 if (segments_.size() > 0)
1358 samplerate = segments_.at(current_segment_id_).samplerate;
1360 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1361 g_variant_new_uint64(samplerate));
1362 for (const shared_ptr<Decoder>& dec : stack_)
1363 dec->apply_all_options();
1367 void DecodeSignal::stop_srd_session()
1370 // Destroy the session
1371 srd_session_destroy(srd_session_);
1372 srd_session_ = nullptr;
1374 // Mark the decoder instances as non-existant since they were deleted
1375 for (const shared_ptr<Decoder>& dec : stack_)
1376 dec->invalidate_decoder_inst();
1380 void DecodeSignal::connect_input_notifiers()
1382 // Disconnect the notification slot from the previous set of signals
1383 disconnect(this, SLOT(on_data_cleared()));
1384 disconnect(this, SLOT(on_data_received()));
1386 // Connect the currently used signals to our slot
1387 for (decode::DecodeChannel& ch : channels_) {
1388 if (!ch.assigned_signal)
1391 const data::SignalBase *signal = ch.assigned_signal;
1392 connect(signal, SIGNAL(samples_cleared()),
1393 this, SLOT(on_data_cleared()));
1394 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1395 this, SLOT(on_data_received()));
1399 void DecodeSignal::create_decode_segment()
1401 // Create annotation segment
1402 segments_.emplace_back();
1404 // Add annotation classes
1405 for (const shared_ptr<Decoder>& dec : stack_)
1406 for (Row* row : dec->get_rows())
1407 segments_.back().annotation_rows.emplace(row, RowData(row));
1409 // Prepare our binary output classes
1410 for (const shared_ptr<Decoder>& dec : stack_) {
1411 uint32_t n = dec->get_binary_class_count();
1413 for (uint32_t i = 0; i < n; i++)
1414 segments_.back().binary_classes.push_back(
1415 {dec.get(), dec->get_binary_class(i), deque<DecodeBinaryDataChunk>()});
1419 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1422 assert(decode_signal);
1424 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1427 if (ds->decode_interrupt_)
1430 if (ds->segments_.empty())
1433 lock_guard<mutex> lock(ds->output_mutex_);
1435 // Get the decoder and the annotation data
1437 assert(pdata->pdo->di);
1438 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1441 const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data;
1445 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
1448 AnnotationClass* ann_class = dec->get_ann_class_by_id(pda->ann_class);
1450 qWarning() << "Decoder" << ds->display_name() << "wanted to add annotation" <<
1451 "with class ID" << pda->ann_class << "but there are only" <<
1452 dec->ann_classes().size() << "known classes";
1456 const Row* row = ann_class->row;
1459 row = dec->get_row_by_id(0);
1461 RowData& row_data = ds->segments_[ds->current_segment_id_].annotation_rows.at(row);
1463 // Add the annotation to the row
1464 const Annotation* ann = row_data.emplace_annotation(pdata);
1466 // We insert the annotation into the global annotation list in a way so that
1467 // the annotation list is sorted by start sample and length. Otherwise, we'd
1468 // have to sort the model, which is expensive
1469 deque<const Annotation*>& all_annotations =
1470 ds->segments_[ds->current_segment_id_].all_annotations;
1472 if (all_annotations.empty()) {
1473 all_annotations.emplace_back(ann);
1475 const uint64_t new_ann_len = (pdata->end_sample - pdata->start_sample);
1476 bool ann_has_earlier_start = (pdata->start_sample < all_annotations.back()->start_sample());
1477 bool ann_is_longer = (new_ann_len >
1478 (all_annotations.back()->end_sample() - all_annotations.back()->start_sample()));
1480 if (ann_has_earlier_start && ann_is_longer) {
1481 bool ann_has_same_start;
1482 auto it = all_annotations.end();
1486 ann_has_earlier_start = (pdata->start_sample < (*it)->start_sample());
1487 ann_has_same_start = (pdata->start_sample == (*it)->start_sample());
1488 ann_is_longer = (new_ann_len > (*it)->length());
1489 } while ((ann_has_earlier_start || (ann_has_same_start && ann_is_longer)) && (it != all_annotations.begin()));
1491 // Allow inserting at the front
1492 if (it != all_annotations.begin())
1495 all_annotations.emplace(it, ann);
1497 all_annotations.emplace_back(ann);
1500 // When emplace_annotation() inserts instead of appends an annotation,
1501 // the pointers in all_annotations that follow the inserted annotation and
1502 // point to annotations for this row are off by one and must be updated
1503 if (&(row_data.annotations().back()) != ann) {
1504 // Search backwards until we find the annotation we just added
1505 auto row_it = row_data.annotations().end();
1506 auto all_it = all_annotations.end();
1509 if ((*all_it)->row_data() == &row_data)
1511 } while (&(*row_it) != ann);
1513 // Update the annotation addresses for this row's annotations until the end
1515 if ((*all_it)->row_data() == &row_data) {
1516 *all_it = &(*row_it);
1520 } while (all_it != all_annotations.end());
1524 void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
1527 assert(decode_signal);
1529 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1532 if (ds->decode_interrupt_)
1535 // Get the decoder and the binary data
1537 assert(pdata->pdo->di);
1538 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1541 const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data;
1544 // Find the matching DecodeBinaryClass
1545 DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_));
1547 DecodeBinaryClass* bin_class = nullptr;
1548 for (DecodeBinaryClass& bc : segment->binary_classes)
1549 if ((bc.decoder->get_srd_decoder() == srd_dec) &&
1550 (bc.info->bin_class_id == (uint32_t)pdb->bin_class))
1554 qWarning() << "Could not find valid DecodeBinaryClass in segment" <<
1555 ds->current_segment_id_ << "for binary class ID" << pdb->bin_class <<
1556 ", segment only knows" << segment->binary_classes.size() << "classes";
1560 // Add the data chunk
1561 bin_class->chunks.emplace_back();
1562 DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back());
1564 chunk->sample = pdata->start_sample;
1565 chunk->data.resize(pdb->size);
1566 memcpy(chunk->data.data(), pdb->data, pdb->size);
1568 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
1570 ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class);
1573 void DecodeSignal::on_capture_state_changed(int state)
1575 // If a new acquisition was started, we need to start decoding from scratch
1576 if (state == Session::Running) {
1577 logic_mux_data_invalid_ = true;
1582 void DecodeSignal::on_data_cleared()
1587 void DecodeSignal::on_data_received()
1589 // If we detected a lack of input data when trying to start decoding,
1590 // we have set an error message. Only try again if we now have data
1592 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1595 if (!logic_mux_thread_.joinable())
1598 logic_mux_cond_.notify_one();
1601 void DecodeSignal::on_annotation_visibility_changed()
1603 annotation_visibility_changed();