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 <QApplication>
  29 #include <QFormLayout>
  30 #include <QToolBar>
  31
  32 #include "logicsignal.hpp"
  33 #include "view.hpp"
  34
  35 #include <pv/session.hpp>
  36 #include <pv/devicemanager.hpp>
  37 #include <pv/devices/device.hpp>
  38 #include <pv/data/logic.hpp>
  39 #include <pv/data/logicsegment.hpp>
  40 #include <pv/view/view.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::pair;
  49 using std::shared_ptr;
  50 using std::vector;
  51
  52 using sigrok::Channel;
  53 using sigrok::ConfigKey;
  54 using sigrok::Error;
  55 using sigrok::Trigger;
  56 using sigrok::TriggerStage;
  57 using sigrok::TriggerMatch;
  58 using sigrok::TriggerMatchType;
  59
  60 namespace pv {
  61 namespace view {
  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
  69 const QColor LogicSignal::SignalColours[10] = {
  70         QColor(0x16, 0x19, 0x1A),       // Black
  71         QColor(0x8F, 0x52, 0x02),       // Brown
  72         QColor(0xCC, 0x00, 0x00),       // Red
  73         QColor(0xF5, 0x79, 0x00),       // Orange
  74         QColor(0xED, 0xD4, 0x00),       // Yellow
  75         QColor(0x73, 0xD2, 0x16),       // Green
  76         QColor(0x34, 0x65, 0xA4),       // Blue
  77         QColor(0x75, 0x50, 0x7B),       // Violet
  78         QColor(0x88, 0x8A, 0x85),       // Grey
  79         QColor(0xEE, 0xEE, 0xEC),       // White
  80 };
  81
  82 QColor LogicSignal::TriggerMarkerBackgroundColour = QColor(0xED, 0xD4, 0x00);
  83 const int LogicSignal::TriggerMarkerPadding = 2;
  84 const char* LogicSignal::TriggerMarkerIcons[8] = {
  85         nullptr,
  86         ":/icons/trigger-marker-low.svg",
  87         ":/icons/trigger-marker-high.svg",
  88         ":/icons/trigger-marker-rising.svg",
  89         ":/icons/trigger-marker-falling.svg",
  90         ":/icons/trigger-marker-change.svg",
  91         nullptr,
  92         nullptr
  93 };
  94
  95 QCache<QString, const QIcon> LogicSignal::icon_cache_;
  96 QCache<QString, const QPixmap> LogicSignal::pixmap_cache_;
  97
  98 LogicSignal::LogicSignal(
  99         pv::Session &session,
 100         shared_ptr<devices::Device> device,
 101         shared_ptr<Channel> channel,
 102         shared_ptr<data::Logic> data) :
 103         Signal(session, channel),
 104         signal_height_(QFontMetrics(QApplication::font()).height() * 2),
 105         device_(device),
 106         data_(data),
 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         set_colour(SignalColours[channel->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() == channel_)
 125                                         trigger_match_ = match->type();
 126 }
 127
 128 LogicSignal::~LogicSignal()
 129 {
 130 }
 131
 132 shared_ptr<pv::data::SignalData> LogicSignal::data() const
 133 {
 134         return data_;
 135 }
 136
 137 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
 138 {
 139         return data_;
 140 }
 141
 142 void LogicSignal::set_logic_data(std::shared_ptr<pv::data::Logic> data)
 143 {
 144         data_ = data;
 145 }
 146
 147 std::pair<int, int> LogicSignal::v_extents() const
 148 {
 149         const int signal_margin =
 150                 QFontMetrics(QApplication::font()).height() / 2;
 151         return make_pair(-signal_height_ - signal_margin, signal_margin);
 152 }
 153
 154 int LogicSignal::scale_handle_offset() const
 155 {
 156         return -signal_height_;
 157 }
 158
 159 void LogicSignal::scale_handle_dragged(int offset)
 160 {
 161         const int font_height = QFontMetrics(QApplication::font()).height();
 162         const int units = (-offset / font_height);
 163         signal_height_ = ((units < 1) ? 1 : units) * font_height;
 164 }
 165
 166 void LogicSignal::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
 167 {
 168         QLineF *line;
 169
 170         vector< pair<int64_t, bool> > edges;
 171
 172         assert(channel_);
 173         assert(data_);
 174         assert(owner_);
 175
 176         const int y = get_visual_y();
 177
 178         if (!channel_->enabled())
 179                 return;
 180
 181         const float high_offset = y - signal_height_ + 0.5f;
 182         const float low_offset = y + 0.5f;
 183
 184         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
 185                 data_->logic_segments();
 186         if (segments.empty())
 187                 return;
 188
 189         const shared_ptr<pv::data::LogicSegment> &segment =
 190                 segments.front();
 191
 192         double samplerate = segment->samplerate();
 193
 194         // Show sample rate as 1Hz when it is unknown
 195         if (samplerate == 0.0)
 196                 samplerate = 1.0;
 197
 198         const double pixels_offset = pp.pixels_offset();
 199         const pv::util::Timestamp& start_time = segment->start_time();
 200         const int64_t last_sample = segment->get_sample_count() - 1;
 201         const double samples_per_pixel = samplerate * pp.scale();
 202         const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
 203         const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
 204
 205         const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
 206                 (int64_t)0), last_sample);
 207         const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
 208                 (int64_t)0), last_sample);
 209
 210         segment->get_subsampled_edges(edges, start_sample, end_sample,
 211                 samples_per_pixel / Oversampling, channel_->index());
 212         assert(edges.size() >= 2);
 213
 214         // Paint the edges
 215         const unsigned int edge_count = edges.size() - 2;
 216         QLineF *const edge_lines = new QLineF[edge_count];
 217         line = edge_lines;
 218
 219         for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
 220                 const float x = ((*i).first / samples_per_pixel -
 221                         pixels_offset) + pp.left();
 222                 *line++ = QLineF(x, high_offset, x, low_offset);
 223         }
 224
 225         p.setPen(EdgeColour);
 226         p.drawLines(edge_lines, edge_count);
 227         delete[] edge_lines;
 228
 229         // Paint the caps
 230         const unsigned int max_cap_line_count = edges.size();
 231         QLineF *const cap_lines = new QLineF[max_cap_line_count];
 232
 233         p.setPen(HighColour);
 234         paint_caps(p, cap_lines, edges, true, samples_per_pixel,
 235                 pixels_offset, pp.left(), high_offset);
 236         p.setPen(LowColour);
 237         paint_caps(p, cap_lines, edges, false, samples_per_pixel,
 238                 pixels_offset, pp.left(), low_offset);
 239
 240         delete[] cap_lines;
 241 }
 242
 243 void LogicSignal::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
 244 {
 245         // Draw the trigger marker
 246         if (!trigger_match_ || !channel_->enabled())
 247                 return;
 248
 249         const int y = get_visual_y();
 250         const vector<int32_t> trig_types = get_trigger_types();
 251         for (int32_t type_id : trig_types) {
 252                 const TriggerMatchType *const type =
 253                         TriggerMatchType::get(type_id);
 254                 if (trigger_match_ != type || type_id < 0 ||
 255                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
 256                         !TriggerMarkerIcons[type_id])
 257                         continue;
 258
 259                 const QPixmap *const pixmap = get_pixmap(
 260                         TriggerMarkerIcons[type_id]);
 261                 if (!pixmap)
 262                         continue;
 263
 264                 const float pad = TriggerMarkerPadding - 0.5f;
 265                 const QSize size = pixmap->size();
 266                 const QPoint point(
 267                         pp.right() - size.width() - pad * 2,
 268                         y - (signal_height_ + size.height()) / 2);
 269
 270                 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
 271                 p.setBrush(TriggerMarkerBackgroundColour);
 272                 p.drawRoundedRect(QRectF(point, size).adjusted(
 273                         -pad, -pad, pad, pad), pad, pad);
 274                 p.drawPixmap(point, *pixmap);
 275
 276                 break;
 277         }
 278 }
 279
 280 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
 281         vector< pair<int64_t, bool> > &edges, bool level,
 282         double samples_per_pixel, double pixels_offset, float x_offset,
 283         float y_offset)
 284 {
 285         QLineF *line = lines;
 286
 287         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
 288                 if ((*i).second == level) {
 289                         *line++ = QLineF(
 290                                 ((*i).first / samples_per_pixel -
 291                                         pixels_offset) + x_offset, y_offset,
 292                                 ((*(i+1)).first / samples_per_pixel -
 293                                         pixels_offset) + x_offset, y_offset);
 294                 }
 295
 296         p.drawLines(lines, line - lines);
 297 }
 298
 299 void LogicSignal::init_trigger_actions(QWidget *parent)
 300 {
 301         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
 302                 tr("No trigger"), parent);
 303         trigger_none_->setCheckable(true);
 304         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 305
 306         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
 307                 tr("Trigger on rising edge"), parent);
 308         trigger_rising_->setCheckable(true);
 309         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 310
 311         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
 312                 tr("Trigger on high level"), parent);
 313         trigger_high_->setCheckable(true);
 314         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 315
 316         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
 317                 tr("Trigger on falling edge"), parent);
 318         trigger_falling_->setCheckable(true);
 319         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 320
 321         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
 322                 tr("Trigger on low level"), parent);
 323         trigger_low_->setCheckable(true);
 324         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 325
 326         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
 327                 tr("Trigger on rising or falling edge"), parent);
 328         trigger_change_->setCheckable(true);
 329         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 330 }
 331
 332 const vector<int32_t> LogicSignal::get_trigger_types() const
 333 {
 334         const auto sr_dev = device_->device();
 335         const auto keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
 336         const auto iter = keys.find(ConfigKey::TRIGGER_MATCH);
 337         if (iter != keys.end() &&
 338                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 339                 try {
 340                         const Glib::VariantContainerBase gvar =
 341                                 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
 342                         return Glib::VariantBase::cast_dynamic<
 343                                 Glib::Variant<vector<int32_t>>>(gvar).get();
 344                 } catch (Error e) {
 345                         // Failed to enumerate triggers
 346                         (void)e;
 347                 }
 348         }
 349
 350         return vector<int32_t>();
 351 }
 352
 353 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
 354 {
 355         QAction *action;
 356
 357         action = trigger_none_;
 358         if (type) {
 359                 switch (type->id()) {
 360                 case SR_TRIGGER_ZERO:
 361                         action = trigger_low_;
 362                         break;
 363                 case SR_TRIGGER_ONE:
 364                         action = trigger_high_;
 365                         break;
 366                 case SR_TRIGGER_RISING:
 367                         action = trigger_rising_;
 368                         break;
 369                 case SR_TRIGGER_FALLING:
 370                         action = trigger_falling_;
 371                         break;
 372                 case SR_TRIGGER_EDGE:
 373                         action = trigger_change_;
 374                         break;
 375                 default:
 376                         assert(0);
 377                 }
 378         }
 379
 380         return action;
 381 }
 382
 383 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
 384 {
 385         if (action == trigger_low_)
 386                 return TriggerMatchType::ZERO;
 387         else if (action == trigger_high_)
 388                 return TriggerMatchType::ONE;
 389         else if (action == trigger_rising_)
 390                 return TriggerMatchType::RISING;
 391         else if (action == trigger_falling_)
 392                 return TriggerMatchType::FALLING;
 393         else if (action == trigger_change_)
 394                 return TriggerMatchType::EDGE;
 395         else
 396                 return nullptr;
 397 }
 398
 399 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 400 {
 401         Signal::populate_popup_form(parent, form);
 402
 403         const vector<int32_t> trig_types = get_trigger_types();
 404
 405         if (!trig_types.empty()) {
 406                 trigger_bar_ = new QToolBar(parent);
 407                 init_trigger_actions(trigger_bar_);
 408                 trigger_bar_->addAction(trigger_none_);
 409                 trigger_none_->setChecked(!trigger_match_);
 410
 411                 for (auto type_id : trig_types) {
 412                         const TriggerMatchType *const type =
 413                                 TriggerMatchType::get(type_id);
 414                         QAction *const action = action_from_trigger_type(type);
 415                         trigger_bar_->addAction(action);
 416                         action->setChecked(trigger_match_ == type);
 417                 }
 418                 form->addRow(tr("Trigger"), trigger_bar_);
 419         }
 420 }
 421
 422 void LogicSignal::modify_trigger()
 423 {
 424         auto trigger = session_.session()->trigger();
 425         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
 426
 427         if (trigger) {
 428                 for (auto stage : trigger->stages()) {
 429                         const auto &matches = stage->matches();
 430                         if (std::none_of(matches.begin(), matches.end(),
 431                             [&](shared_ptr<TriggerMatch> match) {
 432                                         return match->channel() != channel_; }))
 433                                 continue;
 434
 435                         auto new_stage = new_trigger->add_stage();
 436                         for (auto match : stage->matches()) {
 437                                 if (match->channel() == channel_)
 438                                         continue;
 439                                 new_stage->add_match(match->channel(), match->type());
 440                         }
 441                 }
 442         }
 443
 444         if (trigger_match_) {
 445                 // Until we can let the user decide how to group trigger matches
 446                 // into stages, put all of the matches into a single stage --
 447                 // most devices only support a single trigger stage.
 448                 if (new_trigger->stages().empty())
 449                         new_trigger->add_stage();
 450
 451                 new_trigger->stages().back()->add_match(channel_, trigger_match_);
 452         }
 453
 454         session_.session()->set_trigger(
 455                 new_trigger->stages().empty() ? nullptr : new_trigger);
 456
 457         if (owner_)
 458                 owner_->row_item_appearance_changed(false, true);
 459 }
 460
 461 const QIcon* LogicSignal::get_icon(const char *path)
 462 {
 463         const QIcon *icon = icon_cache_.take(path);
 464         if (!icon) {
 465                 icon = new QIcon(path);
 466                 icon_cache_.insert(path, icon);
 467         }
 468
 469         return icon;
 470 }
 471
 472 const QPixmap* LogicSignal::get_pixmap(const char *path)
 473 {
 474         const QPixmap *pixmap = pixmap_cache_.take(path);
 475         if (!pixmap) {
 476                 pixmap = new QPixmap(path);
 477                 pixmap_cache_.insert(path, pixmap);
 478         }
 479
 480         return pixmap;
 481 }
 482
 483 void LogicSignal::on_trigger()
 484 {
 485         QAction *action;
 486
 487         action_from_trigger_type(trigger_match_)->setChecked(false);
 488
 489         action = (QAction *)sender();
 490         action->setChecked(true);
 491         trigger_match_ = trigger_type_from_action(action);
 492
 493         modify_trigger();
 494 }
 495
 496 } // namespace view
 497 } // namespace pv