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 int LogicSignal::SignalHeight = 30;
  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         const int signal_margin =
 151                 QFontMetrics(QApplication::font()).height() / 2;
 152         return make_pair(-SignalHeight - signal_margin, signal_margin);
 153 }
 154
 155 int LogicSignal::scale_handle_offset() const
 156 {
 157         return SignalHeight;
 158 }
 159
 160 void LogicSignal::scale_handle_dragged(int offset)
 161 {
 162         (void)offset;
 163 }
 164
 165 void LogicSignal::paint_back(QPainter &p, const ViewItemPaintParams &pp)
 166 {
 167         if (channel_->enabled())
 168                 paint_axis(p, pp, get_visual_y());
 169 }
 170
 171 void LogicSignal::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
 172 {
 173         QLineF *line;
 174
 175         vector< pair<int64_t, bool> > edges;
 176
 177         assert(channel_);
 178         assert(data_);
 179         assert(owner_);
 180
 181         const int y = get_visual_y();
 182
 183         if (!channel_->enabled())
 184                 return;
 185
 186         const float high_offset = y - SignalHeight + 0.5f;
 187         const float low_offset = y + 0.5f;
 188
 189         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
 190                 data_->logic_segments();
 191         if (segments.empty())
 192                 return;
 193
 194         const shared_ptr<pv::data::LogicSegment> &segment =
 195                 segments.front();
 196
 197         double samplerate = segment->samplerate();
 198
 199         // Show sample rate as 1Hz when it is unknown
 200         if (samplerate == 0.0)
 201                 samplerate = 1.0;
 202
 203         const double pixels_offset = pp.pixels_offset();
 204         const pv::util::Timestamp& start_time = segment->start_time();
 205         const int64_t last_sample = segment->get_sample_count() - 1;
 206         const double samples_per_pixel = samplerate * pp.scale();
 207         const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
 208         const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
 209
 210         const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
 211                 (int64_t)0), last_sample);
 212         const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
 213                 (int64_t)0), last_sample);
 214
 215         segment->get_subsampled_edges(edges, start_sample, end_sample,
 216                 samples_per_pixel / Oversampling, channel_->index());
 217         assert(edges.size() >= 2);
 218
 219         // Paint the edges
 220         const unsigned int edge_count = edges.size() - 2;
 221         QLineF *const edge_lines = new QLineF[edge_count];
 222         line = edge_lines;
 223
 224         for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
 225                 const float x = ((*i).first / samples_per_pixel -
 226                         pixels_offset) + pp.left();
 227                 *line++ = QLineF(x, high_offset, x, low_offset);
 228         }
 229
 230         p.setPen(EdgeColour);
 231         p.drawLines(edge_lines, edge_count);
 232         delete[] edge_lines;
 233
 234         // Paint the caps
 235         const unsigned int max_cap_line_count = edges.size();
 236         QLineF *const cap_lines = new QLineF[max_cap_line_count];
 237
 238         p.setPen(HighColour);
 239         paint_caps(p, cap_lines, edges, true, samples_per_pixel,
 240                 pixels_offset, pp.left(), high_offset);
 241         p.setPen(LowColour);
 242         paint_caps(p, cap_lines, edges, false, samples_per_pixel,
 243                 pixels_offset, pp.left(), low_offset);
 244
 245         delete[] cap_lines;
 246 }
 247
 248 void LogicSignal::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
 249 {
 250         // Draw the trigger marker
 251         if (!trigger_match_)
 252                 return;
 253
 254         const int y = get_visual_y();
 255         const vector<int32_t> trig_types = get_trigger_types();
 256         for (int32_t type_id : trig_types) {
 257                 const TriggerMatchType *const type =
 258                         TriggerMatchType::get(type_id);
 259                 if (trigger_match_ != type || type_id < 0 ||
 260                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
 261                         !TriggerMarkerIcons[type_id])
 262                         continue;
 263
 264                 const QPixmap *const pixmap = get_pixmap(
 265                         TriggerMarkerIcons[type_id]);
 266                 if (!pixmap)
 267                         continue;
 268
 269                 const float pad = TriggerMarkerPadding - 0.5f;
 270                 const QSize size = pixmap->size();
 271                 const QPoint point(
 272                         pp.right() - size.width() - pad * 2,
 273                         y - (SignalHeight + size.height()) / 2);
 274
 275                 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
 276                 p.setBrush(TriggerMarkerBackgroundColour);
 277                 p.drawRoundedRect(QRectF(point, size).adjusted(
 278                         -pad, -pad, pad, pad), pad, pad);
 279                 p.drawPixmap(point, *pixmap);
 280
 281                 break;
 282         }
 283 }
 284
 285 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
 286         vector< pair<int64_t, bool> > &edges, bool level,
 287         double samples_per_pixel, double pixels_offset, float x_offset,
 288         float y_offset)
 289 {
 290         QLineF *line = lines;
 291
 292         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
 293                 if ((*i).second == level) {
 294                         *line++ = QLineF(
 295                                 ((*i).first / samples_per_pixel -
 296                                         pixels_offset) + x_offset, y_offset,
 297                                 ((*(i+1)).first / samples_per_pixel -
 298                                         pixels_offset) + x_offset, y_offset);
 299                 }
 300
 301         p.drawLines(lines, line - lines);
 302 }
 303
 304 void LogicSignal::init_trigger_actions(QWidget *parent)
 305 {
 306         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
 307                 tr("No trigger"), parent);
 308         trigger_none_->setCheckable(true);
 309         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 310
 311         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
 312                 tr("Trigger on rising edge"), parent);
 313         trigger_rising_->setCheckable(true);
 314         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 315
 316         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
 317                 tr("Trigger on high level"), parent);
 318         trigger_high_->setCheckable(true);
 319         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 320
 321         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
 322                 tr("Trigger on falling edge"), parent);
 323         trigger_falling_->setCheckable(true);
 324         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 325
 326         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
 327                 tr("Trigger on low level"), parent);
 328         trigger_low_->setCheckable(true);
 329         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 330
 331         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
 332                 tr("Trigger on rising or falling edge"), parent);
 333         trigger_change_->setCheckable(true);
 334         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 335 }
 336
 337 const vector<int32_t> LogicSignal::get_trigger_types() const
 338 {
 339         const auto sr_dev = device_->device();
 340         const auto keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
 341         const auto iter = keys.find(ConfigKey::TRIGGER_MATCH);
 342         if (iter != keys.end() &&
 343                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 344                 try {
 345                         const Glib::VariantContainerBase gvar =
 346                                 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
 347                         return Glib::VariantBase::cast_dynamic<
 348                                 Glib::Variant<vector<int32_t>>>(gvar).get();
 349                 } catch (Error e) {
 350                         // Failed to enumerate triggers
 351                         (void)e;
 352                 }
 353         }
 354
 355         return vector<int32_t>();
 356 }
 357
 358 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
 359 {
 360         QAction *action;
 361
 362         action = trigger_none_;
 363         if (type) {
 364                 switch (type->id()) {
 365                 case SR_TRIGGER_ZERO:
 366                         action = trigger_low_;
 367                         break;
 368                 case SR_TRIGGER_ONE:
 369                         action = trigger_high_;
 370                         break;
 371                 case SR_TRIGGER_RISING:
 372                         action = trigger_rising_;
 373                         break;
 374                 case SR_TRIGGER_FALLING:
 375                         action = trigger_falling_;
 376                         break;
 377                 case SR_TRIGGER_EDGE:
 378                         action = trigger_change_;
 379                         break;
 380                 default:
 381                         assert(0);
 382                 }
 383         }
 384
 385         return action;
 386 }
 387
 388 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
 389 {
 390         if (action == trigger_low_)
 391                 return TriggerMatchType::ZERO;
 392         else if (action == trigger_high_)
 393                 return TriggerMatchType::ONE;
 394         else if (action == trigger_rising_)
 395                 return TriggerMatchType::RISING;
 396         else if (action == trigger_falling_)
 397                 return TriggerMatchType::FALLING;
 398         else if (action == trigger_change_)
 399                 return TriggerMatchType::EDGE;
 400         else
 401                 return nullptr;
 402 }
 403
 404 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 405 {
 406         Signal::populate_popup_form(parent, form);
 407
 408         const vector<int32_t> trig_types = get_trigger_types();
 409
 410         if (!trig_types.empty()) {
 411                 trigger_bar_ = new QToolBar(parent);
 412                 init_trigger_actions(trigger_bar_);
 413                 trigger_bar_->addAction(trigger_none_);
 414                 trigger_none_->setChecked(!trigger_match_);
 415
 416                 for (auto type_id : trig_types) {
 417                         const TriggerMatchType *const type =
 418                                 TriggerMatchType::get(type_id);
 419                         QAction *const action = action_from_trigger_type(type);
 420                         trigger_bar_->addAction(action);
 421                         action->setChecked(trigger_match_ == type);
 422                 }
 423                 form->addRow(tr("Trigger"), trigger_bar_);
 424         }
 425 }
 426
 427 void LogicSignal::modify_trigger()
 428 {
 429         auto trigger = session_.session()->trigger();
 430         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
 431
 432         if (trigger) {
 433                 for (auto stage : trigger->stages()) {
 434                         const auto &matches = stage->matches();
 435                         if (std::none_of(matches.begin(), matches.end(),
 436                             [&](shared_ptr<TriggerMatch> match) {
 437                                         return match->channel() != channel_; }))
 438                                 continue;
 439
 440                         auto new_stage = new_trigger->add_stage();
 441                         for (auto match : stage->matches()) {
 442                                 if (match->channel() == channel_)
 443                                         continue;
 444                                 new_stage->add_match(match->channel(), match->type());
 445                         }
 446                 }
 447         }
 448
 449         if (trigger_match_)
 450                 new_trigger->add_stage()->add_match(channel_, trigger_match_);
 451
 452         session_.session()->set_trigger(
 453                 new_trigger->stages().empty() ? nullptr : new_trigger);
 454
 455         if (owner_)
 456                 owner_->row_item_appearance_changed(false, true);
 457 }
 458
 459 const QIcon* LogicSignal::get_icon(const char *path)
 460 {
 461         const QIcon *icon = icon_cache_.take(path);
 462         if (!icon) {
 463                 icon = new QIcon(path);
 464                 icon_cache_.insert(path, icon);
 465         }
 466
 467         return icon;
 468 }
 469
 470 const QPixmap* LogicSignal::get_pixmap(const char *path)
 471 {
 472         const QPixmap *pixmap = pixmap_cache_.take(path);
 473         if (!pixmap) {
 474                 pixmap = new QPixmap(path);
 475                 pixmap_cache_.insert(path, pixmap);
 476         }
 477
 478         return pixmap;
 479 }
 480
 481 void LogicSignal::on_trigger()
 482 {
 483         QAction *action;
 484
 485         action_from_trigger_type(trigger_match_)->setChecked(false);
 486
 487         action = (QAction *)sender();
 488         action->setChecked(true);
 489         trigger_match_ = trigger_type_from_action(action);
 490
 491         modify_trigger();
 492 }
 493
 494 } // namespace view
 495 } // namespace pv