]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decodesignal.cpp
Session: Fix issue #67 by improving error handling
[pulseview.git] / pv / data / decodesignal.cpp
index b9a1fabc74917fc2cc8791ed9ae7abe8ff04b38b..9c695a1baa8247dfa09be12c8cdd9b2ee5956d34 100644 (file)
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "config.h"
+
 #include <cstring>
 #include <forward_list>
 #include <limits>
 
 #include <QDebug>
+#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
+#include <QRegularExpression>
+#endif
 
 #include "logic.hpp"
 #include "logicsegment.hpp"
@@ -33,6 +38,7 @@
 #include <pv/globalsettings.hpp>
 #include <pv/session.hpp>
 
+using std::dynamic_pointer_cast;
 using std::lock_guard;
 using std::make_shared;
 using std::min;
@@ -67,6 +73,20 @@ DecodeSignal::~DecodeSignal()
        reset_decode(true);
 }
 
+void DecodeSignal::set_name(QString name)
+{
+       SignalBase::set_name(name);
+
+       update_output_signals();
+}
+
+void DecodeSignal::set_color(QColor color)
+{
+       SignalBase::set_color(color);
+
+       update_output_signals();
+}
+
 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
 {
        return stack_;
@@ -95,6 +115,7 @@ void DecodeSignal::stack_decoder(const srd_decoder *decoder, bool restart_decode
        stack_config_changed_ = true;
        auto_assign_signals(dec);
        commit_decoder_channels();
+       update_output_signals();
 
        decoder_stacked((void*)dec.get());
 
@@ -166,6 +187,10 @@ void DecodeSignal::reset_decode(bool shutting_down)
        current_segment_id_ = 0;
        segments_.clear();
 
+       for (const shared_ptr<decode::Decoder>& dec : stack_)
+               if (dec->has_logic_output())
+                       output_logic_[dec->get_srd_decoder()]->clear();
+
        logic_mux_data_.reset();
        logic_mux_data_invalid_ = true;
 
@@ -231,9 +256,6 @@ void DecodeSignal::begin_decode()
                logic_mux_data_ = make_shared<Logic>(ch_count);
        }
 
-       // Receive notifications when new sample data is available
-       connect_input_notifiers();
-
        if (get_input_segment_count() == 0)
                set_error_message(tr("No input data"));
 
@@ -274,6 +296,9 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
 {
        bool new_assignment = false;
 
+       // Disconnect all input signal notifications so we don't have duplicate connections
+       disconnect_input_notifiers();
+
        // Try to auto-select channels that don't have signals assigned yet
        for (decode::DecodeChannel& ch : channels_) {
                // If a decoder is given, auto-assign only its channels
@@ -284,7 +309,11 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
                        continue;
 
                QString ch_name = ch.name.toLower();
+#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
+               ch_name = ch_name.replace(QRegularExpression("[-_.]"), " ");
+#else
                ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
+#endif
 
                shared_ptr<data::SignalBase> match;
                for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
@@ -292,7 +321,11 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
                                continue;
 
                        QString s_name = s->name().toLower();
+#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
+                       s_name = s_name.replace(QRegularExpression("[-_.]"), " ");
+#else
                        s_name = s_name.replace(QRegExp("[-_.]"), " ");
+#endif
 
                        if (s->logic_data() &&
                                ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
@@ -308,13 +341,22 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
                        }
                }
 
-               if (match) {
+               // Prevent using a signal more than once as D1 would match e.g. D1 and D10
+               bool signal_not_already_used = true;
+               for (decode::DecodeChannel& ch : channels_)
+                       if (ch.assigned_signal && (ch.assigned_signal == match))
+                               signal_not_already_used = false;
+
+               if (match && signal_not_already_used) {
                        ch.assigned_signal = match;
                        new_assignment = true;
                }
        }
 
        if (new_assignment) {
+               // Receive notifications when new sample data is available
+               connect_input_notifiers();
+
                logic_mux_data_invalid_ = true;
                stack_config_changed_ = true;
                commit_decoder_channels();
@@ -324,12 +366,18 @@ void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
 
 void DecodeSignal::assign_signal(const uint16_t channel_id, shared_ptr<const SignalBase> signal)
 {
+       // Disconnect all input signal notifications so we don't have duplicate connections
+       disconnect_input_notifiers();
+
        for (decode::DecodeChannel& ch : channels_)
                if (ch.id == channel_id) {
                        ch.assigned_signal = signal;
                        logic_mux_data_invalid_ = true;
                }
 
+       // Receive notifications when new sample data is available
+       connect_input_notifiers();
+
        stack_config_changed_ = true;
        commit_decoder_channels();
        channels_updated();
@@ -343,6 +391,62 @@ int DecodeSignal::get_assigned_signal_count() const
                [](decode::DecodeChannel ch) { return ch.assigned_signal.get(); });
 }
 
+void DecodeSignal::update_output_signals()
+{
+       for (const shared_ptr<decode::Decoder>& dec : stack_) {
+               assert(dec);
+
+               if (dec->has_logic_output()) {
+                       const vector<decode::DecoderLogicOutputChannel> logic_channels =
+                               dec->logic_output_channels();
+
+                       // All signals of a decoder share the same LogicSegment, so it's
+                       // sufficient to check for only the first channel
+                       const decode::DecoderLogicOutputChannel& first_ch = logic_channels[0];
+
+                       bool ch_exists = false;
+                       for (const shared_ptr<SignalBase>& signal : output_signals_)
+                               if (signal->internal_name() == first_ch.id)
+                                       ch_exists = true;
+
+                       if (!ch_exists) {
+                               shared_ptr<Logic> logic_data = make_shared<Logic>(logic_channels.size());
+                               logic_data->set_samplerate(get_samplerate());
+                               output_logic_[dec->get_srd_decoder()] = logic_data;
+                               output_logic_muxed_data_[dec->get_srd_decoder()] = vector<uint8_t>();
+
+                               shared_ptr<LogicSegment> logic_segment = make_shared<data::LogicSegment>(
+                                       *logic_data, 0, (logic_data->num_channels() + 7) / 8, get_samplerate());
+                               logic_data->push_segment(logic_segment);
+
+                               uint index = 0;
+                               for (const decode::DecoderLogicOutputChannel& logic_ch : logic_channels) {
+                                       shared_ptr<data::SignalBase> signal =
+                                               make_shared<data::SignalBase>(nullptr, LogicChannel);
+                                       signal->set_internal_name(logic_ch.id);
+                                       signal->set_index(index);
+                                       signal->set_data(logic_data);
+                                       output_signals_.push_back(signal);
+                                       session_.add_generated_signal(signal);
+                                       index++;
+                               }
+                       } else {
+                               shared_ptr<Logic> logic_data = output_logic_[dec->get_srd_decoder()];
+                               logic_data->set_samplerate(get_samplerate());
+                               for (shared_ptr<LogicSegment>& segment : logic_data->logic_segments())
+                                       segment->set_samplerate(get_samplerate());
+                       }
+               }
+       }
+
+       for (shared_ptr<SignalBase> s : output_signals_) {
+               s->set_name(s->internal_name() + " (" + name() + ")");
+               s->set_color(color());
+       }
+
+       // TODO Assert that all sample rates are the same as the session's
+}
+
 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
 {
        for (decode::DecodeChannel& ch : channels_)
@@ -457,7 +561,6 @@ vector<const Row*> DecodeSignal::get_rows(bool visible_only) const
        return rows;
 }
 
-
 uint64_t DecodeSignal::get_annotation_count(const Row* row, uint32_t segment_id) const
 {
        if (segment_id >= segments_.size())
@@ -655,7 +758,11 @@ void DecodeSignal::save_settings(QSettings &settings) const
        for (const shared_ptr<Decoder>& decoder : stack_) {
                settings.beginGroup("decoder" + QString::number(decoder_idx++));
 
+#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
+               settings.setValue("id", (const char *)decoder->get_srd_decoder()->id);
+#else
                settings.setValue("id", decoder->get_srd_decoder()->id);
+#endif
                settings.setValue("visible", decoder->visible());
 
                // Save decoder options
@@ -717,6 +824,8 @@ void DecodeSignal::save_settings(QSettings &settings) const
 
                settings.endGroup();
        }
+
+       // TODO Save logic output signal settings
 }
 
 void DecodeSignal::restore_settings(QSettings &settings)
@@ -815,10 +924,15 @@ void DecodeSignal::restore_settings(QSettings &settings)
                settings.endGroup();
        }
 
+       connect_input_notifiers();
+
        // Update the internal structures
        stack_config_changed_ = true;
        update_channel_list();
        commit_decoder_channels();
+       update_output_signals();
+
+       // TODO Restore logic output signal settings
 
        begin_decode();
 }
