]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decodesignal.cpp
DecodeSignal: Use name of last stacked PD unless the name was changed
[pulseview.git] / pv / data / decodesignal.cpp
index 8483d91d0ce4a2b41de67a07605d2a757d761137..4a802c3b7b051b41803bb0ac22c5cfe0ce40280e 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;
@@ -76,14 +78,19 @@ const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
 void DecodeSignal::stack_decoder(const srd_decoder *decoder)
 {
        assert(decoder);
-       const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
 
-       stack_.push_back(dec);
+       // Set name if this decoder is the first in the list or the name is unchanged
+       const srd_decoder* prev_dec =
+               stack_.empty() ? nullptr : stack_.back()->decoder();
+       const QString prev_dec_name =
+               prev_dec ? QString::fromUtf8(prev_dec->name) : QString();
 
-       // Set name if this decoder is the first in the list
-       if (stack_.size() == 1)
+       if ((stack_.empty()) || ((stack_.size() > 0) && (name() == prev_dec_name)))
                set_name(QString::fromUtf8(decoder->name));
 
+       const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
+       stack_.push_back(dec);
+
        // Include the newly created decode channels in the channel lists
        update_channel_list();
 
@@ -149,6 +156,8 @@ void DecodeSignal::reset_decode(bool shutting_down)
                logic_mux_thread_.join();
        }
 
+       resume_decode();  // Make sure the decode thread isn't blocked by pausing
+
        class_rows_.clear();
        current_segment_id_ = 0;
        segments_.clear();
@@ -196,12 +205,12 @@ void DecodeSignal::begin_decode()
        // Make sure that all assigned channels still provide logic data
        // (can happen when a converted signal was assigned but the
        // conversion removed in the meanwhile)
-       for (data::DecodeChannel &ch : channels_)
+       for (data::DecodeChannelch : 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<decode::Decoder> &dec : stack_)
+       for (const shared_ptr<decode::Decoder>dec : stack_)
                if (!dec->have_required_channels()) {
                        set_error_message(tr("One or more required channels "
                                "have not been specified"));
@@ -209,7 +218,8 @@ void DecodeSignal::begin_decode()
                }
 
        // Map out all the annotation classes
-       for (const shared_ptr<decode::Decoder> &dec : stack_) {
+       int row_index = 0;
+       for (const shared_ptr<decode::Decoder>& dec : stack_) {
                assert(dec);
                const srd_decoder *const decc = dec->decoder();
                assert(dec->decoder());
@@ -219,7 +229,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)
@@ -255,6 +265,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_);
@@ -271,7 +300,7 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
        bool new_assignment = false;
 
        // Try to auto-select channels that don't have signals assigned yet
