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