]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/decodetrace.cpp
DecodeTrace: Fix trace resizing when new annotation classes appear
[pulseview.git] / pv / views / trace / decodetrace.cpp
index 6ccd3fb87dc085f9c50b9baa109645ac68c9b213..9529c50a72650958ce7f0b3abdc93b67a01a6f21 100644 (file)
@@ -43,31 +43,31 @@ extern "C" {
 #include "viewport.hpp"
 
 #include <pv/globalsettings.hpp>
+#include <pv/session.hpp>
+#include <pv/strnatcmp.hpp>
+#include <pv/data/decodesignal.hpp>
 #include <pv/data/decode/annotation.hpp>
 #include <pv/data/decode/decoder.hpp>
-#include <pv/data/decoderstack.hpp>
 #include <pv/data/logic.hpp>
 #include <pv/data/logicsegment.hpp>
-#include <pv/session.hpp>
-#include <pv/strnatcmp.hpp>
 #include <pv/widgets/decodergroupbox.hpp>
 #include <pv/widgets/decodermenu.hpp>
 
 using std::all_of;
-using std::list;
 using std::make_pair;
 using std::max;
-using std::make_pair;
-using std::map;
 using std::min;
 using std::out_of_range;
 using std::pair;
 using std::shared_ptr;
-using std::make_shared;
 using std::tie;
-using std::unordered_set;
 using std::vector;
 
+using pv::data::decode::Annotation;
+using pv::data::decode::Row;
+using pv::data::DecodeChannel;
+using pv::data::DecodeSignal;
+
 namespace pv {
 namespace views {
 namespace trace {
@@ -87,6 +87,8 @@ const double DecodeTrace::EndCapWidth = 5;
 const int DecodeTrace::RowTitleMargin = 10;
 const int DecodeTrace::DrawPadding = 100;
 
+const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
+
 const QColor DecodeTrace::Colours[16] = {
        QColor(0xEF, 0x29, 0x29),
        QColor(0xF6, 0x6A, 0x32),
@@ -134,21 +136,30 @@ DecodeTrace::DecodeTrace(pv::Session &session,
        delete_mapper_(this),
        show_hide_mapper_(this)
 {
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
+       decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
 
        // Determine shortest string we want to see displayed in full
        QFontMetrics m(QApplication::font());
        min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
 
-       base_->set_name(QString::fromUtf8(decoder_stack->stack().front()->decoder()->name));
        base_->set_colour(DecodeColours[index % countof(DecodeColours)]);
 
-       connect(decoder_stack.get(), SIGNAL(new_decode_data()),
-               this, SLOT(on_new_decode_data()));
+       connect(decode_signal_.get(), SIGNAL(new_annotations()),
+               this, SLOT(on_new_annotations()));
+       connect(decode_signal_.get(), SIGNAL(decode_finished()),
+               this, SLOT(on_decode_finished()));
+       connect(decode_signal_.get(), SIGNAL(channels_updated()),
+               this, SLOT(on_channels_updated()));
+
        connect(&delete_mapper_, SIGNAL(mapped(int)),
                this, SLOT(on_delete_decoder(int)));
        connect(&show_hide_mapper_, SIGNAL(mapped(int)),
                this, SLOT(on_show_hide_decoder(int)));
+
+       connect(&delayed_trace_updater_, SIGNAL(timeout()),
+               this, SLOT(on_delayed_trace_update()));
+       delayed_trace_updater_.setSingleShot(true);
+       delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
 }
 
 bool DecodeTrace::enabled() const
@@ -179,16 +190,11 @@ void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
 
 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 {
-       using namespace pv::data::decode;
-
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
        const int text_height = ViewItemPaintParams::text_height();
        row_height_ = (text_height * 6) / 4;
        const int annotation_height = (text_height * 5) / 4;
 
-       assert(decoder_stack);
-       const QString err = decoder_stack->error_message();
+       const QString err = decode_signal_->error_message();
        if (!err.isEmpty()) {
                draw_unresolved_period(
                        p, annotation_height, pp.left(), pp.right());
@@ -204,7 +210,7 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
        pair<uint64_t, uint64_t> sample_range = get_sample_range(
                pp.left(), pp.right());
 
-       const vector<Row> rows(decoder_stack->get_visible_rows());
+       const vector<Row> rows = decode_signal_->visible_rows();
 
        visible_rows_.clear();
        for (const Row& row : rows) {
@@ -227,7 +233,7 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
                base_colour >>= 16;
 
                vector<Annotation> annotations;
-               decoder_stack->get_annotation_subset(annotations, row,
+               decode_signal_->get_annotation_subset(annotations, row,
                        sample_range.first, sample_range.second);
                if (!annotations.empty()) {
                        draw_annotations(annotations, p, annotation_height, pp, y,
@@ -242,17 +248,17 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
        // Draw the hatching
        draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
 
-       if ((int)visible_rows_.size() > max_visible_rows_)
-               owner_->extents_changed(false, true);
+       if ((int)visible_rows_.size() > max_visible_rows_) {
+               max_visible_rows_ = (int)visible_rows_.size();
 
-       // Update the maximum row count if needed
-       max_visible_rows_ = max(max_visible_rows_, (int)visible_rows_.size());
+               // Call order is important, otherwise the lazy event handler won't work
+               owner_->extents_changed(false, true);
+               owner_->row_item_appearance_changed(false, true);
+       }
 }
 
 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
 {
-       using namespace pv::data::decode;
-
        assert(row_height_);
 
        for (size_t i = 0; i < visible_rows_.size(); i++) {
@@ -293,21 +299,18 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
 {
        using pv::data::decode::Decoder;
 
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
        assert(form);
-       assert(parent);
-       assert(decoder_stack);
 
        // Add the standard options
        Trace::populate_popup_form(parent, form);
 
        // Add the decoder options
        bindings_.clear();
-       channel_selectors_.clear();
+       channel_id_map_.clear();
+       init_state_map_.clear();
        decoder_forms_.clear();
 
-       const list< shared_ptr<Decoder> >& stack = decoder_stack->stack();
+       const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
 
        if (stack.empty()) {
                QLabel *const l = new QLabel(
@@ -583,7 +586,7 @@ void DecodeTrace::draw_error(QPainter &p, const QString &message,
        p.setBrush(ErrorBgColour);
 
        const QRectF bounding_rect =
-               QRectF(pp.width(), INT_MIN / 2 + y, pp.width(), INT_MAX);
+               QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
        const QRectF text_rect = p.boundingRect(bounding_rect,
                Qt::AlignCenter, message);
        const float r = text_rect.height() / 4;
@@ -595,49 +598,24 @@ void DecodeTrace::draw_error(QPainter &p, const QString &message,
        p.drawText(text_rect, message);
 }
 
-void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
-       int right) const
+void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
 {
        using namespace pv::data;
        using pv::data::decode::Decoder;
 
        double samples_per_pixel, pixels_offset;
 
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
-       assert(decoder_stack);
-
-       shared_ptr<Logic> data;
-       shared_ptr<data::SignalBase> signalbase;
-
-       const list< shared_ptr<Decoder> > &stack = decoder_stack->stack();
-
-       // We get the logic data of the first channel in the list.
-       // This works because we are currently assuming all
-       // LogicSignals have the same data/segment
-       for (const shared_ptr<Decoder> &dec : stack)
-               if (dec && !dec->channels().empty() &&
-                       ((signalbase = (*dec->channels().begin()).second)) &&
-                       ((data = signalbase->logic_data())))
-                       break;
-
-       if (!data || data->logic_segments().empty())
-               return;
-
-       const shared_ptr<LogicSegment> segment = data->logic_segments().front();
-       assert(segment);
-       const int64_t sample_count = (int64_t)segment->get_sample_count();
+       const int64_t sample_count = decode_signal_->get_working_sample_count();
        if (sample_count == 0)
                return;
 
-       const int64_t samples_decoded = decoder_stack->samples_decoded();
+       const int64_t samples_decoded = decode_signal_->get_decoded_sample_count();
        if (sample_count == samples_decoded)
                return;
 
        const int y = get_visual_y();
 
-       tie(pixels_offset, samples_per_pixel) =
-               get_pixels_offset_samples_per_pixel();
+       tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
 
        const double start = max(samples_decoded /
                samples_per_pixel - pixels_offset, left - 1.0);
@@ -656,10 +634,7 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
 
 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
 {
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
        assert(owner_);
-       assert(decoder_stack);
 
        const View *view = owner_->view();
        assert(view);
@@ -668,9 +643,9 @@ pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
        assert(scale > 0);
 
        const double pixels_offset =
-               ((view->offset() - decoder_stack->start_time()) / scale).convert_to<double>();
+               ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
 
-       double samplerate = decoder_stack->samplerate();
+       double samplerate = decode_signal_->samplerate();
 
        // Show sample rate as 1Hz when it is unknown
        if (samplerate == 0.0)
@@ -728,10 +703,7 @@ const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
 
        vector<pv::data::decode::Annotation> annotations;
 
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
-       assert(decoder_stack);
-       decoder_stack->get_annotation_subset(annotations, visible_rows_[row],
+       decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
                sample_range.first, sample_range.second);
 
        return (annotations.empty()) ?
@@ -746,6 +718,12 @@ void DecodeTrace::hover_point_changed()
        assert(view);
 
        QPoint hp = view->hover_point();
+
+       if (hp.x() == 0) {
+               QToolTip::hideText();
+               return;
+       }
+
        QString ann = get_annotation_at_point(hp);
 
        assert(view);
@@ -781,7 +759,6 @@ void DecodeTrace::create_decoder_form(int index,
        shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
        QFormLayout *form)
 {
-       const GSList *l;
        GlobalSettings settings;
 
        assert(dec);
@@ -810,67 +787,40 @@ void DecodeTrace::create_decoder_form(int index,
        QFormLayout *const decoder_form = new QFormLayout;
        group->add_layout(decoder_form);
 
-       // Add the mandatory channels
-       for (l = decoder->channels; l; l = l->next) {
-               const struct srd_channel *const pdch =
-                       (struct srd_channel *)l->data;
-
-               QComboBox *const combo = create_channel_selector(parent, dec, pdch);
-               QComboBox *const combo_initial_pin = create_channel_selector_initial_pin(parent, dec, pdch);
+       const vector<DecodeChannel> channels = decode_signal_->get_channels();
 
-               connect(combo, SIGNAL(currentIndexChanged(int)),
-                       this, SLOT(on_channel_selected(int)));
-               connect(combo_initial_pin, SIGNAL(currentIndexChanged(int)),
-                       this, SLOT(on_initial_pin_selected(int)));
+       // Add the channels
+       for (DecodeChannel ch : channels) {
+               // Ignore channels not part of the decoder we create the form for
+               if (ch.decoder_ != dec)
+                       continue;
 
-               QHBoxLayout *const hlayout = new QHBoxLayout;
-               hlayout->addWidget(combo);
-               hlayout->addWidget(combo_initial_pin);
-
-               if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
-                       combo_initial_pin->hide();
-
-               decoder_form->addRow(tr("<b>%1</b> (%2) *")
-                       .arg(QString::fromUtf8(pdch->name),
-                            QString::fromUtf8(pdch->desc)), hlayout);
-
-               const ChannelSelector s = {combo, combo_initial_pin, dec, pdch};
-               channel_selectors_.push_back(s);
-       }
+               QComboBox *const combo = create_channel_selector(parent, &ch);
+               QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
 
-       // Add the optional channels
-       for (l = decoder->opt_channels; l; l = l->next) {
-               const struct srd_channel *const pdch =
-                       (struct srd_channel *)l->data;
-
-               QComboBox *const combo = create_channel_selector(parent, dec, pdch);
-               QComboBox *const combo_initial_pin = create_channel_selector_initial_pin(parent, dec, pdch);
+               channel_id_map_[combo] = ch.id;
+               init_state_map_[combo_init_state] = ch.id;
 
                connect(combo, SIGNAL(currentIndexChanged(int)),
                        this, SLOT(on_channel_selected(int)));
-               connect(combo_initial_pin, SIGNAL(currentIndexChanged(int)),
-                       this, SLOT(on_initial_pin_selected(int)));
+               connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
+                       this, SLOT(on_init_state_changed(int)));
 
                QHBoxLayout *const hlayout = new QHBoxLayout;
                hlayout->addWidget(combo);
-               hlayout->addWidget(combo_initial_pin);
+               hlayout->addWidget(combo_init_state);
 
                if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
-                       combo_initial_pin->hide();
-
-               decoder_form->addRow(tr("<b>%1</b> (%2)")
-                       .arg(QString::fromUtf8(pdch->name),
-                            QString::fromUtf8(pdch->desc)), hlayout);
+                       combo_init_state->hide();
 
-               const ChannelSelector s = {combo, combo_initial_pin, dec, pdch};
-               channel_selectors_.push_back(s);
+               const QString required_flag = ch.is_optional ? QString() : QString("*");
+               decoder_form->addRow(tr("<b>%1</b> (%2) %3")
+                       .arg(ch.name, ch.desc, required_flag), hlayout);
        }
 
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
        // Add the options
        shared_ptr<binding::Decoder> binding(
-               new binding::Decoder(decoder_stack, dec));
+               new binding::Decoder(decode_signal_, dec));
        binding->add_properties_to_form(decoder_form, true);
 
        bindings_.push_back(binding);
@@ -879,14 +829,11 @@ void DecodeTrace::create_decoder_form(int index,
        decoder_forms_.push_back(group);
 }
 
-QComboBox* DecodeTrace::create_channel_selector(
-       QWidget *parent, const shared_ptr<data::decode::Decoder> &dec,
-       const srd_channel *const pdch)
+QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
 {
-       assert(dec);
-
        const auto sigs(session_.signalbases());
 
+       // Sort signals in natural order
        vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
        sort(sig_list.begin(), sig_list.end(),
                [](const shared_ptr<data::SignalBase> &a,
@@ -894,13 +841,11 @@ QComboBox* DecodeTrace::create_channel_selector(
                        return strnatcasecmp(a->name().toStdString(),
                                b->name().toStdString()) < 0; });
 
-       const auto channel_iter = dec->channels().find(pdch);
-
        QComboBox *selector = new QComboBox(parent);
 
        selector->addItem("-", qVariantFromValue((void*)nullptr));
 
-       if (channel_iter == dec->channels().end())
+       if (!ch->assigned_signal)
                selector->setCurrentIndex(0);
 
        for (const shared_ptr<data::SignalBase> &b : sig_list) {
@@ -909,18 +854,16 @@ QComboBox* DecodeTrace::create_channel_selector(
                        selector->addItem(b->name(),
                                qVariantFromValue((void*)b.get()));
 
-                       if (channel_iter != dec->channels().end() &&
-                               (*channel_iter).second == b)
-                               selector->setCurrentIndex(
-                                       selector->count() - 1);
+                       if (ch->assigned_signal == b.get())
+                               selector->setCurrentIndex(selector->count() - 1);
                }
        }
 
        return selector;
 }
 
-QComboBox* DecodeTrace::create_channel_selector_initial_pin(QWidget *parent,
-       const shared_ptr<data::decode::Decoder> &dec, const srd_channel *const pdch)
+QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
+       const DecodeChannel *ch)
 {
        QComboBox *selector = new QComboBox(parent);
 
@@ -928,64 +871,26 @@ QComboBox* DecodeTrace::create_channel_selector_initial_pin(QWidget *parent,
        selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
        selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
 
-       // Default to index 2 (SRD_INITIAL_PIN_SAME_AS_SAMPLE0).
-       const int idx = (!dec->initial_pins()) ? 2 : dec->initial_pins()->data[pdch->order];
-       selector->setCurrentIndex(idx);
+       selector->setCurrentIndex(ch->initial_pin_state);
 
        selector->setToolTip("Initial (assumed) pin value before the first sample");
 
        return selector;
 }
 
-void DecodeTrace::commit_decoder_channels(shared_ptr<data::decode::Decoder> &dec)
+void DecodeTrace::on_new_annotations()
 {
-       assert(dec);
-
-       map<const srd_channel*, shared_ptr<data::SignalBase> > channel_map;
-
-       const unordered_set< shared_ptr<data::SignalBase> >
-               sigs(session_.signalbases());
-
-       GArray *const initial_pins = g_array_sized_new(FALSE, TRUE,
-               sizeof(uint8_t), channel_selectors_.size());
-       g_array_set_size(initial_pins, channel_selectors_.size());
-
-       for (const ChannelSelector &s : channel_selectors_) {
-               if (s.decoder_ != dec)
-                       break;
-
-               const data::SignalBase *const selection =
-                       (data::SignalBase*)s.combo_->itemData(
-                               s.combo_->currentIndex()).value<void*>();
-
-               for (shared_ptr<data::SignalBase> sig : sigs)
-                       if (sig.get() == selection) {
-                               channel_map[s.pdch_] = sig;
-                               break;
-                       }
-
-               int selection_initial_pin = s.combo_initial_pin_->itemData(
-                       s.combo_initial_pin_->currentIndex()).value<int>();
-
-               initial_pins->data[s.pdch_->order] = selection_initial_pin;
-       }
-
-       dec->set_channels(channel_map);
-       dec->set_initial_pins(initial_pins);
+       if (!delayed_trace_updater_.isActive())
+               delayed_trace_updater_.start();
 }
 
-void DecodeTrace::commit_channels()
+void DecodeTrace::on_delayed_trace_update()
 {
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
-       assert(decoder_stack);
-       for (shared_ptr<data::decode::Decoder> dec : decoder_stack->stack())
-               commit_decoder_channels(dec);
-
-       decoder_stack->begin_decode();
+       if (owner_)
+               owner_->row_item_appearance_changed(false, true);
 }
 
-void DecodeTrace::on_new_decode_data()
+void DecodeTrace::on_decode_finished()
 {
        if (owner_)
                owner_->row_item_appearance_changed(false, true);
@@ -998,64 +903,63 @@ void DecodeTrace::delete_pressed()
 
 void DecodeTrace::on_delete()
 {
-       session_.remove_decode_signal(base_);
+       session_.remove_decode_signal(decode_signal_);
 }
 
 void DecodeTrace::on_channel_selected(int)
 {
-       commit_channels();
+       QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
+
+       // Determine signal that was selected
+       const data::SignalBase *signal =
+               (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
+
+       // Determine decode channel ID this combo box is the channel selector for
+       const uint16_t id = channel_id_map_.at(cb);
+
+       decode_signal_->assign_signal(id, signal);
 }
 
-void DecodeTrace::on_initial_pin_selected(int)
+void DecodeTrace::on_channels_updated()
 {
-       commit_channels();
+       if (owner_)
+               owner_->row_item_appearance_changed(false, true);
 }
 
-void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
+void DecodeTrace::on_init_state_changed(int)
 {
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
+       QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
 
-       assert(decoder);
-       assert(decoder_stack);
-       decoder_stack->push(make_shared<data::decode::Decoder>(decoder));
-       decoder_stack->begin_decode();
+       // Determine inital pin state that was selected
+       int init_state = cb->itemData(cb->currentIndex()).value<int>();
+
+       // Determine decode channel ID this combo box is the channel selector for
+       const uint16_t id = init_state_map_.at(cb);
+
+       decode_signal_->set_initial_pin_state(id, init_state);
+}
+
+void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
+{
+       decode_signal_->stack_decoder(decoder);
 
        create_popup_form();
 }
 
 void DecodeTrace::on_delete_decoder(int index)
 {
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
-       decoder_stack->remove(index);
+       decode_signal_->remove_decoder(index);
 
        // Update the popup
        create_popup_form();
-
-       decoder_stack->begin_decode();
 }
 
 void DecodeTrace::on_show_hide_decoder(int index)
 {
-       using pv::data::decode::Decoder;
-
-       shared_ptr<pv::data::DecoderStack> decoder_stack = base_->decoder_stack();
-
-       const list< shared_ptr<Decoder> > stack(decoder_stack->stack());
-
-       // Find the decoder in the stack
-       auto iter = stack.cbegin();
-       for (int i = 0; i < index; i++, iter++)
-               assert(iter != stack.end());
-
-       shared_ptr<Decoder> dec = *iter;
-       assert(dec);
-
-       const bool show = !dec->shown();
-       dec->show(show);
+       const bool state = decode_signal_->toggle_decoder_visibility(index);
 
        assert(index < (int)decoder_forms_.size());
-       decoder_forms_[index]->set_decoder_visible(show);
+       decoder_forms_[index]->set_decoder_visible(state);
 
        if (owner_)
                owner_->row_item_appearance_changed(false, true);