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;
117 // For the base color, we want to start at a very different color for
118 // every decoder stack, so multiply the index with a number that is
119 // rather close to 180 degrees of the color circle but not a dividend of 360
120 // Note: The offset equals the color of the first annotation
122 const int h = (120 + 160 * index) % 360;
123 const int s = DECODETRACE_COLOR_SATURATION;
124 const int v = DECODETRACE_COLOR_VALUE;
125 color.setHsv(h, s, v);
126 base_->set_color(color);
128 connect(decode_signal_.get(), SIGNAL(new_annotations()),
129 this, SLOT(on_new_annotations()));
130 connect(decode_signal_.get(), SIGNAL(decode_reset()),
131 this, SLOT(on_decode_reset()));
132 connect(decode_signal_.get(), SIGNAL(decode_finished()),
133 this, SLOT(on_decode_finished()));
134 connect(decode_signal_.get(), SIGNAL(channels_updated()),
135 this, SLOT(on_channels_updated()));
137 connect(&delete_mapper_, SIGNAL(mapped(int)),
138 this, SLOT(on_delete_decoder(int)));
139 connect(&show_hide_mapper_, SIGNAL(mapped(int)),
140 this, SLOT(on_show_hide_decoder(int)));
142 connect(&delayed_trace_updater_, SIGNAL(timeout()),
143 this, SLOT(on_delayed_trace_update()));
144 delayed_trace_updater_.setSingleShot(true);
145 delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
148 DecodeTrace::~DecodeTrace()
150 GlobalSettings::remove_change_handler(this);
153 bool DecodeTrace::enabled() const
158 shared_ptr<data::SignalBase> DecodeTrace::base() const
163 pair<int, int> DecodeTrace::v_extents() const
165 // Make an empty decode trace appear symmetrical
166 if (max_visible_rows_ == 0)
167 return make_pair(-default_row_height_, default_row_height_);
169 unsigned int height = 0;
170 for (const RowData& r : rows_)
171 if (r.currently_visible)
174 return make_pair(-default_row_height_, height);
177 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
179 Trace::paint_back(p, pp);
180 paint_axis(p, pp, get_visual_y());
183 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
185 lock_guard<mutex> lock(row_modification_mutex_);
187 const int text_height = ViewItemPaintParams::text_height();
188 const int annotation_height = (text_height * 5) / 4;
190 // Set default pen to allow for text width calculation
193 pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pp.left(), pp.right());
195 // Just because the view says we see a certain sample range it
196 // doesn't mean we have this many decoded samples, too, so crop
197 // the range to what has been decoded already
198 sample_range.second = min((int64_t)sample_range.second,
199 decode_signal_->get_decoded_sample_count(current_segment_, false));
201 for (RowData& r : rows_)
202 r.currently_visible = false;
204 int y = get_visual_y();
206 for (RowData& r : rows_) {
207 vector<Annotation> annotations;
208 decode_signal_->get_annotation_subset(annotations, r.decode_row,
209 current_segment_, sample_range.first, sample_range.second);
211 // Show row if there are visible annotations or when user wants to see
212 // all rows that have annotations somewhere and this one is one of them
213 size_t ann_count = decode_signal_->get_annotation_count(r.decode_row, current_segment_);
214 r.currently_visible = (!annotations.empty() || (always_show_all_rows_ && (ann_count > 0)))
215 && (r.decode_row.decoder()->shown());
217 if (r.currently_visible) {
218 draw_annotations(annotations, p, annotation_height, pp, y,
219 get_row_color(r.decode_row.index()), r.title_width);
225 draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
227 if (visible_rows_ > max_visible_rows_) {
228 max_visible_rows_ = visible_rows_;
230 // Call order is important, otherwise the lazy event handler won't work
231 owner_->extents_changed(false, true);
232 owner_->row_item_appearance_changed(false, true);
235 const QString err = decode_signal_->error_message();
237 draw_error(p, err, pp);
240 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
242 unsigned int y = get_visual_y();
244 for (const RowData& r : rows_) {
245 if (!r.currently_visible)
248 p.setPen(QPen(Qt::NoPen));
250 if (r.expand_marker_highlighted)
251 p.setBrush(QApplication::palette().brush(QPalette::HighlightedText));
253 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
255 // Draw expansion marker
256 const QPointF points[] = {
257 QPointF(pp.left(), y - ArrowSize),
258 QPointF(pp.left() + ArrowSize, y),
259 QPointF(pp.left(), y + ArrowSize)
261 p.drawPolygon(points, countof(points));
263 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
265 const QRect text_rect(pp.left() + ArrowSize * 2, y - r.height / 2,
266 pp.right() - pp.left(), r.height);
267 const QString h(r.decode_row.title());
268 const int f = Qt::AlignLeft | Qt::AlignVCenter |
272 p.setPen(QApplication::palette().color(QPalette::Base));
273 for (int dx = -1; dx <= 1; dx++)
274 for (int dy = -1; dy <= 1; dy++)
275 if (dx != 0 && dy != 0)
276 p.drawText(text_rect.translated(dx, dy), f, h);
279 p.setPen(QApplication::palette().color(QPalette::WindowText));
280 p.drawText(text_rect, f, h);
285 if (show_hover_marker_)
286 paint_hover_marker(p);
289 void DecodeTrace::update_stack_button()
291 const vector< shared_ptr<data::decode::Decoder> > &stack = decode_signal_->decoder_stack();
293 // Only show decoders in the menu that can be stacked onto the last one in the stack
294 if (!stack.empty()) {
295 const srd_decoder* d = stack.back()->decoder();
298 pv::widgets::DecoderMenu *const decoder_menu =
299 new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data));
300 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
301 this, SLOT(on_stack_decoder(srd_decoder*)));
303 decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }");
305 stack_button_->setMenu(decoder_menu);
306 stack_button_->show();
311 // No decoders available for stacking
312 stack_button_->setMenu(nullptr);
313 stack_button_->hide();
316 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
318 using pv::data::decode::Decoder;
322 // Add the standard options
323 Trace::populate_popup_form(parent, form);
325 // Add the decoder options
327 channel_id_map_.clear();
328 init_state_map_.clear();
329 decoder_forms_.clear();
331 const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
334 QLabel *const l = new QLabel(
335 tr("<p><i>No decoders in the stack</i></p>"));
336 l->setAlignment(Qt::AlignCenter);
339 auto iter = stack.cbegin();
340 for (int i = 0; i < (int)stack.size(); i++, iter++) {
341 shared_ptr<Decoder> dec(*iter);
342 create_decoder_form(i, dec, parent, form);
345 form->addRow(new QLabel(
346 tr("<i>* Required channels</i>"), parent));
349 // Add stacking button
350 stack_button_ = new QPushButton(tr("Stack Decoder"), parent);
351 stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one"));
352 update_stack_button();
354 QHBoxLayout *stack_button_box = new QHBoxLayout;
355 stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight);
356 form->addRow(stack_button_box);
359 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
361 QMenu *const menu = Trace::create_header_context_menu(parent);
363 menu->addSeparator();
365 QAction *const del = new QAction(tr("Delete"), this);
366 del->setShortcuts(QKeySequence::Delete);
367 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
368 menu->addAction(del);
373 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
375 // Get entries from default menu before adding our own
376 QMenu *const menu = new QMenu(parent);
378 QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
380 for (QAction *action : default_menu->actions()) { // clazy:exclude=range-loop
381 menu->addAction(action);
382 if (action->parent() == default_menu)
383 action->setParent(menu);
387 // Add separator if needed
388 if (menu->actions().length() > 0)
389 menu->addSeparator();
392 selected_row_ = nullptr;
393 const RowData* r = get_row_at_point(click_pos);
395 selected_row_ = &(r->decode_row);
397 const View *const view = owner_->view();
399 QPoint pos = view->viewport()->mapFrom(parent, click_pos);
401 // Default sample range is "from here"
402 const pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pos.x(), pos.x() + 1);
403 selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
405 if (decode_signal_->is_paused()) {
406 QAction *const resume =
407 new QAction(tr("Resume decoding"), this);
408 resume->setIcon(QIcon::fromTheme("media-playback-start",
409 QIcon(":/icons/media-playback-start.png")));
410 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
411 menu->addAction(resume);
413 QAction *const pause =
414 new QAction(tr("Pause decoding"), this);
415 pause->setIcon(QIcon::fromTheme("media-playback-pause",
416 QIcon(":/icons/media-playback-pause.png")));
417 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
418 menu->addAction(pause);
421 QAction *const copy_annotation_to_clipboard =
422 new QAction(tr("Copy annotation text to clipboard"), this);
423 copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste",
424 QIcon(":/icons/edit-paste.svg")));
425 connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard()));
426 menu->addAction(copy_annotation_to_clipboard);
428 menu->addSeparator();
430 QAction *const export_all_rows =
431 new QAction(tr("Export all annotations"), this);
432 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
433 QIcon(":/icons/document-save-as.png")));
434 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
435 menu->addAction(export_all_rows);
437 QAction *const export_row =
438 new QAction(tr("Export all annotations for this row"), this);
439 export_row->setIcon(QIcon::fromTheme("document-save-as",
440 QIcon(":/icons/document-save-as.png")));
441 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
442 menu->addAction(export_row);
444 menu->addSeparator();
446 QAction *const export_all_rows_from_here =
447 new QAction(tr("Export all annotations, starting here"), this);
448 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
449 QIcon(":/icons/document-save-as.png")));
450 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
451 menu->addAction(export_all_rows_from_here);
453 QAction *const export_row_from_here =
454 new QAction(tr("Export annotations for this row, starting here"), this);
455 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
456 QIcon(":/icons/document-save-as.png")));
457 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
458 menu->addAction(export_row_from_here);
460 menu->addSeparator();
462 QAction *const export_all_rows_with_cursor =
463 new QAction(tr("Export all annotations within cursor range"), this);
464 export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
465 QIcon(":/icons/document-save-as.png")));
466 connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
467 menu->addAction(export_all_rows_with_cursor);
469 QAction *const export_row_with_cursor =
470 new QAction(tr("Export annotations for this row within cursor range"), this);
471 export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
472 QIcon(":/icons/document-save-as.png")));
473 connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
474 menu->addAction(export_row_with_cursor);
476 if (!view->cursors()->enabled()) {
477 export_all_rows_with_cursor->setEnabled(false);
478 export_row_with_cursor->setEnabled(false);
484 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
485 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
486 QColor row_color, int row_title_width)
488 using namespace pv::data::decode;
490 Annotation::Class block_class = 0;
491 bool block_class_uniform = true;
492 qreal block_start = 0;
493 int block_ann_count = 0;
495 const Annotation *prev_ann;
496 qreal prev_end = INT_MIN;
500 double samples_per_pixel, pixels_offset;
501 tie(pixels_offset, samples_per_pixel) =
502 get_pixels_offset_samples_per_pixel();
504 // Sort the annotations by start sample so that decoders
505 // can't confuse us by creating annotations out of order
506 stable_sort(annotations.begin(), annotations.end(),
507 [](const Annotation &a, const Annotation &b) {
508 return a.start_sample() < b.start_sample(); });
510 // Gather all annotations that form a visual "block" and draw them as such
511 for (const Annotation &a : annotations) {
513 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
514 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
516 const qreal a_start = abs_a_start - pixels_offset;
517 a_end = abs_a_end - pixels_offset;
519 const qreal a_width = a_end - a_start;
520 const qreal delta = a_end - prev_end;
522 bool a_is_separate = false;
524 // Annotation wider than the threshold for a useful label width?
525 if (a_width >= min_useful_label_width_) {
526 for (const QString &ann_text : a.annotations()) {
527 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
528 // Annotation wide enough to fit a label? Don't put it in a block then
530 a_is_separate = true;
536 // Were the previous and this annotation more than a pixel apart?
537 if ((abs(delta) > 1) || a_is_separate) {
538 // Block was broken, draw annotations that form the current block
539 if (block_ann_count == 1)
540 draw_annotation(*prev_ann, p, h, pp, y, row_color,
542 else if (block_ann_count > 0)
543 draw_annotation_block(block_start, prev_end, block_class,
544 block_class_uniform, p, h, y, row_color);
550 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
551 // Next annotation must start a new block. delta will be > 1
552 // because we set prev_end to INT_MIN but that's okay since
553 // block_ann_count will be 0 and nothing will be drawn
560 if (block_ann_count == 0) {
561 block_start = a_start;
562 block_class = a.ann_class();
563 block_class_uniform = true;
565 if (a.ann_class() != block_class)
566 block_class_uniform = false;
572 if (block_ann_count == 1)
573 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
574 else if (block_ann_count > 0)
575 draw_annotation_block(block_start, prev_end, block_class,
576 block_class_uniform, p, h, y, row_color);
579 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
580 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
581 QColor row_color, int row_title_width) const
583 double samples_per_pixel, pixels_offset;
584 tie(pixels_offset, samples_per_pixel) =
585 get_pixels_offset_samples_per_pixel();
587 const double start = a.start_sample() / samples_per_pixel -
589 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
591 QColor color = get_annotation_color(row_color, a.ann_class());
592 p.setPen(color.darker());
595 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
598 if (a.start_sample() == a.end_sample())
599 draw_instant(a, p, h, start, y);
601 draw_range(a, p, h, start, end, y, pp, row_title_width);
604 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
605 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
606 int y, QColor row_color) const
608 const double top = y + .5 - h / 2;
609 const double bottom = y + .5 + h / 2;
611 const QRectF rect(start, top, end - start, bottom - top);
614 p.setPen(QPen(Qt::NoPen));
615 p.setBrush(Qt::white);
616 p.drawRoundedRect(rect, r, r);
618 // If all annotations in this block are of the same type, we can use the
619 // one format that all of these annotations have. Otherwise, we should use
620 // a neutral color (i.e. gray)
621 if (use_ann_format) {
622 const QColor color = get_annotation_color(row_color, ann_class);
623 p.setPen(color.darker());
624 p.setBrush(QBrush(color, Qt::Dense4Pattern));
627 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
630 p.drawRoundedRect(rect, r, r);
633 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
634 int h, qreal x, int y) const
636 const QString text = a.annotations().empty() ?
637 QString() : a.annotations().back();
638 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
640 const QRectF rect(x - w / 2, y - h / 2, w, h);
642 p.drawRoundedRect(rect, h / 2, h / 2);
645 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
648 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
649 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
650 int row_title_width) const
652 const qreal top = y + .5 - h / 2;
653 const qreal bottom = y + .5 + h / 2;
654 const vector<QString> annotations = a.annotations();
656 // If the two ends are within 1 pixel, draw a vertical line
657 if (start + 1.0 > end) {
658 p.drawLine(QPointF(start, top), QPointF(start, bottom));
662 const qreal cap_width = min((end - start) / 4, EndCapWidth);
665 QPointF(start, y + .5f),
666 QPointF(start + cap_width, top),
667 QPointF(end - cap_width, top),
668 QPointF(end, y + .5f),
669 QPointF(end - cap_width, bottom),
670 QPointF(start + cap_width, bottom)
673 p.drawConvexPolygon(pts, countof(pts));
675 if (annotations.empty())
678 const int ann_start = start + cap_width;
679 const int ann_end = end - cap_width;
681 const int real_start = max(ann_start, pp.left() + row_title_width);
682 const int real_end = min(ann_end, pp.right());
683 const int real_width = real_end - real_start;
685 QRectF rect(real_start, y - h / 2, real_width, h);
686 if (rect.width() <= 4)
691 // Try to find an annotation that will fit
692 QString best_annotation;
695 for (const QString &a : annotations) {
696 const int w = p.boundingRect(QRectF(), 0, a).width();
697 if (w <= rect.width() && w > best_width)
698 best_annotation = a, best_width = w;
701 if (best_annotation.isEmpty())
702 best_annotation = annotations.back();
704 // If not ellide the last in the list
705 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
706 best_annotation, Qt::ElideRight, rect.width()));
709 void DecodeTrace::draw_error(QPainter &p, const QString &message,
710 const ViewItemPaintParams &pp)
712 const int y = get_visual_y();
714 double samples_per_pixel, pixels_offset;
715 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
717 p.setPen(ErrorBgColor.darker());
718 p.setBrush(ErrorBgColor);
720 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
722 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
723 const qreal r = text_rect.height() / 4;
725 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
728 p.drawText(text_rect, message);
731 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
733 using namespace pv::data;
734 using pv::data::decode::Decoder;
736 double samples_per_pixel, pixels_offset;
738 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
739 if (sample_count == 0)
742 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
743 if (sample_count == samples_decoded)
746 const int y = get_visual_y();
748 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
750 const double start = max(samples_decoded /
751 samples_per_pixel - pixels_offset, left - 1.0);
752 const double end = min(sample_count / samples_per_pixel -
753 pixels_offset, right + 1.0);
754 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
756 p.setPen(QPen(Qt::NoPen));
757 p.setBrush(Qt::white);
758 p.drawRect(no_decode_rect);
760 p.setPen(NoDecodeColor);
761 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
762 p.drawRect(no_decode_rect);
765 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
769 const View *view = owner_->view();
772 const double scale = view->scale();
775 const double pixels_offset =
776 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
778 double samplerate = decode_signal_->samplerate();
780 // Show sample rate as 1Hz when it is unknown
781 if (samplerate == 0.0)
784 return make_pair(pixels_offset, samplerate * scale);
787 pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
788 int x_start, int x_end) const
790 double samples_per_pixel, pixels_offset;
791 tie(pixels_offset, samples_per_pixel) =
792 get_pixels_offset_samples_per_pixel();
794 const uint64_t start = (uint64_t)max(
795 (x_start + pixels_offset) * samples_per_pixel, 0.0);
796 const uint64_t end = (uint64_t)max(
797 (x_end + pixels_offset) * samples_per_pixel, 0.0);
799 return make_pair(start, end);
802 QColor DecodeTrace::get_row_color(int row_index) const
804 // For each row color, use the base color hue and add an offset that's
805 // not a dividend of 360
808 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
809 const int s = DECODETRACE_COLOR_SATURATION;
810 const int v = DECODETRACE_COLOR_VALUE;
811 color.setHsl(h, s, v);
816 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
818 // For each row color, use the base color hue and add an offset that's
819 // not a dividend of 360 and not a multiple of the row offset
821 QColor color(row_color);
822 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
823 const int s = DECODETRACE_COLOR_SATURATION;
824 const int v = DECODETRACE_COLOR_VALUE;
825 color.setHsl(h, s, v);
830 unsigned int DecodeTrace::get_row_y(const RowData* row) const
834 unsigned int y = get_visual_y();
836 for (const RowData& r : rows_)
845 RowData* DecodeTrace::get_row_at_point(const QPoint &point)
847 int y = get_visual_y();
849 for (RowData& r : rows_) {
850 if (!r.currently_visible)
853 if ((point.y() >= y) && (point.y() < (int)(y + r.height)))
862 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
864 using namespace pv::data::decode;
869 const pair<uint64_t, uint64_t> sample_range =
870 get_view_sample_range(point.x(), point.x() + 1);
871 const RowData* r = get_row_at_point(point);
876 vector<Annotation> annotations;
878 decode_signal_->get_annotation_subset(annotations, r->decode_row,
879 current_segment_, sample_range.first, sample_range.second);
881 return (annotations.empty()) ?
882 QString() : annotations[0].annotations().front();
885 void DecodeTrace::hover_point_changed(const QPoint &hp)
887 Trace::hover_point_changed(hp);
891 RowData* hover_row = get_row_at_point(hp);
893 // Row/class visibility button handling
894 for (RowData& r : rows_)
895 r.expand_marker_highlighted = false;
898 int row_y = get_row_y(hover_row);
899 if ((hp.x() > 0) && (hp.x() < ArrowSize) &&
900 (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize)))
901 hover_row->expand_marker_highlighted = true;
906 QString ann = get_annotation_at_point(hp);
909 QToolTip::hideText();
913 QFontMetrics m(QToolTip::font());
914 const QRect text_size = m.boundingRect(QRect(), 0, ann);
916 // This is OS-specific and unfortunately we can't query it, so
917 // use an approximation to at least try to minimize the error.
918 const int padding = 8;
920 // Make sure the tool tip doesn't overlap with the mouse cursor.
921 // If it did, the tool tip would constantly hide and re-appear.
922 // We also push it up by one row so that it appears above the
923 // decode trace, not below.
925 p.setX(hp.x() - (text_size.width() / 2) - padding);
927 p.setY(get_row_y(hover_row) - hover_row->height - default_row_height_ -
928 text_size.height() - padding);
930 const View *const view = owner_->view();
932 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
935 QToolTip::hideText();
938 void DecodeTrace::create_decoder_form(int index,
939 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
942 GlobalSettings settings;
945 const srd_decoder *const decoder = dec->decoder();
948 const bool decoder_deletable = index > 0;
950 pv::widgets::DecoderGroupBox *const group =
951 new pv::widgets::DecoderGroupBox(
952 QString::fromUtf8(decoder->name),
953 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
954 QString::fromUtf8(decoder->desc)),
955 nullptr, decoder_deletable);
956 group->set_decoder_visible(dec->shown());
958 if (decoder_deletable) {
959 delete_mapper_.setMapping(group, index);
960 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
963 show_hide_mapper_.setMapping(group, index);
964 connect(group, SIGNAL(show_hide_decoder()),
965 &show_hide_mapper_, SLOT(map()));
967 QFormLayout *const decoder_form = new QFormLayout;
968 group->add_layout(decoder_form);
970 const vector<DecodeChannel> channels = decode_signal_->get_channels();
973 for (const DecodeChannel& ch : channels) {
974 // Ignore channels not part of the decoder we create the form for
975 if (ch.decoder_ != dec)
978 QComboBox *const combo = create_channel_selector(parent, &ch);
979 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
981 channel_id_map_[combo] = ch.id;
982 init_state_map_[combo_init_state] = ch.id;
984 connect(combo, SIGNAL(currentIndexChanged(int)),
985 this, SLOT(on_channel_selected(int)));
986 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
987 this, SLOT(on_init_state_changed(int)));
989 QHBoxLayout *const hlayout = new QHBoxLayout;
990 hlayout->addWidget(combo);
991 hlayout->addWidget(combo_init_state);
993 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
994 combo_init_state->hide();
996 const QString required_flag = ch.is_optional ? QString() : QString("*");
997 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
998 .arg(ch.name, ch.desc, required_flag), hlayout);
1002 shared_ptr<binding::Decoder> binding(
1003 new binding::Decoder(decode_signal_, dec));
1004 binding->add_properties_to_form(decoder_form, true);
1006 bindings_.push_back(binding);
1008 form->addRow(group);
1009 decoder_forms_.push_back(group);
1012 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
1014 const auto sigs(session_.signalbases());
1016 // Sort signals in natural order
1017 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
1018 sort(sig_list.begin(), sig_list.end(),
1019 [](const shared_ptr<data::SignalBase> &a,
1020 const shared_ptr<data::SignalBase> &b) {
1021 return strnatcasecmp(a->name().toStdString(),
1022 b->name().toStdString()) < 0; });
1024 QComboBox *selector = new QComboBox(parent);
1026 selector->addItem("-", qVariantFromValue((void*)nullptr));
1028 if (!ch->assigned_signal)
1029 selector->setCurrentIndex(0);
1031 for (const shared_ptr<data::SignalBase> &b : sig_list) {
1033 if (b->logic_data() && b->enabled()) {
1034 selector->addItem(b->name(),
1035 qVariantFromValue((void*)b.get()));
1037 if (ch->assigned_signal == b.get())
1038 selector->setCurrentIndex(selector->count() - 1);
1045 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
1046 const DecodeChannel *ch)
1048 QComboBox *selector = new QComboBox(parent);
1050 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
1051 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
1052 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
1054 selector->setCurrentIndex(ch->initial_pin_state);
1056 selector->setToolTip("Initial (assumed) pin value before the first sample");
1061 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
1063 using namespace pv::data::decode;
1065 GlobalSettings settings;
1066 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
1068 const QString file_name = QFileDialog::getSaveFileName(
1069 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1071 if (file_name.isEmpty())
1074 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1075 const QString quote = format.contains("%q") ? "\"" : "";
1076 format = format.remove("%q");
1078 QFile file(file_name);
1079 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1080 QTextStream out_stream(&file);
1082 for (Annotation &ann : *annotations) {
1083 const QString sample_range = QString("%1-%2") \
1084 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
1086 const QString class_name = quote + ann.row()->class_name() + quote;
1088 QString all_ann_text;
1089 for (const QString &s : ann.annotations())
1090 all_ann_text = all_ann_text + quote + s + quote + ",";
1091 all_ann_text.chop(1);
1093 const QString first_ann_text = quote + ann.annotations().front() + quote;
1095 QString out_text = format;
1096 out_text = out_text.replace("%s", sample_range);
1097 out_text = out_text.replace("%d",
1098 quote + QString::fromUtf8(ann.row()->decoder()->name()) + quote);
1099 out_text = out_text.replace("%c", class_name);
1100 out_text = out_text.replace("%1", first_ann_text);
1101 out_text = out_text.replace("%a", all_ann_text);
1102 out_stream << out_text << '\n';
1105 if (out_stream.status() == QTextStream::Ok)
1109 QMessageBox msg(owner_->view());
1110 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1111 msg.setStandardButtons(QMessageBox::Ok);
1112 msg.setIcon(QMessageBox::Warning);
1116 void DecodeTrace::update_rows()
1118 lock_guard<mutex> lock(row_modification_mutex_);
1120 QFontMetrics m(QApplication::font());
1122 for (RowData& r : rows_)
1125 for (const Row& decode_row : decode_signal_->get_rows()) {
1126 // Find row in our list
1127 auto r_it = find_if(rows_.begin(), rows_.end(),
1128 [&](RowData& r){ return r.decode_row == decode_row; });
1130 RowData* r = nullptr;
1131 if (r_it == rows_.end()) {
1132 // Row doesn't exist yet, create and append it
1134 nr.decode_row = decode_row;
1135 nr.height = default_row_height_;
1136 nr.currently_visible = false;
1137 nr.expand_marker_highlighted = false;
1138 nr.expanded = false;
1140 rows_.push_back(nr);
1147 const int w = m.boundingRect(r->decode_row.title()).width() + RowTitleMargin;
1151 // Remove any rows that no longer exist, obeying that iterators are invalidated
1156 for (unsigned int i = 0; i < rows_.size(); i++)
1157 if (!rows_[i].exists) {
1158 rows_.erase(rows_.begin() + i);
1162 } while (any_exists);
1165 void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
1167 Trace::on_setting_changed(key, value);
1169 if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
1170 max_visible_rows_ = 0;
1171 always_show_all_rows_ = value.toBool();
1175 void DecodeTrace::on_new_annotations()
1177 if (!delayed_trace_updater_.isActive())
1178 delayed_trace_updater_.start();
1181 void DecodeTrace::on_delayed_trace_update()
1184 owner_->row_item_appearance_changed(false, true);
1187 void DecodeTrace::on_decode_reset()
1189 max_visible_rows_ = 0;
1193 owner_->row_item_appearance_changed(false, true);
1196 void DecodeTrace::on_decode_finished()
1199 owner_->row_item_appearance_changed(false, true);
1202 void DecodeTrace::on_pause_decode()
1204 if (decode_signal_->is_paused())
1205 decode_signal_->resume_decode();
1207 decode_signal_->pause_decode();
1210 void DecodeTrace::delete_pressed()
1215 void DecodeTrace::on_delete()
1217 session_.remove_decode_signal(decode_signal_);
1220 void DecodeTrace::on_channel_selected(int)
1222 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1224 // Determine signal that was selected
1225 const data::SignalBase *signal =
1226 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1228 // Determine decode channel ID this combo box is the channel selector for
1229 const uint16_t id = channel_id_map_.at(cb);
1231 decode_signal_->assign_signal(id, signal);
1234 void DecodeTrace::on_channels_updated()
1237 owner_->row_item_appearance_changed(false, true);
1240 void DecodeTrace::on_init_state_changed(int)
1242 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1244 // Determine inital pin state that was selected
1245 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1247 // Determine decode channel ID this combo box is the channel selector for
1248 const uint16_t id = init_state_map_.at(cb);
1250 decode_signal_->set_initial_pin_state(id, init_state);
1253 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1255 decode_signal_->stack_decoder(decoder);
1258 create_popup_form();
1261 void DecodeTrace::on_delete_decoder(int index)
1263 decode_signal_->remove_decoder(index);
1266 // Force re-calculation of the trace height
1267 max_visible_rows_ = 0;
1268 owner_->extents_changed(false, true);
1270 create_popup_form();
1273 void DecodeTrace::on_show_hide_decoder(int index)
1275 const bool state = decode_signal_->toggle_decoder_visibility(index);
1277 assert(index < (int)decoder_forms_.size());
1278 decoder_forms_[index]->set_decoder_visible(state);
1281 // Force re-calculation of the trace height, see paint_mid()
1282 max_visible_rows_ = 0;
1283 owner_->extents_changed(false, true);
1287 owner_->row_item_appearance_changed(false, true);
1290 void DecodeTrace::on_copy_annotation_to_clipboard()
1292 using namespace pv::data::decode;
1297 vector<Annotation> *annotations = new vector<Annotation>();
1299 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1300 current_segment_, selected_sample_range_.first, selected_sample_range_.first);
1302 if (annotations->empty())
1305 QClipboard *clipboard = QApplication::clipboard();
1306 clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard);
1308 if (clipboard->supportsSelection())
1309 clipboard->setText(annotations->front().annotations().front(), QClipboard::Selection);
1314 void DecodeTrace::on_export_row()
1316 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1317 on_export_row_from_here();
1320 void DecodeTrace::on_export_all_rows()
1322 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1323 on_export_all_rows_from_here();
1326 void DecodeTrace::on_export_row_with_cursor()
1328 const View *view = owner_->view();
1331 if (!view->cursors()->enabled())
1334 const double samplerate = session_.get_samplerate();
1336 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1337 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1339 const uint64_t start_sample = (uint64_t)max(
1340 0.0, start_time.convert_to<double>() * samplerate);
1341 const uint64_t end_sample = (uint64_t)max(
1342 0.0, end_time.convert_to<double>() * samplerate);
1344 // Are both cursors negative and thus were clamped to 0?
1345 if ((start_sample == 0) && (end_sample == 0))
1348 selected_sample_range_ = make_pair(start_sample, end_sample);
1349 on_export_row_from_here();
1352 void DecodeTrace::on_export_all_rows_with_cursor()
1354 const View *view = owner_->view();
1357 if (!view->cursors()->enabled())
1360 const double samplerate = session_.get_samplerate();
1362 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1363 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1365 const uint64_t start_sample = (uint64_t)max(
1366 0.0, start_time.convert_to<double>() * samplerate);
1367 const uint64_t end_sample = (uint64_t)max(
1368 0.0, end_time.convert_to<double>() * samplerate);
1370 // Are both cursors negative and thus were clamped to 0?
1371 if ((start_sample == 0) && (end_sample == 0))
1374 selected_sample_range_ = make_pair(start_sample, end_sample);
1375 on_export_all_rows_from_here();
1378 void DecodeTrace::on_export_row_from_here()
1380 using namespace pv::data::decode;
1385 vector<Annotation> *annotations = new vector<Annotation>();
1387 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1388 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1390 if (annotations->empty())
1393 export_annotations(annotations);
1397 void DecodeTrace::on_export_all_rows_from_here()
1399 using namespace pv::data::decode;
1401 vector<Annotation> *annotations = new vector<Annotation>();
1403 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1404 selected_sample_range_.first, selected_sample_range_.second);
1406 if (!annotations->empty())
1407 export_annotations(annotations);
1412 } // namespace trace
1413 } // namespace views