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_);
446 const DecodeSegment *segment = &(segments_.at(segment_id));
447 if (include_processing)
448 result = segment->samples_decoded_incl;
450 result = segment->samples_decoded_excl;
451 } catch (out_of_range&) {
458 vector<Row> DecodeSignal::get_rows(bool visible_only) const
460 lock_guard<mutex> lock(output_mutex_);
464 for (const shared_ptr<decode::Decoder>& dec : stack_) {
466 if (visible_only && !dec->shown())
469 const srd_decoder *const decc = dec->decoder();
470 assert(dec->decoder());
473 // Add a row for the decoder if it doesn't have a row list
474 if (!decc->annotation_rows)
475 rows.emplace_back(row_index++, decc);
477 // Add the decoder rows
478 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
479 const srd_decoder_annotation_row *const ann_row =
480 (srd_decoder_annotation_row *)l->data;
482 rows.emplace_back(row_index++, decc, ann_row);
489 void DecodeSignal::get_annotation_subset(
490 vector<pv::data::decode::Annotation> &dest,
491 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
492 uint64_t end_sample) const
494 lock_guard<mutex> lock(output_mutex_);
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,
504 start_sample, end_sample);
505 } catch (out_of_range&) {
510 void DecodeSignal::get_annotation_subset(
511 vector<pv::data::decode::Annotation> &dest,
512 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
514 // Note: We put all vectors and lists on the heap, not the stack
516 const vector<Row> rows = get_rows(true);
518 // Use forward_lists for faster merging
519 forward_list<Annotation> *all_ann_list = new forward_list<Annotation>();
521 for (const Row& row : rows) {
522 vector<Annotation> *ann_vector = new vector<Annotation>();
523 get_annotation_subset(*ann_vector, row, segment_id, start_sample, end_sample);
525 forward_list<Annotation> *ann_list =
526 new forward_list<Annotation>(ann_vector->begin(), ann_vector->end());
529 all_ann_list->merge(*ann_list);
533 move(all_ann_list->begin(), all_ann_list->end(), back_inserter(dest));
537 uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id,
538 const Decoder* dec, uint8_t bin_class_id) const
541 const DecodeSegment *segment = &(segments_.at(segment_id));
543 for (const DecodeBinaryClass& bc : segment->binary_classes)
544 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
545 return bc.chunks.size();
546 } catch (out_of_range&) {
553 void DecodeSignal::get_binary_data_chunk(uint32_t segment_id,
554 const Decoder* dec, uint8_t bin_class_id, uint32_t chunk_id,
555 const vector<uint8_t> **dest, uint64_t *size)
558 const DecodeSegment *segment = &(segments_.at(segment_id));
560 for (const DecodeBinaryClass& bc : segment->binary_classes)
561 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) {
562 if (dest) *dest = &(bc.chunks.at(chunk_id).data);
563 if (size) *size = bc.chunks.at(chunk_id).data.size();
566 } catch (out_of_range&) {
571 void DecodeSignal::get_binary_data_chunks_merged(uint32_t segment_id,
572 const Decoder* dec, uint8_t bin_class_id, uint64_t start_sample,
573 uint64_t end_sample, vector<uint8_t> *dest) const
575 assert(dest != nullptr);
578 const DecodeSegment *segment = &(segments_.at(segment_id));
580 const DecodeBinaryClass* bin_class = nullptr;
581 for (const DecodeBinaryClass& bc : segment->binary_classes)
582 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
585 // Determine overall size before copying to resize dest vector only once
587 uint64_t matches = 0;
588 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
589 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
590 size += chunk.data.size();
596 uint64_t matches2 = 0;
597 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
598 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
599 memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size());
600 offset += chunk.data.size();
603 // Make sure we don't overwrite memory if the array grew in the meanwhile
604 if (matches2 == matches)
607 } catch (out_of_range&) {
613 void DecodeSignal::save_settings(QSettings &settings) const
615 SignalBase::save_settings(settings);
617 settings.setValue("decoders", (int)(stack_.size()));
619 // Save decoder stack
621 for (const shared_ptr<decode::Decoder>& decoder : stack_) {
622 settings.beginGroup("decoder" + QString::number(decoder_idx++));
624 settings.setValue("id", decoder->decoder()->id);
625 settings.setValue("shown", decoder->shown());
627 // Save decoder options
628 const map<string, GVariant*>& options = decoder->options();
630 settings.setValue("options", (int)options.size());
632 // Note: decode::Decoder::options() returns only the options
633 // that differ from the default. See binding::Decoder::getter()
635 for (auto& option : options) {
636 settings.beginGroup("option" + QString::number(i));
637 settings.setValue("name", QString::fromStdString(option.first));
638 GlobalSettings::store_gvariant(settings, option.second);
646 // Save channel mapping
647 settings.setValue("channels", (int)channels_.size());
649 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
650 auto channel = find_if(channels_.begin(), channels_.end(),
651 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
653 if (channel == channels_.end()) {
654 qDebug() << "ERROR: Gap in channel index:" << channel_id;
658 settings.beginGroup("channel" + QString::number(channel_id));
660 settings.setValue("name", channel->name); // Useful for debugging
661 settings.setValue("initial_pin_state", channel->initial_pin_state);
663 if (channel->assigned_signal)
664 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
670 void DecodeSignal::restore_settings(QSettings &settings)
672 SignalBase::restore_settings(settings);
674 // Restore decoder stack
675 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
677 int decoders = settings.value("decoders").toInt();
679 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
680 settings.beginGroup("decoder" + QString::number(decoder_idx));
682 QString id = settings.value("id").toString();
684 for (GSList *entry = dec_list; entry; entry = entry->next) {
685 const srd_decoder *dec = (srd_decoder*)entry->data;
689 if (QString::fromUtf8(dec->id) == id) {
690 shared_ptr<decode::Decoder> decoder =
691 make_shared<decode::Decoder>(dec);
693 stack_.push_back(decoder);
694 decoder->show(settings.value("shown", true).toBool());
696 // Restore decoder options that differ from their default
697 int options = settings.value("options").toInt();
699 for (int i = 0; i < options; i++) {
700 settings.beginGroup("option" + QString::number(i));
701 QString name = settings.value("name").toString();
702 GVariant *value = GlobalSettings::restore_gvariant(settings);
703 decoder->set_option(name.toUtf8(), value);
707 // Include the newly created decode channels in the channel lists
708 update_channel_list();
717 // Restore channel mapping
718 unsigned int channels = settings.value("channels").toInt();
720 const unordered_set< shared_ptr<data::SignalBase> > signalbases =
721 session_.signalbases();
723 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
724 auto channel = find_if(channels_.begin(), channels_.end(),
725 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
727 if (channel == channels_.end()) {
728 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
732 settings.beginGroup("channel" + QString::number(channel_id));
734 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
736 for (const shared_ptr<data::SignalBase>& signal : signalbases)
737 if (signal->name() == assigned_signal_name)
738 channel->assigned_signal = signal.get();
740 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
745 // Update the internal structures
746 stack_config_changed_ = true;
747 update_channel_list();
748 commit_decoder_channels();
753 void DecodeSignal::set_error_message(QString msg)
755 error_message_ = msg;
756 // TODO Emulate noquote()
757 qDebug().nospace() << name() << ": " << msg;
760 uint32_t DecodeSignal::get_input_segment_count() const
762 uint64_t count = std::numeric_limits<uint64_t>::max();
763 bool no_signals_assigned = true;
765 for (const decode::DecodeChannel& ch : channels_)
766 if (ch.assigned_signal) {
767 no_signals_assigned = false;
769 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
770 if (!logic_data || logic_data->logic_segments().empty())
773 // Find the min value of all segment counts
774 if ((uint64_t)(logic_data->logic_segments().size()) < count)
775 count = logic_data->logic_segments().size();
778 return (no_signals_assigned ? 0 : count);
781 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
783 double samplerate = 0;
785 for (const decode::DecodeChannel& ch : channels_)
786 if (ch.assigned_signal) {
787 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
788 if (!logic_data || logic_data->logic_segments().empty())
792 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
793 samplerate = segment->samplerate();
794 } catch (out_of_range&) {
803 void DecodeSignal::update_channel_list()
805 vector<decode::DecodeChannel> prev_channels = channels_;
810 // Copy existing entries, create new as needed
811 for (shared_ptr<Decoder>& decoder : stack_) {
812 const srd_decoder* srd_d = decoder->decoder();
815 // Mandatory channels
816 for (l = srd_d->channels; l; l = l->next) {
817 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
818 bool ch_added = false;
820 // Copy but update ID if this channel was in the list before
821 for (decode::DecodeChannel& ch : prev_channels)
822 if (ch.pdch_ == pdch) {
824 channels_.push_back(ch);
830 // Create new entry without a mapped signal
831 decode::DecodeChannel ch = {id++, 0, false, nullptr,
832 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
833 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
834 channels_.push_back(ch);
839 for (l = srd_d->opt_channels; l; l = l->next) {
840 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
841 bool ch_added = false;
843 // Copy but update ID if this channel was in the list before
844 for (decode::DecodeChannel& ch : prev_channels)
845 if (ch.pdch_ == pdch) {
847 channels_.push_back(ch);
853 // Create new entry without a mapped signal
854 decode::DecodeChannel ch = {id++, 0, true, nullptr,
855 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
856 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
857 channels_.push_back(ch);
862 // Invalidate the logic output data if the channel assignment changed
863 if (prev_channels.size() != channels_.size()) {
864 // The number of channels changed, there's definitely a difference
865 logic_mux_data_invalid_ = true;
867 // Same number but assignment may still differ, so compare all channels
868 for (size_t i = 0; i < channels_.size(); i++) {
869 const decode::DecodeChannel& p_ch = prev_channels[i];
870 const decode::DecodeChannel& ch = channels_[i];
872 if ((p_ch.pdch_ != ch.pdch_) ||
873 (p_ch.assigned_signal != ch.assigned_signal)) {
874 logic_mux_data_invalid_ = true;
884 void DecodeSignal::commit_decoder_channels()
886 // Submit channel list to every decoder, containing only the relevant channels
887 for (shared_ptr<decode::Decoder> dec : stack_) {
888 vector<decode::DecodeChannel*> channel_list;
890 for (decode::DecodeChannel& ch : channels_)
891 if (ch.decoder_ == dec)
892 channel_list.push_back(&ch);
894 dec->set_channels(channel_list);
897 // Channel bit IDs must be in sync with the channel's apperance in channels_
899 for (decode::DecodeChannel& ch : channels_)
900 if (ch.assigned_signal)
904 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
906 // Enforce end to be greater than start
910 // Fetch the channel segments and their data
911 vector<shared_ptr<LogicSegment> > segments;
912 vector<const uint8_t*> signal_data;
913 vector<uint8_t> signal_in_bytepos;
914 vector<uint8_t> signal_in_bitpos;
916 for (decode::DecodeChannel& ch : channels_)
917 if (ch.assigned_signal) {
918 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
920 shared_ptr<LogicSegment> segment;
922 segment = logic_data->logic_segments().at(segment_id);
923 } catch (out_of_range&) {
924 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
925 << "has no logic segment" << segment_id;
928 segments.push_back(segment);
930 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
931 segment->get_samples(start, end, data);
932 signal_data.push_back(data);
934 const int bitpos = ch.assigned_signal->logic_bit_index();
935 signal_in_bytepos.push_back(bitpos / 8);
936 signal_in_bitpos.push_back(bitpos % 8);
940 shared_ptr<LogicSegment> output_segment;
942 output_segment = logic_mux_data_->logic_segments().at(segment_id);
943 } catch (out_of_range&) {
944 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
945 << segment_id << "in mux_logic_samples(), mux segments size is" \
946 << logic_mux_data_->logic_segments().size();
950 // Perform the muxing of signal data into the output data
951 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
952 unsigned int signal_count = signal_data.size();
954 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
960 const int out_sample_pos = sample_cnt * output_segment->unit_size();
961 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
962 output[out_sample_pos + i] = 0;
964 for (unsigned int i = 0; i < signal_count; i++) {
965 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
966 const uint8_t in_sample = 1 &
967 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
969 const uint8_t out_sample = output[out_sample_pos + bytepos];
971 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
981 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
984 for (const uint8_t* data : signal_data)
988 void DecodeSignal::logic_mux_proc()
990 uint32_t segment_id = 0;
992 assert(logic_mux_data_);
994 // Create initial logic mux segment
995 shared_ptr<LogicSegment> output_segment =
996 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
997 logic_mux_unit_size_, 0);
998 logic_mux_data_->push_segment(output_segment);
1000 output_segment->set_samplerate(get_input_samplerate(0));
1003 const uint64_t input_sample_count = get_working_sample_count(segment_id);
1004 const uint64_t output_sample_count = output_segment->get_sample_count();
1006 const uint64_t samples_to_process =
1007 (input_sample_count > output_sample_count) ?
1008 (input_sample_count - output_sample_count) : 0;
1010 // Process the samples if necessary...
1011 if (samples_to_process > 0) {
1012 const uint64_t unit_size = output_segment->unit_size();
1013 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
1015 uint64_t processed_samples = 0;
1017 const uint64_t start_sample = output_sample_count + processed_samples;
1018 const uint64_t sample_count =
1019 min(samples_to_process - processed_samples, chunk_sample_count);
1021 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
1022 processed_samples += sample_count;
1024 // ...and process the newly muxed logic data
1025 decode_input_cond_.notify_one();
1026 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
1029 if (samples_to_process == 0) {
1030 // TODO Optimize this by caching the input segment count and only
1031 // querying it when the cached value was reached
1032 if (segment_id < get_input_segment_count() - 1) {
1033 // Process next segment
1037 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1038 logic_mux_unit_size_, 0);
1039 logic_mux_data_->push_segment(output_segment);
1041 output_segment->set_samplerate(get_input_samplerate(segment_id));
1044 // All segments have been processed
1045 logic_mux_data_invalid_ = false;
1047 // Wait for more input
1048 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1049 logic_mux_cond_.wait(logic_mux_lock);
1053 } while (!logic_mux_interrupt_);
1056 void DecodeSignal::decode_data(
1057 const int64_t abs_start_samplenum, const int64_t sample_count,
1058 const shared_ptr<LogicSegment> input_segment)
1060 const int64_t unit_size = input_segment->unit_size();
1061 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
1063 for (int64_t i = abs_start_samplenum;
1064 error_message_.isEmpty() && !decode_interrupt_ &&
1065 (i < (abs_start_samplenum + sample_count));
1066 i += chunk_sample_count) {
1068 const int64_t chunk_end = min(i + chunk_sample_count,
1069 abs_start_samplenum + sample_count);
1072 lock_guard<mutex> lock(output_mutex_);
1073 // Update the sample count showing the samples including currently processed ones
1074 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
1077 int64_t data_size = (chunk_end - i) * unit_size;
1078 uint8_t* chunk = new uint8_t[data_size];
1079 input_segment->get_samples(i, chunk_end, chunk);
1081 if (srd_session_send(srd_session_, i, chunk_end, chunk,
1082 data_size, unit_size) != SRD_OK)
1083 set_error_message(tr("Decoder reported an error"));
1088 lock_guard<mutex> lock(output_mutex_);
1089 // Now that all samples are processed, the exclusive sample count catches up
1090 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1093 // Notify the frontend that we processed some data and
1094 // possibly have new annotations as well
1097 if (decode_paused_) {
1098 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1099 decode_pause_cond_.wait(pause_wait_lock);
1104 void DecodeSignal::decode_proc()
1106 current_segment_id_ = 0;
1108 // If there is no input data available yet, wait until it is or we're interrupted
1109 if (logic_mux_data_->logic_segments().size() == 0) {
1110 unique_lock<mutex> input_wait_lock(input_mutex_);
1111 decode_input_cond_.wait(input_wait_lock);
1114 if (decode_interrupt_)
1117 shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
1118 assert(input_segment);
1120 // Create the initial segment and set its sample rate so that we can pass it to SRD
1121 create_decode_segment();
1122 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1123 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1125 start_srd_session();
1127 uint64_t sample_count = 0;
1128 uint64_t abs_start_samplenum = 0;
1130 // Keep processing new samples until we exhaust the input data
1132 lock_guard<mutex> input_lock(input_mutex_);
1133 sample_count = input_segment->get_sample_count() - abs_start_samplenum;
1135 if (sample_count > 0) {
1136 decode_data(abs_start_samplenum, sample_count, input_segment);
1137 abs_start_samplenum += sample_count;
1139 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
1141 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
1142 if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
1143 // Process next segment
1144 current_segment_id_++;
1147 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1148 } catch (out_of_range&) {
1149 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1150 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1151 << logic_mux_data_->logic_segments().size();
1154 abs_start_samplenum = 0;
1156 // Create the next segment and set its metadata
1157 create_decode_segment();
1158 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1159 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1161 // Reset decoder state but keep the decoder stack intact
1162 terminate_srd_session();
1164 // All segments have been processed
1167 // Wait for new input data or an interrupt was requested
1168 unique_lock<mutex> input_wait_lock(input_mutex_);
1169 decode_input_cond_.wait(input_wait_lock);
1172 } while (error_message_.isEmpty() && !decode_interrupt_);
1174 // Potentially reap decoders when the application no longer is
1175 // interested in their (pending) results.
1176 if (decode_interrupt_)
1177 terminate_srd_session();
1180 void DecodeSignal::start_srd_session()
1182 // If there were stack changes, the session has been destroyed by now, so if
1183 // it hasn't been destroyed, we can just reset and re-use it
1185 // When a decoder stack was created before, re-use it
1186 // for the next stream of input data, after terminating
1187 // potentially still executing operations, and resetting
1188 // internal state. Skip the rather expensive (teardown
1189 // and) construction of another decoder stack.
1191 // TODO Reduce redundancy, use a common code path for
1192 // the meta/start sequence?
1193 terminate_srd_session();
1195 // Metadata is cleared also, so re-set it
1196 uint64_t samplerate = 0;
1197 if (segments_.size() > 0)
1198 samplerate = segments_.at(current_segment_id_).samplerate;
1200 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1201 g_variant_new_uint64(samplerate));
1202 for (const shared_ptr<decode::Decoder>& dec : stack_)
1203 dec->apply_all_options();
1204 srd_session_start(srd_session_);
1209 // Create the session
1210 srd_session_new(&srd_session_);
1211 assert(srd_session_);
1213 // Create the decoders
1214 srd_decoder_inst *prev_di = nullptr;
1215 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1216 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1219 set_error_message(tr("Failed to create decoder instance"));
1220 srd_session_destroy(srd_session_);
1221 srd_session_ = nullptr;
1226 srd_inst_stack(srd_session_, prev_di, di);
1231 // Start the session
1232 if (segments_.size() > 0)
1233 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1234 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1236 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1237 DecodeSignal::annotation_callback, this);
1239 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
1240 DecodeSignal::binary_callback, this);
1242 srd_session_start(srd_session_);
1244 // We just recreated the srd session, so all stack changes are applied now
1245 stack_config_changed_ = false;
1248 void DecodeSignal::terminate_srd_session()
1250 // Call the "terminate and reset" routine for the decoder stack
1251 // (if available). This does not harm those stacks which already
1252 // have completed their operation, and reduces response time for
1253 // those stacks which still are processing data while the
1254 // application no longer wants them to.
1256 srd_session_terminate_reset(srd_session_);
1258 // Metadata is cleared also, so re-set it
1259 uint64_t samplerate = 0;
1260 if (segments_.size() > 0)
1261 samplerate = segments_.at(current_segment_id_).samplerate;
1263 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1264 g_variant_new_uint64(samplerate));
1265 for (const shared_ptr<decode::Decoder>& dec : stack_)
1266 dec->apply_all_options();
1270 void DecodeSignal::stop_srd_session()
1273 // Destroy the session
1274 srd_session_destroy(srd_session_);
1275 srd_session_ = nullptr;
1277 // Mark the decoder instances as non-existant since they were deleted
1278 for (const shared_ptr<decode::Decoder>& dec : stack_)
1279 dec->invalidate_decoder_inst();
1283 void DecodeSignal::connect_input_notifiers()
1285 // Disconnect the notification slot from the previous set of signals
1286 disconnect(this, SLOT(on_data_cleared()));
1287 disconnect(this, SLOT(on_data_received()));
1289 // Connect the currently used signals to our slot
1290 for (decode::DecodeChannel& ch : channels_) {
1291 if (!ch.assigned_signal)
1294 const data::SignalBase *signal = ch.assigned_signal;
1295 connect(signal, SIGNAL(samples_cleared()),
1296 this, SLOT(on_data_cleared()));
1297 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1298 this, SLOT(on_data_received()));
1302 void DecodeSignal::create_decode_segment()
1304 // Create annotation segment
1305 segments_.emplace_back(DecodeSegment());
1307 // Add annotation classes
1308 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1310 const srd_decoder *const decc = dec->decoder();
1311 assert(dec->decoder());
1314 // Add a row for the decoder if it doesn't have a row list
1315 if (!decc->annotation_rows)
1316 (segments_.back().annotation_rows)[Row(row_index++, decc)] =
1319 // Add the decoder rows
1320 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
1321 const srd_decoder_annotation_row *const ann_row =
1322 (srd_decoder_annotation_row *)l->data;
1325 const Row row(row_index++, decc, ann_row);
1327 // Add a new empty row data object
1328 (segments_.back().annotation_rows)[row] =
1333 // Prepare our binary output classes
1334 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1335 uint8_t n = dec->get_binary_class_count();
1337 for (uint8_t i = 0; i < n; i++)
1338 segments_.back().binary_classes.push_back(
1339 {dec.get(), dec->get_binary_class(i), vector<DecodeBinaryDataChunk>()});
1343 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1346 assert(decode_signal);
1348 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1351 if (ds->decode_interrupt_)
1354 lock_guard<mutex> lock(ds->output_mutex_);
1356 // Get the decoder and the annotation data
1358 assert(pdata->pdo->di);
1359 const srd_decoder *const decc = pdata->pdo->di->decoder;
1362 const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data;
1366 auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end();
1368 // Try finding a better row match than the default by looking up the sub-row of this class
1369 const auto format = pda->ann_class;
1370 const auto r = ds->class_rows_.find(make_pair(decc, format));
1371 if (r != ds->class_rows_.end())
1372 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second);
1374 // Failing that, use the decoder as a key
1375 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(0, decc));
1378 if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) {
1379 qDebug() << "Unexpected annotation: decoder = " << decc <<
1380 ", format = " << format;
1385 // Add the annotation
1386 (*row_iter).second.emplace_annotation(pdata, &((*row_iter).first));
1389 void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
1392 assert(decode_signal);
1394 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1397 if (ds->decode_interrupt_)
1400 // Get the decoder and the binary data
1402 assert(pdata->pdo->di);
1403 const srd_decoder *const decc = pdata->pdo->di->decoder;
1406 const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data;
1409 // Find the matching DecodeBinaryClass
1410 DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_));
1412 DecodeBinaryClass* bin_class = nullptr;
1413 for (DecodeBinaryClass& bc : segment->binary_classes)
1414 if ((bc.decoder->decoder() == decc) && (bc.info->bin_class_id == pdb->bin_class))
1418 qWarning() << "Could not find valid DecodeBinaryClass in segment" <<
1419 ds->current_segment_id_ << "for binary class ID" << pdb->bin_class <<
1420 ", segment only knows" << segment->binary_classes.size() << "classes";
1424 // Add the data chunk
1425 bin_class->chunks.emplace_back();
1426 DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back());
1428 chunk->sample = pdata->start_sample;
1429 chunk->data.resize(pdb->size);
1430 memcpy(chunk->data.data(), pdb->data, pdb->size);
1432 // Note: using pdb->bin_class is only unique for each decoder in the stack,
1433 // so if two stacked decoders both emit binary data with the same bin_class,
1434 // we may be triggering unnecessary updates. Should be ok for now as that
1435 // case isn't possible yet. When it is, we might add the decoder's name
1436 // as an additional parameter to the signal, although string comparisons
1437 // are not really fast.
1438 ds->new_binary_data(ds->current_segment_id_, pdb->bin_class);
1441 void DecodeSignal::on_capture_state_changed(int state)
1443 // If a new acquisition was started, we need to start decoding from scratch
1444 if (state == Session::Running) {
1445 logic_mux_data_invalid_ = true;
1450 void DecodeSignal::on_data_cleared()
1455 void DecodeSignal::on_data_received()
1457 // If we detected a lack of input data when trying to start decoding,
1458 // we have set an error message. Only try again if we now have data
1460 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1463 if (!logic_mux_thread_.joinable())
1466 logic_mux_cond_.notify_one();