X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fdata%2Fdecodesignal.cpp;h=d17c883c4b380eaac155ae1d04c88d7cfa16330b;hp=339c85dd01dd0305879bce1dc88d3fde6d8ec6e3;hb=72486b789078f024e4f3404f81118c03b03e2b70;hpb=a3ebd5561086f4fef6570b3ab5be0a5592724731 diff --git a/pv/data/decodesignal.cpp b/pv/data/decodesignal.cpp index 339c85dd..d17c883c 100644 --- a/pv/data/decodesignal.cpp +++ b/pv/data/decodesignal.cpp @@ -29,12 +29,14 @@ #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; @@ -46,10 +48,7 @@ namespace data { const double DecodeSignal::DecodeMargin = 1.0; const double DecodeSignal::DecodeThreshold = 0.2; -const int64_t DecodeSignal::DecodeChunkLength = 10 * 1024 * 1024; -const unsigned int DecodeSignal::DecodeNotifyPeriod = 1024; - -mutex DecodeSignal::global_srd_mutex_; +const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024; DecodeSignal::DecodeSignal(pv::Session &session) : @@ -57,33 +56,16 @@ DecodeSignal::DecodeSignal(pv::Session &session) : session_(session), srd_session_(nullptr), logic_mux_data_invalid_(false), - start_time_(0), - samplerate_(0), - annotation_count_(0), - samples_decoded_(0), - frame_complete_(false) + stack_config_changed_(true), + current_segment_id_(0) { connect(&session_, SIGNAL(capture_state_changed(int)), this, SLOT(on_capture_state_changed(int))); - - set_name(tr("Empty decoder signal")); } DecodeSignal::~DecodeSignal() { - if (decode_thread_.joinable()) { - decode_interrupt_ = true; - decode_input_cond_.notify_one(); - decode_thread_.join(); - } - - if (logic_mux_thread_.joinable()) { - logic_mux_interrupt_ = true; - logic_mux_cond_.notify_one(); - logic_mux_thread_.join(); - } - - stop_srd_session(); + reset_decode(true); } const vector< shared_ptr >& DecodeSignal::decoder_stack() const @@ -91,10 +73,12 @@ const vector< shared_ptr >& DecodeSignal::decoder_stack() const return stack_; } -void DecodeSignal::stack_decoder(srd_decoder *decoder) +void DecodeSignal::stack_decoder(const srd_decoder *decoder) { assert(decoder); - stack_.push_back(make_shared(decoder)); + const shared_ptr dec = make_shared(decoder); + + stack_.push_back(dec); // Set name if this decoder is the first in the list if (stack_.size() == 1) @@ -103,7 +87,8 @@ void DecodeSignal::stack_decoder(srd_decoder *decoder) // Include the newly created decode channels in the channel lists update_channel_list(); - auto_assign_signals(); + stack_config_changed_ = true; + auto_assign_signals(dec); commit_decoder_channels(); begin_decode(); } @@ -122,6 +107,7 @@ void DecodeSignal::remove_decoder(int index) stack_.erase(iter); // Update channels and decoded data + stack_config_changed_ = true; update_channel_list(); begin_decode(); } @@ -144,16 +130,39 @@ bool DecodeSignal::toggle_decoder_visibility(int index) return state; } -void DecodeSignal::reset_decode() +void DecodeSignal::reset_decode(bool shutting_down) { - stop_srd_session(); + 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(); + decode_thread_.join(); + } + + if (logic_mux_thread_.joinable()) { + logic_mux_interrupt_ = true; + logic_mux_cond_.notify_one(); + logic_mux_thread_.join(); + } - annotation_count_ = 0; - frame_complete_ = false; - samples_decoded_ = 0; - error_message_ = QString(); - rows_.clear(); class_rows_.clear(); + current_segment_id_ = 0; + segments_.clear(); + + logic_mux_data_.reset(); + logic_mux_data_invalid_ = true; + + if (!error_message_.isEmpty()) { + error_message_ = QString(); + // TODO Emulate noquote() + qDebug().nospace() << name() << ": Error cleared"; + } + + decode_reset(); } void DecodeSignal::begin_decode() @@ -173,36 +182,38 @@ 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_) + 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_) 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; } - // Add annotation classes + // Map out all the 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) - rows_[Row(decc)] = decode::RowData(); - - // 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; @@ -210,10 +221,6 @@ void DecodeSignal::begin_decode() const Row row(decc, ann_row); - // Add a new empty row data object - rows_[row] = decode::RowData(); - - // Map out all the classes for (const GSList *ll = ann_row->ann_classes; ll; ll = ll->next) class_rows_[make_pair(decc, @@ -226,11 +233,17 @@ void DecodeSignal::begin_decode() logic_mux_data_.reset(); if (!logic_mux_data_) { - const int64_t ch_count = get_assigned_signal_count(); - const int64_t unit_size = (ch_count + 7) / 8; + const uint32_t ch_count = get_assigned_signal_count(); + logic_mux_unit_size_ = (ch_count + 7) / 8; logic_mux_data_ = make_shared(ch_count); - segment_ = make_shared(*logic_mux_data_, unit_size, samplerate_); - logic_mux_data_->push_segment(segment_); + } + + // Receive notifications when new sample data is available + connect_input_notifiers(); + + if (get_input_segment_count() == 0) { + set_error_message(tr("No input data")); + return; } // Make sure the logic output data is complete and up-to-date @@ -240,9 +253,6 @@ void DecodeSignal::begin_decode() // Decode the muxed logic data decode_interrupt_ = false; decode_thread_ = std::thread(&DecodeSignal::decode_proc, this); - - // Receive notifications when new sample data is available - connect_input_notifiers(); } QString DecodeSignal::error_message() const @@ -256,24 +266,34 @@ const vector DecodeSignal::get_channels() const return channels_; } -void DecodeSignal::auto_assign_signals() +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_) { + // If a decoder is given, auto-assign only its channels + if (dec && (ch.decoder_ != dec)) + continue; + if (ch.assigned_signal) continue; - for (shared_ptr s : session_.signalbases()) - if (s->logic_data() && (ch.name.toLower().contains(s->name().toLower()))) { + for (shared_ptr s : session_.signalbases()) { + const QString ch_name = ch.name.toLower(); + const QString s_name = s->name().toLower(); + + if (s->logic_data() && + ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) { ch.assigned_signal = s.get(); new_assignment = true; } + } } if (new_assignment) { logic_mux_data_invalid_ = true; + stack_config_changed_ = true; commit_decoder_channels(); channels_updated(); } @@ -287,6 +307,7 @@ void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *si logic_mux_data_invalid_ = true; } + stack_config_changed_ = true; commit_decoder_channels(); channels_updated(); begin_decode(); @@ -305,29 +326,38 @@ void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int in if (ch.id == channel_id) ch.initial_pin_state = init_state; + stack_config_changed_ = true; channels_updated(); - begin_decode(); } double DecodeSignal::samplerate() const { - return samplerate_; + double result = 0; + + // TODO For now, we simply return the first samplerate that we have + if (segments_.size() > 0) + result = segments_.front().samplerate; + + return result; } -const pv::util::Timestamp& DecodeSignal::start_time() const +const pv::util::Timestamp DecodeSignal::start_time() const { - return start_time_; + pv::util::Timestamp result; + + // TODO For now, we simply return the first start time that we have + if (segments_.size() > 0) + result = segments_.front().start_time; + + return result; } -int64_t DecodeSignal::get_working_sample_count() const +int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const { // The working sample count is the highest sample number for - // which all used signals have data available, so go through - // all channels and use the lowest overall sample count of the - // current segment - - // TODO Currently, we assume only a single segment exists + // which all used signals have data available, so go through all + // channels and use the lowest overall sample count of the segment int64_t count = std::numeric_limits::max(); bool no_signals_assigned = true; @@ -340,17 +370,31 @@ int64_t DecodeSignal::get_working_sample_count() const if (!logic_data || logic_data->logic_segments().empty()) return 0; - const shared_ptr segment = logic_data->logic_segments().front(); - count = min(count, (int64_t)segment->get_sample_count()); + 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&) { + return 0; + } } return (no_signals_assigned ? 0 : count); } -int64_t DecodeSignal::get_decoded_sample_count() const +int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id) const { lock_guard decode_lock(output_mutex_); - return samples_decoded_; + + int64_t result = 0; + + try { + const DecodeSegment *segment = &(segments_.at(segment_id)); + result = segment->samples_decoded; + } catch (out_of_range&) { + // Do nothing + } + + return result; } vector DecodeSignal::visible_rows() const @@ -385,34 +429,211 @@ vector DecodeSignal::visible_rows() const void DecodeSignal::get_annotation_subset( vector &dest, - const decode::Row &row, uint64_t start_sample, + const decode::Row &row, uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const { lock_guard lock(output_mutex_); - const auto iter = rows_.find(row); - if (iter != rows_.end()) - (*iter).second.get_annotation_subset(dest, - start_sample, end_sample); + 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 + } } void DecodeSignal::save_settings(QSettings &settings) const { SignalBase::save_settings(settings); - // TODO Save decoder stack, channel mapping and decoder options + settings.setValue("decoders", (int)(stack_.size())); + + // Save decoder stack + int decoder_idx = 0; + for (shared_ptr decoder : stack_) { + settings.beginGroup("decoder" + QString::number(decoder_idx++)); + + settings.setValue("id", decoder->decoder()->id); + + // Save decoder options + const map& options = decoder->options(); + + settings.setValue("options", (int)options.size()); + + // Note: decode::Decoder::options() returns only the options + // that differ from the default. See binding::Decoder::getter() + int i = 0; + for (auto option : options) { + settings.beginGroup("option" + QString::number(i)); + settings.setValue("name", QString::fromStdString(option.first)); + GlobalSettings::store_gvariant(settings, option.second); + settings.endGroup(); + i++; + } + + settings.endGroup(); + } + + // Save channel mapping + settings.setValue("channels", (int)channels_.size()); + + 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; }); + + if (channel == channels_.end()) { + qDebug() << "ERROR: Gap in channel index:" << channel_id; + continue; + } + + settings.beginGroup("channel" + QString::number(channel_id)); + + settings.setValue("name", channel->name); // Useful for debugging + settings.setValue("initial_pin_state", channel->initial_pin_state); + + if (channel->assigned_signal) + settings.setValue("assigned_signal_name", channel->assigned_signal->name()); + + settings.endGroup(); + } } void DecodeSignal::restore_settings(QSettings &settings) { SignalBase::restore_settings(settings); - // TODO Restore decoder stack, channel mapping and decoder options + // Restore decoder stack + GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list()); + + int decoders = settings.value("decoders").toInt(); + + for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) { + settings.beginGroup("decoder" + QString::number(decoder_idx)); + + QString id = settings.value("id").toString(); + + for (GSList *entry = dec_list; entry; entry = entry->next) { + const srd_decoder *dec = (srd_decoder*)entry->data; + if (!dec) + continue; + + if (QString::fromUtf8(dec->id) == id) { + shared_ptr decoder = + make_shared(dec); + + stack_.push_back(decoder); + + // Restore decoder options that differ from their default + int options = settings.value("options").toInt(); + + for (int i = 0; i < options; i++) { + settings.beginGroup("option" + QString::number(i)); + QString name = settings.value("name").toString(); + GVariant *value = GlobalSettings::restore_gvariant(settings); + decoder->set_option(name.toUtf8(), value); + settings.endGroup(); + } + + // Include the newly created decode channels in the channel lists + update_channel_list(); + break; + } + } + + settings.endGroup(); + channels_updated(); + } + + // Restore channel mapping + unsigned int channels = settings.value("channels").toInt(); + + const unordered_set< 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; }); + + if (channel == channels_.end()) { + qDebug() << "ERROR: Non-existant channel index:" << channel_id; + continue; + } + + settings.beginGroup("channel" + QString::number(channel_id)); + + QString assigned_signal_name = settings.value("assigned_signal_name").toString(); + + for (shared_ptr signal : signalbases) + if (signal->name() == assigned_signal_name) + channel->assigned_signal = signal.get(); + + channel->initial_pin_state = settings.value("initial_pin_state").toInt(); + + settings.endGroup(); + } + + // Update the internal structures + stack_config_changed_ = true; + update_channel_list(); + commit_decoder_channels(); + + begin_decode(); } -uint64_t DecodeSignal::inc_annotation_count() +void DecodeSignal::set_error_message(QString msg) { - return (annotation_count_++); + 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_) + if (ch.assigned_signal) { + no_signals_assigned = false; + + const shared_ptr logic_data = ch.assigned_signal->logic_data(); + if (!logic_data || logic_data->logic_segments().empty()) + return 0; + + // Find the min value of all segment counts + if ((uint64_t)(logic_data->logic_segments().size()) < count) + count = logic_data->logic_segments().size(); + } + + return (no_signals_assigned ? 0 : count); +} + +uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const +{ + double samplerate = 0; + + for (const data::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()) + continue; + + try { + const shared_ptr segment = logic_data->logic_segments().at(segment_id); + samplerate = segment->samplerate(); + } catch (out_of_range&) { + // Do nothing + } + break; + } + + return samplerate; } void DecodeSignal::update_channel_list() @@ -443,7 +664,7 @@ void DecodeSignal::update_channel_list() if (!ch_added) { // Create new entry without a mapped signal - data::DecodeChannel ch = {id++, false, nullptr, + data::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); @@ -466,7 +687,7 @@ void DecodeSignal::update_channel_list() if (!ch_added) { // Create new entry without a mapped signal - data::DecodeChannel ch = {id++, true, nullptr, + data::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); @@ -508,16 +729,21 @@ void DecodeSignal::commit_decoder_channels() dec->set_channels(channel_list); } + + // Channel bit IDs must be in sync with the channel's apperance in channels_ + int id = 0; + for (data::DecodeChannel &ch : channels_) + if (ch.assigned_signal) + ch.bit_id = id++; } -void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end) +void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end) { // Enforce end to be greater than start if (end <= start) return; - // Fetch all segments and their data - // TODO Currently, we assume only a single segment exists + // Fetch the channel segments and their data vector > segments; vector signal_data; vector signal_in_bytepos; @@ -526,25 +752,49 @@ void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end) for (data::DecodeChannel &ch : channels_) if (ch.assigned_signal) { const shared_ptr logic_data = ch.assigned_signal->logic_data(); - const shared_ptr segment = logic_data->logic_segments().front(); + + shared_ptr segment; + try { + segment = logic_data->logic_segments().at(segment_id); + } catch (out_of_range&) { + qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \ + << "has no logic segment" << segment_id; + return; + } segments.push_back(segment); - signal_data.push_back(segment->get_samples(start, end)); + + uint8_t* data = new uint8_t[(end - start) * segment->unit_size()]; + segment->get_samples(start, end, data); + signal_data.push_back(data); const int bitpos = ch.assigned_signal->logic_bit_index(); signal_in_bytepos.push_back(bitpos / 8); signal_in_bitpos.push_back(bitpos % 8); } + + shared_ptr output_segment; + try { + output_segment = logic_mux_data_->logic_segments().at(segment_id); + } 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(); + return; + } + // Perform the muxing of signal data into the output data - uint8_t* output = new uint8_t[(end - start) * segment_->unit_size()]; + 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; - const int out_sample_pos = sample_cnt * segment_->unit_size(); - for (unsigned int i = 0; i < segment_->unit_size(); i++) + const int out_sample_pos = sample_cnt * output_segment->unit_size(); + for (unsigned int i = 0; i < output_segment->unit_size(); i++) output[out_sample_pos + i] = 0; for (unsigned int i = 0; i < signal_count; i++) { @@ -564,7 +814,7 @@ void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end) } } - segment_->append_payload(output, (end - start) * segment_->unit_size()); + output_segment->append_payload(output, (end - start) * output_segment->unit_size()); delete[] output; for (const uint8_t* data : signal_data) @@ -573,9 +823,21 @@ void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end) void DecodeSignal::logic_mux_proc() { + uint32_t segment_id = 0; + + assert(logic_mux_data_); + + // Create initial logic mux segment + shared_ptr output_segment = + make_shared(*logic_mux_data_, segment_id, + logic_mux_unit_size_, 0); + logic_mux_data_->push_segment(output_segment); + + output_segment->set_samplerate(get_input_samplerate(0)); + do { - const uint64_t input_sample_count = get_working_sample_count(); - const uint64_t output_sample_count = segment_->get_sample_count(); + const uint64_t input_sample_count = get_working_sample_count(segment_id); + const uint64_t output_sample_count = output_segment->get_sample_count(); const uint64_t samples_to_process = (input_sample_count > output_sample_count) ? @@ -583,7 +845,7 @@ void DecodeSignal::logic_mux_proc() // Process the samples if necessary... if (samples_to_process > 0) { - const uint64_t unit_size = segment_->unit_size(); + const uint64_t unit_size = output_segment->unit_size(); const uint64_t chunk_sample_count = DecodeChunkLength / unit_size; uint64_t processed_samples = 0; @@ -592,62 +854,45 @@ void DecodeSignal::logic_mux_proc() const uint64_t sample_count = min(samples_to_process - processed_samples, chunk_sample_count); - mux_logic_samples(start_sample, start_sample + sample_count); + mux_logic_samples(segment_id, start_sample, start_sample + sample_count); processed_samples += sample_count; // ...and process the newly muxed logic data decode_input_cond_.notify_one(); - } while (processed_samples < samples_to_process); - } - - if (session_.get_capture_state() != Session::Stopped) { - // Wait for more input - unique_lock logic_mux_lock(logic_mux_mutex_); - logic_mux_cond_.wait(logic_mux_lock); + } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process)); } - } while ((session_.get_capture_state() != Session::Stopped) && !logic_mux_interrupt_); - - // No more input data and session is stopped, let the decode thread - // process any pending data, terminate and release the global SRD mutex - // in order to let other decoders run - decode_input_cond_.notify_one(); -} -void DecodeSignal::query_input_metadata() -{ - // Update the samplerate and start time because we cannot start - // the libsrd session without the current samplerate + if (samples_to_process == 0) { + // TODO Optimize this by caching the input segment count and only + // querying it when the cached value was reached + if (segment_id < get_input_segment_count() - 1) { + // Process next segment + segment_id++; - // TODO Currently we assume all channels have the same sample rate - // and start time - bool samplerate_valid = false; + output_segment = + make_shared(*logic_mux_data_, segment_id, + logic_mux_unit_size_, 0); + logic_mux_data_->push_segment(output_segment); - auto any_channel = find_if(channels_.begin(), channels_.end(), - [](data::DecodeChannel ch) { return ch.assigned_signal; }); + output_segment->set_samplerate(get_input_samplerate(segment_id)); - shared_ptr logic_data = - any_channel->assigned_signal->logic_data(); + } else { + // All segments have been processed + logic_mux_data_invalid_ = false; - do { - if (!logic_data->logic_segments().empty()) { - shared_ptr first_segment = - any_channel->assigned_signal->logic_data()->logic_segments().front(); - start_time_ = first_segment->start_time(); - samplerate_ = first_segment->samplerate(); - if (samplerate_ > 0) - samplerate_valid = true; + // Wait for more input + unique_lock logic_mux_lock(logic_mux_mutex_); + logic_mux_cond_.wait(logic_mux_lock); + } } - - // Wait until input data is available or an interrupt was requested - unique_lock input_wait_lock(input_mutex_); - decode_input_cond_.wait(input_wait_lock); - } while (!samplerate_valid && !decode_interrupt_); + } while (!logic_mux_interrupt_); } void DecodeSignal::decode_data( - const int64_t abs_start_samplenum, const int64_t sample_count) + const int64_t abs_start_samplenum, const int64_t sample_count, + const shared_ptr input_segment) { - const int64_t unit_size = segment_->unit_size(); + const int64_t unit_size = input_segment->unit_size(); const int64_t chunk_sample_count = DecodeChunkLength / unit_size; for (int64_t i = abs_start_samplenum; @@ -657,67 +902,132 @@ void DecodeSignal::decode_data( const int64_t chunk_end = min(i + chunk_sample_count, abs_start_samplenum + sample_count); - const uint8_t* chunk = segment_->get_samples(i, chunk_end); + // Report this chunk as already decoded so that annotations don't + // appear in an area that we claim to not having been been decoded yet + { + lock_guard lock(output_mutex_); + segments_.at(current_segment_id_).samples_decoded = 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, - (chunk_end - i) * unit_size, unit_size) != SRD_OK) { - error_message_ = tr("Decoder reported an error"); + data_size, unit_size) != SRD_OK) { + set_error_message(tr("Decoder reported an error")); delete[] chunk; break; } delete[] chunk; - { - lock_guard lock(output_mutex_); - samples_decoded_ = chunk_end; - } + // Notify the frontend that we processed some data and + // possibly have new annotations as well + new_annotations(); } } void DecodeSignal::decode_proc() { - query_input_metadata(); + current_segment_id_ = 0; + + // If there is no input data available yet, wait until it is or we're interrupted + if (logic_mux_data_->logic_segments().size() == 0) { + unique_lock input_wait_lock(input_mutex_); + decode_input_cond_.wait(input_wait_lock); + } if (decode_interrupt_) return; + shared_ptr input_segment = logic_mux_data_->logic_segments().front(); + assert(input_segment); + + // Create the initial segment and set its sample rate so that we can pass it to SRD + create_decode_segment(); + segments_.at(current_segment_id_).samplerate = input_segment->samplerate(); + segments_.at(current_segment_id_).start_time = input_segment->start_time(); + start_srd_session(); - uint64_t sample_count; + uint64_t sample_count = 0; uint64_t abs_start_samplenum = 0; do { // Keep processing new samples until we exhaust the input data do { - // Prevent any other decode threads from accessing libsigrokdecode - lock_guard srd_lock(global_srd_mutex_); - - { - lock_guard input_lock(input_mutex_); - sample_count = segment_->get_sample_count() - abs_start_samplenum; - } + lock_guard input_lock(input_mutex_); + sample_count = input_segment->get_sample_count() - abs_start_samplenum; if (sample_count > 0) { - decode_data(abs_start_samplenum, sample_count); + decode_data(abs_start_samplenum, sample_count, input_segment); abs_start_samplenum += sample_count; } - } while (error_message_.isEmpty() && (sample_count > 0)); - - if (error_message_.isEmpty()) { - // Make sure all annotations are known to the frontend - new_annotations(); - - // Wait for new input data or an interrupt was requested - unique_lock input_wait_lock(input_mutex_); - decode_input_cond_.wait(input_wait_lock); + } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_); + + if (error_message_.isEmpty() && !decode_interrupt_ && sample_count == 0) { + if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) { + // Process next segment + current_segment_id_++; + + try { + input_segment = logic_mux_data_->logic_segments().at(current_segment_id_); + } 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(); + return; + } + abs_start_samplenum = 0; + + // Create the next segment and set its metadata + create_decode_segment(); + segments_.at(current_segment_id_).samplerate = input_segment->samplerate(); + segments_.at(current_segment_id_).start_time = input_segment->start_time(); + + // Reset decoder state but keep the decoder stack intact + terminate_srd_session(); + } else { + // All segments have been processed + decode_finished(); + + // Wait for new input data or an interrupt was requested + unique_lock input_wait_lock(input_mutex_); + decode_input_cond_.wait(input_wait_lock); + } } } 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() { - if (srd_session_) - stop_srd_session(); + // 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 + srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE, + g_variant_new_uint64(segments_.at(current_segment_id_).samplerate)); + for (const shared_ptr &dec : stack_) + dec->apply_all_options(); + srd_session_start(srd_session_); + + return; + } // Create the session srd_session_new(&srd_session_); @@ -729,8 +1039,9 @@ void DecodeSignal::start_srd_session() 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; } @@ -742,12 +1053,33 @@ void DecodeSignal::start_srd_session() // Start the session 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_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 + srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE, + g_variant_new_uint64(segments_.at(current_segment_id_).samplerate)); + for (const shared_ptr &dec : stack_) + dec->apply_all_options(); + } } void DecodeSignal::stop_srd_session() @@ -756,12 +1088,17 @@ 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(); } } void DecodeSignal::connect_input_notifiers() { // Disconnect the notification slot from the previous set of signals + disconnect(this, SLOT(on_data_cleared())); disconnect(this, SLOT(on_data_received())); // Connect the currently used signals to our slot @@ -769,23 +1106,57 @@ void DecodeSignal::connect_input_notifiers() if (!ch.assigned_signal) continue; - shared_ptr logic_data = ch.assigned_signal->logic_data(); - connect(logic_data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)), + const data::SignalBase *signal = ch.assigned_signal; + connect(signal, SIGNAL(samples_cleared()), + this, SLOT(on_data_cleared())); + connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)), this, SLOT(on_data_received())); } } +void DecodeSignal::create_decode_segment() +{ + // Create annotation segment + segments_.emplace_back(DecodeSegment()); + + // 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(); + + // 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); + + const Row row(decc, ann_row); + + // Add a new empty row data object + (segments_.back().annotation_rows)[row] = + decode::RowData(); + } + } +} + void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal) { assert(pdata); - assert(decoder); + assert(decode_signal); DecodeSignal *const ds = (DecodeSignal*)decode_signal; assert(ds); - lock_guard lock(ds->output_mutex_); + if (ds->decode_interrupt_) + return; - const decode::Annotation a(pdata); + lock_guard lock(ds->output_mutex_); // Find the row assert(pdata->pdo); @@ -793,43 +1164,59 @@ void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signa const srd_decoder *const decc = pdata->pdo->di->decoder; assert(decc); - auto row_iter = ds->rows_.end(); + 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(); // Try looking up the sub-row of this class - const auto r = ds->class_rows_.find(make_pair(decc, a.format())); + 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->rows_.find((*r).second); + 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->rows_.find(Row(decc)); + row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(decc)); } - assert(row_iter != ds->rows_.end()); - if (row_iter == ds->rows_.end()) { + if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) { qDebug() << "Unexpected annotation: decoder = " << decc << - ", format = " << a.format(); + ", format = " << format; assert(false); return; } // Add the annotation - (*row_iter).second.push_annotation(a); - - // Notify the frontend every DecodeNotifyPeriod annotations - if (ds->inc_annotation_count() % DecodeNotifyPeriod == 0) - ds->new_annotations(); + (*row_iter).second.emplace_annotation(pdata); } void DecodeSignal::on_capture_state_changed(int state) { // If a new acquisition was started, we need to start decoding from scratch - if (state == Session::Running) + if (state == Session::Running) { + logic_mux_data_invalid_ = true; begin_decode(); + } +} + +void DecodeSignal::on_data_cleared() +{ + reset_decode(); } void DecodeSignal::on_data_received() { - logic_mux_cond_.notify_one(); + // 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(); } } // namespace data