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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <extdef.h>
  22
  23 #include <cassert>
  24 #include <cmath>
  25
  26 #include <algorithm>
  27
  28 #include <QFormLayout>
  29 #include <QToolBar>
  30
  31 #include "logicsignal.hpp"
  32 #include "view.hpp"
  33
  34 #include <pv/session.hpp>
  35 #include <pv/devicemanager.hpp>
  36 #include <pv/devices/device.hpp>
  37 #include <pv/data/logic.hpp>
  38 #include <pv/data/logicsegment.hpp>
  39 #include <pv/view/view.hpp>
  40
  41 #include <libsigrokcxx/libsigrokcxx.hpp>
  42
  43 using std::deque;
  44 using std::max;
  45 using std::make_pair;
  46 using std::min;
  47 using std::pair;
  48 using std::shared_ptr;
  49 using std::vector;
  50
  51 using sigrok::Channel;
  52 using sigrok::ConfigKey;
  53 using sigrok::Error;
  54 using sigrok::Trigger;
  55 using sigrok::TriggerStage;
  56 using sigrok::TriggerMatch;
  57 using sigrok::TriggerMatchType;
  58
  59 namespace pv {
  60 namespace view {
  61
  62 const int LogicSignal::SignalHeight = 30;
  63 const int LogicSignal::SignalMargin = 10;
  64
  65 const float LogicSignal::Oversampling = 2.0f;
  66
  67 const QColor LogicSignal::EdgeColour(0x80, 0x80, 0x80);
  68 const QColor LogicSignal::HighColour(0x00, 0xC0, 0x00);
  69 const QColor LogicSignal::LowColour(0xC0, 0x00, 0x00);
  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<Channel> channel,
 104         shared_ptr<data::Logic> data) :
 105         Signal(session, channel),
 106         device_(device),
 107         data_(data),
 108         trigger_none_(nullptr),
 109         trigger_rising_(nullptr),
 110         trigger_high_(nullptr),
 111         trigger_falling_(nullptr),
 112         trigger_low_(nullptr),
 113         trigger_change_(nullptr)
 114 {
 115         shared_ptr<Trigger> trigger;
 116
 117         colour_ = SignalColours[channel->index() % countof(SignalColours)];
 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() == channel_)
 126                                         trigger_match_ = match->type();
 127 }
 128
 129 LogicSignal::~LogicSignal()
 130 {
 131 }
 132
 133 shared_ptr<pv::data::SignalData> LogicSignal::data() const
 134 {
 135         return data_;
 136 }
 137
 138 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
 139 {
 140         return data_;
 141 }
 142
 143 void LogicSignal::set_logic_data(std::shared_ptr<pv::data::Logic> data)
 144 {
 145         data_ = data;
 146 }
 147
 148 std::pair<int, int> LogicSignal::v_extents() const
 149 {
 150         return make_pair(-SignalHeight - SignalMargin, SignalMargin);
 151 }
 152
 153 void LogicSignal::paint_back(QPainter &p, const ViewItemPaintParams &pp)
 154 {
 155         if (channel_->enabled())
 156                 paint_axis(p, pp, get_visual_y());
 157 }
 158
 159 void LogicSignal::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
 160 {
 161         QLineF *line;
 162
 163         vector< pair<int64_t, bool> > edges;
 164
 165         assert(channel_);
 166         assert(data_);
 167         assert(owner_);
 168
 169         const int y = get_visual_y();
 170
 171         if (!channel_->enabled())
 172                 return;
 173
 174         const float high_offset = y - SignalHeight + 0.5f;
 175         const float low_offset = y + 0.5f;
 176
 177         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
 178                 data_->logic_segments();
 179         if (segments.empty())
 180                 return;
 181
 182         const shared_ptr<pv::data::LogicSegment> &segment =
 183                 segments.front();
 184
 185         double samplerate = segment->samplerate();
 186
 187         // Show sample rate as 1Hz when it is unknown
 188         if (samplerate == 0.0)
 189                 samplerate = 1.0;
 190
 191         const double pixels_offset = pp.pixels_offset();
 192         const double start_time = segment->start_time();
 193         const int64_t last_sample = segment->get_sample_count() - 1;
 194         const double samples_per_pixel = samplerate * pp.scale();
 195         const double start = samplerate * (pp.offset() - start_time);
 196         const double end = start + samples_per_pixel * pp.width();
 197
 198         segment->get_subsampled_edges(edges,
 199                 min(max((int64_t)floor(start), (int64_t)0), last_sample),
 200                 min(max((int64_t)ceil(end), (int64_t)0), last_sample),
 201                 samples_per_pixel / Oversampling, channel_->index());
 202         assert(edges.size() >= 2);
 203
 204         // Paint the edges
 205         const unsigned int edge_count = edges.size() - 2;
 206         QLineF *const edge_lines = new QLineF[edge_count];
 207         line = edge_lines;
 208
 209         for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
 210                 const float x = ((*i).first / samples_per_pixel -
 211                         pixels_offset) + pp.left();
 212                 *line++ = QLineF(x, high_offset, x, low_offset);
 213         }
 214
 215         p.setPen(EdgeColour);
 216         p.drawLines(edge_lines, edge_count);
 217         delete[] edge_lines;
 218
 219         // Paint the caps
 220         const unsigned int max_cap_line_count = edges.size();
 221         QLineF *const cap_lines = new QLineF[max_cap_line_count];
 222
 223         p.setPen(HighColour);
 224         paint_caps(p, cap_lines, edges, true, samples_per_pixel,
 225                 pixels_offset, pp.left(), high_offset);
 226         p.setPen(LowColour);
 227         paint_caps(p, cap_lines, edges, false, samples_per_pixel,
 228                 pixels_offset, pp.left(), low_offset);
 229
 230         delete[] cap_lines;
 231 }
 232
 233 void LogicSignal::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
 234 {
 235         // Draw the trigger marker
 236         if (!trigger_match_)
 237                 return;
 238
 239         const int y = get_visual_y();
 240         const vector<int32_t> trig_types = get_trigger_types();
 241         for (int32_t type_id : trig_types) {
 242                 const TriggerMatchType *const type =
 243                         TriggerMatchType::get(type_id);
 244                 if (trigger_match_ != type || type_id < 0 ||
 245                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
 246                         !TriggerMarkerIcons[type_id])
 247                         continue;
 248
 249                 const QPixmap *const pixmap = get_pixmap(
 250                         TriggerMarkerIcons[type_id]);
 251                 if (!pixmap)
 252                         continue;
 253
 254                 const float pad = TriggerMarkerPadding - 0.5f;
 255                 const QSize size = pixmap->size();
 256                 const QPoint point(
 257                         pp.right() - size.width() - pad * 2,
 258                         y - (SignalHeight + size.height()) / 2);
 259
 260                 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
 261                 p.setBrush(TriggerMarkerBackgroundColour);
 262                 p.drawRoundedRect(QRectF(point, size).adjusted(
 263                         -pad, -pad, pad, pad), pad, pad);
 264                 p.drawPixmap(point, *pixmap);
 265
 266                 break;
 267         }
 268 }
 269
 270 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
 271         vector< pair<int64_t, bool> > &edges, bool level,
 272         double samples_per_pixel, double pixels_offset, float x_offset,
 273         float y_offset)
 274 {
 275         QLineF *line = lines;
 276
 277         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
 278                 if ((*i).second == level) {
 279                         *line++ = QLineF(
 280                                 ((*i).first / samples_per_pixel -
 281                                         pixels_offset) + x_offset, y_offset,
 282                                 ((*(i+1)).first / samples_per_pixel -
 283                                         pixels_offset) + x_offset, y_offset);
 284                 }
 285
 286         p.drawLines(lines, line - lines);
 287 }
 288
 289 void LogicSignal::init_trigger_actions(QWidget *parent)
 290 {
 291         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
 292                 tr("No trigger"), parent);
 293         trigger_none_->setCheckable(true);
 294         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 295
 296         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
 297                 tr("Trigger on rising edge"), parent);
 298         trigger_rising_->setCheckable(true);
 299         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 300
 301         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
 302                 tr("Trigger on high level"), parent);
 303         trigger_high_->setCheckable(true);
 304         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 305
 306         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
 307                 tr("Trigger on falling edge"), parent);
 308         trigger_falling_->setCheckable(true);
 309         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 310
 311         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
 312                 tr("Trigger on low level"), parent);
 313         trigger_low_->setCheckable(true);
 314         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 315
 316         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
 317                 tr("Trigger on rising or falling edge"), parent);
 318         trigger_change_->setCheckable(true);
 319         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 320 }
 321
 322 const vector<int32_t> LogicSignal::get_trigger_types() const
 323 {
 324         const auto sr_dev = device_->device();
 325         const auto keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
 326         const auto iter = keys.find(ConfigKey::TRIGGER_MATCH);
 327         if (iter != keys.end() &&
 328                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 329                 try {
 330                         const Glib::VariantContainerBase gvar =
 331                                 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
 332                         return Glib::VariantBase::cast_dynamic<
 333                                 Glib::Variant<vector<int32_t>>>(gvar).get();
 334                 } catch (Error e) {
 335                         // Failed to enumerate triggers
 336                         (void)e;
 337                 }
 338         }
 339
 340         return vector<int32_t>();
 341 }
 342
 343 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
 344 {
 345         QAction *action;
 346
 347         action = trigger_none_;
 348         if (type) {
 349                 switch (type->id()) {
 350                 case SR_TRIGGER_ZERO:
 351                         action = trigger_low_;
 352                         break;
 353                 case SR_TRIGGER_ONE:
 354                         action = trigger_high_;
 355                         break;
 356                 case SR_TRIGGER_RISING:
 357                         action = trigger_rising_;
 358                         break;
 359                 case SR_TRIGGER_FALLING:
 360                         action = trigger_falling_;
 361                         break;
 362                 case SR_TRIGGER_EDGE:
 363                         action = trigger_change_;
 364                         break;
 365                 default:
 366                         assert(0);
 367                 }
 368         }
 369
 370         return action;
 371 }
 372
 373 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
 374 {
 375         if (action == trigger_low_)
 376                 return TriggerMatchType::ZERO;
 377         else if (action == trigger_high_)
 378                 return TriggerMatchType::ONE;
 379         else if (action == trigger_rising_)
 380                 return TriggerMatchType::RISING;
 381         else if (action == trigger_falling_)
 382                 return TriggerMatchType::FALLING;
 383         else if (action == trigger_change_)
 384                 return TriggerMatchType::EDGE;
 385         else
 386                 return nullptr;
 387 }
 388
 389 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 390 {
 391         Signal::populate_popup_form(parent, form);
 392
 393         const vector<int32_t> trig_types = get_trigger_types();
 394
 395         if (!trig_types.empty()) {
 396                 trigger_bar_ = new QToolBar(parent);
 397                 init_trigger_actions(trigger_bar_);
 398                 trigger_bar_->addAction(trigger_none_);
 399                 trigger_none_->setChecked(!trigger_match_);
 400
 401                 for (auto type_id : trig_types) {
 402                         const TriggerMatchType *const type =
 403                                 TriggerMatchType::get(type_id);
 404                         QAction *const action = action_from_trigger_type(type);
 405                         trigger_bar_->addAction(action);
 406                         action->setChecked(trigger_match_ == type);
 407                 }
 408                 form->addRow(tr("Trigger"), trigger_bar_);
 409         }
 410 }
 411
 412 void LogicSignal::modify_trigger()
 413 {
 414         auto trigger = session_.session()->trigger();
 415         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
 416
 417         if (trigger) {
 418                 for (auto stage : trigger->stages()) {
 419                         const auto &matches = stage->matches();
 420                         if (std::none_of(begin(matches), end(matches),
 421                             [&](shared_ptr<TriggerMatch> match) {
 422                                         return match->channel() != channel_; }))
 423                                 continue;
 424
 425                         auto new_stage = new_trigger->add_stage();
 426                         for (auto match : stage->matches()) {
 427                                 if (match->channel() == channel_)
 428                                         continue;
 429                                 new_stage->add_match(match->channel(), match->type());
 430                         }
 431                 }
 432         }
 433
 434         if (trigger_match_)
 435                 new_trigger->add_stage()->add_match(channel_, trigger_match_);
 436
 437         session_.session()->set_trigger(
 438                 new_trigger->stages().empty() ? nullptr : new_trigger);
 439
 440         if (owner_)
 441                 owner_->row_item_appearance_changed(false, true);
 442 }
 443
 444 const QIcon* LogicSignal::get_icon(const char *path)
 445 {
 446         const QIcon *icon = icon_cache_.take(path);
 447         if (!icon) {
 448                 icon = new QIcon(path);
 449                 icon_cache_.insert(path, icon);
 450         }
 451
 452         return icon;
 453 }
 454
 455 const QPixmap* LogicSignal::get_pixmap(const char *path)
 456 {
 457         const QPixmap *pixmap = pixmap_cache_.take(path);
 458         if (!pixmap) {
 459                 pixmap = new QPixmap(path);
 460                 pixmap_cache_.insert(path, pixmap);
 461         }
 462
 463         return pixmap;
 464 }
 465
 466 void LogicSignal::on_trigger()
 467 {
 468         QAction *action;
 469
 470         action_from_trigger_type(trigger_match_)->setChecked(false);
 471
 472         action = (QAction *)sender();
 473         action->setChecked(true);
 474         trigger_match_ = trigger_type_from_action(action);
 475
 476         modify_trigger();
 477 }
 478
 479 } // namespace view
 480 } // namespace pv