]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decodesignal.cpp
DecodeSignal: Improve robustness
[pulseview.git] / pv / data / decodesignal.cpp
index cfc98cd55bb2cfc48706d9400a4d01df5d7c2631..5acf9eec634380533a2cb1c0bfeceb767cec6f7b 100644 (file)
@@ -29,6 +29,7 @@
 #include <pv/binding/decoder.hpp>
 #include <pv/data/decode/decoder.hpp>
 #include <pv/data/decode/row.hpp>
+#include <pv/globalsettings.hpp>
 #include <pv/session.hpp>
 
 using std::lock_guard;
@@ -46,45 +47,28 @@ 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) :
        SignalBase(nullptr, SignalBase::DecodeChannel),
        session_(session),
+       srd_session_(nullptr),
        logic_mux_data_invalid_(false),
        start_time_(0),
        samplerate_(0),
-       annotation_count_(0),
        samples_decoded_(0),
        frame_complete_(false)
 {
        connect(&session_, SIGNAL(capture_state_changed(int)),
                this, SLOT(on_capture_state_changed(int)));
-       connect(&session_, SIGNAL(data_received()),
-               this, SLOT(on_data_received()));
-       connect(&session_, SIGNAL(frame_ended()),
-               this, SLOT(on_frame_ended()));
 
        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();
-       }
+       reset_decode();
 }
 
 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
@@ -92,7 +76,7 @@ const vector< shared_ptr<Decoder> >& 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<decode::Decoder>(decoder));
@@ -147,12 +131,29 @@ bool DecodeSignal::toggle_decoder_visibility(int index)
 
 void DecodeSignal::reset_decode()
 {
-       annotation_count_ = 0;
+       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();
+
        frame_complete_ = false;
        samples_decoded_ = 0;
        error_message_ = QString();
+
        rows_.clear();
        class_rows_.clear();
+
+       logic_mux_data_.reset();
+       logic_mux_data_invalid_ = true;
 }
 
 void DecodeSignal::begin_decode()
@@ -183,6 +184,13 @@ void DecodeSignal::begin_decode()
                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<decode::Decoder> &dec : stack_)
                if (!dec->have_required_channels()) {
@@ -220,13 +228,6 @@ void DecodeSignal::begin_decode()
                }
        }
 
-       // TODO Currently we assume all channels have the same sample rate
-       auto any_channel = find_if(channels_.begin(), channels_.end(),
-               [](data::DecodeChannel ch) { return ch.assigned_signal; });
-       shared_ptr<LogicSegment> first_segment =
-                       any_channel->assigned_signal->logic_data()->logic_segments().front();
-       samplerate_ = first_segment->samplerate();
-
        // Free the logic data and its segment(s) if it needs to be updated
        if (logic_mux_data_invalid_)
                logic_mux_data_.reset();
@@ -239,12 +240,6 @@ void DecodeSignal::begin_decode()
                logic_mux_data_->push_segment(segment_);
        }
 
-       // Update the samplerate and start time
-       start_time_ = segment_->start_time();
-       samplerate_ = segment_->samplerate();
-       if (samplerate_ == 0.0)
-               samplerate_ = 1.0;
-
        // 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);
@@ -252,6 +247,9 @@ 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
@@ -274,11 +272,16 @@ void DecodeSignal::auto_assign_signals()
                if (ch.assigned_signal)
                        continue;
 
-               for (shared_ptr<data::SignalBase> s : session_.signalbases())
-                       if (s->logic_data() && (ch.name.toLower().contains(s->name().toLower()))) {
+               for (shared_ptr<data::SignalBase> 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) {
@@ -409,19 +412,132 @@ 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<decode::Decoder> decoder : stack_) {
+               settings.beginGroup("decoder" + QString::number(decoder_idx++));
+
+               settings.setValue("id", decoder->decoder()->id);
+
+               // Save decoder options
+               const map<string, GVariant*>& 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());
 
-uint64_t DecodeSignal::inc_annotation_count()
-{
-       return (annotation_count_++);
+       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<decode::Decoder> decoder =
+                                       make_shared<decode::Decoder>(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();
+       }
+
+       // Restore channel mapping
+       unsigned int channels = settings.value("channels").toInt();
+
+       const unordered_set< shared_ptr<data::SignalBase> > 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<data::SignalBase> 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();
+       }
+
+       begin_decode();
 }
 
 void DecodeSignal::update_channel_list()
@@ -537,7 +653,10 @@ void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end)
                        const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
                        const shared_ptr<LogicSegment> segment = logic_data->logic_segments().front();
                        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);
@@ -583,7 +702,6 @@ void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end)
 void DecodeSignal::logic_mux_proc()
 {
        do {
-
                const uint64_t input_sample_count = get_working_sample_count();
                const uint64_t output_sample_count = segment_->get_sample_count();
 
@@ -610,12 +728,12 @@ void DecodeSignal::logic_mux_proc()
                        } while (processed_samples < samples_to_process);
                }
 
-               if (session_.get_capture_state() != Session::Stopped) {
+               if (samples_to_process == 0) {
                        // Wait for more input
                        unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
                        logic_mux_cond_.wait(logic_mux_lock);
                }
-       } while ((session_.get_capture_state() != Session::Stopped) && !logic_mux_interrupt_);
+       } while (!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
@@ -623,9 +741,53 @@ void DecodeSignal::logic_mux_proc()
        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
+
+       // 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> 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<mutex> 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<LogicSegment> 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;
+               }
+
+               if (!samplerate_valid) {
+                       // Wait until input data is available or an interrupt was requested
+                       unique_lock<mutex> input_wait_lock(input_mutex_);
+                       decode_input_cond_.wait(input_wait_lock);
+               }
+       } while (!samplerate_valid && !decode_interrupt_);
+}
+
 void DecodeSignal::decode_data(
-       const int64_t abs_start_samplenum, const int64_t sample_count,
-       srd_session *const session)
+       const int64_t abs_start_samplenum, const int64_t sample_count)
 {
        const int64_t unit_size = segment_->unit_size();
        const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
@@ -637,92 +799,126 @@ 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);
+               int64_t data_size = (chunk_end - i) * unit_size;
+               uint8_t* chunk = new uint8_t[data_size];
+               segment_->get_samples(i, chunk_end, chunk);
 
