]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decodesignal.cpp
Fix #831 by saving/restoring the PD channel mapping
[pulseview.git] / pv / data / decodesignal.cpp
index 339c85dd01dd0305879bce1dc88d3fde6d8ec6e3..49b76f2aa9cedd87533031cadd512d50e1589ab2 100644 (file)
@@ -46,8 +46,7 @@ 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;
+const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
 
 mutex DecodeSignal::global_srd_mutex_;
 
@@ -59,7 +58,6 @@ DecodeSignal::DecodeSignal(pv::Session &session) :
        logic_mux_data_invalid_(false),
        start_time_(0),
        samplerate_(0),
-       annotation_count_(0),
        samples_decoded_(0),
        frame_complete_(false)
 {
@@ -71,19 +69,7 @@ DecodeSignal::DecodeSignal(pv::Session &session) :
 
 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();
-       }
-
-       stop_srd_session();
+       reset_decode();
 }
 
 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
@@ -91,7 +77,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));
@@ -146,14 +132,29 @@ bool DecodeSignal::toggle_decoder_visibility(int index)
 
 void DecodeSignal::reset_decode()
 {
+       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();
 
-       annotation_count_ = 0;
        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()
@@ -184,6 +185,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()) {
@@ -265,11 +273,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) {
@@ -400,19 +413,106 @@ 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);
+
+               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();
+       }
+
+       // TODO Save decoder options
 }
 
 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) {
+                               stack_.push_back(make_shared<decode::Decoder>(dec));
+
+                               // 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();
+
+       // TODO Restore decoder options
 }
 
 void DecodeSignal::update_channel_list()
@@ -600,12 +700,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
@@ -638,9 +738,11 @@ void DecodeSignal::query_input_metadata()
                                samplerate_valid = true;
                }
 
-               // 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);
+               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_);
 }
 
@@ -672,6 +774,10 @@ void DecodeSignal::decode_data(
                        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();
        }
 }
 
@@ -701,11 +807,11 @@ void DecodeSignal::decode_proc()
                                decode_data(abs_start_samplenum, sample_count);
                                abs_start_samplenum += sample_count;
                        }
-               } while (error_message_.isEmpty() && (sample_count > 0));
+               } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
 
-               if (error_message_.isEmpty()) {
-                       // Make sure all annotations are known to the frontend
-                       new_annotations();
+               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_);
@@ -762,6 +868,7 @@ void DecodeSignal::stop_srd_session()
 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()));
 
        // Connect the currently used signals to our slot
@@ -769,8 +876,10 @@ void DecodeSignal::connect_input_notifiers()
                if (!ch.assigned_signal)
                        continue;
 
-               shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
-               connect(logic_data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
+               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()));
        }
 }
@@ -814,10 +923,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)
@@ -827,9 +932,17 @@ void DecodeSignal::on_capture_state_changed(int state)
                begin_decode();
 }
 
+void DecodeSignal::on_data_cleared()
+{
+       reset_decode();
+}
+
 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