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