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