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));
216 if (r.currently_visible) {
217 draw_annotations(annotations, p, annotation_height, pp, y,
218 get_row_color(r.decode_row.index()), r.title_width);
224 draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
226 if (visible_rows_ > max_visible_rows_) {
227 max_visible_rows_ = visible_rows_;
229 // Call order is important, otherwise the lazy event handler won't work
230 owner_->extents_changed(false, true);
231 owner_->row_item_appearance_changed(false, true);
234 const QString err = decode_signal_->error_message();
236 draw_error(p, err, pp);
239 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
241 unsigned int y = get_visual_y();
243 for (const RowData& r : rows_) {
244 if (!r.currently_visible)
247 p.setPen(QPen(Qt::NoPen));
249 if (r.expand_marker_highlighted)
250 p.setBrush(QApplication::palette().brush(QPalette::HighlightedText));
252 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
254 // Draw expansion marker
255 const QPointF points[] = {
256 QPointF(pp.left(), y - ArrowSize),
257 QPointF(pp.left() + ArrowSize, y),
258 QPointF(pp.left(), y + ArrowSize)
260 p.drawPolygon(points, countof(points));
262 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
264 const QRect text_rect(pp.left() + ArrowSize * 2, y - r.height / 2,
265 pp.right() - pp.left(), r.height);
266 const QString h(r.decode_row.title());
267 const int f = Qt::AlignLeft | Qt::AlignVCenter |
271 p.setPen(QApplication::palette().color(QPalette::Base));
272 for (int dx = -1; dx <= 1; dx++)
273 for (int dy = -1; dy <= 1; dy++)
274 if (dx != 0 && dy != 0)
275 p.drawText(text_rect.translated(dx, dy), f, h);
278 p.setPen(QApplication::palette().color(QPalette::WindowText));
279 p.drawText(text_rect, f, h);
284 if (show_hover_marker_)
285 paint_hover_marker(p);
288 void DecodeTrace::update_stack_button()
290 const vector< shared_ptr<data::decode::Decoder> > &stack = decode_signal_->decoder_stack();
292 // Only show decoders in the menu that can be stacked onto the last one in the stack
293 if (!stack.empty()) {
294 const srd_decoder* d = stack.back()->decoder();
297 pv::widgets::DecoderMenu *const decoder_menu =
298 new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data));
299 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
300 this, SLOT(on_stack_decoder(srd_decoder*)));
302 decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }");
304 stack_button_->setMenu(decoder_menu);
305 stack_button_->show();
310 // No decoders available for stacking
311 stack_button_->setMenu(nullptr);
312 stack_button_->hide();
315 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
317 using pv::data::decode::Decoder;
321 // Add the standard options
322 Trace::populate_popup_form(parent, form);
324 // Add the decoder options
326 channel_id_map_.clear();
327 init_state_map_.clear();
328 decoder_forms_.clear();
330 const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
333 QLabel *const l = new QLabel(
334 tr("<p><i>No decoders in the stack</i></p>"));
335 l->setAlignment(Qt::AlignCenter);
338 auto iter = stack.cbegin();
339 for (int i = 0; i < (int)stack.size(); i++, iter++) {
340 shared_ptr<Decoder> dec(*iter);
341 create_decoder_form(i, dec, parent, form);
344 form->addRow(new QLabel(
345 tr("<i>* Required channels</i>"), parent));
348 // Add stacking button
349 stack_button_ = new QPushButton(tr("Stack Decoder"), parent);
350 stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one"));
351 update_stack_button();
353 QHBoxLayout *stack_button_box = new QHBoxLayout;
354 stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight);
355 form->addRow(stack_button_box);
358 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
360 QMenu *const menu = Trace::create_header_context_menu(parent);
362 menu->addSeparator();
364 QAction *const del = new QAction(tr("Delete"), this);
365 del->setShortcuts(QKeySequence::Delete);
366 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
367 menu->addAction(del);
372 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
374 // Get entries from default menu before adding our own
375 QMenu *const menu = new QMenu(parent);
377 QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
379 for (QAction *action : default_menu->actions()) { // clazy:exclude=range-loop
380 menu->addAction(action);
381 if (action->parent() == default_menu)
382 action->setParent(menu);
386 // Add separator if needed
387 if (menu->actions().length() > 0)
388 menu->addSeparator();
391 selected_row_ = nullptr;
392 const RowData* r = get_row_at_point(click_pos);
394 selected_row_ = &(r->decode_row);
396 const View *const view = owner_->view();
398 QPoint pos = view->viewport()->mapFrom(parent, click_pos);
400 // Default sample range is "from here"
401 const pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pos.x(), pos.x() + 1);
402 selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
404 if (decode_signal_->is_paused()) {
405 QAction *const resume =
406 new QAction(tr("Resume decoding"), this);
407 resume->setIcon(QIcon::fromTheme("media-playback-start",
408 QIcon(":/icons/media-playback-start.png")));
409 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
410 menu->addAction(resume);
412 QAction *const pause =
413 new QAction(tr("Pause decoding"), this);
414 pause->setIcon(QIcon::fromTheme("media-playback-pause",
415 QIcon(":/icons/media-playback-pause.png")));
416 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
417 menu->addAction(pause);
420 QAction *const copy_annotation_to_clipboard =
421 new QAction(tr("Copy annotation text to clipboard"), this);
422 copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste",
423 QIcon(":/icons/edit-paste.svg")));
424 connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard()));
425 menu->addAction(copy_annotation_to_clipboard);
427 menu->addSeparator();
429 QAction *const export_all_rows =
430 new QAction(tr("Export all annotations"), this);
431 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
432 QIcon(":/icons/document-save-as.png")));
433 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
434 menu->addAction(export_all_rows);
436 QAction *const export_row =
437 new QAction(tr("Export all annotations for this row"), this);
438 export_row->setIcon(QIcon::fromTheme("document-save-as",
439 QIcon(":/icons/document-save-as.png")));
440 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
441 menu->addAction(export_row);
443 menu->addSeparator();
445 QAction *const export_all_rows_from_here =
446 new QAction(tr("Export all annotations, starting here"), this);
447 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
448 QIcon(":/icons/document-save-as.png")));
449 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
450 menu->addAction(export_all_rows_from_here);
452 QAction *const export_row_from_here =
453 new QAction(tr("Export annotations for this row, starting here"), this);
454 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
455 QIcon(":/icons/document-save-as.png")));
456 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
457 menu->addAction(export_row_from_here);
459 menu->addSeparator();
461 QAction *const export_all_rows_with_cursor =
462 new QAction(tr("Export all annotations within cursor range"), this);
463 export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
464 QIcon(":/icons/document-save-as.png")));
465 connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
466 menu->addAction(export_all_rows_with_cursor);
468 QAction *const export_row_with_cursor =
469 new QAction(tr("Export annotations for this row within cursor range"), this);
470 export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
471 QIcon(":/icons/document-save-as.png")));
472 connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
473 menu->addAction(export_row_with_cursor);
475 if (!view->cursors()->enabled()) {
476 export_all_rows_with_cursor->setEnabled(false);
477 export_row_with_cursor->setEnabled(false);
483 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
484 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
485 QColor row_color, int row_title_width)
487 using namespace pv::data::decode;
489 Annotation::Class block_class = 0;
490 bool block_class_uniform = true;
491 qreal block_start = 0;
492 int block_ann_count = 0;
494 const Annotation *prev_ann;
495 qreal prev_end = INT_MIN;
499 double samples_per_pixel, pixels_offset;
500 tie(pixels_offset, samples_per_pixel) =
501 get_pixels_offset_samples_per_pixel();
503 // Sort the annotations by start sample so that decoders
504 // can't confuse us by creating annotations out of order
505 stable_sort(annotations.begin(), annotations.end(),
506 [](const Annotation &a, const Annotation &b) {
507 return a.start_sample() < b.start_sample(); });
509 // Gather all annotations that form a visual "block" and draw them as such
510 for (const Annotation &a : annotations) {
512 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
513 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
515 const qreal a_start = abs_a_start - pixels_offset;
516 a_end = abs_a_end - pixels_offset;
518 const qreal a_width = a_end - a_start;
519 const qreal delta = a_end - prev_end;
521 bool a_is_separate = false;
523 // Annotation wider than the threshold for a useful label width?
524 if (a_width >= min_useful_label_width_) {
525 for (const QString &ann_text : a.annotations()) {
526 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
527 // Annotation wide enough to fit a label? Don't put it in a block then
529 a_is_separate = true;
535 // Were the previous and this annotation more than a pixel apart?
536 if ((abs(delta) > 1) || a_is_separate) {
537 // Block was broken, draw annotations that form the current block
538 if (block_ann_count == 1)
539 draw_annotation(*prev_ann, p, h, pp, y, row_color,
541 else if (block_ann_count > 0)
542 draw_annotation_block(block_start, prev_end, block_class,
543 block_class_uniform, p, h, y, row_color);
549 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
550 // Next annotation must start a new block. delta will be > 1
551 // because we set prev_end to INT_MIN but that's okay since
552 // block_ann_count will be 0 and nothing will be drawn
559 if (block_ann_count == 0) {
560 block_start = a_start;
561 block_class = a.ann_class();
562 block_class_uniform = true;
564 if (a.ann_class() != block_class)
565 block_class_uniform = false;
571 if (block_ann_count == 1)
572 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
573 else if (block_ann_count > 0)
574 draw_annotation_block(block_start, prev_end, block_class,
575 block_class_uniform, p, h, y, row_color);
578 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
579 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
580 QColor row_color, int row_title_width) const
582 double samples_per_pixel, pixels_offset;
583 tie(pixels_offset, samples_per_pixel) =
584 get_pixels_offset_samples_per_pixel();
586 const double start = a.start_sample() / samples_per_pixel -
588 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
590 QColor color = get_annotation_color(row_color, a.ann_class());
591 p.setPen(color.darker());
594 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
597 if (a.start_sample() == a.end_sample())
598 draw_instant(a, p, h, start, y);
600 draw_range(a, p, h, start, end, y, pp, row_title_width);
603 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
604 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
605 int y, QColor row_color) const
607 const double top = y + .5 - h / 2;
608 const double bottom = y + .5 + h / 2;
610 const QRectF rect(start, top, end - start, bottom - top);
613 p.setPen(QPen(Qt::NoPen));
614 p.setBrush(Qt::white);
615 p.drawRoundedRect(rect, r, r);
617 // If all annotations in this block are of the same type, we can use the
618 // one format that all of these annotations have. Otherwise, we should use
619 // a neutral color (i.e. gray)
620 if (use_ann_format) {
621 const QColor color = get_annotation_color(row_color, ann_class);
622 p.setPen(color.darker());
623 p.setBrush(QBrush(color, Qt::Dense4Pattern));
626 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
629 p.drawRoundedRect(rect, r, r);
632 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
633 int h, qreal x, int y) const
635 const QString text = a.annotations().empty() ?
636 QString() : a.annotations().back();
637 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
639 const QRectF rect(x - w / 2, y - h / 2, w, h);
641 p.drawRoundedRect(rect, h / 2, h / 2);
644 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
647 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
648 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
649 int row_title_width) const
651 const qreal top = y + .5 - h / 2;
652 const qreal bottom = y + .5 + h / 2;
653 const vector<QString> annotations = a.annotations();
655 // If the two ends are within 1 pixel, draw a vertical line
656 if (start + 1.0 > end) {
657 p.drawLine(QPointF(start, top), QPointF(start, bottom));
661 const qreal cap_width = min((end - start) / 4, EndCapWidth);
664 QPointF(start, y + .5f),
665 QPointF(start + cap_width, top),
666 QPointF(end - cap_width, top),
667 QPointF(end, y + .5f),
668 QPointF(end - cap_width, bottom),
669 QPointF(start + cap_width, bottom)
672 p.drawConvexPolygon(pts, countof(pts));
674 if (annotations.empty())
677 const int ann_start = start + cap_width;
678 const int ann_end = end - cap_width;
680 const int real_start = max(ann_start, pp.left() + row_title_width);
681 const int real_end = min(ann_end, pp.right());
682 const int real_width = real_end - real_start;
684 QRectF rect(real_start, y - h / 2, real_width, h);
685 if (rect.width() <= 4)
690 // Try to find an annotation that will fit
691 QString best_annotation;
694 for (const QString &a : annotations) {
695 const int w = p.boundingRect(QRectF(), 0, a).width();
696 if (w <= rect.width() && w > best_width)
697 best_annotation = a, best_width = w;
700 if (best_annotation.isEmpty())
701 best_annotation = annotations.back();
703 // If not ellide the last in the list
704 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
705 best_annotation, Qt::ElideRight, rect.width()));
708 void DecodeTrace::draw_error(QPainter &p, const QString &message,
709 const ViewItemPaintParams &pp)
711 const int y = get_visual_y();
713 double samples_per_pixel, pixels_offset;
714 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
716 p.setPen(ErrorBgColor.darker());
717 p.setBrush(ErrorBgColor);
719 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
721 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
722 const qreal r = text_rect.height() / 4;
724 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
727 p.drawText(text_rect, message);
730 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
732 using namespace pv::data;
733 using pv::data::decode::Decoder;
735 double samples_per_pixel, pixels_offset;
737 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
738 if (sample_count == 0)
741 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
742 if (sample_count == samples_decoded)
745 const int y = get_visual_y();
747 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
749 const double start = max(samples_decoded /
750 samples_per_pixel - pixels_offset, left - 1.0);
751 const double end = min(sample_count / samples_per_pixel -
752 pixels_offset, right + 1.0);
753 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
755 p.setPen(QPen(Qt::NoPen));
756 p.setBrush(Qt::white);
757 p.drawRect(no_decode_rect);
759 p.setPen(NoDecodeColor);
760 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
761 p.drawRect(no_decode_rect);
764 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
768 const View *view = owner_->view();
771 const double scale = view->scale();
774 const double pixels_offset =
775 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
777 double samplerate = decode_signal_->samplerate();
779 // Show sample rate as 1Hz when it is unknown
780 if (samplerate == 0.0)
783 return make_pair(pixels_offset, samplerate * scale);
786 pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
787 int x_start, int x_end) const
789 double samples_per_pixel, pixels_offset;
790 tie(pixels_offset, samples_per_pixel) =
791 get_pixels_offset_samples_per_pixel();
793 const uint64_t start = (uint64_t)max(
794 (x_start + pixels_offset) * samples_per_pixel, 0.0);
795 const uint64_t end = (uint64_t)max(
796 (x_end + pixels_offset) * samples_per_pixel, 0.0);
798 return make_pair(start, end);
801 QColor DecodeTrace::get_row_color(int row_index) const
803 // For each row color, use the base color hue and add an offset that's
804 // not a dividend of 360
807 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
808 const int s = DECODETRACE_COLOR_SATURATION;
809 const int v = DECODETRACE_COLOR_VALUE;
810 color.setHsl(h, s, v);
815 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
817 // For each row color, use the base color hue and add an offset that's
818 // not a dividend of 360 and not a multiple of the row offset
820 QColor color(row_color);
821 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
822 const int s = DECODETRACE_COLOR_SATURATION;
823 const int v = DECODETRACE_COLOR_VALUE;
824 color.setHsl(h, s, v);
829 unsigned int DecodeTrace::get_row_y(const RowData* row) const
833 unsigned int y = get_visual_y();
835 for (const RowData& r : rows_)
844 RowData* DecodeTrace::get_row_at_point(const QPoint &point)
846 int y = get_visual_y();
848 for (RowData& r : rows_) {
849 if (!r.currently_visible)
852 if ((point.y() >= y) && (point.y() < (int)(y + r.height)))
861 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
863 using namespace pv::data::decode;
868 const pair<uint64_t, uint64_t> sample_range =
869 get_view_sample_range(point.x(), point.x() + 1);
870 const RowData* r = get_row_at_point(point);
875 vector<Annotation> annotations;
877 decode_signal_->get_annotation_subset(annotations, r->decode_row,
878 current_segment_, sample_range.first, sample_range.second);
880 return (annotations.empty()) ?
881 QString() : annotations[0].annotations().front();
884 void DecodeTrace::hover_point_changed(const QPoint &hp)
886 Trace::hover_point_changed(hp);
890 RowData* hover_row = get_row_at_point(hp);
892 // Row/class visibility button handling
893 for (RowData& r : rows_)
894 r.expand_marker_highlighted = false;
897 int row_y = get_row_y(hover_row);
898 if ((hp.x() > 0) && (hp.x() < ArrowSize) &&
899 (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize)))
900 hover_row->expand_marker_highlighted = true;
905 QString ann = get_annotation_at_point(hp);
908 QToolTip::hideText();
912 QFontMetrics m(QToolTip::font());
913 const QRect text_size = m.boundingRect(QRect(), 0, ann);
915 // This is OS-specific and unfortunately we can't query it, so
916 // use an approximation to at least try to minimize the error.
917 const int padding = 8;
919 // Make sure the tool tip doesn't overlap with the mouse cursor.
920 // If it did, the tool tip would constantly hide and re-appear.
921 // We also push it up by one row so that it appears above the
922 // decode trace, not below.
924 p.setX(hp.x() - (text_size.width() / 2) - padding);
926 p.setY(get_row_y(hover_row) - hover_row->height - default_row_height_ -
927 text_size.height() - padding);
929 const View *const view = owner_->view();
931 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
934 QToolTip::hideText();
937 void DecodeTrace::create_decoder_form(int index,
938 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
941 GlobalSettings settings;
944 const srd_decoder *const decoder = dec->decoder();
947 const bool decoder_deletable = index > 0;
949 pv::widgets::DecoderGroupBox *const group =
950 new pv::widgets::DecoderGroupBox(
951 QString::fromUtf8(decoder->name),
952 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
953 QString::fromUtf8(decoder->desc)),
954 nullptr, decoder_deletable);
955 group->set_decoder_visible(dec->shown());
957 if (decoder_deletable) {
958 delete_mapper_.setMapping(group, index);
959 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
962 show_hide_mapper_.setMapping(group, index);
963 connect(group, SIGNAL(show_hide_decoder()),
964 &show_hide_mapper_, SLOT(map()));
966 QFormLayout *const decoder_form = new QFormLayout;
967 group->add_layout(decoder_form);
969 const vector<DecodeChannel> channels = decode_signal_->get_channels();
972 for (const DecodeChannel& ch : channels) {
973 // Ignore channels not part of the decoder we create the form for
974 if (ch.decoder_ != dec)
977 QComboBox *const combo = create_channel_selector(parent, &ch);
978 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
980 channel_id_map_[combo] = ch.id;
981 init_state_map_[combo_init_state] = ch.id;
983 connect(combo, SIGNAL(currentIndexChanged(int)),
984 this, SLOT(on_channel_selected(int)));
985 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
986 this, SLOT(on_init_state_changed(int)));
988 QHBoxLayout *const hlayout = new QHBoxLayout;
989 hlayout->addWidget(combo);
990 hlayout->addWidget(combo_init_state);
992 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
993 combo_init_state->hide();
995 const QString required_flag = ch.is_optional ? QString() : QString("*");
996 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
997 .arg(ch.name, ch.desc, required_flag), hlayout);
1001 shared_ptr<binding::Decoder> binding(
1002 new binding::Decoder(decode_signal_, dec));
1003 binding->add_properties_to_form(decoder_form, true);
1005 bindings_.push_back(binding);
1007 form->addRow(group);
1008 decoder_forms_.push_back(group);
1011 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
1013 const auto sigs(session_.signalbases());
1015 // Sort signals in natural order
1016 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
1017 sort(sig_list.begin(), sig_list.end(),
1018 [](const shared_ptr<data::SignalBase> &a,
1019 const shared_ptr<data::SignalBase> &b) {
1020 return strnatcasecmp(a->name().toStdString(),
1021 b->name().toStdString()) < 0; });
1023 QComboBox *selector = new QComboBox(parent);
1025 selector->addItem("-", qVariantFromValue((void*)nullptr));
1027 if (!ch->assigned_signal)
1028 selector->setCurrentIndex(0);
1030 for (const shared_ptr<data::SignalBase> &b : sig_list) {
1032 if (b->logic_data() && b->enabled()) {
1033 selector->addItem(b->name(),
1034 qVariantFromValue((void*)b.get()));
1036 if (ch->assigned_signal == b.get())
1037 selector->setCurrentIndex(selector->count() - 1);
1044 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
1045 const DecodeChannel *ch)
1047 QComboBox *selector = new QComboBox(parent);
1049 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
1050 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
1051 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
1053 selector->setCurrentIndex(ch->initial_pin_state);
1055 selector->setToolTip("Initial (assumed) pin value before the first sample");
1060 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
1062 using namespace pv::data::decode;
1064 GlobalSettings settings;
1065 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
1067 const QString file_name = QFileDialog::getSaveFileName(
1068 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1070 if (file_name.isEmpty())
1073 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1074 const QString quote = format.contains("%q") ? "\"" : "";
1075 format = format.remove("%q");
1077 QFile file(file_name);
1078 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1079 QTextStream out_stream(&file);
1081 for (Annotation &ann : *annotations) {
1082 const QString sample_range = QString("%1-%2") \
1083 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
1085 const QString class_name = quote + ann.row()->class_name() + quote;
1087 QString all_ann_text;
1088 for (const QString &s : ann.annotations())
1089 all_ann_text = all_ann_text + quote + s + quote + ",";
1090 all_ann_text.chop(1);
1092 const QString first_ann_text = quote + ann.annotations().front() + quote;
1094 QString out_text = format;
1095 out_text = out_text.replace("%s", sample_range);
1096 out_text = out_text.replace("%d",
1097 quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
1098 out_text = out_text.replace("%c", class_name);
1099 out_text = out_text.replace("%1", first_ann_text);
1100 out_text = out_text.replace("%a", all_ann_text);
1101 out_stream << out_text << '\n';
1104 if (out_stream.status() == QTextStream::Ok)
1108 QMessageBox msg(owner_->view());
1109 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1110 msg.setStandardButtons(QMessageBox::Ok);
1111 msg.setIcon(QMessageBox::Warning);
1115 void DecodeTrace::update_rows()
1117 lock_guard<mutex> lock(row_modification_mutex_);
1119 QFontMetrics m(QApplication::font());
1121 for (RowData& r : rows_)
1124 for (const Row& decode_row : decode_signal_->get_rows()) {
1125 // Find row in our list
1126 auto r_it = find_if(rows_.begin(), rows_.end(),
1127 [&](RowData& r){ return r.decode_row == decode_row; });
1129 RowData* r = nullptr;
1130 if (r_it == rows_.end()) {
1131 // Row doesn't exist yet, create and append it
1133 nr.decode_row = decode_row;
1134 nr.height = default_row_height_;
1135 nr.currently_visible = false;
1136 nr.expand_marker_highlighted = false;
1137 nr.expanded = false;
1139 rows_.push_back(nr);
1146 const int w = m.boundingRect(r->decode_row.title()).width() + RowTitleMargin;
1150 // Remove any rows that no longer exist, obeying that iterators are invalidated
1155 for (unsigned int i = 0; i < rows_.size(); i++)
1156 if (!rows_[i].exists) {
1157 rows_.erase(rows_.begin() + i);
1161 } while (any_exists);
1164 void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
1166 Trace::on_setting_changed(key, value);
1168 if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
1169 max_visible_rows_ = 0;
1170 always_show_all_rows_ = value.toBool();
1174 void DecodeTrace::on_new_annotations()
1176 if (!delayed_trace_updater_.isActive())
1177 delayed_trace_updater_.start();
1180 void DecodeTrace::on_delayed_trace_update()
1183 owner_->row_item_appearance_changed(false, true);
1186 void DecodeTrace::on_decode_reset()
1188 max_visible_rows_ = 0;
1192 owner_->row_item_appearance_changed(false, true);
1195 void DecodeTrace::on_decode_finished()
1198 owner_->row_item_appearance_changed(false, true);
1201 void DecodeTrace::on_pause_decode()
1203 if (decode_signal_->is_paused())
1204 decode_signal_->resume_decode();
1206 decode_signal_->pause_decode();
1209 void DecodeTrace::delete_pressed()
1214 void DecodeTrace::on_delete()
1216 session_.remove_decode_signal(decode_signal_);
1219 void DecodeTrace::on_channel_selected(int)
1221 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1223 // Determine signal that was selected
1224 const data::SignalBase *signal =
1225 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1227 // Determine decode channel ID this combo box is the channel selector for
1228 const uint16_t id = channel_id_map_.at(cb);
1230 decode_signal_->assign_signal(id, signal);
1233 void DecodeTrace::on_channels_updated()
1236 owner_->row_item_appearance_changed(false, true);
1239 void DecodeTrace::on_init_state_changed(int)
1241 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1243 // Determine inital pin state that was selected
1244 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1246 // Determine decode channel ID this combo box is the channel selector for
1247 const uint16_t id = init_state_map_.at(cb);
1249 decode_signal_->set_initial_pin_state(id, init_state);
1252 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1254 decode_signal_->stack_decoder(decoder);
1257 create_popup_form();
1260 void DecodeTrace::on_delete_decoder(int index)
1262 decode_signal_->remove_decoder(index);
1265 // Force re-calculation of the trace height
1266 max_visible_rows_ = 0;
1267 owner_->extents_changed(false, true);
1269 create_popup_form();
1272 void DecodeTrace::on_show_hide_decoder(int index)
1274 const bool state = decode_signal_->toggle_decoder_visibility(index);
1276 assert(index < (int)decoder_forms_.size());
1277 decoder_forms_[index]->set_decoder_visible(state);
1280 // Force re-calculation of the trace height, see paint_mid()
1281 max_visible_rows_ = 0;
1282 owner_->extents_changed(false, true);
1286 owner_->row_item_appearance_changed(false, true);
1289 void DecodeTrace::on_copy_annotation_to_clipboard()
1291 using namespace pv::data::decode;
1296 vector<Annotation> *annotations = new vector<Annotation>();
1298 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1299 current_segment_, selected_sample_range_.first, selected_sample_range_.first);
1301 if (annotations->empty())
1304 QClipboard *clipboard = QApplication::clipboard();
1305 clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard);
1307 if (clipboard->supportsSelection())
1308 clipboard->setText(annotations->front().annotations().front(), QClipboard::Selection);
1313 void DecodeTrace::on_export_row()
1315 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1316 on_export_row_from_here();
1319 void DecodeTrace::on_export_all_rows()
1321 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1322 on_export_all_rows_from_here();
1325 void DecodeTrace::on_export_row_with_cursor()
1327 const View *view = owner_->view();
1330 if (!view->cursors()->enabled())
1333 const double samplerate = session_.get_samplerate();
1335 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1336 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1338 const uint64_t start_sample = (uint64_t)max(
1339 0.0, start_time.convert_to<double>() * samplerate);
1340 const uint64_t end_sample = (uint64_t)max(
1341 0.0, end_time.convert_to<double>() * samplerate);
1343 // Are both cursors negative and thus were clamped to 0?
1344 if ((start_sample == 0) && (end_sample == 0))
1347 selected_sample_range_ = make_pair(start_sample, end_sample);
1348 on_export_row_from_here();
1351 void DecodeTrace::on_export_all_rows_with_cursor()
1353 const View *view = owner_->view();
1356 if (!view->cursors()->enabled())
1359 const double samplerate = session_.get_samplerate();
1361 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1362 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1364 const uint64_t start_sample = (uint64_t)max(
1365 0.0, start_time.convert_to<double>() * samplerate);
1366 const uint64_t end_sample = (uint64_t)max(
1367 0.0, end_time.convert_to<double>() * samplerate);
1369 // Are both cursors negative and thus were clamped to 0?
1370 if ((start_sample == 0) && (end_sample == 0))
1373 selected_sample_range_ = make_pair(start_sample, end_sample);
1374 on_export_all_rows_from_here();
1377 void DecodeTrace::on_export_row_from_here()
1379 using namespace pv::data::decode;
1384 vector<Annotation> *annotations = new vector<Annotation>();
1386 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1387 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1389 if (annotations->empty())
1392 export_annotations(annotations);
1396 void DecodeTrace::on_export_all_rows_from_here()
1398 using namespace pv::data::decode;
1400 vector<Annotation> *annotations = new vector<Annotation>();
1402 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1403 selected_sample_range_.first, selected_sample_range_.second);
1405 if (!annotations->empty())
1406 export_annotations(annotations);
1411 } // namespace trace
1412 } // namespace views