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/data/signalbase.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::pair;
  50 using std::shared_ptr;
  51 using std::vector;
  52
  53 using sigrok::ConfigKey;
  54 using sigrok::Capability;
  55 using sigrok::Error;
  56 using sigrok::Trigger;
  57 using sigrok::TriggerStage;
  58 using sigrok::TriggerMatch;
  59 using sigrok::TriggerMatchType;
  60
  61 namespace pv {
  62 namespace views {
  63 namespace TraceView {
  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<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 std::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, const 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 =
 180                 segments.front();
 181
 182         double samplerate = segment->samplerate();
 183
 184         // Show sample rate as 1Hz when it is unknown
 185         if (samplerate == 0.0)
 186                 samplerate = 1.0;
 187
 188         const double pixels_offset = pp.pixels_offset();
 189         const pv::util::Timestamp& start_time = segment->start_time();
 190         const int64_t last_sample = segment->get_sample_count() - 1;
 191         const double samples_per_pixel = samplerate * pp.scale();
 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         // 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_ || !base_->enabled())
 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 - (signal_height_ + 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         if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
 326                 const Glib::VariantContainerBase gvar =
 327                         sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
 328
 329                 vector<int32_t> ttypes;
 330
 331                 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
 332                         Glib::VariantBase tmp_vb;
 333                         gvar.get_child(tmp_vb, i);
 334
 335                         Glib::Variant<int32_t> tmp_v =
 336                                 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
 337
 338                         ttypes.push_back(tmp_v.get());
 339                 }
 340
 341                 return ttypes;
 342         } else {
 343                 return vector<int32_t>();
 344         }
 345 }
 346
 347 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
 348 {
 349         QAction *action;
 350
 351         action = trigger_none_;
 352         if (type) {
 353                 switch (type->id()) {
 354                 case SR_TRIGGER_ZERO:
 355                         action = trigger_low_;
 356                         break;
 357                 case SR_TRIGGER_ONE:
 358                         action = trigger_high_;
 359                         break;
 360                 case SR_TRIGGER_RISING:
 361                         action = trigger_rising_;
 362                         break;
 363                 case SR_TRIGGER_FALLING:
 364                         action = trigger_falling_;
 365                         break;
 366                 case SR_TRIGGER_EDGE:
 367                         action = trigger_change_;
 368                         break;
 369                 default:
 370                         assert(0);
 371                 }
 372         }
 373
 374         return action;
 375 }
 376
 377 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
 378 {
 379         if (action == trigger_low_)
 380                 return TriggerMatchType::ZERO;
 381         else if (action == trigger_high_)
 382                 return TriggerMatchType::ONE;
 383         else if (action == trigger_rising_)
 384                 return TriggerMatchType::RISING;
 385         else if (action == trigger_falling_)
 386                 return TriggerMatchType::FALLING;
 387         else if (action == trigger_change_)
 388                 return TriggerMatchType::EDGE;
 389         else
 390                 return nullptr;
 391 }
 392
 393 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 394 {
 395         Signal::populate_popup_form(parent, form);
 396
 397         const vector<int32_t> trig_types = get_trigger_types();
 398
 399         if (!trig_types.empty()) {
 400                 trigger_bar_ = new QToolBar(parent);
 401                 init_trigger_actions(trigger_bar_);
 402                 trigger_bar_->addAction(trigger_none_);
 403                 trigger_none_->setChecked(!trigger_match_);
 404
 405                 for (auto type_id : trig_types) {
 406                         const TriggerMatchType *const type =
 407                                 TriggerMatchType::get(type_id);
 408                         QAction *const action = action_from_trigger_type(type);
 409                         trigger_bar_->addAction(action);
 410                         action->setChecked(trigger_match_ == type);
 411                 }
 412                 form->addRow(tr("Trigger"), trigger_bar_);
 413         }
 414 }
 415
 416 void LogicSignal::modify_trigger()
 417 {
 418         auto trigger = session_.session()->trigger();
 419         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
 420
 421         if (trigger) {
 422                 for (auto stage : trigger->stages()) {
 423                         const auto &matches = stage->matches();
 424                         if (std::none_of(matches.begin(), matches.end(),
 425                             [&](shared_ptr<TriggerMatch> match) {
 426                                         return match->channel() != base_->channel(); }))
 427                                 continue;
 428
 429                         auto new_stage = new_trigger->add_stage();
 430                         for (auto match : stage->matches()) {
 431                                 if (match->channel() == base_->channel())
 432                                         continue;
 433                                 new_stage->add_match(match->channel(), match->type());
 434                         }
 435                 }
 436         }
 437
 438         if (trigger_match_) {
 439                 // Until we can let the user decide how to group trigger matches
 440                 // into stages, put all of the matches into a single stage --
 441                 // most devices only support a single trigger stage.
 442                 if (new_trigger->stages().empty())
 443                         new_trigger->add_stage();
 444
 445                 new_trigger->stages().back()->add_match(base_->channel(),
 446                         trigger_match_);
 447         }
 448
 449         session_.session()->set_trigger(
 450                 new_trigger->stages().empty() ? nullptr : new_trigger);
 451
 452         if (owner_)
 453                 owner_->row_item_appearance_changed(false, true);
 454 }
 455
 456 const QIcon* LogicSignal::get_icon(const char *path)
 457 {
 458         if (!icon_cache_.contains(path)) {
 459                 const QIcon *icon = new QIcon(path);
 460                 icon_cache_.insert(path, icon);
 461         }
 462
 463         return icon_cache_.take(path);
 464 }
 465
 466 const QPixmap* LogicSignal::get_pixmap(const char *path)
 467 {
 468         if (!pixmap_cache_.contains(path)) {
 469                 const QPixmap *pixmap = new QPixmap(path);
 470                 pixmap_cache_.insert(path, pixmap);
 471         }
 472
 473         return pixmap_cache_.take(path);
 474 }
 475
 476 void LogicSignal::on_trigger()
 477 {
 478         QAction *action;
 479
 480         action_from_trigger_type(trigger_match_)->setChecked(false);
 481
 482         action = (QAction *)sender();
 483         action->setChecked(true);
 484         trigger_match_ = trigger_type_from_action(action);
 485
 486         modify_trigger();
 487 }
 488
 489 } // namespace TraceView
 490 } // namespace views
 491 } // namespace pv