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)]);
120 GlobalSettings settings;
121 signal_height_ = settings.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
122 show_sampling_points_ =
123 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool();
125 settings.value(GlobalSettings::Key_View_FillSignalHighAreas).toBool();
126 high_fill_color_ = QColor::fromRgba(settings.value(
127 GlobalSettings::Key_View_FillSignalHighAreaColor).value<uint32_t>());
129 /* Populate this channel's trigger setting with whatever we
130 * find in the current session trigger, if anything. */
131 trigger_match_ = nullptr;
132 if ((trigger = session_.session()->trigger()))
133 for (auto stage : trigger->stages())
134 for (auto match : stage->matches())
135 if (match->channel() == base_->channel())
136 trigger_match_ = match->type();
139 shared_ptr<pv::data::SignalData> LogicSignal::data() const
141 return base_->logic_data();
144 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
146 return base_->logic_data();
149 std::map<QString, QVariant> LogicSignal::save_settings() const
151 std::map<QString, QVariant> result;
153 result["trace_height"] = signal_height_;
158 void LogicSignal::restore_settings(std::map<QString, QVariant> settings)
160 auto entry = settings.find("trace_height");
161 if (entry != settings.end()) {
162 const int old_height = signal_height_;
163 signal_height_ = settings["trace_height"].toInt();
165 if ((signal_height_ != old_height) && owner_) {
166 // Call order is important, otherwise the lazy event handler won't work
167 owner_->extents_changed(false, true);
168 owner_->row_item_appearance_changed(false, true);
173 pair<int, int> LogicSignal::v_extents() const
175 const int signal_margin =
176 QFontMetrics(QApplication::font()).height() / 2;
177 return make_pair(-signal_height_ - signal_margin, signal_margin);
180 void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
184 vector< pair<int64_t, bool> > edges;
189 const int y = get_visual_y();
191 if (!base_->enabled())
194 const float low_offset = y + 0.5f;
195 const float high_offset = low_offset - signal_height_;
197 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
198 if (!segment || (segment->get_sample_count() == 0))
201 double samplerate = segment->samplerate();
203 // Show sample rate as 1Hz when it is unknown
204 if (samplerate == 0.0)
207 const double pixels_offset = pp.pixels_offset();
208 const pv::util::Timestamp& start_time = segment->start_time();
209 const int64_t last_sample = (int64_t)segment->get_sample_count() - 1;
210 const double samples_per_pixel = samplerate * pp.scale();
211 const double pixels_per_sample = 1 / samples_per_pixel;
212 const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
213 const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
215 const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
216 (int64_t)0), last_sample);
217 const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
218 (int64_t)0), last_sample);
220 segment->get_subsampled_edges(edges, start_sample, end_sample,
221 samples_per_pixel / Oversampling, base_->index());
222 assert(edges.size() >= 2);
224 const float first_sample_x =
225 pp.left() + (edges.front().first / samples_per_pixel - pixels_offset);
226 const float last_sample_x =
227 pp.left() + (edges.back().first / samples_per_pixel - pixels_offset);
229 // Check whether we need to paint the sampling points
230 const bool show_sampling_points = show_sampling_points_ && (samples_per_pixel < 0.25);
231 vector<QRectF> sampling_points;
232 float sampling_point_x = first_sample_x;
233 int64_t sampling_point_sample = start_sample;
236 if (show_sampling_points)
237 sampling_points.reserve(end_sample - start_sample + 1);
239 vector<QRectF> high_rects;
241 bool rising_edge_seen = false;
244 const unsigned int edge_count = edges.size() - 2;
245 QLineF *const edge_lines = new QLineF[edge_count];
248 if (edges.front().second) {
249 // Beginning of trace is high
250 rising_edge_x = first_sample_x;
251 rising_edge_seen = true;
254 for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
255 // Note: multiple edges occupying a single pixel are represented by an edge
256 // with undefined logic level. This means that only the first falling edge
257 // after a rising edge corresponds to said rising edge - and vice versa. If
258 // more edges with the same logic level follow, they denote multiple edges.
260 const float x = pp.left() + ((*i).first / samples_per_pixel - pixels_offset);
261 *line++ = QLineF(x, high_offset, x, low_offset);
263 if (fill_high_areas_) {
264 // Any edge terminates a high area
265 if (rising_edge_seen) {
266 const int width = x - rising_edge_x;
268 high_rects.emplace_back(rising_edge_x, high_offset,
269 width, signal_height_);
270 rising_edge_seen = false;
273 // Only rising edges start high areas
276 rising_edge_seen = true;
280 if (show_sampling_points)
281 while (sampling_point_sample < (*i).first) {
282 const float y = (*i).second ? low_offset : high_offset;
283 sampling_points.emplace_back(
284 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
285 sampling_point_sample++;
286 sampling_point_x += pixels_per_sample;
290 // Calculate the sample points from the last edge to the end of the trace
291 if (show_sampling_points)
292 while ((uint64_t)sampling_point_sample <= end_sample) {
293 // Signal changed after the last edge, so the level is inverted
294 const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
295 sampling_points.emplace_back(
296 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
297 sampling_point_sample++;
298 sampling_point_x += pixels_per_sample;
301 if (fill_high_areas_) {
302 // Add last high rectangle if the signal is still high at the end of the trace
303 if (rising_edge_seen && (edges.cend() - 1)->second)
304 high_rects.emplace_back(rising_edge_x, high_offset,
305 last_sample_x - rising_edge_x, signal_height_);
307 p.setPen(high_fill_color_);
308 p.setBrush(high_fill_color_);
309 p.drawRects((const QRectF*)(high_rects.data()), high_rects.size());
313 p.drawLines(edge_lines, edge_count);
317 const unsigned int max_cap_line_count = edges.size();
318 QLineF *const cap_lines = new QLineF[max_cap_line_count];
321 paint_caps(p, cap_lines, edges, true, samples_per_pixel,
322 pixels_offset, pp.left(), high_offset);
324 paint_caps(p, cap_lines, edges, false, samples_per_pixel,
325 pixels_offset, pp.left(), low_offset);
329 // Paint the sampling points
330 if (show_sampling_points) {
331 p.setPen(SamplingPointColor);
332 p.drawRects(sampling_points.data(), sampling_points.size());
336 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
338 if (base_->enabled()) {
339 if (trigger_match_) {
340 // Draw the trigger marker
341 const int y = get_visual_y();
343 for (int32_t type_id : trigger_types_) {
344 const TriggerMatchType *const type =
345 TriggerMatchType::get(type_id);
346 if (trigger_match_ != type || type_id < 0 ||
347 (size_t)type_id >= countof(TriggerMarkerIcons) ||
348 !TriggerMarkerIcons[type_id])
351 const QPixmap *const pixmap = get_pixmap(
352 TriggerMarkerIcons[type_id]);
356 const float pad = TriggerMarkerPadding - 0.5f;
357 const QSize size = pixmap->size();
359 pp.right() - size.width() - pad * 2,
360 y - (signal_height_ + size.height()) / 2);
362 p.setPen(QPen(TriggerMarkerBackgroundColor.darker()));
363 p.setBrush(TriggerMarkerBackgroundColor);
364 p.drawRoundedRect(QRectF(point, size).adjusted(
365 -pad, -pad, pad, pad), pad, pad);
366 p.drawPixmap(point, *pixmap);
372 if (show_hover_marker_)
373 paint_hover_marker(p);
377 vector<LogicSegment::EdgePair> LogicSignal::get_nearest_level_changes(uint64_t sample_pos)
383 return vector<LogicSegment::EdgePair>();
385 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
386 if (!segment || (segment->get_sample_count() == 0))
387 return vector<LogicSegment::EdgePair>();
389 const View *view = owner_->view();
391 const double samples_per_pixel = base_->get_samplerate() * view->scale();
393 vector<LogicSegment::EdgePair> edges;
395 segment->get_surrounding_edges(edges, sample_pos,
396 samples_per_pixel / Oversampling, base_->index());
399 return vector<LogicSegment::EdgePair>();
404 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
405 vector< pair<int64_t, bool> > &edges, bool level,
406 double samples_per_pixel, double pixels_offset, float x_offset,
409 QLineF *line = lines;
411 for (auto i = edges.begin(); i != (edges.end() - 1); i++)
412 if ((*i).second == level) {
414 ((*i).first / samples_per_pixel -
415 pixels_offset) + x_offset, y_offset,
416 ((*(i+1)).first / samples_per_pixel -
417 pixels_offset) + x_offset, y_offset);
420 p.drawLines(lines, line - lines);
423 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
425 shared_ptr<pv::data::LogicSegment> segment;
427 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
428 base_->logic_data()->logic_segments();
430 if (!segments.empty()) {
431 if (segment_display_mode_ == ShowLastSegmentOnly) {
432 segment = segments.back();
435 if ((segment_display_mode_ == ShowSingleSegmentOnly) ||
436 (segment_display_mode_ == ShowLastCompleteSegmentOnly)) {
438 segment = segments.at(current_segment_);
439 } catch (out_of_range&) {
440 qDebug() << "Current logic segment out of range for signal" << base_->name() << ":" << current_segment_;
448 void LogicSignal::init_trigger_actions(QWidget *parent)
450 trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
451 tr("No trigger"), parent);
452 trigger_none_->setCheckable(true);
453 connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
455 trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
456 tr("Trigger on rising edge"), parent);
457 trigger_rising_->setCheckable(true);
458 connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
460 trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
461 tr("Trigger on high level"), parent);
462 trigger_high_->setCheckable(true);
463 connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
465 trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
466 tr("Trigger on falling edge"), parent);
467 trigger_falling_->setCheckable(true);
468 connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
470 trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
471 tr("Trigger on low level"), parent);
472 trigger_low_->setCheckable(true);
473 connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
475 trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
476 tr("Trigger on rising or falling edge"), parent);
477 trigger_change_->setCheckable(true);
478 connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
481 const vector<int32_t> LogicSignal::get_trigger_types() const
483 // We may not be associated with a device
485 return vector<int32_t>();
487 const auto sr_dev = device_->device();
488 if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
489 const Glib::VariantContainerBase gvar =
490 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
492 vector<int32_t> ttypes;
494 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
495 Glib::VariantBase tmp_vb;
496 gvar.get_child(tmp_vb, i);
498 Glib::Variant<int32_t> tmp_v =
499 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
501 ttypes.push_back(tmp_v.get());
506 return vector<int32_t>();
510 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
514 action = trigger_none_;
516 switch (type->id()) {
517 case SR_TRIGGER_ZERO:
518 action = trigger_low_;
521 action = trigger_high_;
523 case SR_TRIGGER_RISING:
524 action = trigger_rising_;
526 case SR_TRIGGER_FALLING:
527 action = trigger_falling_;
529 case SR_TRIGGER_EDGE:
530 action = trigger_change_;
540 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
542 if (action == trigger_low_)
543 return TriggerMatchType::ZERO;
544 else if (action == trigger_high_)
545 return TriggerMatchType::ONE;
546 else if (action == trigger_rising_)
547 return TriggerMatchType::RISING;
548 else if (action == trigger_falling_)
549 return TriggerMatchType::FALLING;
550 else if (action == trigger_change_)
551 return TriggerMatchType::EDGE;
556 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
558 Signal::populate_popup_form(parent, form);
560 signal_height_sb_ = new QSpinBox(parent);
561 signal_height_sb_->setRange(5, 1000);
562 signal_height_sb_->setSingleStep(5);
563 signal_height_sb_->setSuffix(tr(" pixels"));
564 signal_height_sb_->setValue(signal_height_);
565 connect(signal_height_sb_, SIGNAL(valueChanged(int)),
566 this, SLOT(on_signal_height_changed(int)));
567 form->addRow(tr("Trace height"), signal_height_sb_);
570 const vector<int32_t> trig_types = get_trigger_types();
572 if (!trig_types.empty()) {
573 trigger_bar_ = new QToolBar(parent);
574 init_trigger_actions(trigger_bar_);
575 trigger_bar_->addAction(trigger_none_);
576 trigger_none_->setChecked(!trigger_match_);
578 for (auto type_id : trig_types) {
579 const TriggerMatchType *const type =
580 TriggerMatchType::get(type_id);
581 QAction *const action = action_from_trigger_type(type);
582 trigger_bar_->addAction(action);
583 action->setChecked(trigger_match_ == type);
586 // Only allow triggers to be changed when we're stopped
587 if (session_.get_capture_state() != Session::Stopped)
588 for (QAction* action : trigger_bar_->findChildren<QAction*>()) // clazy:exclude=range-loop
589 action->setEnabled(false);
591 form->addRow(tr("Trigger"), trigger_bar_);
595 void LogicSignal::modify_trigger()
597 auto trigger = session_.session()->trigger();
598 auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
601 for (auto stage : trigger->stages()) {
602 const auto &matches = stage->matches();
603 if (none_of(matches.begin(), matches.end(),
604 [&](shared_ptr<TriggerMatch> match) {
605 return match->channel() != base_->channel(); }))
608 auto new_stage = new_trigger->add_stage();
609 for (auto match : stage->matches()) {
610 if (match->channel() == base_->channel())
612 new_stage->add_match(match->channel(), match->type());
617 if (trigger_match_) {
618 // Until we can let the user decide how to group trigger matches
619 // into stages, put all of the matches into a single stage --
620 // most devices only support a single trigger stage.
621 if (new_trigger->stages().empty())
622 new_trigger->add_stage();
624 new_trigger->stages().back()->add_match(base_->channel(),
628 session_.session()->set_trigger(
629 new_trigger->stages().empty() ? nullptr : new_trigger);
632 owner_->row_item_appearance_changed(false, true);
635 const QIcon* LogicSignal::get_icon(const char *path)
637 if (!icon_cache_.contains(path)) {
638 const QIcon *icon = new QIcon(path);
639 icon_cache_.insert(path, icon);
642 return icon_cache_.take(path);
645 const QPixmap* LogicSignal::get_pixmap(const char *path)
647 if (!pixmap_cache_.contains(path)) {
648 const QPixmap *pixmap = new QPixmap(path);
649 pixmap_cache_.insert(path, pixmap);
652 return pixmap_cache_.take(path);
655 void LogicSignal::on_setting_changed(const QString &key, const QVariant &value)
657 Signal::on_setting_changed(key, value);
659 if (key == GlobalSettings::Key_View_ShowSamplingPoints)
660 show_sampling_points_ = value.toBool();
662 if (key == GlobalSettings::Key_View_FillSignalHighAreas)
663 fill_high_areas_ = value.toBool();
665 if (key == GlobalSettings::Key_View_FillSignalHighAreaColor)
666 high_fill_color_ = QColor::fromRgba(value.value<uint32_t>());
669 void LogicSignal::on_trigger()
673 action_from_trigger_type(trigger_match_)->setChecked(false);
675 action = (QAction *)sender();
676 action->setChecked(true);
677 trigger_match_ = trigger_type_from_action(action);
682 void LogicSignal::on_signal_height_changed(int height)
684 signal_height_ = height;
687 // Call order is important, otherwise the lazy event handler won't work
688 owner_->extents_changed(false, true);
689 owner_->row_item_appearance_changed(false, true);