@@ -1158,6 +1272,7 @@ void DecodeSignal::logic_mux_proc()
                                        output_segment->set_complete();
 
                                if (segment_id < get_input_segment_count() - 1) {
+
                                        // Process next segment
                                        segment_id++;
 
@@ -1167,9 +1282,13 @@ void DecodeSignal::logic_mux_proc()
                                        logic_mux_data_->push_segment(output_segment);
 
                                        output_segment->set_samplerate(get_input_samplerate(segment_id));
+                               } else {
+                                       // Wait for more input data if we're processing the currently last segment
+                                       unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
+                                       logic_mux_cond_.wait(logic_mux_lock);
                                }
                        } else {
-                               // Wait for more input
+                               // Input segments aren't all complete yet but samples_to_process is 0, wait for more input data
                                unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
                                logic_mux_cond_.wait(logic_mux_lock);
                        }
@@ -1185,8 +1304,7 @@ void DecodeSignal::decode_data(
        const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
 
        for (int64_t i = abs_start_samplenum;
-               error_message_.isEmpty() && !decode_interrupt_ &&
-                       (i < (abs_start_samplenum + sample_count));
+               !decode_interrupt_ && (i < (abs_start_samplenum + sample_count));
                i += chunk_sample_count) {
 
                const int64_t chunk_end = min(i + chunk_sample_count,
@@ -1272,7 +1390,15 @@ void DecodeSignal::decode_proc()
 
                        // If the input segment is complete, we've exhausted this segment
                        if (input_segment->is_complete()) {
-                               if (current_segment_id_ < logic_mux_data_->logic_segments().size() - 1) {
+#if defined HAVE_SRD_SESSION_SEND_EOF && HAVE_SRD_SESSION_SEND_EOF
+                               // Tell protocol decoders about the end of
+                               // the input data, which may result in more
+                               // annotations being emitted
+                               (void)srd_session_send_eof(srd_session_);
+                               new_annotations();
+#endif
+
+                               if (current_segment_id_ < (logic_mux_data_->logic_segments().size() - 1)) {
                                        // Process next segment
                                        current_segment_id_++;
 
@@ -1298,12 +1424,17 @@ void DecodeSignal::decode_proc()
                                        // All segments have been processed
                                        if (!decode_interrupt_)
                                                decode_finished();
+
+                                       // Wait for more input data
+                                       unique_lock<mutex> input_wait_lock(input_mutex_);
+                                       decode_input_cond_.wait(input_wait_lock);
                                }
                        } else {
-                               // Wait for more input data
+                               // Input segment isn't complete yet but samples_to_process is 0, wait for more input data
                                unique_lock<mutex> input_wait_lock(input_mutex_);
                                decode_input_cond_.wait(input_wait_lock);
                        }
+
                }
        } while (!decode_interrupt_);
 }
@@ -1337,6 +1468,9 @@ void DecodeSignal::start_srd_session()
                return;
        }
 
