]> sigrok.org Git - pulseview.git/blame_incremental - pv/views/trace/decodetrace.cpp
projects / pulseview.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Various binary output-related changes
[pulseview.git] / pv / views / trace / decodetrace.cpp
... / ...
CommitLineData
1/*
2 * This file is part of the PulseView project.
3 *
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
20extern "C" {
21#include <libsigrokdecode/libsigrokdecode.h>
22}
23
24#include <limits>
25#include <mutex>
26#include <tuple>
27
28#include <extdef.h>
29
30#include <boost/functional/hash.hpp>
31
32#include <QAction>
33#include <QApplication>
34#include <QClipboard>
35#include <QComboBox>
36#include <QFileDialog>
37#include <QFormLayout>
38#include <QLabel>
39#include <QMenu>
40#include <QMessageBox>
41#include <QPushButton>
42#include <QTextStream>
43#include <QToolTip>
44
45#include "decodetrace.hpp"
46#include "view.hpp"
47#include "viewport.hpp"
48
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>
59
60using std::abs;
61using std::make_pair;
62using std::max;
63using std::min;
64using std::numeric_limits;
65using std::out_of_range;
66using std::pair;
67using std::shared_ptr;
68using std::tie;
69using std::vector;
70
71using pv::data::decode::Annotation;
72using pv::data::decode::Row;
73using pv::data::decode::DecodeChannel;
74using pv::data::DecodeSignal;
75
76namespace pv {
77namespace views {
78namespace trace {
79
80
81#define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
82#define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
83
84const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
85const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
86
87const int DecodeTrace::ArrowSize = 4;
88const double DecodeTrace::EndCapWidth = 5;
89const int DecodeTrace::RowTitleMargin = 10;
90const int DecodeTrace::DrawPadding = 100;
91
92const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
93
94DecodeTrace::DecodeTrace(pv::Session &session,
95 shared_ptr<data::SignalBase> signalbase, int index) :
96 Trace(signalbase),
97 session_(session),
98 row_height_(0),
99 max_visible_rows_(0),
100 delete_mapper_(this),
101 show_hide_mapper_(this)
102{
103 decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
104
105 GlobalSettings settings;
106 always_show_all_rows_ = settings.value(GlobalSettings::Key_Dec_AlwaysShowAllRows).toBool();
107
108 GlobalSettings::add_change_handler(this);
109
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
113
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
118 QColor color;
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);
124
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()));
133
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)));
138
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);
143}
144
145DecodeTrace::~DecodeTrace()
146{
147 GlobalSettings::remove_change_handler(this);
148}
149
150bool DecodeTrace::enabled() const
151{
152 return true;
153}
154
155shared_ptr<data::SignalBase> DecodeTrace::base() const
156{
157 return base_;
158}
159
160pair<int, int> DecodeTrace::v_extents() const
161{
162 const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
163
164 // Make an empty decode trace appear symmetrical
165 const int row_count = max(1, max_visible_rows_);
166
167 return make_pair(-row_height, row_height * row_count);
168}
169
170void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
171{
172 Trace::paint_back(p, pp);
173 paint_axis(p, pp, get_visual_y());
174}
175
176void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
177{
178 const int text_height = ViewItemPaintParams::text_height();
179 row_height_ = (text_height * 6) / 4;
180 const int annotation_height = (text_height * 5) / 4;
181
182 // Set default pen to allow for text width calculation
183 p.setPen(Qt::black);
184
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());
188
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));
194
195 const vector<Row> rows = decode_signal_->get_rows(!always_show_all_rows_);
196
197 visible_rows_.clear();
198 for (const Row& row : rows) {
199 // Cache the row title widths
200 int row_title_width;
201 auto cached_width = row_title_widths_.find(row);
202
203 if (cached_width != row_title_widths_.end())
204 row_title_width = cached_width->second;
205 else {
206 const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
207 RowTitleMargin;
208 row_title_widths_[row] = w;
209 row_title_width = w;
210 }
211
212 vector<Annotation> annotations;
213 decode_signal_->get_annotation_subset(annotations, row,
214 current_segment_, sample_range.first, sample_range.second);
215 if (always_show_all_rows_ || !annotations.empty()) {
216 draw_annotations(annotations, p, annotation_height, pp, y,
217 get_row_color(row.index()), row_title_width);
218 y += row_height_;
219 visible_rows_.push_back(row);
220 }
221 }
222
223 draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
224
225 if ((int)visible_rows_.size() > max_visible_rows_) {
226 max_visible_rows_ = (int)visible_rows_.size();
227
228 // Call order is important, otherwise the lazy event handler won't work
229 owner_->extents_changed(false, true);
230 owner_->row_item_appearance_changed(false, true);
231 }
232
233 const QString err = decode_signal_->error_message();
234 if (!err.isEmpty())
235 draw_error(p, err, pp);
236}
237
238void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
239{
240 assert(row_height_);
241
242 for (size_t i = 0; i < visible_rows_.size(); i++) {
243 const int y = i * row_height_ + get_visual_y();
244
245 p.setPen(QPen(Qt::NoPen));
246 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
247
248 if (i != 0) {
249 const QPointF points[] = {
250 QPointF(pp.left(), y - ArrowSize),
251 QPointF(pp.left() + ArrowSize, y),
252 QPointF(pp.left(), y + ArrowSize)
253 };
254 p.drawPolygon(points, countof(points));
255 }
256
257 const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
258 pp.right() - pp.left(), row_height_);
259 const QString h(visible_rows_[i].title());
260 const int f = Qt::AlignLeft | Qt::AlignVCenter |
261 Qt::TextDontClip;
262
263 // Draw the outline
264 p.setPen(QApplication::palette().color(QPalette::Base));
265 for (int dx = -1; dx <= 1; dx++)
266 for (int dy = -1; dy <= 1; dy++)
267 if (dx != 0 && dy != 0)
268 p.drawText(r.translated(dx, dy), f, h);
269
270 // Draw the text
271 p.setPen(QApplication::palette().color(QPalette::WindowText));
272 p.drawText(r, f, h);
273 }
274
275 if (show_hover_marker_)
276 paint_hover_marker(p);
277}
278
279void DecodeTrace::update_stack_button()
280{
281 const vector< shared_ptr<data::decode::Decoder> > &stack = decode_signal_->decoder_stack();
282
283 // Only show decoders in the menu that can be stacked onto the last one in the stack
284 if (!stack.empty()) {
285 const srd_decoder* d = stack.back()->decoder();
286
287 if (d->outputs) {
288 pv::widgets::DecoderMenu *const decoder_menu =
289 new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data));
290 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
291 this, SLOT(on_stack_decoder(srd_decoder*)));
292
293 decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }");
294
295 stack_button_->setMenu(decoder_menu);
296 stack_button_->show();
297 return;
298 }
299 }
300
301 // No decoders available for stacking
302 stack_button_->setMenu(nullptr);
303 stack_button_->hide();
304}
305
306void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
307{
308 using pv::data::decode::Decoder;
309
310 assert(form);
311
312 // Add the standard options
313 Trace::populate_popup_form(parent, form);
314
315 // Add the decoder options
316 bindings_.clear();
317 channel_id_map_.clear();
318 init_state_map_.clear();
319 decoder_forms_.clear();
320
321 const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
322
323 if (stack.empty()) {
324 QLabel *const l = new QLabel(
325 tr("<p><i>No decoders in the stack</i></p>"));
326 l->setAlignment(Qt::AlignCenter);
327 form->addRow(l);
328 } else {
329 auto iter = stack.cbegin();
330 for (int i = 0; i < (int)stack.size(); i++, iter++) {
331 shared_ptr<Decoder> dec(*iter);
332 create_decoder_form(i, dec, parent, form);
333 }
334
335 form->addRow(new QLabel(
336 tr("<i>* Required channels</i>"), parent));
337 }
338
339 // Add stacking button
340 stack_button_ = new QPushButton(tr("Stack Decoder"), parent);
341 stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one"));
342 update_stack_button();
343
344 QHBoxLayout *stack_button_box = new QHBoxLayout;
345 stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight);
346 form->addRow(stack_button_box);
347}
348
349QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
350{
351 QMenu *const menu = Trace::create_header_context_menu(parent);
352
353 menu->addSeparator();
354
355 QAction *const del = new QAction(tr("Delete"), this);
356 del->setShortcuts(QKeySequence::Delete);
357 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
358 menu->addAction(del);
359
360 return menu;
361}
362
363QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
364{
365 // Get entries from default menu before adding our own
366 QMenu *const menu = new QMenu(parent);
367
368 QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
369 if (default_menu) {
370 for (QAction *action : default_menu->actions()) { // clazy:exclude=range-loop
371 menu->addAction(action);
372 if (action->parent() == default_menu)
373 action->setParent(menu);
374 }
375 delete default_menu;
376
377 // Add separator if needed
378 if (menu->actions().length() > 0)
379 menu->addSeparator();
380 }
381
382 try {
383 selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
384 } catch (out_of_range&) {
385 selected_row_ = nullptr;
386 }
387
388 const View *const view = owner_->view();
389 assert(view);
390 QPoint pos = view->viewport()->mapFrom(parent, click_pos);
391
392 // Default sample range is "from here"
393 const pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pos.x(), pos.x() + 1);
394 selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
395
396 if (decode_signal_->is_paused()) {
397 QAction *const resume =
398 new QAction(tr("Resume decoding"), this);
399 resume->setIcon(QIcon::fromTheme("media-playback-start",
400 QIcon(":/icons/media-playback-start.png")));
401 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
402 menu->addAction(resume);
403 } else {
404 QAction *const pause =
405 new QAction(tr("Pause decoding"), this);
406 pause->setIcon(QIcon::fromTheme("media-playback-pause",
407 QIcon(":/icons/media-playback-pause.png")));
408 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
409 menu->addAction(pause);
410 }
411
412 QAction *const copy_annotation_to_clipboard =
413 new QAction(tr("Copy annotation text to clipboard"), this);
414 copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste",
415 QIcon(":/icons/edit-paste.svg")));
416 connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard()));
417 menu->addAction(copy_annotation_to_clipboard);
418
419 menu->addSeparator();
420
421 QAction *const export_all_rows =
422 new QAction(tr("Export all annotations"), this);
423 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
424 QIcon(":/icons/document-save-as.png")));
425 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
426 menu->addAction(export_all_rows);
427
428 QAction *const export_row =
429 new QAction(tr("Export all annotations for this row"), this);
430 export_row->setIcon(QIcon::fromTheme("document-save-as",
431 QIcon(":/icons/document-save-as.png")));
432 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
433 menu->addAction(export_row);
434
435 menu->addSeparator();
436
437 QAction *const export_all_rows_from_here =
438 new QAction(tr("Export all annotations, starting here"), this);
439 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
440 QIcon(":/icons/document-save-as.png")));
441 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
442 menu->addAction(export_all_rows_from_here);
443
444 QAction *const export_row_from_here =
445 new QAction(tr("Export annotations for this row, starting here"), this);
446 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
447 QIcon(":/icons/document-save-as.png")));
448 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
449 menu->addAction(export_row_from_here);
450
451 menu->addSeparator();
452
453 QAction *const export_all_rows_with_cursor =
454 new QAction(tr("Export all annotations within cursor range"), this);
455 export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
456 QIcon(":/icons/document-save-as.png")));
457 connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
458 menu->addAction(export_all_rows_with_cursor);
459
460 QAction *const export_row_with_cursor =
461 new QAction(tr("Export annotations for this row within cursor range"), this);
462 export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
463 QIcon(":/icons/document-save-as.png")));
464 connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
465 menu->addAction(export_row_with_cursor);
466
467 if (!view->cursors()->enabled()) {
468 export_all_rows_with_cursor->setEnabled(false);
469 export_row_with_cursor->setEnabled(false);
470 }
471
472 return menu;
473}
474
475void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
476 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
477 QColor row_color, int row_title_width)
478{
479 using namespace pv::data::decode;
480
481 Annotation::Class block_class = 0;
482 bool block_class_uniform = true;
483 qreal block_start = 0;
484 int block_ann_count = 0;
485
486 const Annotation *prev_ann;
487 qreal prev_end = INT_MIN;
488
489 qreal a_end;
490
491 double samples_per_pixel, pixels_offset;
492 tie(pixels_offset, samples_per_pixel) =
493 get_pixels_offset_samples_per_pixel();
494
495 // Sort the annotations by start sample so that decoders
496 // can't confuse us by creating annotations out of order
497 stable_sort(annotations.begin(), annotations.end(),
498 [](const Annotation &a, const Annotation &b) {
499 return a.start_sample() < b.start_sample(); });
500
501 // Gather all annotations that form a visual "block" and draw them as such
502 for (const Annotation &a : annotations) {
503
504 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
505 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
506
507 const qreal a_start = abs_a_start - pixels_offset;
508 a_end = abs_a_end - pixels_offset;
509
510 const qreal a_width = a_end - a_start;
511 const qreal delta = a_end - prev_end;
512
513 bool a_is_separate = false;
514
515 // Annotation wider than the threshold for a useful label width?
516 if (a_width >= min_useful_label_width_) {
517 for (const QString &ann_text : a.annotations()) {
518 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
519 // Annotation wide enough to fit a label? Don't put it in a block then
520 if (w <= a_width) {
521 a_is_separate = true;
522 break;
523 }
524 }
525 }
526
527 // Were the previous and this annotation more than a pixel apart?
528 if ((abs(delta) > 1) || a_is_separate) {
529 // Block was broken, draw annotations that form the current block
530 if (block_ann_count == 1)
531 draw_annotation(*prev_ann, p, h, pp, y, row_color,
532 row_title_width);
533 else if (block_ann_count > 0)
534 draw_annotation_block(block_start, prev_end, block_class,
535 block_class_uniform, p, h, y, row_color);
536
537 block_ann_count = 0;
538 }
539
540 if (a_is_separate) {
541 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
542 // Next annotation must start a new block. delta will be > 1
543 // because we set prev_end to INT_MIN but that's okay since
544 // block_ann_count will be 0 and nothing will be drawn
545 prev_end = INT_MIN;
546 block_ann_count = 0;
547 } else {
548 prev_end = a_end;
549 prev_ann = &a;
550
551 if (block_ann_count == 0) {
552 block_start = a_start;
553 block_class = a.ann_class();
554 block_class_uniform = true;
555 } else
556 if (a.ann_class() != block_class)
557 block_class_uniform = false;
558
559 block_ann_count++;
560 }
561 }
562
563 if (block_ann_count == 1)
564 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
565 else if (block_ann_count > 0)
566 draw_annotation_block(block_start, prev_end, block_class,
567 block_class_uniform, p, h, y, row_color);
568}
569
570void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
571 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
572 QColor row_color, int row_title_width) const
573{
574 double samples_per_pixel, pixels_offset;
575 tie(pixels_offset, samples_per_pixel) =
576 get_pixels_offset_samples_per_pixel();
577
578 const double start = a.start_sample() / samples_per_pixel -
579 pixels_offset;
580 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
581
582 QColor color = get_annotation_color(row_color, a.ann_class());
583 p.setPen(color.darker());
584 p.setBrush(color);
585
586 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
587 return;
588
589 if (a.start_sample() == a.end_sample())
590 draw_instant(a, p, h, start, y);
591 else
592 draw_range(a, p, h, start, end, y, pp, row_title_width);
593}
594
595void DecodeTrace::draw_annotation_block(qreal start, qreal end,
596 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
597 int y, QColor row_color) const
598{
599 const double top = y + .5 - h / 2;
600 const double bottom = y + .5 + h / 2;
601
602 const QRectF rect(start, top, end - start, bottom - top);
603 const int r = h / 4;
604
605 p.setPen(QPen(Qt::NoPen));
606 p.setBrush(Qt::white);
607 p.drawRoundedRect(rect, r, r);
608
609 // If all annotations in this block are of the same type, we can use the
610 // one format that all of these annotations have. Otherwise, we should use
611 // a neutral color (i.e. gray)
612 if (use_ann_format) {
613 const QColor color = get_annotation_color(row_color, ann_class);
614 p.setPen(color.darker());
615 p.setBrush(QBrush(color, Qt::Dense4Pattern));
616 } else {
617 p.setPen(Qt::gray);
618 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
619 }
620
621 p.drawRoundedRect(rect, r, r);
622}
623
624void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
625 int h, qreal x, int y) const
626{
627 const QString text = a.annotations().empty() ?
628 QString() : a.annotations().back();
629 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
630 0.0) + h;
631 const QRectF rect(x - w / 2, y - h / 2, w, h);
632
633 p.drawRoundedRect(rect, h / 2, h / 2);
634
635 p.setPen(Qt::black);
636 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
637}
638
639void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
640 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
641 int row_title_width) const
642{
643 const qreal top = y + .5 - h / 2;
644 const qreal bottom = y + .5 + h / 2;
645 const vector<QString> annotations = a.annotations();
646
647 // If the two ends are within 1 pixel, draw a vertical line
648 if (start + 1.0 > end) {
649 p.drawLine(QPointF(start, top), QPointF(start, bottom));
650 return;
651 }
652
653 const qreal cap_width = min((end - start) / 4, EndCapWidth);
654
655 QPointF pts[] = {
656 QPointF(start, y + .5f),
657 QPointF(start + cap_width, top),
658 QPointF(end - cap_width, top),
659 QPointF(end, y + .5f),
660 QPointF(end - cap_width, bottom),
661 QPointF(start + cap_width, bottom)
662 };
663
664 p.drawConvexPolygon(pts, countof(pts));
665
666 if (annotations.empty())
667 return;
668
669 const int ann_start = start + cap_width;
670 const int ann_end = end - cap_width;
671
672 const int real_start = max(ann_start, pp.left() + row_title_width);
673 const int real_end = min(ann_end, pp.right());
674 const int real_width = real_end - real_start;
675
676 QRectF rect(real_start, y - h / 2, real_width, h);
677 if (rect.width() <= 4)
678 return;
679
680 p.setPen(Qt::black);
681
682 // Try to find an annotation that will fit
683 QString best_annotation;
684 int best_width = 0;
685
686 for (const QString &a : annotations) {
687 const int w = p.boundingRect(QRectF(), 0, a).width();
688 if (w <= rect.width() && w > best_width)
689 best_annotation = a, best_width = w;
690 }
691
692 if (best_annotation.isEmpty())
693 best_annotation = annotations.back();
694
695 // If not ellide the last in the list
696 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
697 best_annotation, Qt::ElideRight, rect.width()));
698}
699
700void DecodeTrace::draw_error(QPainter &p, const QString &message,
701 const ViewItemPaintParams &pp)
702{
703 const int y = get_visual_y();
704
705 double samples_per_pixel, pixels_offset;
706 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
707
708 p.setPen(ErrorBgColor.darker());
709 p.setBrush(ErrorBgColor);
710
711 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
712
713 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
714 const qreal r = text_rect.height() / 4;
715
716 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
717
718 p.setPen(Qt::black);
719 p.drawText(text_rect, message);
720}
721
722void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
723{
724 using namespace pv::data;
725 using pv::data::decode::Decoder;
726
727 double samples_per_pixel, pixels_offset;
728
729 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
730 if (sample_count == 0)
731 return;
732
733 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
734 if (sample_count == samples_decoded)
735 return;
736
737 const int y = get_visual_y();
738
739 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
740
741 const double start = max(samples_decoded /
742 samples_per_pixel - pixels_offset, left - 1.0);
743 const double end = min(sample_count / samples_per_pixel -
744 pixels_offset, right + 1.0);
745 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
746
747 p.setPen(QPen(Qt::NoPen));
748 p.setBrush(Qt::white);
749 p.drawRect(no_decode_rect);
750
751 p.setPen(NoDecodeColor);
752 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
753 p.drawRect(no_decode_rect);
754}
755
756pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
757{
758 assert(owner_);
759
760 const View *view = owner_->view();
761 assert(view);
762
763 const double scale = view->scale();
764 assert(scale > 0);
765
766 const double pixels_offset =
767 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
768
769 double samplerate = decode_signal_->samplerate();
770
771 // Show sample rate as 1Hz when it is unknown
772 if (samplerate == 0.0)
773 samplerate = 1.0;
774
775 return make_pair(pixels_offset, samplerate * scale);
776}
777
778pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
779 int x_start, int x_end) const
780{
781 double samples_per_pixel, pixels_offset;
782 tie(pixels_offset, samples_per_pixel) =
783 get_pixels_offset_samples_per_pixel();
784
785 const uint64_t start = (uint64_t)max(
786 (x_start + pixels_offset) * samples_per_pixel, 0.0);
787 const uint64_t end = (uint64_t)max(
788 (x_end + pixels_offset) * samples_per_pixel, 0.0);
789
790 return make_pair(start, end);
791}
792
793QColor DecodeTrace::get_row_color(int row_index) const
794{
795 // For each row color, use the base color hue and add an offset that's
796 // not a dividend of 360
797
798 QColor color;
799 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
800 const int s = DECODETRACE_COLOR_SATURATION;
801 const int v = DECODETRACE_COLOR_VALUE;
802 color.setHsl(h, s, v);
803
804 return color;
805}
806
807QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
808{
809 // For each row color, use the base color hue and add an offset that's
810 // not a dividend of 360 and not a multiple of the row offset
811
812 QColor color(row_color);
813 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
814 const int s = DECODETRACE_COLOR_SATURATION;
815 const int v = DECODETRACE_COLOR_VALUE;
816 color.setHsl(h, s, v);
817
818 return color;
819}
820
821int DecodeTrace::get_row_at_point(const QPoint &point)
822{
823 if (!row_height_)
824 return -1;
825
826 const int y = (point.y() - get_visual_y() + row_height_ / 2);
827
828 /* Integer divison of (x-1)/x would yield 0, so we check for this. */
829 if (y < 0)
830 return -1;
831
832 const int row = y / row_height_;
833
834 if (row >= (int)visible_rows_.size())
835 return -1;
836
837 return row;
838}
839
840const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
841{
842 using namespace pv::data::decode;
843
844 if (!enabled())
845 return QString();
846
847 const pair<uint64_t, uint64_t> sample_range =
848 get_view_sample_range(point.x(), point.x() + 1);
849 const int row = get_row_at_point(point);
850 if (row < 0)
851 return QString();
852
853 vector<Annotation> annotations;
854
855 decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
856 current_segment_, sample_range.first, sample_range.second);
857
858 return (annotations.empty()) ?
859 QString() : annotations[0].annotations().front();
860}
861
862void DecodeTrace::hover_point_changed(const QPoint &hp)
863{
864 Trace::hover_point_changed(hp);
865
866 assert(owner_);
867
868 const View *const view = owner_->view();
869 assert(view);
870
871 if (hp.x() == 0) {
872 QToolTip::hideText();
873 return;
874 }
875
876 QString ann = get_annotation_at_point(hp);
877
878 if (!row_height_ || ann.isEmpty()) {
879 QToolTip::hideText();
880 return;
881 }
882
883 const int hover_row = get_row_at_point(hp);
884
885 QFontMetrics m(QToolTip::font());
886 const QRect text_size = m.boundingRect(QRect(), 0, ann);
887
888 // This is OS-specific and unfortunately we can't query it, so
889 // use an approximation to at least try to minimize the error.
890 const int padding = 8;
891
892 // Make sure the tool tip doesn't overlap with the mouse cursor.
893 // If it did, the tool tip would constantly hide and re-appear.
894 // We also push it up by one row so that it appears above the
895 // decode trace, not below.
896 QPoint p = hp;
897 p.setX(hp.x() - (text_size.width() / 2) - padding);
898
899 p.setY(get_visual_y() - (row_height_ / 2) +
900 (hover_row * row_height_) -
901 row_height_ - text_size.height() - padding);
902
903 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
904}
905
906void DecodeTrace::create_decoder_form(int index,
907 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
908 QFormLayout *form)
909{
910 GlobalSettings settings;
911
912 assert(dec);
913 const srd_decoder *const decoder = dec->decoder();
914 assert(decoder);
915
916 const bool decoder_deletable = index > 0;
917
918 pv::widgets::DecoderGroupBox *const group =
919 new pv::widgets::DecoderGroupBox(
920 QString::fromUtf8(decoder->name),
921 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
922 QString::fromUtf8(decoder->desc)),
923 nullptr, decoder_deletable);
924 group->set_decoder_visible(dec->shown());
925
926 if (decoder_deletable) {
927 delete_mapper_.setMapping(group, index);
928 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
929 }
930
931 show_hide_mapper_.setMapping(group, index);
932 connect(group, SIGNAL(show_hide_decoder()),
933 &show_hide_mapper_, SLOT(map()));
934
935 QFormLayout *const decoder_form = new QFormLayout;
936 group->add_layout(decoder_form);
937
938 const vector<DecodeChannel> channels = decode_signal_->get_channels();
939
940 // Add the channels
941 for (const DecodeChannel& ch : channels) {
942 // Ignore channels not part of the decoder we create the form for
943 if (ch.decoder_ != dec)
944 continue;
945
946 QComboBox *const combo = create_channel_selector(parent, &ch);
947 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
948
949 channel_id_map_[combo] = ch.id;
950 init_state_map_[combo_init_state] = ch.id;
951
952 connect(combo, SIGNAL(currentIndexChanged(int)),
953 this, SLOT(on_channel_selected(int)));
954 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
955 this, SLOT(on_init_state_changed(int)));
956
957 QHBoxLayout *const hlayout = new QHBoxLayout;
958 hlayout->addWidget(combo);
959 hlayout->addWidget(combo_init_state);
960
961 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
962 combo_init_state->hide();
963
964 const QString required_flag = ch.is_optional ? QString() : QString("*");
965 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
966 .arg(ch.name, ch.desc, required_flag), hlayout);
967 }
968
969 // Add the options
970 shared_ptr<binding::Decoder> binding(
971 new binding::Decoder(decode_signal_, dec));
972 binding->add_properties_to_form(decoder_form, true);
973
974 bindings_.push_back(binding);
975
976 form->addRow(group);
977 decoder_forms_.push_back(group);
978}
979
980QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
981{
982 const auto sigs(session_.signalbases());
983
984 // Sort signals in natural order
985 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
986 sort(sig_list.begin(), sig_list.end(),
987 [](const shared_ptr<data::SignalBase> &a,
988 const shared_ptr<data::SignalBase> &b) {
989 return strnatcasecmp(a->name().toStdString(),
990 b->name().toStdString()) < 0; });
991
992 QComboBox *selector = new QComboBox(parent);
993
994 selector->addItem("-", qVariantFromValue((void*)nullptr));
995
996 if (!ch->assigned_signal)
997 selector->setCurrentIndex(0);
998
999 for (const shared_ptr<data::SignalBase> &b : sig_list) {
1000 assert(b);
1001 if (b->logic_data() && b->enabled()) {
1002 selector->addItem(b->name(),
1003 qVariantFromValue((void*)b.get()));
1004
1005 if (ch->assigned_signal == b.get())
1006 selector->setCurrentIndex(selector->count() - 1);
1007 }
1008 }
1009
1010 return selector;
1011}
1012
1013QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
1014 const DecodeChannel *ch)
1015{
1016 QComboBox *selector = new QComboBox(parent);
1017
1018 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
1019 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
1020 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
1021
1022 selector->setCurrentIndex(ch->initial_pin_state);
1023
1024 selector->setToolTip("Initial (assumed) pin value before the first sample");
1025
1026 return selector;
1027}
1028
1029void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
1030{
1031 using namespace pv::data::decode;
1032
1033 GlobalSettings settings;
1034 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
1035
1036 const QString file_name = QFileDialog::getSaveFileName(
1037 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1038
1039 if (file_name.isEmpty())
1040 return;
1041
1042 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1043 const QString quote = format.contains("%q") ? "\"" : "";
1044 format = format.remove("%q");
1045
1046 QFile file(file_name);
1047 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1048 QTextStream out_stream(&file);
1049
1050 for (Annotation &ann : *annotations) {
1051 const QString sample_range = QString("%1-%2") \
1052 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
1053
1054 const QString class_name = quote + ann.row()->class_name() + quote;
1055
1056 QString all_ann_text;
1057 for (const QString &s : ann.annotations())
1058 all_ann_text = all_ann_text + quote + s + quote + ",";
1059 all_ann_text.chop(1);
1060
1061 const QString first_ann_text = quote + ann.annotations().front() + quote;
1062
1063 QString out_text = format;
1064 out_text = out_text.replace("%s", sample_range);
1065 out_text = out_text.replace("%d",
1066 quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
1067 out_text = out_text.replace("%c", class_name);
1068 out_text = out_text.replace("%1", first_ann_text);
1069 out_text = out_text.replace("%a", all_ann_text);
1070 out_stream << out_text << '\n';
1071 }
1072
1073 if (out_stream.status() == QTextStream::Ok)
1074 return;
1075 }
1076
1077 QMessageBox msg(owner_->view());
1078 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1079 msg.setStandardButtons(QMessageBox::Ok);
1080 msg.setIcon(QMessageBox::Warning);
1081 msg.exec();
1082}
1083
1084void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
1085{
1086 if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
1087 visible_rows_.clear();
1088 max_visible_rows_ = 0;
1089 always_show_all_rows_ = value.toBool();
1090 }
1091}
1092
1093void DecodeTrace::on_new_annotations()
1094{
1095 if (!delayed_trace_updater_.isActive())
1096 delayed_trace_updater_.start();
1097}
1098
1099void DecodeTrace::on_delayed_trace_update()
1100{
1101 if (owner_)
1102 owner_->row_item_appearance_changed(false, true);
1103}
1104
1105void DecodeTrace::on_decode_reset()
1106{
1107 visible_rows_.clear();
1108 max_visible_rows_ = 0;
1109
1110 if (owner_)
1111 owner_->row_item_appearance_changed(false, true);
1112}
1113
1114void DecodeTrace::on_decode_finished()
1115{
1116 if (owner_)
1117 owner_->row_item_appearance_changed(false, true);
1118}
1119
1120void DecodeTrace::on_pause_decode()
1121{
1122 if (decode_signal_->is_paused())
1123 decode_signal_->resume_decode();
1124 else
1125 decode_signal_->pause_decode();
1126}
1127
1128void DecodeTrace::delete_pressed()
1129{
1130 on_delete();
1131}
1132
1133void DecodeTrace::on_delete()
1134{
1135 session_.remove_decode_signal(decode_signal_);
1136}
1137
1138void DecodeTrace::on_channel_selected(int)
1139{
1140 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1141
1142 // Determine signal that was selected
1143 const data::SignalBase *signal =
1144 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1145
1146 // Determine decode channel ID this combo box is the channel selector for
1147 const uint16_t id = channel_id_map_.at(cb);
1148
1149 decode_signal_->assign_signal(id, signal);
1150}
1151
1152void DecodeTrace::on_channels_updated()
1153{
1154 if (owner_)
1155 owner_->row_item_appearance_changed(false, true);
1156}
1157
1158void DecodeTrace::on_init_state_changed(int)
1159{
1160 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1161
1162 // Determine inital pin state that was selected
1163 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1164
1165 // Determine decode channel ID this combo box is the channel selector for
1166 const uint16_t id = init_state_map_.at(cb);
1167
1168 decode_signal_->set_initial_pin_state(id, init_state);
1169}
1170
1171void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1172{
1173 decode_signal_->stack_decoder(decoder);
1174
1175 create_popup_form();
1176}
1177
1178void DecodeTrace::on_delete_decoder(int index)
1179{
1180 decode_signal_->remove_decoder(index);
1181
1182 // Force re-calculation of the trace height, see paint_mid()
1183 max_visible_rows_ = 0;
1184 owner_->extents_changed(false, true);
1185
1186 // Update the popup
1187 create_popup_form();
1188}
1189
1190void DecodeTrace::on_show_hide_decoder(int index)
1191{
1192 const bool state = decode_signal_->toggle_decoder_visibility(index);
1193
1194 assert(index < (int)decoder_forms_.size());
1195 decoder_forms_[index]->set_decoder_visible(state);
1196
1197 if (!state) {
1198 // Force re-calculation of the trace height, see paint_mid()
1199 max_visible_rows_ = 0;
1200 owner_->extents_changed(false, true);
1201 }
1202
1203 if (owner_)
1204 owner_->row_item_appearance_changed(false, true);
1205}
1206
1207void DecodeTrace::on_copy_annotation_to_clipboard()
1208{
1209 using namespace pv::data::decode;
1210
1211 if (!selected_row_)
1212 return;
1213
1214 vector<Annotation> *annotations = new vector<Annotation>();
1215
1216 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1217 current_segment_, selected_sample_range_.first, selected_sample_range_.first);
1218
1219 if (annotations->empty())
1220 return;
1221
1222 QClipboard *clipboard = QApplication::clipboard();
1223 clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard);
1224
1225 if (clipboard->supportsSelection())
1226 clipboard->setText(annotations->front().annotations().front(), QClipboard::Selection);
1227
1228 delete annotations;
1229}
1230
1231void DecodeTrace::on_export_row()
1232{
1233 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1234 on_export_row_from_here();
1235}
1236
1237void DecodeTrace::on_export_all_rows()
1238{
1239 selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1240 on_export_all_rows_from_here();
1241}
1242
1243void DecodeTrace::on_export_row_with_cursor()
1244{
1245 const View *view = owner_->view();
1246 assert(view);
1247
1248 if (!view->cursors()->enabled())
1249 return;
1250
1251 const double samplerate = session_.get_samplerate();
1252
1253 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1254 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1255
1256 const uint64_t start_sample = (uint64_t)max(
1257 0.0, start_time.convert_to<double>() * samplerate);
1258 const uint64_t end_sample = (uint64_t)max(
1259 0.0, end_time.convert_to<double>() * samplerate);
1260
1261 // Are both cursors negative and thus were clamped to 0?
1262 if ((start_sample == 0) && (end_sample == 0))
1263 return;
1264
1265 selected_sample_range_ = make_pair(start_sample, end_sample);
1266 on_export_row_from_here();
1267}
1268
1269void DecodeTrace::on_export_all_rows_with_cursor()
1270{
1271 const View *view = owner_->view();
1272 assert(view);
1273
1274 if (!view->cursors()->enabled())
1275 return;
1276
1277 const double samplerate = session_.get_samplerate();
1278
1279 const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1280 const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1281
1282 const uint64_t start_sample = (uint64_t)max(
1283 0.0, start_time.convert_to<double>() * samplerate);
1284 const uint64_t end_sample = (uint64_t)max(
1285 0.0, end_time.convert_to<double>() * samplerate);
1286
1287 // Are both cursors negative and thus were clamped to 0?
1288 if ((start_sample == 0) && (end_sample == 0))
1289 return;
1290
1291 selected_sample_range_ = make_pair(start_sample, end_sample);
1292 on_export_all_rows_from_here();
1293}
1294
1295void DecodeTrace::on_export_row_from_here()
1296{
1297 using namespace pv::data::decode;
1298
1299 if (!selected_row_)
1300 return;
1301
1302 vector<Annotation> *annotations = new vector<Annotation>();
1303
1304 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1305 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1306
1307 if (annotations->empty())
1308 return;
1309
1310 export_annotations(annotations);
1311 delete annotations;
1312}
1313
1314void DecodeTrace::on_export_all_rows_from_here()
1315{
1316 using namespace pv::data::decode;
1317
1318 vector<Annotation> *annotations = new vector<Annotation>();
1319
1320 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1321 selected_sample_range_.first, selected_sample_range_.second);
1322
1323 if (!annotations->empty())
1324 export_annotations(annotations);
1325
1326 delete annotations;
1327}
1328
1329} // namespace trace
1330} // namespace views
1331} // namespace pv
Qt based LA/scope/MSO GUI