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();
235 vector<QRectF> high_rects;
237 bool rising_edge_seen = false;
240 const unsigned int edge_count = edges.size() - 2;
241 QLineF *const edge_lines = new QLineF[edge_count];
244 if (edges.front().second) {
245 // Beginning of trace is high
246 rising_edge_x = first_sample_x;
247 rising_edge_seen = true;
250 for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
251 // Note: multiple edges occupying a single pixel are represented by an edge
252 // with undefined logic level. This means that only the first falling edge
253 // after a rising edge corresponds to said rising edge - and vice versa. If
254 // more edges with the same logic level follow, they denote multiple edges.
256 const float x = pp.left() + ((*i).first / samples_per_pixel - pixels_offset);
257 *line++ = QLineF(x, high_offset, x, low_offset);
259 if (fill_high_areas) {
260 // Any edge terminates a high area
261 if (rising_edge_seen) {
262 const int width = x - rising_edge_x;
264 high_rects.emplace_back(rising_edge_x, high_offset,
265 width, signal_height_);
266 rising_edge_seen = false;
269 // Only rising edges start high areas
272 rising_edge_seen = true;
276 if (show_sampling_points)
277 while (sampling_point_sample < (*i).first) {
278 const float y = (*i).second ? low_offset : high_offset;
279 sampling_points.emplace_back(
280 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
281 sampling_point_sample++;
282 sampling_point_x += pixels_per_sample;
286 // Calculate the sample points from the last edge to the end of the trace
287 if (show_sampling_points)
288 while ((uint64_t)sampling_point_sample <= end_sample) {
289 // Signal changed after the last edge, so the level is inverted
290 const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
291 sampling_points.emplace_back(
292 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
293 sampling_point_sample++;
294 sampling_point_x += pixels_per_sample;
297 if (fill_high_areas) {
298 // Add last high rectangle if the signal is still high at the end of the trace
299 if (rising_edge_seen && (edges.cend() - 1)->second)
300 high_rects.emplace_back(rising_edge_x, high_offset,
301 last_sample_x - rising_edge_x, signal_height_);
303 const QColor fill_color = QColor::fromRgba(settings.value(
304 GlobalSettings::Key_View_FillSignalHighAreaColor).value<uint32_t>());
305 p.setPen(fill_color);
306 p.setBrush(fill_color);
307 p.drawRects((const QRectF*)(high_rects.data()), high_rects.size());
311 p.drawLines(edge_lines, edge_count);
315 const unsigned int max_cap_line_count = edges.size();
316 QLineF *const cap_lines = new QLineF[max_cap_line_count];
319 paint_caps(p, cap_lines, edges, true, samples_per_pixel,
320 pixels_offset, pp.left(), high_offset);
322 paint_caps(p, cap_lines, edges, false, samples_per_pixel,
323 pixels_offset, pp.left(), low_offset);
327 // Paint the sampling points
328 if (show_sampling_points) {
329 p.setPen(SamplingPointColor);
330 p.drawRects(sampling_points.data(), sampling_points.size());
334 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
336 if (base_->enabled()) {
337 if (trigger_match_) {
338 // Draw the trigger marker
339 const int y = get_visual_y();
341 for (int32_t type_id : trigger_types_) {
342 const TriggerMatchType *const type =
343 TriggerMatchType::get(type_id);
344 if (trigger_match_ != type || type_id < 0 ||
345 (size_t)type_id >= countof(TriggerMarkerIcons) ||
346 !TriggerMarkerIcons[type_id])
349 const QPixmap *const pixmap = get_pixmap(
350 TriggerMarkerIcons[type_id]);
354 const float pad = TriggerMarkerPadding - 0.5f;
355 const QSize size = pixmap->size();
357 pp.right() - size.width() - pad * 2,
358 y - (signal_height_ + size.height()) / 2);
360 p.setPen(QPen(TriggerMarkerBackgroundColor.darker()));
361 p.setBrush(TriggerMarkerBackgroundColor);
362 p.drawRoundedRect(QRectF(point, size).adjusted(
363 -pad, -pad, pad, pad), pad, pad);
364 p.drawPixmap(point, *pixmap);
370 if (show_hover_marker_)
371 paint_hover_marker(p);
375 vector<LogicSegment::EdgePair> LogicSignal::get_nearest_level_changes(uint64_t sample_pos)
381 return vector<LogicSegment::EdgePair>();
383 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
384 if (!segment || (segment->get_sample_count() == 0))
385 return vector<LogicSegment::EdgePair>();
387 const View *view = owner_->view();
389 const double samples_per_pixel = base_->get_samplerate() * view->scale();
391 vector<LogicSegment::EdgePair> edges;
393 segment->get_surrounding_edges(edges, sample_pos,
394 samples_per_pixel / Oversampling, base_->index());
397 return vector<LogicSegment::EdgePair>();
402 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
403 vector< pair<int64_t, bool> > &edges, bool level,
404 double samples_per_pixel, double pixels_offset, float x_offset,
407 QLineF *line = lines;
409 for (auto i = edges.begin(); i != (edges.end() - 1); i++)
410 if ((*i).second == level) {
412 ((*i).first / samples_per_pixel -
413 pixels_offset) + x_offset, y_offset,
414 ((*(i+1)).first / samples_per_pixel -
415 pixels_offset) + x_offset, y_offset);
418 p.drawLines(lines, line - lines);
421 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
423 shared_ptr<pv::data::LogicSegment> segment;
425 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
426 base_->logic_data()->logic_segments();
428 if (!segments.empty()) {
429 if (segment_display_mode_ == ShowLastSegmentOnly) {
430 segment = segments.back();
433 if ((segment_display_mode_ == ShowSingleSegmentOnly) ||
434 (segment_display_mode_ == ShowLastCompleteSegmentOnly)) {
436 segment = segments.at(current_segment_);
437 } catch (out_of_range&) {
438 qDebug() << "Current logic segment out of range for signal" << base_->name() << ":" << current_segment_;
446 void LogicSignal::init_trigger_actions(QWidget *parent)
448 trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
449 tr("No trigger"), parent);
450 trigger_none_->setCheckable(true);
451 connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
453 trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
454 tr("Trigger on rising edge"), parent);
455 trigger_rising_->setCheckable(true);
456 connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
458 trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
459 tr("Trigger on high level"), parent);
460 trigger_high_->setCheckable(true);
461 connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
463 trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
464 tr("Trigger on falling edge"), parent);
465 trigger_falling_->setCheckable(true);
466 connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
468 trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
469 tr("Trigger on low level"), parent);
470 trigger_low_->setCheckable(true);
471 connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
473 trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
474 tr("Trigger on rising or falling edge"), parent);
475 trigger_change_->setCheckable(true);
476 connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
479 const vector<int32_t> LogicSignal::get_trigger_types() const
481 // We may not be associated with a device
483 return vector<int32_t>();
485 const auto sr_dev = device_->device();
486 if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
487 const Glib::VariantContainerBase gvar =
488 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
490 vector<int32_t> ttypes;
492 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
493 Glib::VariantBase tmp_vb;
494 gvar.get_child(tmp_vb, i);
496 Glib::Variant<int32_t> tmp_v =
497 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
499 ttypes.push_back(tmp_v.get());
504 return vector<int32_t>();
508 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
512 action = trigger_none_;
514 switch (type->id()) {
515 case SR_TRIGGER_ZERO:
516 action = trigger_low_;
519 action = trigger_high_;
521 case SR_TRIGGER_RISING:
522 action = trigger_rising_;
524 case SR_TRIGGER_FALLING:
525 action = trigger_falling_;
527 case SR_TRIGGER_EDGE:
528 action = trigger_change_;
538 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
540 if (action == trigger_low_)
541 return TriggerMatchType::ZERO;
542 else if (action == trigger_high_)
543 return TriggerMatchType::ONE;
544 else if (action == trigger_rising_)
545 return TriggerMatchType::RISING;
546 else if (action == trigger_falling_)
547 return TriggerMatchType::FALLING;
548 else if (action == trigger_change_)
549 return TriggerMatchType::EDGE;
554 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
556 Signal::populate_popup_form(parent, form);
558 signal_height_sb_ = new QSpinBox(parent);
559 signal_height_sb_->setRange(5, 1000);
560 signal_height_sb_->setSingleStep(5);
561 signal_height_sb_->setSuffix(tr(" pixels"));
562 signal_height_sb_->setValue(signal_height_);
563 connect(signal_height_sb_, SIGNAL(valueChanged(int)),
564 this, SLOT(on_signal_height_changed(int)));
565 form->addRow(tr("Trace height"), signal_height_sb_);
568 const vector<int32_t> trig_types = get_trigger_types();
570 if (!trig_types.empty()) {
571 trigger_bar_ = new QToolBar(parent);
572 init_trigger_actions(trigger_bar_);
573 trigger_bar_->addAction(trigger_none_);
574 trigger_none_->setChecked(!trigger_match_);
576 for (auto type_id : trig_types) {
577 const TriggerMatchType *const type =
578 TriggerMatchType::get(type_id);
579 QAction *const action = action_from_trigger_type(type);
580 trigger_bar_->addAction(action);
581 action->setChecked(trigger_match_ == type);
584 // Only allow triggers to be changed when we're stopped
585 if (session_.get_capture_state() != Session::Stopped)
586 for (QAction* action : trigger_bar_->findChildren<QAction*>())
587 action->setEnabled(false);
589 form->addRow(tr("Trigger"), trigger_bar_);
593 void LogicSignal::modify_trigger()
595 auto trigger = session_.session()->trigger();
596 auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
599 for (auto stage : trigger->stages()) {
600 const auto &matches = stage->matches();
601 if (none_of(matches.begin(), matches.end(),
602 [&](shared_ptr<TriggerMatch> match) {
603 return match->channel() != base_->channel(); }))
606 auto new_stage = new_trigger->add_stage();
607 for (auto match : stage->matches()) {
608 if (match->channel() == base_->channel())
610 new_stage->add_match(match->channel(), match->type());
615 if (trigger_match_) {
616 // Until we can let the user decide how to group trigger matches
617 // into stages, put all of the matches into a single stage --
618 // most devices only support a single trigger stage.
619 if (new_trigger->stages().empty())
620 new_trigger->add_stage();
622 new_trigger->stages().back()->add_match(base_->channel(),
626 session_.session()->set_trigger(
627 new_trigger->stages().empty() ? nullptr : new_trigger);
630 owner_->row_item_appearance_changed(false, true);
633 const QIcon* LogicSignal::get_icon(const char *path)
635 if (!icon_cache_.contains(path)) {
636 const QIcon *icon = new QIcon(path);
637 icon_cache_.insert(path, icon);
640 return icon_cache_.take(path);
643 const QPixmap* LogicSignal::get_pixmap(const char *path)
645 if (!pixmap_cache_.contains(path)) {
646 const QPixmap *pixmap = new QPixmap(path);
647 pixmap_cache_.insert(path, pixmap);
650 return pixmap_cache_.take(path);
653 void LogicSignal::on_trigger()
657 action_from_trigger_type(trigger_match_)->setChecked(false);
659 action = (QAction *)sender();
660 action->setChecked(true);
661 trigger_match_ = trigger_type_from_action(action);
666 void LogicSignal::on_signal_height_changed(int height)
668 signal_height_ = height;
671 // Call order is important, otherwise the lazy event handler won't work
672 owner_->extents_changed(false, true);
673 owner_->row_item_appearance_changed(false, true);