+       // Update the samplerates for the output logic channels
+       update_output_signals();
+
        // Create the session
        srd_session_new(&srd_session_);
        assert(srd_session_);
@@ -1370,6 +1504,9 @@ void DecodeSignal::start_srd_session()
        srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
                DecodeSignal::binary_callback, this);
 
+       srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_LOGIC,
+               DecodeSignal::logic_output_callback, this);
+
        srd_session_start(srd_session_);
 
        // We just recreated the srd session, so all stack changes are applied now
@@ -1384,6 +1521,9 @@ void DecodeSignal::terminate_srd_session()
        // those stacks which still are processing data while the
        // application no longer wants them to.
        if (srd_session_) {
+#if defined HAVE_SRD_SESSION_SEND_EOF && HAVE_SRD_SESSION_SEND_EOF
+               (void)srd_session_send_eof(srd_session_);
+#endif
                srd_session_terminate_reset(srd_session_);
 
                // Metadata is cleared also, so re-set it
@@ -1413,20 +1553,35 @@ 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
        for (decode::DecodeChannel& ch : channels_) {
                if (!ch.assigned_signal)
                        continue;
+               const data::SignalBase *signal = ch.assigned_signal.get();
+
+               connect(signal, SIGNAL(samples_cleared()),
+                       this, SLOT(on_data_cleared()), Qt::UniqueConnection);
+               connect(signal, SIGNAL(samples_added(uint64_t, uint64_t, uint64_t)),
+                       this, SLOT(on_data_received()), Qt::UniqueConnection);
+
+               if (signal->logic_data())
+                       connect(signal->logic_data().get(), SIGNAL(segment_completed()),
+                               this, SLOT(on_input_segment_completed()), Qt::UniqueConnection);
+       }
+}
 
