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(
91 shared_ptr<devices::Device> device,
92 shared_ptr<data::SignalBase> base) :
93 Signal(session, base),
95 trigger_types_(get_trigger_types()),
96 trigger_none_(nullptr),
97 trigger_rising_(nullptr),
98 trigger_high_(nullptr),
99 trigger_falling_(nullptr),
100 trigger_low_(nullptr),
101 trigger_change_(nullptr)
103 shared_ptr<Trigger> trigger;
105 GlobalSettings settings;
106 signal_height_ = settings.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
107 show_sampling_points_ =
108 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool();
110 settings.value(GlobalSettings::Key_View_FillSignalHighAreas).toBool();
111 high_fill_color_ = QColor::fromRgba(settings.value(
112 GlobalSettings::Key_View_FillSignalHighAreaColor).value<uint32_t>());
114 /* Populate this channel's trigger setting with whatever we
115 * find in the current session trigger, if anything. */
116 trigger_match_ = nullptr;
117 if ((trigger = session_.session()->trigger()))
118 for (auto stage : trigger->stages())
119 for (auto match : stage->matches())
120 if (match->channel() == base_->channel())
121 trigger_match_ = match->type();
124 shared_ptr<pv::data::SignalData> LogicSignal::data() const
126 return base_->logic_data();
129 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
131 return base_->logic_data();
134 std::map<QString, QVariant> LogicSignal::save_settings() const
136 std::map<QString, QVariant> result;
138 result["trace_height"] = signal_height_;
143 void LogicSignal::restore_settings(std::map<QString, QVariant> settings)
145 auto entry = settings.find("trace_height");
146 if (entry != settings.end()) {
147 const int old_height = signal_height_;
148 signal_height_ = settings["trace_height"].toInt();
150 if ((signal_height_ != old_height) && owner_) {
151 // Call order is important, otherwise the lazy event handler won't work
152 owner_->extents_changed(false, true);
153 owner_->row_item_appearance_changed(false, true);
158 pair<int, int> LogicSignal::v_extents() const
160 const int signal_margin =
161 QFontMetrics(QApplication::font()).height() / 2;
162 return make_pair(-signal_height_ - signal_margin, signal_margin);
165 void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
169 vector< pair<int64_t, bool> > edges;
174 const int y = get_visual_y();
176 if (!base_->enabled())
179 const float low_offset = y + 0.5f;
180 const float high_offset = low_offset - signal_height_;
182 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
183 if (!segment || (segment->get_sample_count() == 0))
186 double samplerate = segment->samplerate();
188 // Show sample rate as 1Hz when it is unknown
189 if (samplerate == 0.0)
192 const double pixels_offset = pp.pixels_offset();
193 const pv::util::Timestamp& start_time = segment->start_time();
194 const int64_t last_sample = (int64_t)segment->get_sample_count() - 1;
195 const double samples_per_pixel = samplerate * pp.scale();
196 const double pixels_per_sample = 1 / samples_per_pixel;
197 const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
198 const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
200 const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
201 (int64_t)0), last_sample);
202 const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
203 (int64_t)0), last_sample);
205 segment->get_subsampled_edges(edges, start_sample, end_sample,
206 samples_per_pixel / Oversampling, base_->index());
207 assert(edges.size() >= 2);
209 const float first_sample_x =
210 pp.left() + (edges.front().first / samples_per_pixel - pixels_offset);
211 const float last_sample_x =
212 pp.left() + (edges.back().first / samples_per_pixel - pixels_offset);
214 // Check whether we need to paint the sampling points
215 const bool show_sampling_points = show_sampling_points_ && (samples_per_pixel < 0.25);
216 vector<QRectF> sampling_points;
217 float sampling_point_x = first_sample_x;
218 int64_t sampling_point_sample = start_sample;
221 if (show_sampling_points)
222 sampling_points.reserve(end_sample - start_sample + 1);
224 vector<QRectF> high_rects;
226 bool rising_edge_seen = false;
229 const unsigned int edge_count = edges.size() - 2;
230 QLineF *const edge_lines = new QLineF[edge_count];
233 if (edges.front().second) {
234 // Beginning of trace is high
235 rising_edge_x = first_sample_x;
236 rising_edge_seen = true;
239 for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
240 // Note: multiple edges occupying a single pixel are represented by an edge
241 // with undefined logic level. This means that only the first falling edge
242 // after a rising edge corresponds to said rising edge - and vice versa. If
243 // more edges with the same logic level follow, they denote multiple edges.
245 const float x = pp.left() + ((*i).first / samples_per_pixel - pixels_offset);
246 *line++ = QLineF(x, high_offset, x, low_offset);
248 if (fill_high_areas_) {
249 // Any edge terminates a high area
250 if (rising_edge_seen) {
251 const int width = x - rising_edge_x;
253 high_rects.emplace_back(rising_edge_x, high_offset,
254 width, signal_height_);
255 rising_edge_seen = false;
258 // Only rising edges start high areas
261 rising_edge_seen = true;
265 if (show_sampling_points)
266 while (sampling_point_sample < (*i).first) {
267 const float y = (*i).second ? low_offset : high_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;
275 // Calculate the sample points from the last edge to the end of the trace
276 if (show_sampling_points)
277 while ((uint64_t)sampling_point_sample <= end_sample) {
278 // Signal changed after the last edge, so the level is inverted
279 const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
280 sampling_points.emplace_back(
281 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
282 sampling_point_sample++;
283 sampling_point_x += pixels_per_sample;
286 if (fill_high_areas_) {
287 // Add last high rectangle if the signal is still high at the end of the trace
288 if (rising_edge_seen && (edges.cend() - 1)->second)
289 high_rects.emplace_back(rising_edge_x, high_offset,
290 last_sample_x - rising_edge_x, signal_height_);
292 p.setPen(high_fill_color_);
293 p.setBrush(high_fill_color_);
294 p.drawRects((const QRectF*)(high_rects.data()), high_rects.size());
298 p.drawLines(edge_lines, edge_count);
302 const unsigned int max_cap_line_count = edges.size();
303 QLineF *const cap_lines = new QLineF[max_cap_line_count];
306 paint_caps(p, cap_lines, edges, true, samples_per_pixel,
307 pixels_offset, pp.left(), high_offset);
309 paint_caps(p, cap_lines, edges, false, samples_per_pixel,
310 pixels_offset, pp.left(), low_offset);
314 // Paint the sampling points
315 if (show_sampling_points) {
316 p.setPen(SamplingPointColor);
317 p.drawRects(sampling_points.data(), sampling_points.size());
321 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
323 if (base_->enabled()) {
324 if (trigger_match_) {
325 // Draw the trigger marker
326 const int y = get_visual_y();
328 for (int32_t type_id : trigger_types_) {
329 const TriggerMatchType *const type =
330 TriggerMatchType::get(type_id);
331 if (trigger_match_ != type || type_id < 0 ||
332 (size_t)type_id >= countof(TriggerMarkerIcons) ||
333 !TriggerMarkerIcons[type_id])
336 const QPixmap *const pixmap = get_pixmap(
337 TriggerMarkerIcons[type_id]);
341 const float pad = TriggerMarkerPadding - 0.5f;
342 const QSize size = pixmap->size();
344 pp.right() - size.width() - pad * 2,
345 y - (signal_height_ + size.height()) / 2);
347 p.setPen(QPen(TriggerMarkerBackgroundColor.darker()));
348 p.setBrush(TriggerMarkerBackgroundColor);
349 p.drawRoundedRect(QRectF(point, size).adjusted(
350 -pad, -pad, pad, pad), pad, pad);
351 p.drawPixmap(point, *pixmap);
357 if (show_hover_marker_)
358 paint_hover_marker(p);
362 vector<LogicSegment::EdgePair> LogicSignal::get_nearest_level_changes(uint64_t sample_pos)
368 return vector<LogicSegment::EdgePair>();
370 shared_ptr<LogicSegment> segment = get_logic_segment_to_paint();
371 if (!segment || (segment->get_sample_count() == 0))
372 return vector<LogicSegment::EdgePair>();
374 const View *view = owner_->view();
376 const double samples_per_pixel = base_->get_samplerate() * view->scale();
378 vector<LogicSegment::EdgePair> edges;
380 segment->get_surrounding_edges(edges, sample_pos,
381 samples_per_pixel / Oversampling, base_->index());
384 return vector<LogicSegment::EdgePair>();
389 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
390 vector< pair<int64_t, bool> > &edges, bool level,
391 double samples_per_pixel, double pixels_offset, float x_offset,
394 QLineF *line = lines;
396 for (auto i = edges.begin(); i != (edges.end() - 1); i++)
397 if ((*i).second == level) {
399 ((*i).first / samples_per_pixel -
400 pixels_offset) + x_offset, y_offset,
401 ((*(i+1)).first / samples_per_pixel -
402 pixels_offset) + x_offset, y_offset);
405 p.drawLines(lines, line - lines);
408 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
410 shared_ptr<pv::data::LogicSegment> segment;
412 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
413 base_->logic_data()->logic_segments();
415 if (!segments.empty()) {
416 if (segment_display_mode_ == ShowLastSegmentOnly) {
417 segment = segments.back();
420 if ((segment_display_mode_ == ShowSingleSegmentOnly) ||
421 (segment_display_mode_ == ShowLastCompleteSegmentOnly)) {
423 segment = segments.at(current_segment_);
424 } catch (out_of_range&) {
425 qDebug() << "Current logic segment out of range for signal" << base_->name() << ":" << current_segment_;
433 void LogicSignal::init_trigger_actions(QWidget *parent)
435 trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
436 tr("No trigger"), parent);
437 trigger_none_->setCheckable(true);
438 connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
440 trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
441 tr("Trigger on rising edge"), parent);
442 trigger_rising_->setCheckable(true);
443 connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
445 trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
446 tr("Trigger on high level"), parent);
447 trigger_high_->setCheckable(true);
448 connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
450 trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
451 tr("Trigger on falling edge"), parent);
452 trigger_falling_->setCheckable(true);
453 connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
455 trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
456 tr("Trigger on low level"), parent);
457 trigger_low_->setCheckable(true);
458 connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
460 trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
461 tr("Trigger on rising or falling edge"), parent);
462 trigger_change_->setCheckable(true);
463 connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
466 const vector<int32_t> LogicSignal::get_trigger_types() const
468 // We may not be associated with a device
470 return vector<int32_t>();
472 const auto sr_dev = device_->device();
473 if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
474 const Glib::VariantContainerBase gvar =
475 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
477 vector<int32_t> ttypes;
479 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
480 Glib::VariantBase tmp_vb;
481 gvar.get_child(tmp_vb, i);
483 Glib::Variant<int32_t> tmp_v =
484 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
486 ttypes.push_back(tmp_v.get());
491 return vector<int32_t>();
495 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
499 action = trigger_none_;
501 switch (type->id()) {
502 case SR_TRIGGER_ZERO:
503 action = trigger_low_;
506 action = trigger_high_;
508 case SR_TRIGGER_RISING:
509 action = trigger_rising_;
511 case SR_TRIGGER_FALLING:
512 action = trigger_falling_;
514 case SR_TRIGGER_EDGE:
515 action = trigger_change_;
525 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
527 if (action == trigger_low_)
528 return TriggerMatchType::ZERO;
529 else if (action == trigger_high_)
530 return TriggerMatchType::ONE;
531 else if (action == trigger_rising_)
532 return TriggerMatchType::RISING;
533 else if (action == trigger_falling_)
534 return TriggerMatchType::FALLING;
535 else if (action == trigger_change_)
536 return TriggerMatchType::EDGE;
541 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
543 Signal::populate_popup_form(parent, form);
545 signal_height_sb_ = new QSpinBox(parent);
546 signal_height_sb_->setRange(5, 1000);
547 signal_height_sb_->setSingleStep(5);
548 signal_height_sb_->setSuffix(tr(" pixels"));
549 signal_height_sb_->setValue(signal_height_);
550 connect(signal_height_sb_, SIGNAL(valueChanged(int)),
551 this, SLOT(on_signal_height_changed(int)));
552 form->addRow(tr("Trace height"), signal_height_sb_);
555 const vector<int32_t> trig_types = get_trigger_types();
557 if (!trig_types.empty()) {
558 trigger_bar_ = new QToolBar(parent);
559 init_trigger_actions(trigger_bar_);
560 trigger_bar_->addAction(trigger_none_);
561 trigger_none_->setChecked(!trigger_match_);
563 for (auto type_id : trig_types) {
564 const TriggerMatchType *const type =
565 TriggerMatchType::get(type_id);
566 QAction *const action = action_from_trigger_type(type);
567 trigger_bar_->addAction(action);
568 action->setChecked(trigger_match_ == type);
571 // Only allow triggers to be changed when we're stopped
572 if (session_.get_capture_state() != Session::Stopped)
573 for (QAction* action : trigger_bar_->findChildren<QAction*>()) // clazy:exclude=range-loop
574 action->setEnabled(false);
576 form->addRow(tr("Trigger"), trigger_bar_);
580 void LogicSignal::modify_trigger()
582 auto trigger = session_.session()->trigger();
583 auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
586 for (auto stage : trigger->stages()) {
587 const auto &matches = stage->matches();
588 if (none_of(matches.begin(), matches.end(),
589 [&](shared_ptr<TriggerMatch> match) {
590 return match->channel() != base_->channel(); }))
593 auto new_stage = new_trigger->add_stage();
594 for (auto match : stage->matches()) {
595 if (match->channel() == base_->channel())
597 new_stage->add_match(match->channel(), match->type());
602 if (trigger_match_) {
603 // Until we can let the user decide how to group trigger matches
604 // into stages, put all of the matches into a single stage --
605 // most devices only support a single trigger stage.
606 if (new_trigger->stages().empty())
607 new_trigger->add_stage();
609 new_trigger->stages().back()->add_match(base_->channel(),
613 session_.session()->set_trigger(
614 new_trigger->stages().empty() ? nullptr : new_trigger);
617 owner_->row_item_appearance_changed(false, true);
620 const QIcon* LogicSignal::get_icon(const char *path)
622 if (!icon_cache_.contains(path)) {
623 const QIcon *icon = new QIcon(path);
624 icon_cache_.insert(path, icon);
627 return icon_cache_.take(path);
630 const QPixmap* LogicSignal::get_pixmap(const char *path)
632 if (!pixmap_cache_.contains(path)) {
633 const QPixmap *pixmap = new QPixmap(path);
634 pixmap_cache_.insert(path, pixmap);
637 return pixmap_cache_.take(path);
640 void LogicSignal::on_setting_changed(const QString &key, const QVariant &value)
642 Signal::on_setting_changed(key, value);
644 if (key == GlobalSettings::Key_View_ShowSamplingPoints)
645 show_sampling_points_ = value.toBool();
647 if (key == GlobalSettings::Key_View_FillSignalHighAreas)
648 fill_high_areas_ = value.toBool();
650 if (key == GlobalSettings::Key_View_FillSignalHighAreaColor)
651 high_fill_color_ = QColor::fromRgba(value.value<uint32_t>());
654 void LogicSignal::on_trigger()
658 action_from_trigger_type(trigger_match_)->setChecked(false);
660 action = (QAction *)sender();
661 action->setChecked(true);
662 trigger_match_ = trigger_type_from_action(action);
667 void LogicSignal::on_signal_height_changed(int height)
669 signal_height_ = height;
672 // Call order is important, otherwise the lazy event handler won't work
673 owner_->extents_changed(false, true);
674 owner_->row_item_appearance_changed(false, true);