-       for (data::DecodeChannel &ch : channels_) {
+       for (data::DecodeChannelch : channels_) {
                // If a decoder is given, auto-assign only its channels
                if (dec && (ch.decoder_ != dec))
                        continue;
@@ -279,16 +308,35 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
                if (ch.assigned_signal)
                        continue;
 
-               for (shared_ptr<data::SignalBase> s : session_.signalbases()) {
-                       const QString ch_name = ch.name.toLower();
-                       const QString s_name = s->name().toLower();
+               QString ch_name = ch.name.toLower();
+               ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
+
+               shared_ptr<data::SignalBase> match;
+               for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
+                       if (!s->enabled())
+                               continue;
+
+                       QString s_name = s->name().toLower();
+                       s_name = s_name.replace(QRegExp("[-_.]"), " ");
 
                        if (s->logic_data() &&
                                ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
-                               ch.assigned_signal = s.get();
-                               new_assignment = true;
+                               if (!match)
+                                       match = s;
+                               else {
+                                       // Only replace an existing match if it matches more characters
+                                       int old_unmatched = ch_name.length() - match->name().length();
+                                       int new_unmatched = ch_name.length() - s->name().length();
+                                       if (abs(new_unmatched) < abs(old_unmatched))
+                                               match = s;
+                               }
                        }
                }
+
+               if (match) {
+                       ch.assigned_signal = match.get();
+                       new_assignment = true;
+               }
        }
 
        if (new_assignment) {
@@ -301,7 +349,7 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
 
 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
 {
-       for (data::DecodeChannel &ch : channels_)
+       for (data::DecodeChannelch : channels_)
                if (ch.id == channel_id) {
                        ch.assigned_signal = signal;
                        logic_mux_data_invalid_ = true;
@@ -322,7 +370,7 @@ int DecodeSignal::get_assigned_signal_count() const
 
 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
 {
-       for (data::DecodeChannel &ch : channels_)
+       for (data::DecodeChannelch : channels_)
                if (ch.id == channel_id)
                        ch.initial_pin_state = init_state;
 
@@ -362,7 +410,7 @@ int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
        int64_t count = std::numeric_limits<int64_t>::max();
        bool no_signals_assigned = true;
 
-       for (const data::DecodeChannel &ch : channels_)
+       for (const data::DecodeChannelch : channels_)
                if (ch.assigned_signal) {
                        no_signals_assigned = false;
 
@@ -381,7 +429,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_);
 
@@ -389,7 +438,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
        }
@@ -403,7 +455,7 @@ vector<Row> DecodeSignal::visible_rows() const
 
        vector<Row> rows;
 
-       for (const shared_ptr<decode::Decoder> &dec : stack_) {
+       for (const shared_ptr<decode::Decoder>dec : stack_) {
                assert(dec);
                if (!dec->shown())
                        continue;
@@ -411,16 +463,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);
                }
        }
 
@@ -448,6 +501,33 @@ void DecodeSignal::get_annotation_subset(
        }
 }
 
+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);
@@ -456,7 +536,7 @@ void DecodeSignal::save_settings(QSettings &settings) const
 
        // Save decoder stack
        int decoder_idx = 0;
-       for (shared_ptr<decode::Decoder> decoder : stack_) {
+       for (const shared_ptr<decode::Decoder>& decoder : stack_) {
                settings.beginGroup("decoder" + QString::number(decoder_idx++));
 
                settings.setValue("id", decoder->decoder()->id);
@@ -469,7 +549,7 @@ void DecodeSignal::save_settings(QSettings &settings) const
                // Note: decode::Decoder::options() returns only the options
                // that differ from the default. See binding::Decoder::getter()
                int i = 0;
-               for (auto option : options) {
+               for (auto& option : options) {
                        settings.beginGroup("option" + QString::number(i));
                        settings.setValue("name", QString::fromStdString(option.first));
                        GlobalSettings::store_gvariant(settings, option.second);
@@ -569,7 +649,7 @@ void DecodeSignal::restore_settings(QSettings &settings)
 
                QString assigned_signal_name = settings.value("assigned_signal_name").toString();
 
-               for (shared_ptr<data::SignalBase> signal : signalbases)
+               for (const shared_ptr<data::SignalBase>& signal : signalbases)
                        if (signal->name() == assigned_signal_name)
                                channel->assigned_signal = signal.get();
 
@@ -598,7 +678,7 @@ uint32_t DecodeSignal::get_input_segment_count() const
        uint64_t count = std::numeric_limits<uint64_t>::max();
        bool no_signals_assigned = true;
 
-       for (const data::DecodeChannel &ch : channels_)
+       for (const data::DecodeChannelch : channels_)
                if (ch.assigned_signal) {
                        no_signals_assigned = false;
 
@@ -618,7 +698,7 @@ uint32_t DecodeSignal::get_input_samplerate(uint32_t segment_id) const
 {
        double samplerate = 0;
 
-       for (const data::DecodeChannel &ch : channels_)
+       for (const data::DecodeChannelch : channels_)
                if (ch.assigned_signal) {
                        const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
                        if (!logic_data || logic_data->logic_segments().empty())
@@ -644,7 +724,7 @@ void DecodeSignal::update_channel_list()
        uint16_t id = 0;
 
        // Copy existing entries, create new as needed
-       for (shared_ptr<Decoder> decoder : stack_) {
+       for (shared_ptr<Decoder>& decoder : stack_) {
                const srd_decoder* srd_d = decoder->decoder();
                const GSList *l;
 
@@ -654,7 +734,7 @@ void DecodeSignal::update_channel_list()
                        bool ch_added = false;
 
                        // Copy but update ID if this channel was in the list before
-                       for (data::DecodeChannel &ch : prev_channels)
+                       for (data::DecodeChannelch : prev_channels)
                                if (ch.pdch_ == pdch) {
                                        ch.id = id++;
                                        channels_.push_back(ch);
@@ -677,7 +757,7 @@ void DecodeSignal::update_channel_list()
                        bool ch_added = false;
 
                        // Copy but update ID if this channel was in the list before
-                       for (data::DecodeChannel &ch : prev_channels)
+                       for (data::DecodeChannelch : prev_channels)
                                if (ch.pdch_ == pdch) {
                                        ch.id = id++;
                                        channels_.push_back(ch);
@@ -702,8 +782,8 @@ void DecodeSignal::update_channel_list()
        } else {
                // Same number but assignment may still differ, so compare all channels
                for (size_t i = 0; i < channels_.size(); i++) {
-                       const data::DecodeChannel &p_ch = prev_channels[i];
-                       const data::DecodeChannel &ch = channels_[i];
+                       const data::DecodeChannelp_ch = prev_channels[i];
+                       const data::DecodeChannelch = channels_[i];
 
                        if ((p_ch.pdch_ != ch.pdch_) ||
                                (p_ch.assigned_signal != ch.assigned_signal)) {
@@ -723,7 +803,7 @@ void DecodeSignal::commit_decoder_channels()
        for (shared_ptr<decode::Decoder> dec : stack_) {
                vector<data::DecodeChannel*> channel_list;
 
-               for (data::DecodeChannel &ch : channels_)
+               for (data::DecodeChannelch : channels_)
                        if (ch.decoder_ == dec)
                                channel_list.push_back(&ch);
 
@@ -732,7 +812,7 @@ void DecodeSignal::commit_decoder_channels()
 
        // Channel bit IDs must be in sync with the channel's apperance in channels_
        int id = 0;
-       for (data::DecodeChannel &ch : channels_)
+       for (data::DecodeChannelch : channels_)
                if (ch.assigned_signal)
                        ch.bit_id = id++;
 }
@@ -749,7 +829,7 @@ void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, c
        vector<uint8_t> signal_in_bytepos;
        vector<uint8_t> signal_in_bitpos;
 
-       for (data::DecodeChannel &ch : channels_)
+       for (data::DecodeChannelch : channels_)
                if (ch.assigned_signal) {
                        const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
 
@@ -885,6 +965,7 @@ void DecodeSignal::logic_mux_proc()
                                logic_mux_cond_.wait(logic_mux_lock);
                        }
                }
+
        } while (!logic_mux_interrupt_);
 }
 
@@ -896,33 +977,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) {
+                               data_size, unit_size) != SRD_OK)
                        set_error_message(tr("Decoder reported an error"));
-                       delete[] chunk;
-                       break;
-               }
 
                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);
+               }
        }
 }
 
@@ -1004,8 +1095,6 @@ 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_) {
@@ -1016,13 +1105,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;
        }
 
@@ -1032,7 +1128,7 @@ void DecodeSignal::start_srd_session()
 
        // Create the decoders
        srd_decoder_inst *prev_di = nullptr;
-       for (const shared_ptr<decode::Decoder> &dec : stack_) {
+       for (const shared_ptr<decode::Decoder>dec : stack_) {
                srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
 
                if (!di) {
@@ -1049,10 +1145,9 @@ 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);
@@ -1070,8 +1165,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()
@@ -1082,7 +1188,7 @@ void DecodeSignal::stop_srd_session()
                srd_session_ = nullptr;
 
                // Mark the decoder instances as non-existant since they were deleted
-               for (const shared_ptr<decode::Decoder> &dec : stack_)
+               for (const shared_ptr<decode::Decoder>dec : stack_)
                        dec->invalidate_decoder_inst();
        }
 }
@@ -1094,7 +1200,7 @@ void DecodeSignal::connect_input_notifiers()
        disconnect(this, SLOT(on_data_received()));
 
        // Connect the currently used signals to our slot
-       for (data::DecodeChannel &ch : channels_) {
+       for (data::DecodeChannelch : channels_) {
                if (!ch.assigned_signal)
                        continue;
 
@@ -1112,14 +1218,15 @@ void DecodeSignal::create_decode_segment()
        segments_.emplace_back(DecodeSegment());
 
        // Add annotation classes
-       for (const shared_ptr<decode::Decoder> &dec : stack_) {
+       for (const shared_ptr<decode::Decoder>dec : stack_) {
                assert(dec);
                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
@@ -1128,7 +1235,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] =
@@ -1169,7 +1276,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()) {
@@ -1180,7 +1287,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)