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