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 decode_pause_mutex_.unlock();
155 decode_paused_ = false;
158 current_segment_id_ = 0;
161 logic_mux_data_.reset();
162 logic_mux_data_invalid_ = true;
164 if (!error_message_.isEmpty()) {
165 error_message_ = QString();
166 // TODO Emulate noquote()
167 qDebug().nospace() << name() << ": Error cleared";
173 void DecodeSignal::begin_decode()
175 if (decode_thread_.joinable()) {
176 decode_interrupt_ = true;
177 decode_input_cond_.notify_one();
178 decode_thread_.join();
181 if (logic_mux_thread_.joinable()) {
182 logic_mux_interrupt_ = true;
183 logic_mux_cond_.notify_one();
184 logic_mux_thread_.join();
189 if (stack_.size() == 0) {
190 set_error_message(tr("No decoders"));
194 assert(channels_.size() > 0);
196 if (get_assigned_signal_count() == 0) {
197 set_error_message(tr("There are no channels assigned to this decoder"));
201 // Make sure that all assigned channels still provide logic data
202 // (can happen when a converted signal was assigned but the
203 // conversion removed in the meanwhile)
204 for (data::DecodeChannel &ch : channels_)
205 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
206 ch.assigned_signal = nullptr;
208 // Check that all decoders have the required channels
209 for (const shared_ptr<decode::Decoder> &dec : stack_)
210 if (!dec->have_required_channels()) {
211 set_error_message(tr("One or more required channels "
212 "have not been specified"));
216 // Map out all the annotation classes
218 for (const shared_ptr<decode::Decoder> &dec : stack_) {
220 const srd_decoder *const decc = dec->decoder();
221 assert(dec->decoder());
223 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
224 const srd_decoder_annotation_row *const ann_row =
225 (srd_decoder_annotation_row *)l->data;
228 const Row row(row_index++, decc, ann_row);
230 for (const GSList *ll = ann_row->ann_classes;
232 class_rows_[make_pair(decc,
233 GPOINTER_TO_INT(ll->data))] = row;
237 // Free the logic data and its segment(s) if it needs to be updated
238 if (logic_mux_data_invalid_)
239 logic_mux_data_.reset();
241 if (!logic_mux_data_) {
242 const uint32_t ch_count = get_assigned_signal_count();
243 logic_mux_unit_size_ = (ch_count + 7) / 8;
244 logic_mux_data_ = make_shared<Logic>(ch_count);
247 // Receive notifications when new sample data is available
248 connect_input_notifiers();
250 if (get_input_segment_count() == 0) {
251 set_error_message(tr("No input data"));
255 // Make sure the logic output data is complete and up-to-date
256 logic_mux_interrupt_ = false;
257 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
259 // Decode the muxed logic data
260 decode_interrupt_ = false;
261 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
264 void DecodeSignal::pause_decode()
266 decode_paused_ = true;
269 void DecodeSignal::resume_decode()
271 // Manual unlocking is done before notifying, to avoid waking up the
272 // waiting thread only to block again (see notify_one for details)
273 decode_pause_mutex_.unlock();
274 decode_pause_cond_.notify_one();
275 decode_paused_ = false;
278 bool DecodeSignal::is_paused() const
280 return decode_paused_;
283 QString DecodeSignal::error_message() const
285 lock_guard<mutex> lock(output_mutex_);
286 return error_message_;
289 const vector<data::DecodeChannel> DecodeSignal::get_channels() const
294 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
296 bool new_assignment = false;
298 // Try to auto-select channels that don't have signals assigned yet
299 for (data::DecodeChannel &ch : channels_) {
300 // If a decoder is given, auto-assign only its channels
301 if (dec && (ch.decoder_ != dec))
304 if (ch.assigned_signal)
307 const QString ch_name = ch.name.toLower();
309 shared_ptr<data::SignalBase> match;
310 for (shared_ptr<data::SignalBase> s : session_.signalbases()) {
314 const QString s_name = s->name().toLower();
316 if (s->logic_data() &&
317 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
321 // Only replace an existing match if it matches more characters
322 int old_unmatched = ch_name.length() - match->name().length();
323 int new_unmatched = ch_name.length() - s->name().length();
324 if (abs(new_unmatched) < abs(old_unmatched))
331 ch.assigned_signal = match.get();
332 new_assignment = true;
336 if (new_assignment) {
337 logic_mux_data_invalid_ = true;
338 stack_config_changed_ = true;
339 commit_decoder_channels();
344 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
346 for (data::DecodeChannel &ch : channels_)
347 if (ch.id == channel_id) {
348 ch.assigned_signal = signal;
349 logic_mux_data_invalid_ = true;
352 stack_config_changed_ = true;
353 commit_decoder_channels();
358 int DecodeSignal::get_assigned_signal_count() const
360 // Count all channels that have a signal assigned to them
361 return count_if(channels_.begin(), channels_.end(),
362 [](data::DecodeChannel ch) { return ch.assigned_signal; });
365 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
367 for (data::DecodeChannel &ch : channels_)
368 if (ch.id == channel_id)
369 ch.initial_pin_state = init_state;
371 stack_config_changed_ = true;
376 double DecodeSignal::samplerate() const
380 // TODO For now, we simply return the first samplerate that we have
381 if (segments_.size() > 0)
382 result = segments_.front().samplerate;
387 const pv::util::Timestamp DecodeSignal::start_time() const
389 pv::util::Timestamp result;
391 // TODO For now, we simply return the first start time that we have
392 if (segments_.size() > 0)
393 result = segments_.front().start_time;
398 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
400 // The working sample count is the highest sample number for
401 // which all used signals have data available, so go through all
402 // channels and use the lowest overall sample count of the segment
404 int64_t count = std::numeric_limits<int64_t>::max();
405 bool no_signals_assigned = true;
407 for (const data::DecodeChannel &ch : channels_)
408 if (ch.assigned_signal) {
409 no_signals_assigned = false;
411 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
412 if (!logic_data || logic_data->logic_segments().empty())
416 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
417 count = min(count, (int64_t)segment->get_sample_count());
418 } catch (out_of_range&) {
423 return (no_signals_assigned ? 0 : count);
426 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
427 bool include_processing) const
429 lock_guard<mutex> decode_lock(output_mutex_);
434 const DecodeSegment *segment = &(segments_.at(segment_id));
435 if (include_processing)
436 result = segment->samples_decoded_incl;
438 result = segment->samples_decoded_excl;
439 } catch (out_of_range&) {
446 vector<Row> DecodeSignal::visible_rows() const
448 lock_guard<mutex> lock(output_mutex_);
452 for (const shared_ptr<decode::Decoder> &dec : stack_) {
457 const srd_decoder *const decc = dec->decoder();
458 assert(dec->decoder());
461 // Add a row for the decoder if it doesn't have a row list
462 if (!decc->annotation_rows)
463 rows.emplace_back(row_index++, decc);
465 // Add the decoder rows
466 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
467 const srd_decoder_annotation_row *const ann_row =
468 (srd_decoder_annotation_row *)l->data;
470 rows.emplace_back(row_index++, decc, ann_row);
477 void DecodeSignal::get_annotation_subset(
478 vector<pv::data::decode::Annotation> &dest,
479 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
480 uint64_t end_sample) const
482 lock_guard<mutex> lock(output_mutex_);
485 const DecodeSegment *segment = &(segments_.at(segment_id));
486 const map<const decode::Row, decode::RowData> *rows =
487 &(segment->annotation_rows);
489 const auto iter = rows->find(row);
490 if (iter != rows->end())
491 (*iter).second.get_annotation_subset(dest,
492 start_sample, end_sample);
493 } catch (out_of_range&) {
498 void DecodeSignal::get_annotation_subset(
499 vector<pv::data::decode::Annotation> &dest,
500 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
502 // Note: We put all vectors and lists on the heap, not the stack
504 const vector<Row> rows = visible_rows();
506 // Use forward_lists for faster merging
507 forward_list<Annotation> *all_ann_list = new forward_list<Annotation>();
509 for (const Row& row : rows) {
510 vector<Annotation> *ann_vector = new vector<Annotation>();
511 get_annotation_subset(*ann_vector, row, segment_id, start_sample, end_sample);
513 forward_list<Annotation> *ann_list =
514 new forward_list<Annotation>(ann_vector->begin(), ann_vector->end());
517 all_ann_list->merge(*ann_list);
521 move(all_ann_list->begin(), all_ann_list->end(), back_inserter(dest));
525 void DecodeSignal::save_settings(QSettings &settings) const
527 SignalBase::save_settings(settings);
529 settings.setValue("decoders", (int)(stack_.size()));
531 // Save decoder stack
533 for (shared_ptr<decode::Decoder> decoder : stack_) {
534 settings.beginGroup("decoder" + QString::number(decoder_idx++));
536 settings.setValue("id", decoder->decoder()->id);
538 // Save decoder options
539 const map<string, GVariant*>& options = decoder->options();
541 settings.setValue("options", (int)options.size());
543 // Note: decode::Decoder::options() returns only the options
544 // that differ from the default. See binding::Decoder::getter()
546 for (auto option : options) {
547 settings.beginGroup("option" + QString::number(i));
548 settings.setValue("name", QString::fromStdString(option.first));
549 GlobalSettings::store_gvariant(settings, option.second);
557 // Save channel mapping
558 settings.setValue("channels", (int)channels_.size());
560 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
561 auto channel = find_if(channels_.begin(), channels_.end(),
562 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
564 if (channel == channels_.end()) {
565 qDebug() << "ERROR: Gap in channel index:" << channel_id;
569 settings.beginGroup("channel" + QString::number(channel_id));
571 settings.setValue("name", channel->name); // Useful for debugging
572 settings.setValue("initial_pin_state", channel->initial_pin_state);
574 if (channel->assigned_signal)
575 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
581 void DecodeSignal::restore_settings(QSettings &settings)
583 SignalBase::restore_settings(settings);
585 // Restore decoder stack
586 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
588 int decoders = settings.value("decoders").toInt();
590 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
591 settings.beginGroup("decoder" + QString::number(decoder_idx));
593 QString id = settings.value("id").toString();
595 for (GSList *entry = dec_list; entry; entry = entry->next) {
596 const srd_decoder *dec = (srd_decoder*)entry->data;
600 if (QString::fromUtf8(dec->id) == id) {
601 shared_ptr<decode::Decoder> decoder =
602 make_shared<decode::Decoder>(dec);
604 stack_.push_back(decoder);
606 // Restore decoder options that differ from their default
607 int options = settings.value("options").toInt();
609 for (int i = 0; i < options; i++) {
610 settings.beginGroup("option" + QString::number(i));
611 QString name = settings.value("name").toString();
612 GVariant *value = GlobalSettings::restore_gvariant(settings);
613 decoder->set_option(name.toUtf8(), value);
617 // Include the newly created decode channels in the channel lists
618 update_channel_list();
627 // Restore channel mapping
628 unsigned int channels = settings.value("channels").toInt();
630 const unordered_set< shared_ptr<data::SignalBase> > signalbases =
631 session_.signalbases();
633 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
634 auto channel = find_if(channels_.begin(), channels_.end(),
635 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
637 if (channel == channels_.end()) {
638 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
642 settings.beginGroup("channel" + QString::number(channel_id));
644 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
646 for (shared_ptr<data::SignalBase> signal : signalbases)
647 if (signal->name() == assigned_signal_name)
648 channel->assigned_signal = signal.get();
650 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
655 // Update the internal structures
656 stack_config_changed_ = true;
657 update_channel_list();
658 commit_decoder_channels();
663 void DecodeSignal::set_error_message(QString msg)
665 error_message_ = msg;
666 // TODO Emulate noquote()
667 qDebug().nospace() << name() << ": " << msg;
670 uint32_t DecodeSignal::get_input_segment_count() const
672 uint64_t count = std::numeric_limits<uint64_t>::max();
673 bool no_signals_assigned = true;
675 for (const data::DecodeChannel &ch : channels_)
676 if (ch.assigned_signal) {
677 no_signals_assigned = false;
679 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
680 if (!logic_data || logic_data->logic_segments().empty())
683 // Find the min value of all segment counts
684 if ((uint64_t)(logic_data->logic_segments().size()) < count)
685 count = logic_data->logic_segments().size();
688 return (no_signals_assigned ? 0 : count);
691 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
693 double samplerate = 0;
695 for (const data::DecodeChannel &ch : channels_)
696 if (ch.assigned_signal) {
697 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
698 if (!logic_data || logic_data->logic_segments().empty())
702 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
703 samplerate = segment->samplerate();
704 } catch (out_of_range&) {
713 void DecodeSignal::update_channel_list()
715 vector<data::DecodeChannel> prev_channels = channels_;
720 // Copy existing entries, create new as needed
721 for (shared_ptr<Decoder> decoder : stack_) {
722 const srd_decoder* srd_d = decoder->decoder();
725 // Mandatory channels
726 for (l = srd_d->channels; l; l = l->next) {
727 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
728 bool ch_added = false;
730 // Copy but update ID if this channel was in the list before
731 for (data::DecodeChannel &ch : prev_channels)
732 if (ch.pdch_ == pdch) {
734 channels_.push_back(ch);
740 // Create new entry without a mapped signal
741 data::DecodeChannel ch = {id++, 0, false, nullptr,
742 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
743 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
744 channels_.push_back(ch);
749 for (l = srd_d->opt_channels; l; l = l->next) {
750 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
751 bool ch_added = false;
753 // Copy but update ID if this channel was in the list before
754 for (data::DecodeChannel &ch : prev_channels)
755 if (ch.pdch_ == pdch) {
757 channels_.push_back(ch);
763 // Create new entry without a mapped signal
764 data::DecodeChannel ch = {id++, 0, true, nullptr,
765 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
766 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
767 channels_.push_back(ch);
772 // Invalidate the logic output data if the channel assignment changed
773 if (prev_channels.size() != channels_.size()) {
774 // The number of channels changed, there's definitely a difference
775 logic_mux_data_invalid_ = true;
777 // Same number but assignment may still differ, so compare all channels
778 for (size_t i = 0; i < channels_.size(); i++) {
779 const data::DecodeChannel &p_ch = prev_channels[i];
780 const data::DecodeChannel &ch = channels_[i];
782 if ((p_ch.pdch_ != ch.pdch_) ||
783 (p_ch.assigned_signal != ch.assigned_signal)) {
784 logic_mux_data_invalid_ = true;
794 void DecodeSignal::commit_decoder_channels()
796 // Submit channel list to every decoder, containing only the relevant channels
797 for (shared_ptr<decode::Decoder> dec : stack_) {
798 vector<data::DecodeChannel*> channel_list;
800 for (data::DecodeChannel &ch : channels_)
801 if (ch.decoder_ == dec)
802 channel_list.push_back(&ch);
804 dec->set_channels(channel_list);
807 // Channel bit IDs must be in sync with the channel's apperance in channels_
809 for (data::DecodeChannel &ch : channels_)
810 if (ch.assigned_signal)
814 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
816 // Enforce end to be greater than start
820 // Fetch the channel segments and their data
821 vector<shared_ptr<LogicSegment> > segments;
822 vector<const uint8_t*> signal_data;
823 vector<uint8_t> signal_in_bytepos;
824 vector<uint8_t> signal_in_bitpos;
826 for (data::DecodeChannel &ch : channels_)
827 if (ch.assigned_signal) {
828 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
830 shared_ptr<LogicSegment> segment;
832 segment = logic_data->logic_segments().at(segment_id);
833 } catch (out_of_range&) {
834 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
835 << "has no logic segment" << segment_id;
838 segments.push_back(segment);
840 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
841 segment->get_samples(start, end, data);
842 signal_data.push_back(data);
844 const int bitpos = ch.assigned_signal->logic_bit_index();
845 signal_in_bytepos.push_back(bitpos / 8);
846 signal_in_bitpos.push_back(bitpos % 8);
850 shared_ptr<LogicSegment> output_segment;
852 output_segment = logic_mux_data_->logic_segments().at(segment_id);
853 } catch (out_of_range&) {
854 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
855 << segment_id << "in mux_logic_samples(), mux segments size is" \
856 << logic_mux_data_->logic_segments().size();
860 // Perform the muxing of signal data into the output data
861 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
862 unsigned int signal_count = signal_data.size();
864 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
870 const int out_sample_pos = sample_cnt * output_segment->unit_size();
871 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
872 output[out_sample_pos + i] = 0;
874 for (unsigned int i = 0; i < signal_count; i++) {
875 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
876 const uint8_t in_sample = 1 &
877 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
879 const uint8_t out_sample = output[out_sample_pos + bytepos];
881 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
891 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
894 for (const uint8_t* data : signal_data)
898 void DecodeSignal::logic_mux_proc()
900 uint32_t segment_id = 0;
902 assert(logic_mux_data_);
904 // Create initial logic mux segment
905 shared_ptr<LogicSegment> output_segment =
906 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
907 logic_mux_unit_size_, 0);
908 logic_mux_data_->push_segment(output_segment);
910 output_segment->set_samplerate(get_input_samplerate(0));
913 const uint64_t input_sample_count = get_working_sample_count(segment_id);
914 const uint64_t output_sample_count = output_segment->get_sample_count();
916 const uint64_t samples_to_process =
917 (input_sample_count > output_sample_count) ?
918 (input_sample_count - output_sample_count) : 0;
920 // Process the samples if necessary...
921 if (samples_to_process > 0) {
922 const uint64_t unit_size = output_segment->unit_size();
923 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
925 uint64_t processed_samples = 0;
927 const uint64_t start_sample = output_sample_count + processed_samples;
928 const uint64_t sample_count =
929 min(samples_to_process - processed_samples, chunk_sample_count);
931 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
932 processed_samples += sample_count;
934 // ...and process the newly muxed logic data
935 decode_input_cond_.notify_one();
936 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
939 if (samples_to_process == 0) {
940 // TODO Optimize this by caching the input segment count and only
941 // querying it when the cached value was reached
942 if (segment_id < get_input_segment_count() - 1) {
943 // Process next segment
947 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
948 logic_mux_unit_size_, 0);
949 logic_mux_data_->push_segment(output_segment);
951 output_segment->set_samplerate(get_input_samplerate(segment_id));
954 // All segments have been processed
955 logic_mux_data_invalid_ = false;
957 // Wait for more input
958 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
959 logic_mux_cond_.wait(logic_mux_lock);
963 } while (!logic_mux_interrupt_);
966 void DecodeSignal::decode_data(
967 const int64_t abs_start_samplenum, const int64_t sample_count,
968 const shared_ptr<LogicSegment> input_segment)
970 const int64_t unit_size = input_segment->unit_size();
971 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
973 for (int64_t i = abs_start_samplenum;
974 error_message_.isEmpty() && !decode_interrupt_ &&
975 (i < (abs_start_samplenum + sample_count));
976 i += chunk_sample_count) {
978 const int64_t chunk_end = min(i + chunk_sample_count,
979 abs_start_samplenum + sample_count);
982 lock_guard<mutex> lock(output_mutex_);
983 // Update the sample count showing the samples including currently processed ones
984 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
987 int64_t data_size = (chunk_end - i) * unit_size;
988 uint8_t* chunk = new uint8_t[data_size];
989 input_segment->get_samples(i, chunk_end, chunk);
991 if (srd_session_send(srd_session_, i, chunk_end, chunk,
992 data_size, unit_size) != SRD_OK)
993 set_error_message(tr("Decoder reported an error"));
998 lock_guard<mutex> lock(output_mutex_);
999 // Now that all samples are processed, the exclusive sample count catches up
1000 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1003 // Notify the frontend that we processed some data and
1004 // possibly have new annotations as well
1007 if (decode_paused_) {
1008 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1009 decode_pause_cond_.wait(pause_wait_lock);
1014 void DecodeSignal::decode_proc()
1016 current_segment_id_ = 0;
1018 // If there is no input data available yet, wait until it is or we're interrupted
1019 if (logic_mux_data_->logic_segments().size() == 0) {
1020 unique_lock<mutex> input_wait_lock(input_mutex_);
1021 decode_input_cond_.wait(input_wait_lock);
1024 if (decode_interrupt_)
1027 shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
1028 assert(input_segment);
1030 // Create the initial segment and set its sample rate so that we can pass it to SRD
1031 create_decode_segment();
1032 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1033 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1035 start_srd_session();
1037 uint64_t sample_count = 0;
1038 uint64_t abs_start_samplenum = 0;
1040 // Keep processing new samples until we exhaust the input data
1042 lock_guard<mutex> input_lock(input_mutex_);
1043 sample_count = input_segment->get_sample_count() - abs_start_samplenum;
1045 if (sample_count > 0) {
1046 decode_data(abs_start_samplenum, sample_count, input_segment);
1047 abs_start_samplenum += sample_count;
1049 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
1051 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
1052 if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
1053 // Process next segment
1054 current_segment_id_++;
1057 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1058 } catch (out_of_range&) {
1059 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1060 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1061 << logic_mux_data_->logic_segments().size();
1064 abs_start_samplenum = 0;
1066 // Create the next segment and set its metadata
1067 create_decode_segment();
1068 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1069 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1071 // Reset decoder state but keep the decoder stack intact
1072 terminate_srd_session();
1074 // All segments have been processed
1077 // Wait for new input data or an interrupt was requested
1078 unique_lock<mutex> input_wait_lock(input_mutex_);
1079 decode_input_cond_.wait(input_wait_lock);
1082 } while (error_message_.isEmpty() && !decode_interrupt_);
1084 // Potentially reap decoders when the application no longer is
1085 // interested in their (pending) results.
1086 if (decode_interrupt_)
1087 terminate_srd_session();
1090 void DecodeSignal::start_srd_session()
1092 // If there were stack changes, the session has been destroyed by now, so if
1093 // it hasn't been destroyed, we can just reset and re-use it
1095 // When a decoder stack was created before, re-use it
1096 // for the next stream of input data, after terminating
1097 // potentially still executing operations, and resetting
1098 // internal state. Skip the rather expensive (teardown
1099 // and) construction of another decoder stack.
1101 // TODO Reduce redundancy, use a common code path for
1102 // the meta/start sequence?
1103 terminate_srd_session();
1105 // Metadata is cleared also, so re-set it
1106 uint64_t samplerate = 0;
1107 if (segments_.size() > 0)
1108 samplerate = segments_.at(current_segment_id_).samplerate;
1110 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1111 g_variant_new_uint64(samplerate));
1112 for (const shared_ptr<decode::Decoder> &dec : stack_)
1113 dec->apply_all_options();
1114 srd_session_start(srd_session_);
1119 // Create the session
1120 srd_session_new(&srd_session_);
1121 assert(srd_session_);
1123 // Create the decoders
1124 srd_decoder_inst *prev_di = nullptr;
1125 for (const shared_ptr<decode::Decoder> &dec : stack_) {
1126 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1129 set_error_message(tr("Failed to create decoder instance"));
1130 srd_session_destroy(srd_session_);
1131 srd_session_ = nullptr;
1136 srd_inst_stack(srd_session_, prev_di, di);
1141 // Start the session
1142 if (segments_.size() > 0)
1143 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1144 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1146 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1147 DecodeSignal::annotation_callback, this);
1149 srd_session_start(srd_session_);
1151 // We just recreated the srd session, so all stack changes are applied now
1152 stack_config_changed_ = false;
1155 void DecodeSignal::terminate_srd_session()
1157 // Call the "terminate and reset" routine for the decoder stack
1158 // (if available). This does not harm those stacks which already
1159 // have completed their operation, and reduces response time for
1160 // those stacks which still are processing data while the
1161 // application no longer wants them to.
1163 srd_session_terminate_reset(srd_session_);
1165 // Metadata is cleared also, so re-set it
1166 uint64_t samplerate = 0;
1167 if (segments_.size() > 0)
1168 samplerate = segments_.at(current_segment_id_).samplerate;
1170 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1171 g_variant_new_uint64(samplerate));
1172 for (const shared_ptr<decode::Decoder> &dec : stack_)
1173 dec->apply_all_options();
1177 void DecodeSignal::stop_srd_session()
1180 // Destroy the session
1181 srd_session_destroy(srd_session_);
1182 srd_session_ = nullptr;
1184 // Mark the decoder instances as non-existant since they were deleted
1185 for (const shared_ptr<decode::Decoder> &dec : stack_)
1186 dec->invalidate_decoder_inst();
1190 void DecodeSignal::connect_input_notifiers()
1192 // Disconnect the notification slot from the previous set of signals
1193 disconnect(this, SLOT(on_data_cleared()));
1194 disconnect(this, SLOT(on_data_received()));
1196 // Connect the currently used signals to our slot
1197 for (data::DecodeChannel &ch : channels_) {
1198 if (!ch.assigned_signal)
1201 const data::SignalBase *signal = ch.assigned_signal;
1202 connect(signal, SIGNAL(samples_cleared()),
1203 this, SLOT(on_data_cleared()));
1204 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1205 this, SLOT(on_data_received()));
1209 void DecodeSignal::create_decode_segment()
1211 // Create annotation segment
1212 segments_.emplace_back(DecodeSegment());
1214 // Add annotation classes
1215 for (const shared_ptr<decode::Decoder> &dec : stack_) {
1217 const srd_decoder *const decc = dec->decoder();
1218 assert(dec->decoder());
1221 // Add a row for the decoder if it doesn't have a row list
1222 if (!decc->annotation_rows)
1223 (segments_.back().annotation_rows)[Row(row_index++, decc)] =
1226 // Add the decoder rows
1227 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
1228 const srd_decoder_annotation_row *const ann_row =
1229 (srd_decoder_annotation_row *)l->data;
1232 const Row row(row_index++, decc, ann_row);
1234 // Add a new empty row data object
1235 (segments_.back().annotation_rows)[row] =
1241 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1244 assert(decode_signal);
1246 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1249 if (ds->decode_interrupt_)
1252 lock_guard<mutex> lock(ds->output_mutex_);
1256 assert(pdata->pdo->di);
1257 const srd_decoder *const decc = pdata->pdo->di->decoder;
1260 const srd_proto_data_annotation *const pda =
1261 (const srd_proto_data_annotation*)pdata->data;
1264 auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end();
1266 // Try looking up the sub-row of this class
1267 const auto format = pda->ann_class;
1268 const auto r = ds->class_rows_.find(make_pair(decc, format));
1269 if (r != ds->class_rows_.end())
1270 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second);
1272 // Failing that, use the decoder as a key
1273 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(0, decc));
1276 if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) {
1277 qDebug() << "Unexpected annotation: decoder = " << decc <<
1278 ", format = " << format;
1283 // Add the annotation
1284 (*row_iter).second.emplace_annotation(pdata, &((*row_iter).first));
1287 void DecodeSignal::on_capture_state_changed(int state)
1289 // If a new acquisition was started, we need to start decoding from scratch
1290 if (state == Session::Running) {
1291 logic_mux_data_invalid_ = true;
1296 void DecodeSignal::on_data_cleared()
1301 void DecodeSignal::on_data_received()
1303 // If we detected a lack of input data when trying to start decoding,
1304 // we have set an error message. Only try again if we now have data
1306 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1309 if (!logic_mux_thread_.joinable())
1312 logic_mux_cond_.notify_one();