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>
64 using std::numeric_limits;
65 using std::out_of_range;
67 using std::shared_ptr;
71 using pv::data::decode::Annotation;
72 using pv::data::decode::Row;
73 using pv::data::decode::DecodeChannel;
74 using pv::data::DecodeSignal;
81 #define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
82 #define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
84 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
85 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
87 const int DecodeTrace::ArrowSize = 4;
88 const double DecodeTrace::EndCapWidth = 5;
89 const int DecodeTrace::RowTitleMargin = 10;
90 const int DecodeTrace::DrawPadding = 100;
92 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
94 DecodeTrace::DecodeTrace(pv::Session &session,
95 shared_ptr<data::SignalBase> signalbase, int index) :
100 delete_mapper_(this),
101 show_hide_mapper_(this)
103 decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
105 GlobalSettings settings;
106 always_show_all_rows_ = settings.value(GlobalSettings::Key_Dec_AlwaysShowAllRows).toBool();
108 GlobalSettings::add_change_handler(this);
110 // Determine shortest string we want to see displayed in full
111 QFontMetrics m(QApplication::font());
112 min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
114 // For the base color, we want to start at a very different color for
115 // every decoder stack, so multiply the index with a number that is
116 // rather close to 180 degrees of the color circle but not a dividend of 360
117 // Note: The offset equals the color of the first annotation
119 const int h = (120 + 160 * index) % 360;
120 const int s = DECODETRACE_COLOR_SATURATION;
121 const int v = DECODETRACE_COLOR_VALUE;
122 color.setHsv(h, s, v);
123 base_->set_color(color);
125 connect(decode_signal_.get(), SIGNAL(new_annotations()),
126 this, SLOT(on_new_annotations()));
127 connect(decode_signal_.get(), SIGNAL(decode_reset()),
128 this, SLOT(on_decode_reset()));
129 connect(decode_signal_.get(), SIGNAL(decode_finished()),
130 this, SLOT(on_decode_finished()));
131 connect(decode_signal_.get(), SIGNAL(channels_updated()),
132 this, SLOT(on_channels_updated()));
134 connect(&delete_mapper_, SIGNAL(mapped(int)),
135 this, SLOT(on_delete_decoder(int)));
136 connect(&show_hide_mapper_, SIGNAL(mapped(int)),
137 this, SLOT(on_show_hide_decoder(int)));
139 connect(&delayed_trace_updater_, SIGNAL(timeout()),
140 this, SLOT(on_delayed_trace_update()));
141 delayed_trace_updater_.setSingleShot(true);
142 delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
145 DecodeTrace::~DecodeTrace()
147 GlobalSettings::remove_change_handler(this);
150 bool DecodeTrace::enabled() const
155 shared_ptr<data::SignalBase> DecodeTrace::base() const
160 pair<int, int> DecodeTrace::v_extents() const
162 const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
164 // Make an empty decode trace appear symmetrical
165 const int row_count = max(1, max_visible_rows_);
167 return make_pair(-row_height, row_height * row_count);
170 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
172 Trace::paint_back(p, pp);
173 paint_axis(p, pp, get_visual_y());
176 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
178 const int text_height = ViewItemPaintParams::text_height();
179 row_height_ = (text_height * 6) / 4;
180 const int annotation_height = (text_height * 5) / 4;
182 // Set default pen to allow for text width calculation
185 // Iterate through the rows
186 int y = get_visual_y();
187 pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pp.left(), pp.right());
189 // Just because the view says we see a certain sample range it
190 // doesn't mean we have this many decoded samples, too, so crop
191 // the range to what has been decoded already
192 sample_range.second = min((int64_t)sample_range.second,
193 decode_signal_->get_decoded_sample_count(current_segment_, false));
195 const vector<Row> rows = decode_signal_->get_rows();
197 visible_rows_.clear();
198 for (const Row& row : rows) {
199 // Cache the row title widths
201 auto cached_width = row_title_widths_.find(row);
203 if (cached_width != row_title_widths_.end())
204 row_title_width = cached_width->second;
206 const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
208 row_title_widths_[row] = w;
212 vector<Annotation> annotations;
213 decode_signal_->get_annotation_subset(annotations, row,
214 current_segment_, sample_range.first, sample_range.second);
216 // Show row if there are visible annotations or when user wants to see
217 // all rows that have annotations somewhere and this one is one of them
218 bool row_visible = !annotations.empty() ||
219 (always_show_all_rows_ && (decode_signal_->get_annotation_count(row, current_segment_) > 0));
222 draw_annotations(annotations, p, annotation_height, pp, y,
223 get_row_color(row.index()), row_title_width);
225 visible_rows_.push_back(row);
229 draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
231 if ((int)visible_rows_.size() > max_visible_rows_) {
232 max_visible_rows_ = (int)visible_rows_.size();
234 // Call order is important, otherwise the lazy event handler won't work
235 owner_->extents_changed(false, true);
236 owner_->row_item_appearance_changed(false, true);
239 const QString err = decode_signal_->error_message();
241 draw_error(p, err, pp);
244 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
248 for (size_t i = 0; i < visible_rows_.size(); i++) {
249 const int y = i * row_height_ + get_visual_y();
251 p.setPen(QPen(Qt::NoPen));
252 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
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));
263 const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
264 pp.right() - pp.left(), row_height_);
265 const QString h(visible_rows_[i].title());
266 const int f = Qt::AlignLeft | Qt::AlignVCenter |
270 p.setPen(QApplication::palette().color(QPalette::Base));
271 for (int dx = -1; dx <= 1; dx++)
272 for (int dy = -1; dy <= 1; dy++)
273 if (dx != 0 && dy != 0)
274 p.drawText(r.translated(dx, dy), f, h);
277 p.setPen(QApplication::palette().color(QPalette::WindowText));
281 if (show_hover_marker_)
282 paint_hover_marker(p);
285 void DecodeTrace::update_stack_button()
287 const vector< shared_ptr<data::decode::Decoder> > &stack = decode_signal_->decoder_stack();
289 // Only show decoders in the menu that can be stacked onto the last one in the stack
290 if (!stack.empty()) {
291 const srd_decoder* d = stack.back()->decoder();
294 pv::widgets::DecoderMenu *const decoder_menu =
295 new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data));
296 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
297 this, SLOT(on_stack_decoder(srd_decoder*)));
299 decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }");
301 stack_button_->setMenu(decoder_menu);
302 stack_button_->show();
307 // No decoders available for stacking
308 stack_button_->setMenu(nullptr);
309 stack_button_->hide();
312 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
314 using pv::data::decode::Decoder;
318 // Add the standard options
319 Trace::populate_popup_form(parent, form);
321 // Add the decoder options
323 channel_id_map_.clear();
324 init_state_map_.clear();
325 decoder_forms_.clear();
327 const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
330 QLabel *const l = new QLabel(
331 tr("<p><i>No decoders in the stack</i></p>"));
332 l->setAlignment(Qt::AlignCenter);
335 auto iter = stack.cbegin();
336 for (int i = 0; i < (int)stack.size(); i++, iter++) {
337 shared_ptr<Decoder> dec(*iter);
338 create_decoder_form(i, dec, parent, form);
341 form->addRow(new QLabel(
342 tr("<i>* Required channels</i>"), parent));
345 // Add stacking button
346 stack_button_ = new QPushButton(tr("Stack Decoder"), parent);
347 stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one"));
348 update_stack_button();
350 QHBoxLayout *stack_button_box = new QHBoxLayout;
351 stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight);
352 form->addRow(stack_button_box);
355 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
357 QMenu *const menu = Trace::create_header_context_menu(parent);
359 menu->addSeparator();
361 QAction *const del = new QAction(tr("Delete"), this);
362 del->setShortcuts(QKeySequence::Delete);
363 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
364 menu->addAction(del);
369 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
371 // Get entries from default menu before adding our own
372 QMenu *const menu = new QMenu(parent);
374 QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
376 for (QAction *action : default_menu->actions()) { // clazy:exclude=range-loop
377 menu->addAction(action);
378 if (action->parent() == default_menu)
379 action->setParent(menu);
383 // Add separator if needed
384 if (menu->actions().length() > 0)
385 menu->addSeparator();
389 selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
390 } catch (out_of_range&) {
391 selected_row_ = nullptr;
394 const View *const view = owner_->view();
396 QPoint pos = view->viewport()->mapFrom(parent, click_pos);
398 // Default sample range is "from here"
399 const pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pos.x(), pos.x() + 1);
400 selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
402 if (decode_signal_->is_paused()) {
403 QAction *const resume =
404 new QAction(tr("Resume decoding"), this);
405 resume->setIcon(QIcon::fromTheme("media-playback-start",
406 QIcon(":/icons/media-playback-start.png")));
407 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
408 menu->addAction(resume);
410 QAction *const pause =
411 new QAction(tr("Pause decoding"), this);
412 pause->setIcon(QIcon::fromTheme("media-playback-pause",
413 QIcon(":/icons/media-playback-pause.png")));
414 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
415 menu->addAction(pause);
418 QAction *const copy_annotation_to_clipboard =
419 new QAction(tr("Copy annotation text to clipboard"), this);
420 copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste",
421 QIcon(":/icons/edit-paste.svg")));
422 connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard()));
423 menu->addAction(copy_annotation_to_clipboard);
425 menu->addSeparator();
427 QAction *const export_all_rows =
428 new QAction(tr("Export all annotations"), this);
429 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
430 QIcon(":/icons/document-save-as.png")));
431 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
432 menu->addAction(export_all_rows);
434 QAction *const export_row =
435 new QAction(tr("Export all annotations for this row"), this);
436 export_row->setIcon(QIcon::fromTheme("document-save-as",
437 QIcon(":/icons/document-save-as.png")));
438 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
439 menu->addAction(export_row);
441 menu->addSeparator();
443 QAction *const export_all_rows_from_here =
444 new QAction(tr("Export all annotations, starting here"), this);
445 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
446 QIcon(":/icons/document-save-as.png")));
447 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
448 menu->addAction(export_all_rows_from_here);
450 QAction *const export_row_from_here =
451 new QAction(tr("Export annotations for this row, starting here"), this);
452 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
453 QIcon(":/icons/document-save-as.png")));
454 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
455 menu->addAction(export_row_from_here);
457 menu->addSeparator();
459 QAction *const export_all_rows_with_cursor =
460 new QAction(tr("Export all annotations within cursor range"), this);
461 export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
462 QIcon(":/icons/document-save-as.png")));
463 connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
464 menu->addAction(export_all_rows_with_cursor);
466 QAction *const export_row_with_cursor =
467 new QAction(tr("Export annotations for this row within cursor range"), this);
468 export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
469 QIcon(":/icons/document-save-as.png")));
470 connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
471 menu->addAction(export_row_with_cursor);
473 if (!view->cursors()->enabled()) {
474 export_all_rows_with_cursor->setEnabled(false);
475 export_row_with_cursor->setEnabled(false);
481 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
482 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
483 QColor row_color, int row_title_width)
485 using namespace pv::data::decode;
487 Annotation::Class block_class = 0;
488 bool block_class_uniform = true;
489 qreal block_start = 0;
490 int block_ann_count = 0;
492 const Annotation *prev_ann;
493 qreal prev_end = INT_MIN;
497 double samples_per_pixel, pixels_offset;
498 tie(pixels_offset, samples_per_pixel) =
499 get_pixels_offset_samples_per_pixel();
501 // Sort the annotations by start sample so that decoders
502 // can't confuse us by creating annotations out of order
503 stable_sort(annotations.begin(), annotations.end(),
504 [](const Annotation &a, const Annotation &b) {
505 return a.start_sample() < b.start_sample(); });
507 // Gather all annotations that form a visual "block" and draw them as such
508 for (const Annotation &a : annotations) {
510 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
511 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
513 const qreal a_start = abs_a_start - pixels_offset;
514 a_end = abs_a_end - pixels_offset;
516 const qreal a_width = a_end - a_start;
517 const qreal delta = a_end - prev_end;
519 bool a_is_separate = false;
521 // Annotation wider than the threshold for a useful label width?
522 if (a_width >= min_useful_label_width_) {
523 for (const QString &ann_text : a.annotations()) {
524 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
525 // Annotation wide enough to fit a label? Don't put it in a block then
527 a_is_separate = true;
533 // Were the previous and this annotation more than a pixel apart?
534 if ((abs(delta) > 1) || a_is_separate) {
535 // Block was broken, draw annotations that form the current block
536 if (block_ann_count == 1)
537 draw_annotation(*prev_ann, p, h, pp, y, row_color,
539 else if (block_ann_count > 0)
540 draw_annotation_block(block_start, prev_end, block_class,
541 block_class_uniform, p, h, y, row_color);
547 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
548 // Next annotation must start a new block. delta will be > 1
549 // because we set prev_end to INT_MIN but that's okay since
550 // block_ann_count will be 0 and nothing will be drawn
557 if (block_ann_count == 0) {
558 block_start = a_start;
559 block_class = a.ann_class();
560 block_class_uniform = true;
562 if (a.ann_class() != block_class)
563 block_class_uniform = false;
569 if (block_ann_count == 1)
570 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
571 else if (block_ann_count > 0)
572 draw_annotation_block(block_start, prev_end, block_class,
573 block_class_uniform, p, h, y, row_color);
576 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
577 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
578 QColor row_color, int row_title_width) const
580 double samples_per_pixel, pixels_offset;
581 tie(pixels_offset, samples_per_pixel) =
582 get_pixels_offset_samples_per_pixel();
584 const double start = a.start_sample() / samples_per_pixel -
586 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
588 QColor color = get_annotation_color(row_color, a.ann_class());
589 p.setPen(color.darker());
592 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
595 if (a.start_sample() == a.end_sample())
596 draw_instant(a, p, h, start, y);
598 draw_range(a, p, h, start, end, y, pp, row_title_width);
601 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
602 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
603 int y, QColor row_color) const
605 const double top = y + .5 - h / 2;
606 const double bottom = y + .5 + h / 2;
608 const QRectF rect(start, top, end - start, bottom - top);
611 p.setPen(QPen(Qt::NoPen));
612 p.setBrush(Qt::white);
613 p.drawRoundedRect(rect, r, r);
615 // If all annotations in this block are of the same type, we can use the
616 // one format that all of these annotations have. Otherwise, we should use
617 // a neutral color (i.e. gray)
618 if (use_ann_format) {
619 const QColor color = get_annotation_color(row_color, ann_class);
620 p.setPen(color.darker());
621 p.setBrush(QBrush(color, Qt::Dense4Pattern));
624 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
627 p.drawRoundedRect(rect, r, r);
630 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
631 int h, qreal x, int y) const
633 const QString text = a.annotations().empty() ?
634 QString() : a.annotations().back();
635 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
637 const QRectF rect(x - w / 2, y - h / 2, w, h);
639 p.drawRoundedRect(rect, h / 2, h / 2);
642 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
645 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
646 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
647 int row_title_width) const
649 const qreal top = y + .5 - h / 2;
650 const qreal bottom = y + .5 + h / 2;
651 const vector<QString> annotations = a.annotations();
653 // If the two ends are within 1 pixel, draw a vertical line
654 if (start + 1.0 > end) {
655 p.drawLine(QPointF(start, top), QPointF(start, bottom));
659 const qreal cap_width = min((end - start) / 4, EndCapWidth);
662 QPointF(start, y + .5f),
663 QPointF(start + cap_width, top),
664 QPointF(end - cap_width, top),
665 QPointF(end, y + .5f),
666 QPointF(end - cap_width, bottom),
667 QPointF(start + cap_width, bottom)
670 p.drawConvexPolygon(pts, countof(pts));
672 if (annotations.empty())
675 const int ann_start = start + cap_width;
676 const int ann_end = end - cap_width;
678 const int real_start = max(ann_start, pp.left() + row_title_width);
679 const int real_end = min(ann_end, pp.right());
680 const int real_width = real_end - real_start;
682 QRectF rect(real_start, y - h / 2, real_width, h);
683 if (rect.width() <= 4)
688 // Try to find an annotation that will fit
689 QString best_annotation;
692 for (const QString &a : annotations) {
693 const int w = p.boundingRect(QRectF(), 0, a).width();
694 if (w <= rect.width() && w > best_width)
695 best_annotation = a, best_width = w;
698 if (best_annotation.isEmpty())
699 best_annotation = annotations.back();
701 // If not ellide the last in the list
702 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
703 best_annotation, Qt::ElideRight, rect.width()));
706 void DecodeTrace::draw_error(QPainter &p, const QString &message,
707 const ViewItemPaintParams &pp)
709 const int y = get_visual_y();
711 double samples_per_pixel, pixels_offset;
712 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
714 p.setPen(ErrorBgColor.darker());
715 p.setBrush(ErrorBgColor);
717 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
719 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
720 const qreal r = text_rect.height() / 4;
722 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
725 p.drawText(text_rect, message);
728 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
730 using namespace pv::data;
731 using pv::data::decode::Decoder;
733 double samples_per_pixel, pixels_offset;
735 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
736 if (sample_count == 0)
739 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
740 if (sample_count == samples_decoded)
743 const int y = get_visual_y();
745 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
747 const double start = max(samples_decoded /
748 samples_per_pixel - pixels_offset, left - 1.0);
749 const double end = min(sample_count / samples_per_pixel -
750 pixels_offset, right + 1.0);
751 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
753 p.setPen(QPen(Qt::NoPen));
754 p.setBrush(Qt::white);
755 p.drawRect(no_decode_rect);
757 p.setPen(NoDecodeColor);
758 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
759 p.drawRect(no_decode_rect);
762 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
766 const View *view = owner_->view();
769 const double scale = view->scale();
772 const double pixels_offset =
773 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
775 double samplerate = decode_signal_->samplerate();
777 // Show sample rate as 1Hz when it is unknown
778 if (samplerate == 0.0)
781 return make_pair(pixels_offset, samplerate * scale);
784 pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
785 int x_start, int x_end) const
787 double samples_per_pixel, pixels_offset;
788 tie(pixels_offset, samples_per_pixel) =
789 get_pixels_offset_samples_per_pixel();
791 const uint64_t start = (uint64_t)max(
792 (x_start + pixels_offset) * samples_per_pixel, 0.0);
793 const uint64_t end = (uint64_t)max(
794 (x_end + pixels_offset) * samples_per_pixel, 0.0);
796 return make_pair(start, end);
799 QColor DecodeTrace::get_row_color(int row_index) const
801 // For each row color, use the base color hue and add an offset that's
802 // not a dividend of 360
805 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
806 const int s = DECODETRACE_COLOR_SATURATION;
807 const int v = DECODETRACE_COLOR_VALUE;
808 color.setHsl(h, s, v);
813 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
815 // For each row color, use the base color hue and add an offset that's
816 // not a dividend of 360 and not a multiple of the row offset
818 QColor color(row_color);
819 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
820 const int s = DECODETRACE_COLOR_SATURATION;
821 const int v = DECODETRACE_COLOR_VALUE;
822 color.setHsl(h, s, v);
827 int DecodeTrace::get_row_at_point(const QPoint &point)
832 const int y = (point.y() - get_visual_y() + row_height_ / 2);
834 /* Integer divison of (x-1)/x would yield 0, so we check for this. */
838 const int row = y / row_height_;
840 if (row >= (int)visible_rows_.size())
846 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
848 using namespace pv::data::decode;
853 const pair<uint64_t, uint64_t> sample_range =
854 get_view_sample_range(point.x(), point.x() + 1);
855 const int row = get_row_at_point(point);
859 vector<Annotation> annotations;
861 decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
862 current_segment_, sample_range.first, sample_range.second);
864 return (annotations.empty()) ?
865 QString() : annotations[0].annotations().front();
868 void DecodeTrace::hover_point_changed(const QPoint &hp)
870 Trace::hover_point_changed(hp);
874 const View *const view = owner_->view();
878 QToolTip::hideText();
882 QString ann = get_annotation_at_point(hp);
884 if (!row_height_ || ann.isEmpty()) {
885 QToolTip::hideText();
889 const int hover_row = get_row_at_point(hp);
891 QFontMetrics m(QToolTip::font());
892 const QRect text_size = m.boundingRect(QRect(), 0, ann);
894 // This is OS-specific and unfortunately we can't query it, so
895 // use an approximation to at least try to minimize the error.
896 const int padding = 8;
898 // Make sure the tool tip doesn't overlap with the mouse cursor.
899 // If it did, the tool tip would constantly hide and re-appear.
900 // We also push it up by one row so that it appears above the
901 // decode trace, not below.
903 p.setX(hp.x() - (text_size.width() / 2) - padding);
905 p.setY(get_visual_y() - (row_height_ / 2) +
906 (hover_row * row_height_) -
907 row_height_ - text_size.height() - padding);
909 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
912 void DecodeTrace::create_decoder_form(int index,
913 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
916 GlobalSettings settings;
919 const srd_decoder *const decoder = dec->decoder();
922 const bool decoder_deletable = index > 0;
924 pv::widgets::DecoderGroupBox *const group =
925 new pv::widgets::DecoderGroupBox(
926 QString::fromUtf8(decoder->name),
927 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
928 QString::fromUtf8(decoder->desc)),
929 nullptr, decoder_deletable);
930 group->set_decoder_visible(dec->shown());
932 if (decoder_deletable) {
933 delete_mapper_.setMapping(group, index);
934 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
937 show_hide_mapper_.setMapping(group, index);
938 connect(group, SIGNAL(show_hide_decoder()),
939 &show_hide_mapper_, SLOT(map()));
941 QFormLayout *const decoder_form = new QFormLayout;
942 group->add_layout(decoder_form);
944 const vector<DecodeChannel> channels = decode_signal_->get_channels();
947 for (const DecodeChannel& ch : channels) {
948 // Ignore channels not part of the decoder we create the form for
949 if (ch.decoder_ != dec)
952 QComboBox *const combo = create_channel_selector(parent, &ch);
953 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
955 channel_id_map_[combo] = ch.id;
956 init_state_map_[combo_init_state] = ch.id;
958 connect(combo, SIGNAL(currentIndexChanged(int)),
959 this, SLOT(on_channel_selected(int)));
960 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
961 this, SLOT(on_init_state_changed(int)));
963 QHBoxLayout *const hlayout = new QHBoxLayout;
964 hlayout->addWidget(combo);
965 hlayout->addWidget(combo_init_state);
967 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
968 combo_init_state->hide();
970 const QString required_flag = ch.is_optional ? QString() : QString("*");
971 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
972 .arg(ch.name, ch.desc, required_flag), hlayout);
976 shared_ptr<binding::Decoder> binding(
977 new binding::Decoder(decode_signal_, dec));
978 binding->add_properties_to_form(decoder_form, true);
980 bindings_.push_back(binding);
983 decoder_forms_.push_back(group);
986 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
988 const auto sigs(session_.signalbases());
990 // Sort signals in natural order
991 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
992 sort(sig_list.begin(), sig_list.end(),
993 [](const shared_ptr<data::SignalBase> &a,
994 const shared_ptr<data::SignalBase> &b) {
995 return strnatcasecmp(a->name().toStdString(),
996 b->name().toStdString()) < 0; });
998 QComboBox *selector = new QComboBox(parent);
1000 selector->addItem("-", qVariantFromValue((void*)nullptr));
1002 if (!ch->assigned_signal)
1003 selector->setCurrentIndex(0);
1005 for (const shared_ptr<data::SignalBase> &b : sig_list) {
1007 if (b->logic_data() && b->enabled()) {
1008 selector->addItem(b->name(),
1009 qVariantFromValue((void*)b.get()));
1011 if (ch->assigned_signal == b.get())
1012 selector->setCurrentIndex(selector->count() - 1);
1019 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
1020 const DecodeChannel *ch)
1022 QComboBox *selector = new QComboBox(parent);
1024 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
1025 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
1026 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
1028 selector->setCurrentIndex(ch->initial_pin_state);
1030 selector->setToolTip("Initial (assumed) pin value before the first sample");
1035 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
1037 using namespace pv::data::decode;
1039 GlobalSettings settings;
1040 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
1042 const QString file_name = QFileDialog::getSaveFileName(
1043 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1045 if (file_name.isEmpty())
1048 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1049 const QString quote = format.contains("%q") ? "\"" : "";
1050 format = format.remove("%q");
1052 QFile file(file_name);
1053 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1054 QTextStream out_stream(&file);
1056 for (Annotation &ann : *annotations) {
1057 const QString sample_range = QString("%1-%2") \
1058 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
1060 const QString class_name = quote + ann.row()->class_name() + quote;
1062 QString all_ann_text;
1063 for (const QString &s : ann.annotations())
1064 all_ann_text = all_ann_text + quote + s + quote + ",";
1065 all_ann_text.chop(1);
1067 const QString first_ann_text = quote + ann.annotations().front() + quote;
1069 QString out_text = format;
1070 out_text = out_text.replace("%s", sample_range);
1071 out_text = out_text.replace("%d",
1072 quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
1073 out_text = out_text.replace("%c", class_name);
1074 out_text = out_text.replace("%1", first_ann_text);
1075 out_text = out_text.replace("%a", all_ann_text);
1076 out_stream << out_text << '\n';
1079 if (out_stream.status() == QTextStream::Ok)
1083 QMessageBox msg(owner_->view());
1084 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1085 msg.setStandardButtons(QMessageBox::Ok);
1086 msg.setIcon(QMessageBox::Warning);
1090 void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
1092 Trace::on_setting_changed(key, value);
1094 if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
1095 visible_rows_.clear();
1096 max_visible_rows_ = 0;
1097 always_show_all_rows_ = value.toBool();
1101 void DecodeTrace::on_new_annotations()
1103 if (!delayed_trace_updater_.isActive())
1104 delayed_trace_updater_.start();
1107 void DecodeTrace::on_delayed_trace_update()
1110 owner_->row_item_appearance_changed(false, true);
1113 void DecodeTrace::on_decode_reset()
1115 visible_rows_.clear();
1116 max_visible_rows_ = 0;
1119 owner_->row_item_appearance_changed(false, true);
1122 void DecodeTrace::on_decode_finished()
1125 owner_->row_item_appearance_changed(false, true);
1128 void DecodeTrace::on_pause_decode()
1130 if (decode_signal_->is_paused())
1131 decode_signal_->resume_decode();
1133 decode_signal_->pause_decode();
1136 void DecodeTrace::delete_pressed()
1141 void DecodeTrace::on_delete()
1143 session_.remove_decode_signal(decode_signal_);
1146 void DecodeTrace::on_channel_selected(int)
1148 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1150 // Determine signal that was selected
1151 const data::SignalBase *signal =
1152 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1154 // Determine decode channel ID this combo box is the channel selector for
1155 const uint16_t id = channel_id_map_.at(cb);
1157 decode_signal_->assign_signal(id, signal);
1160 void DecodeTrace::on_channels_updated()
1163 owner_->row_item_appearance_changed(false, true);
1166 void DecodeTrace::on_init_state_changed(int)
1168 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1170 // Determine inital pin state that was selected
1171 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1173 // Determine decode channel ID this combo box is the channel selector for
1174 const uint16_t id = init_state_map_.at(cb);
1176 decode_signal_->set_initial_pin_state(id, init_state);
1179 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1181 decode_signal_->stack_decoder(decoder);
1183 create_popup_form();
1186 void DecodeTrace::on_delete_decoder(int index)
1188 decode_signal_->remove_decoder(index);
1190 // Force re-calculation of the trace height, see paint_mid()
1191 max_visible_rows_ = 0;
1192 owner_->extents_changed(false, true);
1195 create_popup_form();
1198 void DecodeTrace::on_show_hide_decoder(int index)
1200 const bool state = decode_signal_->toggle_decoder_visibility(index);
1202 assert(index < (int)decoder_forms_.size());
1203 decoder_forms_[index]->set_decoder_visible(state);
1206 // Force re-calculation of the trace height, see paint_mid()
1207 max_visible_rows_ = 0;
1208 owner_->extents_changed(false, true);
1212 owner_->row_item_appearance_changed(false, true);
1215 void DecodeTrace::on_copy_annotation_to_clipboard()
1217 using namespace pv::data::decode;
1222 vector<Annotation> *annotations = new vector<Annotation>();
1224 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1225 current_segment_, selected_sample_range_.first, selected_sample_range_.first);
1227 if (annotations->empty())
1230 QClipboard *clipboard = QApplication::clipboard();
1231 clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard);
1233 if (clipboard->supportsSelection())
1234 clipboard->setText(annotations->front().annotations().front(), QClipboard::Selection);
1239 void DecodeTrace::on_export_row()
1241 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1242 on_export_row_from_here();
1245 void DecodeTrace::on_export_all_rows()
1247 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1248 on_export_all_rows_from_here();
1251 void DecodeTrace::on_export_row_with_cursor()
1253 const View *view = owner_->view();
1256 if (!view->cursors()->enabled())
1259 const double samplerate = session_.get_samplerate();
1261 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1262 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1264 const uint64_t start_sample = (uint64_t)max(
1265 0.0, start_time.convert_to<double>() * samplerate);
1266 const uint64_t end_sample = (uint64_t)max(
1267 0.0, end_time.convert_to<double>() * samplerate);
1269 // Are both cursors negative and thus were clamped to 0?
1270 if ((start_sample == 0) && (end_sample == 0))
1273 selected_sample_range_ = make_pair(start_sample, end_sample);
1274 on_export_row_from_here();
1277 void DecodeTrace::on_export_all_rows_with_cursor()
1279 const View *view = owner_->view();
1282 if (!view->cursors()->enabled())
1285 const double samplerate = session_.get_samplerate();
1287 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1288 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1290 const uint64_t start_sample = (uint64_t)max(
1291 0.0, start_time.convert_to<double>() * samplerate);
1292 const uint64_t end_sample = (uint64_t)max(
1293 0.0, end_time.convert_to<double>() * samplerate);
1295 // Are both cursors negative and thus were clamped to 0?
1296 if ((start_sample == 0) && (end_sample == 0))
1299 selected_sample_range_ = make_pair(start_sample, end_sample);
1300 on_export_all_rows_from_here();
1303 void DecodeTrace::on_export_row_from_here()
1305 using namespace pv::data::decode;
1310 vector<Annotation> *annotations = new vector<Annotation>();
1312 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1313 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1315 if (annotations->empty())
1318 export_annotations(annotations);
1322 void DecodeTrace::on_export_all_rows_from_here()
1324 using namespace pv::data::decode;
1326 vector<Annotation> *annotations = new vector<Annotation>();
1328 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1329 selected_sample_range_.first, selected_sample_range_.second);
1331 if (!annotations->empty())
1332 export_annotations(annotations);
1337 } // namespace trace
1338 } // namespace views