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>
35 #include <QFileDialog>
36 #include <QFormLayout>
39 #include <QMessageBox>
40 #include <QPushButton>
41 #include <QTextStream>
44 #include "decodetrace.hpp"
46 #include "viewport.hpp"
48 #include <pv/globalsettings.hpp>
49 #include <pv/session.hpp>
50 #include <pv/strnatcmp.hpp>
51 #include <pv/data/decodesignal.hpp>
52 #include <pv/data/decode/annotation.hpp>
53 #include <pv/data/decode/decoder.hpp>
54 #include <pv/data/logic.hpp>
55 #include <pv/data/logicsegment.hpp>
56 #include <pv/widgets/decodergroupbox.hpp>
57 #include <pv/widgets/decodermenu.hpp>
63 using std::numeric_limits;
64 using std::out_of_range;
66 using std::shared_ptr;
70 using pv::data::decode::Annotation;
71 using pv::data::decode::Row;
72 using pv::data::DecodeChannel;
73 using pv::data::DecodeSignal;
80 #define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
81 #define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
83 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
84 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
86 const int DecodeTrace::ArrowSize = 4;
87 const double DecodeTrace::EndCapWidth = 5;
88 const int DecodeTrace::RowTitleMargin = 10;
89 const int DecodeTrace::DrawPadding = 100;
91 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
93 DecodeTrace::DecodeTrace(pv::Session &session,
94 shared_ptr<data::SignalBase> signalbase, int index) :
100 show_hide_mapper_(this)
102 decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
104 // Determine shortest string we want to see displayed in full
105 QFontMetrics m(QApplication::font());
106 min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
108 // For the base color, we want to start at a very different color for
109 // every decoder stack, so multiply the index with a number that is
110 // rather close to 180 degrees of the color circle but not a dividend of 360
111 // Note: The offset equals the color of the first annotation
113 const int h = (120 + 160 * index) % 360;
114 const int s = DECODETRACE_COLOR_SATURATION;
115 const int v = DECODETRACE_COLOR_VALUE;
116 color.setHsv(h, s, v);
117 base_->set_color(color);
119 connect(decode_signal_.get(), SIGNAL(new_annotations()),
120 this, SLOT(on_new_annotations()));
121 connect(decode_signal_.get(), SIGNAL(decode_reset()),
122 this, SLOT(on_decode_reset()));
123 connect(decode_signal_.get(), SIGNAL(decode_finished()),
124 this, SLOT(on_decode_finished()));
125 connect(decode_signal_.get(), SIGNAL(channels_updated()),
126 this, SLOT(on_channels_updated()));
128 connect(&delete_mapper_, SIGNAL(mapped(int)),
129 this, SLOT(on_delete_decoder(int)));
130 connect(&show_hide_mapper_, SIGNAL(mapped(int)),
131 this, SLOT(on_show_hide_decoder(int)));
133 connect(&delayed_trace_updater_, SIGNAL(timeout()),
134 this, SLOT(on_delayed_trace_update()));
135 delayed_trace_updater_.setSingleShot(true);
136 delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
139 bool DecodeTrace::enabled() const
144 shared_ptr<data::SignalBase> DecodeTrace::base() const
149 pair<int, int> DecodeTrace::v_extents() const
151 const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
153 // Make an empty decode trace appear symmetrical
154 const int row_count = max(1, max_visible_rows_);
156 return make_pair(-row_height, row_height * row_count);
159 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
161 Trace::paint_back(p, pp);
162 paint_axis(p, pp, get_visual_y());
165 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
167 const int text_height = ViewItemPaintParams::text_height();
168 row_height_ = (text_height * 6) / 4;
169 const int annotation_height = (text_height * 5) / 4;
171 // Set default pen to allow for text width calculation
174 // Iterate through the rows
175 int y = get_visual_y();
176 pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pp.left(), pp.right());
178 // Just because the view says we see a certain sample range it
179 // doesn't mean we have this many decoded samples, too, so crop
180 // the range to what has been decoded already
181 sample_range.second = min((int64_t)sample_range.second,
182 decode_signal_->get_decoded_sample_count(current_segment_, false));
184 const vector<Row> rows = decode_signal_->visible_rows();
186 visible_rows_.clear();
187 for (const Row& row : rows) {
188 // Cache the row title widths
191 row_title_width = row_title_widths_.at(row);
192 } catch (out_of_range&) {
193 const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
195 row_title_widths_[row] = w;
199 vector<Annotation> annotations;
200 decode_signal_->get_annotation_subset(annotations, row,
201 current_segment_, sample_range.first, sample_range.second);
202 if (!annotations.empty()) {
203 draw_annotations(annotations, p, annotation_height, pp, y,
204 get_row_color(row.index()), row_title_width);
206 visible_rows_.push_back(row);
210 draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
212 if ((int)visible_rows_.size() > max_visible_rows_) {
213 max_visible_rows_ = (int)visible_rows_.size();
215 // Call order is important, otherwise the lazy event handler won't work
216 owner_->extents_changed(false, true);
217 owner_->row_item_appearance_changed(false, true);
220 const QString err = decode_signal_->error_message();
222 draw_error(p, err, pp);
225 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
229 for (size_t i = 0; i < visible_rows_.size(); i++) {
230 const int y = i * row_height_ + get_visual_y();
232 p.setPen(QPen(Qt::NoPen));
233 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
236 const QPointF points[] = {
237 QPointF(pp.left(), y - ArrowSize),
238 QPointF(pp.left() + ArrowSize, y),
239 QPointF(pp.left(), y + ArrowSize)
241 p.drawPolygon(points, countof(points));
244 const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
245 pp.right() - pp.left(), row_height_);
246 const QString h(visible_rows_[i].title());
247 const int f = Qt::AlignLeft | Qt::AlignVCenter |
251 p.setPen(QApplication::palette().color(QPalette::Base));
252 for (int dx = -1; dx <= 1; dx++)
253 for (int dy = -1; dy <= 1; dy++)
254 if (dx != 0 && dy != 0)
255 p.drawText(r.translated(dx, dy), f, h);
258 p.setPen(QApplication::palette().color(QPalette::WindowText));
262 if (show_hover_marker_)
263 paint_hover_marker(p);
266 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
268 using pv::data::decode::Decoder;
272 // Add the standard options
273 Trace::populate_popup_form(parent, form);
275 // Add the decoder options
277 channel_id_map_.clear();
278 init_state_map_.clear();
279 decoder_forms_.clear();
281 const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
284 QLabel *const l = new QLabel(
285 tr("<p><i>No decoders in the stack</i></p>"));
286 l->setAlignment(Qt::AlignCenter);
289 auto iter = stack.cbegin();
290 for (int i = 0; i < (int)stack.size(); i++, iter++) {
291 shared_ptr<Decoder> dec(*iter);
292 create_decoder_form(i, dec, parent, form);
295 form->addRow(new QLabel(
296 tr("<i>* Required channels</i>"), parent));
299 // Add stacking button
300 pv::widgets::DecoderMenu *const decoder_menu =
301 new pv::widgets::DecoderMenu(parent);
302 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
303 this, SLOT(on_stack_decoder(srd_decoder*)));
305 QPushButton *const stack_button =
306 new QPushButton(tr("Stack Decoder"), parent);
307 stack_button->setMenu(decoder_menu);
308 stack_button->setToolTip(tr("Stack a higher-level decoder on top of this one"));
310 QHBoxLayout *stack_button_box = new QHBoxLayout;
311 stack_button_box->addWidget(stack_button, 0, Qt::AlignRight);
312 form->addRow(stack_button_box);
315 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
317 QMenu *const menu = Trace::create_header_context_menu(parent);
319 menu->addSeparator();
321 QAction *const del = new QAction(tr("Delete"), this);
322 del->setShortcuts(QKeySequence::Delete);
323 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
324 menu->addAction(del);
329 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
331 // Get entries from default menu before adding our own
332 QMenu *const menu = new QMenu(parent);
334 QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
336 for (QAction *action : default_menu->actions()) { // clazy:exclude=range-loop
337 menu->addAction(action);
338 if (action->parent() == default_menu)
339 action->setParent(menu);
343 // Add separator if needed
344 if (menu->actions().length() > 0)
345 menu->addSeparator();
349 selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
350 } catch (out_of_range&) {
351 selected_row_ = nullptr;
354 // Default sample range is "from here"
355 const pair<uint64_t, uint64_t> sample_range =
356 get_view_sample_range(click_pos.x(), click_pos.x() + 1);
357 selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
359 if (decode_signal_->is_paused()) {
360 QAction *const resume =
361 new QAction(tr("Resume decoding"), this);
362 resume->setIcon(QIcon::fromTheme("media-playback-start",
363 QIcon(":/icons/media-playback-start.png")));
364 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
365 menu->addAction(resume);
367 QAction *const pause =
368 new QAction(tr("Pause decoding"), this);
369 pause->setIcon(QIcon::fromTheme("media-playback-pause",
370 QIcon(":/icons/media-playback-pause.png")));
371 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
372 menu->addAction(pause);
375 menu->addSeparator();
377 QAction *const export_all_rows =
378 new QAction(tr("Export all annotations"), this);
379 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
380 QIcon(":/icons/document-save-as.png")));
381 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
382 menu->addAction(export_all_rows);
384 QAction *const export_row =
385 new QAction(tr("Export all annotations for this row"), this);
386 export_row->setIcon(QIcon::fromTheme("document-save-as",
387 QIcon(":/icons/document-save-as.png")));
388 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
389 menu->addAction(export_row);
391 menu->addSeparator();
393 QAction *const export_all_rows_from_here =
394 new QAction(tr("Export all annotations, starting here"), this);
395 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
396 QIcon(":/icons/document-save-as.png")));
397 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
398 menu->addAction(export_all_rows_from_here);
400 QAction *const export_row_from_here =
401 new QAction(tr("Export annotations for this row, starting here"), this);
402 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
403 QIcon(":/icons/document-save-as.png")));
404 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
405 menu->addAction(export_row_from_here);
407 menu->addSeparator();
409 QAction *const export_all_rows_with_cursor =
410 new QAction(tr("Export all annotations within cursor range"), this);
411 export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
412 QIcon(":/icons/document-save-as.png")));
413 connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
414 menu->addAction(export_all_rows_with_cursor);
416 QAction *const export_row_with_cursor =
417 new QAction(tr("Export annotations for this row within cursor range"), this);
418 export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
419 QIcon(":/icons/document-save-as.png")));
420 connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
421 menu->addAction(export_row_with_cursor);
423 const View *view = owner_->view();
426 if (!view->cursors()->enabled()) {
427 export_all_rows_with_cursor->setEnabled(false);
428 export_row_with_cursor->setEnabled(false);
434 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
435 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
436 QColor row_color, int row_title_width)
438 using namespace pv::data::decode;
440 Annotation::Class block_class = 0;
441 bool block_class_uniform = true;
442 qreal block_start = 0;
443 int block_ann_count = 0;
445 const Annotation *prev_ann;
446 qreal prev_end = INT_MIN;
450 double samples_per_pixel, pixels_offset;
451 tie(pixels_offset, samples_per_pixel) =
452 get_pixels_offset_samples_per_pixel();
454 // Sort the annotations by start sample so that decoders
455 // can't confuse us by creating annotations out of order
456 stable_sort(annotations.begin(), annotations.end(),
457 [](const Annotation &a, const Annotation &b) {
458 return a.start_sample() < b.start_sample(); });
460 // Gather all annotations that form a visual "block" and draw them as such
461 for (const Annotation &a : annotations) {
463 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
464 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
466 const qreal a_start = abs_a_start - pixels_offset;
467 a_end = abs_a_end - pixels_offset;
469 const qreal a_width = a_end - a_start;
470 const qreal delta = a_end - prev_end;
472 bool a_is_separate = false;
474 // Annotation wider than the threshold for a useful label width?
475 if (a_width >= min_useful_label_width_) {
476 for (const QString &ann_text : a.annotations()) {
477 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
478 // Annotation wide enough to fit a label? Don't put it in a block then
480 a_is_separate = true;
486 // Were the previous and this annotation more than a pixel apart?
487 if ((abs(delta) > 1) || a_is_separate) {
488 // Block was broken, draw annotations that form the current block
489 if (block_ann_count == 1)
490 draw_annotation(*prev_ann, p, h, pp, y, row_color,
492 else if (block_ann_count > 0)
493 draw_annotation_block(block_start, prev_end, block_class,
494 block_class_uniform, p, h, y, row_color);
500 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
501 // Next annotation must start a new block. delta will be > 1
502 // because we set prev_end to INT_MIN but that's okay since
503 // block_ann_count will be 0 and nothing will be drawn
510 if (block_ann_count == 0) {
511 block_start = a_start;
512 block_class = a.ann_class();
513 block_class_uniform = true;
515 if (a.ann_class() != block_class)
516 block_class_uniform = false;
522 if (block_ann_count == 1)
523 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
524 else if (block_ann_count > 0)
525 draw_annotation_block(block_start, prev_end, block_class,
526 block_class_uniform, p, h, y, row_color);
529 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
530 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
531 QColor row_color, int row_title_width) const
533 double samples_per_pixel, pixels_offset;
534 tie(pixels_offset, samples_per_pixel) =
535 get_pixels_offset_samples_per_pixel();
537 const double start = a.start_sample() / samples_per_pixel -
539 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
541 QColor color = get_annotation_color(row_color, a.ann_class());
542 p.setPen(color.darker());
545 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
548 if (a.start_sample() == a.end_sample())
549 draw_instant(a, p, h, start, y);
551 draw_range(a, p, h, start, end, y, pp, row_title_width);
554 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
555 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
556 int y, QColor row_color) const
558 const double top = y + .5 - h / 2;
559 const double bottom = y + .5 + h / 2;
561 const QRectF rect(start, top, end - start, bottom - top);
564 p.setPen(QPen(Qt::NoPen));
565 p.setBrush(Qt::white);
566 p.drawRoundedRect(rect, r, r);
568 // If all annotations in this block are of the same type, we can use the
569 // one format that all of these annotations have. Otherwise, we should use
570 // a neutral color (i.e. gray)
571 if (use_ann_format) {
572 const QColor color = get_annotation_color(row_color, ann_class);
573 p.setPen(color.darker());
574 p.setBrush(QBrush(color, Qt::Dense4Pattern));
577 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
580 p.drawRoundedRect(rect, r, r);
583 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
584 int h, qreal x, int y) const
586 const QString text = a.annotations().empty() ?
587 QString() : a.annotations().back();
588 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
590 const QRectF rect(x - w / 2, y - h / 2, w, h);
592 p.drawRoundedRect(rect, h / 2, h / 2);
595 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
598 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
599 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
600 int row_title_width) const
602 const qreal top = y + .5 - h / 2;
603 const qreal bottom = y + .5 + h / 2;
604 const vector<QString> annotations = a.annotations();
606 // If the two ends are within 1 pixel, draw a vertical line
607 if (start + 1.0 > end) {
608 p.drawLine(QPointF(start, top), QPointF(start, bottom));
612 const qreal cap_width = min((end - start) / 4, EndCapWidth);
615 QPointF(start, y + .5f),
616 QPointF(start + cap_width, top),
617 QPointF(end - cap_width, top),
618 QPointF(end, y + .5f),
619 QPointF(end - cap_width, bottom),
620 QPointF(start + cap_width, bottom)
623 p.drawConvexPolygon(pts, countof(pts));
625 if (annotations.empty())
628 const int ann_start = start + cap_width;
629 const int ann_end = end - cap_width;
631 const int real_start = max(ann_start, pp.left() + row_title_width);
632 const int real_end = min(ann_end, pp.right());
633 const int real_width = real_end - real_start;
635 QRectF rect(real_start, y - h / 2, real_width, h);
636 if (rect.width() <= 4)
641 // Try to find an annotation that will fit
642 QString best_annotation;
645 for (const QString &a : annotations) {
646 const int w = p.boundingRect(QRectF(), 0, a).width();
647 if (w <= rect.width() && w > best_width)
648 best_annotation = a, best_width = w;
651 if (best_annotation.isEmpty())
652 best_annotation = annotations.back();
654 // If not ellide the last in the list
655 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
656 best_annotation, Qt::ElideRight, rect.width()));
659 void DecodeTrace::draw_error(QPainter &p, const QString &message,
660 const ViewItemPaintParams &pp)
662 const int y = get_visual_y();
664 double samples_per_pixel, pixels_offset;
665 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
667 p.setPen(ErrorBgColor.darker());
668 p.setBrush(ErrorBgColor);
670 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
672 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
673 const qreal r = text_rect.height() / 4;
675 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
678 p.drawText(text_rect, message);
681 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
683 using namespace pv::data;
684 using pv::data::decode::Decoder;
686 double samples_per_pixel, pixels_offset;
688 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
689 if (sample_count == 0)
692 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
693 if (sample_count == samples_decoded)
696 const int y = get_visual_y();
698 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
700 const double start = max(samples_decoded /
701 samples_per_pixel - pixels_offset, left - 1.0);
702 const double end = min(sample_count / samples_per_pixel -
703 pixels_offset, right + 1.0);
704 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
706 p.setPen(QPen(Qt::NoPen));
707 p.setBrush(Qt::white);
708 p.drawRect(no_decode_rect);
710 p.setPen(NoDecodeColor);
711 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
712 p.drawRect(no_decode_rect);
715 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
719 const View *view = owner_->view();
722 const double scale = view->scale();
725 const double pixels_offset =
726 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
728 double samplerate = decode_signal_->samplerate();
730 // Show sample rate as 1Hz when it is unknown
731 if (samplerate == 0.0)
734 return make_pair(pixels_offset, samplerate * scale);
737 pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
738 int x_start, int x_end) const
740 double samples_per_pixel, pixels_offset;
741 tie(pixels_offset, samples_per_pixel) =
742 get_pixels_offset_samples_per_pixel();
744 const uint64_t start = (uint64_t)max(
745 (x_start + pixels_offset) * samples_per_pixel, 0.0);
746 const uint64_t end = (uint64_t)max(
747 (x_end + pixels_offset) * samples_per_pixel, 0.0);
749 return make_pair(start, end);
752 QColor DecodeTrace::get_row_color(int row_index) const
754 // For each row color, use the base color hue and add an offset that's
755 // not a dividend of 360
758 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
759 const int s = DECODETRACE_COLOR_SATURATION;
760 const int v = DECODETRACE_COLOR_VALUE;
761 color.setHsl(h, s, v);
766 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
768 // For each row color, use the base color hue and add an offset that's
769 // not a dividend of 360 and not a multiple of the row offset
771 QColor color(row_color);
772 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
773 const int s = DECODETRACE_COLOR_SATURATION;
774 const int v = DECODETRACE_COLOR_VALUE;
775 color.setHsl(h, s, v);
780 int DecodeTrace::get_row_at_point(const QPoint &point)
785 const int y = (point.y() - get_visual_y() + row_height_ / 2);
787 /* Integer divison of (x-1)/x would yield 0, so we check for this. */
791 const int row = y / row_height_;
793 if (row >= (int)visible_rows_.size())
799 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
801 using namespace pv::data::decode;
806 const pair<uint64_t, uint64_t> sample_range =
807 get_view_sample_range(point.x(), point.x() + 1);
808 const int row = get_row_at_point(point);
812 vector<Annotation> annotations;
814 decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
815 current_segment_, sample_range.first, sample_range.second);
817 return (annotations.empty()) ?
818 QString() : annotations[0].annotations().front();
821 void DecodeTrace::hover_point_changed(const QPoint &hp)
823 Trace::hover_point_changed(hp);
827 const View *const view = owner_->view();
831 QToolTip::hideText();
835 QString ann = get_annotation_at_point(hp);
839 if (!row_height_ || ann.isEmpty()) {
840 QToolTip::hideText();
844 const int hover_row = get_row_at_point(hp);
846 QFontMetrics m(QToolTip::font());
847 const QRect text_size = m.boundingRect(QRect(), 0, ann);
849 // This is OS-specific and unfortunately we can't query it, so
850 // use an approximation to at least try to minimize the error.
851 const int padding = 8;
853 // Make sure the tool tip doesn't overlap with the mouse cursor.
854 // If it did, the tool tip would constantly hide and re-appear.
855 // We also push it up by one row so that it appears above the
856 // decode trace, not below.
858 p.setX(hp.x() - (text_size.width() / 2) - padding);
860 p.setY(get_visual_y() - (row_height_ / 2) +
861 (hover_row * row_height_) -
862 row_height_ - text_size.height() - padding);
864 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
867 void DecodeTrace::create_decoder_form(int index,
868 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
871 GlobalSettings settings;
874 const srd_decoder *const decoder = dec->decoder();
877 const bool decoder_deletable = index > 0;
879 pv::widgets::DecoderGroupBox *const group =
880 new pv::widgets::DecoderGroupBox(
881 QString::fromUtf8(decoder->name),
882 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
883 QString::fromUtf8(decoder->desc)),
884 nullptr, decoder_deletable);
885 group->set_decoder_visible(dec->shown());
887 if (decoder_deletable) {
888 delete_mapper_.setMapping(group, index);
889 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
892 show_hide_mapper_.setMapping(group, index);
893 connect(group, SIGNAL(show_hide_decoder()),
894 &show_hide_mapper_, SLOT(map()));
896 QFormLayout *const decoder_form = new QFormLayout;
897 group->add_layout(decoder_form);
899 const vector<DecodeChannel> channels = decode_signal_->get_channels();
902 for (const DecodeChannel& ch : channels) {
903 // Ignore channels not part of the decoder we create the form for
904 if (ch.decoder_ != dec)
907 QComboBox *const combo = create_channel_selector(parent, &ch);
908 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
910 channel_id_map_[combo] = ch.id;
911 init_state_map_[combo_init_state] = ch.id;
913 connect(combo, SIGNAL(currentIndexChanged(int)),
914 this, SLOT(on_channel_selected(int)));
915 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
916 this, SLOT(on_init_state_changed(int)));
918 QHBoxLayout *const hlayout = new QHBoxLayout;
919 hlayout->addWidget(combo);
920 hlayout->addWidget(combo_init_state);
922 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
923 combo_init_state->hide();
925 const QString required_flag = ch.is_optional ? QString() : QString("*");
926 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
927 .arg(ch.name, ch.desc, required_flag), hlayout);
931 shared_ptr<binding::Decoder> binding(
932 new binding::Decoder(decode_signal_, dec));
933 binding->add_properties_to_form(decoder_form, true);
935 bindings_.push_back(binding);
938 decoder_forms_.push_back(group);
941 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
943 const auto sigs(session_.signalbases());
945 // Sort signals in natural order
946 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
947 sort(sig_list.begin(), sig_list.end(),
948 [](const shared_ptr<data::SignalBase> &a,
949 const shared_ptr<data::SignalBase> &b) {
950 return strnatcasecmp(a->name().toStdString(),
951 b->name().toStdString()) < 0; });
953 QComboBox *selector = new QComboBox(parent);
955 selector->addItem("-", qVariantFromValue((void*)nullptr));
957 if (!ch->assigned_signal)
958 selector->setCurrentIndex(0);
960 for (const shared_ptr<data::SignalBase> &b : sig_list) {
962 if (b->logic_data() && b->enabled()) {
963 selector->addItem(b->name(),
964 qVariantFromValue((void*)b.get()));
966 if (ch->assigned_signal == b.get())
967 selector->setCurrentIndex(selector->count() - 1);
974 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
975 const DecodeChannel *ch)
977 QComboBox *selector = new QComboBox(parent);
979 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
980 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
981 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
983 selector->setCurrentIndex(ch->initial_pin_state);
985 selector->setToolTip("Initial (assumed) pin value before the first sample");
990 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
992 using namespace pv::data::decode;
994 GlobalSettings settings;
995 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
997 const QString file_name = QFileDialog::getSaveFileName(
998 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1000 if (file_name.isEmpty())
1003 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1004 const QString quote = format.contains("%q") ? "\"" : "";
1005 format = format.remove("%q");
1007 QFile file(file_name);
1008 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1009 QTextStream out_stream(&file);
1011 for (Annotation &ann : *annotations) {
1012 const QString sample_range = QString("%1-%2") \
1013 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
1015 const QString class_name = quote + ann.row()->class_name() + quote;
1017 QString all_ann_text;
1018 for (const QString &s : ann.annotations())
1019 all_ann_text = all_ann_text + quote + s + quote + ",";
1020 all_ann_text.chop(1);
1022 const QString first_ann_text = quote + ann.annotations().front() + quote;
1024 QString out_text = format;
1025 out_text = out_text.replace("%s", sample_range);
1026 out_text = out_text.replace("%d",
1027 quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
1028 out_text = out_text.replace("%c", class_name);
1029 out_text = out_text.replace("%1", first_ann_text);
1030 out_text = out_text.replace("%a", all_ann_text);
1031 out_stream << out_text << '\n';
1034 if (out_stream.status() == QTextStream::Ok)
1038 QMessageBox msg(owner_->view());
1039 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1040 msg.setStandardButtons(QMessageBox::Ok);
1041 msg.setIcon(QMessageBox::Warning);
1045 void DecodeTrace::on_new_annotations()
1047 if (!delayed_trace_updater_.isActive())
1048 delayed_trace_updater_.start();
1051 void DecodeTrace::on_delayed_trace_update()
1054 owner_->row_item_appearance_changed(false, true);
1057 void DecodeTrace::on_decode_reset()
1059 visible_rows_.clear();
1060 max_visible_rows_ = 0;
1063 owner_->row_item_appearance_changed(false, true);
1066 void DecodeTrace::on_decode_finished()
1069 owner_->row_item_appearance_changed(false, true);
1072 void DecodeTrace::on_pause_decode()
1074 if (decode_signal_->is_paused())
1075 decode_signal_->resume_decode();
1077 decode_signal_->pause_decode();
1080 void DecodeTrace::delete_pressed()
1085 void DecodeTrace::on_delete()
1087 session_.remove_decode_signal(decode_signal_);
1090 void DecodeTrace::on_channel_selected(int)
1092 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1094 // Determine signal that was selected
1095 const data::SignalBase *signal =
1096 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1098 // Determine decode channel ID this combo box is the channel selector for
1099 const uint16_t id = channel_id_map_.at(cb);
1101 decode_signal_->assign_signal(id, signal);
1104 void DecodeTrace::on_channels_updated()
1107 owner_->row_item_appearance_changed(false, true);
1110 void DecodeTrace::on_init_state_changed(int)
1112 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1114 // Determine inital pin state that was selected
1115 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1117 // Determine decode channel ID this combo box is the channel selector for
1118 const uint16_t id = init_state_map_.at(cb);
1120 decode_signal_->set_initial_pin_state(id, init_state);
1123 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1125 decode_signal_->stack_decoder(decoder);
1127 create_popup_form();
1130 void DecodeTrace::on_delete_decoder(int index)
1132 decode_signal_->remove_decoder(index);
1134 // Force re-calculation of the trace height, see paint_mid()
1135 max_visible_rows_ = 0;
1136 owner_->extents_changed(false, true);
1139 create_popup_form();
1142 void DecodeTrace::on_show_hide_decoder(int index)
1144 const bool state = decode_signal_->toggle_decoder_visibility(index);
1146 assert(index < (int)decoder_forms_.size());
1147 decoder_forms_[index]->set_decoder_visible(state);
1150 // Force re-calculation of the trace height, see paint_mid()
1151 max_visible_rows_ = 0;
1152 owner_->extents_changed(false, true);
1156 owner_->row_item_appearance_changed(false, true);
1159 void DecodeTrace::on_export_row()
1161 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1162 on_export_row_from_here();
1165 void DecodeTrace::on_export_all_rows()
1167 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1168 on_export_all_rows_from_here();
1171 void DecodeTrace::on_export_row_with_cursor()
1173 const View *view = owner_->view();
1176 if (!view->cursors()->enabled())
1179 const double samplerate = session_.get_samplerate();
1181 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1182 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1184 const uint64_t start_sample = (uint64_t)max(
1185 0.0, start_time.convert_to<double>() * samplerate);
1186 const uint64_t end_sample = (uint64_t)max(
1187 0.0, end_time.convert_to<double>() * samplerate);
1189 // Are both cursors negative and thus were clamped to 0?
1190 if ((start_sample == 0) && (end_sample == 0))
1193 selected_sample_range_ = make_pair(start_sample, end_sample);
1194 on_export_row_from_here();
1197 void DecodeTrace::on_export_all_rows_with_cursor()
1199 const View *view = owner_->view();
1202 if (!view->cursors()->enabled())
1205 const double samplerate = session_.get_samplerate();
1207 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1208 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1210 const uint64_t start_sample = (uint64_t)max(
1211 0.0, start_time.convert_to<double>() * samplerate);
1212 const uint64_t end_sample = (uint64_t)max(
1213 0.0, end_time.convert_to<double>() * samplerate);
1215 // Are both cursors negative and thus were clamped to 0?
1216 if ((start_sample == 0) && (end_sample == 0))
1219 selected_sample_range_ = make_pair(start_sample, end_sample);
1220 on_export_all_rows_from_here();
1223 void DecodeTrace::on_export_row_from_here()
1225 using namespace pv::data::decode;
1230 vector<Annotation> *annotations = new vector<Annotation>();
1232 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1233 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1235 if (annotations->empty())
1238 export_annotations(annotations);
1242 void DecodeTrace::on_export_all_rows_from_here()
1244 using namespace pv::data::decode;
1246 vector<Annotation> *annotations = new vector<Annotation>();
1248 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1249 selected_sample_range_.first, selected_sample_range_.second);
1251 if (!annotations->empty())
1252 export_annotations(annotations);
1257 } // namespace trace
1258 } // namespace views