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/>.
25 #include "logicsegment.hpp"
26 #include "decodesignal.hpp"
27 #include "signaldata.hpp"
29 #include <pv/binding/decoder.hpp>
30 #include <pv/data/decode/decoder.hpp>
31 #include <pv/data/decode/row.hpp>
32 #include <pv/globalsettings.hpp>
33 #include <pv/session.hpp>
35 using std::lock_guard;
37 using std::make_shared;
39 using std::out_of_range;
40 using std::shared_ptr;
41 using std::unique_lock;
42 using pv::data::decode::Annotation;
43 using pv::data::decode::Decoder;
44 using pv::data::decode::Row;
49 const double DecodeSignal::DecodeMargin = 1.0;
50 const double DecodeSignal::DecodeThreshold = 0.2;
51 const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
54 DecodeSignal::DecodeSignal(pv::Session &session) :
55 SignalBase(nullptr, SignalBase::DecodeChannel),
57 srd_session_(nullptr),
58 logic_mux_data_invalid_(false),
59 current_segment_id_(0)
61 connect(&session_, SIGNAL(capture_state_changed(int)),
62 this, SLOT(on_capture_state_changed(int)));
65 DecodeSignal::~DecodeSignal()
70 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
75 void DecodeSignal::stack_decoder(const srd_decoder *decoder)
78 const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
80 stack_.push_back(dec);
82 // Set name if this decoder is the first in the list
83 if (stack_.size() == 1)
84 set_name(QString::fromUtf8(decoder->name));
86 // Include the newly created decode channels in the channel lists
87 update_channel_list();
89 auto_assign_signals(dec);
90 commit_decoder_channels();
94 void DecodeSignal::remove_decoder(int index)
97 assert(index < (int)stack_.size());
99 // Find the decoder in the stack
100 auto iter = stack_.begin();
101 for (int i = 0; i < index; i++, iter++)
102 assert(iter != stack_.end());
104 // Delete the element
107 // Update channels and decoded data
108 update_channel_list();
112 bool DecodeSignal::toggle_decoder_visibility(int index)
114 auto iter = stack_.cbegin();
115 for (int i = 0; i < index; i++, iter++)
116 assert(iter != stack_.end());
118 shared_ptr<Decoder> dec = *iter;
120 // Toggle decoder visibility
123 state = !dec->shown();
130 void DecodeSignal::reset_decode()
132 if (decode_thread_.joinable()) {
133 decode_interrupt_ = true;
134 decode_input_cond_.notify_one();
135 decode_thread_.join();
138 if (logic_mux_thread_.joinable()) {
139 logic_mux_interrupt_ = true;
140 logic_mux_cond_.notify_one();
141 logic_mux_thread_.join();
147 current_segment_id_ = 0;
150 logic_mux_data_.reset();
151 logic_mux_data_invalid_ = true;
153 error_message_ = QString();
158 void DecodeSignal::begin_decode()
160 if (decode_thread_.joinable()) {
161 decode_interrupt_ = true;
162 decode_input_cond_.notify_one();
163 decode_thread_.join();
166 if (logic_mux_thread_.joinable()) {
167 logic_mux_interrupt_ = true;
168 logic_mux_cond_.notify_one();
169 logic_mux_thread_.join();
174 if (stack_.size() == 0) {
175 error_message_ = tr("No decoders");
179 assert(channels_.size() > 0);
181 if (get_assigned_signal_count() == 0) {
182 error_message_ = tr("There are no channels assigned to this decoder");
186 // Make sure that all assigned channels still provide logic data
187 // (can happen when a converted signal was assigned but the
188 // conversion removed in the meanwhile)
189 for (data::DecodeChannel &ch : channels_)
190 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
191 ch.assigned_signal = nullptr;
193 // Check that all decoders have the required channels
194 for (const shared_ptr<decode::Decoder> &dec : stack_)
195 if (!dec->have_required_channels()) {
196 error_message_ = tr("One or more required channels "
197 "have not been specified");
201 // Map out all the annotation classes
202 for (const shared_ptr<decode::Decoder> &dec : stack_) {
204 const srd_decoder *const decc = dec->decoder();
205 assert(dec->decoder());
207 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
208 const srd_decoder_annotation_row *const ann_row =
209 (srd_decoder_annotation_row *)l->data;
212 const Row row(decc, ann_row);
214 for (const GSList *ll = ann_row->ann_classes;
216 class_rows_[make_pair(decc,
217 GPOINTER_TO_INT(ll->data))] = row;
221 // Free the logic data and its segment(s) if it needs to be updated
222 if (logic_mux_data_invalid_)
223 logic_mux_data_.reset();
225 if (!logic_mux_data_) {
226 const uint32_t ch_count = get_assigned_signal_count();
227 logic_mux_unit_size_ = (ch_count + 7) / 8;
228 logic_mux_data_ = make_shared<Logic>(ch_count);
231 // Receive notifications when new sample data is available
232 connect_input_notifiers();
234 if (get_input_segment_count() == 0) {
235 error_message_ = tr("No input data");
241 // Make sure the logic output data is complete and up-to-date
242 logic_mux_interrupt_ = false;
243 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
245 // Decode the muxed logic data
246 decode_interrupt_ = false;
247 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
250 QString DecodeSignal::error_message() const
252 lock_guard<mutex> lock(output_mutex_);
253 return error_message_;
256 const vector<data::DecodeChannel> DecodeSignal::get_channels() const
261 void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
263 bool new_assignment = false;
265 // Try to auto-select channels that don't have signals assigned yet
266 for (data::DecodeChannel &ch : channels_) {
267 // If a decoder is given, auto-assign only its channels
268 if (dec && (ch.decoder_ != dec))
271 if (ch.assigned_signal)
274 for (shared_ptr<data::SignalBase> s : session_.signalbases()) {
275 const QString ch_name = ch.name.toLower();
276 const QString s_name = s->name().toLower();
278 if (s->logic_data() &&
279 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
280 ch.assigned_signal = s.get();
281 new_assignment = true;
286 if (new_assignment) {
287 logic_mux_data_invalid_ = true;
288 commit_decoder_channels();
293 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
295 for (data::DecodeChannel &ch : channels_)
296 if (ch.id == channel_id) {
297 ch.assigned_signal = signal;
298 logic_mux_data_invalid_ = true;
301 commit_decoder_channels();
306 int DecodeSignal::get_assigned_signal_count() const
308 // Count all channels that have a signal assigned to them
309 return count_if(channels_.begin(), channels_.end(),
310 [](data::DecodeChannel ch) { return ch.assigned_signal; });
313 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
315 for (data::DecodeChannel &ch : channels_)
316 if (ch.id == channel_id)
317 ch.initial_pin_state = init_state;
324 double DecodeSignal::samplerate() const
328 // TODO For now, we simply return the first samplerate that we have
329 if (segments_.size() > 0)
330 result = segments_.front().samplerate;
335 const pv::util::Timestamp DecodeSignal::start_time() const
337 pv::util::Timestamp result;
339 // TODO For now, we simply return the first start time that we have
340 if (segments_.size() > 0)
341 result = segments_.front().start_time;
346 int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
348 // The working sample count is the highest sample number for
349 // which all used signals have data available, so go through all
350 // channels and use the lowest overall sample count of the segment
352 int64_t count = std::numeric_limits<int64_t>::max();
353 bool no_signals_assigned = true;
355 for (const data::DecodeChannel &ch : channels_)
356 if (ch.assigned_signal) {
357 no_signals_assigned = false;
359 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
360 if (!logic_data || logic_data->logic_segments().empty())
364 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
365 count = min(count, (int64_t)segment->get_sample_count());
366 } catch (out_of_range) {
371 return (no_signals_assigned ? 0 : count);
374 int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id) const
376 lock_guard<mutex> decode_lock(output_mutex_);
381 const DecodeSegment *segment = &(segments_.at(segment_id));
382 result = segment->samples_decoded;
383 } catch (out_of_range) {
390 vector<Row> DecodeSignal::visible_rows() const
392 lock_guard<mutex> lock(output_mutex_);
396 for (const shared_ptr<decode::Decoder> &dec : stack_) {
401 const srd_decoder *const decc = dec->decoder();
402 assert(dec->decoder());
404 // Add a row for the decoder if it doesn't have a row list
405 if (!decc->annotation_rows)
406 rows.emplace_back(decc);
408 // Add the decoder rows
409 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
410 const srd_decoder_annotation_row *const ann_row =
411 (srd_decoder_annotation_row *)l->data;
413 rows.emplace_back(decc, ann_row);
420 void DecodeSignal::get_annotation_subset(
421 vector<pv::data::decode::Annotation> &dest,
422 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
423 uint64_t end_sample) const
425 lock_guard<mutex> lock(output_mutex_);
428 const DecodeSegment *segment = &(segments_.at(segment_id));
429 const map<const decode::Row, decode::RowData> *rows =
430 &(segment->annotation_rows);
432 const auto iter = rows->find(row);
433 if (iter != rows->end())
434 (*iter).second.get_annotation_subset(dest,
435 start_sample, end_sample);
436 } catch (out_of_range) {
441 void DecodeSignal::save_settings(QSettings &settings) const
443 SignalBase::save_settings(settings);
445 settings.setValue("decoders", (int)(stack_.size()));
447 // Save decoder stack
449 for (shared_ptr<decode::Decoder> decoder : stack_) {
450 settings.beginGroup("decoder" + QString::number(decoder_idx++));
452 settings.setValue("id", decoder->decoder()->id);
454 // Save decoder options
455 const map<string, GVariant*>& options = decoder->options();
457 settings.setValue("options", (int)options.size());
459 // Note: decode::Decoder::options() returns only the options
460 // that differ from the default. See binding::Decoder::getter()
462 for (auto option : options) {
463 settings.beginGroup("option" + QString::number(i));
464 settings.setValue("name", QString::fromStdString(option.first));
465 GlobalSettings::store_gvariant(settings, option.second);
473 // Save channel mapping
474 settings.setValue("channels", (int)channels_.size());
476 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
477 auto channel = find_if(channels_.begin(), channels_.end(),
478 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
480 if (channel == channels_.end()) {
481 qDebug() << "ERROR: Gap in channel index:" << channel_id;
485 settings.beginGroup("channel" + QString::number(channel_id));
487 settings.setValue("name", channel->name); // Useful for debugging
488 settings.setValue("initial_pin_state", channel->initial_pin_state);
490 if (channel->assigned_signal)
491 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
497 void DecodeSignal::restore_settings(QSettings &settings)
499 SignalBase::restore_settings(settings);
501 // Restore decoder stack
502 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
504 int decoders = settings.value("decoders").toInt();
506 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
507 settings.beginGroup("decoder" + QString::number(decoder_idx));
509 QString id = settings.value("id").toString();
511 for (GSList *entry = dec_list; entry; entry = entry->next) {
512 const srd_decoder *dec = (srd_decoder*)entry->data;
516 if (QString::fromUtf8(dec->id) == id) {
517 shared_ptr<decode::Decoder> decoder =
518 make_shared<decode::Decoder>(dec);
520 stack_.push_back(decoder);
522 // Restore decoder options that differ from their default
523 int options = settings.value("options").toInt();
525 for (int i = 0; i < options; i++) {
526 settings.beginGroup("option" + QString::number(i));
527 QString name = settings.value("name").toString();
528 GVariant *value = GlobalSettings::restore_gvariant(settings);
529 decoder->set_option(name.toUtf8(), value);
533 // Include the newly created decode channels in the channel lists
534 update_channel_list();
543 // Restore channel mapping
544 unsigned int channels = settings.value("channels").toInt();
546 const unordered_set< shared_ptr<data::SignalBase> > signalbases =
547 session_.signalbases();
549 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
550 auto channel = find_if(channels_.begin(), channels_.end(),
551 [&](data::DecodeChannel ch) { return ch.id == channel_id; });
553 if (channel == channels_.end()) {
554 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
558 settings.beginGroup("channel" + QString::number(channel_id));
560 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
562 for (shared_ptr<data::SignalBase> signal : signalbases)
563 if (signal->name() == assigned_signal_name)
564 channel->assigned_signal = signal.get();
566 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
571 // Update the internal structures
572 update_channel_list();
573 commit_decoder_channels();
578 uint32_t DecodeSignal::get_input_segment_count() const
580 uint64_t count = std::numeric_limits<uint64_t>::max();
581 bool no_signals_assigned = true;
583 for (const data::DecodeChannel &ch : channels_)
584 if (ch.assigned_signal) {
585 no_signals_assigned = false;
587 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
588 if (!logic_data || logic_data->logic_segments().empty())
591 // Find the min value of all segment counts
592 if ((uint64_t)(logic_data->logic_segments().size()) < count)
593 count = logic_data->logic_segments().size();
596 return (no_signals_assigned ? 0 : count);
599 uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
601 double samplerate = 0;
603 for (const data::DecodeChannel &ch : channels_)
604 if (ch.assigned_signal) {
605 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
606 if (!logic_data || logic_data->logic_segments().empty())
610 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
611 samplerate = segment->samplerate();
612 } catch (out_of_range) {
621 void DecodeSignal::update_channel_list()
623 vector<data::DecodeChannel> prev_channels = channels_;
628 // Copy existing entries, create new as needed
629 for (shared_ptr<Decoder> decoder : stack_) {
630 const srd_decoder* srd_d = decoder->decoder();
633 // Mandatory channels
634 for (l = srd_d->channels; l; l = l->next) {
635 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
636 bool ch_added = false;
638 // Copy but update ID if this channel was in the list before
639 for (data::DecodeChannel &ch : prev_channels)
640 if (ch.pdch_ == pdch) {
642 channels_.push_back(ch);
648 // Create new entry without a mapped signal
649 data::DecodeChannel ch = {id++, 0, false, nullptr,
650 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
651 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
652 channels_.push_back(ch);
657 for (l = srd_d->opt_channels; l; l = l->next) {
658 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
659 bool ch_added = false;
661 // Copy but update ID if this channel was in the list before
662 for (data::DecodeChannel &ch : prev_channels)
663 if (ch.pdch_ == pdch) {
665 channels_.push_back(ch);
671 // Create new entry without a mapped signal
672 data::DecodeChannel ch = {id++, 0, true, nullptr,
673 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
674 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
675 channels_.push_back(ch);
680 // Invalidate the logic output data if the channel assignment changed
681 if (prev_channels.size() != channels_.size()) {
682 // The number of channels changed, there's definitely a difference
683 logic_mux_data_invalid_ = true;
685 // Same number but assignment may still differ, so compare all channels
686 for (size_t i = 0; i < channels_.size(); i++) {
687 const data::DecodeChannel &p_ch = prev_channels[i];
688 const data::DecodeChannel &ch = channels_[i];
690 if ((p_ch.pdch_ != ch.pdch_) ||
691 (p_ch.assigned_signal != ch.assigned_signal)) {
692 logic_mux_data_invalid_ = true;
702 void DecodeSignal::commit_decoder_channels()
704 // Submit channel list to every decoder, containing only the relevant channels
705 for (shared_ptr<decode::Decoder> dec : stack_) {
706 vector<data::DecodeChannel*> channel_list;
708 for (data::DecodeChannel &ch : channels_)
709 if (ch.decoder_ == dec)
710 channel_list.push_back(&ch);
712 dec->set_channels(channel_list);
715 // Channel bit IDs must be in sync with the channel's apperance in channels_
717 for (data::DecodeChannel &ch : channels_)
718 if (ch.assigned_signal)
722 void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
724 // Enforce end to be greater than start
728 // Fetch the channel segments and their data
729 vector<shared_ptr<LogicSegment> > segments;
730 vector<const uint8_t*> signal_data;
731 vector<uint8_t> signal_in_bytepos;
732 vector<uint8_t> signal_in_bitpos;
734 for (data::DecodeChannel &ch : channels_)
735 if (ch.assigned_signal) {
736 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
738 shared_ptr<LogicSegment> segment;
740 segment = logic_data->logic_segments().at(segment_id);
741 } catch (out_of_range) {
742 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
743 << "has no logic segment" << segment_id;
746 segments.push_back(segment);
748 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
749 segment->get_samples(start, end, data);
750 signal_data.push_back(data);
752 const int bitpos = ch.assigned_signal->logic_bit_index();
753 signal_in_bytepos.push_back(bitpos / 8);
754 signal_in_bitpos.push_back(bitpos % 8);
758 shared_ptr<LogicSegment> output_segment;
760 output_segment = logic_mux_data_->logic_segments().at(segment_id);
761 } catch (out_of_range) {
762 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
763 << segment_id << "in mux_logic_samples(), mux segments size is" \
764 << logic_mux_data_->logic_segments().size();
768 // Perform the muxing of signal data into the output data
769 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
770 unsigned int signal_count = signal_data.size();
772 for (int64_t sample_cnt = 0; sample_cnt < (end - start); sample_cnt++) {
776 const int out_sample_pos = sample_cnt * output_segment->unit_size();
777 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
778 output[out_sample_pos + i] = 0;
780 for (unsigned int i = 0; i < signal_count; i++) {
781 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
782 const uint8_t in_sample = 1 &
783 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
785 const uint8_t out_sample = output[out_sample_pos + bytepos];
787 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
797 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
800 for (const uint8_t* data : signal_data)
804 void DecodeSignal::logic_mux_proc()
806 uint32_t segment_id = 0;
808 assert(logic_mux_data_);
810 shared_ptr<LogicSegment> output_segment = logic_mux_data_->logic_segments().front();
811 assert(output_segment);
813 output_segment->set_samplerate(get_input_samplerate(0));
816 const uint64_t input_sample_count = get_working_sample_count(segment_id);
817 const uint64_t output_sample_count = output_segment->get_sample_count();
819 const uint64_t samples_to_process =
820 (input_sample_count > output_sample_count) ?
821 (input_sample_count - output_sample_count) : 0;
823 // Process the samples if necessary...
824 if (samples_to_process > 0) {
825 const uint64_t unit_size = output_segment->unit_size();
826 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
828 uint64_t processed_samples = 0;
830 const uint64_t start_sample = output_sample_count + processed_samples;
831 const uint64_t sample_count =
832 min(samples_to_process - processed_samples, chunk_sample_count);
834 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
835 processed_samples += sample_count;
837 // ...and process the newly muxed logic data
838 decode_input_cond_.notify_one();
839 } while (processed_samples < samples_to_process);
842 if (samples_to_process == 0) {
843 // TODO Optimize this by caching the input segment count and only
844 // querying it when the cached value was reached
845 if (segment_id < get_input_segment_count() - 1) {
846 // Process next segment
850 output_segment = logic_mux_data_->logic_segments().at(segment_id);
851 } catch (out_of_range) {
852 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
853 << segment_id << "in logic_mux_proc(), mux segments size is" \
854 << logic_mux_data_->logic_segments().size();
858 output_segment->set_samplerate(get_input_samplerate(segment_id));
861 // All segments have been processed
862 logic_mux_data_invalid_ = false;
864 // Wait for more input
865 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
866 logic_mux_cond_.wait(logic_mux_lock);
869 } while (!logic_mux_interrupt_);
872 void DecodeSignal::query_input_metadata()
874 // Update the samplerate and start time because we cannot start
875 // the libsrd session without the current samplerate
877 // TODO Currently we assume all channels have the same sample rate
879 bool samplerate_valid = false;
880 data::DecodeChannel *any_channel;
881 shared_ptr<Logic> logic_data;
884 any_channel = &(*find_if(channels_.begin(), channels_.end(),
885 [](data::DecodeChannel ch) { return ch.assigned_signal; }));
887 logic_data = any_channel->assigned_signal->logic_data();
890 // Wait until input data is available or an interrupt was requested
891 unique_lock<mutex> input_wait_lock(input_mutex_);
892 decode_input_cond_.wait(input_wait_lock);
894 } while (!logic_data && !decode_interrupt_);
896 if (decode_interrupt_)
900 if (!logic_data->logic_segments().empty()) {
901 shared_ptr<LogicSegment> first_segment =
902 any_channel->assigned_signal->logic_data()->logic_segments().front();
904 // We only need valid metadata in the first decode segment
905 // so that start_srd_session() can use it
906 segments_.at(current_segment_id_).start_time = first_segment->start_time();
907 segments_.at(current_segment_id_).samplerate = first_segment->samplerate();
909 if (segments_.at(current_segment_id_).samplerate > 0)
910 samplerate_valid = true;
913 if (!samplerate_valid) {
914 // Wait until input data is available or an interrupt was requested
915 unique_lock<mutex> input_wait_lock(input_mutex_);
916 decode_input_cond_.wait(input_wait_lock);
918 } while (!samplerate_valid && !decode_interrupt_);
921 void DecodeSignal::decode_data(
922 const int64_t abs_start_samplenum, const int64_t sample_count,
923 const shared_ptr<LogicSegment> input_segment)
925 const int64_t unit_size = input_segment->unit_size();
926 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
928 for (int64_t i = abs_start_samplenum;
929 !decode_interrupt_ && (i < (abs_start_samplenum + sample_count));
930 i += chunk_sample_count) {
932 const int64_t chunk_end = min(i + chunk_sample_count,
933 abs_start_samplenum + sample_count);
935 int64_t data_size = (chunk_end - i) * unit_size;
936 uint8_t* chunk = new uint8_t[data_size];
937 input_segment->get_samples(i, chunk_end, chunk);
939 if (srd_session_send(srd_session_, i, chunk_end, chunk,
940 data_size, unit_size) != SRD_OK) {
941 error_message_ = tr("Decoder reported an error");
949 lock_guard<mutex> lock(output_mutex_);
950 segments_.at(current_segment_id_).samples_decoded = chunk_end;
953 // Notify the frontend that we processed some data and
954 // possibly have new annotations as well
959 void DecodeSignal::decode_proc()
961 query_input_metadata();
963 if (decode_interrupt_)
968 current_segment_id_ = 0;
969 shared_ptr<LogicSegment> input_segment = logic_mux_data_->logic_segments().front();
971 assert(input_segment);
972 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
974 uint64_t sample_count;
975 uint64_t abs_start_samplenum = 0;
977 // Keep processing new samples until we exhaust the input data
979 lock_guard<mutex> input_lock(input_mutex_);
980 sample_count = input_segment->get_sample_count() - abs_start_samplenum;
982 if (sample_count > 0) {
983 decode_data(abs_start_samplenum, sample_count, input_segment);
984 abs_start_samplenum += sample_count;
986 } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
988 if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) {
989 if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
990 // Process next segment
991 current_segment_id_++;
994 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
995 } catch (out_of_range) {
996 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
997 << current_segment_id_ << "in decode_proc(), mux segments size is" \
998 << logic_mux_data_->logic_segments().size();
1001 abs_start_samplenum = 0;
1003 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1005 // Reset decoder state
1007 start_srd_session();
1009 // All segments have been processed
1012 // Wait for new input data or an interrupt was requested
1013 unique_lock<mutex> input_wait_lock(input_mutex_);
1014 decode_input_cond_.wait(input_wait_lock);
1017 } while (error_message_.isEmpty() && !decode_interrupt_);
1020 void DecodeSignal::start_srd_session()
1025 // Create the session
1026 srd_session_new(&srd_session_);
1027 assert(srd_session_);
1029 // Create the decoders
1030 srd_decoder_inst *prev_di = nullptr;
1031 for (const shared_ptr<decode::Decoder> &dec : stack_) {
1032 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
1035 error_message_ = tr("Failed to create decoder instance");
1036 srd_session_destroy(srd_session_);
1041 srd_inst_stack(srd_session_, prev_di, di);
1046 // Start the session
1047 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1048 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
1050 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1051 DecodeSignal::annotation_callback, this);
1053 srd_session_start(srd_session_);
1056 void DecodeSignal::stop_srd_session()
1059 // Destroy the session
1060 srd_session_destroy(srd_session_);
1061 srd_session_ = nullptr;
1065 void DecodeSignal::connect_input_notifiers()
1067 // Disconnect the notification slot from the previous set of signals
1068 disconnect(this, SLOT(on_data_cleared()));
1069 disconnect(this, SLOT(on_data_received()));
1071 // Connect the currently used signals to our slot
1072 for (data::DecodeChannel &ch : channels_) {
1073 if (!ch.assigned_signal)
1076 const data::SignalBase *signal = ch.assigned_signal;
1077 connect(signal, SIGNAL(samples_cleared()),
1078 this, SLOT(on_data_cleared()));
1079 connect(signal, SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
1080 this, SLOT(on_data_received()));
1084 void DecodeSignal::create_segments()
1086 // Make sure we have as many segments as we need
1087 const uint32_t input_segment_count = get_input_segment_count();
1089 for (uint32_t i = logic_mux_data_->logic_segments().size(); i < input_segment_count; i++) {
1090 shared_ptr<LogicSegment> segment =
1091 make_shared<LogicSegment>(*logic_mux_data_, logic_mux_unit_size_, 0);
1092 logic_mux_data_->push_segment(segment);
1095 for (uint32_t i = segments_.size(); i < input_segment_count; i++) {
1096 // Create annotation segment
1097 segments_.emplace_back(DecodeSegment());
1099 // Add annotation classes
1100 for (const shared_ptr<decode::Decoder> &dec : stack_) {
1102 const srd_decoder *const decc = dec->decoder();
1103 assert(dec->decoder());
1105 // Add a row for the decoder if it doesn't have a row list
1106 if (!decc->annotation_rows)
1107 (segments_.back().annotation_rows)[Row(decc)] =
1110 // Add the decoder rows
1111 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
1112 const srd_decoder_annotation_row *const ann_row =
1113 (srd_decoder_annotation_row *)l->data;
1116 const Row row(decc, ann_row);
1118 // Add a new empty row data object
1119 (segments_.back().annotation_rows)[row] =
1126 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1129 assert(decode_signal);
1131 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1134 lock_guard<mutex> lock(ds->output_mutex_);
1138 assert(pdata->pdo->di);
1139 const srd_decoder *const decc = pdata->pdo->di->decoder;
1142 const srd_proto_data_annotation *const pda =
1143 (const srd_proto_data_annotation*)pdata->data;
1146 auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end();
1148 // Try looking up the sub-row of this class
1149 const auto format = pda->ann_class;
1150 const auto r = ds->class_rows_.find(make_pair(decc, format));
1151 if (r != ds->class_rows_.end())
1152 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second);
1154 // Failing that, use the decoder as a key
1155 row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(decc));
1158 if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) {
1159 qDebug() << "Unexpected annotation: decoder = " << decc <<
1160 ", format = " << format;
1165 // Add the annotation
1166 (*row_iter).second.emplace_annotation(pdata);
1169 void DecodeSignal::on_capture_state_changed(int state)
1171 // If a new acquisition was started, we need to start decoding from scratch
1172 if (state == Session::Running) {
1173 logic_mux_data_invalid_ = true;
1178 void DecodeSignal::on_data_cleared()
1183 void DecodeSignal::on_data_received()
1187 if (!logic_mux_thread_.joinable())
1190 logic_mux_cond_.notify_one();