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();
155 current_segment_id_ = 0;
158 logic_mux_data_.reset();
159 logic_mux_data_invalid_ = true;
161 if (!error_message_.isEmpty()) {
162 error_message_ = QString();
163 // TODO Emulate noquote()
164 qDebug().nospace() << name() << ": Error cleared";
170 void DecodeSignal::begin_decode()
172 if (decode_thread_.joinable()) {
173 decode_interrupt_ = true;
174 decode_input_cond_.notify_one();
175 decode_thread_.join();
178 if (logic_mux_thread_.joinable()) {
179 logic_mux_interrupt_ = true;
180 logic_mux_cond_.notify_one();
181 logic_mux_thread_.join();
186 if (stack_.size() == 0) {
187 set_error_message(tr("No decoders"));
191 assert(channels_.size() > 0);
193 if (get_assigned_signal_count() == 0) {
194 set_error_message(tr("There are no channels assigned to this decoder"));
198 // Make sure that all assigned channels still provide logic data
199 // (can happen when a converted signal was assigned but the
200 // conversion removed in the meanwhile)
201 for (data::DecodeChannel &ch : channels_)
202 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
203 ch.assigned_signal = nullptr;
205 // Check that all decoders have the required channels
206 for (const shared_ptr<decode::Decoder> &dec : stack_)
207 if (!dec->have_required_channels()) {
208 set_error_message(tr("One or more required channels "
209 "have not been specified"));
213 // Map out all the annotation classes
215 for (const shared_ptr<decode::Decoder> &dec : stack_) {
217 const srd_decoder *const decc = dec->decoder();
218 assert(dec->decoder());
220 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
221 const srd_decoder_annotation_row *const ann_row =
222 (srd_decoder_annotation_row *)l->data;
225 const Row row(row_index++, decc, ann_row);
227 for (const GSList *ll = ann_row->ann_classes;
229 class_rows_[make_pair(decc,
230 GPOINTER_TO_INT(ll->data))] = row;
234 // Free the logic data and its segment(s) if it needs to be updated
235 if (logic_mux_data_invalid_)
236 logic_mux_data_.reset();
238 if (!logic_mux_data_) {
239 const uint32_t ch_count = get_assigned_signal_count();
240 logic_mux_unit_size_ = (ch_count + 7) / 8;
241 logic_mux_data_ = make_shared<Logic>(ch_count);
244 // Receive notifications when new sample data is available
245 connect_input_notifiers();
247 if (get_input_segment_count() == 0) {
248 set_error_message(tr("No input data"));
252 // Make sure the logic output data is complete and up-to-date
253 logic_mux_interrupt_ = false;
254 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
256 // Decode the muxed logic data
257 decode_interrupt_ = false;
258 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
261 QString DecodeSignal::error_message() const
263 lock_guard<mutex> lock(output_mutex_);
264 return error_message_;
267 const vector<data::DecodeChannel> DecodeSignal::get_channels() const
272 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
274 bool new_assignment = false;
276 // Try to auto-select channels that don't have signals assigned yet
277 for (data::DecodeChannel &ch : channels_) {
278 // If a decoder is given, auto-assign only its channels
279 if (dec && (ch.decoder_ != dec))
282 if (ch.assigned_signal)
285 const QString ch_name = ch.name.toLower();
287 shared_ptr<data::SignalBase> match;
288 for (shared_ptr<data::SignalBase> s : session_.signalbases()) {
292 const QString s_name = s->name().toLower();
294 if (s->logic_data() &&
295 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
299 // Only replace an existing match if it matches more characters
300 int old_unmatched = ch_name.length() - match->name().length();
301 int new_unmatched = ch_name.length() - s->name().length();
302 if (abs(new_unmatched) < abs(old_unmatched))
309 ch.assigned_signal = match.get();
310 new_assignment = true;
314 if (new_assignment) {
315 logic_mux_data_invalid_ = true;
316 stack_config_changed_ = true;
317 commit_decoder_channels();
322 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
324 for (data::DecodeChannel &ch : channels_)
325 if (ch.id == channel_id) {
326 ch.assigned_signal = signal;
327 logic_mux_data_invalid_ = true;
330 stack_config_changed_ = true;
331 commit_decoder_channels();
336 int DecodeSignal::get_assigned_signal_count() const
338 // Count all channels that have a signal assigned to them
339 return count_if(channels_.begin(), channels_.end(),
340 [](data::DecodeChannel ch) { return ch.assigned_signal; });
343 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
345 for (data::DecodeChannel &ch : channels_)
346 if (ch.id == channel_id)
347 ch.initial_pin_state = init_state;
349 stack_config_changed_ = true;
354 double DecodeSignal::samplerate() const
358 // TODO For now, we simply return the first samplerate that we have
359 if (segments_.size() > 0)
360 result = segments_.front().samplerate;
365 const pv::util::Timestamp DecodeSignal::start_time() const
367 pv::util::Timestamp result;
369 // TODO For now, we simply return the first start time that we have
370 if (segments_.size() > 0)
371 result = segments_.front().start_time;
376 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
378 // The working sample count is the highest sample number for
379 // which all used signals have data available, so go through all
380 // channels and use the lowest overall sample count of the segment
382 int64_t count = std::numeric_limits<int64_t>::max();
383 bool no_signals_assigned = true;
385 for (const data::DecodeChannel &ch : channels_)
386 if (ch.assigned_signal) {
387 no_signals_assigned = false;
389 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
390 if (!logic_data || logic_data->logic_segments().empty())
394 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
395 count = min(count, (int64_t)segment->get_sample_count());
396 } catch (out_of_range&) {
401 return (no_signals_assigned ? 0 : count);
404 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
405 bool include_processing) const
407 lock_guard<mutex> decode_lock(output_mutex_);
412 const DecodeSegment *segment = &(segments_.at(segment_id));
413 if (include_processing)
414 result = segment->samples_decoded_incl;
416 result = segment->samples_decoded_excl;
417 } catch (out_of_range&) {
424 vector<Row> DecodeSignal::visible_rows() const
426 lock_guard<mutex> lock(output_mutex_);
430 for (const shared_ptr<decode::Decoder> &dec : stack_) {
435 const srd_decoder *const decc = dec->decoder();
436 assert(dec->decoder());
439 // Add a row for the decoder if it doesn't have a row list
440 if (!decc->annotation_rows)
441 rows.emplace_back(row_index++, decc);
443 // Add the decoder rows
444 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
445 const srd_decoder_annotation_row *const ann_row =
446 (srd_decoder_annotation_row *)l->data;
448 rows.emplace_back(row_index++, decc, ann_row);
455 void DecodeSignal::get_annotation_subset(
456 vector<pv::data::decode::Annotation> &dest,
457 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
458 uint64_t end_sample) const
460 lock_guard<mutex> lock(output_mutex_);
463 const DecodeSegment *segment = &(segments_.at(segment_id));
464 const map<const decode::Row, decode::RowData> *rows =
465 &(segment->annotation_rows);
467 const auto iter = rows->find(row);
468 if (iter != rows->end())
469 (*iter).second.get_annotation_subset(dest,
470 start_sample, end_sample);
471 } catch (out_of_range&) {
476 void DecodeSignal::get_annotation_subset(
477 vector<pv::data::decode::Annotation> &dest,
478 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
480 // Note: We put all vectors and lists on the heap, not the stack
482 const vector<Row> rows = visible_rows();
484 // Use forward_lists for faster merging
485 forward_list<Annotation> *all_ann_list = new forward_list<Annotation>();
487 for (const Row& row : rows) {
488 vector<Annotation> *ann_vector = new vector<Annotation>();
489 get_annotation_subset(*ann_vector, row, segment_id, start_sample, end_sample);
491 forward_list<Annotation> *ann_list =
492 new forward_list<Annotation>(ann_vector->begin(), ann_vector->end());
495 all_ann_list->merge(*ann_list);
499 move(all_ann_list->begin(), all_ann_list->end(), back_inserter(dest));
503 void DecodeSignal::save_settings(QSettings &settings) const
505 SignalBase::save_settings(settings);
507 settings.setValue("decoders", (int)(stack_.size()));
509 // Save decoder stack
511 for (shared_ptr<decode::Decoder> decoder : stack_) {
512 settings.beginGroup("decoder" + QString::number(decoder_idx++));
514 settings.setValue("id", decoder->decoder()->id);
516 // Save decoder options
517 const map<string, GVariant*>& options = decoder->options();
519 settings.setValue("options", (int)options.size());
521 // Note: decode::Decoder::options() returns only the options
522 // that differ from the default. See binding::Decoder::getter()
524 for (auto option : options) {
525 settings.beginGroup("option" + QString::number(i));
526 settings.setValue("name", QString::fromStdString(option.first));
527 GlobalSettings::store_gvariant(settings, option.second);
535 // Save channel mapping
536 settings.setValue("channels", (int)channels_.size());
538 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
539 auto channel = find_if(channels_.begin(), channels_.end(),
540 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
542 if (channel == channels_.end()) {
543 qDebug() << "ERROR: Gap in channel index:" << channel_id;
547 settings.beginGroup("channel" + QString::number(channel_id));
549 settings.setValue("name", channel->name); // Useful for debugging
550 settings.setValue("initial_pin_state", channel->initial_pin_state);
552 if (channel->assigned_signal)
553 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
559 void DecodeSignal::restore_settings(QSettings &settings)
561 SignalBase::restore_settings(settings);
563 // Restore decoder stack
564 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
566 int decoders = settings.value("decoders").toInt();
568 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
569 settings.beginGroup("decoder" + QString::number(decoder_idx));
571 QString id = settings.value("id").toString();
573 for (GSList *entry = dec_list; entry; entry = entry->next) {
574 const srd_decoder *dec = (srd_decoder*)entry->data;
578 if (QString::fromUtf8(dec->id) == id) {
579 shared_ptr<decode::Decoder> decoder =
580 make_shared<decode::Decoder>(dec);
582 stack_.push_back(decoder);
584 // Restore decoder options that differ from their default
585 int options = settings.value("options").toInt();
587 for (int i = 0; i < options; i++) {
588 settings.beginGroup("option" + QString::number(i));
589 QString name = settings.value("name").toString();
590 GVariant *value = GlobalSettings::restore_gvariant(settings);
591 decoder->set_option(name.toUtf8(), value);
595 // Include the newly created decode channels in the channel lists
596 update_channel_list();
605 // Restore channel mapping
606 unsigned int channels = settings.value("channels").toInt();
608 const unordered_set< shared_ptr<data::SignalBase> > signalbases =
609 session_.signalbases();
611 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
612 auto channel = find_if(channels_.begin(), channels_.end(),
613 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
615 if (channel == channels_.end()) {
616 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
620 settings.beginGroup("channel" + QString::number(channel_id));
622 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
624 for (shared_ptr<data::SignalBase> signal : signalbases)
625 if (signal->name() == assigned_signal_name)
626 channel->assigned_signal = signal.get();
628 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
633 // Update the internal structures
634 stack_config_changed_ = true;
635 update_channel_list();
636 commit_decoder_channels();
641 void DecodeSignal::set_error_message(QString msg)
643 error_message_ = msg;
644 // TODO Emulate noquote()
645 qDebug().nospace() << name() << ": " << msg;
648 uint32_t DecodeSignal::get_input_segment_count() const
650 uint64_t count = std::numeric_limits<uint64_t>::max();
651 bool no_signals_assigned = true;
653 for (const data::DecodeChannel &ch : channels_)
654 if (ch.assigned_signal) {
655 no_signals_assigned = false;
657 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
658 if (!logic_data || logic_data->logic_segments().empty())
661 // Find the min value of all segment counts
662 if ((uint64_t)(logic_data->logic_segments().size()) < count)
663 count = logic_data->logic_segments().size();
666 return (no_signals_assigned ? 0 : count);
669 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
671 double samplerate = 0;
673 for (const data::DecodeChannel &ch : channels_)
674 if (ch.assigned_signal) {
675 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
676 if (!logic_data || logic_data->logic_segments().empty())
680 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
681 samplerate = segment->samplerate();
682 } catch (out_of_range&) {
691 void DecodeSignal::update_channel_list()
693 vector<data::DecodeChannel> prev_channels = channels_;
698 // Copy existing entries, create new as needed
699 for (shared_ptr<Decoder> decoder : stack_) {
700 const srd_decoder* srd_d = decoder->decoder();
703 // Mandatory channels
704 for (l = srd_d->channels; l; l = l->next) {
705 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
706 bool ch_added = false;
708 // Copy but update ID if this channel was in the list before
709 for (data::DecodeChannel &ch : prev_channels)
710 if (ch.pdch_ == pdch) {
712 channels_.push_back(ch);
718 // Create new entry without a mapped signal
719 data::DecodeChannel ch = {id++, 0, false, nullptr,
720 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
721 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
722 channels_.push_back(ch);
727 for (l = srd_d->opt_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, true, 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 // Invalidate the logic output data if the channel assignment changed
751 if (prev_channels.size() != channels_.size()) {
752 // The number of channels changed, there's definitely a difference
753 logic_mux_data_invalid_ = true;
755 // Same number but assignment may still differ, so compare all channels
756 for (size_t i = 0; i < channels_.size(); i++) {
757 const data::DecodeChannel &p_ch = prev_channels[i];
758 const data::DecodeChannel &ch = channels_[i];
760 if ((p_ch.pdch_ != ch.pdch_) ||
761 (p_ch.assigned_signal != ch.assigned_signal)) {
762 logic_mux_data_invalid_ = true;
772 void DecodeSignal::commit_decoder_channels()
774 // Submit channel list to every decoder, containing only the relevant channels
775 for (shared_ptr<decode::Decoder> dec : stack_) {
776 vector<data::DecodeChannel*> channel_list;
778 for (data::DecodeChannel &ch : channels_)
779 if (ch.decoder_ == dec)
780 channel_list.push_back(&ch);
782 dec->set_channels(channel_list);
785 // Channel bit IDs must be in sync with the channel's apperance in channels_
787 for (data::DecodeChannel &ch : channels_)
788 if (ch.assigned_signal)
792 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
794 // Enforce end to be greater than start
798 // Fetch the channel segments and their data
799 vector<shared_ptr<LogicSegment> > segments;
800 vector<const uint8_t*> signal_data;
801 vector<uint8_t> signal_in_bytepos;
802 vector<uint8_t> signal_in_bitpos;
804 for (data::DecodeChannel &ch : channels_)
805 if (ch.assigned_signal) {
806 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
808 shared_ptr<LogicSegment> segment;
810 segment = logic_data->logic_segments().at(segment_id);
811 } catch (out_of_range&) {
812 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
813 << "has no logic segment" << segment_id;
816 segments.push_back(segment);
818 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
819 segment->get_samples(start, end, data);
820 signal_data.push_back(data);
822 const int bitpos = ch.assigned_signal->logic_bit_index();
823 signal_in_bytepos.push_back(bitpos / 8);
824 signal_in_bitpos.push_back(bitpos % 8);
828 shared_ptr<LogicSegment> output_segment;
830 output_segment = logic_mux_data_->logic_segments().at(segment_id);
831 } catch (out_of_range&) {
832 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
833 << segment_id << "in mux_logic_samples(), mux segments size is" \
834 << logic_mux_data_->logic_segments().size();
838 // Perform the muxing of signal data into the output data
839 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
840 unsigned int signal_count = signal_data.size();
842 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
848 const int out_sample_pos = sample_cnt * output_segment->unit_size();
849 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
850 output[out_sample_pos + i] = 0;
852 for (unsigned int i = 0; i < signal_count; i++) {
853 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
854 const uint8_t in_sample = 1 &
855 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
857 const uint8_t out_sample = output[out_sample_pos + bytepos];
859 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
869 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
872 for (const uint8_t* data : signal_data)
876 void DecodeSignal::logic_mux_proc()
878 uint32_t segment_id = 0;
880 assert(logic_mux_data_);
882 // Create initial logic mux segment
883 shared_ptr<LogicSegment> output_segment =
884 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
885 logic_mux_unit_size_, 0);
886 logic_mux_data_->push_segment(output_segment);
888 output_segment->set_samplerate(get_input_samplerate(0));
891 const uint64_t input_sample_count = get_working_sample_count(segment_id);
892 const uint64_t output_sample_count = output_segment->get_sample_count();
894 const uint64_t samples_to_process =
895 (input_sample_count > output_sample_count) ?
896 (input_sample_count - output_sample_count) : 0;
898 // Process the samples if necessary...
899 if (samples_to_process > 0) {
900 const uint64_t unit_size = output_segment->unit_size();
901 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
903 uint64_t processed_samples = 0;
905 const uint64_t start_sample = output_sample_count + processed_samples;
906 const uint64_t sample_count =
907 min(samples_to_process - processed_samples, chunk_sample_count);
909 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
910 processed_samples += sample_count;
912 // ...and process the newly muxed logic data
913 decode_input_cond_.notify_one();
914 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
917 if (samples_to_process == 0) {
918 // TODO Optimize this by caching the input segment count and only
919 // querying it when the cached value was reached
920 if (segment_id < get_input_segment_count() - 1) {
921 // Process next segment
925 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
926 logic_mux_unit_size_, 0);
927 logic_mux_data_->push_segment(output_segment);
929 output_segment->set_samplerate(get_input_samplerate(segment_id));
932 // All segments have been processed
933 logic_mux_data_invalid_ = false;
935 // Wait for more input
936 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
937 logic_mux_cond_.wait(logic_mux_lock);
941 } while (!logic_mux_interrupt_);
944 void DecodeSignal::decode_data(
945 const int64_t abs_start_samplenum, const int64_t sample_count,
946 const shared_ptr<LogicSegment> input_segment)
948 const int64_t unit_size = input_segment->unit_size();
949 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
951 for (int64_t i = abs_start_samplenum;
952 error_message_.isEmpty() && !decode_interrupt_ &&
953 (i < (abs_start_samplenum + sample_count));
954 i += chunk_sample_count) {
956 const int64_t chunk_end = min(i + chunk_sample_count,
957 abs_start_samplenum + sample_count);
960 lock_guard<mutex> lock(output_mutex_);
961 // Update the sample count showing the samples including currently processed ones
962 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
965 int64_t data_size = (chunk_end - i) * unit_size;
966 uint8_t* chunk = new uint8_t[data_size];
967 input_segment->get_samples(i, chunk_end, chunk);
969 if (srd_session_send(srd_session_, i, chunk_end, chunk,
970 data_size, unit_size) != SRD_OK)
971 set_error_message(tr("Decoder reported an error"));
976 lock_guard<mutex> lock(output_mutex_);
977 // Now that all samples are processed, the exclusive sample count catches up
978 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
981 // Notify the frontend that we processed some data and
982 // possibly have new annotations as well
987 void DecodeSignal::decode_proc()
989 current_segment_id_ = 0;
991 // If there is no input data available yet, wait until it is or we're interrupted
992 if (logic_mux_data_->logic_segments().size() == 0) {
993 unique_lock<mutex> input_wait_lock(input_mutex_);
994 decode_input_cond_.wait(input_wait_lock);
997 if (decode_interrupt_)
1000 shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
1001 assert(input_segment);
1003 // Create the initial segment and set its sample rate so that we can pass it to SRD
1004 create_decode_segment();
1005 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1006 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1008 start_srd_session();
1010 uint64_t sample_count = 0;
1011 uint64_t abs_start_samplenum = 0;
1013 // Keep processing new samples until we exhaust the input data
1015 lock_guard<mutex> input_lock(input_mutex_);
1016 sample_count = input_segment->get_sample_count() - abs_start_samplenum;
1018 if (sample_count > 0) {
1019 decode_data(abs_start_samplenum, sample_count, input_segment);
1020 abs_start_samplenum += sample_count;
1022 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
1024 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
1025 if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
1026 // Process next segment
1027 current_segment_id_++;
1030 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1031 } catch (out_of_range&) {
1032 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1033 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1034 << logic_mux_data_->logic_segments().size();
1037 abs_start_samplenum = 0;
1039 // Create the next segment and set its metadata
1040 create_decode_segment();
1041 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1042 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1044 // Reset decoder state but keep the decoder stack intact
1045 terminate_srd_session();
1047 // All segments have been processed
1050 // Wait for new input data or an interrupt was requested
1051 unique_lock<mutex> input_wait_lock(input_mutex_);
1052 decode_input_cond_.wait(input_wait_lock);
1055 } while (error_message_.isEmpty() && !decode_interrupt_);
1057 // Potentially reap decoders when the application no longer is
1058 // interested in their (pending) results.
1059 if (decode_interrupt_)
1060 terminate_srd_session();
1063 void DecodeSignal::start_srd_session()
1065 // If there were stack changes, the session has been destroyed by now, so if
1066 // it hasn't been destroyed, we can just reset and re-use it
1068 // When a decoder stack was created before, re-use it
1069 // for the next stream of input data, after terminating
1070 // potentially still executing operations, and resetting
1071 // internal state. Skip the rather expensive (teardown
1072 // and) construction of another decoder stack.
1074 // TODO Reduce redundancy, use a common code path for
1075 // the meta/start sequence?
1076 terminate_srd_session();
1078 // Metadata is cleared also, so re-set it
1079 uint64_t samplerate = 0;
1080 if (segments_.size() > 0)
1081 samplerate = segments_.at(current_segment_id_).samplerate;
1083 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1084 g_variant_new_uint64(samplerate));
1085 for (const shared_ptr<decode::Decoder> &dec : stack_)
1086 dec->apply_all_options();
1087 srd_session_start(srd_session_);
1092 // Create the session
1093 srd_session_new(&srd_session_);
1094 assert(srd_session_);
1096 // Create the decoders
1097 srd_decoder_inst *prev_di = nullptr;
1098 for (const shared_ptr<decode::Decoder> &dec : stack_) {
1099 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1102 set_error_message(tr("Failed to create decoder instance"));
1103 srd_session_destroy(srd_session_);
1104 srd_session_ = nullptr;
1109 srd_inst_stack(srd_session_, prev_di, di);
1114 // Start the session
1115 if (segments_.size() > 0)
1116 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1117 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1119 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1120 DecodeSignal::annotation_callback, this);
1122 srd_session_start(srd_session_);
1124 // We just recreated the srd session, so all stack changes are applied now
1125 stack_config_changed_ = false;
1128 void DecodeSignal::terminate_srd_session()
1130 // Call the "terminate and reset" routine for the decoder stack
1131 // (if available). This does not harm those stacks which already
1132 // have completed their operation, and reduces response time for
1133 // those stacks which still are processing data while the
1134 // application no longer wants them to.
1136 srd_session_terminate_reset(srd_session_);
1138 // Metadata is cleared also, so re-set it
1139 uint64_t samplerate = 0;
1140 if (segments_.size() > 0)
1141 samplerate = segments_.at(current_segment_id_).samplerate;
1143 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1144 g_variant_new_uint64(samplerate));
1145 for (const shared_ptr<decode::Decoder> &dec : stack_)
1146 dec->apply_all_options();
1150 void DecodeSignal::stop_srd_session()
1153 // Destroy the session
1154 srd_session_destroy(srd_session_);
1155 srd_session_ = nullptr;
1157 // Mark the decoder instances as non-existant since they were deleted
1158 for (const shared_ptr<decode::Decoder> &dec : stack_)
1159 dec->invalidate_decoder_inst();
1163 void DecodeSignal::connect_input_notifiers()
1165 // Disconnect the notification slot from the previous set of signals
1166 disconnect(this, SLOT(on_data_cleared()));
1167 disconnect(this, SLOT(on_data_received()));
1169 // Connect the currently used signals to our slot
1170 for (data::DecodeChannel &ch : channels_) {
1171 if (!ch.assigned_signal)
1174 const data::SignalBase *signal = ch.assigned_signal;
1175 connect(signal, SIGNAL(samples_cleared()),
1176 this, SLOT(on_data_cleared()));
1177 connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
1178 this, SLOT(on_data_received()));
1182 void DecodeSignal::create_decode_segment()
1184 // Create annotation segment
1185 segments_.emplace_back(DecodeSegment());
1187 // Add annotation classes
1188 for (const shared_ptr<decode::Decoder> &dec : stack_) {
1190 const srd_decoder *const decc = dec->decoder();
1191 assert(dec->decoder());
1194 // Add a row for the decoder if it doesn't have a row list
1195 if (!decc->annotation_rows)
1196 (segments_.back().annotation_rows)[Row(row_index++, decc)] =
1199 // Add the decoder rows
1200 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
1201 const srd_decoder_annotation_row *const ann_row =
1202 (srd_decoder_annotation_row *)l->data;
1205 const Row row(row_index++, decc, ann_row);
1207 // Add a new empty row data object
1208 (segments_.back().annotation_rows)[row] =
1214 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1217 assert(decode_signal);
1219 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1222 if (ds->decode_interrupt_)
1225 lock_guard<mutex> lock(ds->output_mutex_);
1229 assert(pdata->pdo->di);
1230 const srd_decoder *const decc = pdata->pdo->di->decoder;
1233 const srd_proto_data_annotation *const pda =
1234 (const srd_proto_data_annotation*)pdata->data;
1237 auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end();
1239 // Try looking up the sub-row of this class
1240 const auto format = pda->ann_class;
1241 const auto r = ds->class_rows_.find(make_pair(decc, format));
1242 if (r != ds->class_rows_.end())
1243 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second);
1245 // Failing that, use the decoder as a key
1246 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(0, decc));
1249 if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) {
1250 qDebug() << "Unexpected annotation: decoder = " << decc <<
1251 ", format = " << format;
1256 // Add the annotation
1257 (*row_iter).second.emplace_annotation(pdata, &((*row_iter).first));
1260 void DecodeSignal::on_capture_state_changed(int state)
1262 // If a new acquisition was started, we need to start decoding from scratch
1263 if (state == Session::Running) {
1264 logic_mux_data_invalid_ = true;
1269 void DecodeSignal::on_data_cleared()
1274 void DecodeSignal::on_data_received()
1276 // If we detected a lack of input data when trying to start decoding,
1277 // we have set an error message. Only try again if we now have data
1279 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1282 if (!logic_mux_thread_.joinable())
1285 logic_mux_cond_.notify_one();