+void DecodeSignal::disconnect_input_notifiers()
+{
+       // Disconnect the notification slot from the previous set of signals
+       for (decode::DecodeChannel& ch : channels_) {
+               if (!ch.assigned_signal)
+                       continue;
                const data::SignalBase *signal = ch.assigned_signal.get();
-               connect(signal, &data::SignalBase::samples_cleared,
-                       this, &DecodeSignal::on_data_cleared);
-               connect(signal, &data::SignalBase::samples_added,
-                       this, &DecodeSignal::on_data_received);
+               disconnect(signal, nullptr, this, SLOT(on_data_cleared()));
+               disconnect(signal, nullptr, this, SLOT(on_data_received()));
+
+               if (signal->logic_data())
+                       disconnect(signal->logic_data().get(), nullptr, this, SLOT(on_input_segment_completed()));
        }
 }
 
@@ -1604,6 +1759,77 @@ void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
        ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class);
 }
 
+void DecodeSignal::logic_output_callback(srd_proto_data *pdata, void *decode_signal)
+{
+       assert(pdata);
+       assert(decode_signal);
+
+       DecodeSignal *const ds = (DecodeSignal*)decode_signal;
+       assert(ds);
+
+       if (ds->decode_interrupt_)
+               return;
+
+       lock_guard<mutex> lock(ds->output_mutex_);
+
+       assert(pdata->pdo);
+       assert(pdata->pdo->di);
+       const srd_decoder *const decc = pdata->pdo->di->decoder;
+       assert(decc);
+
+       const srd_proto_data_logic *const pdl = (const srd_proto_data_logic*)pdata->data;
+       assert(pdl);
+
+       // FIXME Only one group supported for now
+       if (pdl->logic_group > 0) {
+               qWarning() << "Received logic output state change for group" << pdl->logic_group << "from decoder" \
+                       << QString::fromUtf8(decc->name) << "but only group 0 is currently supported";
+               return;
+       }
+
+       shared_ptr<Logic> output_logic = ds->output_logic_.at(decc);
+
+       vector< shared_ptr<Segment> > segments = output_logic->segments();
+
+       shared_ptr<LogicSegment> last_segment;
+
+       if (!segments.empty())
+               last_segment = dynamic_pointer_cast<LogicSegment>(segments.back());
+       else {
+               // Happens when the data was cleared - all segments are gone then
+               // segment_id is always 0 as it's the first segment
+               last_segment = make_shared<data::LogicSegment>(
+                       *output_logic, 0, (output_logic->num_channels() + 7) / 8, output_logic->get_samplerate());
+               output_logic->push_segment(last_segment);
+       }
+
+       if (pdata->start_sample < pdata->end_sample) {
+               vector<uint8_t> data;
+               const unsigned int unit_size = last_segment->unit_size();
+               data.resize(unit_size * (1 + pdl->repeat_count));
+
+               if (unit_size == 1)
+                       for (unsigned int i = 0; i <= pdl->repeat_count; i++)
+                               data.data()[i * unit_size] = *((uint8_t*)pdl->data);
+               else if (unit_size == 2)
+                       for (unsigned int i = 0; i <= pdl->repeat_count; i++)
+                               data.data()[i * unit_size] = *((uint16_t*)pdl->data);
+               else if (unit_size <= 4)
+                       for (unsigned int i = 0; i <= pdl->repeat_count; i++)
+                               data.data()[i * unit_size] = *((uint32_t*)pdl->data);
+               else if (unit_size <= 8)
+                       for (unsigned int i = 0; i <= pdl->repeat_count; i++)
+                               data.data()[i * unit_size] = *((uint64_t*)pdl->data);
+               else
+                       for (unsigned int i = 0; i <= pdl->repeat_count; i++)
+                               memcpy((void*)&data.data()[i * unit_size], (void*)pdl->data, unit_size);
+
+               last_segment->append_payload(data.data(), data.size());
+       } else
+               qWarning() << "Ignoring malformed logic output state change for group" << pdl->logic_group << "from decoder" \
+                       << QString::fromUtf8(decc->name) << "from" << pdata->start_sample << "to" << pdata->end_sample;
+}
+
 void DecodeSignal::on_capture_state_changed(int state)
 {
        // If a new acquisition was started, we need to start decoding from scratch
@@ -1621,17 +1847,29 @@ 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
+       // we have set an error message. Bail out if we still don't have data
        // to work with
        if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
                return;
 
+       if (!error_message_.isEmpty()) {
+               error_message_.clear();
+               // TODO Emulate noquote()
+               qDebug().nospace() << name() << ": Input data available, error cleared";
+       }
+
        if (!logic_mux_thread_.joinable())
                begin_decode();
        else
                logic_mux_cond_.notify_one();
 }
 
+void DecodeSignal::on_input_segment_completed()
+{
+       if (!logic_mux_thread_.joinable())
+               logic_mux_cond_.notify_one();
+}
+
 void DecodeSignal::on_annotation_visibility_changed()
 {
        annotation_visibility_changed();