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