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::EdgeColour(0x80, 0x80, 0x80);
  67 const QColor LogicSignal::HighColour(0x00, 0xC0, 0x00);
  68 const QColor LogicSignal::LowColour(0xC0, 0x00, 0x00);
  69 const QColor LogicSignal::SamplingPointColour(0x77, 0x77, 0x77);
  70
  71 const QColor LogicSignal::SignalColours[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::TriggerMarkerBackgroundColour = 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_none_(nullptr),
 107         trigger_rising_(nullptr),
 108         trigger_high_(nullptr),
 109         trigger_falling_(nullptr),
 110         trigger_low_(nullptr),
 111         trigger_change_(nullptr)
 112 {
 113         shared_ptr<Trigger> trigger;
 114
 115         base_->set_colour(SignalColours[base->index() % countof(SignalColours)]);
 116
 117         GlobalSettings gs;
 118         signal_height_ = gs.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
 119
 120         /* Populate this channel's trigger setting with whatever we
 121          * find in the current session trigger, if anything. */
 122         trigger_match_ = nullptr;
 123         if ((trigger = session_.session()->trigger()))
 124                 for (auto stage : trigger->stages())
 125                         for (auto match : stage->matches())
 126                                 if (match->channel() == base_->channel())
 127                                         trigger_match_ = match->type();
 128 }
 129
 130 shared_ptr<pv::data::SignalData> LogicSignal::data() const
 131 {
 132         return base_->logic_data();
 133 }
 134
 135 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
 136 {
 137         return base_->logic_data();
 138 }
 139
 140 void LogicSignal::save_settings(QSettings &settings) const
 141 {
 142         settings.setValue("trace_height", signal_height_);
 143 }
 144
 145 void LogicSignal::restore_settings(QSettings &settings)
 146 {
 147         if (settings.contains("trace_height")) {
 148                 const int old_height = signal_height_;
 149                 signal_height_ = settings.value("trace_height").toInt();
 150
 151                 if ((signal_height_ != old_height) && owner_) {
 152                         // Call order is important, otherwise the lazy event handler won't work
 153                         owner_->extents_changed(false, true);
 154                         owner_->row_item_appearance_changed(false, true);
 155                 }
 156         }
 157 }
 158
 159 pair<int, int> LogicSignal::v_extents() const
 160 {
 161         const int signal_margin =
 162                 QFontMetrics(QApplication::font()).height() / 2;
 163         return make_pair(-signal_height_ - signal_margin, signal_margin);
 164 }
 165
 166 int LogicSignal::scale_handle_offset() const
 167 {
 168         return -signal_height_;
 169 }
 170
 171 void LogicSignal::scale_handle_dragged(int offset)
 172 {
 173         const int font_height = QFontMetrics(QApplication::font()).height();
 174         const int units = (-offset / font_height);
 175         signal_height_ = ((units < 1) ? 1 : units) * font_height;
 176 }
 177
 178 void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 179 {
 180         QLineF *line;
 181
 182         vector< pair<int64_t, bool> > edges;
 183
 184         assert(base_);
 185         assert(owner_);
 186
 187         const int y = get_visual_y();
 188
 189         if (!base_->enabled())
 190                 return;
 191
 192         const float high_offset = y - signal_height_ + 0.5f;
 193         const float low_offset = y + 0.5f;
 194
 195         shared_ptr<pv::data::LogicSegment> segment = get_logic_segment_to_paint();
 196         if (!segment)
 197                 return;
 198
 199         double samplerate = segment->samplerate();
 200
 201         // Show sample rate as 1Hz when it is unknown
 202         if (samplerate == 0.0)
 203                 samplerate = 1.0;
 204
 205         const double pixels_offset = pp.pixels_offset();
 206         const pv::util::Timestamp& start_time = segment->start_time();
 207         const int64_t last_sample = segment->get_sample_count() - 1;
 208         const double samples_per_pixel = samplerate * pp.scale();
 209         const double pixels_per_sample = 1 / samples_per_pixel;
 210         const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
 211         const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
 212
 213         const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
 214                 (int64_t)0), last_sample);
 215         const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
 216                 (int64_t)0), last_sample);
 217
 218         segment->get_subsampled_edges(edges, start_sample, end_sample,
 219                 samples_per_pixel / Oversampling, base_->index());
 220         assert(edges.size() >= 2);
 221
 222         // Check whether we need to paint the sampling points
 223         GlobalSettings settings;
 224         const bool show_sampling_points =
 225                 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool() &&
 226                 (samples_per_pixel < 0.25);
 227
 228         vector<QRectF> sampling_points;
 229         float sampling_point_x = 0.0f;
 230         int64_t sampling_point_sample = start_sample;
 231         const int w = 2;
 232
 233         if (show_sampling_points) {
 234                 sampling_points.reserve(end_sample - start_sample + 1);
 235                 sampling_point_x = (edges.cbegin()->first / samples_per_pixel - pixels_offset) + pp.left();
 236         }
 237
 238         // Paint the edges
 239         const unsigned int edge_count = edges.size() - 2;
 240         QLineF *const edge_lines = new QLineF[edge_count];
 241         line = edge_lines;
 242
 243         for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
 244                 const float x = ((*i).first / samples_per_pixel -
 245                         pixels_offset) + pp.left();
 246                 *line++ = QLineF(x, high_offset, x, low_offset);
 247
 248                 if (show_sampling_points)
 249                         while (sampling_point_sample < (*i).first) {
 250                                 const float y = (*i).second ? low_offset : high_offset;
 251                                 sampling_points.emplace_back(
 252                                         QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
 253                                 sampling_point_sample++;
 254                                 sampling_point_x += pixels_per_sample;
 255                         };
 256         }
 257
 258         // Calculate the sample points from the last edge to the end of the trace
 259         if (show_sampling_points)
 260                 while ((uint64_t)sampling_point_sample <= end_sample) {
 261                         // Signal changed after the last edge, so the level is inverted
 262                         const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
 263                         sampling_points.emplace_back(
 264                                 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
 265                         sampling_point_sample++;
 266                         sampling_point_x += pixels_per_sample;
 267                 };
 268
 269         p.setPen(EdgeColour);
 270         p.drawLines(edge_lines, edge_count);
 271         delete[] edge_lines;
 272
 273         // Paint the caps
 274         const unsigned int max_cap_line_count = edges.size();
 275         QLineF *const cap_lines = new QLineF[max_cap_line_count];
 276
 277         p.setPen(HighColour);
 278         paint_caps(p, cap_lines, edges, true, samples_per_pixel,
 279                 pixels_offset, pp.left(), high_offset);
 280         p.setPen(LowColour);
 281         paint_caps(p, cap_lines, edges, false, samples_per_pixel,
 282                 pixels_offset, pp.left(), low_offset);
 283
 284         delete[] cap_lines;
 285
 286         // Paint the sampling points
 287         if (show_sampling_points) {
 288                 p.setPen(SamplingPointColour);
 289                 p.drawRects(sampling_points.data(), sampling_points.size());
 290         }
 291 }
 292
 293 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
 294 {
 295         // Draw the trigger marker
 296         if (!trigger_match_ || !base_->enabled())
 297                 return;
 298
 299         const int y = get_visual_y();
 300         const vector<int32_t> trig_types = get_trigger_types();
 301         for (int32_t type_id : trig_types) {
 302                 const TriggerMatchType *const type =
 303                         TriggerMatchType::get(type_id);
 304                 if (trigger_match_ != type || type_id < 0 ||
 305                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
 306                         !TriggerMarkerIcons[type_id])
 307                         continue;
 308
 309                 const QPixmap *const pixmap = get_pixmap(
 310                         TriggerMarkerIcons[type_id]);
 311                 if (!pixmap)
 312                         continue;
 313
 314                 const float pad = TriggerMarkerPadding - 0.5f;
 315                 const QSize size = pixmap->size();
 316                 const QPoint point(
 317                         pp.right() - size.width() - pad * 2,
 318                         y - (signal_height_ + size.height()) / 2);
 319
 320                 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
 321                 p.setBrush(TriggerMarkerBackgroundColour);
 322                 p.drawRoundedRect(QRectF(point, size).adjusted(
 323                         -pad, -pad, pad, pad), pad, pad);
 324                 p.drawPixmap(point, *pixmap);
 325
 326                 break;
 327         }
 328 }
 329
 330 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
 331         vector< pair<int64_t, bool> > &edges, bool level,
 332         double samples_per_pixel, double pixels_offset, float x_offset,
 333         float y_offset)
 334 {
 335         QLineF *line = lines;
 336
 337         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
 338                 if ((*i).second == level) {
 339                         *line++ = QLineF(
 340                                 ((*i).first / samples_per_pixel -
 341                                         pixels_offset) + x_offset, y_offset,
 342                                 ((*(i+1)).first / samples_per_pixel -
 343                                         pixels_offset) + x_offset, y_offset);
 344                 }
 345
 346         p.drawLines(lines, line - lines);
 347 }
 348
 349 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
 350 {
 351         shared_ptr<pv::data::LogicSegment> segment;
 352
 353         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
 354                 base_->logic_data()->logic_segments();
 355
 356         if (!segments.empty()) {
 357                 if (segment_display_mode_ == ShowLastSegmentOnly) {
 358                         segment = segments.back();
 359                 }
 360
 361                 if (segment_display_mode_ == ShowSingleSegmentOnly) {
 362                         try {
 363                                 segment = segments.at(current_segment_);
 364                         } catch (out_of_range) {
 365                                 qDebug() << "Current logic segment out of range for signal" << base_->name();
 366                         }
 367                 }
 368         }
 369
 370         return segment;
 371 }
 372
 373 void LogicSignal::init_trigger_actions(QWidget *parent)
 374 {
 375         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
 376                 tr("No trigger"), parent);
 377         trigger_none_->setCheckable(true);
 378         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 379
 380         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
 381                 tr("Trigger on rising edge"), parent);
 382         trigger_rising_->setCheckable(true);
 383         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 384
 385         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
 386                 tr("Trigger on high level"), parent);
 387         trigger_high_->setCheckable(true);
 388         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 389
 390         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
 391                 tr("Trigger on falling edge"), parent);
 392         trigger_falling_->setCheckable(true);
 393         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 394
 395         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
 396                 tr("Trigger on low level"), parent);
 397         trigger_low_->setCheckable(true);
 398         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 399
 400         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
 401                 tr("Trigger on rising or falling edge"), parent);
 402         trigger_change_->setCheckable(true);
 403         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 404 }
 405
 406 const vector<int32_t> LogicSignal::get_trigger_types() const
 407 {
 408         // We may not be associated with a device
 409         if (!device_)
 410                 return vector<int32_t>();
 411
 412         const auto sr_dev = device_->device();
 413         if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
 414                 const Glib::VariantContainerBase gvar =
 415                         sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
 416
 417                 vector<int32_t> ttypes;
 418
 419                 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
 420                         Glib::VariantBase tmp_vb;
 421                         gvar.get_child(tmp_vb, i);
 422
 423                         Glib::Variant<int32_t> tmp_v =
 424                                 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
 425
 426                         ttypes.push_back(tmp_v.get());
 427                 }
 428
 429                 return ttypes;
 430         } else {
 431                 return vector<int32_t>();
 432         }
 433 }
 434
 435 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
 436 {
 437         QAction *action;
 438
 439         action = trigger_none_;
 440         if (type) {
 441                 switch (type->id()) {
 442                 case SR_TRIGGER_ZERO:
 443                         action = trigger_low_;
 444                         break;
 445                 case SR_TRIGGER_ONE:
 446                         action = trigger_high_;
 447                         break;
 448                 case SR_TRIGGER_RISING:
 449                         action = trigger_rising_;
 450                         break;
 451                 case SR_TRIGGER_FALLING:
 452                         action = trigger_falling_;
 453                         break;
 454                 case SR_TRIGGER_EDGE:
 455                         action = trigger_change_;
 456                         break;
 457                 default:
 458                         assert(false);
 459                 }
 460         }
 461
 462         return action;
 463 }
 464
 465 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
 466 {
 467         if (action == trigger_low_)
 468                 return TriggerMatchType::ZERO;
 469         else if (action == trigger_high_)
 470                 return TriggerMatchType::ONE;
 471         else if (action == trigger_rising_)
 472                 return TriggerMatchType::RISING;
 473         else if (action == trigger_falling_)
 474                 return TriggerMatchType::FALLING;
 475         else if (action == trigger_change_)
 476                 return TriggerMatchType::EDGE;
 477         else
 478                 return nullptr;
 479 }
 480
 481 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 482 {
 483         Signal::populate_popup_form(parent, form);
 484
 485         signal_height_sb_ = new QSpinBox(parent);
 486         signal_height_sb_->setRange(5, 1000);
 487         signal_height_sb_->setSingleStep(5);
 488         signal_height_sb_->setSuffix(tr(" pixels"));
 489         signal_height_sb_->setValue(signal_height_);
 490         connect(signal_height_sb_, SIGNAL(valueChanged(int)),
 491                 this, SLOT(on_signal_height_changed(int)));
 492         form->addRow(tr("Trace height"), signal_height_sb_);
 493
 494         // Trigger settings
 495         const vector<int32_t> trig_types = get_trigger_types();
 496
 497         if (!trig_types.empty()) {
 498                 trigger_bar_ = new QToolBar(parent);
 499                 init_trigger_actions(trigger_bar_);
 500                 trigger_bar_->addAction(trigger_none_);
 501                 trigger_none_->setChecked(!trigger_match_);
 502
 503                 for (auto type_id : trig_types) {
 504                         const TriggerMatchType *const type =
 505                                 TriggerMatchType::get(type_id);
 506                         QAction *const action = action_from_trigger_type(type);
 507                         trigger_bar_->addAction(action);
 508                         action->setChecked(trigger_match_ == type);
 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