X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fdata%2Fdecodesignal.cpp;h=a17ea693aaa89d67ca3859751529e84b75b42eb2;hp=5fbc8b6ca630bab38093f61f4a3e230feea366d2;hb=4640a84e926ac4b82e2a1b6ef9fc80ef44c2bd3c;hpb=b10b58f40fd9c71f1a8b020077ecda65cebc578c diff --git a/pv/data/decodesignal.cpp b/pv/data/decodesignal.cpp index 5fbc8b6c..a17ea693 100644 --- a/pv/data/decodesignal.cpp +++ b/pv/data/decodesignal.cpp @@ -17,6 +17,8 @@ * along with this program; if not, see . */ +#include +#include #include #include @@ -26,22 +28,19 @@ #include "decodesignal.hpp" #include "signaldata.hpp" -#include #include #include #include #include using std::lock_guard; -using std::make_pair; using std::make_shared; using std::min; using std::out_of_range; using std::shared_ptr; using std::unique_lock; -using pv::data::decode::Annotation; -using pv::data::decode::Decoder; -using pv::data::decode::Row; +using pv::data::decode::AnnotationClass; +using pv::data::decode::DecodeChannel; namespace pv { namespace data { @@ -56,7 +55,9 @@ DecodeSignal::DecodeSignal(pv::Session &session) : session_(session), srd_session_(nullptr), logic_mux_data_invalid_(false), - current_segment_id_(0) + stack_config_changed_(true), + current_segment_id_(0), + error_message_("") { connect(&session_, SIGNAL(capture_state_changed(int)), this, SLOT(on_capture_state_changed(int))); @@ -64,7 +65,7 @@ DecodeSignal::DecodeSignal(pv::Session &session) : DecodeSignal::~DecodeSignal() { - reset_decode(); + reset_decode(true); } const vector< shared_ptr >& DecodeSignal::decoder_stack() const @@ -72,23 +73,34 @@ const vector< shared_ptr >& DecodeSignal::decoder_stack() const return stack_; } -void DecodeSignal::stack_decoder(const srd_decoder *decoder) +void DecodeSignal::stack_decoder(const srd_decoder *decoder, bool restart_decode) { assert(decoder); - const shared_ptr dec = make_shared(decoder); - stack_.push_back(dec); + // Set name if this decoder is the first in the list or the name is unchanged + const srd_decoder* prev_dec = stack_.empty() ? nullptr : stack_.back()->get_srd_decoder(); + const QString prev_dec_name = prev_dec ? QString::fromUtf8(prev_dec->name) : QString(); - // Set name if this decoder is the first in the list - if (stack_.size() == 1) + if ((stack_.empty()) || ((stack_.size() > 0) && (name() == prev_dec_name))) set_name(QString::fromUtf8(decoder->name)); + const shared_ptr dec = make_shared(decoder, stack_.size()); + stack_.push_back(dec); + + connect(dec.get(), SIGNAL(annotation_visibility_changed()), + this, SLOT(on_annotation_visibility_changed())); + // Include the newly created decode channels in the channel lists update_channel_list(); + stack_config_changed_ = true; auto_assign_signals(dec); commit_decoder_channels(); - begin_decode(); + + decoder_stacked((void*)dec.get()); + + if (restart_decode) + begin_decode(); } void DecodeSignal::remove_decoder(int index) @@ -97,14 +109,18 @@ void DecodeSignal::remove_decoder(int index) assert(index < (int)stack_.size()); // Find the decoder in the stack - auto iter = stack_.begin(); - for (int i = 0; i < index; i++, iter++) - assert(iter != stack_.end()); + auto iter = stack_.begin() + index; + assert(iter != stack_.end()); + + shared_ptr dec = *iter; + + decoder_removed(dec.get()); // Delete the element stack_.erase(iter); // Update channels and decoded data + stack_config_changed_ = true; update_channel_list(); begin_decode(); } @@ -120,15 +136,22 @@ bool DecodeSignal::toggle_decoder_visibility(int index) // Toggle decoder visibility bool state = false; if (dec) { - state = !dec->shown(); - dec->show(state); + state = !dec->visible(); + dec->set_visible(state); } return state; } -void DecodeSignal::reset_decode() +void DecodeSignal::reset_decode(bool shutting_down) { + resume_decode(); // Make sure the decode thread isn't blocked by pausing + + if (stack_config_changed_ || shutting_down) + stop_srd_session(); + else + terminate_srd_session(); + if (decode_thread_.joinable()) { decode_interrupt_ = true; decode_input_cond_.notify_one(); @@ -141,16 +164,17 @@ void DecodeSignal::reset_decode() logic_mux_thread_.join(); } - stop_srd_session(); - - class_rows_.clear(); current_segment_id_ = 0; segments_.clear(); logic_mux_data_.reset(); logic_mux_data_invalid_ = true; - error_message_ = QString(); + if (!error_message_.isEmpty()) { + error_message_ = QString(); + // TODO Emulate noquote() + qDebug().nospace() << name() << ": Error cleared"; + } decode_reset(); } @@ -172,52 +196,32 @@ void DecodeSignal::begin_decode() reset_decode(); if (stack_.size() == 0) { - error_message_ = tr("No decoders"); + set_error_message(tr("No decoders")); return; } assert(channels_.size() > 0); if (get_assigned_signal_count() == 0) { - error_message_ = tr("There are no channels assigned to this decoder"); + set_error_message(tr("There are no channels assigned to this decoder")); return; } // Make sure that all assigned channels still provide logic data // (can happen when a converted signal was assigned but the // conversion removed in the meanwhile) - for (data::DecodeChannel &ch : channels_) + for (decode::DecodeChannel& ch : channels_) if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr)) ch.assigned_signal = nullptr; // Check that all decoders have the required channels - for (const shared_ptr &dec : stack_) + for (const shared_ptr& dec : stack_) if (!dec->have_required_channels()) { - error_message_ = tr("One or more required channels " - "have not been specified"); + set_error_message(tr("One or more required channels " + "have not been specified")); return; } - // Map out all the annotation classes - for (const shared_ptr &dec : stack_) { - assert(dec); - const srd_decoder *const decc = dec->decoder(); - assert(dec->decoder()); - - for (const GSList *l = decc->annotation_rows; l; l = l->next) { - const srd_decoder_annotation_row *const ann_row = - (srd_decoder_annotation_row *)l->data; - assert(ann_row); - - const Row row(decc, ann_row); - - for (const GSList *ll = ann_row->ann_classes; - ll; ll = ll->next) - class_rows_[make_pair(decc, - GPOINTER_TO_INT(ll->data))] = row; - } - } - // Free the logic data and its segment(s) if it needs to be updated if (logic_mux_data_invalid_) logic_mux_data_.reset(); @@ -232,7 +236,7 @@ void DecodeSignal::begin_decode() connect_input_notifiers(); if (get_input_segment_count() == 0) { - error_message_ = tr("No input data"); + set_error_message(tr("No input data")); return; } @@ -245,13 +249,32 @@ void DecodeSignal::begin_decode() decode_thread_ = std::thread(&DecodeSignal::decode_proc, this); } +void DecodeSignal::pause_decode() +{ + decode_paused_ = true; +} + +void DecodeSignal::resume_decode() +{ + // Manual unlocking is done before notifying, to avoid waking up the + // waiting thread only to block again (see notify_one for details) + decode_pause_mutex_.unlock(); + decode_pause_cond_.notify_one(); + decode_paused_ = false; +} + +bool DecodeSignal::is_paused() const +{ + return decode_paused_; +} + QString DecodeSignal::error_message() const { lock_guard lock(output_mutex_); return error_message_; } -const vector DecodeSignal::get_channels() const +const vector DecodeSignal::get_channels() const { return channels_; } @@ -261,7 +284,7 @@ void DecodeSignal::auto_assign_signals(const shared_ptr dec) bool new_assignment = false; // Try to auto-select channels that don't have signals assigned yet - for (data::DecodeChannel &ch : channels_) { + for (decode::DecodeChannel& ch : channels_) { // If a decoder is given, auto-assign only its channels if (dec && (ch.decoder_ != dec)) continue; @@ -269,20 +292,40 @@ void DecodeSignal::auto_assign_signals(const shared_ptr dec) if (ch.assigned_signal) continue; - for (shared_ptr s : session_.signalbases()) { - const QString ch_name = ch.name.toLower(); - const QString s_name = s->name().toLower(); + QString ch_name = ch.name.toLower(); + ch_name = ch_name.replace(QRegExp("[-_.]"), " "); + + shared_ptr match; + for (const shared_ptr& s : session_.signalbases()) { + if (!s->enabled()) + continue; + + QString s_name = s->name().toLower(); + s_name = s_name.replace(QRegExp("[-_.]"), " "); if (s->logic_data() && ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) { - ch.assigned_signal = s.get(); - new_assignment = true; + if (!match) + match = s; + else { + // Only replace an existing match if it matches more characters + int old_unmatched = ch_name.length() - match->name().length(); + int new_unmatched = ch_name.length() - s->name().length(); + if (abs(new_unmatched) < abs(old_unmatched)) + match = s; + } } } + + if (match) { + ch.assigned_signal = match.get(); + new_assignment = true; + } } if (new_assignment) { logic_mux_data_invalid_ = true; + stack_config_changed_ = true; commit_decoder_channels(); channels_updated(); } @@ -290,12 +333,13 @@ void DecodeSignal::auto_assign_signals(const shared_ptr dec) void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal) { - for (data::DecodeChannel &ch : channels_) + for (decode::DecodeChannel& ch : channels_) if (ch.id == channel_id) { ch.assigned_signal = signal; logic_mux_data_invalid_ = true; } + stack_config_changed_ = true; commit_decoder_channels(); channels_updated(); begin_decode(); @@ -305,21 +349,21 @@ int DecodeSignal::get_assigned_signal_count() const { // Count all channels that have a signal assigned to them return count_if(channels_.begin(), channels_.end(), - [](data::DecodeChannel ch) { return ch.assigned_signal; }); + [](decode::DecodeChannel ch) { return ch.assigned_signal; }); } void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state) { - for (data::DecodeChannel &ch : channels_) + for (decode::DecodeChannel& ch : channels_) if (ch.id == channel_id) ch.initial_pin_state = init_state; + stack_config_changed_ = true; channels_updated(); - begin_decode(); } -double DecodeSignal::samplerate() const +double DecodeSignal::get_samplerate() const { double result = 0; @@ -350,92 +394,264 @@ int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const int64_t count = std::numeric_limits::max(); bool no_signals_assigned = true; - for (const data::DecodeChannel &ch : channels_) + for (const decode::DecodeChannel& ch : channels_) if (ch.assigned_signal) { + if (!ch.assigned_signal->logic_data()) + return 0; + no_signals_assigned = false; const shared_ptr logic_data = ch.assigned_signal->logic_data(); - if (!logic_data || logic_data->logic_segments().empty()) + if (logic_data->logic_segments().empty()) return 0; - try { - const shared_ptr segment = logic_data->logic_segments().at(segment_id); - count = min(count, (int64_t)segment->get_sample_count()); - } catch (out_of_range) { + if (segment_id >= logic_data->logic_segments().size()) return 0; - } + + const shared_ptr segment = logic_data->logic_segments()[segment_id]; + count = min(count, (int64_t)segment->get_sample_count()); } return (no_signals_assigned ? 0 : count); } -int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id) const +int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id, + bool include_processing) const { lock_guard decode_lock(output_mutex_); int64_t result = 0; - try { - const DecodeSegment *segment = &(segments_.at(segment_id)); - result = segment->samples_decoded; - } catch (out_of_range) { - // Do nothing - } + if (segment_id >= segments_.size()) + return result; + + if (include_processing) + result = segments_[segment_id].samples_decoded_incl; + else + result = segments_[segment_id].samples_decoded_excl; return result; } -vector DecodeSignal::visible_rows() const +vector DecodeSignal::get_rows(bool visible_only) { - lock_guard lock(output_mutex_); + vector rows; - vector rows; - - for (const shared_ptr &dec : stack_) { + for (const shared_ptr& dec : stack_) { assert(dec); - if (!dec->shown()) + if (visible_only && !dec->visible()) continue; - const srd_decoder *const decc = dec->decoder(); - assert(dec->decoder()); + for (Row* row : dec->get_rows()) + rows.push_back(row); + } + + return rows; +} - // Add a row for the decoder if it doesn't have a row list - if (!decc->annotation_rows) - rows.emplace_back(decc); +vector DecodeSignal::get_rows(bool visible_only) const +{ + vector rows; - // Add the decoder rows - for (const GSList *l = decc->annotation_rows; l; l = l->next) { - const srd_decoder_annotation_row *const ann_row = - (srd_decoder_annotation_row *)l->data; - assert(ann_row); - rows.emplace_back(decc, ann_row); - } + for (const shared_ptr& dec : stack_) { + assert(dec); + if (visible_only && !dec->visible()) + continue; + + for (const Row* row : dec->get_rows()) + rows.push_back(row); } return rows; } -void DecodeSignal::get_annotation_subset( - vector &dest, - const decode::Row &row, uint32_t segment_id, uint64_t start_sample, + +uint64_t DecodeSignal::get_annotation_count(const Row* row, uint32_t segment_id) const +{ + if (segment_id >= segments_.size()) + return 0; + + const DecodeSegment* segment = &(segments_.at(segment_id)); + + auto row_it = segment->annotation_rows.find(row); + + const RowData* rd; + if (row_it == segment->annotation_rows.end()) + return 0; + else + rd = &(row_it->second); + + return rd->get_annotation_count(); +} + +void DecodeSignal::get_annotation_subset(deque &dest, + const Row* row, uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const { lock_guard lock(output_mutex_); - try { - const DecodeSegment *segment = &(segments_.at(segment_id)); - const map *rows = - &(segment->annotation_rows); - - const auto iter = rows->find(row); - if (iter != rows->end()) - (*iter).second.get_annotation_subset(dest, - start_sample, end_sample); - } catch (out_of_range) { - // Do nothing + if (segment_id >= segments_.size()) + return; + + const DecodeSegment* segment = &(segments_.at(segment_id)); + + auto row_it = segment->annotation_rows.find(row); + + const RowData* rd; + if (row_it == segment->annotation_rows.end()) + return; + else + rd = &(row_it->second); + + rd->get_annotation_subset(dest, start_sample, end_sample); +} + +void DecodeSignal::get_annotation_subset(deque &dest, + uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const +{ + for (const Row* row : get_rows()) + get_annotation_subset(dest, row, segment_id, start_sample, end_sample); +} + +uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id, + const Decoder* dec, uint32_t bin_class_id) const +{ + if ((segments_.size() == 0) || (segment_id >= segments_.size())) + return 0; + + const DecodeSegment *segment = &(segments_[segment_id]); + + for (const DecodeBinaryClass& bc : segment->binary_classes) + if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) + return bc.chunks.size(); + + return 0; +} + +void DecodeSignal::get_binary_data_chunk(uint32_t segment_id, + const Decoder* dec, uint32_t bin_class_id, uint32_t chunk_id, + const vector **dest, uint64_t *size) +{ + if (segment_id >= segments_.size()) + return; + + const DecodeSegment *segment = &(segments_[segment_id]); + + for (const DecodeBinaryClass& bc : segment->binary_classes) + if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) { + if (dest) *dest = &(bc.chunks.at(chunk_id).data); + if (size) *size = bc.chunks.at(chunk_id).data.size(); + return; + } +} + +void DecodeSignal::get_merged_binary_data_chunks_by_sample(uint32_t segment_id, + const Decoder* dec, uint32_t bin_class_id, uint64_t start_sample, + uint64_t end_sample, vector *dest) const +{ + assert(dest != nullptr); + + if (segment_id >= segments_.size()) + return; + + const DecodeSegment *segment = &(segments_[segment_id]); + + const DecodeBinaryClass* bin_class = nullptr; + for (const DecodeBinaryClass& bc : segment->binary_classes) + if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) + bin_class = &bc; + + // Determine overall size before copying to resize dest vector only once + uint64_t size = 0; + uint64_t matches = 0; + for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) + if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) { + size += chunk.data.size(); + matches++; + } + dest->resize(size); + + uint64_t offset = 0; + uint64_t matches2 = 0; + for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) + if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) { + memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size()); + offset += chunk.data.size(); + matches2++; + + // Make sure we don't overwrite memory if the array grew in the meanwhile + if (matches2 == matches) + break; + } +} + +void DecodeSignal::get_merged_binary_data_chunks_by_offset(uint32_t segment_id, + const Decoder* dec, uint32_t bin_class_id, uint64_t start, uint64_t end, + vector *dest) const +{ + assert(dest != nullptr); + + if (segment_id >= segments_.size()) + return; + + const DecodeSegment *segment = &(segments_[segment_id]); + + const DecodeBinaryClass* bin_class = nullptr; + for (const DecodeBinaryClass& bc : segment->binary_classes) + if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) + bin_class = &bc; + + // Determine overall size before copying to resize dest vector only once + uint64_t size = 0; + uint64_t offset = 0; + for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) { + if (offset >= start) + size += chunk.data.size(); + offset += chunk.data.size(); + if (offset >= end) + break; + } + dest->resize(size); + + offset = 0; + uint64_t dest_offset = 0; + for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) { + if (offset >= start) { + memcpy(dest->data() + dest_offset, chunk.data.data(), chunk.data.size()); + dest_offset += chunk.data.size(); + } + offset += chunk.data.size(); + if (offset >= end) + break; } } +const DecodeBinaryClass* DecodeSignal::get_binary_data_class(uint32_t segment_id, + const Decoder* dec, uint32_t bin_class_id) const +{ + if (segment_id >= segments_.size()) + return nullptr; + + const DecodeSegment *segment = &(segments_[segment_id]); + + for (const DecodeBinaryClass& bc : segment->binary_classes) + if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) + return &bc; + + return nullptr; +} + +const deque* DecodeSignal::get_all_annotations_by_segment( + uint32_t segment_id) const +{ + if (segment_id >= segments_.size()) + return nullptr; + + const DecodeSegment *segment = &(segments_[segment_id]); + + return &(segment->all_annotations); +} + void DecodeSignal::save_settings(QSettings &settings) const { SignalBase::save_settings(settings); @@ -444,20 +660,21 @@ void DecodeSignal::save_settings(QSettings &settings) const // Save decoder stack int decoder_idx = 0; - for (shared_ptr decoder : stack_) { + for (const shared_ptr& decoder : stack_) { settings.beginGroup("decoder" + QString::number(decoder_idx++)); - settings.setValue("id", decoder->decoder()->id); + settings.setValue("id", decoder->get_srd_decoder()->id); + settings.setValue("visible", decoder->visible()); // Save decoder options const map& options = decoder->options(); settings.setValue("options", (int)options.size()); - // Note: decode::Decoder::options() returns only the options + // Note: Decoder::options() returns only the options // that differ from the default. See binding::Decoder::getter() int i = 0; - for (auto option : options) { + for (auto& option : options) { settings.beginGroup("option" + QString::number(i)); settings.setValue("name", QString::fromStdString(option.first)); GlobalSettings::store_gvariant(settings, option.second); @@ -465,6 +682,24 @@ void DecodeSignal::save_settings(QSettings &settings) const i++; } + // Save row properties + i = 0; + for (const Row* row : decoder->get_rows()) { + settings.beginGroup("row" + QString::number(i)); + settings.setValue("visible", row->visible()); + settings.endGroup(); + i++; + } + + // Save class properties + i = 0; + for (const AnnotationClass* ann_class : decoder->ann_classes()) { + settings.beginGroup("ann_class" + QString::number(i)); + settings.setValue("visible", ann_class->visible()); + settings.endGroup(); + i++; + } + settings.endGroup(); } @@ -473,7 +708,7 @@ void DecodeSignal::save_settings(QSettings &settings) const for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) { auto channel = find_if(channels_.begin(), channels_.end(), - [&](data::DecodeChannel ch) { return ch.id == channel_id; }); + [&](decode::DecodeChannel ch) { return ch.id == channel_id; }); if (channel == channels_.end()) { qDebug() << "ERROR: Gap in channel index:" << channel_id; @@ -512,10 +747,13 @@ void DecodeSignal::restore_settings(QSettings &settings) continue; if (QString::fromUtf8(dec->id) == id) { - shared_ptr decoder = - make_shared(dec); + shared_ptr decoder = make_shared(dec, stack_.size()); + + connect(decoder.get(), SIGNAL(annotation_visibility_changed()), + this, SLOT(on_annotation_visibility_changed())); stack_.push_back(decoder); + decoder->set_visible(settings.value("visible", true).toBool()); // Restore decoder options that differ from their default int options = settings.value("options").toInt(); @@ -530,6 +768,25 @@ void DecodeSignal::restore_settings(QSettings &settings) // Include the newly created decode channels in the channel lists update_channel_list(); + + // Restore row properties + int i = 0; + for (Row* row : decoder->get_rows()) { + settings.beginGroup("row" + QString::number(i)); + row->set_visible(settings.value("visible", true).toBool()); + settings.endGroup(); + i++; + } + + // Restore class properties + i = 0; + for (AnnotationClass* ann_class : decoder->ann_classes()) { + settings.beginGroup("ann_class" + QString::number(i)); + ann_class->set_visible(settings.value("visible", true).toBool()); + settings.endGroup(); + i++; + } + break; } } @@ -541,12 +798,12 @@ void DecodeSignal::restore_settings(QSettings &settings) // Restore channel mapping unsigned int channels = settings.value("channels").toInt(); - const unordered_set< shared_ptr > signalbases = + const vector< shared_ptr > signalbases = session_.signalbases(); for (unsigned int channel_id = 0; channel_id < channels; channel_id++) { auto channel = find_if(channels_.begin(), channels_.end(), - [&](data::DecodeChannel ch) { return ch.id == channel_id; }); + [&](decode::DecodeChannel ch) { return ch.id == channel_id; }); if (channel == channels_.end()) { qDebug() << "ERROR: Non-existant channel index:" << channel_id; @@ -557,8 +814,8 @@ void DecodeSignal::restore_settings(QSettings &settings) QString assigned_signal_name = settings.value("assigned_signal_name").toString(); - for (shared_ptr signal : signalbases) - if (signal->name() == assigned_signal_name) + for (const shared_ptr& signal : signalbases) + if ((signal->name() == assigned_signal_name) && (signal->type() != SignalBase::DecodeChannel)) channel->assigned_signal = signal.get(); channel->initial_pin_state = settings.value("initial_pin_state").toInt(); @@ -567,18 +824,26 @@ void DecodeSignal::restore_settings(QSettings &settings) } // Update the internal structures + stack_config_changed_ = true; update_channel_list(); commit_decoder_channels(); begin_decode(); } +void DecodeSignal::set_error_message(QString msg) +{ + error_message_ = msg; + // TODO Emulate noquote() + qDebug().nospace() << name() << ": " << msg; +} + uint32_t DecodeSignal::get_input_segment_count() const { uint64_t count = std::numeric_limits::max(); bool no_signals_assigned = true; - for (const data::DecodeChannel &ch : channels_) + for (const decode::DecodeChannel& ch : channels_) if (ch.assigned_signal) { no_signals_assigned = false; @@ -594,11 +859,11 @@ uint32_t DecodeSignal::get_input_segment_count() const return (no_signals_assigned ? 0 : count); } -uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const +double DecodeSignal::get_input_samplerate(uint32_t segment_id) const { double samplerate = 0; - for (const data::DecodeChannel &ch : channels_) + for (const decode::DecodeChannel& ch : channels_) if (ch.assigned_signal) { const shared_ptr logic_data = ch.assigned_signal->logic_data(); if (!logic_data || logic_data->logic_segments().empty()) @@ -607,7 +872,7 @@ uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const try { const shared_ptr segment = logic_data->logic_segments().at(segment_id); samplerate = segment->samplerate(); - } catch (out_of_range) { + } catch (out_of_range&) { // Do nothing } break; @@ -616,25 +881,34 @@ uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const return samplerate; } +Decoder* DecodeSignal::get_decoder_by_instance(const srd_decoder *const srd_dec) +{ + for (shared_ptr& d : stack_) + if (d->get_srd_decoder() == srd_dec) + return d.get(); + + return nullptr; +} + void DecodeSignal::update_channel_list() { - vector prev_channels = channels_; + vector prev_channels = channels_; channels_.clear(); uint16_t id = 0; // Copy existing entries, create new as needed - for (shared_ptr decoder : stack_) { - const srd_decoder* srd_d = decoder->decoder(); + for (shared_ptr& decoder : stack_) { + const srd_decoder* srd_dec = decoder->get_srd_decoder(); const GSList *l; // Mandatory channels - for (l = srd_d->channels; l; l = l->next) { + for (l = srd_dec->channels; l; l = l->next) { const struct srd_channel *const pdch = (struct srd_channel *)l->data; bool ch_added = false; // Copy but update ID if this channel was in the list before - for (data::DecodeChannel &ch : prev_channels) + for (decode::DecodeChannel& ch : prev_channels) if (ch.pdch_ == pdch) { ch.id = id++; channels_.push_back(ch); @@ -644,7 +918,7 @@ void DecodeSignal::update_channel_list() if (!ch_added) { // Create new entry without a mapped signal - data::DecodeChannel ch = {id++, 0, false, nullptr, + decode::DecodeChannel ch = {id++, 0, false, nullptr, QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc), SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch}; channels_.push_back(ch); @@ -652,12 +926,12 @@ void DecodeSignal::update_channel_list() } // Optional channels - for (l = srd_d->opt_channels; l; l = l->next) { + for (l = srd_dec->opt_channels; l; l = l->next) { const struct srd_channel *const pdch = (struct srd_channel *)l->data; bool ch_added = false; // Copy but update ID if this channel was in the list before - for (data::DecodeChannel &ch : prev_channels) + for (decode::DecodeChannel& ch : prev_channels) if (ch.pdch_ == pdch) { ch.id = id++; channels_.push_back(ch); @@ -667,7 +941,7 @@ void DecodeSignal::update_channel_list() if (!ch_added) { // Create new entry without a mapped signal - data::DecodeChannel ch = {id++, 0, true, nullptr, + decode::DecodeChannel ch = {id++, 0, true, nullptr, QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc), SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch}; channels_.push_back(ch); @@ -682,8 +956,8 @@ void DecodeSignal::update_channel_list() } else { // Same number but assignment may still differ, so compare all channels for (size_t i = 0; i < channels_.size(); i++) { - const data::DecodeChannel &p_ch = prev_channels[i]; - const data::DecodeChannel &ch = channels_[i]; + const decode::DecodeChannel& p_ch = prev_channels[i]; + const decode::DecodeChannel& ch = channels_[i]; if ((p_ch.pdch_ != ch.pdch_) || (p_ch.assigned_signal != ch.assigned_signal)) { @@ -700,10 +974,10 @@ void DecodeSignal::update_channel_list() void DecodeSignal::commit_decoder_channels() { // Submit channel list to every decoder, containing only the relevant channels - for (shared_ptr dec : stack_) { - vector channel_list; + for (shared_ptr dec : stack_) { + vector channel_list; - for (data::DecodeChannel &ch : channels_) + for (decode::DecodeChannel& ch : channels_) if (ch.decoder_ == dec) channel_list.push_back(&ch); @@ -712,7 +986,7 @@ void DecodeSignal::commit_decoder_channels() // Channel bit IDs must be in sync with the channel's apperance in channels_ int id = 0; - for (data::DecodeChannel &ch : channels_) + for (decode::DecodeChannel& ch : channels_) if (ch.assigned_signal) ch.bit_id = id++; } @@ -729,14 +1003,14 @@ void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, c vector signal_in_bytepos; vector signal_in_bitpos; - for (data::DecodeChannel &ch : channels_) + for (decode::DecodeChannel& ch : channels_) if (ch.assigned_signal) { const shared_ptr logic_data = ch.assigned_signal->logic_data(); shared_ptr segment; try { segment = logic_data->logic_segments().at(segment_id); - } catch (out_of_range) { + } catch (out_of_range&) { qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \ << "has no logic segment" << segment_id; return; @@ -756,7 +1030,7 @@ void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, c shared_ptr output_segment; try { output_segment = logic_mux_data_->logic_segments().at(segment_id); - } catch (out_of_range) { + } catch (out_of_range&) { qDebug() << "Muxer error for" << name() << ": no logic mux segment" \ << segment_id << "in mux_logic_samples(), mux segments size is" \ << logic_mux_data_->logic_segments().size(); @@ -767,7 +1041,9 @@ void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, c uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()]; unsigned int signal_count = signal_data.size(); - for (int64_t sample_cnt = 0; sample_cnt < (end - start); sample_cnt++) { + for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start)); + sample_cnt++) { + int bitpos = 0; uint8_t bytepos = 0; @@ -837,7 +1113,7 @@ void DecodeSignal::logic_mux_proc() // ...and process the newly muxed logic data decode_input_cond_.notify_one(); - } while (processed_samples < samples_to_process); + } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process)); } if (samples_to_process == 0) { @@ -853,7 +1129,6 @@ void DecodeSignal::logic_mux_proc() logic_mux_data_->push_segment(output_segment); output_segment->set_samplerate(get_input_samplerate(segment_id)); - } else { // All segments have been processed logic_mux_data_invalid_ = false; @@ -863,6 +1138,7 @@ void DecodeSignal::logic_mux_proc() logic_mux_cond_.wait(logic_mux_lock); } } + } while (!logic_mux_interrupt_); } @@ -874,33 +1150,43 @@ void DecodeSignal::decode_data( const int64_t chunk_sample_count = DecodeChunkLength / unit_size; for (int64_t i = abs_start_samplenum; - !decode_interrupt_ && (i < (abs_start_samplenum + sample_count)); + error_message_.isEmpty() && !decode_interrupt_ && + (i < (abs_start_samplenum + sample_count)); i += chunk_sample_count) { const int64_t chunk_end = min(i + chunk_sample_count, abs_start_samplenum + sample_count); + { + lock_guard lock(output_mutex_); + // Update the sample count showing the samples including currently processed ones + segments_.at(current_segment_id_).samples_decoded_incl = chunk_end; + } + int64_t data_size = (chunk_end - i) * unit_size; uint8_t* chunk = new uint8_t[data_size]; input_segment->get_samples(i, chunk_end, chunk); if (srd_session_send(srd_session_, i, chunk_end, chunk, - data_size, unit_size) != SRD_OK) { - error_message_ = tr("Decoder reported an error"); - delete[] chunk; - break; - } + data_size, unit_size) != SRD_OK) + set_error_message(tr("Decoder reported an error")); delete[] chunk; { lock_guard lock(output_mutex_); - segments_.at(current_segment_id_).samples_decoded = chunk_end; + // Now that all samples are processed, the exclusive sample count catches up + segments_.at(current_segment_id_).samples_decoded_excl = chunk_end; } // Notify the frontend that we processed some data and // possibly have new annotations as well new_annotations(); + + if (decode_paused_) { + unique_lock pause_wait_lock(decode_pause_mutex_); + decode_pause_cond_.wait(pause_wait_lock); + } } } @@ -948,7 +1234,7 @@ void DecodeSignal::decode_proc() try { input_segment = logic_mux_data_->logic_segments().at(current_segment_id_); - } catch (out_of_range) { + } catch (out_of_range&) { qDebug() << "Decode error for" << name() << ": no logic mux segment" \ << current_segment_id_ << "in decode_proc(), mux segments size is" \ << logic_mux_data_->logic_segments().size(); @@ -961,9 +1247,8 @@ void DecodeSignal::decode_proc() segments_.at(current_segment_id_).samplerate = input_segment->samplerate(); segments_.at(current_segment_id_).start_time = input_segment->start_time(); - // Reset decoder state - stop_srd_session(); - start_srd_session(); + // Reset decoder state but keep the decoder stack intact + terminate_srd_session(); } else { // All segments have been processed decode_finished(); @@ -974,14 +1259,41 @@ void DecodeSignal::decode_proc() } } } while (error_message_.isEmpty() && !decode_interrupt_); + + // Potentially reap decoders when the application no longer is + // interested in their (pending) results. + if (decode_interrupt_) + terminate_srd_session(); } void DecodeSignal::start_srd_session() { - uint64_t samplerate; + // If there were stack changes, the session has been destroyed by now, so if + // it hasn't been destroyed, we can just reset and re-use it + if (srd_session_) { + // When a decoder stack was created before, re-use it + // for the next stream of input data, after terminating + // potentially still executing operations, and resetting + // internal state. Skip the rather expensive (teardown + // and) construction of another decoder stack. + + // TODO Reduce redundancy, use a common code path for + // the meta/start sequence? + terminate_srd_session(); + + // Metadata is cleared also, so re-set it + uint64_t samplerate = 0; + if (segments_.size() > 0) + samplerate = segments_.at(current_segment_id_).samplerate; + if (samplerate) + srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE, + g_variant_new_uint64(samplerate)); + for (const shared_ptr& dec : stack_) + dec->apply_all_options(); + srd_session_start(srd_session_); - if (srd_session_) - stop_srd_session(); + return; + } // Create the session srd_session_new(&srd_session_); @@ -989,11 +1301,11 @@ void DecodeSignal::start_srd_session() // Create the decoders srd_decoder_inst *prev_di = nullptr; - for (const shared_ptr &dec : stack_) { + for (const shared_ptr& dec : stack_) { srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_); if (!di) { - error_message_ = tr("Failed to create decoder instance"); + set_error_message(tr("Failed to create decoder instance")); srd_session_destroy(srd_session_); srd_session_ = nullptr; return; @@ -1006,15 +1318,42 @@ void DecodeSignal::start_srd_session() } // Start the session - samplerate = segments_.at(current_segment_id_).samplerate; - if (samplerate) + if (segments_.size() > 0) srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE, - g_variant_new_uint64(samplerate)); + g_variant_new_uint64(segments_.at(current_segment_id_).samplerate)); srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN, DecodeSignal::annotation_callback, this); + srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY, + DecodeSignal::binary_callback, this); + srd_session_start(srd_session_); + + // We just recreated the srd session, so all stack changes are applied now + stack_config_changed_ = false; +} + +void DecodeSignal::terminate_srd_session() +{ + // Call the "terminate and reset" routine for the decoder stack + // (if available). This does not harm those stacks which already + // have completed their operation, and reduces response time for + // those stacks which still are processing data while the + // application no longer wants them to. + if (srd_session_) { + srd_session_terminate_reset(srd_session_); + + // Metadata is cleared also, so re-set it + uint64_t samplerate = 0; + if (segments_.size() > 0) + samplerate = segments_.at(current_segment_id_).samplerate; + if (samplerate) + srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE, + g_variant_new_uint64(samplerate)); + for (const shared_ptr& dec : stack_) + dec->apply_all_options(); + } } void DecodeSignal::stop_srd_session() @@ -1023,6 +1362,10 @@ void DecodeSignal::stop_srd_session() // Destroy the session srd_session_destroy(srd_session_); srd_session_ = nullptr; + + // Mark the decoder instances as non-existant since they were deleted + for (const shared_ptr& dec : stack_) + dec->invalidate_decoder_inst(); } } @@ -1033,7 +1376,7 @@ void DecodeSignal::connect_input_notifiers() disconnect(this, SLOT(on_data_received())); // Connect the currently used signals to our slot - for (data::DecodeChannel &ch : channels_) { + for (decode::DecodeChannel& ch : channels_) { if (!ch.assigned_signal) continue; @@ -1048,31 +1391,20 @@ void DecodeSignal::connect_input_notifiers() void DecodeSignal::create_decode_segment() { // Create annotation segment - segments_.emplace_back(DecodeSegment()); + segments_.emplace_back(); // Add annotation classes - for (const shared_ptr &dec : stack_) { - assert(dec); - const srd_decoder *const decc = dec->decoder(); - assert(dec->decoder()); - - // Add a row for the decoder if it doesn't have a row list - if (!decc->annotation_rows) - (segments_.back().annotation_rows)[Row(decc)] = - decode::RowData(); + for (const shared_ptr& dec : stack_) + for (Row* row : dec->get_rows()) + segments_.back().annotation_rows.emplace(row, RowData(row)); - // Add the decoder rows - for (const GSList *l = decc->annotation_rows; l; l = l->next) { - const srd_decoder_annotation_row *const ann_row = - (srd_decoder_annotation_row *)l->data; - assert(ann_row); + // Prepare our binary output classes + for (const shared_ptr& dec : stack_) { + uint32_t n = dec->get_binary_class_count(); - const Row row(decc, ann_row); - - // Add a new empty row data object - (segments_.back().annotation_rows)[row] = - decode::RowData(); - } + for (uint32_t i = 0; i < n; i++) + segments_.back().binary_classes.push_back( + {dec.get(), dec->get_binary_class(i), deque()}); } } @@ -1084,39 +1416,150 @@ void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signa DecodeSignal *const ds = (DecodeSignal*)decode_signal; assert(ds); + if (ds->decode_interrupt_) + return; + + if (ds->segments_.empty()) + return; + lock_guard lock(ds->output_mutex_); - // Find the row + // Get the decoder and the annotation data assert(pdata->pdo); assert(pdata->pdo->di); - const srd_decoder *const decc = pdata->pdo->di->decoder; - assert(decc); + const srd_decoder *const srd_dec = pdata->pdo->di->decoder; + assert(srd_dec); - const srd_proto_data_annotation *const pda = - (const srd_proto_data_annotation*)pdata->data; + const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data; assert(pda); - auto row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.end(); + // Find the row + Decoder* dec = ds->get_decoder_by_instance(srd_dec); + assert(dec); + + AnnotationClass* ann_class = dec->get_ann_class_by_id(pda->ann_class); + if (!ann_class) { + qWarning() << "Decoder" << ds->display_name() << "wanted to add annotation" << + "with class ID" << pda->ann_class << "but there are only" << + dec->ann_classes().size() << "known classes"; + return; + } + + const Row* row = ann_class->row; + + if (!row) + row = dec->get_row_by_id(0); + + RowData& row_data = ds->segments_[ds->current_segment_id_].annotation_rows.at(row); + + // Add the annotation to the row + const Annotation* ann = row_data.emplace_annotation(pdata); - // Try looking up the sub-row of this class - const auto format = pda->ann_class; - const auto r = ds->class_rows_.find(make_pair(decc, format)); - if (r != ds->class_rows_.end()) - row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find((*r).second); - else { - // Failing that, use the decoder as a key - row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(decc)); + // We insert the annotation into the global annotation list in a way so that + // the annotation list is sorted by start sample and length. Otherwise, we'd + // have to sort the model, which is expensive + deque& all_annotations = + ds->segments_[ds->current_segment_id_].all_annotations; + + if (all_annotations.empty()) { + all_annotations.emplace_back(ann); + } else { + const uint64_t new_ann_len = (pdata->end_sample - pdata->start_sample); + bool ann_has_earlier_start = (pdata->start_sample < all_annotations.back()->start_sample()); + bool ann_is_longer = (new_ann_len > + (all_annotations.back()->end_sample() - all_annotations.back()->start_sample())); + + if (ann_has_earlier_start && ann_is_longer) { + bool ann_has_same_start; + auto it = all_annotations.end(); + + do { + it--; + ann_has_earlier_start = (pdata->start_sample < (*it)->start_sample()); + ann_has_same_start = (pdata->start_sample == (*it)->start_sample()); + ann_is_longer = (new_ann_len > (*it)->length()); + } while ((ann_has_earlier_start || (ann_has_same_start && ann_is_longer)) && (it != all_annotations.begin())); + + // Allow inserting at the front + if (it != all_annotations.begin()) + it++; + + all_annotations.emplace(it, ann); + } else + all_annotations.emplace_back(ann); } - if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) { - qDebug() << "Unexpected annotation: decoder = " << decc << - ", format = " << format; - assert(false); + // When emplace_annotation() inserts instead of appends an annotation, + // the pointers in all_annotations that follow the inserted annotation and + // point to annotations for this row are off by one and must be updated + if (&(row_data.annotations().back()) != ann) { + // Search backwards until we find the annotation we just added + auto row_it = row_data.annotations().end(); + auto all_it = all_annotations.end(); + do { + all_it--; + if ((*all_it)->row_data() == &row_data) + row_it--; + } while (&(*row_it) != ann); + + // Update the annotation addresses for this row's annotations until the end + do { + if ((*all_it)->row_data() == &row_data) { + *all_it = &(*row_it); + row_it++; + } + all_it++; + } while (all_it != all_annotations.end()); + } +} + +void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal) +{ + assert(pdata); + assert(decode_signal); + + DecodeSignal *const ds = (DecodeSignal*)decode_signal; + assert(ds); + + if (ds->decode_interrupt_) + return; + + // Get the decoder and the binary data + assert(pdata->pdo); + assert(pdata->pdo->di); + const srd_decoder *const srd_dec = pdata->pdo->di->decoder; + assert(srd_dec); + + const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data; + assert(pdb); + + // Find the matching DecodeBinaryClass + DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_)); + + DecodeBinaryClass* bin_class = nullptr; + for (DecodeBinaryClass& bc : segment->binary_classes) + if ((bc.decoder->get_srd_decoder() == srd_dec) && + (bc.info->bin_class_id == (uint32_t)pdb->bin_class)) + bin_class = &bc; + + if (!bin_class) { + qWarning() << "Could not find valid DecodeBinaryClass in segment" << + ds->current_segment_id_ << "for binary class ID" << pdb->bin_class << + ", segment only knows" << segment->binary_classes.size() << "classes"; return; } - // Add the annotation - (*row_iter).second.emplace_annotation(pdata); + // Add the data chunk + bin_class->chunks.emplace_back(); + DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back()); + + chunk->sample = pdata->start_sample; + chunk->data.resize(pdb->size); + memcpy(chunk->data.data(), pdb->data, pdb->size); + + Decoder* dec = ds->get_decoder_by_instance(srd_dec); + + ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class); } void DecodeSignal::on_capture_state_changed(int state) @@ -1135,11 +1578,22 @@ void DecodeSignal::on_data_cleared() void DecodeSignal::on_data_received() { + // If we detected a lack of input data when trying to start decoding, + // we have set an error message. Only try again if we now have data + // to work with + if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0)) + return; + if (!logic_mux_thread_.joinable()) begin_decode(); else logic_mux_cond_.notify_one(); } +void DecodeSignal::on_annotation_visibility_changed() +{ + annotation_visibility_changed(); +} + } // namespace data } // namespace pv