2 * This file is part of the PulseView project.
4 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #include <forward_list>
26 #include "logicsegment.hpp"
27 #include "decodesignal.hpp"
28 #include "signaldata.hpp"
30 #include <pv/binding/decoder.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::Decoder;
46 using pv::data::decode::Row;
51 const double DecodeSignal::DecodeMargin = 1.0;
52 const double DecodeSignal::DecodeThreshold = 0.2;
53 const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
56 DecodeSignal::DecodeSignal(pv::Session &session) :
57 SignalBase(nullptr, SignalBase::DecodeChannel),
59 srd_session_(nullptr),
60 logic_mux_data_invalid_(false),
61 stack_config_changed_(true),
62 current_segment_id_(0)
64 connect(&session_, SIGNAL(capture_state_changed(int)),
65 this, SLOT(on_capture_state_changed(int)));
68 DecodeSignal::~DecodeSignal()
73 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
78 void DecodeSignal::stack_decoder(const srd_decoder *decoder)
81 const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
83 stack_.push_back(dec);
85 // Set name if this decoder is the first in the list
86 if (stack_.size() == 1)
87 set_name(QString::fromUtf8(decoder->name));
89 // Include the newly created decode channels in the channel lists
90 update_channel_list();
92 stack_config_changed_ = true;
93 auto_assign_signals(dec);
94 commit_decoder_channels();
98 void DecodeSignal::remove_decoder(int index)
101 assert(index < (int)stack_.size());
103 // Find the decoder in the stack
104 auto iter = stack_.begin();
105 for (int i = 0; i < index; i++, iter++)
106 assert(iter != stack_.end());
108 // Delete the element
111 // Update channels and decoded data
112 stack_config_changed_ = true;
113 update_channel_list();
117 bool DecodeSignal::toggle_decoder_visibility(int index)
119 auto iter = stack_.cbegin();
120 for (int i = 0; i < index; i++, iter++)
121 assert(iter != stack_.end());
123 shared_ptr<Decoder> dec = *iter;
125 // Toggle decoder visibility
128 state = !dec->shown();
135 void DecodeSignal::reset_decode(bool shutting_down)
137 if (stack_config_changed_ || shutting_down)
140 terminate_srd_session();
142 if (decode_thread_.joinable()) {
143 decode_interrupt_ = true;
144 decode_input_cond_.notify_one();
145 decode_thread_.join();
148 if (logic_mux_thread_.joinable()) {
149 logic_mux_interrupt_ = true;
150 logic_mux_cond_.notify_one();
151 logic_mux_thread_.join();
154 resume_decode(); // Make sure the decode thread isn't blocked by pausing
157 current_segment_id_ = 0;
160 logic_mux_data_.reset();
161 logic_mux_data_invalid_ = true;
163 if (!error_message_.isEmpty()) {
164 error_message_ = QString();
165 // TODO Emulate noquote()
166 qDebug().nospace() << name() << ": Error cleared";
172 void DecodeSignal::begin_decode()
174 if (decode_thread_.joinable()) {
175 decode_interrupt_ = true;
176 decode_input_cond_.notify_one();
177 decode_thread_.join();
180 if (logic_mux_thread_.joinable()) {
181 logic_mux_interrupt_ = true;
182 logic_mux_cond_.notify_one();
183 logic_mux_thread_.join();
188 if (stack_.size() == 0) {
189 set_error_message(tr("No decoders"));
193 assert(channels_.size() > 0);
195 if (get_assigned_signal_count() == 0) {
196 set_error_message(tr("There are no channels assigned to this decoder"));
200 // Make sure that all assigned channels still provide logic data
201 // (can happen when a converted signal was assigned but the
202 // conversion removed in the meanwhile)
203 for (data::DecodeChannel& ch : channels_)
204 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
205 ch.assigned_signal = nullptr;
207 // Check that all decoders have the required channels
208 for (const shared_ptr<decode::Decoder>& dec : stack_)
209 if (!dec->have_required_channels()) {
210 set_error_message(tr("One or more required channels "
211 "have not been specified"));
215 // Map out all the annotation classes
217 for (const shared_ptr<decode::Decoder>& dec : stack_) {
219 const srd_decoder *const decc = dec->decoder();
220 assert(dec->decoder());
222 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
223 const srd_decoder_annotation_row *const ann_row =
224 (srd_decoder_annotation_row *)l->data;
227 const Row row(row_index++, decc, ann_row);
229 for (const GSList *ll = ann_row->ann_classes;
231 class_rows_[make_pair(decc,
232 GPOINTER_TO_INT(ll->data))] = row;
236 // Free the logic data and its segment(s) if it needs to be updated
237 if (logic_mux_data_invalid_)
238 logic_mux_data_.reset();
240 if (!logic_mux_data_) {
241 const uint32_t ch_count = get_assigned_signal_count();
242 logic_mux_unit_size_ = (ch_count + 7) / 8;
243 logic_mux_data_ = make_shared<Logic>(ch_count);
246 // Receive notifications when new sample data is available
247 connect_input_notifiers();
249 if (get_input_segment_count() == 0) {
250 set_error_message(tr("No input data"));
254 // Make sure the logic output data is complete and up-to-date
255 logic_mux_interrupt_ = false;
256 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
258 // Decode the muxed logic data
259 decode_interrupt_ = false;
260 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
263 void DecodeSignal::pause_decode()
265 decode_paused_ = true;
268 void DecodeSignal::resume_decode()
270 // Manual unlocking is done before notifying, to avoid waking up the
271 // waiting thread only to block again (see notify_one for details)
272 decode_pause_mutex_.unlock();
273 decode_pause_cond_.notify_one();
274 decode_paused_ = false;
277 bool DecodeSignal::is_paused() const
279 return decode_paused_;
282 QString DecodeSignal::error_message() const
284 lock_guard<mutex> lock(output_mutex_);
285 return error_message_;
288 const vector<data::DecodeChannel> DecodeSignal::get_channels() const
293 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
295 bool new_assignment = false;
297 // Try to auto-select channels that don't have signals assigned yet
298 for (data::DecodeChannel& ch : channels_) {
299 // If a decoder is given, auto-assign only its channels
300 if (dec && (ch.decoder_ != dec))
303 if (ch.assigned_signal)
306 QString ch_name = ch.name.toLower();
307 ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
309 shared_ptr<data::SignalBase> match;
310 for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
314 QString s_name = s->name().toLower();
315 s_name = s_name.replace(QRegExp("[-_.]"), " ");
317 if (s->logic_data() &&
318 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
322 // Only replace an existing match if it matches more characters
323 int old_unmatched = ch_name.length() - match->name().length();
324 int new_unmatched = ch_name.length() - s->name().length();
325 if (abs(new_unmatched) < abs(old_unmatched))
332 ch.assigned_signal = match.get();
333 new_assignment = true;
337 if (new_assignment) {
338 logic_mux_data_invalid_ = true;
339 stack_config_changed_ = true;
340 commit_decoder_channels();
345 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
347 for (data::DecodeChannel& ch : channels_)
348 if (ch.id == channel_id) {
349 ch.assigned_signal = signal;
350 logic_mux_data_invalid_ = true;
353 stack_config_changed_ = true;
354 commit_decoder_channels();
359 int DecodeSignal::get_assigned_signal_count() const
361 // Count all channels that have a signal assigned to them
362 return count_if(channels_.begin(), channels_.end(),
363 [](data::DecodeChannel ch) { return ch.assigned_signal; });
366 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
368 for (data::DecodeChannel& ch : channels_)
369 if (ch.id == channel_id)
370 ch.initial_pin_state = init_state;
372 stack_config_changed_ = true;
377 double DecodeSignal::samplerate() const
381 // TODO For now, we simply return the first samplerate that we have
382 if (segments_.size() > 0)
383 result = segments_.front().samplerate;
388 const pv::util::Timestamp DecodeSignal::start_time() const
390 pv::util::Timestamp result;
392 // TODO For now, we simply return the first start time that we have
393 if (segments_.size() > 0)
394 result = segments_.front().start_time;
399 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
401 // The working sample count is the highest sample number for
402 // which all used signals have data available, so go through all
403 // channels and use the lowest overall sample count of the segment
405 int64_t count = std::numeric_limits<int64_t>::max();
406 bool no_signals_assigned = true;
408 for (const data::DecodeChannel& ch : channels_)
409 if (ch.assigned_signal) {
410 no_signals_assigned = false;
412 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
413 if (!logic_data || logic_data->logic_segments().empty())
417 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
418 count = min(count, (int64_t)segment->get_sample_count());
419 } catch (out_of_range&) {
424 return (no_signals_assigned ? 0 : count);
427 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
428 bool include_processing) const
430 lock_guard<mutex> decode_lock(output_mutex_);
435 const DecodeSegment *segment = &(segments_.at(segment_id));
436 if (include_processing)
437 result = segment->samples_decoded_incl;
439 result = segment->samples_decoded_excl;
440 } catch (out_of_range&) {
447 vector<Row> DecodeSignal::visible_rows() const
449 lock_guard<mutex> lock(output_mutex_);
453 for (const shared_ptr<decode::Decoder>& dec : stack_) {
458 const srd_decoder *const decc = dec->decoder();
459 assert(dec->decoder());
462 // Add a row for the decoder if it doesn't have a row list
463 if (!decc->annotation_rows)
464 rows.emplace_back(row_index++, decc);
466 // Add the decoder rows
467 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
468 const srd_decoder_annotation_row *const ann_row =
469 (srd_decoder_annotation_row *)l->data;
471 rows.emplace_back(row_index++, decc, ann_row);
478 void DecodeSignal::get_annotation_subset(
479 vector<pv::data::decode::Annotation> &dest,
480 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
481 uint64_t end_sample) const
483 lock_guard<mutex> lock(output_mutex_);
486 const DecodeSegment *segment = &(segments_.at(segment_id));
487 const map<const decode::Row, decode::RowData> *rows =
488 &(segment->annotation_rows);
490 const auto iter = rows->find(row);
491 if (iter != rows->end())
492 (*iter).second.get_annotation_subset(dest,
493 start_sample, end_sample);
494 } catch (out_of_range&) {
499 void DecodeSignal::get_annotation_subset(
500 vector<pv::data::decode::Annotation> &dest,
501 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
503 // Note: We put all vectors and lists on the heap, not the stack
505 const vector<Row> rows = visible_rows();
507 // Use forward_lists for faster merging
508 forward_list<Annotation> *all_ann_list = new forward_list<Annotation>();
510 for (const Row& row : rows) {
511 vector<Annotation> *ann_vector = new vector<Annotation>();
512 get_annotation_subset(*ann_vector, row, segment_id, start_sample, end_sample);
514 forward_list<Annotation> *ann_list =
515 new forward_list<Annotation>(ann_vector->begin(), ann_vector->end());
518 all_ann_list->merge(*ann_list);
522 move(all_ann_list->begin(), all_ann_list->end(), back_inserter(dest));
526 void DecodeSignal::save_settings(QSettings &settings) const
528 SignalBase::save_settings(settings);
530 settings.setValue("decoders", (int)(stack_.size()));
532 // Save decoder stack
534 for (const shared_ptr<decode::Decoder>& decoder : stack_) {
535 settings.beginGroup("decoder" + QString::number(decoder_idx++));
537 settings.setValue("id", decoder->decoder()->id);
539 // Save decoder options
540 const map<string, GVariant*>& options = decoder->options();
542 settings.setValue("options", (int)options.size());
544 // Note: decode::Decoder::options() returns only the options
545 // that differ from the default. See binding::Decoder::getter()
547 for (auto& option : options) {
548 settings.beginGroup("option" + QString::number(i));
549 settings.setValue("name", QString::fromStdString(option.first));
550 GlobalSettings::store_gvariant(settings, option.second);
558 // Save channel mapping
559 settings.setValue("channels", (int)channels_.size());
561 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
562 auto channel = find_if(channels_.begin(), channels_.end(),
563 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
565 if (channel == channels_.end()) {
566 qDebug() << "ERROR: Gap in channel index:" << channel_id;
570 settings.beginGroup("channel" + QString::number(channel_id));
572 settings.setValue("name", channel->name); // Useful for debugging
573 settings.setValue("initial_pin_state", channel->initial_pin_state);
575 if (channel->assigned_signal)
576 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
582 void DecodeSignal::restore_settings(QSettings &settings)
584 SignalBase::restore_settings(settings);
586 // Restore decoder stack
587 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
589 int decoders = settings.value("decoders").toInt();
591 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
592 settings.beginGroup("decoder" + QString::number(decoder_idx));
594 QString id = settings.value("id").toString();
596 for (GSList *entry = dec_list; entry; entry = entry->next) {
597 const srd_decoder *dec = (srd_decoder*)entry->data;
601 if (QString::fromUtf8(dec->id) == id) {
602 shared_ptr<decode::Decoder> decoder =
603 make_shared<decode::Decoder>(dec);
605 stack_.push_back(decoder);
607 // Restore decoder options that differ from their default
608 int options = settings.value("options").toInt();
610 for (int i = 0; i < options; i++) {
611 settings.beginGroup("option" + QString::number(i));
612 QString name = settings.value("name").toString();
613 GVariant *value = GlobalSettings::restore_gvariant(settings);
614 decoder->set_option(name.toUtf8(), value);
618 // Include the newly created decode channels in the channel lists
619 update_channel_list();
628 // Restore channel mapping
629 unsigned int channels = settings.value("channels").toInt();
631 const unordered_set< shared_ptr<data::SignalBase> > signalbases =
632 session_.signalbases();
634 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
635 auto channel = find_if(channels_.begin(), channels_.end(),
636 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
638 if (channel == channels_.end()) {
639 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
643 settings.beginGroup("channel" + QString::number(channel_id));
645 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
647 for (const shared_ptr<data::SignalBase>& signal : signalbases)
648 if (signal->name() == assigned_signal_name)
649 channel->assigned_signal = signal.get();
651 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
656 // Update the internal structures
657 stack_config_changed_ = true;
658 update_channel_list();
659 commit_decoder_channels();
664 void DecodeSignal::set_error_message(QString msg)
666 error_message_ = msg;
667 // TODO Emulate noquote()
668 qDebug().nospace() << name() << ": " << msg;
671 uint32_t DecodeSignal::get_input_segment_count() const
673 uint64_t count = std::numeric_limits<uint64_t>::max();
674 bool no_signals_assigned = true;
676 for (const data::DecodeChannel& ch : channels_)
677 if (ch.assigned_signal) {
678 no_signals_assigned = false;
680 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
681 if (!logic_data || logic_data->logic_segments().empty())
684 // Find the min value of all segment counts
685 if ((uint64_t)(logic_data->logic_segments().size()) < count)
686 count = logic_data->logic_segments().size();
689 return (no_signals_assigned ? 0 : count);
692 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
694 double samplerate = 0;
696 for (const data::DecodeChannel& ch : channels_)
697 if (ch.assigned_signal) {
698 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
699 if (!logic_data || logic_data->logic_segments().empty())
703 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
704 samplerate = segment->samplerate();
705 } catch (out_of_range&) {
714 void DecodeSignal::update_channel_list()
716 vector<data::DecodeChannel> prev_channels = channels_;
721 // Copy existing entries, create new as needed
722 for (shared_ptr<Decoder>& decoder : stack_) {
723 const srd_decoder* srd_d = decoder->decoder();
726 // Mandatory channels
727 for (l = srd_d->channels; l; l = l->next) {
728 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
729 bool ch_added = false;
731 // Copy but update ID if this channel was in the list before
732 for (data::DecodeChannel& ch : prev_channels)
733 if (ch.pdch_ == pdch) {
735 channels_.push_back(ch);
741 // Create new entry without a mapped signal
742 data::DecodeChannel ch = {id++, 0, false, nullptr,
743 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
744 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
745 channels_.push_back(ch);
750 for (l = srd_d->opt_channels; l; l = l->next) {
751 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
752 bool ch_added = false;
754 // Copy but update ID if this channel was in the list before
755 for (data::DecodeChannel& ch : prev_channels)
756 if (ch.pdch_ == pdch) {
758 channels_.push_back(ch);
764 // Create new entry without a mapped signal
765 data::DecodeChannel ch = {id++, 0, true, nullptr,
766 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
767 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
768 channels_.push_back(ch);
773 // Invalidate the logic output data if the channel assignment changed
774 if (prev_channels.size() != channels_.size()) {
775 // The number of channels changed, there's definitely a difference
776 logic_mux_data_invalid_ = true;
778 // Same number but assignment may still differ, so compare all channels
779 for (size_t i = 0; i < channels_.size(); i++) {
780 const data::DecodeChannel& p_ch = prev_channels[i];
781 const data::DecodeChannel& ch = channels_[i];
783 if ((p_ch.pdch_ != ch.pdch_) ||
784 (p_ch.assigned_signal != ch.assigned_signal)) {
785 logic_mux_data_invalid_ = true;
795 void DecodeSignal::commit_decoder_channels()
797 // Submit channel list to every decoder, containing only the relevant channels
798 for (shared_ptr<decode::Decoder> dec : stack_) {
799 vector<data::DecodeChannel*> channel_list;
801 for (data::DecodeChannel& ch : channels_)
802 if (ch.decoder_ == dec)
803 channel_list.push_back(&ch);
805 dec->set_channels(channel_list);
808 // Channel bit IDs must be in sync with the channel's apperance in channels_
810 for (data::DecodeChannel& ch : channels_)
811 if (ch.assigned_signal)
815 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
817 // Enforce end to be greater than start
821 // Fetch the channel segments and their data
822 vector<shared_ptr<LogicSegment> > segments;
823 vector<const uint8_t*> signal_data;
824 vector<uint8_t> signal_in_bytepos;
825 vector<uint8_t> signal_in_bitpos;
827 for (data::DecodeChannel& ch : channels_)
828 if (ch.assigned_signal) {
829 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
831 shared_ptr<LogicSegment> segment;
833 segment = logic_data->logic_segments().at(segment_id);
834 } catch (out_of_range&) {
835 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
836 << "has no logic segment" << segment_id;
839 segments.push_back(segment);
841 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
842 segment->get_samples(start, end, data);
843 signal_data.push_back(data);
845 const int bitpos = ch.assigned_signal->logic_bit_index();
846 signal_in_bytepos.push_back(bitpos / 8);
847 signal_in_bitpos.push_back(bitpos % 8);
851 shared_ptr<LogicSegment> output_segment;
853 output_segment = logic_mux_data_->logic_segments().at(segment_id);
854 } catch (out_of_range&) {
855 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
856 << segment_id << "in mux_logic_samples(), mux segments size is" \
857 << logic_mux_data_->logic_segments().size();
861 // Perform the muxing of signal data into the output data
862 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
863 unsigned int signal_count = signal_data.size();
865 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
871 const int out_sample_pos = sample_cnt * output_segment->unit_size();
872 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
873 output[out_sample_pos + i] = 0;
875 for (unsigned int i = 0; i < signal_count; i++) {
876 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
877 const uint8_t in_sample = 1 &
878 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
880 const uint8_t out_sample = output[out_sample_pos + bytepos];
882 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
892 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
895 for (const uint8_t* data : signal_data)
899 void DecodeSignal::logic_mux_proc()
901 uint32_t segment_id = 0;
903 assert(logic_mux_data_);
905 // Create initial logic mux segment
906 shared_ptr<LogicSegment> output_segment =
907 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
908 logic_mux_unit_size_, 0);
909 logic_mux_data_->push_segment(output_segment);
911 output_segment->set_samplerate(get_input_samplerate(0));
914 const uint64_t input_sample_count = get_working_sample_count(segment_id);
915 const uint64_t output_sample_count = output_segment->get_sample_count();
917 const uint64_t samples_to_process =
918 (input_sample_count > output_sample_count) ?
919 (input_sample_count - output_sample_count) : 0;
921 // Process the samples if necessary...
922 if (samples_to_process > 0) {
923 const uint64_t unit_size = output_segment->unit_size();
924 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
926 uint64_t processed_samples = 0;
928 const uint64_t start_sample = output_sample_count + processed_samples;
929 const uint64_t sample_count =
930 min(samples_to_process - processed_samples, chunk_sample_count);
932 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
933 processed_samples += sample_count;
935 // ...and process the newly muxed logic data
936 decode_input_cond_.notify_one();
937 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
940 if (samples_to_process == 0) {
941 // TODO Optimize this by caching the input segment count and only
942 // querying it when the cached value was reached
943 if (segment_id < get_input_segment_count() - 1) {
944 // Process next segment
948 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
949 logic_mux_unit_size_, 0);
950 logic_mux_data_->push_segment(output_segment);
952 output_segment->set_samplerate(get_input_samplerate(segment_id));
955 // All segments have been processed
956 logic_mux_data_invalid_ = false;
958 // Wait for more input
959 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
960 logic_mux_cond_.wait(logic_mux_lock);
964 } while (!logic_mux_interrupt_);
967 void DecodeSignal::decode_data(
968 const int64_t abs_start_samplenum, const int64_t sample_count,
969 const shared_ptr<LogicSegment> input_segment)
971 const int64_t unit_size = input_segment->unit_size();
972 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
974 for (int64_t i = abs_start_samplenum;
975 error_message_.isEmpty() && !decode_interrupt_ &&
976 (i < (abs_start_samplenum + sample_count));
977 i += chunk_sample_count) {
979 const int64_t chunk_end = min(i + chunk_sample_count,
980 abs_start_samplenum + sample_count);
983 lock_guard<mutex> lock(output_mutex_);
984 // Update the sample count showing the samples including currently processed ones
985 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
988 int64_t data_size = (chunk_end - i) * unit_size;
989 uint8_t* chunk = new uint8_t[data_size];
990 input_segment->get_samples(i, chunk_end, chunk);
992 if (srd_session_send(srd_session_, i, chunk_end, chunk,
993 data_size, unit_size) != SRD_OK)
994 set_error_message(tr("Decoder reported an error"));
999 lock_guard<mutex> lock(output_mutex_);
1000 // Now that all samples are processed, the exclusive sample count catches up
1001 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1004 // Notify the frontend that we processed some data and
1005 // possibly have new annotations as well
1008 if (decode_paused_) {
1009 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1010 decode_pause_cond_.wait(pause_wait_lock);
1015 void DecodeSignal::decode_proc()
1017 current_segment_id_ = 0;
1019 // If there is no input data available yet, wait until it is or we're interrupted
1020 if (logic_mux_data_->logic_segments().size() == 0) {
1021 unique_lock<mutex> input_wait_lock(input_mutex_);
1022 decode_input_cond_.wait(input_wait_lock);
1025 if (decode_interrupt_)
1028 shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
1029 assert(input_segment);
1031 // Create the initial segment and set its sample rate so that we can pass it to SRD
1032 create_decode_segment();
1033 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1034 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1036 start_srd_session();
1038 uint64_t sample_count = 0;
1039 uint64_t abs_start_samplenum = 0;
1041 // Keep processing new samples until we exhaust the input data
1043 lock_guard<mutex> input_lock(input_mutex_);
1044 sample_count = input_segment->get_sample_count() - abs_start_samplenum;
1046 if (sample_count > 0) {
1047 decode_data(abs_start_samplenum, sample_count, input_segment);
1048 abs_start_samplenum += sample_count;
1050 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
1052 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
1053 if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
1054 // Process next segment
1055 current_segment_id_++;
1058 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1059 } catch (out_of_range&) {
1060 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1061 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1062 << logic_mux_data_->logic_segments().size();
1065 abs_start_samplenum = 0;
1067 // Create the next segment and set its metadata
1068 create_decode_segment();
1069 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1070 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1072 // Reset decoder state but keep the decoder stack intact
1073 terminate_srd_session();
1075 // All segments have been processed
1078 // Wait for new input data or an interrupt was requested
1079 unique_lock<mutex> input_wait_lock(input_mutex_);
1080 decode_input_cond_.wait(input_wait_lock);
1083 } while (error_message_.isEmpty() && !decode_interrupt_);
1085 // Potentially reap decoders when the application no longer is
1086 // interested in their (pending) results.
1087 if (decode_interrupt_)
1088 terminate_srd_session();
1091 void DecodeSignal::start_srd_session()
1093 // If there were stack changes, the session has been destroyed by now, so if
1094 // it hasn't been destroyed, we can just reset and re-use it
1096 // When a decoder stack was created before, re-use it
1097 // for the next stream of input data, after terminating
1098 // potentially still executing operations, and resetting
1099 // internal state. Skip the rather expensive (teardown
1100 // and) construction of another decoder stack.
1102 // TODO Reduce redundancy, use a common code path for
1103 // the meta/start sequence?
1104 terminate_srd_session();
1106 // Metadata is cleared also, so re-set it
1107 uint64_t samplerate = 0;
1108 if (segments_.size() > 0)
1109 samplerate = segments_.at(current_segment_id_).samplerate;
1111 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1112 g_variant_new_uint64(samplerate));
1113 for (const shared_ptr<decode::Decoder>& dec : stack_)
1114 dec->apply_all_options();
1115 srd_session_start(srd_session_);
1120 // Create the session
1121 srd_session_new(&srd_session_);
1122 assert(srd_session_);
1124 // Create the decoders
1125 srd_decoder_inst *prev_di = nullptr;
1126 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1127 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1130 set_error_message(tr("Failed to create decoder instance"));
1131 srd_session_destroy(srd_session_);
1132 srd_session_ = nullptr;
1137 srd_inst_stack(srd_session_, prev_di, di);
1142 // Start the session
1143 if (segments_.size() > 0)
1144 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1145 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1147 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1148 DecodeSignal::annotation_callback, this);
1150 srd_session_start(srd_session_);
1152 // We just recreated the srd session, so all stack changes are applied now
1153 stack_config_changed_ = false;
1156 void DecodeSignal::terminate_srd_session()
1158 // Call the "terminate and reset" routine for the decoder stack
1159 // (if available). This does not harm those stacks which already
1160 // have completed their operation, and reduces response time for
1161 // those stacks which still are processing data while the
1162 // application no longer wants them to.
1164 srd_session_terminate_reset(srd_session_);
1166 // Metadata is cleared also, so re-set it
1167 uint64_t samplerate = 0;
1168 if (segments_.size() > 0)
1169 samplerate = segments_.at(current_segment_id_).samplerate;
1171 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1172 g_variant_new_uint64(samplerate));
1173 for (const shared_ptr<decode::Decoder>& dec : stack_)
1174 dec->apply_all_options();
1178 void DecodeSignal::stop_srd_session()
1181 // Destroy the session
1182 srd_session_destroy(srd_session_);
1183 srd_session_ = nullptr;
1185 // Mark the decoder instances as non-existant since they were deleted
1186 for (const shared_ptr<decode::Decoder>& dec : stack_)
1187 dec->invalidate_decoder_inst();
1191 void DecodeSignal::connect_input_notifiers()
1193 // Disconnect the notification slot from the previous set of signals
1194 disconnect(this, SLOT(on_data_cleared()));
1195 disconnect(this, SLOT(on_data_received()));
1197 // Connect the currently used signals to our slot
1198 for (data::DecodeChannel& ch : channels_) {
1199 if (!ch.assigned_signal)
1202 const data::SignalBase *signal = ch.assigned_signal;
1203 connect(signal, SIGNAL(samples_cleared()),
1204 this, SLOT(on_data_cleared()));
1205 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1206 this, SLOT(on_data_received()));
1210 void DecodeSignal::create_decode_segment()
1212 // Create annotation segment
1213 segments_.emplace_back(DecodeSegment());
1215 // Add annotation classes
1216 for (const shared_ptr<decode::Decoder>& dec : stack_) {
1218 const srd_decoder *const decc = dec->decoder();
1219 assert(dec->decoder());
1222 // Add a row for the decoder if it doesn't have a row list
1223 if (!decc->annotation_rows)
1224 (segments_.back().annotation_rows)[Row(row_index++, decc)] =
1227 // Add the decoder rows
1228 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
1229 const srd_decoder_annotation_row *const ann_row =
1230 (srd_decoder_annotation_row *)l->data;
1233 const Row row(row_index++, decc, ann_row);
1235 // Add a new empty row data object
1236 (segments_.back().annotation_rows)[row] =
1242 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1245 assert(decode_signal);
1247 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1250 if (ds->decode_interrupt_)
1253 lock_guard<mutex> lock(ds->output_mutex_);
1257 assert(pdata->pdo->di);
1258 const srd_decoder *const decc = pdata->pdo->di->decoder;
1261 const srd_proto_data_annotation *const pda =
1262 (const srd_proto_data_annotation*)pdata->data;
1265 auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end();
1267 // Try looking up the sub-row of this class
1268 const auto format = pda->ann_class;
1269 const auto r = ds->class_rows_.find(make_pair(decc, format));
1270 if (r != ds->class_rows_.end())
1271 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second);
1273 // Failing that, use the decoder as a key
1274 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(0, decc));
1277 if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) {
1278 qDebug() << "Unexpected annotation: decoder = " << decc <<
1279 ", format = " << format;
1284 // Add the annotation
1285 (*row_iter).second.emplace_annotation(pdata, &((*row_iter).first));
1288 void DecodeSignal::on_capture_state_changed(int state)
1290 // If a new acquisition was started, we need to start decoding from scratch
1291 if (state == Session::Running) {
1292 logic_mux_data_invalid_ = true;
1297 void DecodeSignal::on_data_cleared()
1302 void DecodeSignal::on_data_received()
1304 // If we detected a lack of input data when trying to start decoding,
1305 // we have set an error message. Only try again if we now have data
1307 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1310 if (!logic_mux_thread_.joinable())
1313 logic_mux_cond_.notify_one();