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_.clear();
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"));
240 // Make sure the logic output data is complete and up-to-date
241 logic_mux_interrupt_ = false;
242 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
244 // Decode the muxed logic data
245 decode_interrupt_ = false;
246 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
249 void DecodeSignal::pause_decode()
251 decode_paused_ = true;
254 void DecodeSignal::resume_decode()
256 // Manual unlocking is done before notifying, to avoid waking up the
257 // waiting thread only to block again (see notify_one for details)
258 decode_pause_mutex_.unlock();
259 decode_pause_cond_.notify_one();
260 decode_paused_ = false;
263 bool DecodeSignal::is_paused() const
265 return decode_paused_;
268 const vector<decode::DecodeChannel> DecodeSignal::get_channels() const
273 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
275 bool new_assignment = false;
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))
283 if (ch.assigned_signal)
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()) {
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)))) {
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))
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 logic_mux_data_invalid_ = true;
325 stack_config_changed_ = true;
326 commit_decoder_channels();
331 void DecodeSignal::assign_signal(const uint16_t channel_id, shared_ptr<const SignalBase> signal)
333 for (decode::DecodeChannel& ch : channels_)
334 if (ch.id == channel_id) {
335 ch.assigned_signal = signal;
336 logic_mux_data_invalid_ = true;
339 stack_config_changed_ = true;
340 commit_decoder_channels();
345 int DecodeSignal::get_assigned_signal_count() const
347 // Count all channels that have a signal assigned to them
348 return count_if(channels_.begin(), channels_.end(),
349 [](decode::DecodeChannel ch) { return ch.assigned_signal.get(); });
352 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
354 for (decode::DecodeChannel& ch : channels_)
355 if (ch.id == channel_id)
356 ch.initial_pin_state = init_state;
358 stack_config_changed_ = true;
363 double DecodeSignal::get_samplerate() const
367 // TODO For now, we simply return the first samplerate that we have
368 if (segments_.size() > 0)
369 result = segments_.front().samplerate;
374 const pv::util::Timestamp DecodeSignal::start_time() const
376 pv::util::Timestamp result;
378 // TODO For now, we simply return the first start time that we have
379 if (segments_.size() > 0)
380 result = segments_.front().start_time;
385 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
387 // The working sample count is the highest sample number for
388 // which all used signals have data available, so go through all
389 // channels and use the lowest overall sample count of the segment
391 int64_t count = std::numeric_limits<int64_t>::max();
392 bool no_signals_assigned = true;
394 for (const decode::DecodeChannel& ch : channels_)
395 if (ch.assigned_signal) {
396 if (!ch.assigned_signal->logic_data())
399 no_signals_assigned = false;
401 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
402 if (logic_data->logic_segments().empty())
405 if (segment_id >= logic_data->logic_segments().size())
408 const shared_ptr<const LogicSegment> segment = logic_data->logic_segments()[segment_id]->get_shared_ptr();
410 count = min(count, (int64_t)segment->get_sample_count());
413 return (no_signals_assigned ? 0 : count);
416 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
417 bool include_processing) const
419 lock_guard<mutex> decode_lock(output_mutex_);
423 if (segment_id >= segments_.size())
426 if (include_processing)
427 result = segments_[segment_id].samples_decoded_incl;
429 result = segments_[segment_id].samples_decoded_excl;
434 vector<Row*> DecodeSignal::get_rows(bool visible_only)
438 for (const shared_ptr<Decoder>& dec : stack_) {
440 if (visible_only && !dec->visible())
443 for (Row* row : dec->get_rows())
450 vector<const Row*> DecodeSignal::get_rows(bool visible_only) const
452 vector<const Row*> rows;
454 for (const shared_ptr<Decoder>& dec : stack_) {
456 if (visible_only && !dec->visible())
459 for (const Row* row : dec->get_rows())
467 uint64_t DecodeSignal::get_annotation_count(const Row* row, uint32_t segment_id) const
469 if (segment_id >= segments_.size())
472 const DecodeSegment* segment = &(segments_.at(segment_id));
474 auto row_it = segment->annotation_rows.find(row);
477 if (row_it == segment->annotation_rows.end())
480 rd = &(row_it->second);
482 return rd->get_annotation_count();
485 void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
486 const Row* row, uint32_t segment_id, uint64_t start_sample,
487 uint64_t end_sample) const
489 lock_guard<mutex> lock(output_mutex_);
491 if (segment_id >= segments_.size())
494 const DecodeSegment* segment = &(segments_.at(segment_id));
496 auto row_it = segment->annotation_rows.find(row);
499 if (row_it == segment->annotation_rows.end())
502 rd = &(row_it->second);
504 rd->get_annotation_subset(dest, start_sample, end_sample);
507 void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
508 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
510 for (const Row* row : get_rows())
511 get_annotation_subset(dest, row, segment_id, start_sample, end_sample);
514 uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id,
515 const Decoder* dec, uint32_t bin_class_id) const
517 if ((segments_.size() == 0) || (segment_id >= segments_.size()))
520 const DecodeSegment *segment = &(segments_[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();
529 void DecodeSignal::get_binary_data_chunk(uint32_t segment_id,
530 const Decoder* dec, uint32_t bin_class_id, uint32_t chunk_id,
531 const vector<uint8_t> **dest, uint64_t *size)
533 if (segment_id >= segments_.size())
536 const DecodeSegment *segment = &(segments_[segment_id]);
538 for (const DecodeBinaryClass& bc : segment->binary_classes)
539 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) {
540 if (dest) *dest = &(bc.chunks.at(chunk_id).data);
541 if (size) *size = bc.chunks.at(chunk_id).data.size();
546 void DecodeSignal::get_merged_binary_data_chunks_by_sample(uint32_t segment_id,
547 const Decoder* dec, uint32_t bin_class_id, uint64_t start_sample,
548 uint64_t end_sample, vector<uint8_t> *dest) const
550 assert(dest != nullptr);
552 if (segment_id >= segments_.size())
555 const DecodeSegment *segment = &(segments_[segment_id]);
557 const DecodeBinaryClass* bin_class = nullptr;
558 for (const DecodeBinaryClass& bc : segment->binary_classes)
559 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
562 // Determine overall size before copying to resize dest vector only once
564 uint64_t matches = 0;
565 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
566 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
567 size += chunk.data.size();
573 uint64_t matches2 = 0;
574 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
575 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
576 memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size());
577 offset += chunk.data.size();
580 // Make sure we don't overwrite memory if the array grew in the meanwhile
581 if (matches2 == matches)
586 void DecodeSignal::get_merged_binary_data_chunks_by_offset(uint32_t segment_id,
587 const Decoder* dec, uint32_t bin_class_id, uint64_t start, uint64_t end,
588 vector<uint8_t> *dest) const
590 assert(dest != nullptr);
592 if (segment_id >= segments_.size())
595 const DecodeSegment *segment = &(segments_[segment_id]);
597 const DecodeBinaryClass* bin_class = nullptr;
598 for (const DecodeBinaryClass& bc : segment->binary_classes)
599 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
602 // Determine overall size before copying to resize dest vector only once
605 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
607 size += chunk.data.size();
608 offset += chunk.data.size();
615 uint64_t dest_offset = 0;
616 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
617 if (offset >= start) {
618 memcpy(dest->data() + dest_offset, chunk.data.data(), chunk.data.size());
619 dest_offset += chunk.data.size();
621 offset += chunk.data.size();
627 const DecodeBinaryClass* DecodeSignal::get_binary_data_class(uint32_t segment_id,
628 const Decoder* dec, uint32_t bin_class_id) const
630 if (segment_id >= segments_.size())
633 const DecodeSegment *segment = &(segments_[segment_id]);
635 for (const DecodeBinaryClass& bc : segment->binary_classes)
636 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
642 const deque<const Annotation*>* DecodeSignal::get_all_annotations_by_segment(
643 uint32_t segment_id) const
645 if (segment_id >= segments_.size())
648 const DecodeSegment *segment = &(segments_[segment_id]);
650 return &(segment->all_annotations);
653 void DecodeSignal::save_settings(QSettings &settings) const
655 SignalBase::save_settings(settings);
657 settings.setValue("decoders", (int)(stack_.size()));
659 // Save decoder stack
661 for (const shared_ptr<Decoder>& decoder : stack_) {
662 settings.beginGroup("decoder" + QString::number(decoder_idx++));
664 settings.setValue("id", decoder->get_srd_decoder()->id);
665 settings.setValue("visible", decoder->visible());
667 // Save decoder options
668 const map<string, GVariant*>& options = decoder->options();
670 settings.setValue("options", (int)options.size());
672 // Note: Decoder::options() returns only the options
673 // that differ from the default. See binding::Decoder::getter()
675 for (auto& option : options) {
676 settings.beginGroup("option" + QString::number(i));
677 settings.setValue("name", QString::fromStdString(option.first));
678 GlobalSettings::store_gvariant(settings, option.second);
683 // Save row properties
685 for (const Row* row : decoder->get_rows()) {
686 settings.beginGroup("row" + QString::number(i));
687 settings.setValue("visible", row->visible());
692 // Save class properties
694 for (const AnnotationClass* ann_class : decoder->ann_classes()) {
695 settings.beginGroup("ann_class" + QString::number(i));
696 settings.setValue("visible", ann_class->visible());
704 // Save channel mapping
705 settings.setValue("channels", (int)channels_.size());
707 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
708 auto channel = find_if(channels_.begin(), channels_.end(),
709 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
711 if (channel == channels_.end()) {
712 qDebug() << "ERROR: Gap in channel index:" << channel_id;
716 settings.beginGroup("channel" + QString::number(channel_id));
718 settings.setValue("name", channel->name); // Useful for debugging
719 settings.setValue("initial_pin_state", channel->initial_pin_state);
721 if (channel->assigned_signal)
722 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
728 void DecodeSignal::restore_settings(QSettings &settings)
730 SignalBase::restore_settings(settings);
732 // Restore decoder stack
733 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
735 int decoders = settings.value("decoders").toInt();
737 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
738 settings.beginGroup("decoder" + QString::number(decoder_idx));
740 QString id = settings.value("id").toString();
742 for (GSList *entry = dec_list; entry; entry = entry->next) {
743 const srd_decoder *dec = (srd_decoder*)entry->data;
747 if (QString::fromUtf8(dec->id) == id) {
748 shared_ptr<Decoder> decoder = make_shared<Decoder>(dec, stack_.size());
750 connect(decoder.get(), SIGNAL(annotation_visibility_changed()),
751 this, SLOT(on_annotation_visibility_changed()));
753 stack_.push_back(decoder);
754 decoder->set_visible(settings.value("visible", true).toBool());
756 // Restore decoder options that differ from their default
757 int options = settings.value("options").toInt();
759 for (int i = 0; i < options; i++) {
760 settings.beginGroup("option" + QString::number(i));
761 QString name = settings.value("name").toString();
762 GVariant *value = GlobalSettings::restore_gvariant(settings);
763 decoder->set_option(name.toUtf8(), value);
767 // Include the newly created decode channels in the channel lists
768 update_channel_list();
770 // Restore row properties
772 for (Row* row : decoder->get_rows()) {
773 settings.beginGroup("row" + QString::number(i));
774 row->set_visible(settings.value("visible", true).toBool());
779 // Restore class properties
781 for (AnnotationClass* ann_class : decoder->ann_classes()) {
782 settings.beginGroup("ann_class" + QString::number(i));
783 ann_class->set_visible(settings.value("visible", true).toBool());
796 // Restore channel mapping
797 unsigned int channels = settings.value("channels").toInt();
799 const vector< shared_ptr<data::SignalBase> > signalbases =
800 session_.signalbases();
802 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
803 auto channel = find_if(channels_.begin(), channels_.end(),
804 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
806 if (channel == channels_.end()) {
807 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
811 settings.beginGroup("channel" + QString::number(channel_id));
813 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
815 for (const shared_ptr<data::SignalBase>& signal : signalbases)
816 if ((signal->name() == assigned_signal_name) && (signal->type() != SignalBase::DecodeChannel))
817 channel->assigned_signal = signal;
819 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
824 // Update the internal structures
825 stack_config_changed_ = true;
826 update_channel_list();
827 commit_decoder_channels();
832 bool DecodeSignal::all_input_segments_complete(uint32_t segment_id) const
834 bool all_complete = true;
836 for (const decode::DecodeChannel& ch : channels_)
837 if (ch.assigned_signal) {
838 if (!ch.assigned_signal->logic_data())
841 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
842 if (logic_data->logic_segments().empty())
845 if (segment_id >= logic_data->logic_segments().size())
848 const shared_ptr<const LogicSegment> segment = logic_data->logic_segments()[segment_id]->get_shared_ptr();
849 if (segment && !segment->is_complete())
850 all_complete = false;
856 uint32_t DecodeSignal::get_input_segment_count() const
858 uint64_t count = std::numeric_limits<uint64_t>::max();
859 bool no_signals_assigned = true;
861 for (const decode::DecodeChannel& ch : channels_)
862 if (ch.assigned_signal) {
863 no_signals_assigned = false;
865 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
866 if (!logic_data || logic_data->logic_segments().empty())
869 // Find the min value of all segment counts
870 if ((uint64_t)(logic_data->logic_segments().size()) < count)
871 count = logic_data->logic_segments().size();
874 return (no_signals_assigned ? 0 : count);
877 double DecodeSignal::get_input_samplerate(uint32_t segment_id) const
879 double samplerate = 0;
881 for (const decode::DecodeChannel& ch : channels_)
882 if (ch.assigned_signal) {
883 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
884 if (!logic_data || logic_data->logic_segments().empty())
888 const shared_ptr<const LogicSegment> segment =
889 logic_data->logic_segments().at(segment_id)->get_shared_ptr();
891 samplerate = segment->samplerate();
892 } catch (out_of_range&) {
901 Decoder* DecodeSignal::get_decoder_by_instance(const srd_decoder *const srd_dec)
903 for (shared_ptr<Decoder>& d : stack_)
904 if (d->get_srd_decoder() == srd_dec)
910 void DecodeSignal::update_channel_list()
912 vector<decode::DecodeChannel> prev_channels = channels_;
917 // Copy existing entries, create new as needed
918 for (shared_ptr<Decoder>& decoder : stack_) {
919 const srd_decoder* srd_dec = decoder->get_srd_decoder();
922 // Mandatory channels
923 for (l = srd_dec->channels; l; l = l->next) {
924 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
925 bool ch_added = false;
927 // Copy but update ID if this channel was in the list before
928 for (decode::DecodeChannel& ch : prev_channels)
929 if (ch.pdch_ == pdch) {
931 channels_.push_back(ch);
937 // Create new entry without a mapped signal
938 decode::DecodeChannel ch = {id++, 0, false, nullptr,
939 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
940 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
941 channels_.push_back(ch);
946 for (l = srd_dec->opt_channels; l; l = l->next) {
947 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
948 bool ch_added = false;
950 // Copy but update ID if this channel was in the list before
951 for (decode::DecodeChannel& ch : prev_channels)
952 if (ch.pdch_ == pdch) {
954 channels_.push_back(ch);
960 // Create new entry without a mapped signal
961 decode::DecodeChannel ch = {id++, 0, true, nullptr,
962 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
963 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
964 channels_.push_back(ch);
969 // Invalidate the logic output data if the channel assignment changed
970 if (prev_channels.size() != channels_.size()) {
971 // The number of channels changed, there's definitely a difference
972 logic_mux_data_invalid_ = true;
974 // Same number but assignment may still differ, so compare all channels
975 for (size_t i = 0; i < channels_.size(); i++) {
976 const decode::DecodeChannel& p_ch = prev_channels[i];
977 const decode::DecodeChannel& ch = channels_[i];
979 if ((p_ch.pdch_ != ch.pdch_) ||
980 (p_ch.assigned_signal != ch.assigned_signal)) {
981 logic_mux_data_invalid_ = true;
991 void DecodeSignal::commit_decoder_channels()
993 // Submit channel list to every decoder, containing only the relevant channels
994 for (shared_ptr<Decoder> dec : stack_) {
995 vector<decode::DecodeChannel*> channel_list;
997 for (decode::DecodeChannel& ch : channels_)
998 if (ch.decoder_ == dec)
999 channel_list.push_back(&ch);
1001 dec->set_channels(channel_list);
1004 // Channel bit IDs must be in sync with the channel's apperance in channels_
1006 for (decode::DecodeChannel& ch : channels_)
1007 if (ch.assigned_signal)
1011 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
1013 // Enforce end to be greater than start
1017 // Fetch the channel segments and their data
1018 vector<shared_ptr<const LogicSegment> > segments;
1019 vector<const uint8_t*> signal_data;
1020 vector<uint8_t> signal_in_bytepos;
1021 vector<uint8_t> signal_in_bitpos;
1023 for (decode::DecodeChannel& ch : channels_)
1024 if (ch.assigned_signal) {
1025 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
1027 shared_ptr<const LogicSegment> segment;
1028 if (segment_id < logic_data->logic_segments().size()) {
1029 segment = logic_data->logic_segments().at(segment_id)->get_shared_ptr();
1031 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
1032 << "has no logic segment" << segment_id;
1033 logic_mux_interrupt_ = true;
1040 segments.push_back(segment);
1042 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
1043 segment->get_samples(start, end, data);
1044 signal_data.push_back(data);
1046 const int bitpos = ch.assigned_signal->logic_bit_index();
1047 signal_in_bytepos.push_back(bitpos / 8);
1048 signal_in_bitpos.push_back(bitpos % 8);
1051 shared_ptr<LogicSegment> output_segment;
1053 output_segment = logic_mux_data_->logic_segments().at(segment_id);
1054 } catch (out_of_range&) {
1055 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
1056 << segment_id << "in mux_logic_samples(), mux segments size is" \
1057 << logic_mux_data_->logic_segments().size();
1058 logic_mux_interrupt_ = true;
1062 // Perform the muxing of signal data into the output data
1063 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
1064 unsigned int signal_count = signal_data.size();
1066 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
1070 uint8_t bytepos = 0;
1072 const int out_sample_pos = sample_cnt * output_segment->unit_size();
1073 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
1074 output[out_sample_pos + i] = 0;
1076 for (unsigned int i = 0; i < signal_count; i++) {
1077 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
1078 const uint8_t in_sample = 1 &
1079 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
1081 const uint8_t out_sample = output[out_sample_pos + bytepos];
1083 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
1093 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
1096 for (const uint8_t* data : signal_data)
1100 void DecodeSignal::logic_mux_proc()
1102 uint32_t input_segment_count;
1104 input_segment_count = get_input_segment_count();
1105 if (input_segment_count == 0) {
1106 // Wait for input data
1107 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1108 logic_mux_cond_.wait(logic_mux_lock);
1110 } while ((!logic_mux_interrupt_) && (input_segment_count == 0));
1112 if (logic_mux_interrupt_)
1115 assert(logic_mux_data_);
1117 uint32_t segment_id = 0;
1119 // Create initial logic mux segment
1120 shared_ptr<LogicSegment> output_segment =
1121 make_shared<LogicSegment>(*logic_mux_data_, segment_id, logic_mux_unit_size_, 0);
1122 logic_mux_data_->push_segment(output_segment);
1124 output_segment->set_samplerate(get_input_samplerate(0));
1126 // Logic mux data is being updated
1127 logic_mux_data_invalid_ = false;
1129 uint64_t samples_to_process;
1132 const uint64_t input_sample_count = get_working_sample_count(segment_id);
1133 const uint64_t output_sample_count = output_segment->get_sample_count();
1135 samples_to_process =
1136 (input_sample_count > output_sample_count) ?
1137 (input_sample_count - output_sample_count) : 0;
1139 if (samples_to_process > 0) {
1140 const uint64_t unit_size = output_segment->unit_size();
1141 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
1143 uint64_t processed_samples = 0;
1145 const uint64_t start_sample = output_sample_count + processed_samples;
1146 const uint64_t sample_count =
1147 min(samples_to_process - processed_samples, chunk_sample_count);
1149 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
1150 processed_samples += sample_count;
1152 // ...and process the newly muxed logic data
1153 decode_input_cond_.notify_one();
1154 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
1156 } while (!logic_mux_interrupt_ && (samples_to_process > 0));
1158 if (!logic_mux_interrupt_) {
1159 // samples_to_process is now 0, we've exhausted the currently available input data
1161 // If the input segments are complete, we've completed this segment
1162 if (all_input_segments_complete(segment_id)) {
1163 if (!output_segment->is_complete())
1164 output_segment->set_complete();
1166 if (segment_id < get_input_segment_count() - 1) {
1167 // Process next segment
1171 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1172 logic_mux_unit_size_, 0);
1173 logic_mux_data_->push_segment(output_segment);
1175 output_segment->set_samplerate(get_input_samplerate(segment_id));
1179 if (segment_id == (get_input_segment_count() - 1)) {
1180 // Wait for more input data if we're processing the currently last segment
1181 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1182 logic_mux_cond_.wait(logic_mux_lock);
1185 } while (!logic_mux_interrupt_);
1188 void DecodeSignal::decode_data(
1189 const int64_t abs_start_samplenum, const int64_t sample_count,
1190 const shared_ptr<const LogicSegment> input_segment)
1192 const int64_t unit_size = input_segment->unit_size();
1193 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
1195 for (int64_t i = abs_start_samplenum;
1196 !decode_interrupt_ && (i < (abs_start_samplenum + sample_count));
1197 i += chunk_sample_count) {
1199 const int64_t chunk_end = min(i + chunk_sample_count,
1200 abs_start_samplenum + sample_count);
1203 lock_guard<mutex> lock(output_mutex_);
1204 // Update the sample count showing the samples including currently processed ones
1205 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
1208 int64_t data_size = (chunk_end - i) * unit_size;
1209 uint8_t* chunk = new uint8_t[data_size];
1210 input_segment->get_samples(i, chunk_end, chunk);
1212 if (srd_session_send(srd_session_, i, chunk_end, chunk,
1213 data_size, unit_size) != SRD_OK) {
1214 set_error_message(tr("Decoder reported an error"));
1215 decode_interrupt_ = true;
1221 lock_guard<mutex> lock(output_mutex_);
1222 // Now that all samples are processed, the exclusive sample count catches up
1223 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1226 // Notify the frontend that we processed some data and
1227 // possibly have new annotations as well
1230 if (decode_paused_) {
1231 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1232 decode_pause_cond_.wait(pause_wait_lock);
1237 void DecodeSignal::decode_proc()
1239 current_segment_id_ = 0;
1241 // If there is no input data available yet, wait until it is or we're interrupted
1243 if (logic_mux_data_->logic_segments().size() == 0) {
1244 // Wait for input data
1245 unique_lock<mutex> input_wait_lock(input_mutex_);
1246 decode_input_cond_.wait(input_wait_lock);
1248 } while ((!decode_interrupt_) && (logic_mux_data_->logic_segments().size() == 0));
1250 if (decode_interrupt_)
1253 shared_ptr<const LogicSegment> input_segment = logic_mux_data_->logic_segments().front()->get_shared_ptr();
1257 // Create the initial segment and set its sample rate so that we can pass it to SRD
1258 create_decode_segment();
1259 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1260 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1262 start_srd_session();
1264 uint64_t samples_to_process = 0;
1265 uint64_t abs_start_samplenum = 0;
1267 // Keep processing new samples until we exhaust the input data
1269 samples_to_process = input_segment->get_sample_count() - abs_start_samplenum;
1271 if (samples_to_process > 0) {
1272 decode_data(abs_start_samplenum, samples_to_process, input_segment);
1273 abs_start_samplenum += samples_to_process;
1275 } while (!decode_interrupt_ && (samples_to_process > 0));
1277 if (!decode_interrupt_) {
1278 // samples_to_process is now 0, we've exhausted the currently available input data
1280 // If the input segment is complete, we've exhausted this segment
1281 if (input_segment->is_complete()) {
1282 if (current_segment_id_ < (logic_mux_data_->logic_segments().size() - 1)) {
1283 // Process next segment
1284 current_segment_id_++;
1287 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1288 } catch (out_of_range&) {
1289 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1290 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1291 << logic_mux_data_->logic_segments().size();
1292 decode_interrupt_ = true;
1295 abs_start_samplenum = 0;
1297 // Create the next segment and set its metadata
1298 create_decode_segment();
1299 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1300 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1302 // Reset decoder state but keep the decoder stack intact
1303 terminate_srd_session();
1305 // All segments have been processed
1306 if (!decode_interrupt_)
1311 if (current_segment_id_ == (logic_mux_data_->logic_segments().size() - 1)) {
1312 // Wait for more input data if we're processing the currently last segment
1313 unique_lock<mutex> input_wait_lock(input_mutex_);
1314 decode_input_cond_.wait(input_wait_lock);
1317 } while (!decode_interrupt_);
1320 void DecodeSignal::start_srd_session()
1322 // If there were stack changes, the session has been destroyed by now, so if
1323 // it hasn't been destroyed, we can just reset and re-use it
1325 // When a decoder stack was created before, re-use it
1326 // for the next stream of input data, after terminating
1327 // potentially still executing operations, and resetting
1328 // internal state. Skip the rather expensive (teardown
1329 // and) construction of another decoder stack.
1331 // TODO Reduce redundancy, use a common code path for
1332 // the meta/start sequence?
1333 terminate_srd_session();
1335 // Metadata is cleared also, so re-set it
1336 uint64_t samplerate = 0;
1337 if (segments_.size() > 0)
1338 samplerate = segments_.at(current_segment_id_).samplerate;
1340 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1341 g_variant_new_uint64(samplerate));
1342 for (const shared_ptr<Decoder>& dec : stack_)
1343 dec->apply_all_options();
1344 srd_session_start(srd_session_);
1349 // Create the session
1350 srd_session_new(&srd_session_);
1351 assert(srd_session_);
1353 // Create the decoders
1354 srd_decoder_inst *prev_di = nullptr;
1355 for (const shared_ptr<Decoder>& dec : stack_) {
1356 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1359 set_error_message(tr("Failed to create decoder instance"));
1360 srd_session_destroy(srd_session_);
1361 srd_session_ = nullptr;
1366 srd_inst_stack(srd_session_, prev_di, di);
1371 // Start the session
1372 if (segments_.size() > 0)
1373 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1374 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1376 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1377 DecodeSignal::annotation_callback, this);
1379 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
1380 DecodeSignal::binary_callback, this);
1382 srd_session_start(srd_session_);
1384 // We just recreated the srd session, so all stack changes are applied now
1385 stack_config_changed_ = false;
1388 void DecodeSignal::terminate_srd_session()
1390 // Call the "terminate and reset" routine for the decoder stack
1391 // (if available). This does not harm those stacks which already
1392 // have completed their operation, and reduces response time for
1393 // those stacks which still are processing data while the
1394 // application no longer wants them to.
1396 srd_session_terminate_reset(srd_session_);
1398 // Metadata is cleared also, so re-set it
1399 uint64_t samplerate = 0;
1400 if (segments_.size() > 0)
1401 samplerate = segments_.at(current_segment_id_).samplerate;
1403 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1404 g_variant_new_uint64(samplerate));
1405 for (const shared_ptr<Decoder>& dec : stack_)
1406 dec->apply_all_options();
1410 void DecodeSignal::stop_srd_session()
1413 // Destroy the session
1414 srd_session_destroy(srd_session_);
1415 srd_session_ = nullptr;
1417 // Mark the decoder instances as non-existant since they were deleted
1418 for (const shared_ptr<Decoder>& dec : stack_)
1419 dec->invalidate_decoder_inst();
1423 void DecodeSignal::connect_input_notifiers()
1425 // Disconnect the notification slot from the previous set of signals
1426 disconnect(this, SLOT(on_data_cleared()));
1427 disconnect(this, SLOT(on_data_received()));
1429 // Connect the currently used signals to our slot
1430 for (decode::DecodeChannel& ch : channels_) {
1431 if (!ch.assigned_signal)
1434 const data::SignalBase *signal = ch.assigned_signal.get();
1435 connect(signal, &data::SignalBase::samples_cleared,
1436 this, &DecodeSignal::on_data_cleared);
1437 connect(signal, &data::SignalBase::samples_added,
1438 this, &DecodeSignal::on_data_received);
1442 void DecodeSignal::create_decode_segment()
1444 // Create annotation segment
1445 segments_.emplace_back();
1447 // Add annotation classes
1448 for (const shared_ptr<Decoder>& dec : stack_)
1449 for (Row* row : dec->get_rows())
1450 segments_.back().annotation_rows.emplace(row, RowData(row));
1452 // Prepare our binary output classes
1453 for (const shared_ptr<Decoder>& dec : stack_) {
1454 uint32_t n = dec->get_binary_class_count();
1456 for (uint32_t i = 0; i < n; i++)
1457 segments_.back().binary_classes.push_back(
1458 {dec.get(), dec->get_binary_class(i), deque<DecodeBinaryDataChunk>()});
1462 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1465 assert(decode_signal);
1467 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1470 if (ds->decode_interrupt_)
1473 if (ds->segments_.empty())
1476 lock_guard<mutex> lock(ds->output_mutex_);
1478 // Get the decoder and the annotation data
1480 assert(pdata->pdo->di);
1481 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1484 const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data;
1488 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
1491 AnnotationClass* ann_class = dec->get_ann_class_by_id(pda->ann_class);
1493 qWarning() << "Decoder" << ds->display_name() << "wanted to add annotation" <<
1494 "with class ID" << pda->ann_class << "but there are only" <<
1495 dec->ann_classes().size() << "known classes";
1499 const Row* row = ann_class->row;
1502 row = dec->get_row_by_id(0);
1504 RowData& row_data = ds->segments_[ds->current_segment_id_].annotation_rows.at(row);
1506 // Add the annotation to the row
1507 const Annotation* ann = row_data.emplace_annotation(pdata);
1509 // We insert the annotation into the global annotation list in a way so that
1510 // the annotation list is sorted by start sample and length. Otherwise, we'd
1511 // have to sort the model, which is expensive
1512 deque<const Annotation*>& all_annotations =
1513 ds->segments_[ds->current_segment_id_].all_annotations;
1515 if (all_annotations.empty()) {
1516 all_annotations.emplace_back(ann);
1518 const uint64_t new_ann_len = (pdata->end_sample - pdata->start_sample);
1519 bool ann_has_earlier_start = (pdata->start_sample < all_annotations.back()->start_sample());
1520 bool ann_is_longer = (new_ann_len >
1521 (all_annotations.back()->end_sample() - all_annotations.back()->start_sample()));
1523 if (ann_has_earlier_start && ann_is_longer) {
1524 bool ann_has_same_start;
1525 auto it = all_annotations.end();
1529 ann_has_earlier_start = (pdata->start_sample < (*it)->start_sample());
1530 ann_has_same_start = (pdata->start_sample == (*it)->start_sample());
1531 ann_is_longer = (new_ann_len > (*it)->length());
1532 } while ((ann_has_earlier_start || (ann_has_same_start && ann_is_longer)) && (it != all_annotations.begin()));
1534 // Allow inserting at the front
1535 if (it != all_annotations.begin())
1538 all_annotations.emplace(it, ann);
1540 all_annotations.emplace_back(ann);
1543 // When emplace_annotation() inserts instead of appends an annotation,
1544 // the pointers in all_annotations that follow the inserted annotation and
1545 // point to annotations for this row are off by one and must be updated
1546 if (&(row_data.annotations().back()) != ann) {
1547 // Search backwards until we find the annotation we just added
1548 auto row_it = row_data.annotations().end();
1549 auto all_it = all_annotations.end();
1552 if ((*all_it)->row_data() == &row_data)
1554 } while (&(*row_it) != ann);
1556 // Update the annotation addresses for this row's annotations until the end
1558 if ((*all_it)->row_data() == &row_data) {
1559 *all_it = &(*row_it);
1563 } while (all_it != all_annotations.end());
1567 void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
1570 assert(decode_signal);
1572 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1575 if (ds->decode_interrupt_)
1578 // Get the decoder and the binary data
1580 assert(pdata->pdo->di);
1581 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1584 const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data;
1587 // Find the matching DecodeBinaryClass
1588 DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_));
1590 DecodeBinaryClass* bin_class = nullptr;
1591 for (DecodeBinaryClass& bc : segment->binary_classes)
1592 if ((bc.decoder->get_srd_decoder() == srd_dec) &&
1593 (bc.info->bin_class_id == (uint32_t)pdb->bin_class))
1597 qWarning() << "Could not find valid DecodeBinaryClass in segment" <<
1598 ds->current_segment_id_ << "for binary class ID" << pdb->bin_class <<
1599 ", segment only knows" << segment->binary_classes.size() << "classes";
1603 // Add the data chunk
1604 bin_class->chunks.emplace_back();
1605 DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back());
1607 chunk->sample = pdata->start_sample;
1608 chunk->data.resize(pdb->size);
1609 memcpy(chunk->data.data(), pdb->data, pdb->size);
1611 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
1613 ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class);
1616 void DecodeSignal::on_capture_state_changed(int state)
1618 // If a new acquisition was started, we need to start decoding from scratch
1619 if (state == Session::Running) {
1620 logic_mux_data_invalid_ = true;
1625 void DecodeSignal::on_data_cleared()
1630 void DecodeSignal::on_data_received()
1632 // If we detected a lack of input data when trying to start decoding,
1633 // we have set an error message. Only try again if we now have data
1635 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1638 error_message_.clear();
1639 // TODO Emulate noquote()
1640 qDebug().nospace() << name() << ": Error cleared";
1643 if (!logic_mux_thread_.joinable())
1646 logic_mux_cond_.notify_one();
1649 void DecodeSignal::on_annotation_visibility_changed()
1651 annotation_visibility_changed();