]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/decodetrace.cpp
Annotation: Use special type for the class, not plain int
[pulseview.git] / pv / views / trace / decodetrace.cpp
index d8f04c582ef5a6c9c76696e344e034a52db6bace..f4f243931bd6d27e94952afba35421a38d1ebf2e 100644 (file)
@@ -56,14 +56,11 @@ extern "C" {
 using std::all_of;
 using std::make_pair;
 using std::max;
-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;
@@ -75,58 +72,19 @@ namespace pv {
 namespace views {
 namespace trace {
 
-const QColor DecodeTrace::DecodeColours[4] = {
-       QColor(0xEF, 0x29, 0x29),       // Red
-       QColor(0xFC, 0xE9, 0x4F),       // Yellow
-       QColor(0x8A, 0xE2, 0x34),       // Green
-       QColor(0x72, 0x9F, 0xCF)        // Blue
-};
 
-const QColor DecodeTrace::ErrorBgColour = QColor(0xEF, 0x29, 0x29);
-const QColor DecodeTrace::NoDecodeColour = QColor(0x88, 0x8A, 0x85);
+#define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
+#define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
+
+const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
+const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
 
 const int DecodeTrace::ArrowSize = 4;
 const double DecodeTrace::EndCapWidth = 5;
 const int DecodeTrace::RowTitleMargin = 10;
 const int DecodeTrace::DrawPadding = 100;
 
-const QColor DecodeTrace::Colours[16] = {
-       QColor(0xEF, 0x29, 0x29),
-       QColor(0xF6, 0x6A, 0x32),
-       QColor(0xFC, 0xAE, 0x3E),
-       QColor(0xFB, 0xCA, 0x47),
-       QColor(0xFC, 0xE9, 0x4F),
-       QColor(0xCD, 0xF0, 0x40),
-       QColor(0x8A, 0xE2, 0x34),
-       QColor(0x4E, 0xDC, 0x44),
-       QColor(0x55, 0xD7, 0x95),
-       QColor(0x64, 0xD1, 0xD2),
-       QColor(0x72, 0x9F, 0xCF),
-       QColor(0xD4, 0x76, 0xC4),
-       QColor(0x9D, 0x79, 0xB9),
-       QColor(0xAD, 0x7F, 0xA8),
-       QColor(0xC2, 0x62, 0x9B),
-       QColor(0xD7, 0x47, 0x6F)
-};
-
-const QColor DecodeTrace::OutlineColours[16] = {
-       QColor(0x77, 0x14, 0x14),
-       QColor(0x7B, 0x35, 0x19),
-       QColor(0x7E, 0x57, 0x1F),
-       QColor(0x7D, 0x65, 0x23),
-       QColor(0x7E, 0x74, 0x27),
-       QColor(0x66, 0x78, 0x20),
-       QColor(0x45, 0x71, 0x1A),
-       QColor(0x27, 0x6E, 0x22),
-       QColor(0x2A, 0x6B, 0x4A),
-       QColor(0x32, 0x68, 0x69),
-       QColor(0x39, 0x4F, 0x67),
-       QColor(0x6A, 0x3B, 0x62),
-       QColor(0x4E, 0x3C, 0x5C),
-       QColor(0x56, 0x3F, 0x54),
-       QColor(0x61, 0x31, 0x4D),
-       QColor(0x6B, 0x23, 0x37)
-};
+const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
 
 DecodeTrace::DecodeTrace(pv::Session &session,
        shared_ptr<data::SignalBase> signalbase, int index) :
@@ -143,10 +101,23 @@ DecodeTrace::DecodeTrace(pv::Session &session,
        QFontMetrics m(QApplication::font());
        min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
 
-       base_->set_colour(DecodeColours[index % countof(DecodeColours)]);
+       // For the base color, we want to start at a very different color for
+       // every decoder stack, so multiply the index with a number that is
+       // rather close to 180 degrees of the color circle but not a dividend of 360
+       // Note: The offset equals the color of the first annotation
+       QColor color;
+       const int h = (120 + 160 * index) % 360;
+       const int s = DECODETRACE_COLOR_SATURATION;
+       const int v = DECODETRACE_COLOR_VALUE;
+       color.setHsv(h, s, v);
+       base_->set_color(color);
 
        connect(decode_signal_.get(), SIGNAL(new_annotations()),
                this, SLOT(on_new_annotations()));
+       connect(decode_signal_.get(), SIGNAL(decode_reset()),
+               this, SLOT(on_decode_reset()));
+       connect(decode_signal_.get(), SIGNAL(decode_finished()),
+               this, SLOT(on_decode_finished()));
        connect(decode_signal_.get(), SIGNAL(channels_updated()),
                this, SLOT(on_channels_updated()));
 
@@ -154,6 +125,11 @@ DecodeTrace::DecodeTrace(pv::Session &session,
                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
@@ -212,26 +188,19 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
                int row_title_width;
                try {
                        row_title_width = row_title_widths_.at(row);
-               } catch (out_of_range) {
+               } catch (out_of_range&) {
                        const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
                                RowTitleMargin;
                        row_title_widths_[row] = w;
                        row_title_width = w;
                }
 
-               // Determine the row's color
-               size_t base_colour = 0x13579BDF;
-               boost::hash_combine(base_colour, this);
-               boost::hash_combine(base_colour, row.decoder());
-               boost::hash_combine(base_colour, row.row());
-               base_colour >>= 16;
-
                vector<Annotation> annotations;
                decode_signal_->get_annotation_subset(annotations, row,
-                       sample_range.first, sample_range.second);
+                       current_segment_, sample_range.first, sample_range.second);
                if (!annotations.empty()) {
                        draw_annotations(annotations, p, annotation_height, pp, y,
-                               base_colour, row_title_width);
+                               get_row_color(visible_rows_.size()), row_title_width);
 
                        y += row_height_;
 
@@ -242,11 +211,13 @@ 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)
@@ -352,7 +323,7 @@ QMenu* DecodeTrace::create_context_menu(QWidget *parent)
 
 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
                QPainter &p, int h, const ViewItemPaintParams &pp, int y,
-               size_t base_colour, int row_title_width)
+               QColor row_color, int row_title_width)
 {
        using namespace pv::data::decode;
 
@@ -396,17 +367,17 @@ void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotati
                if ((abs(delta) > 1) || a_is_separate) {
                        // Block was broken, draw annotations that form the current block
                        if (a_block.size() == 1) {
-                               draw_annotation(a_block.front(), p, h, pp, y, base_colour,
+                               draw_annotation(a_block.front(), p, h, pp, y, row_color,
                                        row_title_width);
                        }
                        else
-                               draw_annotation_block(a_block, p, h, y, base_colour);
+                               draw_annotation_block(a_block, p, h, y, row_color);
 
                        a_block.clear();
                }
 
                if (a_is_separate) {
-                       draw_annotation(a, p, h, pp, y, base_colour, row_title_width);
+                       draw_annotation(a, p, h, pp, y, row_color, row_title_width);
                        // Next annotation must start a new block. delta will be > 1
                        // because we set p_end to INT_MIN but that's okay since
                        // a_block will be empty, so nothing will be drawn
@@ -418,15 +389,14 @@ void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotati
        }
 
        if (a_block.size() == 1)
-               draw_annotation(a_block.front(), p, h, pp, y, base_colour,
-                       row_title_width);
+               draw_annotation(a_block.front(), p, h, pp, y, row_color, row_title_width);
        else
-               draw_annotation_block(a_block, p, h, y, base_colour);
+               draw_annotation_block(a_block, p, h, y, row_color);
 }
 
 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
        QPainter &p, int h, const ViewItemPaintParams &pp, int y,
-       size_t base_colour, int row_title_width) const
+       QColor row_color, int row_title_width) const
 {
        double samples_per_pixel, pixels_offset;
        tie(pixels_offset, samples_per_pixel) =
@@ -436,9 +406,9 @@ void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
                pixels_offset;
        const double end = a.end_sample() / samples_per_pixel - pixels_offset;
 
-       const size_t colour = (base_colour + a.format()) % countof(Colours);
-       p.setPen(OutlineColours[colour]);
-       p.setBrush(Colours[colour]);
+       QColor color = get_annotation_color(row_color, a.ann_class());
+       p.setPen(color.darker());
+       p.setBrush(color);
 
        if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
                return;
@@ -451,7 +421,7 @@ void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
 
 void DecodeTrace::draw_annotation_block(
        vector<pv::data::decode::Annotation> annotations, QPainter &p, int h,
-       int y, size_t base_colour) const
+       int y, QColor row_color) const
 {
        using namespace pv::data::decode;
 
@@ -470,15 +440,14 @@ void DecodeTrace::draw_annotation_block(
        const double top = y + .5 - h / 2;
        const double bottom = y + .5 + h / 2;
 
-       const size_t colour = (base_colour + annotations.front().format()) %
-               countof(Colours);
+       QColor color = get_annotation_color(row_color, annotations.front().ann_class());
 
        // Check if all annotations are of the same type (i.e. we can use one color)
        // or if we should use a neutral color (i.e. gray)
-       const int format = annotations.front().format();
-       const bool single_format = all_of(
+       const Annotation::Class ann_class = annotations.front().ann_class();
+       const bool single_class = all_of(
                annotations.begin(), annotations.end(),
-               [&](const Annotation &a) { return a.format() == format; });
+               [&](const Annotation &a) { return a.ann_class() == ann_class; });
 
        const QRectF rect(start, top, end - start, bottom - top);
        const int r = h / 4;
@@ -487,9 +456,8 @@ void DecodeTrace::draw_annotation_block(
        p.setBrush(Qt::white);
        p.drawRoundedRect(rect, r, r);
 
-       p.setPen((single_format ? OutlineColours[colour] : Qt::gray));
-       p.setBrush(QBrush((single_format ? Colours[colour] : Qt::gray),
-               Qt::Dense4Pattern));
+       p.setPen((single_class ? color.darker() : Qt::gray));
+       p.setBrush(QBrush((single_class ? color : Qt::gray), Qt::Dense4Pattern));
        p.drawRoundedRect(rect, r, r);
 }
 
@@ -574,8 +542,8 @@ void DecodeTrace::draw_error(QPainter &p, const QString &message,
 {
        const int y = get_visual_y();
 
-       p.setPen(ErrorBgColour.darker());
-       p.setBrush(ErrorBgColour);
+       p.setPen(ErrorBgColor.darker());
+       p.setBrush(ErrorBgColor);
 
        const QRectF bounding_rect =
                QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
@@ -597,11 +565,11 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right
 
        double samples_per_pixel, pixels_offset;
 
-       const int64_t sample_count = decode_signal_->get_working_sample_count();
+       const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
        if (sample_count == 0)
                return;
 
-       const int64_t samples_decoded = decode_signal_->get_decoded_sample_count();
+       const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_);
        if (sample_count == samples_decoded)
                return;
 
@@ -619,8 +587,8 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right
        p.setBrush(Qt::white);
        p.drawRect(no_decode_rect);
 
-       p.setPen(NoDecodeColour);
-       p.setBrush(QBrush(NoDecodeColour, Qt::Dense6Pattern));
+       p.setPen(NoDecodeColor);
+       p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
        p.drawRect(no_decode_rect);
 }
 
@@ -661,6 +629,34 @@ pair<uint64_t, uint64_t> DecodeTrace::get_sample_range(
        return make_pair(start, end);
 }
 
+QColor DecodeTrace::get_row_color(int row_index) const
+{
+       // For each row color, use the base color hue and add an offset that's
+       // not a dividend of 360
+
+       QColor color;
+       const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
+       const int s = DECODETRACE_COLOR_SATURATION;
+       const int v = DECODETRACE_COLOR_VALUE;
+       color.setHsl(h, s, v);
+
+       return color;
+}
+
+QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
+{
+       // For each row color, use the base color hue and add an offset that's
+       // not a dividend of 360 and not a multiple of the row offset
+
+       QColor color(row_color);
+       const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
+       const int s = DECODETRACE_COLOR_SATURATION;
+       const int v = DECODETRACE_COLOR_VALUE;
+       color.setHsl(h, s, v);
+
+       return color;
+}
+
 int DecodeTrace::get_row_at_point(const QPoint &point)
 {
        if (!row_height_)
@@ -696,20 +692,24 @@ const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
        vector<pv::data::decode::Annotation> annotations;
 
        decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
-               sample_range.first, sample_range.second);
+               current_segment_, sample_range.first, sample_range.second);
 
        return (annotations.empty()) ?
                QString() : annotations[0].annotations().front();
 }
 
-void DecodeTrace::hover_point_changed()
+void DecodeTrace::hover_point_changed(const QPoint &hp)
 {
        assert(owner_);
 
        const View *const view = owner_->view();
        assert(view);
 
-       QPoint hp = view->hover_point();
+       if (hp.x() == 0) {
+               QToolTip::hideText();
+               return;
+       }
+
        QString ann = get_annotation_at_point(hp);
 
        assert(view);
@@ -732,13 +732,14 @@ void DecodeTrace::hover_point_changed()
        // If it did, the tool tip would constantly hide and re-appear.
        // We also push it up by one row so that it appears above the
        // decode trace, not below.
-       hp.setX(hp.x() - (text_size.width() / 2) - padding);
+       QPoint p = hp;
+       p.setX(hp.x() - (text_size.width() / 2) - padding);
 
-       hp.setY(get_visual_y() - (row_height_ / 2) +
+       p.setY(get_visual_y() - (row_height_ / 2) +
                (hover_row * row_height_) -
                row_height_ - text_size.height() - padding);
 
-       QToolTip::showText(view->viewport()->mapToGlobal(hp), ann);
+       QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
 }
 
 void DecodeTrace::create_decoder_form(int index,
@@ -865,6 +866,27 @@ QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
 }
 
 void DecodeTrace::on_new_annotations()
+{
+       if (!delayed_trace_updater_.isActive())
+               delayed_trace_updater_.start();
+}
+
+void DecodeTrace::on_delayed_trace_update()
+{
+       if (owner_)
+               owner_->row_item_appearance_changed(false, true);
+}
+
+void DecodeTrace::on_decode_reset()
+{
+       visible_rows_.clear();
+       max_visible_rows_ = 0;
+
+       if (owner_)
+               owner_->row_item_appearance_changed(false, true);
+}
+
+void DecodeTrace::on_decode_finished()
 {
        if (owner_)
                owner_->row_item_appearance_changed(false, true);
@@ -924,6 +946,10 @@ void DecodeTrace::on_delete_decoder(int index)
 {
        decode_signal_->remove_decoder(index);
 
+       // Force re-calculation of the trace height, see paint_mid()
+       max_visible_rows_ = 0;
+       owner_->extents_changed(false, true);
+
        // Update the popup
        create_popup_form();
 }
@@ -935,6 +961,12 @@ void DecodeTrace::on_show_hide_decoder(int index)
        assert(index < (int)decoder_forms_.size());
        decoder_forms_[index]->set_decoder_visible(state);
 
+       if (!state) {
+               // Force re-calculation of the trace height, see paint_mid()
+               max_visible_rows_ = 0;
+               owner_->extents_changed(false, true);
+       }
+
        if (owner_)
                owner_->row_item_appearance_changed(false, true);
 }