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