2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
27 #include <QApplication>
28 #include <QFormLayout>
31 #include "logicsignal.hpp"
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>
42 #include <libsigrokcxx/libsigrokcxx.hpp>
49 using std::out_of_range;
51 using std::shared_ptr;
54 using sigrok::ConfigKey;
55 using sigrok::Capability;
56 using sigrok::Trigger;
57 using sigrok::TriggerMatch;
58 using sigrok::TriggerMatchType;
60 using pv::data::LogicSegment;
66 const float LogicSignal::Oversampling = 2.0f;
68 const QColor LogicSignal::EdgeColor(0x80, 0x80, 0x80);
69 const QColor LogicSignal::HighColor(0x00, 0xC0, 0x00);
70 const QColor LogicSignal::LowColor(0xC0, 0x00, 0x00);
71 const QColor LogicSignal::SamplingPointColor(0x77, 0x77, 0x77);
73 const QColor LogicSignal::SignalColors[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
86 QColor LogicSignal::TriggerMarkerBackgroundColor = QColor(0xED, 0xD4, 0x00);
87 const int LogicSignal::TriggerMarkerPadding = 2;
88 const char* LogicSignal::TriggerMarkerIcons[8] = {
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",
99 QCache<QString, const QIcon> LogicSignal::icon_cache_;
100 QCache<QString, const QPixmap> LogicSignal::pixmap_cache_;
102 LogicSignal::LogicSignal(
103 pv::Session &session,
104 shared_ptr<devices::Device> device,
105 shared_ptr<data::SignalBase> base) :
106 Signal(session, base),
108 trigger_types_(get_trigger_types()),
109 trigger_none_(nullptr),
110 trigger_rising_(nullptr),
111 trigger_high_(nullptr),
112 trigger_falling_(nullptr),
113 trigger_low_(nullptr),
114 trigger_change_(nullptr)
116 shared_ptr<Trigger> trigger;
118 base_->set_color(SignalColors[base->index() % countof(SignalColors)]);
121 signal_height_ = gs.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
123 /* Populate this channel's trigger setting with whatever we
124 * find in the current session trigger, if anything. */
125 trigger_match_ = nullptr;
126 if ((trigger = session_.session()->trigger()))
127 for (auto stage : trigger->stages())
128 for (auto match : stage->matches())
129 if (match->channel() == base_->channel())
130 trigger_match_ = match->type();
133 shared_ptr<pv::data::SignalData> LogicSignal::data() const
135 return base_->logic_data();
138 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
140 return base_->logic_data();
143 void LogicSignal::save_settings(QSettings &settings) const
145 settings.setValue("trace_height", signal_height_);
148 void LogicSignal::restore_settings(QSettings &settings)
150 if (settings.contains("trace_height")) {
151 const int old_height = signal_height_;
152 signal_height_ = settings.value("trace_height").toInt();
154 if ((signal_height_ != old_height) && owner_) {
155 // Call order is important, otherwise the lazy event handler won't work
156 owner_->extents_changed(false, true);
157 owner_->row_item_appearance_changed(false, true);
162 pair<int, int> LogicSignal::v_extents() const
164 const int signal_margin =
165 QFontMetrics(QApplication::font()).height() / 2;
166 return make_pair(-signal_height_ - signal_margin, signal_margin);
169 void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
173 vector< pair<int64_t, bool> > edges;
178 const int y = get_visual_y();
180 if (!base_->enabled())
183 const float low_offset = y + 0.5f;
184 const float high_offset = low_offset - signal_height_;
186 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
187 if (!segment || (segment->get_sample_count() == 0))
190 double samplerate = segment->samplerate();
192 // Show sample rate as 1Hz when it is unknown
193 if (samplerate == 0.0)
196 const double pixels_offset = pp.pixels_offset();
197 const pv::util::Timestamp& start_time = segment->start_time();
198 const int64_t last_sample = (int64_t)segment->get_sample_count() - 1;
199 const double samples_per_pixel = samplerate * pp.scale();
200 const double pixels_per_sample = 1 / samples_per_pixel;
201 const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
202 const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
204 const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
205 (int64_t)0), last_sample);
206 const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
207 (int64_t)0), last_sample);
209 segment->get_subsampled_edges(edges, start_sample, end_sample,
210 samples_per_pixel / Oversampling, base_->index());
211 assert(edges.size() >= 2);
213 const float first_sample_x =
214 pp.left() + (edges.front().first / samples_per_pixel - pixels_offset);
215 const float last_sample_x =
216 pp.left() + (edges.back().first / samples_per_pixel - pixels_offset);
218 // Check whether we need to paint the sampling points
219 GlobalSettings settings;
220 const bool show_sampling_points =
221 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool() &&
222 (samples_per_pixel < 0.25);
224 vector<QRectF> sampling_points;
225 float sampling_point_x = first_sample_x;
226 int64_t sampling_point_sample = start_sample;
229 if (show_sampling_points)
230 sampling_points.reserve(end_sample - start_sample + 1);
232 // Check whether we need to fill the high areas
233 const bool fill_high_areas =
234 settings.value(GlobalSettings::Key_View_FillSignalHighAreas).toBool();
236 vector<QRectF> high_rects;
239 const unsigned int edge_count = edges.size() - 2;
240 QLineF *const edge_lines = new QLineF[edge_count];
243 if (edges.front().second)
244 high_start_x = first_sample_x; // Beginning of signal is high
246 for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
247 const float x = ((*i).first / samples_per_pixel -
248 pixels_offset) + pp.left();
249 *line++ = QLineF(x, high_offset, x, low_offset);
251 if (fill_high_areas) {
255 high_rects.emplace_back(high_start_x, high_offset,
256 x - high_start_x, signal_height_);
259 if (show_sampling_points)
260 while (sampling_point_sample < (*i).first) {
261 const float y = (*i).second ? low_offset : high_offset;
262 sampling_points.emplace_back(
263 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
264 sampling_point_sample++;
265 sampling_point_x += pixels_per_sample;
269 // Calculate the sample points from the last edge to the end of the trace
270 if (show_sampling_points)
271 while ((uint64_t)sampling_point_sample <= end_sample) {
272 // Signal changed after the last edge, so the level is inverted
273 const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
274 sampling_points.emplace_back(
275 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
276 sampling_point_sample++;
277 sampling_point_x += pixels_per_sample;
280 if (fill_high_areas) {
281 // Add last high rectangle if the signal is still high at the end of the view
282 if ((edges.cend() - 1)->second)
283 high_rects.emplace_back(high_start_x, high_offset,
284 last_sample_x - high_start_x, signal_height_);
286 const QColor fill_color = QColor::fromRgba(settings.value(
287 GlobalSettings::Key_View_FillSignalHighAreaColor).value<uint32_t>());
288 p.setPen(fill_color);
289 p.setBrush(fill_color);
290 p.drawRects((const QRectF*)(high_rects.data()), high_rects.size());
294 p.drawLines(edge_lines, edge_count);
298 const unsigned int max_cap_line_count = edges.size();
299 QLineF *const cap_lines = new QLineF[max_cap_line_count];
302 paint_caps(p, cap_lines, edges, true, samples_per_pixel,
303 pixels_offset, pp.left(), high_offset);
305 paint_caps(p, cap_lines, edges, false, samples_per_pixel,
306 pixels_offset, pp.left(), low_offset);
310 // Paint the sampling points
311 if (show_sampling_points) {
312 p.setPen(SamplingPointColor);
313 p.drawRects(sampling_points.data(), sampling_points.size());
317 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
319 if (base_->enabled()) {
320 if (trigger_match_) {
321 // Draw the trigger marker
322 const int y = get_visual_y();
324 for (int32_t type_id : trigger_types_) {
325 const TriggerMatchType *const type =
326 TriggerMatchType::get(type_id);
327 if (trigger_match_ != type || type_id < 0 ||
328 (size_t)type_id >= countof(TriggerMarkerIcons) ||
329 !TriggerMarkerIcons[type_id])
332 const QPixmap *const pixmap = get_pixmap(
333 TriggerMarkerIcons[type_id]);
337 const float pad = TriggerMarkerPadding - 0.5f;
338 const QSize size = pixmap->size();
340 pp.right() - size.width() - pad * 2,
341 y - (signal_height_ + size.height()) / 2);
343 p.setPen(QPen(TriggerMarkerBackgroundColor.darker()));
344 p.setBrush(TriggerMarkerBackgroundColor);
345 p.drawRoundedRect(QRectF(point, size).adjusted(
346 -pad, -pad, pad, pad), pad, pad);
347 p.drawPixmap(point, *pixmap);
353 if (show_hover_marker_)
354 paint_hover_marker(p);
358 vector<LogicSegment::EdgePair> LogicSignal::get_nearest_level_changes(uint64_t sample_pos)
364 return vector<LogicSegment::EdgePair>();
366 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
367 if (!segment || (segment->get_sample_count() == 0))
368 return vector<LogicSegment::EdgePair>();
370 const View *view = owner_->view();
372 const double samples_per_pixel = base_->get_samplerate() * view->scale();
374 vector<LogicSegment::EdgePair> edges;
376 segment->get_surrounding_edges(edges, sample_pos,
377 samples_per_pixel / Oversampling, base_->index());
380 return vector<LogicSegment::EdgePair>();
385 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
386 vector< pair<int64_t, bool> > &edges, bool level,
387 double samples_per_pixel, double pixels_offset, float x_offset,
390 QLineF *line = lines;
392 for (auto i = edges.begin(); i != (edges.end() - 1); i++)
393 if ((*i).second == level) {
395 ((*i).first / samples_per_pixel -
396 pixels_offset) + x_offset, y_offset,
397 ((*(i+1)).first / samples_per_pixel -
398 pixels_offset) + x_offset, y_offset);
401 p.drawLines(lines, line - lines);
404 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
406 shared_ptr<pv::data::LogicSegment> segment;
408 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
409 base_->logic_data()->logic_segments();
411 if (!segments.empty()) {
412 if (segment_display_mode_ == ShowLastSegmentOnly) {
413 segment = segments.back();
416 if ((segment_display_mode_ == ShowSingleSegmentOnly) ||
417 (segment_display_mode_ == ShowLastCompleteSegmentOnly)) {
419 segment = segments.at(current_segment_);
420 } catch (out_of_range&) {
421 qDebug() << "Current logic segment out of range for signal" << base_->name() << ":" << current_segment_;
429 void LogicSignal::init_trigger_actions(QWidget *parent)
431 trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
432 tr("No trigger"), parent);
433 trigger_none_->setCheckable(true);
434 connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
436 trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
437 tr("Trigger on rising edge"), parent);
438 trigger_rising_->setCheckable(true);
439 connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
441 trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
442 tr("Trigger on high level"), parent);
443 trigger_high_->setCheckable(true);
444 connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
446 trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
447 tr("Trigger on falling edge"), parent);
448 trigger_falling_->setCheckable(true);
449 connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
451 trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
452 tr("Trigger on low level"), parent);
453 trigger_low_->setCheckable(true);
454 connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
456 trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
457 tr("Trigger on rising or falling edge"), parent);
458 trigger_change_->setCheckable(true);
459 connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
462 const vector<int32_t> LogicSignal::get_trigger_types() const
464 // We may not be associated with a device
466 return vector<int32_t>();
468 const auto sr_dev = device_->device();
469 if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
470 const Glib::VariantContainerBase gvar =
471 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
473 vector<int32_t> ttypes;
475 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
476 Glib::VariantBase tmp_vb;
477 gvar.get_child(tmp_vb, i);
479 Glib::Variant<int32_t> tmp_v =
480 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
482 ttypes.push_back(tmp_v.get());
487 return vector<int32_t>();
491 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
495 action = trigger_none_;
497 switch (type->id()) {
498 case SR_TRIGGER_ZERO:
499 action = trigger_low_;
502 action = trigger_high_;
504 case SR_TRIGGER_RISING:
505 action = trigger_rising_;
507 case SR_TRIGGER_FALLING:
508 action = trigger_falling_;
510 case SR_TRIGGER_EDGE:
511 action = trigger_change_;
521 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
523 if (action == trigger_low_)
524 return TriggerMatchType::ZERO;
525 else if (action == trigger_high_)
526 return TriggerMatchType::ONE;
527 else if (action == trigger_rising_)
528 return TriggerMatchType::RISING;
529 else if (action == trigger_falling_)
530 return TriggerMatchType::FALLING;
531 else if (action == trigger_change_)
532 return TriggerMatchType::EDGE;
537 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
539 Signal::populate_popup_form(parent, form);
541 signal_height_sb_ = new QSpinBox(parent);
542 signal_height_sb_->setRange(5, 1000);
543 signal_height_sb_->setSingleStep(5);
544 signal_height_sb_->setSuffix(tr(" pixels"));
545 signal_height_sb_->setValue(signal_height_);
546 connect(signal_height_sb_, SIGNAL(valueChanged(int)),
547 this, SLOT(on_signal_height_changed(int)));
548 form->addRow(tr("Trace height"), signal_height_sb_);
551 const vector<int32_t> trig_types = get_trigger_types();
553 if (!trig_types.empty()) {
554 trigger_bar_ = new QToolBar(parent);
555 init_trigger_actions(trigger_bar_);
556 trigger_bar_->addAction(trigger_none_);
557 trigger_none_->setChecked(!trigger_match_);
559 for (auto type_id : trig_types) {
560 const TriggerMatchType *const type =
561 TriggerMatchType::get(type_id);
562 QAction *const action = action_from_trigger_type(type);
563 trigger_bar_->addAction(action);
564 action->setChecked(trigger_match_ == type);
567 // Only allow triggers to be changed when we're stopped
568 if (session_.get_capture_state() != Session::Stopped)
569 for (QAction* action : trigger_bar_->findChildren<QAction*>())
570 action->setEnabled(false);
572 form->addRow(tr("Trigger"), trigger_bar_);
576 void LogicSignal::modify_trigger()
578 auto trigger = session_.session()->trigger();
579 auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
582 for (auto stage : trigger->stages()) {
583 const auto &matches = stage->matches();
584 if (none_of(matches.begin(), matches.end(),
585 [&](shared_ptr<TriggerMatch> match) {
586 return match->channel() != base_->channel(); }))
589 auto new_stage = new_trigger->add_stage();
590 for (auto match : stage->matches()) {
591 if (match->channel() == base_->channel())
593 new_stage->add_match(match->channel(), match->type());
598 if (trigger_match_) {
599 // Until we can let the user decide how to group trigger matches
600 // into stages, put all of the matches into a single stage --
601 // most devices only support a single trigger stage.
602 if (new_trigger->stages().empty())
603 new_trigger->add_stage();
605 new_trigger->stages().back()->add_match(base_->channel(),
609 session_.session()->set_trigger(
610 new_trigger->stages().empty() ? nullptr : new_trigger);
613 owner_->row_item_appearance_changed(false, true);
616 const QIcon* LogicSignal::get_icon(const char *path)
618 if (!icon_cache_.contains(path)) {
619 const QIcon *icon = new QIcon(path);
620 icon_cache_.insert(path, icon);
623 return icon_cache_.take(path);
626 const QPixmap* LogicSignal::get_pixmap(const char *path)
628 if (!pixmap_cache_.contains(path)) {
629 const QPixmap *pixmap = new QPixmap(path);
630 pixmap_cache_.insert(path, pixmap);
633 return pixmap_cache_.take(path);
636 void LogicSignal::on_trigger()
640 action_from_trigger_type(trigger_match_)->setChecked(false);
642 action = (QAction *)sender();
643 action->setChecked(true);
644 trigger_match_ = trigger_type_from_action(action);
649 void LogicSignal::on_signal_height_changed(int height)
651 signal_height_ = height;
654 // Call order is important, otherwise the lazy event handler won't work
655 owner_->extents_changed(false, true);
656 owner_->row_item_appearance_changed(false, true);