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;
64 const float LogicSignal::Oversampling = 2.0f;
66 const QColor LogicSignal::EdgeColor(0x80, 0x80, 0x80);
67 const QColor LogicSignal::HighColor(0x00, 0xC0, 0x00);
68 const QColor LogicSignal::LowColor(0xC0, 0x00, 0x00);
69 const QColor LogicSignal::SamplingPointColor(0x77, 0x77, 0x77);
71 const QColor LogicSignal::SignalColors[10] = {
72 QColor(0x16, 0x19, 0x1A), // Black
73 QColor(0x8F, 0x52, 0x02), // Brown
74 QColor(0xCC, 0x00, 0x00), // Red
75 QColor(0xF5, 0x79, 0x00), // Orange
76 QColor(0xED, 0xD4, 0x00), // Yellow
77 QColor(0x73, 0xD2, 0x16), // Green
78 QColor(0x34, 0x65, 0xA4), // Blue
79 QColor(0x75, 0x50, 0x7B), // Violet
80 QColor(0x88, 0x8A, 0x85), // Grey
81 QColor(0xEE, 0xEE, 0xEC), // White
84 QColor LogicSignal::TriggerMarkerBackgroundColor = QColor(0xED, 0xD4, 0x00);
85 const int LogicSignal::TriggerMarkerPadding = 2;
86 const char* LogicSignal::TriggerMarkerIcons[8] = {
88 ":/icons/trigger-marker-low.svg",
89 ":/icons/trigger-marker-high.svg",
90 ":/icons/trigger-marker-rising.svg",
91 ":/icons/trigger-marker-falling.svg",
92 ":/icons/trigger-marker-change.svg",
97 QCache<QString, const QIcon> LogicSignal::icon_cache_;
98 QCache<QString, const QPixmap> LogicSignal::pixmap_cache_;
100 LogicSignal::LogicSignal(
101 pv::Session &session,
102 shared_ptr<devices::Device> device,
103 shared_ptr<data::SignalBase> base) :
104 Signal(session, base),
106 trigger_types_(get_trigger_types()),
107 trigger_none_(nullptr),
108 trigger_rising_(nullptr),
109 trigger_high_(nullptr),
110 trigger_falling_(nullptr),
111 trigger_low_(nullptr),
112 trigger_change_(nullptr)
114 shared_ptr<Trigger> trigger;
116 base_->set_color(SignalColors[base->index() % countof(SignalColors)]);
119 signal_height_ = gs.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
121 /* Populate this channel's trigger setting with whatever we
122 * find in the current session trigger, if anything. */
123 trigger_match_ = nullptr;
124 if ((trigger = session_.session()->trigger()))
125 for (auto stage : trigger->stages())
126 for (auto match : stage->matches())
127 if (match->channel() == base_->channel())
128 trigger_match_ = match->type();
131 shared_ptr<pv::data::SignalData> LogicSignal::data() const
133 return base_->logic_data();
136 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
138 return base_->logic_data();
141 void LogicSignal::save_settings(QSettings &settings) const
143 settings.setValue("trace_height", signal_height_);
146 void LogicSignal::restore_settings(QSettings &settings)
148 if (settings.contains("trace_height")) {
149 const int old_height = signal_height_;
150 signal_height_ = settings.value("trace_height").toInt();
152 if ((signal_height_ != old_height) && owner_) {
153 // Call order is important, otherwise the lazy event handler won't work
154 owner_->extents_changed(false, true);
155 owner_->row_item_appearance_changed(false, true);
160 pair<int, int> LogicSignal::v_extents() const
162 const int signal_margin =
163 QFontMetrics(QApplication::font()).height() / 2;
164 return make_pair(-signal_height_ - signal_margin, signal_margin);
167 void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
171 vector< pair<int64_t, bool> > edges;
176 const int y = get_visual_y();
178 if (!base_->enabled())
181 const float high_offset = y - signal_height_ + 0.5f;
182 const float low_offset = y + 0.5f;
184 shared_ptr<pv::data::LogicSegment> segment = get_logic_segment_to_paint();
185 if (!segment || (segment->get_sample_count() == 0))
188 double samplerate = segment->samplerate();
190 // Show sample rate as 1Hz when it is unknown
191 if (samplerate == 0.0)
194 const double pixels_offset = pp.pixels_offset();
195 const pv::util::Timestamp& start_time = segment->start_time();
196 const int64_t last_sample = (int64_t)segment->get_sample_count() - 1;
197 const double samples_per_pixel = samplerate * pp.scale();
198 const double pixels_per_sample = 1 / samples_per_pixel;
199 const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
200 const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
202 const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
203 (int64_t)0), last_sample);
204 const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
205 (int64_t)0), last_sample);
207 segment->get_subsampled_edges(edges, start_sample, end_sample,
208 samples_per_pixel / Oversampling, base_->index());
209 assert(edges.size() >= 2);
211 // Check whether we need to paint the sampling points
212 GlobalSettings settings;
213 const bool show_sampling_points =
214 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool() &&
215 (samples_per_pixel < 0.25);
217 vector<QRectF> sampling_points;
218 float sampling_point_x = 0.0f;
219 int64_t sampling_point_sample = start_sample;
222 if (show_sampling_points) {
223 sampling_points.reserve(end_sample - start_sample + 1);
224 sampling_point_x = (edges.cbegin()->first / samples_per_pixel - pixels_offset) + pp.left();
228 const unsigned int edge_count = edges.size() - 2;
229 QLineF *const edge_lines = new QLineF[edge_count];
232 for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
233 const float x = ((*i).first / samples_per_pixel -
234 pixels_offset) + pp.left();
235 *line++ = QLineF(x, high_offset, x, low_offset);
237 if (show_sampling_points)
238 while (sampling_point_sample < (*i).first) {
239 const float y = (*i).second ? low_offset : high_offset;
240 sampling_points.emplace_back(
241 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
242 sampling_point_sample++;
243 sampling_point_x += pixels_per_sample;
247 // Calculate the sample points from the last edge to the end of the trace
248 if (show_sampling_points)
249 while ((uint64_t)sampling_point_sample <= end_sample) {
250 // Signal changed after the last edge, so the level is inverted
251 const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
252 sampling_points.emplace_back(
253 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
254 sampling_point_sample++;
255 sampling_point_x += pixels_per_sample;
259 p.drawLines(edge_lines, edge_count);
263 const unsigned int max_cap_line_count = edges.size();
264 QLineF *const cap_lines = new QLineF[max_cap_line_count];
267 paint_caps(p, cap_lines, edges, true, samples_per_pixel,
268 pixels_offset, pp.left(), high_offset);
270 paint_caps(p, cap_lines, edges, false, samples_per_pixel,
271 pixels_offset, pp.left(), low_offset);
275 // Paint the sampling points
276 if (show_sampling_points) {
277 p.setPen(SamplingPointColor);
278 p.drawRects(sampling_points.data(), sampling_points.size());
282 void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
284 if (base_->enabled()) {
285 if (trigger_match_) {
286 // Draw the trigger marker
287 const int y = get_visual_y();
289 for (int32_t type_id : trigger_types_) {
290 const TriggerMatchType *const type =
291 TriggerMatchType::get(type_id);
292 if (trigger_match_ != type || type_id < 0 ||
293 (size_t)type_id >= countof(TriggerMarkerIcons) ||
294 !TriggerMarkerIcons[type_id])
297 const QPixmap *const pixmap = get_pixmap(
298 TriggerMarkerIcons[type_id]);
302 const float pad = TriggerMarkerPadding - 0.5f;
303 const QSize size = pixmap->size();
305 pp.right() - size.width() - pad * 2,
306 y - (signal_height_ + size.height()) / 2);
308 p.setPen(QPen(TriggerMarkerBackgroundColor.darker()));
309 p.setBrush(TriggerMarkerBackgroundColor);
310 p.drawRoundedRect(QRectF(point, size).adjusted(
311 -pad, -pad, pad, pad), pad, pad);
312 p.drawPixmap(point, *pixmap);
318 if (show_hover_marker_)
319 paint_hover_marker(p);
323 void LogicSignal::hover_point_changed(const QPoint &hp)
325 Signal::hover_point_changed(hp);
330 if ((!base_->enabled()) || (hp.x() == 0))
333 // Ignore if mouse cursor is not hovering over this trace
334 const int y = get_visual_y();
335 const pair<int, int> extents = v_extents();
336 if ((hp.y() < (y + extents.first)) || ((hp.y() > (y + extents.second))))
339 shared_ptr<pv::data::LogicSegment> segment = get_logic_segment_to_paint();
340 if (!segment || (segment->get_sample_count() == 0))
343 double samplerate = segment->samplerate();
345 // Show sample rate as 1Hz when it is unknown
346 if (samplerate == 0.0)
349 const View *view = owner_->view();
351 const double scale = view->scale();
352 const double pixels_offset =
353 ((view->offset() - segment->start_time()) / scale).convert_to<double>();
354 const double samples_per_pixel = samplerate * scale;
356 const uint64_t sample_pos = (uint64_t)max(
357 (hp.x() + pixels_offset) * samples_per_pixel, 0.0);
359 vector<data::LogicSegment::EdgePair> edges;
361 segment->get_surrounding_edges(edges, sample_pos,
362 samples_per_pixel / Oversampling, base_->index());
368 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
369 vector< pair<int64_t, bool> > &edges, bool level,
370 double samples_per_pixel, double pixels_offset, float x_offset,
373 QLineF *line = lines;
375 for (auto i = edges.begin(); i != (edges.end() - 1); i++)
376 if ((*i).second == level) {
378 ((*i).first / samples_per_pixel -
379 pixels_offset) + x_offset, y_offset,
380 ((*(i+1)).first / samples_per_pixel -
381 pixels_offset) + x_offset, y_offset);
384 p.drawLines(lines, line - lines);
387 shared_ptr<pv::data::LogicSegment> LogicSignal::get_logic_segment_to_paint() const
389 shared_ptr<pv::data::LogicSegment> segment;
391 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
392 base_->logic_data()->logic_segments();
394 if (!segments.empty()) {
395 if (segment_display_mode_ == ShowLastSegmentOnly) {
396 segment = segments.back();
399 if ((segment_display_mode_ == ShowSingleSegmentOnly) ||
400 (segment_display_mode_ == ShowLastCompleteSegmentOnly)) {
402 segment = segments.at(current_segment_);
403 } catch (out_of_range&) {
404 qDebug() << "Current logic segment out of range for signal" << base_->name() << ":" << current_segment_;
412 void LogicSignal::init_trigger_actions(QWidget *parent)
414 trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
415 tr("No trigger"), parent);
416 trigger_none_->setCheckable(true);
417 connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
419 trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
420 tr("Trigger on rising edge"), parent);
421 trigger_rising_->setCheckable(true);
422 connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
424 trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
425 tr("Trigger on high level"), parent);
426 trigger_high_->setCheckable(true);
427 connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
429 trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
430 tr("Trigger on falling edge"), parent);
431 trigger_falling_->setCheckable(true);
432 connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
434 trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
435 tr("Trigger on low level"), parent);
436 trigger_low_->setCheckable(true);
437 connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
439 trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
440 tr("Trigger on rising or falling edge"), parent);
441 trigger_change_->setCheckable(true);
442 connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
445 const vector<int32_t> LogicSignal::get_trigger_types() const
447 // We may not be associated with a device
449 return vector<int32_t>();
451 const auto sr_dev = device_->device();
452 if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
453 const Glib::VariantContainerBase gvar =
454 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
456 vector<int32_t> ttypes;
458 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
459 Glib::VariantBase tmp_vb;
460 gvar.get_child(tmp_vb, i);
462 Glib::Variant<int32_t> tmp_v =
463 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
465 ttypes.push_back(tmp_v.get());
470 return vector<int32_t>();
474 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
478 action = trigger_none_;
480 switch (type->id()) {
481 case SR_TRIGGER_ZERO:
482 action = trigger_low_;
485 action = trigger_high_;
487 case SR_TRIGGER_RISING:
488 action = trigger_rising_;
490 case SR_TRIGGER_FALLING:
491 action = trigger_falling_;
493 case SR_TRIGGER_EDGE:
494 action = trigger_change_;
504 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
506 if (action == trigger_low_)
507 return TriggerMatchType::ZERO;
508 else if (action == trigger_high_)
509 return TriggerMatchType::ONE;
510 else if (action == trigger_rising_)
511 return TriggerMatchType::RISING;
512 else if (action == trigger_falling_)
513 return TriggerMatchType::FALLING;
514 else if (action == trigger_change_)
515 return TriggerMatchType::EDGE;
520 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
522 Signal::populate_popup_form(parent, form);
524 signal_height_sb_ = new QSpinBox(parent);
525 signal_height_sb_->setRange(5, 1000);
526 signal_height_sb_->setSingleStep(5);
527 signal_height_sb_->setSuffix(tr(" pixels"));
528 signal_height_sb_->setValue(signal_height_);
529 connect(signal_height_sb_, SIGNAL(valueChanged(int)),
530 this, SLOT(on_signal_height_changed(int)));
531 form->addRow(tr("Trace height"), signal_height_sb_);
534 const vector<int32_t> trig_types = get_trigger_types();
536 if (!trig_types.empty()) {
537 trigger_bar_ = new QToolBar(parent);
538 init_trigger_actions(trigger_bar_);
539 trigger_bar_->addAction(trigger_none_);
540 trigger_none_->setChecked(!trigger_match_);
542 for (auto type_id : trig_types) {
543 const TriggerMatchType *const type =
544 TriggerMatchType::get(type_id);
545 QAction *const action = action_from_trigger_type(type);
546 trigger_bar_->addAction(action);
547 action->setChecked(trigger_match_ == type);
550 // Only allow triggers to be changed when we're stopped
551 if (session_.get_capture_state() != Session::Stopped)
552 for (QAction* action : trigger_bar_->findChildren<QAction*>())
553 action->setEnabled(false);
555 form->addRow(tr("Trigger"), trigger_bar_);
559 void LogicSignal::modify_trigger()
561 auto trigger = session_.session()->trigger();
562 auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
565 for (auto stage : trigger->stages()) {
566 const auto &matches = stage->matches();
567 if (none_of(matches.begin(), matches.end(),
568 [&](shared_ptr<TriggerMatch> match) {
569 return match->channel() != base_->channel(); }))
572 auto new_stage = new_trigger->add_stage();
573 for (auto match : stage->matches()) {
574 if (match->channel() == base_->channel())
576 new_stage->add_match(match->channel(), match->type());
581 if (trigger_match_) {
582 // Until we can let the user decide how to group trigger matches
583 // into stages, put all of the matches into a single stage --
584 // most devices only support a single trigger stage.
585 if (new_trigger->stages().empty())
586 new_trigger->add_stage();
588 new_trigger->stages().back()->add_match(base_->channel(),
592 session_.session()->set_trigger(
593 new_trigger->stages().empty() ? nullptr : new_trigger);
596 owner_->row_item_appearance_changed(false, true);
599 const QIcon* LogicSignal::get_icon(const char *path)
601 if (!icon_cache_.contains(path)) {
602 const QIcon *icon = new QIcon(path);
603 icon_cache_.insert(path, icon);
606 return icon_cache_.take(path);
609 const QPixmap* LogicSignal::get_pixmap(const char *path)
611 if (!pixmap_cache_.contains(path)) {
612 const QPixmap *pixmap = new QPixmap(path);
613 pixmap_cache_.insert(path, pixmap);
616 return pixmap_cache_.take(path);
619 void LogicSignal::on_trigger()
623 action_from_trigger_type(trigger_match_)->setChecked(false);
625 action = (QAction *)sender();
626 action->setChecked(true);
627 trigger_match_ = trigger_type_from_action(action);
632 void LogicSignal::on_signal_height_changed(int height)
634 signal_height_ = height;
637 // Call order is important, otherwise the lazy event handler won't work
638 owner_->extents_changed(false, true);
639 owner_->row_item_appearance_changed(false, true);