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