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_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)
332 selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
333 } catch (out_of_range&) {
334 selected_row_ = nullptr;
337 // Default sample range is "from here"
338 const pair<uint64_t, uint64_t> sample_range =
339 get_sample_range(click_pos.x(), click_pos.x() + 1);
340 selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
342 QMenu *const menu = new QMenu(parent);
344 QAction *const export_all_rows =
345 new QAction(tr("Export all annotations"), this);
346 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
347 QIcon(":/icons/document-save-as.png")));
348 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
349 menu->addAction(export_all_rows);
351 QAction *const export_row =
352 new QAction(tr("Export all annotations for this row"), this);
353 export_row->setIcon(QIcon::fromTheme("document-save-as",
354 QIcon(":/icons/document-save-as.png")));
355 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
356 menu->addAction(export_row);
358 menu->addSeparator();
360 QAction *const export_all_rows_from_here =
361 new QAction(tr("Export all annotations, starting here"), this);
362 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
363 QIcon(":/icons/document-save-as.png")));
364 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
365 menu->addAction(export_all_rows_from_here);
367 QAction *const export_row_from_here =
368 new QAction(tr("Export annotations for this row, starting here"), this);
369 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
370 QIcon(":/icons/document-save-as.png")));
371 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
372 menu->addAction(export_row_from_here);
374 menu->addSeparator();
376 QAction *const export_all_rows_with_cursor =
377 new QAction(tr("Export all annotations within cursor range"), this);
378 export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
379 QIcon(":/icons/document-save-as.png")));
380 connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
381 menu->addAction(export_all_rows_with_cursor);
383 QAction *const export_row_with_cursor =
384 new QAction(tr("Export annotations for this row within cursor range"), this);
385 export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
386 QIcon(":/icons/document-save-as.png")));
387 connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
388 menu->addAction(export_row_with_cursor);
390 const View *view = owner_->view();
393 if (!view->cursors()->enabled()) {
394 export_all_rows_with_cursor->setEnabled(false);
395 export_row_with_cursor->setEnabled(false);
401 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
402 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
403 QColor row_color, int row_title_width)
405 using namespace pv::data::decode;
407 Annotation::Class block_class = 0;
408 bool block_class_uniform = true;
409 qreal block_start = 0;
410 int block_ann_count = 0;
412 const Annotation *prev_ann;
413 qreal prev_end = INT_MIN;
417 double samples_per_pixel, pixels_offset;
418 tie(pixels_offset, samples_per_pixel) =
419 get_pixels_offset_samples_per_pixel();
421 // Sort the annotations by start sample so that decoders
422 // can't confuse us by creating annotations out of order
423 stable_sort(annotations.begin(), annotations.end(),
424 [](const Annotation &a, const Annotation &b) {
425 return a.start_sample() < b.start_sample(); });
427 // Gather all annotations that form a visual "block" and draw them as such
428 for (const Annotation &a : annotations) {
430 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
431 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
433 const qreal a_start = abs_a_start - pixels_offset;
434 a_end = abs_a_end - pixels_offset;
436 const qreal a_width = a_end - a_start;
437 const qreal delta = a_end - prev_end;
439 bool a_is_separate = false;
441 // Annotation wider than the threshold for a useful label width?
442 if (a_width >= min_useful_label_width_) {
443 for (const QString &ann_text : a.annotations()) {
444 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
445 // Annotation wide enough to fit a label? Don't put it in a block then
447 a_is_separate = true;
453 // Were the previous and this annotation more than a pixel apart?
454 if ((abs(delta) > 1) || a_is_separate) {
455 // Block was broken, draw annotations that form the current block
456 if (block_ann_count == 1)
457 draw_annotation(*prev_ann, p, h, pp, y, row_color,
459 else if (block_ann_count > 0)
460 draw_annotation_block(block_start, prev_end, block_class,
461 block_class_uniform, p, h, y, row_color);
467 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
468 // Next annotation must start a new block. delta will be > 1
469 // because we set prev_end to INT_MIN but that's okay since
470 // block_ann_count will be 0 and nothing will be drawn
477 if (block_ann_count == 0) {
478 block_start = a_start;
479 block_class = a.ann_class();
480 block_class_uniform = true;
482 if (a.ann_class() != block_class)
483 block_class_uniform = false;
489 if (block_ann_count == 1)
490 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
491 else if (block_ann_count > 0)
492 draw_annotation_block(block_start, prev_end, block_class,
493 block_class_uniform, p, h, y, row_color);
496 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
497 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
498 QColor row_color, int row_title_width) const
500 double samples_per_pixel, pixels_offset;
501 tie(pixels_offset, samples_per_pixel) =
502 get_pixels_offset_samples_per_pixel();
504 const double start = a.start_sample() / samples_per_pixel -
506 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
508 QColor color = get_annotation_color(row_color, a.ann_class());
509 p.setPen(color.darker());
512 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
515 if (a.start_sample() == a.end_sample())
516 draw_instant(a, p, h, start, y);
518 draw_range(a, p, h, start, end, y, pp, row_title_width);
521 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
522 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
523 int y, QColor row_color) const
525 const double top = y + .5 - h / 2;
526 const double bottom = y + .5 + h / 2;
528 const QRectF rect(start, top, end - start, bottom - top);
531 p.setPen(QPen(Qt::NoPen));
532 p.setBrush(Qt::white);
533 p.drawRoundedRect(rect, r, r);
535 // If all annotations in this block are of the same type, we can use the
536 // one format that all of these annotations have. Otherwise, we should use
537 // a neutral color (i.e. gray)
538 if (use_ann_format) {
539 const QColor color = get_annotation_color(row_color, ann_class);
540 p.setPen(color.darker());
541 p.setBrush(QBrush(color, Qt::Dense4Pattern));
544 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
547 p.drawRoundedRect(rect, r, r);
550 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
551 int h, qreal x, int y) const
553 const QString text = a.annotations().empty() ?
554 QString() : a.annotations().back();
555 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
557 const QRectF rect(x - w / 2, y - h / 2, w, h);
559 p.drawRoundedRect(rect, h / 2, h / 2);
562 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
565 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
566 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
567 int row_title_width) const
569 const qreal top = y + .5 - h / 2;
570 const qreal bottom = y + .5 + h / 2;
571 const vector<QString> annotations = a.annotations();
573 // If the two ends are within 1 pixel, draw a vertical line
574 if (start + 1.0 > end) {
575 p.drawLine(QPointF(start, top), QPointF(start, bottom));
579 const qreal cap_width = min((end - start) / 4, EndCapWidth);
582 QPointF(start, y + .5f),
583 QPointF(start + cap_width, top),
584 QPointF(end - cap_width, top),
585 QPointF(end, y + .5f),
586 QPointF(end - cap_width, bottom),
587 QPointF(start + cap_width, bottom)
590 p.drawConvexPolygon(pts, countof(pts));
592 if (annotations.empty())
595 const int ann_start = start + cap_width;
596 const int ann_end = end - cap_width;
598 const int real_start = max(ann_start, pp.left() + row_title_width);
599 const int real_end = min(ann_end, pp.right());
600 const int real_width = real_end - real_start;
602 QRectF rect(real_start, y - h / 2, real_width, h);
603 if (rect.width() <= 4)
608 // Try to find an annotation that will fit
609 QString best_annotation;
612 for (const QString &a : annotations) {
613 const int w = p.boundingRect(QRectF(), 0, a).width();
614 if (w <= rect.width() && w > best_width)
615 best_annotation = a, best_width = w;
618 if (best_annotation.isEmpty())
619 best_annotation = annotations.back();
621 // If not ellide the last in the list
622 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
623 best_annotation, Qt::ElideRight, rect.width()));
626 void DecodeTrace::draw_error(QPainter &p, const QString &message,
627 const ViewItemPaintParams &pp)
629 const int y = get_visual_y();
631 double samples_per_pixel, pixels_offset;
632 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
634 p.setPen(ErrorBgColor.darker());
635 p.setBrush(ErrorBgColor);
637 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
639 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
640 const qreal r = text_rect.height() / 4;
642 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
645 p.drawText(text_rect, message);
648 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
650 using namespace pv::data;
651 using pv::data::decode::Decoder;
653 double samples_per_pixel, pixels_offset;
655 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
656 if (sample_count == 0)
659 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
660 if (sample_count == samples_decoded)
663 const int y = get_visual_y();
665 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
667 const double start = max(samples_decoded /
668 samples_per_pixel - pixels_offset, left - 1.0);
669 const double end = min(sample_count / samples_per_pixel -
670 pixels_offset, right + 1.0);
671 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
673 p.setPen(QPen(Qt::NoPen));
674 p.setBrush(Qt::white);
675 p.drawRect(no_decode_rect);
677 p.setPen(NoDecodeColor);
678 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
679 p.drawRect(no_decode_rect);
682 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
686 const View *view = owner_->view();
689 const double scale = view->scale();
692 const double pixels_offset =
693 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
695 double samplerate = decode_signal_->samplerate();
697 // Show sample rate as 1Hz when it is unknown
698 if (samplerate == 0.0)
701 return make_pair(pixels_offset, samplerate * scale);
704 pair<uint64_t, uint64_t> DecodeTrace::get_sample_range(
705 int x_start, int x_end) const
707 double samples_per_pixel, pixels_offset;
708 tie(pixels_offset, samples_per_pixel) =
709 get_pixels_offset_samples_per_pixel();
711 const uint64_t start = (uint64_t)max(
712 (x_start + pixels_offset) * samples_per_pixel, 0.0);
713 const uint64_t end = (uint64_t)max(
714 (x_end + pixels_offset) * samples_per_pixel, 0.0);
716 return make_pair(start, end);
719 QColor DecodeTrace::get_row_color(int row_index) const
721 // For each row color, use the base color hue and add an offset that's
722 // not a dividend of 360
725 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
726 const int s = DECODETRACE_COLOR_SATURATION;
727 const int v = DECODETRACE_COLOR_VALUE;
728 color.setHsl(h, s, v);
733 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
735 // For each row color, use the base color hue and add an offset that's
736 // not a dividend of 360 and not a multiple of the row offset
738 QColor color(row_color);
739 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
740 const int s = DECODETRACE_COLOR_SATURATION;
741 const int v = DECODETRACE_COLOR_VALUE;
742 color.setHsl(h, s, v);
747 int DecodeTrace::get_row_at_point(const QPoint &point)
752 const int y = (point.y() - get_visual_y() + row_height_ / 2);
754 /* Integer divison of (x-1)/x would yield 0, so we check for this. */
758 const int row = y / row_height_;
760 if (row >= (int)visible_rows_.size())
766 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
768 using namespace pv::data::decode;
773 const pair<uint64_t, uint64_t> sample_range =
774 get_sample_range(point.x(), point.x() + 1);
775 const int row = get_row_at_point(point);
779 vector<Annotation> annotations;
781 decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
782 current_segment_, sample_range.first, sample_range.second);
784 return (annotations.empty()) ?
785 QString() : annotations[0].annotations().front();
788 void DecodeTrace::hover_point_changed(const QPoint &hp)
790 Trace::hover_point_changed(hp);
794 const View *const view = owner_->view();
798 QToolTip::hideText();
802 QString ann = get_annotation_at_point(hp);
806 if (!row_height_ || ann.isEmpty()) {
807 QToolTip::hideText();
811 const int hover_row = get_row_at_point(hp);
813 QFontMetrics m(QToolTip::font());
814 const QRect text_size = m.boundingRect(QRect(), 0, ann);
816 // This is OS-specific and unfortunately we can't query it, so
817 // use an approximation to at least try to minimize the error.
818 const int padding = 8;
820 // Make sure the tool tip doesn't overlap with the mouse cursor.
821 // If it did, the tool tip would constantly hide and re-appear.
822 // We also push it up by one row so that it appears above the
823 // decode trace, not below.
825 p.setX(hp.x() - (text_size.width() / 2) - padding);
827 p.setY(get_visual_y() - (row_height_ / 2) +
828 (hover_row * row_height_) -
829 row_height_ - text_size.height() - padding);
831 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
834 void DecodeTrace::create_decoder_form(int index,
835 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
838 GlobalSettings settings;
841 const srd_decoder *const decoder = dec->decoder();
844 const bool decoder_deletable = index > 0;
846 pv::widgets::DecoderGroupBox *const group =
847 new pv::widgets::DecoderGroupBox(
848 QString::fromUtf8(decoder->name),
849 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
850 QString::fromUtf8(decoder->desc)),
851 nullptr, decoder_deletable);
852 group->set_decoder_visible(dec->shown());
854 if (decoder_deletable) {
855 delete_mapper_.setMapping(group, index);
856 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
859 show_hide_mapper_.setMapping(group, index);
860 connect(group, SIGNAL(show_hide_decoder()),
861 &show_hide_mapper_, SLOT(map()));
863 QFormLayout *const decoder_form = new QFormLayout;
864 group->add_layout(decoder_form);
866 const vector<DecodeChannel> channels = decode_signal_->get_channels();
869 for (DecodeChannel ch : channels) {
870 // Ignore channels not part of the decoder we create the form for
871 if (ch.decoder_ != dec)
874 QComboBox *const combo = create_channel_selector(parent, &ch);
875 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
877 channel_id_map_[combo] = ch.id;
878 init_state_map_[combo_init_state] = ch.id;
880 connect(combo, SIGNAL(currentIndexChanged(int)),
881 this, SLOT(on_channel_selected(int)));
882 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
883 this, SLOT(on_init_state_changed(int)));
885 QHBoxLayout *const hlayout = new QHBoxLayout;
886 hlayout->addWidget(combo);
887 hlayout->addWidget(combo_init_state);
889 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
890 combo_init_state->hide();
892 const QString required_flag = ch.is_optional ? QString() : QString("*");
893 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
894 .arg(ch.name, ch.desc, required_flag), hlayout);
898 shared_ptr<binding::Decoder> binding(
899 new binding::Decoder(decode_signal_, dec));
900 binding->add_properties_to_form(decoder_form, true);
902 bindings_.push_back(binding);
905 decoder_forms_.push_back(group);
908 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
910 const auto sigs(session_.signalbases());
912 // Sort signals in natural order
913 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
914 sort(sig_list.begin(), sig_list.end(),
915 [](const shared_ptr<data::SignalBase> &a,
916 const shared_ptr<data::SignalBase> &b) {
917 return strnatcasecmp(a->name().toStdString(),
918 b->name().toStdString()) < 0; });
920 QComboBox *selector = new QComboBox(parent);
922 selector->addItem("-", qVariantFromValue((void*)nullptr));
924 if (!ch->assigned_signal)
925 selector->setCurrentIndex(0);
927 for (const shared_ptr<data::SignalBase> &b : sig_list) {
929 if (b->logic_data() && b->enabled()) {
930 selector->addItem(b->name(),
931 qVariantFromValue((void*)b.get()));
933 if (ch->assigned_signal == b.get())
934 selector->setCurrentIndex(selector->count() - 1);
941 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
942 const DecodeChannel *ch)
944 QComboBox *selector = new QComboBox(parent);
946 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
947 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
948 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
950 selector->setCurrentIndex(ch->initial_pin_state);
952 selector->setToolTip("Initial (assumed) pin value before the first sample");
957 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
959 using namespace pv::data::decode;
961 GlobalSettings settings;
962 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
964 const QString file_name = QFileDialog::getSaveFileName(
965 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
967 if (file_name.isEmpty())
970 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
971 const QString quote = format.contains("%q") ? "\"" : "";
972 format = format.remove("%q");
974 QFile file(file_name);
975 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
976 QTextStream out_stream(&file);
978 for (Annotation &ann : *annotations) {
979 const QString sample_range = QString("%1-%2") \
980 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
982 const QString class_name = quote + ann.row()->class_name() + quote;
984 QString all_ann_text;
985 for (const QString &s : ann.annotations())
986 all_ann_text = all_ann_text + quote + s + quote + ",";
987 all_ann_text.chop(1);
989 const QString first_ann_text = quote + ann.annotations().front() + quote;
991 QString out_text = format;
992 out_text = out_text.replace("%s", sample_range);
993 out_text = out_text.replace("%d",
994 quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
995 out_text = out_text.replace("%c", class_name);
996 out_text = out_text.replace("%1", first_ann_text);
997 out_text = out_text.replace("%a", all_ann_text);
998 out_stream << out_text << '\n';
1001 if (out_stream.status() == QTextStream::Ok)
1005 QMessageBox msg(owner_->view());
1006 msg.setText(tr("Error"));
1007 msg.setInformativeText(tr("File %1 could not be written to.").arg(file_name));
1008 msg.setStandardButtons(QMessageBox::Ok);
1009 msg.setIcon(QMessageBox::Warning);
1013 void DecodeTrace::on_new_annotations()
1015 if (!delayed_trace_updater_.isActive())
1016 delayed_trace_updater_.start();
1019 void DecodeTrace::on_delayed_trace_update()
1022 owner_->row_item_appearance_changed(false, true);
1025 void DecodeTrace::on_decode_reset()
1027 visible_rows_.clear();
1028 max_visible_rows_ = 0;
1031 owner_->row_item_appearance_changed(false, true);
1034 void DecodeTrace::on_decode_finished()
1037 owner_->row_item_appearance_changed(false, true);
1040 void DecodeTrace::delete_pressed()
1045 void DecodeTrace::on_delete()
1047 session_.remove_decode_signal(decode_signal_);
1050 void DecodeTrace::on_channel_selected(int)
1052 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1054 // Determine signal that was selected
1055 const data::SignalBase *signal =
1056 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1058 // Determine decode channel ID this combo box is the channel selector for
1059 const uint16_t id = channel_id_map_.at(cb);
1061 decode_signal_->assign_signal(id, signal);
1064 void DecodeTrace::on_channels_updated()
1067 owner_->row_item_appearance_changed(false, true);
1070 void DecodeTrace::on_init_state_changed(int)
1072 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1074 // Determine inital pin state that was selected
1075 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1077 // Determine decode channel ID this combo box is the channel selector for
1078 const uint16_t id = init_state_map_.at(cb);
1080 decode_signal_->set_initial_pin_state(id, init_state);
1083 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1085 decode_signal_->stack_decoder(decoder);
1087 create_popup_form();
1090 void DecodeTrace::on_delete_decoder(int index)
1092 decode_signal_->remove_decoder(index);
1094 // Force re-calculation of the trace height, see paint_mid()
1095 max_visible_rows_ = 0;
1096 owner_->extents_changed(false, true);
1099 create_popup_form();
1102 void DecodeTrace::on_show_hide_decoder(int index)
1104 const bool state = decode_signal_->toggle_decoder_visibility(index);
1106 assert(index < (int)decoder_forms_.size());
1107 decoder_forms_[index]->set_decoder_visible(state);
1110 // Force re-calculation of the trace height, see paint_mid()
1111 max_visible_rows_ = 0;
1112 owner_->extents_changed(false, true);
1116 owner_->row_item_appearance_changed(false, true);
1119 void DecodeTrace::on_export_row()
1121 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1122 on_export_row_from_here();
1125 void DecodeTrace::on_export_all_rows()
1127 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1128 on_export_all_rows_from_here();
1131 void DecodeTrace::on_export_row_with_cursor()
1133 const View *view = owner_->view();
1136 if (!view->cursors()->enabled())
1139 const double samplerate = session_.get_samplerate();
1141 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1142 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1144 const uint64_t start_sample = (uint64_t)max(
1145 (double)0, start_time.convert_to<double>() * samplerate);
1146 const uint64_t end_sample = (uint64_t)max(
1147 (double)0, end_time.convert_to<double>() * samplerate);
1149 // Are both cursors negative and thus were clamped to 0?
1150 if ((start_sample == 0) && (end_sample == 0))
1153 selected_sample_range_ = make_pair(start_sample, end_sample);
1154 on_export_row_from_here();
1157 void DecodeTrace::on_export_all_rows_with_cursor()
1159 const View *view = owner_->view();
1162 if (!view->cursors()->enabled())
1165 const double samplerate = session_.get_samplerate();
1167 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1168 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1170 const uint64_t start_sample = (uint64_t)max(
1171 (double)0, start_time.convert_to<double>() * samplerate);
1172 const uint64_t end_sample = (uint64_t)max(
1173 (double)0, end_time.convert_to<double>() * samplerate);
1175 // Are both cursors negative and thus were clamped to 0?
1176 if ((start_sample == 0) && (end_sample == 0))
1179 selected_sample_range_ = make_pair(start_sample, end_sample);
1180 on_export_all_rows_from_here();
1183 void DecodeTrace::on_export_row_from_here()
1185 using namespace pv::data::decode;
1190 vector<Annotation> *annotations = new vector<Annotation>();
1192 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1193 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1195 if (annotations->empty())
1198 export_annotations(annotations);
1202 void DecodeTrace::on_export_all_rows_from_here()
1204 using namespace pv::data::decode;
1206 vector<Annotation> *annotations = new vector<Annotation>();
1208 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1209 selected_sample_range_.first, selected_sample_range_.second);
1211 if (!annotations->empty())
1212 export_annotations(annotations);
1217 } // namespace trace
1218 } // namespace views