2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <libsigrokdecode/libsigrokdecode.h>
30 #include <boost/functional/hash.hpp>
33 #include <QApplication>
36 #include <QFileDialog>
37 #include <QFormLayout>
40 #include <QMessageBox>
41 #include <QPushButton>
42 #include <QTextStream>
45 #include "decodetrace.hpp"
47 #include "viewport.hpp"
49 #include <pv/globalsettings.hpp>
50 #include <pv/session.hpp>
51 #include <pv/strnatcmp.hpp>
52 #include <pv/data/decodesignal.hpp>
53 #include <pv/data/decode/annotation.hpp>
54 #include <pv/data/decode/decoder.hpp>
55 #include <pv/data/logic.hpp>
56 #include <pv/data/logicsegment.hpp>
57 #include <pv/widgets/decodergroupbox.hpp>
58 #include <pv/widgets/decodermenu.hpp>
62 using std::lock_guard;
66 using std::numeric_limits;
67 using std::out_of_range;
69 using std::shared_ptr;
73 using pv::data::decode::Annotation;
74 using pv::data::decode::Row;
75 using pv::data::decode::DecodeChannel;
76 using pv::data::DecodeSignal;
83 #define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
84 #define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
86 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
87 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
89 const int DecodeTrace::ArrowSize = 7;
90 const double DecodeTrace::EndCapWidth = 5;
91 const int DecodeTrace::RowTitleMargin = 10;
92 const int DecodeTrace::DrawPadding = 100;
94 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
96 DecodeTrace::DecodeTrace(pv::Session &session,
97 shared_ptr<data::SignalBase> signalbase, int index) :
100 max_visible_rows_(0),
101 delete_mapper_(this),
102 show_hide_mapper_(this)
104 decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
106 GlobalSettings settings;
107 always_show_all_rows_ = settings.value(GlobalSettings::Key_Dec_AlwaysShowAllRows).toBool();
109 GlobalSettings::add_change_handler(this);
111 // Determine shortest string we want to see displayed in full
112 QFontMetrics m(QApplication::font());
113 min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
115 default_row_height_ = (ViewItemPaintParams::text_height() * 6) / 4;
116 annotation_height_ = (ViewItemPaintParams::text_height() * 5) / 4;
118 // For the base color, we want to start at a very different color for
119 // every decoder stack, so multiply the index with a number that is
120 // rather close to 180 degrees of the color circle but not a dividend of 360
121 // Note: The offset equals the color of the first annotation
123 const int h = (120 + 160 * index) % 360;
124 const int s = DECODETRACE_COLOR_SATURATION;
125 const int v = DECODETRACE_COLOR_VALUE;
126 color.setHsv(h, s, v);
127 base_->set_color(color);
129 connect(decode_signal_.get(), SIGNAL(new_annotations()),
130 this, SLOT(on_new_annotations()));
131 connect(decode_signal_.get(), SIGNAL(decode_reset()),
132 this, SLOT(on_decode_reset()));
133 connect(decode_signal_.get(), SIGNAL(decode_finished()),
134 this, SLOT(on_decode_finished()));
135 connect(decode_signal_.get(), SIGNAL(channels_updated()),
136 this, SLOT(on_channels_updated()));
138 connect(&delete_mapper_, SIGNAL(mapped(int)),
139 this, SLOT(on_delete_decoder(int)));
140 connect(&show_hide_mapper_, SIGNAL(mapped(int)),
141 this, SLOT(on_show_hide_decoder(int)));
143 connect(&delayed_trace_updater_, SIGNAL(timeout()),
144 this, SLOT(on_delayed_trace_update()));
145 delayed_trace_updater_.setSingleShot(true);
146 delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
149 DecodeTrace::~DecodeTrace()
151 GlobalSettings::remove_change_handler(this);
154 bool DecodeTrace::enabled() const
159 shared_ptr<data::SignalBase> DecodeTrace::base() const
164 pair<int, int> DecodeTrace::v_extents() const
166 // Make an empty decode trace appear symmetrical
167 if (max_visible_rows_ == 0)
168 return make_pair(-default_row_height_, default_row_height_);
170 unsigned int height = 0;
171 for (const RowData& r : rows_)
172 if (r.currently_visible)
175 return make_pair(-default_row_height_, height);
178 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
180 Trace::paint_back(p, pp);
181 paint_axis(p, pp, get_visual_y());
184 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
186 lock_guard<mutex> lock(row_modification_mutex_);
188 // Set default pen to allow for text width calculation
191 pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pp.left(), pp.right());
193 // Just because the view says we see a certain sample range it
194 // doesn't mean we have this many decoded samples, too, so crop
195 // the range to what has been decoded already
196 sample_range.second = min((int64_t)sample_range.second,
197 decode_signal_->get_decoded_sample_count(current_segment_, false));
199 for (RowData& r : rows_)
200 r.currently_visible = false;
202 int y = get_visual_y();
204 for (RowData& r : rows_) {
205 // If an entire decoder is hidden, we don't want to fetch annotations
206 if (!r.decode_row.decoder()->shown()) {
207 r.currently_visible = false;
211 vector<Annotation> annotations;
212 decode_signal_->get_annotation_subset(annotations, r.decode_row,
213 current_segment_, sample_range.first, sample_range.second);
215 // Show row if there are visible annotations or when user wants to see
216 // all rows that have annotations somewhere and this one is one of them
217 size_t ann_count = decode_signal_->get_annotation_count(r.decode_row, current_segment_);
218 r.currently_visible = !annotations.empty() || (always_show_all_rows_ && (ann_count > 0));
220 if (r.currently_visible) {
221 draw_annotations(annotations, p, annotation_height_, pp, y,
222 get_row_color(r.decode_row.index()), r.title_width);
228 draw_unresolved_period(p, annotation_height_, pp.left(), pp.right());
230 if (visible_rows_ > max_visible_rows_) {
231 max_visible_rows_ = visible_rows_;
233 // Call order is important, otherwise the lazy event handler won't work
234 owner_->extents_changed(false, true);
235 owner_->row_item_appearance_changed(false, true);
238 const QString err = decode_signal_->error_message();
240 draw_error(p, err, pp);
243 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
245 unsigned int y = get_visual_y();
247 for (const RowData& r : rows_) {
248 if (!r.currently_visible)
251 p.setPen(QPen(Qt::NoPen));
253 if (r.expand_marker_highlighted)
254 p.setBrush(QApplication::palette().brush(QPalette::HighlightedText));
256 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
258 // Draw expansion marker
259 const QPointF points[] = {
260 QPointF(pp.left(), y - ArrowSize),
261 QPointF(pp.left() + ArrowSize, y),
262 QPointF(pp.left(), y + ArrowSize)
264 p.drawPolygon(points, countof(points));
266 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
268 const QRect text_rect(pp.left() + ArrowSize * 2, y - r.height / 2,
269 pp.right() - pp.left(), r.height);
270 const QString h(r.decode_row.title());
271 const int f = Qt::AlignLeft | Qt::AlignVCenter |
275 p.setPen(QApplication::palette().color(QPalette::Base));
276 for (int dx = -1; dx <= 1; dx++)
277 for (int dy = -1; dy <= 1; dy++)
278 if (dx != 0 && dy != 0)
279 p.drawText(text_rect.translated(dx, dy), f, h);
282 p.setPen(QApplication::palette().color(QPalette::WindowText));
283 p.drawText(text_rect, f, h);
288 if (show_hover_marker_)
289 paint_hover_marker(p);
292 void DecodeTrace::update_stack_button()
294 const vector< shared_ptr<data::decode::Decoder> > &stack = decode_signal_->decoder_stack();
296 // Only show decoders in the menu that can be stacked onto the last one in the stack
297 if (!stack.empty()) {
298 const srd_decoder* d = stack.back()->decoder();
301 pv::widgets::DecoderMenu *const decoder_menu =
302 new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data));
303 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
304 this, SLOT(on_stack_decoder(srd_decoder*)));
306 decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }");
308 stack_button_->setMenu(decoder_menu);
309 stack_button_->show();
314 // No decoders available for stacking
315 stack_button_->setMenu(nullptr);
316 stack_button_->hide();
319 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
321 using pv::data::decode::Decoder;
325 // Add the standard options
326 Trace::populate_popup_form(parent, form);
328 // Add the decoder options
330 channel_id_map_.clear();
331 init_state_map_.clear();
332 decoder_forms_.clear();
334 const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
337 QLabel *const l = new QLabel(
338 tr("<p><i>No decoders in the stack</i></p>"));
339 l->setAlignment(Qt::AlignCenter);
342 auto iter = stack.cbegin();
343 for (int i = 0; i < (int)stack.size(); i++, iter++) {
344 shared_ptr<Decoder> dec(*iter);
345 create_decoder_form(i, dec, parent, form);
348 form->addRow(new QLabel(
349 tr("<i>* Required channels</i>"), parent));
352 // Add stacking button
353 stack_button_ = new QPushButton(tr("Stack Decoder"), parent);
354 stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one"));
355 update_stack_button();
357 QHBoxLayout *stack_button_box = new QHBoxLayout;
358 stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight);
359 form->addRow(stack_button_box);
362 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
364 QMenu *const menu = Trace::create_header_context_menu(parent);
366 menu->addSeparator();
368 QAction *const del = new QAction(tr("Delete"), this);
369 del->setShortcuts(QKeySequence::Delete);
370 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
371 menu->addAction(del);
376 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
378 // Get entries from default menu before adding our own
379 QMenu *const menu = new QMenu(parent);
381 QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
383 for (QAction *action : default_menu->actions()) { // clazy:exclude=range-loop
384 menu->addAction(action);
385 if (action->parent() == default_menu)
386 action->setParent(menu);
390 // Add separator if needed
391 if (menu->actions().length() > 0)
392 menu->addSeparator();
395 selected_row_ = nullptr;
396 const RowData* r = get_row_at_point(click_pos);
398 selected_row_ = &(r->decode_row);
400 const View *const view = owner_->view();
402 QPoint pos = view->viewport()->mapFrom(parent, click_pos);
404 // Default sample range is "from here"
405 const pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pos.x(), pos.x() + 1);
406 selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
408 if (decode_signal_->is_paused()) {
409 QAction *const resume =
410 new QAction(tr("Resume decoding"), this);
411 resume->setIcon(QIcon::fromTheme("media-playback-start",
412 QIcon(":/icons/media-playback-start.png")));
413 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
414 menu->addAction(resume);
416 QAction *const pause =
417 new QAction(tr("Pause decoding"), this);
418 pause->setIcon(QIcon::fromTheme("media-playback-pause",
419 QIcon(":/icons/media-playback-pause.png")));
420 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
421 menu->addAction(pause);
424 QAction *const copy_annotation_to_clipboard =
425 new QAction(tr("Copy annotation text to clipboard"), this);
426 copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste",
427 QIcon(":/icons/edit-paste.svg")));
428 connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard()));
429 menu->addAction(copy_annotation_to_clipboard);
431 menu->addSeparator();
433 QAction *const export_all_rows =
434 new QAction(tr("Export all annotations"), this);
435 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
436 QIcon(":/icons/document-save-as.png")));
437 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
438 menu->addAction(export_all_rows);
440 QAction *const export_row =
441 new QAction(tr("Export all annotations for this row"), this);
442 export_row->setIcon(QIcon::fromTheme("document-save-as",
443 QIcon(":/icons/document-save-as.png")));
444 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
445 menu->addAction(export_row);
447 menu->addSeparator();
449 QAction *const export_all_rows_from_here =
450 new QAction(tr("Export all annotations, starting here"), this);
451 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
452 QIcon(":/icons/document-save-as.png")));
453 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
454 menu->addAction(export_all_rows_from_here);
456 QAction *const export_row_from_here =
457 new QAction(tr("Export annotations for this row, starting here"), this);
458 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
459 QIcon(":/icons/document-save-as.png")));
460 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
461 menu->addAction(export_row_from_here);
463 menu->addSeparator();
465 QAction *const export_all_rows_with_cursor =
466 new QAction(tr("Export all annotations within cursor range"), this);
467 export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
468 QIcon(":/icons/document-save-as.png")));
469 connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
470 menu->addAction(export_all_rows_with_cursor);
472 QAction *const export_row_with_cursor =
473 new QAction(tr("Export annotations for this row within cursor range"), this);
474 export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
475 QIcon(":/icons/document-save-as.png")));
476 connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
477 menu->addAction(export_row_with_cursor);
479 if (!view->cursors()->enabled()) {
480 export_all_rows_with_cursor->setEnabled(false);
481 export_row_with_cursor->setEnabled(false);
487 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
488 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
489 QColor row_color, int row_title_width)
491 using namespace pv::data::decode;
493 Annotation::Class block_class = 0;
494 bool block_class_uniform = true;
495 qreal block_start = 0;
496 int block_ann_count = 0;
498 const Annotation *prev_ann;
499 qreal prev_end = INT_MIN;
503 double samples_per_pixel, pixels_offset;
504 tie(pixels_offset, samples_per_pixel) =
505 get_pixels_offset_samples_per_pixel();
507 // Sort the annotations by start sample so that decoders
508 // can't confuse us by creating annotations out of order
509 stable_sort(annotations.begin(), annotations.end(),
510 [](const Annotation &a, const Annotation &b) {
511 return a.start_sample() < b.start_sample(); });
513 // Gather all annotations that form a visual "block" and draw them as such
514 for (const Annotation &a : annotations) {
516 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
517 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
519 const qreal a_start = abs_a_start - pixels_offset;
520 a_end = abs_a_end - pixels_offset;
522 const qreal a_width = a_end - a_start;
523 const qreal delta = a_end - prev_end;
525 bool a_is_separate = false;
527 // Annotation wider than the threshold for a useful label width?
528 if (a_width >= min_useful_label_width_) {
529 for (const QString &ann_text : a.annotations()) {
530 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
531 // Annotation wide enough to fit a label? Don't put it in a block then
533 a_is_separate = true;
539 // Were the previous and this annotation more than a pixel apart?
540 if ((abs(delta) > 1) || a_is_separate) {
541 // Block was broken, draw annotations that form the current block
542 if (block_ann_count == 1)
543 draw_annotation(*prev_ann, p, h, pp, y, row_color,
545 else if (block_ann_count > 0)
546 draw_annotation_block(block_start, prev_end, block_class,
547 block_class_uniform, p, h, y, row_color);
553 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
554 // Next annotation must start a new block. delta will be > 1
555 // because we set prev_end to INT_MIN but that's okay since
556 // block_ann_count will be 0 and nothing will be drawn
563 if (block_ann_count == 0) {
564 block_start = a_start;
565 block_class = a.ann_class();
566 block_class_uniform = true;
568 if (a.ann_class() != block_class)
569 block_class_uniform = false;
575 if (block_ann_count == 1)
576 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
577 else if (block_ann_count > 0)
578 draw_annotation_block(block_start, prev_end, block_class,
579 block_class_uniform, p, h, y, row_color);
582 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
583 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
584 QColor row_color, int row_title_width) const
586 double samples_per_pixel, pixels_offset;
587 tie(pixels_offset, samples_per_pixel) =
588 get_pixels_offset_samples_per_pixel();
590 const double start = a.start_sample() / samples_per_pixel -
592 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
594 QColor color = get_annotation_color(row_color, a.ann_class());
595 p.setPen(color.darker());
598 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
601 if (a.start_sample() == a.end_sample())
602 draw_instant(a, p, h, start, y);
604 draw_range(a, p, h, start, end, y, pp, row_title_width);
607 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
608 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
609 int y, QColor row_color) const
611 const double top = y + .5 - h / 2;
612 const double bottom = y + .5 + h / 2;
614 const QRectF rect(start, top, end - start, bottom - top);
617 p.setPen(QPen(Qt::NoPen));
618 p.setBrush(Qt::white);
619 p.drawRoundedRect(rect, r, r);
621 // If all annotations in this block are of the same type, we can use the
622 // one format that all of these annotations have. Otherwise, we should use
623 // a neutral color (i.e. gray)
624 if (use_ann_format) {
625 const QColor color = get_annotation_color(row_color, ann_class);
626 p.setPen(color.darker());
627 p.setBrush(QBrush(color, Qt::Dense4Pattern));
630 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
633 p.drawRoundedRect(rect, r, r);
636 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
637 int h, qreal x, int y) const
639 const QString text = a.annotations().empty() ?
640 QString() : a.annotations().back();
641 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
643 const QRectF rect(x - w / 2, y - h / 2, w, h);
645 p.drawRoundedRect(rect, h / 2, h / 2);
648 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
651 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
652 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
653 int row_title_width) const
655 const qreal top = y + .5 - h / 2;
656 const qreal bottom = y + .5 + h / 2;
657 const vector<QString> annotations = a.annotations();
659 // If the two ends are within 1 pixel, draw a vertical line
660 if (start + 1.0 > end) {
661 p.drawLine(QPointF(start, top), QPointF(start, bottom));
665 const qreal cap_width = min((end - start) / 4, EndCapWidth);
668 QPointF(start, y + .5f),
669 QPointF(start + cap_width, top),
670 QPointF(end - cap_width, top),
671 QPointF(end, y + .5f),
672 QPointF(end - cap_width, bottom),
673 QPointF(start + cap_width, bottom)
676 p.drawConvexPolygon(pts, countof(pts));
678 if (annotations.empty())
681 const int ann_start = start + cap_width;
682 const int ann_end = end - cap_width;
684 const int real_start = max(ann_start, pp.left() + row_title_width);
685 const int real_end = min(ann_end, pp.right());
686 const int real_width = real_end - real_start;
688 QRectF rect(real_start, y - h / 2, real_width, h);
689 if (rect.width() <= 4)
694 // Try to find an annotation that will fit
695 QString best_annotation;
698 for (const QString &a : annotations) {
699 const int w = p.boundingRect(QRectF(), 0, a).width();
700 if (w <= rect.width() && w > best_width)
701 best_annotation = a, best_width = w;
704 if (best_annotation.isEmpty())
705 best_annotation = annotations.back();
707 // If not ellide the last in the list
708 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
709 best_annotation, Qt::ElideRight, rect.width()));
712 void DecodeTrace::draw_error(QPainter &p, const QString &message,
713 const ViewItemPaintParams &pp)
715 const int y = get_visual_y();
717 double samples_per_pixel, pixels_offset;
718 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
720 p.setPen(ErrorBgColor.darker());
721 p.setBrush(ErrorBgColor);
723 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
725 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
726 const qreal r = text_rect.height() / 4;
728 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
731 p.drawText(text_rect, message);
734 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
736 using namespace pv::data;
737 using pv::data::decode::Decoder;
739 double samples_per_pixel, pixels_offset;
741 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
742 if (sample_count == 0)
745 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
746 if (sample_count == samples_decoded)
749 const int y = get_visual_y();
751 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
753 const double start = max(samples_decoded /
754 samples_per_pixel - pixels_offset, left - 1.0);
755 const double end = min(sample_count / samples_per_pixel -
756 pixels_offset, right + 1.0);
757 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
759 p.setPen(QPen(Qt::NoPen));
760 p.setBrush(Qt::white);
761 p.drawRect(no_decode_rect);
763 p.setPen(NoDecodeColor);
764 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
765 p.drawRect(no_decode_rect);
768 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
772 const View *view = owner_->view();
775 const double scale = view->scale();
778 const double pixels_offset =
779 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
781 double samplerate = decode_signal_->samplerate();
783 // Show sample rate as 1Hz when it is unknown
784 if (samplerate == 0.0)
787 return make_pair(pixels_offset, samplerate * scale);
790 pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
791 int x_start, int x_end) const
793 double samples_per_pixel, pixels_offset;
794 tie(pixels_offset, samples_per_pixel) =
795 get_pixels_offset_samples_per_pixel();
797 const uint64_t start = (uint64_t)max(
798 (x_start + pixels_offset) * samples_per_pixel, 0.0);
799 const uint64_t end = (uint64_t)max(
800 (x_end + pixels_offset) * samples_per_pixel, 0.0);
802 return make_pair(start, end);
805 QColor DecodeTrace::get_row_color(int row_index) const
807 // For each row color, use the base color hue and add an offset that's
808 // not a dividend of 360
811 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
812 const int s = DECODETRACE_COLOR_SATURATION;
813 const int v = DECODETRACE_COLOR_VALUE;
814 color.setHsl(h, s, v);
819 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
821 // For each row color, use the base color hue and add an offset that's
822 // not a dividend of 360 and not a multiple of the row offset
824 QColor color(row_color);
825 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
826 const int s = DECODETRACE_COLOR_SATURATION;
827 const int v = DECODETRACE_COLOR_VALUE;
828 color.setHsl(h, s, v);
833 unsigned int DecodeTrace::get_row_y(const RowData* row) const
837 unsigned int y = get_visual_y();
839 for (const RowData& r : rows_) {
840 if (!r.currently_visible)
843 if (row->decode_row == r.decode_row)
852 RowData* DecodeTrace::get_row_at_point(const QPoint &point)
854 int y = get_visual_y() - (default_row_height_ / 2);
856 for (RowData& r : rows_) {
857 if (!r.currently_visible)
860 if ((point.y() >= y) && (point.y() < (int)(y + r.height)))
869 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
871 using namespace pv::data::decode;
876 const pair<uint64_t, uint64_t> sample_range =
877 get_view_sample_range(point.x(), point.x() + 1);
878 const RowData* r = get_row_at_point(point);
883 if (point.y() > (int)(get_row_y(r) + (annotation_height_ / 2)))
886 vector<Annotation> annotations;
888 decode_signal_->get_annotation_subset(annotations, r->decode_row,
889 current_segment_, sample_range.first, sample_range.second);
891 return (annotations.empty()) ?
892 QString() : annotations[0].annotations().front();
895 void DecodeTrace::hover_point_changed(const QPoint &hp)
897 Trace::hover_point_changed(hp);
901 RowData* hover_row = get_row_at_point(hp);
903 // Row expansion marker handling
904 for (RowData& r : rows_)
905 r.expand_marker_highlighted = false;
908 int row_y = get_row_y(hover_row);
909 if ((hp.x() > 0) && (hp.x() < ArrowSize) &&
910 (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize)))
911 hover_row->expand_marker_highlighted = true;
916 QString ann = get_annotation_at_point(hp);
918 if (!ann.isEmpty()) {
919 QFontMetrics m(QToolTip::font());
920 const QRect text_size = m.boundingRect(QRect(), 0, ann);
922 // This is OS-specific and unfortunately we can't query it, so
923 // use an approximation to at least try to minimize the error.
924 const int padding = default_row_height_ + 8;
926 // Make sure the tool tip doesn't overlap with the mouse cursor.
927 // If it did, the tool tip would constantly hide and re-appear.
928 // We also push it up by one row so that it appears above the
929 // decode trace, not below.
931 p.setX(hp.x() - (text_size.width() / 2) - padding);
933 p.setY(get_row_y(hover_row) - default_row_height_ -
934 text_size.height() - padding);
936 const View *const view = owner_->view();
938 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
941 QToolTip::hideText();
944 QToolTip::hideText();
947 void DecodeTrace::create_decoder_form(int index,
948 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
951 GlobalSettings settings;
954 const srd_decoder *const decoder = dec->decoder();
957 const bool decoder_deletable = index > 0;
959 pv::widgets::DecoderGroupBox *const group =
960 new pv::widgets::DecoderGroupBox(
961 QString::fromUtf8(decoder->name),
962 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
963 QString::fromUtf8(decoder->desc)),
964 nullptr, decoder_deletable);
965 group->set_decoder_visible(dec->shown());
967 if (decoder_deletable) {
968 delete_mapper_.setMapping(group, index);
969 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
972 show_hide_mapper_.setMapping(group, index);
973 connect(group, SIGNAL(show_hide_decoder()),
974 &show_hide_mapper_, SLOT(map()));
976 QFormLayout *const decoder_form = new QFormLayout;
977 group->add_layout(decoder_form);
979 const vector<DecodeChannel> channels = decode_signal_->get_channels();
982 for (const DecodeChannel& ch : channels) {
983 // Ignore channels not part of the decoder we create the form for
984 if (ch.decoder_ != dec)
987 QComboBox *const combo = create_channel_selector(parent, &ch);
988 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
990 channel_id_map_[combo] = ch.id;
991 init_state_map_[combo_init_state] = ch.id;
993 connect(combo, SIGNAL(currentIndexChanged(int)),
994 this, SLOT(on_channel_selected(int)));
995 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
996 this, SLOT(on_init_state_changed(int)));
998 QHBoxLayout *const hlayout = new QHBoxLayout;
999 hlayout->addWidget(combo);
1000 hlayout->addWidget(combo_init_state);
1002 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
1003 combo_init_state->hide();
1005 const QString required_flag = ch.is_optional ? QString() : QString("*");
1006 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
1007 .arg(ch.name, ch.desc, required_flag), hlayout);
1011 shared_ptr<binding::Decoder> binding(
1012 new binding::Decoder(decode_signal_, dec));
1013 binding->add_properties_to_form(decoder_form, true);
1015 bindings_.push_back(binding);
1017 form->addRow(group);
1018 decoder_forms_.push_back(group);
1021 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
1023 const auto sigs(session_.signalbases());
1025 // Sort signals in natural order
1026 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
1027 sort(sig_list.begin(), sig_list.end(),
1028 [](const shared_ptr<data::SignalBase> &a,
1029 const shared_ptr<data::SignalBase> &b) {
1030 return strnatcasecmp(a->name().toStdString(),
1031 b->name().toStdString()) < 0; });
1033 QComboBox *selector = new QComboBox(parent);
1035 selector->addItem("-", qVariantFromValue((void*)nullptr));
1037 if (!ch->assigned_signal)
1038 selector->setCurrentIndex(0);
1040 for (const shared_ptr<data::SignalBase> &b : sig_list) {
1042 if (b->logic_data() && b->enabled()) {
1043 selector->addItem(b->name(),
1044 qVariantFromValue((void*)b.get()));
1046 if (ch->assigned_signal == b.get())
1047 selector->setCurrentIndex(selector->count() - 1);
1054 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
1055 const DecodeChannel *ch)
1057 QComboBox *selector = new QComboBox(parent);
1059 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
1060 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
1061 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
1063 selector->setCurrentIndex(ch->initial_pin_state);
1065 selector->setToolTip("Initial (assumed) pin value before the first sample");
1070 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
1072 using namespace pv::data::decode;
1074 GlobalSettings settings;
1075 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
1077 const QString file_name = QFileDialog::getSaveFileName(
1078 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1080 if (file_name.isEmpty())
1083 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1084 const QString quote = format.contains("%q") ? "\"" : "";
1085 format = format.remove("%q");
1087 QFile file(file_name);
1088 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1089 QTextStream out_stream(&file);
1091 for (Annotation &ann : *annotations) {
1092 const QString sample_range = QString("%1-%2") \
1093 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
1095 const QString class_name = quote + ann.row()->class_name() + quote;
1097 QString all_ann_text;
1098 for (const QString &s : ann.annotations())
1099 all_ann_text = all_ann_text + quote + s + quote + ",";
1100 all_ann_text.chop(1);
1102 const QString first_ann_text = quote + ann.annotations().front() + quote;
1104 QString out_text = format;
1105 out_text = out_text.replace("%s", sample_range);
1106 out_text = out_text.replace("%d",
1107 quote + QString::fromUtf8(ann.row()->decoder()->name()) + quote);
1108 out_text = out_text.replace("%c", class_name);
1109 out_text = out_text.replace("%1", first_ann_text);
1110 out_text = out_text.replace("%a", all_ann_text);
1111 out_stream << out_text << '\n';
1114 if (out_stream.status() == QTextStream::Ok)
1118 QMessageBox msg(owner_->view());
1119 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1120 msg.setStandardButtons(QMessageBox::Ok);
1121 msg.setIcon(QMessageBox::Warning);
1125 void DecodeTrace::update_rows()
1127 lock_guard<mutex> lock(row_modification_mutex_);
1129 QFontMetrics m(QApplication::font());
1131 for (RowData& r : rows_)
1134 for (const Row& decode_row : decode_signal_->get_rows()) {
1135 // Find row in our list
1136 auto r_it = find_if(rows_.begin(), rows_.end(),
1137 [&](RowData& r){ return r.decode_row == decode_row; });
1139 RowData* r = nullptr;
1140 if (r_it == rows_.end()) {
1141 // Row doesn't exist yet, create and append it
1143 nr.decode_row = decode_row;
1144 nr.height = default_row_height_;
1145 nr.currently_visible = false;
1146 nr.expand_marker_highlighted = false;
1147 nr.expanded = false;
1149 rows_.push_back(nr);
1156 const int w = m.boundingRect(r->decode_row.title()).width() + RowTitleMargin;
1160 // Remove any rows that no longer exist, obeying that iterators are invalidated
1165 for (unsigned int i = 0; i < rows_.size(); i++)
1166 if (!rows_[i].exists) {
1167 rows_.erase(rows_.begin() + i);
1171 } while (any_exists);
1174 void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
1176 Trace::on_setting_changed(key, value);
1178 if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
1179 max_visible_rows_ = 0;
1180 always_show_all_rows_ = value.toBool();
1184 void DecodeTrace::on_new_annotations()
1186 if (!delayed_trace_updater_.isActive())
1187 delayed_trace_updater_.start();
1190 void DecodeTrace::on_delayed_trace_update()
1193 owner_->row_item_appearance_changed(false, true);
1196 void DecodeTrace::on_decode_reset()
1198 max_visible_rows_ = 0;
1202 owner_->row_item_appearance_changed(false, true);
1205 void DecodeTrace::on_decode_finished()
1208 owner_->row_item_appearance_changed(false, true);
1211 void DecodeTrace::on_pause_decode()
1213 if (decode_signal_->is_paused())
1214 decode_signal_->resume_decode();
1216 decode_signal_->pause_decode();
1219 void DecodeTrace::delete_pressed()
1224 void DecodeTrace::on_delete()
1226 session_.remove_decode_signal(decode_signal_);
1229 void DecodeTrace::on_channel_selected(int)
1231 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1233 // Determine signal that was selected
1234 const data::SignalBase *signal =
1235 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1237 // Determine decode channel ID this combo box is the channel selector for
1238 const uint16_t id = channel_id_map_.at(cb);
1240 decode_signal_->assign_signal(id, signal);
1243 void DecodeTrace::on_channels_updated()
1246 owner_->row_item_appearance_changed(false, true);
1249 void DecodeTrace::on_init_state_changed(int)
1251 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1253 // Determine inital pin state that was selected
1254 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1256 // Determine decode channel ID this combo box is the channel selector for
1257 const uint16_t id = init_state_map_.at(cb);
1259 decode_signal_->set_initial_pin_state(id, init_state);
1262 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1264 decode_signal_->stack_decoder(decoder);
1267 create_popup_form();
1270 void DecodeTrace::on_delete_decoder(int index)
1272 decode_signal_->remove_decoder(index);
1275 // Force re-calculation of the trace height
1276 max_visible_rows_ = 0;
1277 owner_->extents_changed(false, true);
1279 create_popup_form();
1282 void DecodeTrace::on_show_hide_decoder(int index)
1284 const bool state = decode_signal_->toggle_decoder_visibility(index);
1286 assert(index < (int)decoder_forms_.size());
1287 decoder_forms_[index]->set_decoder_visible(state);
1290 // Force re-calculation of the trace height, see paint_mid()
1291 max_visible_rows_ = 0;
1292 owner_->extents_changed(false, true);
1296 owner_->row_item_appearance_changed(false, true);
1299 void DecodeTrace::on_copy_annotation_to_clipboard()
1301 using namespace pv::data::decode;
1306 vector<Annotation> *annotations = new vector<Annotation>();
1308 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1309 current_segment_, selected_sample_range_.first, selected_sample_range_.first);
1311 if (annotations->empty())
1314 QClipboard *clipboard = QApplication::clipboard();
1315 clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard);
1317 if (clipboard->supportsSelection())
1318 clipboard->setText(annotations->front().annotations().front(), QClipboard::Selection);
1323 void DecodeTrace::on_export_row()
1325 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1326 on_export_row_from_here();
1329 void DecodeTrace::on_export_all_rows()
1331 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1332 on_export_all_rows_from_here();
1335 void DecodeTrace::on_export_row_with_cursor()
1337 const View *view = owner_->view();
1340 if (!view->cursors()->enabled())
1343 const double samplerate = session_.get_samplerate();
1345 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1346 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1348 const uint64_t start_sample = (uint64_t)max(
1349 0.0, start_time.convert_to<double>() * samplerate);
1350 const uint64_t end_sample = (uint64_t)max(
1351 0.0, end_time.convert_to<double>() * samplerate);
1353 // Are both cursors negative and thus were clamped to 0?
1354 if ((start_sample == 0) && (end_sample == 0))
1357 selected_sample_range_ = make_pair(start_sample, end_sample);
1358 on_export_row_from_here();
1361 void DecodeTrace::on_export_all_rows_with_cursor()
1363 const View *view = owner_->view();
1366 if (!view->cursors()->enabled())
1369 const double samplerate = session_.get_samplerate();
1371 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1372 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1374 const uint64_t start_sample = (uint64_t)max(
1375 0.0, start_time.convert_to<double>() * samplerate);
1376 const uint64_t end_sample = (uint64_t)max(
1377 0.0, end_time.convert_to<double>() * samplerate);
1379 // Are both cursors negative and thus were clamped to 0?
1380 if ((start_sample == 0) && (end_sample == 0))
1383 selected_sample_range_ = make_pair(start_sample, end_sample);
1384 on_export_all_rows_from_here();
1387 void DecodeTrace::on_export_row_from_here()
1389 using namespace pv::data::decode;
1394 vector<Annotation> *annotations = new vector<Annotation>();
1396 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1397 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1399 if (annotations->empty())
1402 export_annotations(annotations);
1406 void DecodeTrace::on_export_all_rows_from_here()
1408 using namespace pv::data::decode;
1410 vector<Annotation> *annotations = new vector<Annotation>();
1412 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1413 selected_sample_range_.first, selected_sample_range_.second);
1415 if (!annotations->empty())
1416 export_annotations(annotations);
1421 } // namespace trace
1422 } // namespace views