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 QColor LogicSignal::TriggerMarkerBackgroundColor = QColor(0xED, 0xD4, 0x00);
74 const int LogicSignal::TriggerMarkerPadding = 2;
75 const char* LogicSignal::TriggerMarkerIcons[8] = {
77 ":/icons/trigger-marker-low.svg",
78 ":/icons/trigger-marker-high.svg",
79 ":/icons/trigger-marker-rising.svg",
80 ":/icons/trigger-marker-falling.svg",
81 ":/icons/trigger-marker-change.svg",
86 QCache<QString, const QIcon> LogicSignal::icon_cache_;
87 QCache<QString, const QPixmap> LogicSignal::pixmap_cache_;
89 LogicSignal::LogicSignal(pv::Session &session, shared_ptr<data::SignalBase> base) :
90 Signal(session, base),
91 trigger_types_(get_trigger_types()),
92 trigger_none_(nullptr),
93 trigger_rising_(nullptr),
94 trigger_high_(nullptr),
95 trigger_falling_(nullptr),
96 trigger_low_(nullptr),
97 trigger_change_(nullptr)
99 GlobalSettings settings;
100 signal_height_ = settings.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
101 show_sampling_points_ =
102 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool();
104 settings.value(GlobalSettings::Key_View_FillSignalHighAreas).toBool();
105 high_fill_color_ = QColor::fromRgba(settings.value(
106 GlobalSettings::Key_View_FillSignalHighAreaColor).value<uint32_t>());
108 update_logic_level_offsets();
110 /* Populate this channel's trigger setting with whatever we
111 * find in the current session trigger, if anything. */
112 trigger_match_ = nullptr;
113 if (shared_ptr<Trigger> trigger = session_.session()->trigger())
114 for (auto stage : trigger->stages())
115 for (auto match : stage->matches())
116 if (match->channel() == base_->channel())
117 trigger_match_ = match->type();
120 std::map<QString, QVariant> LogicSignal::save_settings() const
122 std::map<QString, QVariant> result;
124 result["trace_height"] = signal_height_;
129 void LogicSignal::restore_settings(std::map<QString, QVariant> settings)
131 auto entry = settings.find("trace_height");
132 if (entry != settings.end()) {
133 const int old_height = signal_height_;
134 signal_height_ = settings["trace_height"].toInt();
136 if ((signal_height_ != old_height) && owner_) {
137 update_logic_level_offsets();
139 // Call order is important, otherwise the lazy event handler won't work
140 owner_->extents_changed(false, true);
141 owner_->row_item_appearance_changed(false, true);
146 pair<int, int> LogicSignal::v_extents() const
148 const int signal_margin =
149 QFontMetrics(QApplication::font()).height() / 2;
150 return make_pair(-signal_height_ - signal_margin, signal_margin);
153 void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
157 vector< pair<int64_t, bool> > edges;
162 const int y = get_visual_y();
164 if (!base_->enabled())
167 const float low_offset = y + low_level_offset_;
168 const float high_offset = y + high_level_offset_;
169 const float fill_height = low_offset - high_offset;
171 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
172 if (!segment || (segment->get_sample_count() == 0))
175 double samplerate = segment->samplerate();
177 // Show sample rate as 1Hz when it is unknown
178 if (samplerate == 0.0)
181 const double pixels_offset = pp.pixels_offset();
182 const pv::util::Timestamp& start_time = segment->start_time();
183 const int64_t last_sample = (int64_t)segment->get_sample_count() - 1;
184 const double samples_per_pixel = samplerate * pp.scale();
185 const double pixels_per_sample = 1 / samples_per_pixel;
186 const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
187 const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
189 const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
190 (int64_t)0), last_sample);
191 const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
192 (int64_t)0), last_sample);
194 segment->get_subsampled_edges(edges, start_sample, end_sample,
195 samples_per_pixel / Oversampling, base_->logic_bit_index());
196 assert(edges.size() >= 2);
198 const float first_sample_x =
199 pp.left() + (edges.front().first / samples_per_pixel - pixels_offset);
200 const float last_sample_x =
201 pp.left() + (edges.back().first / samples_per_pixel - pixels_offset);
203 // Check whether we need to paint the sampling points
204 const bool show_sampling_points = show_sampling_points_ && (samples_per_pixel < 0.25);
205 vector<QRectF> sampling_points;
206 float sampling_point_x = first_sample_x;
207 int64_t sampling_point_sample = start_sample;
210 if (show_sampling_points)
211 sampling_points.reserve(end_sample - start_sample + 1);
213 vector<QRectF> high_rects;
215 bool rising_edge_seen = false;
218 const unsigned int edge_count = edges.size() - 2;
219 QLineF *const edge_lines = new QLineF[edge_count];
222 if (edges.front().second) {
223 // Beginning of trace is high
224 rising_edge_x = first_sample_x;
225 rising_edge_seen = true;
228 for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
229 // Note: multiple edges occupying a single pixel are represented by an edge
230 // with undefined logic level. This means that only the first falling edge
231 // after a rising edge corresponds to said rising edge - and vice versa. If
232 // more edges with the same logic level follow, they denote multiple edges.
234 const float x = pp.left() + ((*i).first / samples_per_pixel - pixels_offset);
235 *line++ = QLineF(x, high_offset, x, low_offset);
237 if (fill_high_areas_) {
238 // Any edge terminates a high area
239 if (rising_edge_seen) {
240 const int width = x - rising_edge_x;
242 high_rects.emplace_back(rising_edge_x, high_offset, width, fill_height);
243 rising_edge_seen = false;
246 // Only rising edges start high areas
249 rising_edge_seen = true;
253 if (show_sampling_points)
254 while (sampling_point_sample < (*i).first) {
255 const float y = (*i).second ? low_offset : high_offset;
256 sampling_points.emplace_back(
257 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
258 sampling_point_sample++;
259 sampling_point_x += pixels_per_sample;
263 // Calculate the sample points from the last edge to the end of the trace
264 if (show_sampling_points)
265 while ((uint64_t)sampling_point_sample <= end_sample) {
266 // Signal changed after the last edge, so the level is inverted
267 const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
268 sampling_points.emplace_back(
269 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
270 sampling_point_sample++;
271 sampling_point_x += pixels_per_sample;
274 if (fill_high_areas_) {
275 // Add last high rectangle if the signal is still high at the end of the trace
276 if (rising_edge_seen && (edges.cend() - 1)->second)
277 high_rects.emplace_back(rising_edge_x, high_offset,
278 last_sample_x - rising_edge_x, signal_height_);
280 p.setPen(high_fill_color_);
281 p.setBrush(high_fill_color_);
282 p.drawRects((const QRectF*)(high_rects.data()), high_rects.size());
286 p.drawLines(edge_lines, edge_count);
290 const unsigned int max_cap_line_count = edges.size();
291 QLineF *const cap_lines = new QLineF[max_cap_line_count];
294 paint_caps(p, cap_lines, edges, true, samples_per_pixel,
295 pixels_offset, pp.left(), high_offset);
297 paint_caps(p, cap_lines, edges, false, samples_per_pixel,
298 pixels_offset, pp.left(), low_offset);
302 // Paint the sampling points
303 if (show_sampling_points) {
304 p.setPen(SamplingPointColor);
305 p.drawRects(sampling_points.data(), sampling_points.size());
309 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
311 if (base_->enabled()) {
312 if (trigger_match_) {
313 // Draw the trigger marker
314 const int y = get_visual_y();
316 for (int32_t type_id : trigger_types_) {
317 const TriggerMatchType *const type =
318 TriggerMatchType::get(type_id);
319 if (trigger_match_ != type || type_id < 0 ||
320 (size_t)type_id >= countof(TriggerMarkerIcons) ||
321 !TriggerMarkerIcons[type_id])
324 const QPixmap *const pixmap = get_pixmap(
325 TriggerMarkerIcons[type_id]);
329 const float pad = TriggerMarkerPadding - 0.5f;
330 const QSize size = pixmap->size();
332 pp.right() - size.width() - pad * 2,
333 y - (signal_height_ + size.height()) / 2);
335 p.setPen(QPen(TriggerMarkerBackgroundColor.darker()));
336 p.setBrush(TriggerMarkerBackgroundColor);
337 p.drawRoundedRect(QRectF(point, size).adjusted(
338 -pad, -pad, pad, pad), pad, pad);
339 p.drawPixmap(point, *pixmap);
345 if (show_hover_marker_)
346 paint_hover_marker(p);
350 vector<LogicSegment::EdgePair> LogicSignal::get_nearest_level_changes(uint64_t sample_pos)
356 return vector<LogicSegment::EdgePair>();
358 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
359 if (!segment || (segment->get_sample_count() == 0))
360 return vector<LogicSegment::EdgePair>();
362 const View *view = owner_->view();
364 const double samples_per_pixel = base_->get_samplerate() * view->scale();
366 vector<LogicSegment::EdgePair> edges;
368 segment->get_surrounding_edges(edges, sample_pos,
369 samples_per_pixel / Oversampling, base_->index());
372 return vector<LogicSegment::EdgePair>();
377 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
378 vector< pair<int64_t, bool> > &edges, bool level,
379 double samples_per_pixel, double pixels_offset, float x_offset,
382 QLineF *line = lines;
384 for (auto i = edges.begin(); i != (edges.end() - 1); i++)
385 if ((*i).second == level) {
387 ((*i).first / samples_per_pixel -
388 pixels_offset) + x_offset, y_offset,
389 ((*(i+1)).first / samples_per_pixel -
390 pixels_offset) + x_offset, y_offset);
393 p.drawLines(lines, line - lines);
396 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
398 shared_ptr<pv::data::LogicSegment> segment;
400 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
401 base_->logic_data()->logic_segments();
403 if (!segments.empty()) {
404 if (segment_display_mode_ == ShowLastSegmentOnly)
405 segment = segments.back();
407 if ((segment_display_mode_ == ShowSingleSegmentOnly) ||
408 (segment_display_mode_ == ShowLastCompleteSegmentOnly)) {
410 segment = segments.at(current_segment_);
411 } catch (out_of_range&) {
412 qDebug() << "Current logic segment out of range for signal" << base_->name() << ":" << current_segment_;
420 void LogicSignal::init_trigger_actions(QWidget *parent)
422 trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
423 tr("No trigger"), parent);
424 trigger_none_->setCheckable(true);
425 connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
427 trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
428 tr("Trigger on rising edge"), parent);
429 trigger_rising_->setCheckable(true);
430 connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
432 trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
433 tr("Trigger on high level"), parent);
434 trigger_high_->setCheckable(true);
435 connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
437 trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
438 tr("Trigger on falling edge"), parent);
439 trigger_falling_->setCheckable(true);
440 connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
442 trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
443 tr("Trigger on low level"), parent);
444 trigger_low_->setCheckable(true);
445 connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
447 trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
448 tr("Trigger on rising or falling edge"), parent);
449 trigger_change_->setCheckable(true);
450 connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
453 const vector<int32_t> LogicSignal::get_trigger_types() const
455 // We may not be associated with a device
456 if (!session_.device())
457 return vector<int32_t>();
459 const auto sr_dev = session_.device()->device();
460 if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
461 const Glib::VariantContainerBase gvar =
462 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
464 vector<int32_t> ttypes;
466 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
467 Glib::VariantBase tmp_vb;
468 gvar.get_child(tmp_vb, i);
470 Glib::Variant<int32_t> tmp_v =
471 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
473 ttypes.push_back(tmp_v.get());
478 return vector<int32_t>();
482 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
486 action = trigger_none_;
488 switch (type->id()) {
489 case SR_TRIGGER_ZERO:
490 action = trigger_low_;
493 action = trigger_high_;
495 case SR_TRIGGER_RISING:
496 action = trigger_rising_;
498 case SR_TRIGGER_FALLING:
499 action = trigger_falling_;
501 case SR_TRIGGER_EDGE:
502 action = trigger_change_;
512 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
514 if (action == trigger_low_)
515 return TriggerMatchType::ZERO;
516 else if (action == trigger_high_)
517 return TriggerMatchType::ONE;
518 else if (action == trigger_rising_)
519 return TriggerMatchType::RISING;
520 else if (action == trigger_falling_)
521 return TriggerMatchType::FALLING;
522 else if (action == trigger_change_)
523 return TriggerMatchType::EDGE;
528 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
530 Signal::populate_popup_form(parent, form);
532 signal_height_sb_ = new QSpinBox(parent);
533 signal_height_sb_->setRange(5, 1000);
534 signal_height_sb_->setSingleStep(5);
535 signal_height_sb_->setSuffix(tr(" pixels"));
536 signal_height_sb_->setValue(signal_height_);
537 connect(signal_height_sb_, SIGNAL(valueChanged(int)),
538 this, SLOT(on_signal_height_changed(int)));
539 form->addRow(tr("Trace height"), signal_height_sb_);
542 const vector<int32_t> trig_types = get_trigger_types();
544 if (!trig_types.empty()) {
545 trigger_bar_ = new QToolBar(parent);
546 init_trigger_actions(trigger_bar_);
547 trigger_bar_->addAction(trigger_none_);
548 trigger_none_->setChecked(!trigger_match_);
550 for (auto type_id : trig_types) {
551 const TriggerMatchType *const type =
552 TriggerMatchType::get(type_id);
553 QAction *const action = action_from_trigger_type(type);
554 trigger_bar_->addAction(action);
555 action->setChecked(trigger_match_ == type);
558 // Only allow triggers to be changed when we're stopped
559 if (session_.get_capture_state() != Session::Stopped)
560 for (QAction* action : trigger_bar_->findChildren<QAction*>()) // clazy:exclude=range-loop
561 action->setEnabled(false);
563 form->addRow(tr("Trigger"), trigger_bar_);
567 void LogicSignal::modify_trigger()
569 auto trigger = session_.session()->trigger();
570 auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
573 for (auto stage : trigger->stages()) {
574 const auto &matches = stage->matches();
575 if (none_of(matches.begin(), matches.end(),
576 [&](shared_ptr<TriggerMatch> match) {
577 return match->channel() != base_->channel(); }))
580 auto new_stage = new_trigger->add_stage();
581 for (auto match : stage->matches()) {
582 if (match->channel() == base_->channel())
584 new_stage->add_match(match->channel(), match->type());
589 if (trigger_match_) {
590 // Until we can let the user decide how to group trigger matches
591 // into stages, put all of the matches into a single stage --
592 // most devices only support a single trigger stage.
593 if (new_trigger->stages().empty())
594 new_trigger->add_stage();
596 new_trigger->stages().back()->add_match(base_->channel(),
600 session_.session()->set_trigger(
601 new_trigger->stages().empty() ? nullptr : new_trigger);
604 owner_->row_item_appearance_changed(false, true);
607 const QIcon* LogicSignal::get_icon(const char *path)
609 if (!icon_cache_.contains(path)) {
610 const QIcon *icon = new QIcon(path);
611 icon_cache_.insert(path, icon);
614 return icon_cache_.take(path);
617 const QPixmap* LogicSignal::get_pixmap(const char *path)
619 if (!pixmap_cache_.contains(path)) {
620 const QPixmap *pixmap = new QPixmap(path);
621 pixmap_cache_.insert(path, pixmap);
624 return pixmap_cache_.take(path);
627 void LogicSignal::update_logic_level_offsets()
629 low_level_offset_ = 0.5f;
630 high_level_offset_ = low_level_offset_ - signal_height_;
633 void LogicSignal::on_setting_changed(const QString &key, const QVariant &value)
635 Signal::on_setting_changed(key, value);
637 if (key == GlobalSettings::Key_View_ShowSamplingPoints)
638 show_sampling_points_ = value.toBool();
640 if (key == GlobalSettings::Key_View_FillSignalHighAreas)
641 fill_high_areas_ = value.toBool();
643 if (key == GlobalSettings::Key_View_FillSignalHighAreaColor)
644 high_fill_color_ = QColor::fromRgba(value.value<uint32_t>());
647 void LogicSignal::on_trigger()
651 action_from_trigger_type(trigger_match_)->setChecked(false);
653 action = (QAction *)sender();
654 action->setChecked(true);
655 trigger_match_ = trigger_type_from_action(action);
660 void LogicSignal::on_signal_height_changed(int height)
662 signal_height_ = height;
665 update_logic_level_offsets();
667 // Call order is important, otherwise the lazy event handler won't work
668 owner_->extents_changed(false, true);
669 owner_->row_item_appearance_changed(false, true);