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/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/data/signalbase.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::ConfigKey;
  53 using sigrok::Capability;
  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 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 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         // Paint the sampling points
 233         const uint64_t sampling_points_count = end_sample - start_sample + 1;
 234         QRectF *const sampling_points = new QRectF[sampling_points_count];
 235         QRectF *sampling_point = sampling_points;
 236
 237         const int w = 1;
 238         const float y_middle = high_offset - ((high_offset - low_offset) / 2);
 239         for (uint64_t i = start_sample; i < end_sample + 1; ++i) {
 240                 const float x = (i / samples_per_pixel - pixels_offset) + pp.left();
 241                 *sampling_point++ = QRectF(x - (w / 2), y_middle - (w / 2), w, w);
 242         }
 243
 244         p.setPen(SamplingPointColour);
 245         p.drawRects(sampling_points, sampling_points_count);
 246         delete[] sampling_points;
 247 }
 248
 249 void LogicSignal::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
 250 {
 251         // Draw the trigger marker
 252         if (!trigger_match_ || !base_->enabled())
 253                 return;
 254
 255         const int y = get_visual_y();
 256         const vector<int32_t> trig_types = get_trigger_types();
 257         for (int32_t type_id : trig_types) {
 258                 const TriggerMatchType *const type =
 259                         TriggerMatchType::get(type_id);
 260                 if (trigger_match_ != type || type_id < 0 ||
 261                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
 262                         !TriggerMarkerIcons[type_id])
 263                         continue;
 264
 265                 const QPixmap *const pixmap = get_pixmap(
 266                         TriggerMarkerIcons[type_id]);
 267                 if (!pixmap)
 268                         continue;
 269
 270                 const float pad = TriggerMarkerPadding - 0.5f;
 271                 const QSize size = pixmap->size();
 272                 const QPoint point(
 273                         pp.right() - size.width() - pad * 2,
 274                         y - (signal_height_ + size.height()) / 2);
 275
 276                 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
 277                 p.setBrush(TriggerMarkerBackgroundColour);
 278                 p.drawRoundedRect(QRectF(point, size).adjusted(
 279                         -pad, -pad, pad, pad), pad, pad);
 280                 p.drawPixmap(point, *pixmap);
 281
 282                 break;
 283         }
 284 }
 285
 286 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
 287         vector< pair<int64_t, bool> > &edges, bool level,
 288         double samples_per_pixel, double pixels_offset, float x_offset,
 289         float y_offset)
 290 {
 291         QLineF *line = lines;
 292
 293         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
 294                 if ((*i).second == level) {
 295                         *line++ = QLineF(
 296                                 ((*i).first / samples_per_pixel -
 297                                         pixels_offset) + x_offset, y_offset,
 298                                 ((*(i+1)).first / samples_per_pixel -
 299                                         pixels_offset) + x_offset, y_offset);
 300                 }
 301
 302         p.drawLines(lines, line - lines);
 303 }
 304
 305 void LogicSignal::init_trigger_actions(QWidget *parent)
 306 {
 307         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
 308                 tr("No trigger"), parent);
 309         trigger_none_->setCheckable(true);
 310         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 311
 312         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
 313                 tr("Trigger on rising edge"), parent);
 314         trigger_rising_->setCheckable(true);
 315         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 316
 317         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
 318                 tr("Trigger on high level"), parent);
 319         trigger_high_->setCheckable(true);
 320         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 321
 322         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
 323                 tr("Trigger on falling edge"), parent);
 324         trigger_falling_->setCheckable(true);
 325         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 326
 327         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
 328                 tr("Trigger on low level"), parent);
 329         trigger_low_->setCheckable(true);
 330         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 331
 332         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
 333                 tr("Trigger on rising or falling edge"), parent);
 334         trigger_change_->setCheckable(true);
 335         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
 336 }
 337
 338 const vector<int32_t> LogicSignal::get_trigger_types() const
 339 {
 340         const auto sr_dev = device_->device();
 341         if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
 342                 const Glib::VariantContainerBase gvar =
 343                         sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
 344
 345                 vector<int32_t> ttypes;
 346
 347                 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
 348                         Glib::VariantBase tmp_vb;
 349                         gvar.get_child(tmp_vb, i);
 350
 351                         Glib::Variant<int32_t> tmp_v =
 352                                 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
 353
 354                         ttypes.push_back(tmp_v.get());
 355                 }
 356
 357                 return ttypes;
 358         } else {
 359                 return vector<int32_t>();
 360         }
 361 }
 362
 363 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
 364 {
 365         QAction *action;
 366
 367         action = trigger_none_;
 368         if (type) {
 369                 switch (type->id()) {
 370                 case SR_TRIGGER_ZERO:
 371                         action = trigger_low_;
 372                         break;
 373                 case SR_TRIGGER_ONE:
 374                         action = trigger_high_;
 375                         break;
 376                 case SR_TRIGGER_RISING:
 377                         action = trigger_rising_;
 378                         break;
 379                 case SR_TRIGGER_FALLING:
 380                         action = trigger_falling_;
 381                         break;
 382                 case SR_TRIGGER_EDGE:
 383                         action = trigger_change_;
 384                         break;
 385                 default:
 386                         assert(0);
 387                 }
 388         }
 389
 390         return action;
 391 }
 392
 393 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
 394 {
 395         if (action == trigger_low_)
 396                 return TriggerMatchType::ZERO;
 397         else if (action == trigger_high_)
 398                 return TriggerMatchType::ONE;
 399         else if (action == trigger_rising_)
 400                 return TriggerMatchType::RISING;
 401         else if (action == trigger_falling_)
 402                 return TriggerMatchType::FALLING;
 403         else if (action == trigger_change_)
 404                 return TriggerMatchType::EDGE;
 405         else
 406                 return nullptr;
 407 }
 408
 409 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 410 {
 411         Signal::populate_popup_form(parent, form);
 412
 413         const vector<int32_t> trig_types = get_trigger_types();
 414
 415         if (!trig_types.empty()) {
 416                 trigger_bar_ = new QToolBar(parent);
 417                 init_trigger_actions(trigger_bar_);
 418                 trigger_bar_->addAction(trigger_none_);
 419                 trigger_none_->setChecked(!trigger_match_);
 420
 421                 for (auto type_id : trig_types) {
 422                         const TriggerMatchType *const type =
 423                                 TriggerMatchType::get(type_id);
 424                         QAction *const action = action_from_trigger_type(type);
 425                         trigger_bar_->addAction(action);
 426                         action->setChecked(trigger_match_ == type);
 427                 }
 428                 form->addRow(tr("Trigger"), trigger_bar_);
 429         }
 430 }
 431
 432 void LogicSignal::modify_trigger()
 433 {
 434         auto trigger = session_.session()->trigger();
 435         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
 436
 437         if (trigger) {
 438                 for (auto stage : trigger->stages()) {
 439                         const auto &matches = stage->matches();
 440                         if (std::none_of(matches.begin(), matches.end(),
 441                             [&](shared_ptr<TriggerMatch> match) {
 442                                         return match->channel() != base_->channel(); }))
 443                                 continue;
 444
 445                         auto new_stage = new_trigger->add_stage();
 446                         for (auto match : stage->matches()) {
 447                                 if (match->channel() == base_->channel())
 448                                         continue;
 449                                 new_stage->add_match(match->channel(), match->type());
 450                         }
 451                 }
 452         }
 453
 454         if (trigger_match_) {
 455                 // Until we can let the user decide how to group trigger matches
 456                 // into stages, put all of the matches into a single stage --
 457                 // most devices only support a single trigger stage.
 458                 if (new_trigger->stages().empty())
 459                         new_trigger->add_stage();
 460
 461                 new_trigger->stages().back()->add_match(base_->channel(),
 462                         trigger_match_);
 463         }
 464
 465         session_.session()->set_trigger(
 466                 new_trigger->stages().empty() ? nullptr : new_trigger);
 467
 468         if (owner_)
 469                 owner_->row_item_appearance_changed(false, true);
 470 }
 471
 472 const QIcon* LogicSignal::get_icon(const char *path)
 473 {
 474         if (!icon_cache_.contains(path)) {
 475                 const QIcon *icon = new QIcon(path);
 476                 icon_cache_.insert(path, icon);
 477         }
 478
 479         return icon_cache_.take(path);
 480 }
 481
 482 const QPixmap* LogicSignal::get_pixmap(const char *path)
 483 {
 484         if (!pixmap_cache_.contains(path)) {
 485                 const QPixmap *pixmap = new QPixmap(path);
 486                 pixmap_cache_.insert(path, pixmap);
 487         }
 488
 489         return pixmap_cache_.take(path);
 490 }
 491
 492 void LogicSignal::on_trigger()
 493 {
 494         QAction *action;
 495
 496         action_from_trigger_type(trigger_match_)->setChecked(false);
 497
 498         action = (QAction *)sender();
 499         action->setChecked(true);
 500         trigger_match_ = trigger_type_from_action(action);
 501
 502         modify_trigger();
 503 }
 504
 505 } // namespace TraceView
 506 } // namespace views
 507 } // namespace pv