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::forward_list;
37 using std::lock_guard;
39 using std::make_shared;
41 using std::out_of_range;
42 using std::shared_ptr;
43 using std::unique_lock;
44 using pv::data::decode::Annotation;
45 using pv::data::decode::DecodeChannel;
46 using pv::data::decode::Decoder;
47 using pv::data::decode::Row;
52 const double DecodeSignal::DecodeMargin = 1.0;
53 const double DecodeSignal::DecodeThreshold = 0.2;
54 const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
57 DecodeSignal::DecodeSignal(pv::Session &session) :
58 SignalBase(nullptr, SignalBase::DecodeChannel),
60 srd_session_(nullptr),
61 logic_mux_data_invalid_(false),
62 stack_config_changed_(true),
63 current_segment_id_(0)
65 connect(&session_, SIGNAL(capture_state_changed(int)),
66 this, SLOT(on_capture_state_changed(int)));
69 DecodeSignal::~DecodeSignal()
74 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
79 void DecodeSignal::stack_decoder(const srd_decoder *decoder)
83 // Set name if this decoder is the first in the list or the name is unchanged
84 const srd_decoder* prev_dec =
85 stack_.empty() ? nullptr : stack_.back()->decoder();
86 const QString prev_dec_name =
87 prev_dec ? QString::fromUtf8(prev_dec->name) : QString();
89 if ((stack_.empty()) || ((stack_.size() > 0) && (name() == prev_dec_name)))
90 set_name(QString::fromUtf8(decoder->name));
92 const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
93 stack_.push_back(dec);
95 // Include the newly created decode channels in the channel lists
96 update_channel_list();
98 stack_config_changed_ = true;
99 auto_assign_signals(dec);
100 commit_decoder_channels();
102 decoder_stacked((void*)dec.get());
107 void DecodeSignal::remove_decoder(int index)
110 assert(index < (int)stack_.size());
112 // Find the decoder in the stack
113 auto iter = stack_.begin();
114 for (int i = 0; i < index; i++, iter++)
115 assert(iter != stack_.end());
117 decoder_removed(iter->get());
119 // Delete the element
122 // Update channels and decoded data
123 stack_config_changed_ = true;
124 update_channel_list();
128 bool DecodeSignal::toggle_decoder_visibility(int index)
130 auto iter = stack_.cbegin();
131 for (int i = 0; i < index; i++, iter++)
132 assert(iter != stack_.end());
134 shared_ptr<Decoder> dec = *iter;
136 // Toggle decoder visibility
139 state = !dec->shown();
146 void DecodeSignal::reset_decode(bool shutting_down)
148 if (stack_config_changed_ || shutting_down)
151 terminate_srd_session();
153 if (decode_thread_.joinable()) {
154 decode_interrupt_ = true;
155 decode_input_cond_.notify_one();
156 decode_thread_.join();
159 if (logic_mux_thread_.joinable()) {
160 logic_mux_interrupt_ = true;
161 logic_mux_cond_.notify_one();
162 logic_mux_thread_.join();
165 resume_decode(); // Make sure the decode thread isn't blocked by pausing
168 current_segment_id_ = 0;
171 logic_mux_data_.reset();
172 logic_mux_data_invalid_ = true;
174 if (!error_message_.isEmpty()) {
175 error_message_ = QString();
176 // TODO Emulate noquote()
177 qDebug().nospace() << name() << ": Error cleared";
183 void DecodeSignal::begin_decode()
185 if (decode_thread_.joinable()) {
186 decode_interrupt_ = true;
187 decode_input_cond_.notify_one();
188 decode_thread_.join();
191 if (logic_mux_thread_.joinable()) {
192 logic_mux_interrupt_ = true;
193 logic_mux_cond_.notify_one();
194 logic_mux_thread_.join();
199 if (stack_.size() == 0) {
200 set_error_message(tr("No decoders"));
204 assert(channels_.size() > 0);
206 if (get_assigned_signal_count() == 0) {
207 set_error_message(tr("There are no channels assigned to this decoder"));
211 // Make sure that all assigned channels still provide logic data
212 // (can happen when a converted signal was assigned but the
213 // conversion removed in the meanwhile)
214 for (decode::DecodeChannel& ch : channels_)
215 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
216 ch.assigned_signal = nullptr;
218 // Check that all decoders have the required channels
219 for (const shared_ptr<decode::Decoder>& dec : stack_)
220 if (!dec->have_required_channels()) {
221 set_error_message(tr("One or more required channels "
222 "have not been specified"));
226 // Map out all the annotation classes
228 for (const shared_ptr<decode::Decoder>& dec : stack_) {
230 const srd_decoder *const decc = dec->decoder();
231 assert(dec->decoder());
233 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
234 const srd_decoder_annotation_row *const ann_row =
235 (srd_decoder_annotation_row *)l->data;
238 const Row row(row_index++, decc, ann_row);
240 for (const GSList *ll = ann_row->ann_classes;
242 class_rows_[make_pair(decc,
243 GPOINTER_TO_INT(ll->data))] = row;
247 // Free the logic data and its segment(s) if it needs to be updated
248 if (logic_mux_data_invalid_)
249 logic_mux_data_.reset();
251 if (!logic_mux_data_) {
252 const uint32_t ch_count = get_assigned_signal_count();
253 logic_mux_unit_size_ = (ch_count + 7) / 8;
254 logic_mux_data_ = make_shared<Logic>(ch_count);
257 // Receive notifications when new sample data is available
258 connect_input_notifiers();
260 if (get_input_segment_count() == 0) {
261 set_error_message(tr("No input data"));
265 // Make sure the logic output data is complete and up-to-date
266 logic_mux_interrupt_ = false;
267 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
269 // Decode the muxed logic data
270 decode_interrupt_ = false;
271 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
274 void DecodeSignal::pause_decode()
276 decode_paused_ = true;
279 void DecodeSignal::resume_decode()
281 // Manual unlocking is done before notifying, to avoid waking up the
282 // waiting thread only to block again (see notify_one for details)
283 decode_pause_mutex_.unlock();
284 decode_pause_cond_.notify_one();
285 decode_paused_ = false;
288 bool DecodeSignal::is_paused() const
290 return decode_paused_;
293 QString DecodeSignal::error_message() const
295 lock_guard<mutex> lock(output_mutex_);
296 return error_message_;
299 const vector<decode::DecodeChannel> DecodeSignal::get_channels() const
304 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
306 bool new_assignment = false;
308 // Try to auto-select channels that don't have signals assigned yet
309 for (decode::DecodeChannel& ch : channels_) {
310 // If a decoder is given, auto-assign only its channels
311 if (dec && (ch.decoder_ != dec))
314 if (ch.assigned_signal)
317 QString ch_name = ch.name.toLower();
318 ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
320 shared_ptr<data::SignalBase> match;
321 for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
325 QString s_name = s->name().toLower();
326 s_name = s_name.replace(QRegExp("[-_.]"), " ");
328 if (s->logic_data() &&
329 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
333 // Only replace an existing match if it matches more characters
334 int old_unmatched = ch_name.length() - match->name().length();
335 int new_unmatched = ch_name.length() - s->name().length();
336 if (abs(new_unmatched) < abs(old_unmatched))
343 ch.assigned_signal = match.get();
344 new_assignment = true;
348 if (new_assignment) {
349 logic_mux_data_invalid_ = true;
350 stack_config_changed_ = true;
351 commit_decoder_channels();
356 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
358 for (decode::DecodeChannel& ch : channels_)
359 if (ch.id == channel_id) {
360 ch.assigned_signal = signal;
361 logic_mux_data_invalid_ = true;
364 stack_config_changed_ = true;
365 commit_decoder_channels();
370 int DecodeSignal::get_assigned_signal_count() const
372 // Count all channels that have a signal assigned to them
373 return count_if(channels_.begin(), channels_.end(),
374 [](decode::DecodeChannel ch) { return ch.assigned_signal; });
377 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
379 for (decode::DecodeChannel& ch : channels_)
380 if (ch.id == channel_id)
381 ch.initial_pin_state = init_state;
383 stack_config_changed_ = true;
388 double DecodeSignal::samplerate() const
392 // TODO For now, we simply return the first samplerate that we have
393 if (segments_.size() > 0)
394 result = segments_.front().samplerate;
399 const pv::util::Timestamp DecodeSignal::start_time() const
401 pv::util::Timestamp result;
403 // TODO For now, we simply return the first start time that we have
404 if (segments_.size() > 0)
405 result = segments_.front().start_time;
410 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
412 // The working sample count is the highest sample number for
413 // which all used signals have data available, so go through all
414 // channels and use the lowest overall sample count of the segment
416 int64_t count = std::numeric_limits<int64_t>::max();
417 bool no_signals_assigned = true;
419 for (const decode::DecodeChannel& ch : channels_)
420 if (ch.assigned_signal) {
421 no_signals_assigned = false;
423 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
424 if (!logic_data || logic_data->logic_segments().empty())
428 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
429 count = min(count, (int64_t)segment->get_sample_count());
430 } catch (out_of_range&) {
435 return (no_signals_assigned ? 0 : count);
438 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
439 bool include_processing) const
441 lock_guard<mutex> decode_lock(output_mutex_);
445 if (segment_id >= segments_.size())
448 if (include_processing)
449 result = segments_[segment_id].samples_decoded_incl;
451 result = segments_[segment_id].samples_decoded_excl;
456 vector<Row> DecodeSignal::get_rows(bool visible_only) const
458 lock_guard<mutex> lock(output_mutex_);
462 for (const shared_ptr<decode::Decoder>& dec : stack_) {
464 if (visible_only && !dec->shown())
467 const srd_decoder *const decc = dec->decoder();
468 assert(dec->decoder());
471 // Add a row for the decoder if it doesn't have a row list
472 if (!decc->annotation_rows)
473 rows.emplace_back(row_index++, decc);
475 // Add the decoder rows
476 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
477 const srd_decoder_annotation_row *const ann_row =
478 (srd_decoder_annotation_row *)l->data;
480 rows.emplace_back(row_index++, decc, ann_row);
487 void DecodeSignal::get_annotation_subset(
488 vector<pv::data::decode::Annotation> &dest,
489 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
490 uint64_t end_sample) const
492 lock_guard<mutex> lock(output_mutex_);
494 if (segment_id >= segments_.size())
497 const DecodeSegment *segment = &(segments_.at(segment_id));
498 const map<const decode::Row, decode::RowData> *rows =
499 &(segment->annotation_rows);
501 const auto iter = rows->find(row);
502 if (iter != rows->end())
503 (*iter).second.get_annotation_subset(dest, start_sample, end_sample);
506 void DecodeSignal::get_annotation_subset(
507 vector<pv::data::decode::Annotation> &dest,
508 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
510 // Note: We put all vectors and lists on the heap, not the stack
512 const vector<Row> rows = get_rows(true);
514 // Use forward_lists for faster merging
515 forward_list<Annotation> *all_ann_list = new forward_list<Annotation>();
517 for (const Row& row : rows) {
518 vector<Annotation> *ann_vector = new vector<Annotation>();
519 get_annotation_subset(*ann_vector, row, segment_id, start_sample, end_sample);
521 forward_list<Annotation> *ann_list =
522 new forward_list<Annotation>(ann_vector->begin(), ann_vector->end());
525 all_ann_list->merge(*ann_list);
529 move(all_ann_list->begin(), all_ann_list->end(), back_inserter(dest));
533 uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id,
534 const Decoder* dec, uint32_t bin_class_id) const
536 if (segments_.size() == 0)
540 const DecodeSegment *segment = &(segments_.at(segment_id));
542 for (const DecodeBinaryClass& bc : segment->binary_classes)
543 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
544 return bc.chunks.size();
545 } catch (out_of_range&) {
552 void DecodeSignal::get_binary_data_chunk(uint32_t segment_id,
553 const Decoder* dec, uint32_t bin_class_id, uint32_t chunk_id,
554 const vector<uint8_t> **dest, uint64_t *size)
557 const DecodeSegment *segment = &(segments_.at(segment_id));
559 for (const DecodeBinaryClass& bc : segment->binary_classes)
560 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) {
561 if (dest) *dest = &(bc.chunks.at(chunk_id).data);
562 if (size) *size = bc.chunks.at(chunk_id).data.size();
565 } catch (out_of_range&) {
570 void DecodeSignal::get_binary_data_chunks_merged(uint32_t segment_id,
571 const Decoder* dec, uint32_t bin_class_id, uint64_t start_sample,
572 uint64_t end_sample, vector<uint8_t> *dest) const
574 assert(dest != nullptr);
577 const DecodeSegment *segment = &(segments_.at(segment_id));
579 const DecodeBinaryClass* bin_class = nullptr;
580 for (const DecodeBinaryClass& bc : segment->binary_classes)
581 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
584 // Determine overall size before copying to resize dest vector only once
586 uint64_t matches = 0;
587 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
588 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
589 size += chunk.data.size();
595 uint64_t matches2 = 0;
596 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
597 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
598 memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size());
599 offset += chunk.data.size();
602 // Make sure we don't overwrite memory if the array grew in the meanwhile
603 if (matches2 == matches)
606 } catch (out_of_range&) {
611 const DecodeBinaryClass* DecodeSignal::get_binary_data_class(uint32_t segment_id,
612 const data::decode::Decoder* dec, uint32_t bin_class_id) const
615 const DecodeSegment *segment = &(segments_.at(segment_id));
617 for (const DecodeBinaryClass& bc : segment->binary_classes)
618 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
620 } catch (out_of_range&) {
627 void DecodeSignal::save_settings(QSettings &settings) const
629 SignalBase::save_settings(settings);
631 settings.setValue("decoders", (int)(stack_.size()));
633 // Save decoder stack
635 for (const shared_ptr<decode::Decoder>& decoder : stack_) {
636 settings.beginGroup("decoder" + QString::number(decoder_idx++));
638 settings.setValue("id", decoder->decoder()->id);
639 settings.setValue("shown", decoder->shown());
641 // Save decoder options
642 const map<string, GVariant*>& options = decoder->options();
644 settings.setValue("options", (int)options.size());
646 // Note: decode::Decoder::options() returns only the options
647 // that differ from the default. See binding::Decoder::getter()
649 for (auto& option : options) {
650 settings.beginGroup("option" + QString::number(i));
651 settings.setValue("name", QString::fromStdString(option.first));
652 GlobalSettings::store_gvariant(settings, option.second);
660 // Save channel mapping
661 settings.setValue("channels", (int)channels_.size());
663 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
664 auto channel = find_if(channels_.begin(), channels_.end(),
665 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
667 if (channel == channels_.end()) {
668 qDebug() << "ERROR: Gap in channel index:" << channel_id;
672 settings.beginGroup("channel" + QString::number(channel_id));
674 settings.setValue("name", channel->name); // Useful for debugging
675 settings.setValue("initial_pin_state", channel->initial_pin_state);
677 if (channel->assigned_signal)
678 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
684 void DecodeSignal::restore_settings(QSettings &settings)
686 SignalBase::restore_settings(settings);
688 // Restore decoder stack
689 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
691 int decoders = settings.value("decoders").toInt();
693 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
694 settings.beginGroup("decoder" + QString::number(decoder_idx));
696 QString id = settings.value("id").toString();
698 for (GSList *entry = dec_list; entry; entry = entry->next) {
699 const srd_decoder *dec = (srd_decoder*)entry->data;
703 if (QString::fromUtf8(dec->id) == id) {
704 shared_ptr<decode::Decoder> decoder =
705 make_shared<decode::Decoder>(dec);
707 stack_.push_back(decoder);
708 decoder->show(settings.value("shown", true).toBool());
710 // Restore decoder options that differ from their default
711 int options = settings.value("options").toInt();
713 for (int i = 0; i < options; i++) {
714 settings.beginGroup("option" + QString::number(i));
715 QString name = settings.value("name").toString();
716 GVariant *value = GlobalSettings::restore_gvariant(settings);
717 decoder->set_option(name.toUtf8(), value);
721 // Include the newly created decode channels in the channel lists
722 update_channel_list();
731 // Restore channel mapping
732 unsigned int channels = settings.value("channels").toInt();
734 const unordered_set< shared_ptr<data::SignalBase> > signalbases =
735 session_.signalbases();
737 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
738 auto channel = find_if(channels_.begin(), channels_.end(),
739 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
741 if (channel == channels_.end()) {
742 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
746 settings.beginGroup("channel" + QString::number(channel_id));
748 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
750 for (const shared_ptr<data::SignalBase>& signal : signalbases)
751 if (signal->name() == assigned_signal_name)
752 channel->assigned_signal = signal.get();
754 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
759 // Update the internal structures
760 stack_config_changed_ = true;
761 update_channel_list();
762 commit_decoder_channels();
767 void DecodeSignal::set_error_message(QString msg)
769 error_message_ = msg;
770 // TODO Emulate noquote()
771 qDebug().nospace() << name() << ": " << msg;
774 uint32_t DecodeSignal::get_input_segment_count() const
776 uint64_t count = std::numeric_limits<uint64_t>::max();
777 bool no_signals_assigned = true;
779 for (const decode::DecodeChannel& ch : channels_)
780 if (ch.assigned_signal) {
781 no_signals_assigned = false;
783 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
784 if (!logic_data || logic_data->logic_segments().empty())
787 // Find the min value of all segment counts
788 if ((uint64_t)(logic_data->logic_segments().size()) < count)
789 count = logic_data->logic_segments().size();
792 return (no_signals_assigned ? 0 : count);
795 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
797 double samplerate = 0;
799 for (const decode::DecodeChannel& ch : channels_)
800 if (ch.assigned_signal) {
801 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
802 if (!logic_data || logic_data->logic_segments().empty())
806 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
807 samplerate = segment->samplerate();
808 } catch (out_of_range&) {
817 void DecodeSignal::update_channel_list()
819 vector<decode::DecodeChannel> prev_channels = channels_;
824 // Copy existing entries, create new as needed
825 for (shared_ptr<Decoder>& decoder : stack_) {
826 const srd_decoder* srd_d = decoder->decoder();
829 // Mandatory channels
830 for (l = srd_d->channels; l; l = l->next) {
831 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
832 bool ch_added = false;
834 // Copy but update ID if this channel was in the list before
835 for (decode::DecodeChannel& ch : prev_channels)
836 if (ch.pdch_ == pdch) {
838 channels_.push_back(ch);
844 // Create new entry without a mapped signal
845 decode::DecodeChannel ch = {id++, 0, false, nullptr,
846 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
847 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
848 channels_.push_back(ch);
853 for (l = srd_d->opt_channels; l; l = l->next) {
854 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
855 bool ch_added = false;
857 // Copy but update ID if this channel was in the list before
858 for (decode::DecodeChannel& ch : prev_channels)
859 if (ch.pdch_ == pdch) {
861 channels_.push_back(ch);
867 // Create new entry without a mapped signal
868 decode::DecodeChannel ch = {id++, 0, true, nullptr,
869 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
870 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
871 channels_.push_back(ch);
876 // Invalidate the logic output data if the channel assignment changed
877 if (prev_channels.size() != channels_.size()) {
878 // The number of channels changed, there's definitely a difference
879 logic_mux_data_invalid_ = true;
881 // Same number but assignment may still differ, so compare all channels
882 for (size_t i = 0; i < channels_.size(); i++) {
883 const decode::DecodeChannel& p_ch = prev_channels[i];
884 const decode::DecodeChannel& ch = channels_[i];
886 if ((p_ch.pdch_ != ch.pdch_) ||
887 (p_ch.assigned_signal != ch.assigned_signal)) {
888 logic_mux_data_invalid_ = true;
898 void DecodeSignal::commit_decoder_channels()
900 // Submit channel list to every decoder, containing only the relevant channels
901 for (shared_ptr<decode::Decoder> dec : stack_) {
902 vector<decode::DecodeChannel*> channel_list;
904 for (decode::DecodeChannel& ch : channels_)
905 if (ch.decoder_ == dec)
906 channel_list.push_back(&ch);
908 dec->set_channels(channel_list);
911 // Channel bit IDs must be in sync with the channel's apperance in channels_
913 for (decode::DecodeChannel& ch : channels_)
914 if (ch.assigned_signal)
918 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
920 // Enforce end to be greater than start
924 // Fetch the channel segments and their data
925 vector<shared_ptr<LogicSegment> > segments;
926 vector<const uint8_t*> signal_data;
927 vector<uint8_t> signal_in_bytepos;
928 vector<uint8_t> signal_in_bitpos;
930 for (decode::DecodeChannel& ch : channels_)
931 if (ch.assigned_signal) {
932 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
934 shared_ptr<LogicSegment> segment;
936 segment = logic_data->logic_segments().at(segment_id);
937 } catch (out_of_range&) {
938 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
939 << "has no logic segment" << segment_id;
942 segments.push_back(segment);
944 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
945 segment->get_samples(start, end, data);
946 signal_data.push_back(data);
948 const int bitpos = ch.assigned_signal->logic_bit_index();
949 signal_in_bytepos.push_back(bitpos / 8);
950 signal_in_bitpos.push_back(bitpos % 8);
954 shared_ptr<LogicSegment> output_segment;
956 output_segment = logic_mux_data_->logic_segments().at(segment_id);
957 } catch (out_of_range&) {
958 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
959 << segment_id << "in mux_logic_samples(), mux segments size is" \
960 << logic_mux_data_->logic_segments().size();
964 // Perform the muxing of signal data into the output data
965 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
966 unsigned int signal_count = signal_data.size();
968 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
974 const int out_sample_pos = sample_cnt * output_segment->unit_size();
975 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
976 output[out_sample_pos + i] = 0;
978 for (unsigned int i = 0; i < signal_count; i++) {
979 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
980 const uint8_t in_sample = 1 &
981 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
983 const uint8_t out_sample = output[out_sample_pos + bytepos];
985 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
995 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
998 for (const uint8_t* data : signal_data)
1002 void DecodeSignal::logic_mux_proc()
1004 uint32_t segment_id = 0;
1006 assert(logic_mux_data_);
1008 // Create initial logic mux segment
1009 shared_ptr<LogicSegment> output_segment =
1010 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1011 logic_mux_unit_size_, 0);
1012 logic_mux_data_->push_segment(output_segment);
1014 output_segment->set_samplerate(get_input_samplerate(0));
1017 const uint64_t input_sample_count = get_working_sample_count(segment_id);
1018 const uint64_t output_sample_count = output_segment->get_sample_count();
1020 const uint64_t samples_to_process =
1021 (input_sample_count > output_sample_count) ?
1022 (input_sample_count - output_sample_count) : 0;
1024 // Process the samples if necessary...
1025 if (samples_to_process > 0) {
1026 const uint64_t unit_size = output_segment->unit_size();
1027 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
1029 uint64_t processed_samples = 0;
1031 const uint64_t start_sample = output_sample_count + processed_samples;
1032 const uint64_t sample_count =
1033 min(samples_to_process - processed_samples, chunk_sample_count);
1035 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
1036 processed_samples += sample_count;
1038 // ...and process the newly muxed logic data
1039 decode_input_cond_.notify_one();
1040 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
1043 if (samples_to_process == 0) {
1044 // TODO Optimize this by caching the input segment count and only
1045 // querying it when the cached value was reached
1046 if (segment_id < get_input_segment_count() - 1) {
1047 // Process next segment
1051 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1052 logic_mux_unit_size_, 0);
1053 logic_mux_data_->push_segment(output_segment);
1055 output_segment->set_samplerate(get_input_samplerate(segment_id));
1058 // All segments have been processed
1059 logic_mux_data_invalid_ = false;
1061 // Wait for more input
1062 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1063 logic_mux_cond_.wait(logic_mux_lock);
1067 } while (!logic_mux_interrupt_);
1070 void DecodeSignal::decode_data(
1071 const int64_t abs_start_samplenum, const int64_t sample_count,
1072 const shared_ptr<LogicSegment> input_segment)
1074 const int64_t unit_size = input_segment->unit_size();
1075 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
1077 for (int64_t i = abs_start_samplenum;
1078 error_message_.isEmpty() && !decode_interrupt_ &&
1079 (i < (abs_start_samplenum + sample_count));
1080 i += chunk_sample_count) {
1082 const int64_t chunk_end = min(i + chunk_sample_count,
1083 abs_start_samplenum + sample_count);
1086 lock_guard<mutex> lock(output_mutex_);
1087 // Update the sample count showing the samples including currently processed ones
1088 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
1091 int64_t data_size = (chunk_end - i) * unit_size;
1092 uint8_t* chunk = new uint8_t[data_size];
1093 input_segment->get_samples(i, chunk_end, chunk);
1095 if (srd_session_send(srd_session_, i, chunk_end, chunk,
1096 data_size, unit_size) != SRD_OK)
1097 set_error_message(tr("Decoder reported an error"));
1102 lock_guard<mutex> lock(output_mutex_);
1103 // Now that all samples are processed, the exclusive sample count catches up
1104 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1107 // Notify the frontend that we processed some data and
1108 // possibly have new annotations as well
1111 if (decode_paused_) {
1112 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1113 decode_pause_cond_.wait(pause_wait_lock);
1118 void DecodeSignal::decode_proc()
1120 current_segment_id_ = 0;
1122 // If there is no input data available yet, wait until it is or we're interrupted
1123 if (logic_mux_data_->logic_segments().size() == 0) {
1124 unique_lock<mutex> input_wait_lock(input_mutex_);
1125 decode_input_cond_.wait(input_wait_lock);
1128 if (decode_interrupt_)
1131 shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
1132 assert(input_segment);
1134 // Create the initial segment and set its sample rate so that we can pass it to SRD
1135 create_decode_segment();
1136 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1137 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1139 start_srd_session();
1141 uint64_t sample_count = 0;
1142 uint64_t abs_start_samplenum = 0;
1144 // Keep processing new samples until we exhaust the input data
1146 lock_guard<mutex> input_lock(input_mutex_);
1147 sample_count = input_segment->get_sample_count() - abs_start_samplenum;
1149 if (sample_count > 0) {
1150 decode_data(abs_start_samplenum, sample_count, input_segment);
1151 abs_start_samplenum += sample_count;
1153 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
1155 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
1156 if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
1157 // Process next segment
1158 current_segment_id_++;
1161 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1162 } catch (out_of_range&) {
1163 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1164 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1165 << logic_mux_data_->logic_segments().size();
1168 abs_start_samplenum = 0;
1170 // Create the next segment and set its metadata
1171 create_decode_segment();
1172 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1173 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1175 // Reset decoder state but keep the decoder stack intact
1176 terminate_srd_session();
1178 // All segments have been processed
1181 // Wait for new input data or an interrupt was requested
1182 unique_lock<mutex> input_wait_lock(input_mutex_);
1183 decode_input_cond_.wait(input_wait_lock);
1186 } while (error_message_.isEmpty() && !decode_interrupt_);
1188 // Potentially reap decoders when the application no longer is
1189 // interested in their (pending) results.
1190 if (decode_interrupt_)
1191 terminate_srd_session();
1194 void DecodeSignal::start_srd_session()
1196 // If there were stack changes, the session has been destroyed by now, so if
1197 // it hasn't been destroyed, we can just reset and re-use it
1199 // When a decoder stack was created before, re-use it
1200 // for the next stream of input data, after terminating
1201 // potentially still executing operations, and resetting
1202 // internal state. Skip the rather expensive (teardown
1203 // and) construction of another decoder stack.
1205 // TODO Reduce redundancy, use a common code path for
1206 // the meta/start sequence?
1207 terminate_srd_session();
1209 // Metadata is cleared also, so re-set it
1210 uint64_t samplerate = 0;
1211 if (segments_.size() > 0)
1212 samplerate = segments_.at(current_segment_id_).samplerate;
1214 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1215 g_variant_new_uint64(samplerate));
1216 for (const shared_ptr<decode::Decoder>& dec : stack_)
1217 dec->apply_all_options();
1218 srd_session_start(srd_session_);
1223 // Create the session
1224 srd_session_new(&srd_session_);
1225 assert(srd_session_);
1227 // Create the decoders
1228 srd_decoder_inst *prev_di = nullptr;
1229 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1230 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1233 set_error_message(tr("Failed to create decoder instance"));
1234 srd_session_destroy(srd_session_);
1235 srd_session_ = nullptr;
1240 srd_inst_stack(srd_session_, prev_di, di);
1245 // Start the session
1246 if (segments_.size() > 0)
1247 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1248 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1250 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1251 DecodeSignal::annotation_callback, this);
1253 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
1254 DecodeSignal::binary_callback, this);
1256 srd_session_start(srd_session_);
1258 // We just recreated the srd session, so all stack changes are applied now
1259 stack_config_changed_ = false;
1262 void DecodeSignal::terminate_srd_session()
1264 // Call the "terminate and reset" routine for the decoder stack
1265 // (if available). This does not harm those stacks which already
1266 // have completed their operation, and reduces response time for
1267 // those stacks which still are processing data while the
1268 // application no longer wants them to.
1270 srd_session_terminate_reset(srd_session_);
1272 // Metadata is cleared also, so re-set it
1273 uint64_t samplerate = 0;
1274 if (segments_.size() > 0)
1275 samplerate = segments_.at(current_segment_id_).samplerate;
1277 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1278 g_variant_new_uint64(samplerate));
1279 for (const shared_ptr<decode::Decoder>& dec : stack_)
1280 dec->apply_all_options();
1284 void DecodeSignal::stop_srd_session()
1287 // Destroy the session
1288 srd_session_destroy(srd_session_);
1289 srd_session_ = nullptr;
1291 // Mark the decoder instances as non-existant since they were deleted
1292 for (const shared_ptr<decode::Decoder>& dec : stack_)
1293 dec->invalidate_decoder_inst();
1297 void DecodeSignal::connect_input_notifiers()
1299 // Disconnect the notification slot from the previous set of signals
1300 disconnect(this, SLOT(on_data_cleared()));
1301 disconnect(this, SLOT(on_data_received()));
1303 // Connect the currently used signals to our slot
1304 for (decode::DecodeChannel& ch : channels_) {
1305 if (!ch.assigned_signal)
1308 const data::SignalBase *signal = ch.assigned_signal;
1309 connect(signal, SIGNAL(samples_cleared()),
1310 this, SLOT(on_data_cleared()));
1311 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1312 this, SLOT(on_data_received()));
1316 void DecodeSignal::create_decode_segment()
1318 // Create annotation segment
1319 segments_.emplace_back(DecodeSegment());
1321 // Add annotation classes
1322 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1324 const srd_decoder *const decc = dec->decoder();
1325 assert(dec->decoder());
1328 // Add a row for the decoder if it doesn't have a row list
1329 if (!decc->annotation_rows)
1330 (segments_.back().annotation_rows)[Row(row_index++, decc)] =
1333 // Add the decoder rows
1334 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
1335 const srd_decoder_annotation_row *const ann_row =
1336 (srd_decoder_annotation_row *)l->data;
1339 const Row row(row_index++, decc, ann_row);
1341 // Add a new empty row data object
1342 (segments_.back().annotation_rows)[row] =
1347 // Prepare our binary output classes
1348 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1349 uint32_t n = dec->get_binary_class_count();
1351 for (uint32_t i = 0; i < n; i++)
1352 segments_.back().binary_classes.push_back(
1353 {dec.get(), dec->get_binary_class(i), deque<DecodeBinaryDataChunk>()});
1357 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1360 assert(decode_signal);
1362 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1365 if (ds->decode_interrupt_)
1368 lock_guard<mutex> lock(ds->output_mutex_);
1370 // Get the decoder and the annotation data
1372 assert(pdata->pdo->di);
1373 const srd_decoder *const decc = pdata->pdo->di->decoder;
1376 const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data;
1380 auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end();
1382 // Try finding a better row match than the default by looking up the sub-row of this class
1383 const auto format = pda->ann_class;
1384 const auto r = ds->class_rows_.find(make_pair(decc, format));
1385 if (r != ds->class_rows_.end())
1386 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second);
1388 // Failing that, use the decoder as a key
1389 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(0, decc));
1392 if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) {
1393 qDebug() << "Unexpected annotation: decoder = " << decc <<
1394 ", format = " << format;
1399 // Add the annotation
1400 (*row_iter).second.emplace_annotation(pdata, &((*row_iter).first));
1403 void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
1406 assert(decode_signal);
1408 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1411 if (ds->decode_interrupt_)
1414 // Get the decoder and the binary data
1416 assert(pdata->pdo->di);
1417 const srd_decoder *const decc = pdata->pdo->di->decoder;
1420 const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data;
1423 // Find the matching DecodeBinaryClass
1424 DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_));
1426 DecodeBinaryClass* bin_class = nullptr;
1427 for (DecodeBinaryClass& bc : segment->binary_classes)
1428 if ((bc.decoder->decoder() == decc) && (bc.info->bin_class_id == (uint32_t)pdb->bin_class))
1432 qWarning() << "Could not find valid DecodeBinaryClass in segment" <<
1433 ds->current_segment_id_ << "for binary class ID" << pdb->bin_class <<
1434 ", segment only knows" << segment->binary_classes.size() << "classes";
1438 // Add the data chunk
1439 bin_class->chunks.emplace_back();
1440 DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back());
1442 chunk->sample = pdata->start_sample;
1443 chunk->data.resize(pdb->size);
1444 memcpy(chunk->data.data(), pdb->data, pdb->size);
1446 // Find decoder class instance
1447 Decoder* dec = nullptr;
1448 for (const shared_ptr<decode::Decoder>& d : ds->decoder_stack())
1449 if (d->decoder() == decc) {
1454 ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class);
1457 void DecodeSignal::on_capture_state_changed(int state)
1459 // If a new acquisition was started, we need to start decoding from scratch
1460 if (state == Session::Running) {
1461 logic_mux_data_invalid_ = true;
1466 void DecodeSignal::on_data_cleared()
1471 void DecodeSignal::on_data_received()
1473 // If we detected a lack of input data when trying to start decoding,
1474 // we have set an error message. Only try again if we now have data
1476 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1479 if (!logic_mux_thread_.joinable())
1482 logic_mux_cond_.notify_one();