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