X-Git-Url: http://git.code-monkey.de/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fdata%2Fdecodesignal.cpp;h=9da7de6766c418e759ea1f02d88ba8ab8614c551;hp=c0dbb20d8c9aca5f86921459d650ae52b53b906a;hb=f98070844c2d468fdbb6beb5b65e4ccbbcd3f10b;hpb=8a603e135f0eee0b2665c8ec9caa5f19ae6ee5e4 diff --git a/pv/data/decodesignal.cpp b/pv/data/decodesignal.cpp index c0dbb20..9da7de6 100644 --- a/pv/data/decodesignal.cpp +++ b/pv/data/decodesignal.cpp @@ -56,6 +56,7 @@ DecodeSignal::DecodeSignal(pv::Session &session) : session_(session), srd_session_(nullptr), logic_mux_data_invalid_(false), + stack_config_changed_(true), current_segment_id_(0) { connect(&session_, SIGNAL(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 @@ -86,6 +87,7 @@ void DecodeSignal::stack_decoder(const srd_decoder *decoder) // 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(); @@ -105,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(); } @@ -127,8 +130,13 @@ bool DecodeSignal::toggle_decoder_visibility(int index) return state; } -void DecodeSignal::reset_decode() +void DecodeSignal::reset_decode(bool shutting_down) { + 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,8 +149,6 @@ void DecodeSignal::reset_decode() logic_mux_thread_.join(); } - stop_srd_session(); - class_rows_.clear(); current_segment_id_ = 0; segments_.clear(); @@ -150,7 +156,11 @@ void DecodeSignal::reset_decode() 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,14 +182,14 @@ 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; } @@ -193,12 +203,13 @@ void DecodeSignal::begin_decode() // 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; } // Map out all the annotation classes + int row_index = 0; for (const shared_ptr &dec : stack_) { assert(dec); const srd_decoder *const decc = dec->decoder(); @@ -209,7 +220,7 @@ void DecodeSignal::begin_decode() (srd_decoder_annotation_row *)l->data; assert(ann_row); - const Row row(decc, ann_row); + const Row row(row_index++, decc, ann_row); for (const GSList *ll = ann_row->ann_classes; ll; ll = ll->next) @@ -232,12 +243,10 @@ 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; } - create_segments(); - // Make sure the logic output data is complete and up-to-date logic_mux_interrupt_ = false; logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this); @@ -271,20 +280,38 @@ void DecodeSignal::auto_assign_signals(const shared_ptr dec) if (ch.assigned_signal) continue; + const QString ch_name = ch.name.toLower(); + + shared_ptr match; for (shared_ptr s : session_.signalbases()) { - const QString ch_name = ch.name.toLower(); + if (!s->enabled()) + continue; + 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 (!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(); } @@ -298,6 +325,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(); @@ -316,8 +344,8 @@ 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(); } @@ -363,7 +391,7 @@ int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const 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) { + } catch (out_of_range&) { return 0; } } @@ -371,7 +399,8 @@ int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const 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_); @@ -379,8 +408,11 @@ int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id) const try { const DecodeSegment *segment = &(segments_.at(segment_id)); - result = segment->samples_decoded; - } catch (out_of_range) { + if (include_processing) + result = segment->samples_decoded_incl; + else + result = segment->samples_decoded_excl; + } catch (out_of_range&) { // Do nothing } @@ -401,16 +433,17 @@ vector DecodeSignal::visible_rows() const const srd_decoder *const decc = dec->decoder(); assert(dec->decoder()); + int row_index = 0; // Add a row for the decoder if it doesn't have a row list if (!decc->annotation_rows) - rows.emplace_back(decc); + rows.emplace_back(row_index++, decc); // 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); + rows.emplace_back(row_index++, decc, ann_row); } } @@ -433,7 +466,7 @@ void DecodeSignal::get_annotation_subset( if (iter != rows->end()) (*iter).second.get_annotation_subset(dest, start_sample, end_sample); - } catch (out_of_range) { + } catch (out_of_range&) { // Do nothing } } @@ -569,12 +602,20 @@ 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(); @@ -609,7 +650,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; @@ -738,7 +779,7 @@ void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, c 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; @@ -758,7 +799,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(); @@ -769,7 +810,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; @@ -807,8 +850,11 @@ void DecodeSignal::logic_mux_proc() assert(logic_mux_data_); - shared_ptr output_segment = logic_mux_data_->logic_segments().front(); - assert(output_segment); + // 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)); @@ -836,7 +882,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) { @@ -846,14 +892,10 @@ void DecodeSignal::logic_mux_proc() // Process next segment segment_id++; - 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 logic_mux_proc(), mux segments size is" \ - << logic_mux_data_->logic_segments().size(); - return; - } + 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(segment_id)); @@ -866,56 +908,8 @@ void DecodeSignal::logic_mux_proc() logic_mux_cond_.wait(logic_mux_lock); } } - } while (!logic_mux_interrupt_); -} - -void DecodeSignal::query_input_metadata() -{ - // Update the samplerate and start time because we cannot start - // the libsrd session without the current samplerate - - // TODO Currently we assume all channels have the same sample rate - // and start time - bool samplerate_valid = false; - data::DecodeChannel *any_channel; - shared_ptr logic_data; - - do { - any_channel = &(*find_if(channels_.begin(), channels_.end(), - [](data::DecodeChannel ch) { return ch.assigned_signal; })); - - logic_data = any_channel->assigned_signal->logic_data(); - - if (!logic_data) { - // 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 (!logic_data && !decode_interrupt_); - - if (decode_interrupt_) - return; - do { - if (!logic_data->logic_segments().empty()) { - shared_ptr first_segment = - any_channel->assigned_signal->logic_data()->logic_segments().front(); - - // We only need valid metadata in the first decode segment - // so that start_srd_session() can use it - segments_.at(current_segment_id_).start_time = first_segment->start_time(); - segments_.at(current_segment_id_).samplerate = first_segment->samplerate(); - - if (segments_.at(current_segment_id_).samplerate > 0) - samplerate_valid = true; - } - - if (!samplerate_valid) { - // 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( @@ -926,28 +920,33 @@ 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 @@ -958,20 +957,28 @@ void DecodeSignal::decode_data( 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; - start_srd_session(); - - current_segment_id_ = 0; 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 @@ -992,7 +999,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(); @@ -1000,11 +1007,13 @@ void DecodeSignal::decode_proc() } 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 - 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(); @@ -1015,12 +1024,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() { - 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 + 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_); + + return; + } // Create the session srd_session_new(&srd_session_); @@ -1032,8 +1070,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; } @@ -1044,13 +1083,39 @@ void DecodeSignal::start_srd_session() } // Start the session - srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE, - g_variant_new_uint64(segments_.at(current_segment_id_).samplerate)); + if (segments_.size() > 0) + srd_session_metadata_set(srd_session_, SRD_CONF_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 + 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() @@ -1059,6 +1124,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(); } } @@ -1076,49 +1145,39 @@ void DecodeSignal::connect_input_notifiers() const data::SignalBase *signal = ch.assigned_signal; connect(signal, SIGNAL(samples_cleared()), this, SLOT(on_data_cleared())); - connect(signal, SIGNAL(samples_added(QObject*, uint64_t, uint64_t)), + connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)), this, SLOT(on_data_received())); } } -void DecodeSignal::create_segments() +void DecodeSignal::create_decode_segment() { - // Make sure we have as many segments as we need - const uint32_t input_segment_count = get_input_segment_count(); - - for (uint32_t i = logic_mux_data_->logic_segments().size(); i < input_segment_count; i++) { - shared_ptr segment = - make_shared(*logic_mux_data_, logic_mux_unit_size_, 0); - logic_mux_data_->push_segment(segment); - } + // Create annotation segment + segments_.emplace_back(DecodeSegment()); - for (uint32_t i = segments_.size(); i < input_segment_count; i++) { - // 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 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(); + int row_index = 0; + // Add a row for the decoder if it doesn't have a row list + if (!decc->annotation_rows) + (segments_.back().annotation_rows)[Row(row_index++, 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); + // 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); + const Row row(row_index++, decc, ann_row); - // Add a new empty row data object - (segments_.back().annotation_rows)[row] = - decode::RowData(); - } + // Add a new empty row data object + (segments_.back().annotation_rows)[row] = + decode::RowData(); } } } @@ -1131,6 +1190,9 @@ void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signa DecodeSignal *const ds = (DecodeSignal*)decode_signal; assert(ds); + if (ds->decode_interrupt_) + return; + lock_guard lock(ds->output_mutex_); // Find the row @@ -1152,7 +1214,7 @@ void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signa 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)); + row_iter = ds->segments_.at(ds->current_segment_id_).annotation_rows.find(Row(0, decc)); } if (row_iter == ds->segments_.at(ds->current_segment_id_).annotation_rows.end()) { @@ -1182,7 +1244,11 @@ void DecodeSignal::on_data_cleared() void DecodeSignal::on_data_received() { - create_segments(); + // 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();