-               if (srd_session_send(session, i, chunk_end, chunk,
-                               (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
+               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;
                }
+
                delete[] chunk;
 
                {
                        lock_guard<mutex> 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()
 {
-       srd_session *session;
-       srd_decoder_inst *prev_di = nullptr;
+       query_input_metadata();
+
+       if (decode_interrupt_)
+               return;
 
-       // Prevent any other decode threads from accessing libsigrokdecode
-       lock_guard<mutex> srd_lock(global_srd_mutex_);
+       start_srd_session();
+
+       uint64_t sample_count;
+       uint64_t abs_start_samplenum = 0;
+       do {
+               // Keep processing new samples until we exhaust the input data
+               do {
+                       lock_guard<mutex> input_lock(input_mutex_);
+                       sample_count = segment_->get_sample_count() - abs_start_samplenum;
+
+                       if (sample_count > 0) {
+                               decode_data(abs_start_samplenum, sample_count);
+                               abs_start_samplenum += sample_count;
+                       }
+               } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
+
+               if (error_message_.isEmpty() && !decode_interrupt_) {
+                       if (sample_count == 0)
+                               decode_finished();
+
+                       // Wait for new input data or an interrupt was requested
+                       unique_lock<mutex> input_wait_lock(input_mutex_);
+                       decode_input_cond_.wait(input_wait_lock);
+               }
+       } while (error_message_.isEmpty() && !decode_interrupt_);
+}
+
+void DecodeSignal::start_srd_session()
+{
+       if (srd_session_)
+               stop_srd_session();
 
        // Create the session
-       srd_session_new(&session);
-       assert(session);
+       srd_session_new(&srd_session_);
+       assert(srd_session_);
 
        // Create the decoders
+       srd_decoder_inst *prev_di = nullptr;
        for (const shared_ptr<decode::Decoder> &dec : stack_) {
-               srd_decoder_inst *const di = dec->create_decoder_inst(session);
+               srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
 
                if (!di) {
                        error_message_ = tr("Failed to create decoder instance");
-                       srd_session_destroy(session);
+                       srd_session_destroy(srd_session_);
                        return;
                }
 
                if (prev_di)
-                       srd_inst_stack(session, prev_di, di);
+                       srd_inst_stack(srd_session_, prev_di, di);
 
                prev_di = di;
        }
 
        // Start the session
-       srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
+       srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
                g_variant_new_uint64(samplerate_));
 
-       srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
+       srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
                DecodeSignal::annotation_callback, this);
 
-       srd_session_start(session);
-
-       uint64_t sample_count;
-       uint64_t abs_start_samplenum = 0;
-       do {
-               // Keep processing new samples until we exhaust the input data
-               do {
-                       {
-                               lock_guard<mutex> input_lock(input_mutex_);
-                               sample_count = segment_->get_sample_count() - abs_start_samplenum;
-                       }
-
-                       if (sample_count > 0) {
-                               decode_data(abs_start_samplenum, sample_count, session);
-                               abs_start_samplenum += sample_count;
-                       }
-               } while (error_message_.isEmpty() && (sample_count > 0));
+       srd_session_start(srd_session_);
+}
 
-               // Terminate if we exhausted the input data
-               if ((int64_t)segment_->get_sample_count() == get_working_sample_count())
-                       break;
+void DecodeSignal::stop_srd_session()
+{
+       if (srd_session_) {
+               // Destroy the session
+               srd_session_destroy(srd_session_);
+               srd_session_ = nullptr;
+       }
+}
 
-               if (error_message_.isEmpty()) {
-                       // Wait for new input data or an interrupt request
-                       unique_lock<mutex> input_wait_lock(input_mutex_);
-                       decode_input_cond_.wait(input_wait_lock);
-               }
-       } while (error_message_.isEmpty() && !decode_interrupt_);
+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()));
 
-       // Make sure all annotations are known to the frontend
-       new_annotations();
+       // Connect the currently used signals to our slot
+       for (data::DecodeChannel &ch : channels_) {
+               if (!ch.assigned_signal)
+                       continue;
 
-       // Destroy the session
-       srd_session_destroy(session);
+               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)),
+                       this, SLOT(on_data_received()));
+       }
 }
 
 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
@@ -764,10 +960,6 @@ void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signa
 
        // 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();
 }
 
 void DecodeSignal::on_capture_state_changed(int state)
@@ -777,14 +969,17 @@ void DecodeSignal::on_capture_state_changed(int state)
                begin_decode();
 }
 
-void DecodeSignal::on_data_received()
+void DecodeSignal::on_data_cleared()
 {
-       logic_mux_cond_.notify_one();
+       reset_decode();
 }
 
-void DecodeSignal::on_frame_ended()
+void DecodeSignal::on_data_received()
 {
-       logic_mux_cond_.notify_one();
+       if (!logic_mux_thread_.joinable())
+               begin_decode();
+       else
+               logic_mux_cond_.notify_one();
 }
 
 } // namespace data