]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decodesignal.cpp
Properly handle decoder errors
[pulseview.git] / pv / data / decodesignal.cpp
index df385be8d99ce397ed9aba327247f37e0176983b..65436002c760681a8b1b8117f15c74932479f4a2 100644 (file)
@@ -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<Decoder> >& 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,9 +130,12 @@ bool DecodeSignal::toggle_decoder_visibility(int index)
        return state;
 }
 
-void DecodeSignal::reset_decode()
+void DecodeSignal::reset_decode(bool shutting_down)
 {
-       terminate_srd_session();
+       if (stack_config_changed_ || shutting_down)
+               stop_srd_session();
+       else
+               terminate_srd_session();
 
        if (decode_thread_.joinable()) {
                decode_interrupt_ = true;
@@ -143,8 +149,6 @@ void DecodeSignal::reset_decode()
                logic_mux_thread_.join();
        }
 
-       stop_srd_session();
-
        class_rows_.clear();
        current_segment_id_ = 0;
        segments_.clear();
@@ -152,15 +156,17 @@ 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();
 }
 
 void DecodeSignal::begin_decode()
 {
-       terminate_srd_session();
-
        if (decode_thread_.joinable()) {
                decode_interrupt_ = true;
                decode_input_cond_.notify_one();
@@ -176,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;
        }
 
@@ -197,8 +203,8 @@ void DecodeSignal::begin_decode()
        // Check that all decoders have the required channels
        for (const shared_ptr<decode::Decoder> &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;
                }
 
@@ -236,7 +242,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;
        }
 
@@ -273,20 +279,38 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
                if (ch.assigned_signal)
                        continue;
 
+               const QString ch_name = ch.name.toLower();
+
+               shared_ptr<data::SignalBase> match;
                for (shared_ptr<data::SignalBase> 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();
        }
@@ -300,6 +324,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();
@@ -318,8 +343,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();
 }
 
@@ -373,7 +398,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<mutex> decode_lock(output_mutex_);
 
@@ -381,7 +407,10 @@ int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id) const
 
        try {
                const DecodeSegment *segment = &(segments_.at(segment_id));
-               result = segment->samples_decoded;
+               if (include_processing)
+                       result = segment->samples_decoded_incl;
+               else
+                       result = segment->samples_decoded_excl;
        } catch (out_of_range&) {
                // Do nothing
        }
@@ -571,12 +600,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<uint64_t>::max();
@@ -771,7 +808,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;
 
@@ -841,7 +880,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) {
@@ -867,6 +906,7 @@ void DecodeSignal::logic_mux_proc()
                                logic_mux_cond_.wait(logic_mux_lock);
                        }
                }
+
        } while (!logic_mux_interrupt_);
 }
 
@@ -878,28 +918,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<mutex> 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<mutex> 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
@@ -965,9 +1010,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();
@@ -987,8 +1031,8 @@ void DecodeSignal::decode_proc()
 
 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
@@ -997,13 +1041,20 @@ void DecodeSignal::start_srd_session()
                // and) construction of another decoder stack.
 
                // TODO Reduce redundancy, use a common code path for
-               // the meta/cb/start sequence?
+               // the meta/start sequence?
                terminate_srd_session();
-               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);
+
+               // 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<decode::Decoder> &dec : stack_)
+                       dec->apply_all_options();
                srd_session_start(srd_session_);
+
                return;
        }
 
@@ -1017,7 +1068,7 @@ 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;
@@ -1030,15 +1081,17 @@ 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_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()
@@ -1048,8 +1101,19 @@ void DecodeSignal::terminate_srd_session()
        // 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_)
+       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<decode::Decoder> &dec : stack_)
+                       dec->apply_all_options();
+       }
 }
 
 void DecodeSignal::stop_srd_session()
@@ -1058,6 +1122,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<decode::Decoder> &dec : stack_)
+                       dec->invalidate_decoder_inst();
        }
 }
 
@@ -1119,6 +1187,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<mutex> lock(ds->output_mutex_);
 
        // Find the row
@@ -1170,6 +1241,12 @@ 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