pv/views/trace/decodetrace.cpp

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