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