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         // Set default pen to allow for text width calculation
 167         p.setPen(Qt::black);
 168
 169         // Iterate through the rows
 170         int y = get_visual_y();
 171         pair<uint64_t, uint64_t> sample_range = get_sample_range(pp.left(), pp.right());
 172
 173         // Just because the view says we see a certain sample range it
 174         // doesn't mean we have this many decoded samples, too, so crop
 175         // the range to what has been decoded already
 176         sample_range.second = min((int64_t)sample_range.second,
 177                 decode_signal_->get_decoded_sample_count(current_segment_, false));
 178
 179         const vector<Row> rows = decode_signal_->visible_rows();
 180
 181         visible_rows_.clear();
 182         for (const Row& row : rows) {
 183                 // Cache the row title widths
 184                 int row_title_width;
 185                 try {
 186                         row_title_width = row_title_widths_.at(row);
 187                 } catch (out_of_range&) {
 188                         const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
 189                                 RowTitleMargin;
 190                         row_title_widths_[row] = w;
 191                         row_title_width = w;
 192                 }
 193
 194                 vector<Annotation> annotations;
 195                 decode_signal_->get_annotation_subset(annotations, row,
 196                         current_segment_, sample_range.first, sample_range.second);
 197                 if (!annotations.empty()) {
 198                         draw_annotations(annotations, p, annotation_height, pp, y,
 199                                 get_row_color(row.index()), row_title_width);
 200                         y += row_height_;
 201                         visible_rows_.push_back(row);
 202                 }
 203         }
 204
 205         draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
 206
 207         if ((int)visible_rows_.size() > max_visible_rows_) {
 208                 max_visible_rows_ = (int)visible_rows_.size();
 209
 210                 // Call order is important, otherwise the lazy event handler won't work
 211                 owner_->extents_changed(false, true);
 212                 owner_->row_item_appearance_changed(false, true);
 213         }
 214
 215         const QString err = decode_signal_->error_message();
 216         if (!err.isEmpty())
 217                 draw_error(p, err, pp);
 218 }
 219
 220 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
 221 {
 222         assert(row_height_);
 223
 224         for (size_t i = 0; i < visible_rows_.size(); i++) {
 225                 const int y = i * row_height_ + get_visual_y();
 226
 227                 p.setPen(QPen(Qt::NoPen));
 228                 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 229
 230                 if (i != 0) {
 231                         const QPointF points[] = {
 232                                 QPointF(pp.left(), y - ArrowSize),
 233                                 QPointF(pp.left() + ArrowSize, y),
 234                                 QPointF(pp.left(), y + ArrowSize)
 235                         };
 236                         p.drawPolygon(points, countof(points));
 237                 }
 238
 239                 const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
 240                         pp.right() - pp.left(), row_height_);
 241                 const QString h(visible_rows_[i].title());
 242                 const int f = Qt::AlignLeft | Qt::AlignVCenter |
 243                         Qt::TextDontClip;
 244
 245                 // Draw the outline
 246                 p.setPen(QApplication::palette().color(QPalette::Base));
 247                 for (int dx = -1; dx <= 1; dx++)
 248                         for (int dy = -1; dy <= 1; dy++)
 249                                 if (dx != 0 && dy != 0)
 250                                         p.drawText(r.translated(dx, dy), f, h);
 251
 252                 // Draw the text
 253                 p.setPen(QApplication::palette().color(QPalette::WindowText));
 254                 p.drawText(r, f, h);
 255         }
 256
 257         if (show_hover_marker_)
 258                 paint_hover_marker(p);
 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_header_context_menu(QWidget *parent)
 311 {
 312         QMenu *const menu = Trace::create_header_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         qreal block_start = 0;
 333         int block_ann_count = 0;
 334
 335         const Annotation *prev_ann;
 336         qreal prev_end = INT_MIN;
 337
 338         qreal 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 qreal abs_a_start = a.start_sample() / samples_per_pixel;
 354                 const qreal abs_a_end   = a.end_sample() / samples_per_pixel;
 355
 356                 const qreal a_start = abs_a_start - pixels_offset;
 357                 a_end = abs_a_end - pixels_offset;
 358
 359                 const qreal a_width = a_end - a_start;
 360                 const qreal 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 qreal 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                         block_ann_count = 0;
 396                 } else {
 397                         prev_end = a_end;
 398                         prev_ann = &a;
 399
 400                         if (block_ann_count == 0) {
 401                                 block_start = a_start;
 402                                 block_class = a.ann_class();
 403                                 block_class_uniform = true;
 404                         } else
 405                                 if (a.ann_class() != block_class)
 406                                         block_class_uniform = false;
 407
 408                         block_ann_count++;
 409                 }
 410         }
 411
 412         if (block_ann_count == 1)
 413                 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
 414         else if (block_ann_count > 0)
 415                 draw_annotation_block(block_start, prev_end, block_class,
 416                         block_class_uniform, p, h, y, row_color);
 417 }
 418
 419 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
 420         QPainter &p, int h, const ViewItemPaintParams &pp, int y,
 421         QColor row_color, int row_title_width) const
 422 {
 423         double samples_per_pixel, pixels_offset;
 424         tie(pixels_offset, samples_per_pixel) =
 425                 get_pixels_offset_samples_per_pixel();
 426
 427         const double start = a.start_sample() / samples_per_pixel -
 428                 pixels_offset;
 429         const double end = a.end_sample() / samples_per_pixel - pixels_offset;
 430
 431         QColor color = get_annotation_color(row_color, a.ann_class());
 432         p.setPen(color.darker());
 433         p.setBrush(color);
 434
 435         if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
 436                 return;
 437
 438         if (a.start_sample() == a.end_sample())
 439                 draw_instant(a, p, h, start, y);
 440         else
 441                 draw_range(a, p, h, start, end, y, pp, row_title_width);
 442 }
 443
 444 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
 445         Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
 446         int y, QColor row_color) const
 447 {
 448         const double top = y + .5 - h / 2;
 449         const double bottom = y + .5 + h / 2;
 450
 451         const QRectF rect(start, top, end - start, bottom - top);
 452         const int r = h / 4;
 453
 454         p.setPen(QPen(Qt::NoPen));
 455         p.setBrush(Qt::white);
 456         p.drawRoundedRect(rect, r, r);
 457
 458         // If all annotations in this block are of the same type, we can use the
 459         // one format that all of these annotations have. Otherwise, we should use
 460         // a neutral color (i.e. gray)
 461         if (use_ann_format) {
 462                 const QColor color = get_annotation_color(row_color, ann_class);
 463                 p.setPen(color.darker());
 464                 p.setBrush(QBrush(color, Qt::Dense4Pattern));
 465         } else {
 466                 p.setPen(Qt::gray);
 467                 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
 468         }
 469
 470         p.drawRoundedRect(rect, r, r);
 471 }
 472
 473 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
 474         int h, qreal x, int y) const
 475 {
 476         const QString text = a.annotations().empty() ?
 477                 QString() : a.annotations().back();
 478         const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
 479                 0.0) + h;
 480         const QRectF rect(x - w / 2, y - h / 2, w, h);
 481
 482         p.drawRoundedRect(rect, h / 2, h / 2);
 483
 484         p.setPen(Qt::black);
 485         p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
 486 }
 487
 488 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 489         int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
 490         int row_title_width) const
 491 {
 492         const qreal top = y + .5 - h / 2;
 493         const qreal bottom = y + .5 + h / 2;
 494         const vector<QString> annotations = a.annotations();
 495
 496         // If the two ends are within 1 pixel, draw a vertical line
 497         if (start + 1.0 > end) {
 498                 p.drawLine(QPointF(start, top), QPointF(start, bottom));
 499                 return;
 500         }
 501
 502         const qreal cap_width = min((end - start) / 4, EndCapWidth);
 503
 504         QPointF pts[] = {
 505                 QPointF(start, y + .5f),
 506                 QPointF(start + cap_width, top),
 507                 QPointF(end - cap_width, top),
 508                 QPointF(end, y + .5f),
 509                 QPointF(end - cap_width, bottom),
 510                 QPointF(start + cap_width, bottom)
 511         };
 512
 513         p.drawConvexPolygon(pts, countof(pts));
 514
 515         if (annotations.empty())
 516                 return;
 517
 518         const int ann_start = start + cap_width;
 519         const int ann_end = end - cap_width;
 520
 521         const int real_start = max(ann_start, pp.left() + row_title_width);
 522         const int real_end = min(ann_end, pp.right());
 523         const int real_width = real_end - real_start;
 524
 525         QRectF rect(real_start, y - h / 2, real_width, h);
 526         if (rect.width() <= 4)
 527                 return;
 528
 529         p.setPen(Qt::black);
 530
 531         // Try to find an annotation that will fit
 532         QString best_annotation;
 533         int best_width = 0;
 534
 535         for (const QString &a : annotations) {
 536                 const int w = p.boundingRect(QRectF(), 0, a).width();
 537                 if (w <= rect.width() && w > best_width)
 538                         best_annotation = a, best_width = w;
 539         }
 540
 541         if (best_annotation.isEmpty())
 542                 best_annotation = annotations.back();
 543
 544         // If not ellide the last in the list
 545         p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
 546                 best_annotation, Qt::ElideRight, rect.width()));
 547 }
 548
 549 void DecodeTrace::draw_error(QPainter &p, const QString &message,
 550         const ViewItemPaintParams &pp)
 551 {
 552         const int y = get_visual_y();
 553
 554         double samples_per_pixel, pixels_offset;
 555         tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
 556
 557         p.setPen(ErrorBgColor.darker());
 558         p.setBrush(ErrorBgColor);
 559
 560         const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
 561
 562         const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
 563         const qreal r = text_rect.height() / 4;
 564
 565         p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
 566
 567         p.setPen(Qt::black);
 568         p.drawText(text_rect, message);
 569 }
 570
 571 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
 572 {
 573         using namespace pv::data;
 574         using pv::data::decode::Decoder;
 575
 576         double samples_per_pixel, pixels_offset;
 577
 578         const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
 579         if (sample_count == 0)
 580                 return;
 581
 582         const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
 583         if (sample_count == samples_decoded)
 584                 return;
 585
 586         const int y = get_visual_y();
 587
 588         tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
 589
 590         const double start = max(samples_decoded /
 591                 samples_per_pixel - pixels_offset, left - 1.0);
 592         const double end = min(sample_count / samples_per_pixel -
 593                 pixels_offset, right + 1.0);
 594         const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
 595
 596         p.setPen(QPen(Qt::NoPen));
 597         p.setBrush(Qt::white);
 598         p.drawRect(no_decode_rect);
 599
 600         p.setPen(NoDecodeColor);
 601         p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
 602         p.drawRect(no_decode_rect);
 603 }
 604
 605 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
 606 {
 607         assert(owner_);
 608
 609         const View *view = owner_->view();
 610         assert(view);
 611
 612         const double scale = view->scale();
 613         assert(scale > 0);
 614
 615         const double pixels_offset =
 616                 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
 617
 618         double samplerate = decode_signal_->samplerate();
 619
 620         // Show sample rate as 1Hz when it is unknown
 621         if (samplerate == 0.0)
 622                 samplerate = 1.0;
 623
 624         return make_pair(pixels_offset, samplerate * scale);
 625 }
 626
 627 pair<uint64_t, uint64_t> DecodeTrace::get_sample_range(
 628         int x_start, int x_end) const
 629 {
 630         double samples_per_pixel, pixels_offset;
 631         tie(pixels_offset, samples_per_pixel) =
 632                 get_pixels_offset_samples_per_pixel();
 633
 634         const uint64_t start = (uint64_t)max(
 635                 (x_start + pixels_offset) * samples_per_pixel, 0.0);
 636         const uint64_t end = (uint64_t)max(
 637                 (x_end + pixels_offset) * samples_per_pixel, 0.0);
 638
 639         return make_pair(start, end);
 640 }
 641
 642 QColor DecodeTrace::get_row_color(int row_index) const
 643 {
 644         // For each row color, use the base color hue and add an offset that's
 645         // not a dividend of 360
 646
 647         QColor color;
 648         const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
 649         const int s = DECODETRACE_COLOR_SATURATION;
 650         const int v = DECODETRACE_COLOR_VALUE;
 651         color.setHsl(h, s, v);
 652
 653         return color;
 654 }
 655
 656 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
 657 {
 658         // For each row color, use the base color hue and add an offset that's
 659         // not a dividend of 360 and not a multiple of the row offset
 660
 661         QColor color(row_color);
 662         const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
 663         const int s = DECODETRACE_COLOR_SATURATION;
 664         const int v = DECODETRACE_COLOR_VALUE;
 665         color.setHsl(h, s, v);
 666
 667         return color;
 668 }
 669
 670 int DecodeTrace::get_row_at_point(const QPoint &point)
 671 {
 672         if (!row_height_)
 673                 return -1;
 674
 675         const int y = (point.y() - get_visual_y() + row_height_ / 2);
 676
 677         /* Integer divison of (x-1)/x would yield 0, so we check for this. */
 678         if (y < 0)
 679                 return -1;
 680
 681         const int row = y / row_height_;
 682
 683         if (row >= (int)visible_rows_.size())
 684                 return -1;
 685
 686         return row;
 687 }
 688
 689 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
 690 {
 691         using namespace pv::data::decode;
 692
 693         if (!enabled())
 694                 return QString();
 695
 696         const pair<uint64_t, uint64_t> sample_range =
 697                 get_sample_range(point.x(), point.x() + 1);
 698         const int row = get_row_at_point(point);
 699         if (row < 0)
 700                 return QString();
 701
 702         vector<pv::data::decode::Annotation> annotations;
 703
 704         decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
 705                 current_segment_, sample_range.first, sample_range.second);
 706
 707         return (annotations.empty()) ?
 708                 QString() : annotations[0].annotations().front();
 709 }
 710
 711 void DecodeTrace::hover_point_changed(const QPoint &hp)
 712 {
 713         Trace::hover_point_changed(hp);
 714
 715         assert(owner_);
 716
 717         const View *const view = owner_->view();
 718         assert(view);
 719
 720         if (hp.x() == 0) {
 721                 QToolTip::hideText();
 722                 return;
 723         }
 724
 725         QString ann = get_annotation_at_point(hp);
 726
 727         assert(view);
 728
 729         if (!row_height_ || ann.isEmpty()) {
 730                 QToolTip::hideText();
 731                 return;
 732         }
 733
 734         const int hover_row = get_row_at_point(hp);
 735
 736         QFontMetrics m(QToolTip::font());
 737         const QRect text_size = m.boundingRect(QRect(), 0, ann);
 738
 739         // This is OS-specific and unfortunately we can't query it, so
 740         // use an approximation to at least try to minimize the error.
 741         const int padding = 8;
 742
 743         // Make sure the tool tip doesn't overlap with the mouse cursor.
 744         // If it did, the tool tip would constantly hide and re-appear.
 745         // We also push it up by one row so that it appears above the
 746         // decode trace, not below.
 747         QPoint p = hp;
 748         p.setX(hp.x() - (text_size.width() / 2) - padding);
 749
 750         p.setY(get_visual_y() - (row_height_ / 2) +
 751                 (hover_row * row_height_) -
 752                 row_height_ - text_size.height() - padding);
 753
 754         QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
 755 }
 756
 757 void DecodeTrace::create_decoder_form(int index,
 758         shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
 759         QFormLayout *form)
 760 {
 761         GlobalSettings settings;
 762
 763         assert(dec);
 764         const srd_decoder *const decoder = dec->decoder();
 765         assert(decoder);
 766
 767         const bool decoder_deletable = index > 0;
 768
 769         pv::widgets::DecoderGroupBox *const group =
 770                 new pv::widgets::DecoderGroupBox(
 771                         QString::fromUtf8(decoder->name),
 772                         tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
 773                                 QString::fromUtf8(decoder->desc)),
 774                         nullptr, decoder_deletable);
 775         group->set_decoder_visible(dec->shown());
 776
 777         if (decoder_deletable) {
 778                 delete_mapper_.setMapping(group, index);
 779                 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
 780         }
 781
 782         show_hide_mapper_.setMapping(group, index);
 783         connect(group, SIGNAL(show_hide_decoder()),
 784                 &show_hide_mapper_, SLOT(map()));
 785
 786         QFormLayout *const decoder_form = new QFormLayout;
 787         group->add_layout(decoder_form);
 788
 789         const vector<DecodeChannel> channels = decode_signal_->get_channels();
 790
 791         // Add the channels
 792         for (DecodeChannel ch : channels) {
 793                 // Ignore channels not part of the decoder we create the form for
 794                 if (ch.decoder_ != dec)
 795                         continue;
 796
 797                 QComboBox *const combo = create_channel_selector(parent, &ch);
 798                 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
 799
 800                 channel_id_map_[combo] = ch.id;
 801                 init_state_map_[combo_init_state] = ch.id;
 802
 803                 connect(combo, SIGNAL(currentIndexChanged(int)),
 804                         this, SLOT(on_channel_selected(int)));
 805                 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
 806                         this, SLOT(on_init_state_changed(int)));
 807
 808                 QHBoxLayout *const hlayout = new QHBoxLayout;
 809                 hlayout->addWidget(combo);
 810                 hlayout->addWidget(combo_init_state);
 811
 812                 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
 813                         combo_init_state->hide();
 814
 815                 const QString required_flag = ch.is_optional ? QString() : QString("*");
 816                 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
 817                         .arg(ch.name, ch.desc, required_flag), hlayout);
 818         }
 819
 820         // Add the options
 821         shared_ptr<binding::Decoder> binding(
 822                 new binding::Decoder(decode_signal_, dec));
 823         binding->add_properties_to_form(decoder_form, true);
 824
 825         bindings_.push_back(binding);
 826
 827         form->addRow(group);
 828         decoder_forms_.push_back(group);
 829 }
 830
 831 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
 832 {
 833         const auto sigs(session_.signalbases());
 834
 835         // Sort signals in natural order
 836         vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
 837         sort(sig_list.begin(), sig_list.end(),
 838                 [](const shared_ptr<data::SignalBase> &a,
 839                 const shared_ptr<data::SignalBase> &b) {
 840                         return strnatcasecmp(a->name().toStdString(),
 841                                 b->name().toStdString()) < 0; });
 842
 843         QComboBox *selector = new QComboBox(parent);
 844
 845         selector->addItem("-", qVariantFromValue((void*)nullptr));
 846
 847         if (!ch->assigned_signal)
 848                 selector->setCurrentIndex(0);
 849
 850         for (const shared_ptr<data::SignalBase> &b : sig_list) {
 851                 assert(b);
 852                 if (b->logic_data() && b->enabled()) {
 853                         selector->addItem(b->name(),
 854                                 qVariantFromValue((void*)b.get()));
 855
 856                         if (ch->assigned_signal == b.get())
 857                                 selector->setCurrentIndex(selector->count() - 1);
 858                 }
 859         }
 860
 861         return selector;
 862 }
 863
 864 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
 865         const DecodeChannel *ch)
 866 {
 867         QComboBox *selector = new QComboBox(parent);
 868
 869         selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
 870         selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
 871         selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
 872
 873         selector->setCurrentIndex(ch->initial_pin_state);
 874
 875         selector->setToolTip("Initial (assumed) pin value before the first sample");
 876
 877         return selector;
 878 }
 879
 880 void DecodeTrace::on_new_annotations()
 881 {
 882         if (!delayed_trace_updater_.isActive())
 883                 delayed_trace_updater_.start();
 884 }
 885
 886 void DecodeTrace::on_delayed_trace_update()
 887 {
 888         if (owner_)
 889                 owner_->row_item_appearance_changed(false, true);
 890 }
 891
 892 void DecodeTrace::on_decode_reset()
 893 {
 894         visible_rows_.clear();
 895         max_visible_rows_ = 0;
 896
 897         if (owner_)
 898                 owner_->row_item_appearance_changed(false, true);
 899 }
 900
 901 void DecodeTrace::on_decode_finished()
 902 {
 903         if (owner_)
 904                 owner_->row_item_appearance_changed(false, true);
 905 }
 906
 907 void DecodeTrace::delete_pressed()
 908 {
 909         on_delete();
 910 }
 911
 912 void DecodeTrace::on_delete()
 913 {
 914         session_.remove_decode_signal(decode_signal_);
 915 }
 916
 917 void DecodeTrace::on_channel_selected(int)
 918 {
 919         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
 920
 921         // Determine signal that was selected
 922         const data::SignalBase *signal =
 923                 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
 924
 925         // Determine decode channel ID this combo box is the channel selector for
 926         const uint16_t id = channel_id_map_.at(cb);
 927
 928         decode_signal_->assign_signal(id, signal);
 929 }
 930
 931 void DecodeTrace::on_channels_updated()
 932 {
 933         if (owner_)
 934                 owner_->row_item_appearance_changed(false, true);
 935 }
 936
 937 void DecodeTrace::on_init_state_changed(int)
 938 {
 939         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
 940
 941         // Determine inital pin state that was selected
 942         int init_state = cb->itemData(cb->currentIndex()).value<int>();
 943
 944         // Determine decode channel ID this combo box is the channel selector for
 945         const uint16_t id = init_state_map_.at(cb);
 946
 947         decode_signal_->set_initial_pin_state(id, init_state);
 948 }
 949
 950 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
 951 {
 952         decode_signal_->stack_decoder(decoder);
 953
 954         create_popup_form();
 955 }
 956
 957 void DecodeTrace::on_delete_decoder(int index)
 958 {
 959         decode_signal_->remove_decoder(index);
 960
 961         // Force re-calculation of the trace height, see paint_mid()
 962         max_visible_rows_ = 0;
 963         owner_->extents_changed(false, true);
 964
 965         // Update the popup
 966         create_popup_form();
 967 }
 968
 969 void DecodeTrace::on_show_hide_decoder(int index)
 970 {
 971         const bool state = decode_signal_->toggle_decoder_visibility(index);
 972
 973         assert(index < (int)decoder_forms_.size());
 974         decoder_forms_[index]->set_decoder_visible(state);
 975
 976         if (!state) {
 977                 // Force re-calculation of the trace height, see paint_mid()
 978                 max_visible_rows_ = 0;
 979                 owner_->extents_changed(false, true);
 980         }
 981
 982         if (owner_)
 983                 owner_->row_item_appearance_changed(false, true);
 984 }
 985
 986 } // namespace trace
 987 } // namespace views
 988 } // namespace pv