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