X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fviews%2Ftrace%2Fdecodetrace.cpp;h=61163bc2bdca727068f7384d0c455877ef5756fe;hp=bc309a738d8d82ee6f0341c3d301ec5a0119c0e9;hb=74bf66669012692f7eda790abe724bd5bb4ae8c6;hpb=5ecf957f9f58abc2372b0214333d3491477c1b4d diff --git a/pv/views/trace/decodetrace.cpp b/pv/views/trace/decodetrace.cpp index bc309a73..61163bc2 100644 --- a/pv/views/trace/decodetrace.cpp +++ b/pv/views/trace/decodetrace.cpp @@ -21,21 +21,25 @@ extern "C" { #include } +#include #include +#include #include -#include - #include #include #include +#include #include +#include #include #include #include +#include #include +#include #include #include "decodetrace.hpp" @@ -53,10 +57,13 @@ extern "C" { #include #include -using std::all_of; +using std::abs; +using std::find_if; +using std::lock_guard; using std::make_pair; using std::max; using std::min; +using std::numeric_limits; using std::out_of_range; using std::pair; using std::shared_ptr; @@ -65,84 +72,60 @@ using std::vector; using pv::data::decode::Annotation; using pv::data::decode::Row; -using pv::data::DecodeChannel; +using pv::data::decode::DecodeChannel; using pv::data::DecodeSignal; 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 int DecodeTrace::ArrowSize = 4; +const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29); +const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85); + +const int DecodeTrace::ArrowSize = 6; const double DecodeTrace::EndCapWidth = 5; -const int DecodeTrace::RowTitleMargin = 10; +const int DecodeTrace::RowTitleMargin = 7; 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), - 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 unsigned int DecodeTrace::AnimationDurationInTicks = 7; DecodeTrace::DecodeTrace(pv::Session &session, shared_ptr signalbase, int index) : Trace(signalbase), session_(session), - row_height_(0), max_visible_rows_(0), delete_mapper_(this), show_hide_mapper_(this) { decode_signal_ = dynamic_pointer_cast(base_); + GlobalSettings settings; + always_show_all_rows_ = settings.value(GlobalSettings::Key_Dec_AlwaysShowAllRows).toBool(); + + GlobalSettings::add_change_handler(this); + // 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_colour(DecodeColours[index % countof(DecodeColours)]); + default_row_height_ = (ViewItemPaintParams::text_height() * 6) / 4; + annotation_height_ = (ViewItemPaintParams::text_height() * 5) / 4; + + // 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())); @@ -162,6 +145,19 @@ DecodeTrace::DecodeTrace(pv::Session &session, this, SLOT(on_delayed_trace_update())); delayed_trace_updater_.setSingleShot(true); delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate); + + connect(&animation_timer_, SIGNAL(timeout()), + this, SLOT(on_animation_timer())); + animation_timer_.setInterval(1000 / 50); + + default_marker_shape_ << QPoint(0, -ArrowSize); + default_marker_shape_ << QPoint(ArrowSize, 0); + default_marker_shape_ << QPoint(0, ArrowSize); +} + +DecodeTrace::~DecodeTrace() +{ + GlobalSettings::remove_change_handler(this); } bool DecodeTrace::enabled() const @@ -176,12 +172,16 @@ shared_ptr DecodeTrace::base() const pair DecodeTrace::v_extents() const { - const int row_height = (ViewItemPaintParams::text_height() * 6) / 4; - // Make an empty decode trace appear symmetrical - const int row_count = max(1, max_visible_rows_); + if (max_visible_rows_ == 0) + return make_pair(-default_row_height_, default_row_height_); - return make_pair(-row_height, row_height * row_count); + unsigned int height = 0; + for (const RowData& r : rows_) + if (r.currently_visible) + height += r.height; + + return make_pair(-default_row_height_, height); } void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp) @@ -192,95 +192,88 @@ void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp) void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp) { - const int text_height = ViewItemPaintParams::text_height(); - row_height_ = (text_height * 6) / 4; - const int annotation_height = (text_height * 5) / 4; - - const QString err = decode_signal_->error_message(); - if (!err.isEmpty()) { - draw_unresolved_period( - p, annotation_height, pp.left(), pp.right()); - draw_error(p, err, pp); - return; - } + lock_guard lock(row_modification_mutex_); // Set default pen to allow for text width calculation p.setPen(Qt::black); - // Iterate through the rows - int y = get_visual_y(); - pair sample_range = get_sample_range( - pp.left(), pp.right()); - - const vector rows = decode_signal_->visible_rows(); - - visible_rows_.clear(); - for (const Row& row : rows) { - // Cache the row title widths - int row_title_width; - try { - row_title_width = row_title_widths_.at(row); - } catch (out_of_range) { - const int w = p.boundingRect(QRectF(), 0, row.title()).width() + - RowTitleMargin; - row_title_widths_[row] = w; - row_title_width = w; - } + pair sample_range = get_view_sample_range(pp.left(), pp.right()); - // 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; + // Just because the view says we see a certain sample range it + // doesn't mean we have this many decoded samples, too, so crop + // the range to what has been decoded already + sample_range.second = min((int64_t)sample_range.second, + decode_signal_->get_decoded_sample_count(current_segment_, false)); - vector annotations; - decode_signal_->get_annotation_subset(annotations, row, - sample_range.first, sample_range.second); - if (!annotations.empty()) { - draw_annotations(annotations, p, annotation_height, pp, y, - base_colour, row_title_width); + for (RowData& r : rows_) + r.currently_visible = false; + visible_rows_ = 0; + int y = get_visual_y(); - y += row_height_; + for (RowData& r : rows_) { + // If an entire decoder is hidden, we don't want to fetch annotations + if (!r.decode_row.decoder()->shown()) { + r.currently_visible = false; + continue; + } - visible_rows_.push_back(row); + vector annotations; + decode_signal_->get_annotation_subset(annotations, r.decode_row, + current_segment_, sample_range.first, sample_range.second); + + // Show row if there are visible annotations or when user wants to see + // all rows that have annotations somewhere and this one is one of them + size_t ann_count = decode_signal_->get_annotation_count(r.decode_row, current_segment_); + r.currently_visible = !annotations.empty() || (always_show_all_rows_ && (ann_count > 0)); + + if (r.currently_visible) { + draw_annotations(annotations, p, annotation_height_, pp, y, + get_row_color(r.decode_row.index()), r.title_width); + y += r.height; + visible_rows_++; } } - // Draw the hatching - draw_unresolved_period(p, annotation_height, pp.left(), pp.right()); + draw_unresolved_period(p, annotation_height_, pp.left(), pp.right()); - if ((int)visible_rows_.size() > max_visible_rows_) { - max_visible_rows_ = (int)visible_rows_.size(); + if (visible_rows_ > max_visible_rows_) { + max_visible_rows_ = visible_rows_; // Call order is important, otherwise the lazy event handler won't work owner_->extents_changed(false, true); owner_->row_item_appearance_changed(false, true); } + + const QString err = decode_signal_->error_message(); + if (!err.isEmpty()) + draw_error(p, err, pp); } void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp) { - assert(row_height_); + unsigned int y = get_visual_y(); - for (size_t i = 0; i < visible_rows_.size(); i++) { - const int y = i * row_height_ + get_visual_y(); + for (const RowData& r : rows_) { + if (!r.currently_visible) + continue; p.setPen(QPen(Qt::NoPen)); - p.setBrush(QApplication::palette().brush(QPalette::WindowText)); - if (i != 0) { - const QPointF points[] = { - QPointF(pp.left(), y - ArrowSize), - QPointF(pp.left() + ArrowSize, y), - QPointF(pp.left(), y + ArrowSize) - }; - p.drawPolygon(points, countof(points)); - } + if (r.expand_marker_highlighted) + p.setBrush(QApplication::palette().brush(QPalette::Highlight)); + else + p.setBrush(QApplication::palette().brush(QPalette::WindowText)); + + // Draw expansion marker + QPolygon marker(r.expand_marker_shape); + marker.translate(pp.left(), y); + p.drawPolygon(marker); + + p.setBrush(QApplication::palette().brush(QPalette::WindowText)); - const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2, - pp.right() - pp.left(), row_height_); - const QString h(visible_rows_[i].title()); + const QRect text_rect(pp.left() + ArrowSize * 2, y - r.height / 2, + pp.right() - pp.left(), r.height); + const QString h(r.decode_row.title()); const int f = Qt::AlignLeft | Qt::AlignVCenter | Qt::TextDontClip; @@ -289,12 +282,44 @@ void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp) for (int dx = -1; dx <= 1; dx++) for (int dy = -1; dy <= 1; dy++) if (dx != 0 && dy != 0) - p.drawText(r.translated(dx, dy), f, h); + p.drawText(text_rect.translated(dx, dy), f, h); // Draw the text p.setPen(QApplication::palette().color(QPalette::WindowText)); - p.drawText(r, f, h); + p.drawText(text_rect, f, h); + + y += r.height; } + + if (show_hover_marker_) + paint_hover_marker(p); +} + +void DecodeTrace::update_stack_button() +{ + const vector< shared_ptr > &stack = decode_signal_->decoder_stack(); + + // Only show decoders in the menu that can be stacked onto the last one in the stack + if (!stack.empty()) { + const srd_decoder* d = stack.back()->decoder(); + + if (d->outputs) { + pv::widgets::DecoderMenu *const decoder_menu = + new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data)); + connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)), + this, SLOT(on_stack_decoder(srd_decoder*))); + + decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }"); + + stack_button_->setMenu(decoder_menu); + stack_button_->show(); + return; + } + } + + // No decoders available for stacking + stack_button_->setMenu(nullptr); + stack_button_->hide(); } void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form) @@ -331,24 +356,18 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form) } // Add stacking button - pv::widgets::DecoderMenu *const decoder_menu = - new pv::widgets::DecoderMenu(parent); - connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)), - this, SLOT(on_stack_decoder(srd_decoder*))); - - QPushButton *const stack_button = - new QPushButton(tr("Stack Decoder"), parent); - stack_button->setMenu(decoder_menu); - stack_button->setToolTip(tr("Stack a higher-level decoder on top of this one")); + stack_button_ = new QPushButton(tr("Stack Decoder"), parent); + stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one")); + update_stack_button(); QHBoxLayout *stack_button_box = new QHBoxLayout; - stack_button_box->addWidget(stack_button, 0, Qt::AlignRight); + stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight); form->addRow(stack_button_box); } -QMenu* DecodeTrace::create_context_menu(QWidget *parent) +QMenu* DecodeTrace::create_header_context_menu(QWidget *parent) { - QMenu *const menu = Trace::create_context_menu(parent); + QMenu *const menu = Trace::create_header_context_menu(parent); menu->addSeparator(); @@ -360,14 +379,217 @@ QMenu* DecodeTrace::create_context_menu(QWidget *parent) return menu; } +QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos) +{ + // Get entries from default menu before adding our own + QMenu *const menu = new QMenu(parent); + + QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos); + if (default_menu) { + for (QAction *action : default_menu->actions()) { // clazy:exclude=range-loop + menu->addAction(action); + if (action->parent() == default_menu) + action->setParent(menu); + } + delete default_menu; + + // Add separator if needed + if (menu->actions().length() > 0) + menu->addSeparator(); + } + + selected_row_ = nullptr; + const RowData* r = get_row_at_point(click_pos); + if (r) + selected_row_ = &(r->decode_row); + + const View *const view = owner_->view(); + assert(view); + QPoint pos = view->viewport()->mapFrom(parent, click_pos); + + // Default sample range is "from here" + const pair sample_range = get_view_sample_range(pos.x(), pos.x() + 1); + selected_sample_range_ = make_pair(sample_range.first, numeric_limits::max()); + + if (decode_signal_->is_paused()) { + QAction *const resume = + new QAction(tr("Resume decoding"), this); + resume->setIcon(QIcon::fromTheme("media-playback-start", + QIcon(":/icons/media-playback-start.png"))); + connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode())); + menu->addAction(resume); + } else { + QAction *const pause = + new QAction(tr("Pause decoding"), this); + pause->setIcon(QIcon::fromTheme("media-playback-pause", + QIcon(":/icons/media-playback-pause.png"))); + connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode())); + menu->addAction(pause); + } + + QAction *const copy_annotation_to_clipboard = + new QAction(tr("Copy annotation text to clipboard"), this); + copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste", + QIcon(":/icons/edit-paste.svg"))); + connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard())); + menu->addAction(copy_annotation_to_clipboard); + + menu->addSeparator(); + + QAction *const export_all_rows = + new QAction(tr("Export all annotations"), this); + export_all_rows->setIcon(QIcon::fromTheme("document-save-as", + QIcon(":/icons/document-save-as.png"))); + connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows())); + menu->addAction(export_all_rows); + + QAction *const export_row = + new QAction(tr("Export all annotations for this row"), this); + export_row->setIcon(QIcon::fromTheme("document-save-as", + QIcon(":/icons/document-save-as.png"))); + connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row())); + menu->addAction(export_row); + + menu->addSeparator(); + + QAction *const export_all_rows_from_here = + new QAction(tr("Export all annotations, starting here"), this); + export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as", + QIcon(":/icons/document-save-as.png"))); + connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here())); + menu->addAction(export_all_rows_from_here); + + QAction *const export_row_from_here = + new QAction(tr("Export annotations for this row, starting here"), this); + export_row_from_here->setIcon(QIcon::fromTheme("document-save-as", + QIcon(":/icons/document-save-as.png"))); + connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here())); + menu->addAction(export_row_from_here); + + menu->addSeparator(); + + QAction *const export_all_rows_with_cursor = + new QAction(tr("Export all annotations within cursor range"), this); + export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as", + QIcon(":/icons/document-save-as.png"))); + connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor())); + menu->addAction(export_all_rows_with_cursor); + + QAction *const export_row_with_cursor = + new QAction(tr("Export annotations for this row within cursor range"), this); + export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as", + QIcon(":/icons/document-save-as.png"))); + connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor())); + menu->addAction(export_row_with_cursor); + + if (!view->cursors()->enabled()) { + export_all_rows_with_cursor->setEnabled(false); + export_row_with_cursor->setEnabled(false); + } + + return menu; +} + +void DecodeTrace::delete_pressed() +{ + on_delete(); +} + +void DecodeTrace::hover_point_changed(const QPoint &hp) +{ + Trace::hover_point_changed(hp); + + assert(owner_); + + RowData* hover_row = get_row_at_point(hp); + + // Row expansion marker handling + for (RowData& r : rows_) + r.expand_marker_highlighted = false; + + if (hover_row) { + int row_y = get_row_y(hover_row); + if ((hp.x() > 0) && (hp.x() < 2 * ArrowSize) && + (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize))) + hover_row->expand_marker_highlighted = true; + } + + // Tooltip handling + if (hp.x() > 0) { + QString ann = get_annotation_at_point(hp); + + if (!ann.isEmpty()) { + QFontMetrics m(QToolTip::font()); + const QRect text_size = m.boundingRect(QRect(), 0, ann); + + // This is OS-specific and unfortunately we can't query it, so + // use an approximation to at least try to minimize the error. + const int padding = default_row_height_ + 8; + + // Make sure the tool tip doesn't overlap with the mouse cursor. + // 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. + QPoint p = hp; + p.setX(hp.x() - (text_size.width() / 2) - padding); + + p.setY(get_row_y(hover_row) - default_row_height_ - + text_size.height() - padding); + + const View *const view = owner_->view(); + assert(view); + QToolTip::showText(view->viewport()->mapToGlobal(p), ann); + + } else + QToolTip::hideText(); + + } else + QToolTip::hideText(); +} + +void DecodeTrace::mouse_left_press_event(const QMouseEvent* event) +{ + // Handle row expansion marker + for (RowData& r : rows_) { + if (!r.expand_marker_highlighted) + continue; + + unsigned int y = get_row_y(&r); + if ((event->x() > 0) && (event->x() <= (int)(ArrowSize + 3)) && + (event->y() > (int)(y - (default_row_height_ / 2))) && + (event->y() <= (int)(y + (default_row_height_ / 2)))) { + + if (r.expanded) { + r.collapsing = true; + r.expanded = false; + r.anim_shape = ArrowSize; + } else { + r.expanding = true; + r.anim_shape = 0; + } + + r.animation_step = 0; + r.anim_height = r.height; + animation_timer_.start(); + } + } +} + void DecodeTrace::draw_annotations(vector 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; - vector a_block; - int p_end = INT_MIN; + Annotation::Class block_class = 0; + bool block_class_uniform = true; + qreal block_start = 0; + int block_ann_count = 0; + + const Annotation *prev_ann; + qreal prev_end = INT_MIN; + + qreal a_end; double samples_per_pixel, pixels_offset; tie(pixels_offset, samples_per_pixel) = @@ -382,18 +604,21 @@ void DecodeTrace::draw_annotations(vector annotati // Gather all annotations that form a visual "block" and draw them as such for (const Annotation &a : annotations) { - const int a_start = a.start_sample() / samples_per_pixel - pixels_offset; - const int a_end = a.end_sample() / samples_per_pixel - pixels_offset; - const int a_width = a_end - a_start; + const qreal abs_a_start = a.start_sample() / samples_per_pixel; + const qreal abs_a_end = a.end_sample() / samples_per_pixel; + + const qreal a_start = abs_a_start - pixels_offset; + a_end = abs_a_end - pixels_offset; - const int delta = a_end - p_end; + const qreal a_width = a_end - a_start; + const qreal delta = a_end - prev_end; bool a_is_separate = false; // Annotation wider than the threshold for a useful label width? if (a_width >= min_useful_label_width_) { for (const QString &ann_text : a.annotations()) { - const int w = p.boundingRect(QRectF(), 0, ann_text).width(); + const qreal w = p.boundingRect(QRectF(), 0, ann_text).width(); // Annotation wide enough to fit a label? Don't put it in a block then if (w <= a_width) { a_is_separate = true; @@ -405,38 +630,49 @@ void DecodeTrace::draw_annotations(vector annotati // Were the previous and this annotation more than a pixel apart? 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, + if (block_ann_count == 1) + draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width); - } - else - draw_annotation_block(a_block, p, h, y, base_colour); + else if (block_ann_count > 0) + draw_annotation_block(block_start, prev_end, block_class, + block_class_uniform, p, h, y, row_color); - a_block.clear(); + block_ann_count = 0; } 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 - p_end = INT_MIN; + // because we set prev_end to INT_MIN but that's okay since + // block_ann_count will be 0 and nothing will be drawn + prev_end = INT_MIN; + block_ann_count = 0; } else { - a_block.push_back(a); - p_end = a_end; + prev_end = a_end; + prev_ann = &a; + + if (block_ann_count == 0) { + block_start = a_start; + block_class = a.ann_class(); + block_class_uniform = true; + } else + if (a.ann_class() != block_class) + block_class_uniform = false; + + block_ann_count++; } } - if (a_block.size() == 1) - draw_annotation(a_block.front(), p, h, pp, y, base_colour, - row_title_width); - else - draw_annotation_block(a_block, p, h, y, base_colour); + if (block_ann_count == 1) + draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width); + else if (block_ann_count > 0) + draw_annotation_block(block_start, prev_end, block_class, + block_class_uniform, 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) = @@ -446,9 +682,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; @@ -459,37 +695,13 @@ void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a, draw_range(a, p, h, start, end, y, pp, row_title_width); } -void DecodeTrace::draw_annotation_block( - vector annotations, QPainter &p, int h, - int y, size_t base_colour) const +void DecodeTrace::draw_annotation_block(qreal start, qreal end, + Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h, + int y, QColor row_color) const { - using namespace pv::data::decode; - - if (annotations.empty()) - return; - - double samples_per_pixel, pixels_offset; - tie(pixels_offset, samples_per_pixel) = - get_pixels_offset_samples_per_pixel(); - - const double start = annotations.front().start_sample() / - samples_per_pixel - pixels_offset; - const double end = annotations.back().end_sample() / - samples_per_pixel - pixels_offset; - 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); - - // 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( - annotations.begin(), annotations.end(), - [&](const Annotation &a) { return a.format() == format; }); - const QRectF rect(start, top, end - start, bottom - top); const int r = h / 4; @@ -497,18 +709,27 @@ 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)); + // If all annotations in this block are of the same type, we can use the + // one format that all of these annotations have. Otherwise, we should use + // a neutral color (i.e. gray) + if (use_ann_format) { + const QColor color = get_annotation_color(row_color, ann_class); + p.setPen(color.darker()); + p.setBrush(QBrush(color, Qt::Dense4Pattern)); + } else { + p.setPen(Qt::gray); + p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern)); + } + p.drawRoundedRect(rect, r, r); } void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p, - int h, double x, int y) const + int h, qreal x, int y) const { const QString text = a.annotations().empty() ? QString() : a.annotations().back(); - const double w = min((double)p.boundingRect(QRectF(), 0, text).width(), + const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(), 0.0) + h; const QRectF rect(x - w / 2, y - h / 2, w, h); @@ -519,11 +740,11 @@ void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter & } void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p, - int h, double start, double end, int y, const ViewItemPaintParams &pp, + int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp, int row_title_width) const { - const double top = y + .5 - h / 2; - const double bottom = y + .5 + h / 2; + const qreal top = y + .5 - h / 2; + const qreal bottom = y + .5 + h / 2; const vector annotations = a.annotations(); // If the two ends are within 1 pixel, draw a vertical line @@ -532,7 +753,7 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p, return; } - const double cap_width = min((end - start) / 4, EndCapWidth); + const qreal cap_width = min((end - start) / 4, EndCapWidth); QPointF pts[] = { QPointF(start, y + .5f), @@ -551,7 +772,7 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p, const int ann_start = start + cap_width; const int ann_end = end - cap_width; - const int real_start = max(ann_start, pp.left() + row_title_width); + const int real_start = max(ann_start, pp.left() + ArrowSize + row_title_width); const int real_end = min(ann_end, pp.right()); const int real_width = real_end - real_start; @@ -584,17 +805,18 @@ void DecodeTrace::draw_error(QPainter &p, const QString &message, { const int y = get_visual_y(); - p.setPen(ErrorBgColour.darker()); - p.setBrush(ErrorBgColour); + double samples_per_pixel, pixels_offset; + tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel(); - const QRectF bounding_rect = - 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; + p.setPen(ErrorBgColor.darker()); + p.setBrush(ErrorBgColor); - p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, - Qt::AbsoluteSize); + const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX); + + const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message); + const qreal r = text_rect.height() / 4; + + p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize); p.setPen(Qt::black); p.drawText(text_rect, message); @@ -611,7 +833,7 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right if (sample_count == 0) return; - const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_); + const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true); if (sample_count == samples_decoded) return; @@ -623,14 +845,14 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right samples_per_pixel - pixels_offset, left - 1.0); const double end = min(sample_count / samples_per_pixel - pixels_offset, right + 1.0); - const QRectF no_decode_rect(start, y - (h / 2) + 0.5, end - start, h); + const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h); p.setPen(QPen(Qt::NoPen)); 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); } @@ -656,7 +878,7 @@ pair DecodeTrace::get_pixels_offset_samples_per_pixel() const return make_pair(pixels_offset, samplerate * scale); } -pair DecodeTrace::get_sample_range( +pair DecodeTrace::get_view_sample_range( int x_start, int x_end) const { double samples_per_pixel, pixels_offset; @@ -671,89 +893,94 @@ pair DecodeTrace::get_sample_range( return make_pair(start, end); } -int DecodeTrace::get_row_at_point(const QPoint &point) +QColor DecodeTrace::get_row_color(int row_index) const { - if (!row_height_) - return -1; + // For each row color, use the base color hue and add an offset that's + // not a dividend of 360 - const int y = (point.y() - get_visual_y() + row_height_ / 2); + 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); - /* Integer divison of (x-1)/x would yield 0, so we check for this. */ - if (y < 0) - return -1; + return color; +} - const int row = y / row_height_; +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 - if (row >= (int)visible_rows_.size()) - return -1; + 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 row; + return color; } -const QString DecodeTrace::get_annotation_at_point(const QPoint &point) +unsigned int DecodeTrace::get_row_y(const RowData* row) const { - using namespace pv::data::decode; + assert(row); - if (!enabled()) - return QString(); + unsigned int y = get_visual_y(); - const pair sample_range = - get_sample_range(point.x(), point.x() + 1); - const int row = get_row_at_point(point); - if (row < 0) - return QString(); - - vector annotations; + for (const RowData& r : rows_) { + if (!r.currently_visible) + continue; - decode_signal_->get_annotation_subset(annotations, visible_rows_[row], - sample_range.first, sample_range.second); + if (row->decode_row == r.decode_row) + break; + else + y += r.height; + } - return (annotations.empty()) ? - QString() : annotations[0].annotations().front(); + return y; } -void DecodeTrace::hover_point_changed(const QPoint &hp) +RowData* DecodeTrace::get_row_at_point(const QPoint &point) { - assert(owner_); + int y = get_visual_y() - (default_row_height_ / 2); - const View *const view = owner_->view(); - assert(view); + for (RowData& r : rows_) { + if (!r.currently_visible) + continue; - if (hp.x() == 0) { - QToolTip::hideText(); - return; + if ((point.y() >= y) && (point.y() < (int)(y + r.height))) + return &r; + + y += r.height; } - QString ann = get_annotation_at_point(hp); + return nullptr; +} - assert(view); +const QString DecodeTrace::get_annotation_at_point(const QPoint &point) +{ + using namespace pv::data::decode; - if (!row_height_ || ann.isEmpty()) { - QToolTip::hideText(); - return; - } + if (!enabled()) + return QString(); - const int hover_row = get_row_at_point(hp); + const pair sample_range = + get_view_sample_range(point.x(), point.x() + 1); + const RowData* r = get_row_at_point(point); - QFontMetrics m(QToolTip::font()); - const QRect text_size = m.boundingRect(QRect(), 0, ann); + if (!r) + return QString(); - // This is OS-specific and unfortunately we can't query it, so - // use an approximation to at least try to minimize the error. - const int padding = 8; + if (point.y() > (int)(get_row_y(r) + (annotation_height_ / 2))) + return QString(); - // Make sure the tool tip doesn't overlap with the mouse cursor. - // 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. - QPoint p = hp; - p.setX(hp.x() - (text_size.width() / 2) - padding); + vector annotations; - p.setY(get_visual_y() - (row_height_ / 2) + - (hover_row * row_height_) - - row_height_ - text_size.height() - padding); + decode_signal_->get_annotation_subset(annotations, r->decode_row, + current_segment_, sample_range.first, sample_range.second); - QToolTip::showText(view->viewport()->mapToGlobal(p), ann); + return (annotations.empty()) ? + QString() : annotations[0].annotations().front(); } void DecodeTrace::create_decoder_form(int index, @@ -791,7 +1018,7 @@ void DecodeTrace::create_decoder_form(int index, const vector channels = decode_signal_->get_channels(); // Add the channels - for (DecodeChannel ch : channels) { + for (const DecodeChannel& ch : channels) { // Ignore channels not part of the decoder we create the form for if (ch.decoder_ != dec) continue; @@ -879,6 +1106,124 @@ QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent, return selector; } +void DecodeTrace::export_annotations(vector *annotations) const +{ + using namespace pv::data::decode; + + GlobalSettings settings; + const QString dir = settings.value("MainWindow/SaveDirectory").toString(); + + const QString file_name = QFileDialog::getSaveFileName( + owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)")); + + if (file_name.isEmpty()) + return; + + QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString(); + const QString quote = format.contains("%q") ? "\"" : ""; + format = format.remove("%q"); + + QFile file(file_name); + if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) { + QTextStream out_stream(&file); + + for (Annotation &ann : *annotations) { + const QString sample_range = QString("%1-%2") \ + .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample())); + + const QString class_name = quote + ann.row()->class_name() + quote; + + QString all_ann_text; + for (const QString &s : ann.annotations()) + all_ann_text = all_ann_text + quote + s + quote + ","; + all_ann_text.chop(1); + + const QString first_ann_text = quote + ann.annotations().front() + quote; + + QString out_text = format; + out_text = out_text.replace("%s", sample_range); + out_text = out_text.replace("%d", + quote + QString::fromUtf8(ann.row()->decoder()->name()) + quote); + out_text = out_text.replace("%c", class_name); + out_text = out_text.replace("%1", first_ann_text); + out_text = out_text.replace("%a", all_ann_text); + out_stream << out_text << '\n'; + } + + if (out_stream.status() == QTextStream::Ok) + return; + } + + QMessageBox msg(owner_->view()); + msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name)); + msg.setStandardButtons(QMessageBox::Ok); + msg.setIcon(QMessageBox::Warning); + msg.exec(); +} + +void DecodeTrace::update_rows() +{ + lock_guard lock(row_modification_mutex_); + + QFontMetrics m(QApplication::font()); + + for (RowData& r : rows_) + r.exists = false; + + for (const Row& decode_row : decode_signal_->get_rows()) { + // Find row in our list + auto r_it = find_if(rows_.begin(), rows_.end(), + [&](RowData& r){ return r.decode_row == decode_row; }); + + RowData* r = nullptr; + if (r_it == rows_.end()) { + // Row doesn't exist yet, create and append it + RowData nr; + nr.decode_row = decode_row; + nr.height = default_row_height_; + nr.expanded_height = 5*default_row_height_; + nr.currently_visible = false; + nr.expand_marker_highlighted = false; + nr.expanding = false; + nr.expanded = false; + nr.collapsing = false; + nr.expand_marker_shape = default_marker_shape_; + + rows_.push_back(nr); + r = &rows_.back(); + } else + r = &(*r_it); + + r->exists = true; + + const int w = m.boundingRect(r->decode_row.title()).width() + RowTitleMargin; + r->title_width = w; + } + + // Remove any rows that no longer exist, obeying that iterators are invalidated + bool any_exists; + do { + any_exists = false; + + for (unsigned int i = 0; i < rows_.size(); i++) + if (!rows_[i].exists) { + rows_.erase(rows_.begin() + i); + any_exists = true; + break; + } + } while (any_exists); +} + +void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value) +{ + Trace::on_setting_changed(key, value); + + if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) { + max_visible_rows_ = 0; + always_show_all_rows_ = value.toBool(); + } +} + void DecodeTrace::on_new_annotations() { if (!delayed_trace_updater_.isActive()) @@ -893,8 +1238,8 @@ void DecodeTrace::on_delayed_trace_update() void DecodeTrace::on_decode_reset() { - visible_rows_.clear(); max_visible_rows_ = 0; + update_rows(); if (owner_) owner_->row_item_appearance_changed(false, true); @@ -906,9 +1251,12 @@ void DecodeTrace::on_decode_finished() owner_->row_item_appearance_changed(false, true); } -void DecodeTrace::delete_pressed() +void DecodeTrace::on_pause_decode() { - on_delete(); + if (decode_signal_->is_paused()) + decode_signal_->resume_decode(); + else + decode_signal_->pause_decode(); } void DecodeTrace::on_delete() @@ -952,6 +1300,7 @@ void DecodeTrace::on_init_state_changed(int) void DecodeTrace::on_stack_decoder(srd_decoder *decoder) { decode_signal_->stack_decoder(decoder); + update_rows(); create_popup_form(); } @@ -959,12 +1308,12 @@ void DecodeTrace::on_stack_decoder(srd_decoder *decoder) void DecodeTrace::on_delete_decoder(int index) { decode_signal_->remove_decoder(index); + update_rows(); - // Force re-calculation of the trace height, see paint_mid() + // Force re-calculation of the trace height max_visible_rows_ = 0; owner_->extents_changed(false, true); - // Update the popup create_popup_form(); } @@ -985,6 +1334,181 @@ void DecodeTrace::on_show_hide_decoder(int index) owner_->row_item_appearance_changed(false, true); } +void DecodeTrace::on_copy_annotation_to_clipboard() +{ + using namespace pv::data::decode; + + if (!selected_row_) + return; + + vector *annotations = new vector(); + + decode_signal_->get_annotation_subset(*annotations, *selected_row_, + current_segment_, selected_sample_range_.first, selected_sample_range_.first); + + if (annotations->empty()) + return; + + QClipboard *clipboard = QApplication::clipboard(); + clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard); + + if (clipboard->supportsSelection()) + clipboard->setText(annotations->front().annotations().front(), QClipboard::Selection); + + delete annotations; +} + +void DecodeTrace::on_export_row() +{ + selected_sample_range_ = make_pair(0, numeric_limits::max()); + on_export_row_from_here(); +} + +void DecodeTrace::on_export_all_rows() +{ + selected_sample_range_ = make_pair(0, numeric_limits::max()); + on_export_all_rows_from_here(); +} + +void DecodeTrace::on_export_row_with_cursor() +{ + const View *view = owner_->view(); + assert(view); + + if (!view->cursors()->enabled()) + return; + + const double samplerate = session_.get_samplerate(); + + const pv::util::Timestamp& start_time = view->cursors()->first()->time(); + const pv::util::Timestamp& end_time = view->cursors()->second()->time(); + + const uint64_t start_sample = (uint64_t)max( + 0.0, start_time.convert_to() * samplerate); + const uint64_t end_sample = (uint64_t)max( + 0.0, end_time.convert_to() * samplerate); + + // Are both cursors negative and thus were clamped to 0? + if ((start_sample == 0) && (end_sample == 0)) + return; + + selected_sample_range_ = make_pair(start_sample, end_sample); + on_export_row_from_here(); +} + +void DecodeTrace::on_export_all_rows_with_cursor() +{ + const View *view = owner_->view(); + assert(view); + + if (!view->cursors()->enabled()) + return; + + const double samplerate = session_.get_samplerate(); + + const pv::util::Timestamp& start_time = view->cursors()->first()->time(); + const pv::util::Timestamp& end_time = view->cursors()->second()->time(); + + const uint64_t start_sample = (uint64_t)max( + 0.0, start_time.convert_to() * samplerate); + const uint64_t end_sample = (uint64_t)max( + 0.0, end_time.convert_to() * samplerate); + + // Are both cursors negative and thus were clamped to 0? + if ((start_sample == 0) && (end_sample == 0)) + return; + + selected_sample_range_ = make_pair(start_sample, end_sample); + on_export_all_rows_from_here(); +} + +void DecodeTrace::on_export_row_from_here() +{ + using namespace pv::data::decode; + + if (!selected_row_) + return; + + vector *annotations = new vector(); + + decode_signal_->get_annotation_subset(*annotations, *selected_row_, + current_segment_, selected_sample_range_.first, selected_sample_range_.second); + + if (annotations->empty()) + return; + + export_annotations(annotations); + delete annotations; +} + +void DecodeTrace::on_export_all_rows_from_here() +{ + using namespace pv::data::decode; + + vector *annotations = new vector(); + + decode_signal_->get_annotation_subset(*annotations, current_segment_, + selected_sample_range_.first, selected_sample_range_.second); + + if (!annotations->empty()) + export_annotations(annotations); + + delete annotations; +} + +void DecodeTrace::on_animation_timer() +{ + bool animation_finished = true; + + for (RowData& r : rows_) { + if (!(r.expanding || r.collapsing)) + continue; + + unsigned int height_delta = r.expanded_height - default_row_height_; + + if (r.expanding) { + if (r.height < r.expanded_height) { + r.anim_height += height_delta / (float)AnimationDurationInTicks; + r.height = r.anim_height; + r.anim_shape += ArrowSize / (float)AnimationDurationInTicks; + animation_finished = false; + } else { + r.height = std::min(r.height, r.expanded_height); + r.expanding = false; + r.expanded = true; + } + } + + if (r.collapsing) { + if (r.height > default_row_height_) { + r.anim_height -= height_delta / (float)AnimationDurationInTicks; + r.height = r.anim_height; + r.anim_shape -= ArrowSize / (float)AnimationDurationInTicks; + animation_finished = false; + } else { + r.height = std::max(r.height, default_row_height_); + r.collapsing = false; + r.expanded = false; + r.expand_marker_shape = default_marker_shape_; + } + } + + // The expansion marker shape switches between + // 0/-A, A/0, 0/A (default state; anim_shape=0) and + // 0/ 0, A/A, 2A/0 (expanded state; anim_shape=ArrowSize) + + r.expand_marker_shape.setPoint(0, 0, -ArrowSize + r.anim_shape); + r.expand_marker_shape.setPoint(1, ArrowSize, r.anim_shape); + r.expand_marker_shape.setPoint(2, 2*r.anim_shape, ArrowSize - r.anim_shape); + } + + if (animation_finished) + animation_timer_.stop(); + + if (owner_) + owner_->row_item_appearance_changed(false, true); +} + } // namespace trace } // namespace views } // namespace pv