DecodeTrace: Speed up painting by not copying the annotations
[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 <mutex>
25
26 #include <extdef.h>
27
28 #include <tuple>
29
30 #include <boost/functional/hash.hpp>
31
32 #include <QAction>
33 #include <QApplication>
34 #include <QComboBox>
35 #include <QFormLayout>
36 #include <QLabel>
37 #include <QMenu>
38 #include <QPushButton>
39 #include <QToolTip>
40
41 #include "decodetrace.hpp"
42 #include "view.hpp"
43 #include "viewport.hpp"
44
45 #include <pv/globalsettings.hpp>
46 #include <pv/session.hpp>
47 #include <pv/strnatcmp.hpp>
48 #include <pv/data/decodesignal.hpp>
49 #include <pv/data/decode/annotation.hpp>
50 #include <pv/data/decode/decoder.hpp>
51 #include <pv/data/logic.hpp>
52 #include <pv/data/logicsegment.hpp>
53 #include <pv/widgets/decodergroupbox.hpp>
54 #include <pv/widgets/decodermenu.hpp>
55
56 using std::all_of;
57 using std::make_pair;
58 using std::max;
59 using std::min;
60 using std::out_of_range;
61 using std::pair;
62 using std::shared_ptr;
63 using std::tie;
64 using std::vector;
65
66 using pv::data::decode::Annotation;
67 using pv::data::decode::Row;
68 using pv::data::DecodeChannel;
69 using pv::data::DecodeSignal;
70
71 namespace pv {
72 namespace views {
73 namespace trace {
74
75
76 #define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
77 #define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
78
79 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
80 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
81
82 const int DecodeTrace::ArrowSize = 4;
83 const double DecodeTrace::EndCapWidth = 5;
84 const int DecodeTrace::RowTitleMargin = 10;
85 const int DecodeTrace::DrawPadding = 100;
86
87 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
88
89 DecodeTrace::DecodeTrace(pv::Session &session,
90         shared_ptr<data::SignalBase> signalbase, int index) :
91         Trace(signalbase),
92         session_(session),
93         row_height_(0),
94         max_visible_rows_(0),
95         delete_mapper_(this),
96         show_hide_mapper_(this)
97 {
98         decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
99
100         // Determine shortest string we want to see displayed in full
101         QFontMetrics m(QApplication::font());
102         min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
103
104         // For the base color, we want to start at a very different color for
105         // every decoder stack, so multiply the index with a number that is
106         // rather close to 180 degrees of the color circle but not a dividend of 360
107         // Note: The offset equals the color of the first annotation
108         QColor color;
109         const int h = (120 + 160 * index) % 360;
110         const int s = DECODETRACE_COLOR_SATURATION;
111         const int v = DECODETRACE_COLOR_VALUE;
112         color.setHsv(h, s, v);
113         base_->set_color(color);
114
115         connect(decode_signal_.get(), SIGNAL(new_annotations()),
116                 this, SLOT(on_new_annotations()));
117         connect(decode_signal_.get(), SIGNAL(decode_reset()),
118                 this, SLOT(on_decode_reset()));
119         connect(decode_signal_.get(), SIGNAL(decode_finished()),
120                 this, SLOT(on_decode_finished()));
121         connect(decode_signal_.get(), SIGNAL(channels_updated()),
122                 this, SLOT(on_channels_updated()));
123
124         connect(&delete_mapper_, SIGNAL(mapped(int)),
125                 this, SLOT(on_delete_decoder(int)));
126         connect(&show_hide_mapper_, SIGNAL(mapped(int)),
127                 this, SLOT(on_show_hide_decoder(int)));
128
129         connect(&delayed_trace_updater_, SIGNAL(timeout()),
130                 this, SLOT(on_delayed_trace_update()));
131         delayed_trace_updater_.setSingleShot(true);
132         delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
133 }
134
135 bool DecodeTrace::enabled() const
136 {
137         return true;
138 }
139
140 shared_ptr<data::SignalBase> DecodeTrace::base() const
141 {
142         return base_;
143 }
144
145 pair<int, int> DecodeTrace::v_extents() const
146 {
147         const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
148
149         // Make an empty decode trace appear symmetrical
150         const int row_count = max(1, max_visible_rows_);
151
152         return make_pair(-row_height, row_height * row_count);
153 }
154
155 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
156 {
157         Trace::paint_back(p, pp);
158         paint_axis(p, pp, get_visual_y());
159 }
160
161 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
162 {
163         const int text_height = ViewItemPaintParams::text_height();
164         row_height_ = (text_height * 6) / 4;
165         const int annotation_height = (text_height * 5) / 4;
166
167         const QString err = decode_signal_->error_message();
168         if (!err.isEmpty()) {
169                 draw_unresolved_period(
170                         p, annotation_height, pp.left(), pp.right());
171                 draw_error(p, err, pp);
172                 return;
173         }
174
175         // Set default pen to allow for text width calculation
176         p.setPen(Qt::black);
177
178         // Iterate through the rows
179         int y = get_visual_y();
180         pair<uint64_t, uint64_t> sample_range = get_sample_range(
181                 pp.left(), pp.right());
182
183         const vector<Row> rows = decode_signal_->visible_rows();
184
185         visible_rows_.clear();
186         for (const Row& row : rows) {
187                 // Cache the row title widths
188                 int row_title_width;
189                 try {
190                         row_title_width = row_title_widths_.at(row);
191                 } catch (out_of_range&) {
192                         const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
193                                 RowTitleMargin;
194                         row_title_widths_[row] = w;
195                         row_title_width = w;
196                 }
197
198                 vector<Annotation> annotations;
199                 decode_signal_->get_annotation_subset(annotations, row,
200                         current_segment_, sample_range.first, sample_range.second);
201                 if (!annotations.empty()) {
202                         draw_annotations(annotations, p, annotation_height, pp, y,
203                                 get_row_color(visible_rows_.size()), row_title_width);
204
205                         y += row_height_;
206
207                         visible_rows_.push_back(row);
208                 }
209         }
210
211         // Draw the hatching
212         draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
213
214         if ((int)visible_rows_.size() > max_visible_rows_) {
215                 max_visible_rows_ = (int)visible_rows_.size();
216
217                 // Call order is important, otherwise the lazy event handler won't work
218                 owner_->extents_changed(false, true);
219                 owner_->row_item_appearance_changed(false, true);
220         }
221 }
222
223 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
224 {
225         assert(row_height_);
226
227         for (size_t i = 0; i < visible_rows_.size(); i++) {
228                 const int y = i * row_height_ + get_visual_y();
229
230                 p.setPen(QPen(Qt::NoPen));
231                 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
232
233                 if (i != 0) {
234                         const QPointF points[] = {
235                                 QPointF(pp.left(), y - ArrowSize),
236                                 QPointF(pp.left() + ArrowSize, y),
237                                 QPointF(pp.left(), y + ArrowSize)
238                         };
239                         p.drawPolygon(points, countof(points));
240                 }
241
242                 const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
243                         pp.right() - pp.left(), row_height_);
244                 const QString h(visible_rows_[i].title());
245                 const int f = Qt::AlignLeft | Qt::AlignVCenter |
246                         Qt::TextDontClip;
247
248                 // Draw the outline
249                 p.setPen(QApplication::palette().color(QPalette::Base));
250                 for (int dx = -1; dx <= 1; dx++)
251                         for (int dy = -1; dy <= 1; dy++)
252                                 if (dx != 0 && dy != 0)
253                                         p.drawText(r.translated(dx, dy), f, h);
254
255                 // Draw the text
256                 p.setPen(QApplication::palette().color(QPalette::WindowText));
257                 p.drawText(r, f, h);
258         }
259 }
260
261 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
262 {
263         using pv::data::decode::Decoder;
264
265         assert(form);
266
267         // Add the standard options
268         Trace::populate_popup_form(parent, form);
269
270         // Add the decoder options
271         bindings_.clear();
272         channel_id_map_.clear();
273         init_state_map_.clear();
274         decoder_forms_.clear();
275
276         const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
277
278         if (stack.empty()) {
279                 QLabel *const l = new QLabel(
280                         tr("<p><i>No decoders in the stack</i></p>"));
281                 l->setAlignment(Qt::AlignCenter);
282                 form->addRow(l);
283         } else {
284                 auto iter = stack.cbegin();
285                 for (int i = 0; i < (int)stack.size(); i++, iter++) {
286                         shared_ptr<Decoder> dec(*iter);
287                         create_decoder_form(i, dec, parent, form);
288                 }
289
290                 form->addRow(new QLabel(
291                         tr("<i>* Required channels</i>"), parent));
292         }
293
294         // Add stacking button
295         pv::widgets::DecoderMenu *const decoder_menu =
296                 new pv::widgets::DecoderMenu(parent);
297         connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
298                 this, SLOT(on_stack_decoder(srd_decoder*)));
299
300         QPushButton *const stack_button =
301                 new QPushButton(tr("Stack Decoder"), parent);
302         stack_button->setMenu(decoder_menu);
303         stack_button->setToolTip(tr("Stack a higher-level decoder on top of this one"));
304
305         QHBoxLayout *stack_button_box = new QHBoxLayout;
306         stack_button_box->addWidget(stack_button, 0, Qt::AlignRight);
307         form->addRow(stack_button_box);
308 }
309
310 QMenu* DecodeTrace::create_context_menu(QWidget *parent)
311 {
312         QMenu *const menu = Trace::create_context_menu(parent);
313
314         menu->addSeparator();
315
316         QAction *const del = new QAction(tr("Delete"), this);
317         del->setShortcuts(QKeySequence::Delete);
318         connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
319         menu->addAction(del);
320
321         return menu;
322 }
323
324 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
325                 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
326                 QColor row_color, int row_title_width)
327 {
328         using namespace pv::data::decode;
329
330         Annotation::Class block_class = 0;
331         bool block_class_uniform = true;
332         int block_start = 0;
333         int block_ann_count = 0;
334
335         const Annotation *prev_ann;
336         int prev_end = INT_MIN;
337
338         int a_end;
339
340         double samples_per_pixel, pixels_offset;
341         tie(pixels_offset, samples_per_pixel) =
342                 get_pixels_offset_samples_per_pixel();
343
344         // Sort the annotations by start sample so that decoders
345         // can't confuse us by creating annotations out of order
346         stable_sort(annotations.begin(), annotations.end(),
347                 [](const Annotation &a, const Annotation &b) {
348                         return a.start_sample() < b.start_sample(); });
349
350         // Gather all annotations that form a visual "block" and draw them as such
351         for (const Annotation &a : annotations) {
352
353                 const int abs_a_start = a.start_sample() / samples_per_pixel;
354                 const int abs_a_end   = a.end_sample() / samples_per_pixel;
355
356                 const int a_start = abs_a_start - pixels_offset;
357                 a_end = abs_a_end - pixels_offset;
358
359                 const int a_width = a_end - a_start;
360                 const int delta = a_end - prev_end;
361
362                 bool a_is_separate = false;
363
364                 // Annotation wider than the threshold for a useful label width?
365                 if (a_width >= min_useful_label_width_) {
366                         for (const QString &ann_text : a.annotations()) {
367                                 const int w = p.boundingRect(QRectF(), 0, ann_text).width();
368                                 // Annotation wide enough to fit a label? Don't put it in a block then
369                                 if (w <= a_width) {
370                                         a_is_separate = true;
371                                         break;
372                                 }
373                         }
374                 }
375
376                 // Were the previous and this annotation more than a pixel apart?
377                 if ((abs(delta) > 1) || a_is_separate) {
378                         // Block was broken, draw annotations that form the current block
379                         if (block_ann_count == 1)
380                                 draw_annotation(*prev_ann, p, h, pp, y, row_color,
381                                         row_title_width);
382                         else if (block_ann_count > 0)
383                                 draw_annotation_block(block_start, prev_end, block_class,
384                                         block_class_uniform, p, h, y, row_color);
385
386                         block_ann_count = 0;
387                 }
388
389                 if (a_is_separate) {
390                         draw_annotation(a, p, h, pp, y, row_color, row_title_width);
391                         // Next annotation must start a new block. delta will be > 1
392                         // because we set prev_end to INT_MIN but that's okay since
393                         // block_ann_count will be 0 and nothing will be drawn
394                         prev_end = INT_MIN;
395                 } else {
396                         prev_end = a_end;
397                         prev_ann = &a;
398
399                         if (block_ann_count == 0) {
400                                 block_start = a_start;
401                                 block_class = a.ann_class();
402                                 block_class_uniform = true;
403                         } else
404                                 if (a.ann_class() != block_class)
405                                         block_class_uniform = false;
406
407                         block_ann_count++;
408                 }
409         }
410
411         if (block_ann_count == 1)
412                 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
413         else if (block_ann_count > 0)
414                 draw_annotation_block(block_start, prev_end, block_class,
415                         block_class_uniform, p, h, y, row_color);
416 }
417
418 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
419         QPainter &p, int h, const ViewItemPaintParams &pp, int y,
420         QColor row_color, int row_title_width) const
421 {
422         double samples_per_pixel, pixels_offset;
423         tie(pixels_offset, samples_per_pixel) =
424                 get_pixels_offset_samples_per_pixel();
425
426         const double start = a.start_sample() / samples_per_pixel -
427                 pixels_offset;
428         const double end = a.end_sample() / samples_per_pixel - pixels_offset;
429
430         QColor color = get_annotation_color(row_color, a.ann_class());
431         p.setPen(color.darker());
432         p.setBrush(color);
433
434         if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
435                 return;
436
437         if (a.start_sample() == a.end_sample())
438                 draw_instant(a, p, h, start, y);
439         else
440                 draw_range(a, p, h, start, end, y, pp, row_title_width);
441 }
442
443 void DecodeTrace::draw_annotation_block(int start, int end,
444         Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
445         int y, QColor row_color) const
446 {
447         const double top = y + .5 - h / 2;
448         const double bottom = y + .5 + h / 2;
449
450         const QRectF rect(start, top, end - start, bottom - top);
451         const int r = h / 4;
452
453         p.setPen(QPen(Qt::NoPen));
454         p.setBrush(Qt::white);
455         p.drawRoundedRect(rect, r, r);
456
457         // If all annotations in this block are of the same type, we can use the
458         // one format that all of these annotations have. Otherwise, we should use
459         // a neutral color (i.e. gray)
460         if (use_ann_format) {
461                 const QColor color = get_annotation_color(row_color, ann_class);
462                 p.setPen(color.darker());
463                 p.setBrush(QBrush(color, Qt::Dense4Pattern));
464         } else {
465                 p.setPen(Qt::gray);
466                 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
467         }
468
469         p.drawRoundedRect(rect, r, r);
470 }
471
472 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
473         int h, double x, int y) const
474 {
475         const QString text = a.annotations().empty() ?
476                 QString() : a.annotations().back();
477         const double w = min((double)p.boundingRect(QRectF(), 0, text).width(),
478                 0.0) + h;
479         const QRectF rect(x - w / 2, y - h / 2, w, h);
480
481         p.drawRoundedRect(rect, h / 2, h / 2);
482
483         p.setPen(Qt::black);
484         p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
485 }
486
487 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
488         int h, double start, double end, int y, const ViewItemPaintParams &pp,
489         int row_title_width) const
490 {
491         const double top = y + .5 - h / 2;
492         const double bottom = y + .5 + h / 2;
493         const vector<QString> annotations = a.annotations();
494
495         // If the two ends are within 1 pixel, draw a vertical line
496         if (start + 1.0 > end) {
497                 p.drawLine(QPointF(start, top), QPointF(start, bottom));
498                 return;
499         }
500
501         const double cap_width = min((end - start) / 4, EndCapWidth);
502
503         QPointF pts[] = {
504                 QPointF(start, y + .5f),
505                 QPointF(start + cap_width, top),
506                 QPointF(end - cap_width, top),
507                 QPointF(end, y + .5f),
508                 QPointF(end - cap_width, bottom),
509                 QPointF(start + cap_width, bottom)
510         };
511
512         p.drawConvexPolygon(pts, countof(pts));
513
514         if (annotations.empty())
515                 return;
516
517         const int ann_start = start + cap_width;
518         const int ann_end = end - cap_width;
519
520         const int real_start = max(ann_start, pp.left() + row_title_width);
521         const int real_end = min(ann_end, pp.right());
522         const int real_width = real_end - real_start;
523
524         QRectF rect(real_start, y - h / 2, real_width, h);
525         if (rect.width() <= 4)
526                 return;
527
528         p.setPen(Qt::black);
529
530         // Try to find an annotation that will fit
531         QString best_annotation;
532         int best_width = 0;
533
534         for (const QString &a : annotations) {
535                 const int w = p.boundingRect(QRectF(), 0, a).width();
536                 if (w <= rect.width() && w > best_width)
537                         best_annotation = a, best_width = w;
538         }
539
540         if (best_annotation.isEmpty())
541                 best_annotation = annotations.back();
542
543         // If not ellide the last in the list
544         p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
545                 best_annotation, Qt::ElideRight, rect.width()));
546 }
547
548 void DecodeTrace::draw_error(QPainter &p, const QString &message,
549         const ViewItemPaintParams &pp)
550 {
551         const int y = get_visual_y();
552
553         p.setPen(ErrorBgColor.darker());
554         p.setBrush(ErrorBgColor);
555
556         const QRectF bounding_rect =
557                 QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
558         const QRectF text_rect = p.boundingRect(bounding_rect,
559                 Qt::AlignCenter, message);
560         const float r = text_rect.height() / 4;
561
562         p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r,
563                 Qt::AbsoluteSize);
564
565         p.setPen(Qt::black);
566         p.drawText(text_rect, message);
567 }
568
569 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
570 {
571         using namespace pv::data;
572         using pv::data::decode::Decoder;
573
574         double samples_per_pixel, pixels_offset;
575
576         const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
577         if (sample_count == 0)
578                 return;
579
580         const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_);
581         if (sample_count == samples_decoded)
582                 return;
583
584         const int y = get_visual_y();
585
586         tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
587
588         const double start = max(samples_decoded /
589                 samples_per_pixel - pixels_offset, left - 1.0);
590         const double end = min(sample_count / samples_per_pixel -
591                 pixels_offset, right + 1.0);
592         const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
593
594         p.setPen(QPen(Qt::NoPen));
595         p.setBrush(Qt::white);
596         p.drawRect(no_decode_rect);
597
598         p.setPen(NoDecodeColor);
599         p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
600         p.drawRect(no_decode_rect);
601 }
602
603 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
604 {
605         assert(owner_);
606
607         const View *view = owner_->view();
608         assert(view);
609
610         const double scale = view->scale();
611         assert(scale > 0);
612
613         const double pixels_offset =
614                 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
615
616         double samplerate = decode_signal_->samplerate();
617
618         // Show sample rate as 1Hz when it is unknown
619         if (samplerate == 0.0)
620                 samplerate = 1.0;
621
622         return make_pair(pixels_offset, samplerate * scale);
623 }
624
625 pair<uint64_t, uint64_t> DecodeTrace::get_sample_range(
626         int x_start, int x_end) const
627 {
628         double samples_per_pixel, pixels_offset;
629         tie(pixels_offset, samples_per_pixel) =
630                 get_pixels_offset_samples_per_pixel();
631
632         const uint64_t start = (uint64_t)max(
633                 (x_start + pixels_offset) * samples_per_pixel, 0.0);
634         const uint64_t end = (uint64_t)max(
635                 (x_end + pixels_offset) * samples_per_pixel, 0.0);
636
637         return make_pair(start, end);
638 }
639
640 QColor DecodeTrace::get_row_color(int row_index) const
641 {
642         // For each row color, use the base color hue and add an offset that's
643         // not a dividend of 360
644
645         QColor color;
646         const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
647         const int s = DECODETRACE_COLOR_SATURATION;
648         const int v = DECODETRACE_COLOR_VALUE;
649         color.setHsl(h, s, v);
650
651         return color;
652 }
653
654 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
655 {
656         // For each row color, use the base color hue and add an offset that's
657         // not a dividend of 360 and not a multiple of the row offset
658
659         QColor color(row_color);
660         const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
661         const int s = DECODETRACE_COLOR_SATURATION;
662         const int v = DECODETRACE_COLOR_VALUE;
663         color.setHsl(h, s, v);
664
665         return color;
666 }
667
668 int DecodeTrace::get_row_at_point(const QPoint &point)
669 {
670         if (!row_height_)
671                 return -1;
672
673         const int y = (point.y() - get_visual_y() + row_height_ / 2);
674
675         /* Integer divison of (x-1)/x would yield 0, so we check for this. */
676         if (y < 0)
677                 return -1;
678
679         const int row = y / row_height_;
680
681         if (row >= (int)visible_rows_.size())
682                 return -1;
683
684         return row;
685 }
686
687 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
688 {
689         using namespace pv::data::decode;
690
691         if (!enabled())
692                 return QString();
693
694         const pair<uint64_t, uint64_t> sample_range =
695                 get_sample_range(point.x(), point.x() + 1);
696         const int row = get_row_at_point(point);
697         if (row < 0)
698                 return QString();
699
700         vector<pv::data::decode::Annotation> annotations;
701
702         decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
703                 current_segment_, sample_range.first, sample_range.second);
704
705         return (annotations.empty()) ?
706                 QString() : annotations[0].annotations().front();
707 }
708
709 void DecodeTrace::hover_point_changed(const QPoint &hp)
710 {
711         assert(owner_);
712
713         const View *const view = owner_->view();
714         assert(view);
715
716         if (hp.x() == 0) {
717                 QToolTip::hideText();
718                 return;
719         }
720
721         QString ann = get_annotation_at_point(hp);
722
723         assert(view);
724
725         if (!row_height_ || ann.isEmpty()) {
726                 QToolTip::hideText();
727                 return;
728         }
729
730         const int hover_row = get_row_at_point(hp);
731
732         QFontMetrics m(QToolTip::font());
733         const QRect text_size = m.boundingRect(QRect(), 0, ann);
734
735         // This is OS-specific and unfortunately we can't query it, so
736         // use an approximation to at least try to minimize the error.
737         const int padding = 8;
738
739         // Make sure the tool tip doesn't overlap with the mouse cursor.
740         // If it did, the tool tip would constantly hide and re-appear.
741         // We also push it up by one row so that it appears above the
742         // decode trace, not below.
743         QPoint p = hp;
744         p.setX(hp.x() - (text_size.width() / 2) - padding);
745
746         p.setY(get_visual_y() - (row_height_ / 2) +
747                 (hover_row * row_height_) -
748                 row_height_ - text_size.height() - padding);
749
750         QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
751 }
752
753 void DecodeTrace::create_decoder_form(int index,
754         shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
755         QFormLayout *form)
756 {
757         GlobalSettings settings;
758
759         assert(dec);
760         const srd_decoder *const decoder = dec->decoder();
761         assert(decoder);
762
763         const bool decoder_deletable = index > 0;
764
765         pv::widgets::DecoderGroupBox *const group =
766                 new pv::widgets::DecoderGroupBox(
767                         QString::fromUtf8(decoder->name),
768                         tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
769                                 QString::fromUtf8(decoder->desc)),
770                         nullptr, decoder_deletable);
771         group->set_decoder_visible(dec->shown());
772
773         if (decoder_deletable) {
774                 delete_mapper_.setMapping(group, index);
775                 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
776         }
777
778         show_hide_mapper_.setMapping(group, index);
779         connect(group, SIGNAL(show_hide_decoder()),
780                 &show_hide_mapper_, SLOT(map()));
781
782         QFormLayout *const decoder_form = new QFormLayout;
783         group->add_layout(decoder_form);
784
785         const vector<DecodeChannel> channels = decode_signal_->get_channels();
786
787         // Add the channels
788         for (DecodeChannel ch : channels) {
789                 // Ignore channels not part of the decoder we create the form for
790                 if (ch.decoder_ != dec)
791                         continue;
792
793                 QComboBox *const combo = create_channel_selector(parent, &ch);
794                 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
795
796                 channel_id_map_[combo] = ch.id;
797                 init_state_map_[combo_init_state] = ch.id;
798
799                 connect(combo, SIGNAL(currentIndexChanged(int)),
800                         this, SLOT(on_channel_selected(int)));
801                 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
802                         this, SLOT(on_init_state_changed(int)));
803
804                 QHBoxLayout *const hlayout = new QHBoxLayout;
805                 hlayout->addWidget(combo);
806                 hlayout->addWidget(combo_init_state);
807
808                 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
809                         combo_init_state->hide();
810
811                 const QString required_flag = ch.is_optional ? QString() : QString("*");
812                 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
813                         .arg(ch.name, ch.desc, required_flag), hlayout);
814         }
815
816         // Add the options
817         shared_ptr<binding::Decoder> binding(
818                 new binding::Decoder(decode_signal_, dec));
819         binding->add_properties_to_form(decoder_form, true);
820
821         bindings_.push_back(binding);
822
823         form->addRow(group);
824         decoder_forms_.push_back(group);
825 }
826
827 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
828 {
829         const auto sigs(session_.signalbases());
830
831         // Sort signals in natural order
832         vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
833         sort(sig_list.begin(), sig_list.end(),
834                 [](const shared_ptr<data::SignalBase> &a,
835                 const shared_ptr<data::SignalBase> &b) {
836                         return strnatcasecmp(a->name().toStdString(),
837                                 b->name().toStdString()) < 0; });
838
839         QComboBox *selector = new QComboBox(parent);
840
841         selector->addItem("-", qVariantFromValue((void*)nullptr));
842
843         if (!ch->assigned_signal)
844                 selector->setCurrentIndex(0);
845
846         for (const shared_ptr<data::SignalBase> &b : sig_list) {
847                 assert(b);
848                 if (b->logic_data() && b->enabled()) {
849                         selector->addItem(b->name(),
850                                 qVariantFromValue((void*)b.get()));
851
852                         if (ch->assigned_signal == b.get())
853                                 selector->setCurrentIndex(selector->count() - 1);
854                 }
855         }
856
857         return selector;
858 }
859
860 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
861         const DecodeChannel *ch)
862 {
863         QComboBox *selector = new QComboBox(parent);
864
865         selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
866         selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
867         selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
868
869         selector->setCurrentIndex(ch->initial_pin_state);
870
871         selector->setToolTip("Initial (assumed) pin value before the first sample");
872
873         return selector;
874 }
875
876 void DecodeTrace::on_new_annotations()
877 {
878         if (!delayed_trace_updater_.isActive())
879                 delayed_trace_updater_.start();
880 }
881
882 void DecodeTrace::on_delayed_trace_update()
883 {
884         if (owner_)
885                 owner_->row_item_appearance_changed(false, true);
886 }
887
888 void DecodeTrace::on_decode_reset()
889 {
890         visible_rows_.clear();
891         max_visible_rows_ = 0;
892
893         if (owner_)
894                 owner_->row_item_appearance_changed(false, true);
895 }
896
897 void DecodeTrace::on_decode_finished()
898 {
899         if (owner_)
900                 owner_->row_item_appearance_changed(false, true);
901 }
902
903 void DecodeTrace::delete_pressed()
904 {
905         on_delete();
906 }
907
908 void DecodeTrace::on_delete()
909 {
910         session_.remove_decode_signal(decode_signal_);
911 }
912
913 void DecodeTrace::on_channel_selected(int)
914 {
915         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
916
917         // Determine signal that was selected
918         const data::SignalBase *signal =
919                 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
920
921         // Determine decode channel ID this combo box is the channel selector for
922         const uint16_t id = channel_id_map_.at(cb);
923
924         decode_signal_->assign_signal(id, signal);
925 }
926
927 void DecodeTrace::on_channels_updated()
928 {
929         if (owner_)
930                 owner_->row_item_appearance_changed(false, true);
931 }
932
933 void DecodeTrace::on_init_state_changed(int)
934 {
935         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
936
937         // Determine inital pin state that was selected
938         int init_state = cb->itemData(cb->currentIndex()).value<int>();
939
940         // Determine decode channel ID this combo box is the channel selector for
941         const uint16_t id = init_state_map_.at(cb);
942
943         decode_signal_->set_initial_pin_state(id, init_state);
944 }
945
946 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
947 {
948         decode_signal_->stack_decoder(decoder);
949
950         create_popup_form();
951 }
952
953 void DecodeTrace::on_delete_decoder(int index)
954 {
955         decode_signal_->remove_decoder(index);
956
957         // Force re-calculation of the trace height, see paint_mid()
958         max_visible_rows_ = 0;
959         owner_->extents_changed(false, true);
960
961         // Update the popup
962         create_popup_form();
963 }
964
965 void DecodeTrace::on_show_hide_decoder(int index)
966 {
967         const bool state = decode_signal_->toggle_decoder_visibility(index);
968
969         assert(index < (int)decoder_forms_.size());
970         decoder_forms_[index]->set_decoder_visible(state);
971
972         if (!state) {
973                 // Force re-calculation of the trace height, see paint_mid()
974                 max_visible_rows_ = 0;
975                 owner_->extents_changed(false, true);
976         }
977
978         if (owner_)
979                 owner_->row_item_appearance_changed(false, true);
980 }
981
982 } // namespace trace
983 } // namespace views
984 } // namespace pv