pv/views/trace/logicsignal.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 #include <extdef.h>
  21
  22 #include <cassert>
  23 #include <cmath>
  24
  25 #include <algorithm>
  26
  27 #include <QApplication>
  28 #include <QFormLayout>
  29 #include <QToolBar>
  30
  31 #include "logicsignal.hpp"
  32 #include "view.hpp"
  33
  34 #include <pv/data/logic.hpp>
  35 #include <pv/data/logicsegment.hpp>
  36 #include <pv/data/signalbase.hpp>
  37 #include <pv/devicemanager.hpp>
  38 #include <pv/devices/device.hpp>
  39 #include <pv/globalsettings.hpp>
  40 #include <pv/session.hpp>
  41
  42 #include <libsigrokcxx/libsigrokcxx.hpp>
  43
  44 using std::deque;
  45 using std::max;
  46 using std::make_pair;
  47 using std::min;
  48 using std::none_of;
  49 using std::out_of_range;
  50 using std::pair;
  51 using std::shared_ptr;
  52 using std::vector;
  53
  54 using sigrok::ConfigKey;
  55 using sigrok::Capability;
  56 using sigrok::Trigger;
  57 using sigrok::TriggerMatch;
  58 using sigrok::TriggerMatchType;
  59
  60 using pv::data::LogicSegment;
  61
  62 namespace pv {
  63 namespace views {
  64 namespace trace {
  65
  66 const float LogicSignal::Oversampling = 2.0f;
  67
  68 const QColor LogicSignal::EdgeColor(0x80, 0x80, 0x80);
  69 const QColor LogicSignal::HighColor(0x00, 0xC0, 0x00);
  70 const QColor LogicSignal::LowColor(0xC0, 0x00, 0x00);
  71 const QColor LogicSignal::SamplingPointColor(0x77, 0x77, 0x77);
  72
  73 const QColor LogicSignal::SignalColors[10] = {
  74         QColor(0x16, 0x19, 0x1A),       // Black
  75         QColor(0x8F, 0x52, 0x02),       // Brown
  76         QColor(0xCC, 0x00, 0x00),       // Red
  77         QColor(0xF5, 0x79, 0x00),       // Orange
  78         QColor(0xED, 0xD4, 0x00),       // Yellow
  79         QColor(0x73, 0xD2, 0x16),       // Green
  80         QColor(0x34, 0x65, 0xA4),       // Blue
  81         QColor(0x75, 0x50, 0x7B),       // Violet
  82         QColor(0x88, 0x8A, 0x85),       // Grey
  83         QColor(0xEE, 0xEE, 0xEC),       // White
  84 };
  85
  86 QColor LogicSignal::TriggerMarkerBackgroundColor = QColor(0xED, 0xD4, 0x00);
  87 const int LogicSignal::TriggerMarkerPadding = 2;
  88 const char* LogicSignal::TriggerMarkerIcons[8] = {
  89         nullptr,
  90         ":/icons/trigger-marker-low.svg",
  91         ":/icons/trigger-marker-high.svg",
  92         ":/icons/trigger-marker-rising.svg",
  93         ":/icons/trigger-marker-falling.svg",
  94         ":/icons/trigger-marker-change.svg",
  95         nullptr,
  96         nullptr
  97 };
  98
  99 QCache<QString, const QIcon> LogicSignal::icon_cache_;
 100 QCache<QString, const QPixmap> LogicSignal::pixmap_cache_;
 101
 102 LogicSignal::LogicSignal(
 103         pv::Session &session,
 104         shared_ptr<devices::Device> device,
 105         shared_ptr<data::SignalBase> base) :
 106         Signal(session, base),
 107         device_(device),
 108         trigger_types_(get_trigger_types()),
 109         trigger_none_(nullptr),
 110         trigger_rising_(nullptr),
 111         trigger_high_(nullptr),
 112         trigger_falling_(nullptr),
 113         trigger_low_(nullptr),
 114         trigger_change_(nullptr)
 115 {
 116         shared_ptr<Trigger> trigger;
 117
 118         base_->set_color(SignalColors[base->index() % countof(SignalColors)]);
 119
 120         GlobalSettings gs;
 121         signal_height_ = gs.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
 122
 123         /* Populate this channel's trigger setting with whatever we
 124          * find in the current session trigger, if anything. */
 125         trigger_match_ = nullptr;
 126         if ((trigger = session_.session()->trigger()))
 127                 for (auto stage : trigger->stages())
 128                         for (auto match : stage->matches())
 129                                 if (match->channel() == base_->channel())
 130                                         trigger_match_ = match->type();
 131 }
 132
 133 shared_ptr<pv::data::SignalData> LogicSignal::data() const
 134 {
 135         return base_->logic_data();
 136 }
 137
 138 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
 139 {
 140         return base_->logic_data();
 141 }
 142
 143 void LogicSignal::save_settings(QSettings &settings) const
 144 {
 145         settings.setValue("trace_height", signal_height_);
 146 }
 147
 148 void LogicSignal::restore_settings(QSettings &settings)
 149 {
 150         if (settings.contains("trace_height")) {
 151                 const int old_height = signal_height_;
 152                 signal_height_ = settings.value("trace_height").toInt();
 153
 154                 if ((signal_height_ != old_height) && owner_) {
 155                         // Call order is important, otherwise the lazy event handler won't work
 156                         owner_->extents_changed(false, true);
 157                         owner_->row_item_appearance_changed(false, true);
 158                 }
 159         }
 160 }
 161
 162 pair<int, int> LogicSignal::v_extents() const
 163 {
 164         const int signal_margin =
 165                 QFontMetrics(QApplication::font()).height() / 2;
 166         return make_pair(-signal_height_ - signal_margin, signal_margin);
 167 }
 168
 169 void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 170 {
 171         QLineF *line;
 172
 173         vector< pair<int64_t, bool> > edges;
 174
 175         assert(base_);
 176         assert(owner_);
 177
 178         const int y = get_visual_y();
 179
 180         if (!base_->enabled())
 181                 return;
 182
 183         const float high_offset = y - signal_height_ + 0.5f;
 184         const float low_offset = y + 0.5f;
 185
 186         shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
 187         if (!segment || (segment->get_sample_count() == 0))
 188                 return;
 189
 190         double samplerate = segment->samplerate();
 191
 192         // Show sample rate as 1Hz when it is unknown
 193         if (samplerate == 0.0)
 194                 samplerate = 1.0;
 195
 196         const double pixels_offset = pp.pixels_offset();
 197         const pv::util::Timestamp& start_time = segment->start_time();
 198         const int64_t last_sample = (int64_t)segment->get_sample_count() - 1;
 199         const double samples_per_pixel = samplerate * pp.scale();
 200         const double pixels_per_sample = 1 / samples_per_pixel;
 201         const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
 202         const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
 203
 204         const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
 205                 (int64_t)0), last_sample);
 206         const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
 207                 (int64_t)0), last_sample);
 208
 209         segment->get_subsampled_edges(edges, start_sample, end_sample,
 210                 samples_per_pixel / Oversampling, base_->index());
 211         assert(edges.size() >= 2);
 212
 213         // Check whether we need to paint the sampling points
 214         GlobalSettings settings;
 215         const bool show_sampling_points =
 216                 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool() &&
 217                 (samples_per_pixel < 0.25);
 218
 219         vector<QRectF> sampling_points;
 220         float sampling_point_x = 0.0f;
 221         int64_t sampling_point_sample = start_sample;
 222         const int w = 2;
 223
 224         if (show_sampling_points) {
 225                 sampling_points.reserve(end_sample - start_sample + 1);
 226                 sampling_point_x = (edges.cbegin()->first / samples_per_pixel - pixels_offset) + pp.left();
 227         }
 228
 229         // Paint the edges
 230         const unsigned int edge_count = edges.size() - 2;
 231         QLineF *const edge_lines = new QLineF[edge_count];
 232         line = edge_lines;
 233
 234         for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
 235                 const float x = ((*i).first / samples_per_pixel -
 236                         pixels_offset) + pp.left();
 237                 *line++ = QLineF(x, high_offset, x, low_offset);
 238
 239                 if (show_sampling_points)
 240                         while (sampling_point_sample < (*i).first) {
 241                                 const float y = (*i).second ? low_offset : high_offset;
 242                                 sampling_points.emplace_back(
 243                                         QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
 244                                 sampling_point_sample++;
 245                                 sampling_point_x += pixels_per_sample;
 246                         };
 247         }
 248
 249         // Calculate the sample points from the last edge to the end of the trace
 250         if (show_sampling_points)
 251                 while ((uint64_t)sampling_point_sample <= end_sample) {
 252                         // Signal changed after the last edge, so the level is inverted
 253                         const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
 254                         sampling_points.emplace_back(
 255                                 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
 256                         sampling_point_sample++;
 257                         sampling_point_x += pixels_per_sample;
 258                 };
 259
 260         p.setPen(EdgeColor);
 261         p.drawLines(edge_lines, edge_count);
 262         delete[] edge_lines;
 263
 264         // Paint the caps
 265         const unsigned int max_cap_line_count = edges.size();
 266         QLineF *const cap_lines = new QLineF[max_cap_line_count];
 267
 268         p.setPen(HighColor);
 269         paint_caps(p, cap_lines, edges, true, samples_per_pixel,
 270                 pixels_offset, pp.left(), high_offset);
 271         p.setPen(LowColor);
 272         paint_caps(p, cap_lines, edges, false, samples_per_pixel,
 273                 pixels_offset, pp.left(), low_offset);
 274
 275         delete[] cap_lines;
 276
 277         // Paint the sampling points
 278         if (show_sampling_points) {
 279                 p.setPen(SamplingPointColor);
 280                 p.drawRects(sampling_points.data(), sampling_points.size());
 281         }
 282 }
 283
 284 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
 285 {
 286         if (base_->enabled()) {
 287                 if (trigger_match_) {
 288                         // Draw the trigger marker
 289                         const int y = get_visual_y();
 290
 291                         for (int32_t type_id : trigger_types_) {
 292                                 const TriggerMatchType *const type =
 293                                         TriggerMatchType::get(type_id);
 294                                 if (trigger_match_ != type || type_id < 0 ||
 295                                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
 296                                         !TriggerMarkerIcons[type_id])
 297                                         continue;
 298
 299                                 const QPixmap *const pixmap = get_pixmap(
 300                                         TriggerMarkerIcons[type_id]);
 301                                 if (!pixmap)
 302                                         continue;
 303
 304                                 const float pad = TriggerMarkerPadding - 0.5f;
 305                                 const QSize size = pixmap->size();
 306                                 const QPoint point(
 307                                         pp.right() - size.width() - pad * 2,
 308                                         y - (signal_height_ + size.height()) / 2);
 309
 310                                 p.setPen(QPen(TriggerMarkerBackgroundColor.darker()));
 311                                 p.setBrush(TriggerMarkerBackgroundColor);
 312                                 p.drawRoundedRect(QRectF(point, size).adjusted(
 313                                         -pad, -pad, pad, pad), pad, pad);
 314                                 p.drawPixmap(point, *pixmap);
 315
 316                                 break;
 317                         }
 318                 }
 319
 320                 if (show_hover_marker_)
 321                         paint_hover_marker(p);
 322         }
 323 }
 324
 325 vector<LogicSegment::EdgePair> LogicSignal::get_nearest_level_changes(uint64_t sample_pos)
 326 {
 327         assert(base_);
 328         assert(owner_);
 329
 330         if (sample_pos == 0)
 331                 return vector<LogicSegment::EdgePair>();
 332
 333         shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
 334         if (!segment || (segment->get_sample_count() == 0))
 335                 return vector<LogicSegment::EdgePair>();
 336
 337         const View *view = owner_->view();
 338         assert(view);
 339         const double samples_per_pixel = base_->get_samplerate() * view->scale();
 340
 341         vector<LogicSegment::EdgePair> edges;
 342
 343         segment->get_surrounding_edges(edges, sample_pos,
 344                 samples_per_pixel / Oversampling, base_->index());
 345
 346         if (edges.empty())
 347                 return vector<LogicSegment::EdgePair>();
 348
 349         return edges;
 350 }
 351
 352 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
 353         vector< pair<int64_t, bool> > &edges, bool level,
 354         double samples_per_pixel, double pixels_offset, float x_offset,
 355         float y_offset)
 356 {
 357         QLineF *line = lines;
 358
 359         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
 360                 if ((*i).second == level) {
 361                         *line++ = QLineF(
 362                                 ((*i).first / samples_per_pixel -
 363                                         pixels_offset) + x_offset, y_offset,
 364                                 ((*(i+1)).first / samples_per_pixel -
 365                                         pixels_offset) + x_offset, y_offset);
 366                 }
 367
 368         p.drawLines(lines, line - lines);
 369 }
 370
 371 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
 372 {
 373         shared_ptr<pv::data::LogicSegment> segment;
 374
 375         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
 376                 base_->logic_data()->logic_segments();
 377
 378         if (!segments.empty()) {
 379                 if (segment_display_mode_ == ShowLastSegmentOnly) {
 380                         segment = segments.back();
 381                 }
 382
 383         if ((segment_display_mode_ == ShowSingleSegmentOnly) ||
 384                 (segment_display_mode_ == ShowLastCompleteSegmentOnly)) {
 385                         try {
 386                                 segment = segments.at(current_segment_);
 387                         } catch (out_of_range&) {
 388                                 qDebug() << "Current logic segment out of range for signal" << base_->name() << ":" << current_segment_;
 389                         }
 390                 }
 391         }
 392
 393         return segment;
 394 }
 395
 396 void LogicSignal::init_trigger_actions(QWidget *parent)
 397 {
 398         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
 399                 tr("No trigger"), parent);
 400         trigger_none_->setCheckable(true);
 401         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 402
 403         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
 404                 tr("Trigger on rising edge"), parent);
 405         trigger_rising_->setCheckable(true);
 406         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 407
 408         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
 409                 tr("Trigger on high level"), parent);
 410         trigger_high_->setCheckable(true);
 411         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 412
 413         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
 414                 tr("Trigger on falling edge"), parent);
 415         trigger_falling_->setCheckable(true);
 416         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 417
 418         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
 419                 tr("Trigger on low level"), parent);
 420         trigger_low_->setCheckable(true);
 421         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 422
 423         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
 424                 tr("Trigger on rising or falling edge"), parent);
 425         trigger_change_->setCheckable(true);
 426         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 427 }
 428
 429 const vector<int32_t> LogicSignal::get_trigger_types() const
 430 {
 431         // We may not be associated with a device
 432         if (!device_)
 433                 return vector<int32_t>();
 434
 435         const auto sr_dev = device_->device();
 436         if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
 437                 const Glib::VariantContainerBase gvar =
 438                         sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
 439
 440                 vector<int32_t> ttypes;
 441
 442                 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
 443                         Glib::VariantBase tmp_vb;
 444                         gvar.get_child(tmp_vb, i);
 445
 446                         Glib::Variant<int32_t> tmp_v =
 447                                 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
 448
 449                         ttypes.push_back(tmp_v.get());
 450                 }
 451
 452                 return ttypes;
 453         } else {
 454                 return vector<int32_t>();
 455         }
 456 }
 457
 458 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
 459 {
 460         QAction *action;
 461
 462         action = trigger_none_;
 463         if (type) {
 464                 switch (type->id()) {
 465                 case SR_TRIGGER_ZERO:
 466                         action = trigger_low_;
 467                         break;
 468                 case SR_TRIGGER_ONE:
 469                         action = trigger_high_;
 470                         break;
 471                 case SR_TRIGGER_RISING:
 472                         action = trigger_rising_;
 473                         break;
 474                 case SR_TRIGGER_FALLING:
 475                         action = trigger_falling_;
 476                         break;
 477                 case SR_TRIGGER_EDGE:
 478                         action = trigger_change_;
 479                         break;
 480                 default:
 481                         assert(false);
 482                 }
 483         }
 484
 485         return action;
 486 }
 487
 488 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
 489 {
 490         if (action == trigger_low_)
 491                 return TriggerMatchType::ZERO;
 492         else if (action == trigger_high_)
 493                 return TriggerMatchType::ONE;
 494         else if (action == trigger_rising_)
 495                 return TriggerMatchType::RISING;
 496         else if (action == trigger_falling_)
 497                 return TriggerMatchType::FALLING;
 498         else if (action == trigger_change_)
 499                 return TriggerMatchType::EDGE;
 500         else
 501                 return nullptr;
 502 }
 503
 504 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 505 {
 506         Signal::populate_popup_form(parent, form);
 507
 508         signal_height_sb_ = new QSpinBox(parent);
 509         signal_height_sb_->setRange(5, 1000);
 510         signal_height_sb_->setSingleStep(5);
 511         signal_height_sb_->setSuffix(tr(" pixels"));
 512         signal_height_sb_->setValue(signal_height_);
 513         connect(signal_height_sb_, SIGNAL(valueChanged(int)),
 514                 this, SLOT(on_signal_height_changed(int)));
 515         form->addRow(tr("Trace height"), signal_height_sb_);
 516
 517         // Trigger settings
 518         const vector<int32_t> trig_types = get_trigger_types();
 519
 520         if (!trig_types.empty()) {
 521                 trigger_bar_ = new QToolBar(parent);
 522                 init_trigger_actions(trigger_bar_);
 523                 trigger_bar_->addAction(trigger_none_);
 524                 trigger_none_->setChecked(!trigger_match_);
 525
 526                 for (auto type_id : trig_types) {
 527                         const TriggerMatchType *const type =
 528                                 TriggerMatchType::get(type_id);
 529                         QAction *const action = action_from_trigger_type(type);
 530                         trigger_bar_->addAction(action);
 531                         action->setChecked(trigger_match_ == type);
 532                 }
 533
 534                 // Only allow triggers to be changed when we're stopped
 535                 if (session_.get_capture_state() != Session::Stopped)
 536                         for (QAction* action : trigger_bar_->findChildren<QAction*>())
 537                                 action->setEnabled(false);
 538
 539                 form->addRow(tr("Trigger"), trigger_bar_);
 540         }
 541 }
 542
 543 void LogicSignal::modify_trigger()
 544 {
 545         auto trigger = session_.session()->trigger();
 546         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
 547
 548         if (trigger) {
 549                 for (auto stage : trigger->stages()) {
 550                         const auto &matches = stage->matches();
 551                         if (none_of(matches.begin(), matches.end(),
 552                             [&](shared_ptr<TriggerMatch> match) {
 553                                         return match->channel() != base_->channel(); }))
 554                                 continue;
 555
 556                         auto new_stage = new_trigger->add_stage();
 557                         for (auto match : stage->matches()) {
 558                                 if (match->channel() == base_->channel())
 559                                         continue;
 560                                 new_stage->add_match(match->channel(), match->type());
 561                         }
 562                 }
 563         }
 564
 565         if (trigger_match_) {
 566                 // Until we can let the user decide how to group trigger matches
 567                 // into stages, put all of the matches into a single stage --
 568                 // most devices only support a single trigger stage.
 569                 if (new_trigger->stages().empty())
 570                         new_trigger->add_stage();
 571
 572                 new_trigger->stages().back()->add_match(base_->channel(),
 573                         trigger_match_);
 574         }
 575
 576         session_.session()->set_trigger(
 577                 new_trigger->stages().empty() ? nullptr : new_trigger);
 578
 579         if (owner_)
 580                 owner_->row_item_appearance_changed(false, true);
 581 }
 582
 583 const QIcon* LogicSignal::get_icon(const char *path)
 584 {
 585         if (!icon_cache_.contains(path)) {
 586                 const QIcon *icon = new QIcon(path);
 587                 icon_cache_.insert(path, icon);
 588         }
 589
 590         return icon_cache_.take(path);
 591 }
 592
 593 const QPixmap* LogicSignal::get_pixmap(const char *path)
 594 {
 595         if (!pixmap_cache_.contains(path)) {
 596                 const QPixmap *pixmap = new QPixmap(path);
 597                 pixmap_cache_.insert(path, pixmap);
 598         }
 599
 600         return pixmap_cache_.take(path);
 601 }
 602
 603 void LogicSignal::on_trigger()
 604 {
 605         QAction *action;
 606
 607         action_from_trigger_type(trigger_match_)->setChecked(false);
 608
 609         action = (QAction *)sender();
 610         action->setChecked(true);
 611         trigger_match_ = trigger_type_from_action(action);
 612
 613         modify_trigger();
 614 }
 615
 616 void LogicSignal::on_signal_height_changed(int height)
 617 {
 618         signal_height_ = height;
 619
 620         if (owner_) {
 621                 // Call order is important, otherwise the lazy event handler won't work
 622                 owner_->extents_changed(false, true);
 623                 owner_->row_item_appearance_changed(false, true);
 624         }
 625 }
 626
 627 } // namespace trace
 628 } // namespace views
 629 } // namespace pv