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