]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decodesignal.cpp
DecodeSignal: Unpause reliably
[pulseview.git] / pv / data / decodesignal.cpp
index 5fbc8b6ca630bab38093f61f4a3e230feea366d2..405e06e145b50ed15743af7e47892125c297613d 100644 (file)
@@ -17,6 +17,7 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <forward_list>
 #include <limits>
 
 #include <QDebug>
@@ -32,6 +33,7 @@
 #include <pv/globalsettings.hpp>
 #include <pv/session.hpp>
 
+using std::forward_list;
 using std::lock_guard;
 using std::make_pair;
 using std::make_shared;
@@ -56,6 +58,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 +67,7 @@ DecodeSignal::DecodeSignal(pv::Session &session) :
 
 DecodeSignal::~DecodeSignal()
 {
-       reset_decode();
+       reset_decode(true);
 }
 
 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
@@ -86,6 +89,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 +109,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 +132,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,7 +151,7 @@ void DecodeSignal::reset_decode()
                logic_mux_thread_.join();
        }
 
-       stop_srd_session();
+       resume_decode();  // Make sure the decode thread isn't blocked by pausing
 
        class_rows_.clear();
        current_segment_id_ = 0;
@@ -150,7 +160,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 +186,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 +207,13 @@ 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;
                }
 
        // Map out all the annotation classes
+       int row_index = 0;
        for (const shared_ptr<decode::Decoder> &dec : stack_) {
                assert(dec);
                const srd_decoder *const decc = dec->decoder();
@@ -209,7 +224,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,7 +247,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,6 +260,25 @@ 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<mutex> lock(output_mutex_);
@@ -269,20 +303,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();
        }
@@ -296,6 +348,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();
@@ -314,8 +367,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();
 }
 
@@ -361,7 +414,7 @@ int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
                        try {
                                const shared_ptr<LogicSegment> 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;
                        }
                }
@@ -369,7 +422,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_);
 
@@ -377,8 +431,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
        }
 
@@ -399,16 +456,17 @@ vector<Row> 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);
                }
        }
 
@@ -431,11 +489,38 @@ 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
        }
 }
 
+void DecodeSignal::get_annotation_subset(
+       vector<pv::data::decode::Annotation> &dest,
+       uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
+{
+       // Note: We put all vectors and lists on the heap, not the stack
+
+       const vector<Row> rows = visible_rows();
+
+       // Use forward_lists for faster merging
+       forward_list<Annotation> *all_ann_list = new forward_list<Annotation>();
+
+       for (const Row& row : rows) {
+               vector<Annotation> *ann_vector = new vector<Annotation>();
+               get_annotation_subset(*ann_vector, row, segment_id, start_sample, end_sample);
+
+               forward_list<Annotation> *ann_list =
+                       new forward_list<Annotation>(ann_vector->begin(), ann_vector->end());
+               delete ann_vector;
+
+               all_ann_list->merge(*ann_list);
+               delete ann_list;
+       }
+
+       move(all_ann_list->begin(), all_ann_list->end(), back_inserter(dest));
+       delete all_ann_list;
+}
+
 void DecodeSignal::save_settings(QSettings &settings) const
 {
        SignalBase::save_settings(settings);
@@ -567,12 +652,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();
@@ -607,7 +700,7 @@ uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
                        try {
                                const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
                                samplerate = segment->samplerate();
-                       } catch (out_of_range) {
+                       } catch (out_of_range&) {
                                // Do nothing
                        }
                        break;
@@ -736,7 +829,7 @@ void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, c
                        shared_ptr<LogicSegment> 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 +849,7 @@ void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, c
        shared_ptr<LogicSegment> 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 +860,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 +932,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) {
@@ -863,6 +958,7 @@ void DecodeSignal::logic_mux_proc()
                                logic_mux_cond_.wait(logic_mux_lock);
                        }
                }
+
        } while (!logic_mux_interrupt_);
 }
 
@@ -874,33 +970,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<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
                // possibly have new annotations as well
                new_annotations();
+
+               if (decode_paused_) {
+                       unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
+                       decode_pause_cond_.wait(pause_wait_lock);
+               }
        }
 }
 
@@ -948,7 +1054,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 +1067,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 +1079,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<decode::Decoder> &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_);
@@ -993,7 +1125,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;
@@ -1006,15 +1138,39 @@ 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()
+{
+       // 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<decode::Decoder> &dec : stack_)
+                       dec->apply_all_options();
+       }
 }
 
 void DecodeSignal::stop_srd_session()
@@ -1023,6 +1179,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();
        }
 }
 
@@ -1056,9 +1216,10 @@ void DecodeSignal::create_decode_segment()
                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)
-                       (segments_.back().annotation_rows)[Row(decc)] =
+                       (segments_.back().annotation_rows)[Row(row_index++, decc)] =
                                decode::RowData();
 
                // Add the decoder rows
@@ -1067,7 +1228,7 @@ void DecodeSignal::create_decode_segment()
                                (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] =
@@ -1084,6 +1245,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
@@ -1105,7 +1269,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()) {
@@ -1116,7 +1280,7 @@ void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signa
        }
 
        // Add the annotation
-       (*row_iter).second.emplace_annotation(pdata);
+       (*row_iter).second.emplace_annotation(pdata, &((*row_iter).first));
 }
 
 void DecodeSignal::on_capture_state_changed(int state)
@@ -1135,6 +1299,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