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