]> sigrok.org Git - pulseview.git/blame_incremental - pv/views/trace/logicsignal.cpp
View: Move comment to where it belongs
[pulseview.git] / pv / views / trace / logicsignal.cpp
... / ...
CommitLineData
1/*
2 * This file is part of the PulseView project.
3 *
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
20#include <extdef.h>
21
22#include <cassert>
23#include <cmath>
24
25#include <algorithm>
26
27#include <QApplication>
28#include <QFormLayout>
29#include <QToolBar>
30
31#include "logicsignal.hpp"
32#include "view.hpp"
33
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>
41
42#include <libsigrokcxx/libsigrokcxx.hpp>
43
44using std::deque;
45using std::max;
46using std::make_pair;
47using std::min;
48using std::none_of;
49using std::out_of_range;
50using std::pair;
51using std::shared_ptr;
52using std::vector;
53
54using sigrok::ConfigKey;
55using sigrok::Capability;
56using sigrok::Trigger;
57using sigrok::TriggerMatch;
58using sigrok::TriggerMatchType;
59
60namespace pv {
61namespace views {
62namespace trace {
63
64const float LogicSignal::Oversampling = 2.0f;
65
66const QColor LogicSignal::EdgeColour(0x80, 0x80, 0x80);
67const QColor LogicSignal::HighColour(0x00, 0xC0, 0x00);
68const QColor LogicSignal::LowColour(0xC0, 0x00, 0x00);
69const QColor LogicSignal::SamplingPointColour(0x77, 0x77, 0x77);
70
71const QColor LogicSignal::SignalColours[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
82};
83
84QColor LogicSignal::TriggerMarkerBackgroundColour = QColor(0xED, 0xD4, 0x00);
85const int LogicSignal::TriggerMarkerPadding = 2;
86const char* LogicSignal::TriggerMarkerIcons[8] = {
87 nullptr,
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",
93 nullptr,
94 nullptr
95};
96
97QCache<QString, const QIcon> LogicSignal::icon_cache_;
98QCache<QString, const QPixmap> LogicSignal::pixmap_cache_;
99
100LogicSignal::LogicSignal(
101 pv::Session &session,
102 shared_ptr<devices::Device> device,
103 shared_ptr<data::SignalBase> base) :
104 Signal(session, base),
105 device_(device),
106 trigger_none_(nullptr),
107 trigger_rising_(nullptr),
108 trigger_high_(nullptr),
109 trigger_falling_(nullptr),
110 trigger_low_(nullptr),
111 trigger_change_(nullptr)
112{
113 shared_ptr<Trigger> trigger;
114
115 base_->set_colour(SignalColours[base->index() % countof(SignalColours)]);
116
117 GlobalSettings gs;
118 signal_height_ = gs.value(GlobalSettings::Key_View_DefaultLogicHeight).toInt();
119
120 /* Populate this channel's trigger setting with whatever we
121 * find in the current session trigger, if anything. */
122 trigger_match_ = nullptr;
123 if ((trigger = session_.session()->trigger()))
124 for (auto stage : trigger->stages())
125 for (auto match : stage->matches())
126 if (match->channel() == base_->channel())
127 trigger_match_ = match->type();
128}
129
130shared_ptr<pv::data::SignalData> LogicSignal::data() const
131{
132 return base_->logic_data();
133}
134
135shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
136{
137 return base_->logic_data();
138}
139
140void LogicSignal::save_settings(QSettings &settings) const
141{
142 settings.setValue("trace_height", signal_height_);
143}
144
145void LogicSignal::restore_settings(QSettings &settings)
146{
147 if (settings.contains("trace_height")) {
148 const int old_height = signal_height_;
149 signal_height_ = settings.value("trace_height").toInt();
150
151 if ((signal_height_ != old_height) && owner_) {
152 // Call order is important, otherwise the lazy event handler won't work
153 owner_->extents_changed(false, true);
154 owner_->row_item_appearance_changed(false, true);
155 }
156 }
157}
158
159pair<int, int> LogicSignal::v_extents() const
160{
161 const int signal_margin =
162 QFontMetrics(QApplication::font()).height() / 2;
163 return make_pair(-signal_height_ - signal_margin, signal_margin);
164}
165
166int LogicSignal::scale_handle_offset() const
167{
168 return -signal_height_;
169}
170
171void LogicSignal::scale_handle_dragged(int offset)
172{
173 const int font_height = QFontMetrics(QApplication::font()).height();
174 const int units = (-offset / font_height);
175 signal_height_ = ((units < 1) ? 1 : units) * font_height;
176}
177
178void LogicSignal::paint_mid(QPainter &p, ViewItemPaintParams &pp)
179{
180 QLineF *line;
181
182 vector< pair<int64_t, bool> > edges;
183
184 assert(base_);
185 assert(owner_);
186
187 const int y = get_visual_y();
188
189 if (!base_->enabled())
190 return;
191
192 const float high_offset = y - signal_height_ + 0.5f;
193 const float low_offset = y + 0.5f;
194
195 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
196 base_->logic_data()->logic_segments();
197 if (segments.empty())
198 return;
199
200 shared_ptr<pv::data::LogicSegment> segment;
201 try {
202 segment = segments.at(current_segment_);
203 } catch (out_of_range) {
204 qDebug() << "Current logic segment out of range for signal" << base_->name();
205 return;
206 }
207
208 double samplerate = segment->samplerate();
209
210 // Show sample rate as 1Hz when it is unknown
211 if (samplerate == 0.0)
212 samplerate = 1.0;
213
214 const double pixels_offset = pp.pixels_offset();
215 const pv::util::Timestamp& start_time = segment->start_time();
216 const int64_t last_sample = segment->get_sample_count() - 1;
217 const double samples_per_pixel = samplerate * pp.scale();
218 const double pixels_per_sample = 1 / samples_per_pixel;
219 const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
220 const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
221
222 const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
223 (int64_t)0), last_sample);
224 const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
225 (int64_t)0), last_sample);
226
227 segment->get_subsampled_edges(edges, start_sample, end_sample,
228 samples_per_pixel / Oversampling, base_->index());
229 assert(edges.size() >= 2);
230
231 // Check whether we need to paint the sampling points
232 GlobalSettings settings;
233 const bool show_sampling_points =
234 settings.value(GlobalSettings::Key_View_ShowSamplingPoints).toBool() &&
235 (samples_per_pixel < 0.25);
236
237 vector<QRectF> sampling_points;
238 float sampling_point_x = 0.0f;
239 int64_t sampling_point_sample = start_sample;
240 const int w = 2;
241
242 if (show_sampling_points) {
243 sampling_points.reserve(end_sample - start_sample + 1);
244 sampling_point_x = (edges.cbegin()->first / samples_per_pixel - pixels_offset) + pp.left();
245 }
246
247 // Paint the edges
248 const unsigned int edge_count = edges.size() - 2;
249 QLineF *const edge_lines = new QLineF[edge_count];
250 line = edge_lines;
251
252 for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
253 const float x = ((*i).first / samples_per_pixel -
254 pixels_offset) + pp.left();
255 *line++ = QLineF(x, high_offset, x, low_offset);
256
257 if (show_sampling_points)
258 while (sampling_point_sample < (*i).first) {
259 const float y = (*i).second ? low_offset : high_offset;
260 sampling_points.emplace_back(
261 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
262 sampling_point_sample++;
263 sampling_point_x += pixels_per_sample;
264 };
265 }
266
267 // Calculate the sample points from the last edge to the end of the trace
268 if (show_sampling_points)
269 while ((uint64_t)sampling_point_sample <= end_sample) {
270 // Signal changed after the last edge, so the level is inverted
271 const float y = (edges.cend() - 1)->second ? high_offset : low_offset;
272 sampling_points.emplace_back(
273 QRectF(sampling_point_x - (w / 2), y - (w / 2), w, w));
274 sampling_point_sample++;
275 sampling_point_x += pixels_per_sample;
276 };
277
278 p.setPen(EdgeColour);
279 p.drawLines(edge_lines, edge_count);
280 delete[] edge_lines;
281
282 // Paint the caps
283 const unsigned int max_cap_line_count = edges.size();
284 QLineF *const cap_lines = new QLineF[max_cap_line_count];
285
286 p.setPen(HighColour);
287 paint_caps(p, cap_lines, edges, true, samples_per_pixel,
288 pixels_offset, pp.left(), high_offset);
289 p.setPen(LowColour);
290 paint_caps(p, cap_lines, edges, false, samples_per_pixel,
291 pixels_offset, pp.left(), low_offset);
292
293 delete[] cap_lines;
294
295 // Paint the sampling points
296 if (show_sampling_points) {
297 p.setPen(SamplingPointColour);
298 p.drawRects(sampling_points.data(), sampling_points.size());
299 }
300}
301
302void LogicSignal::paint_fore(QPainter &p, ViewItemPaintParams &pp)
303{
304 // Draw the trigger marker
305 if (!trigger_match_ || !base_->enabled())
306 return;
307
308 const int y = get_visual_y();
309 const vector<int32_t> trig_types = get_trigger_types();
310 for (int32_t type_id : trig_types) {
311 const TriggerMatchType *const type =
312 TriggerMatchType::get(type_id);
313 if (trigger_match_ != type || type_id < 0 ||
314 (size_t)type_id >= countof(TriggerMarkerIcons) ||
315 !TriggerMarkerIcons[type_id])
316 continue;
317
318 const QPixmap *const pixmap = get_pixmap(
319 TriggerMarkerIcons[type_id]);
320 if (!pixmap)
321 continue;
322
323 const float pad = TriggerMarkerPadding - 0.5f;
324 const QSize size = pixmap->size();
325 const QPoint point(
326 pp.right() - size.width() - pad * 2,
327 y - (signal_height_ + size.height()) / 2);
328
329 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
330 p.setBrush(TriggerMarkerBackgroundColour);
331 p.drawRoundedRect(QRectF(point, size).adjusted(
332 -pad, -pad, pad, pad), pad, pad);
333 p.drawPixmap(point, *pixmap);
334
335 break;
336 }
337}
338
339void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
340 vector< pair<int64_t, bool> > &edges, bool level,
341 double samples_per_pixel, double pixels_offset, float x_offset,
342 float y_offset)
343{
344 QLineF *line = lines;
345
346 for (auto i = edges.begin(); i != (edges.end() - 1); i++)
347 if ((*i).second == level) {
348 *line++ = QLineF(
349 ((*i).first / samples_per_pixel -
350 pixels_offset) + x_offset, y_offset,
351 ((*(i+1)).first / samples_per_pixel -
352 pixels_offset) + x_offset, y_offset);
353 }
354
355 p.drawLines(lines, line - lines);
356}
357
358void LogicSignal::init_trigger_actions(QWidget *parent)
359{
360 trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
361 tr("No trigger"), parent);
362 trigger_none_->setCheckable(true);
363 connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
364
365 trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
366 tr("Trigger on rising edge"), parent);
367 trigger_rising_->setCheckable(true);
368 connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
369
370 trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
371 tr("Trigger on high level"), parent);
372 trigger_high_->setCheckable(true);
373 connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
374
375 trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
376 tr("Trigger on falling edge"), parent);
377 trigger_falling_->setCheckable(true);
378 connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
379
380 trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
381 tr("Trigger on low level"), parent);
382 trigger_low_->setCheckable(true);
383 connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
384
385 trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
386 tr("Trigger on rising or falling edge"), parent);
387 trigger_change_->setCheckable(true);
388 connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
389}
390
391const vector<int32_t> LogicSignal::get_trigger_types() const
392{
393 // We may not be associated with a device
394 if (!device_)
395 return vector<int32_t>();
396
397 const auto sr_dev = device_->device();
398 if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
399 const Glib::VariantContainerBase gvar =
400 sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
401
402 vector<int32_t> ttypes;
403
404 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
405 Glib::VariantBase tmp_vb;
406 gvar.get_child(tmp_vb, i);
407
408 Glib::Variant<int32_t> tmp_v =
409 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
410
411 ttypes.push_back(tmp_v.get());
412 }
413
414 return ttypes;
415 } else {
416 return vector<int32_t>();
417 }
418}
419
420QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
421{
422 QAction *action;
423
424 action = trigger_none_;
425 if (type) {
426 switch (type->id()) {
427 case SR_TRIGGER_ZERO:
428 action = trigger_low_;
429 break;
430 case SR_TRIGGER_ONE:
431 action = trigger_high_;
432 break;
433 case SR_TRIGGER_RISING:
434 action = trigger_rising_;
435 break;
436 case SR_TRIGGER_FALLING:
437 action = trigger_falling_;
438 break;
439 case SR_TRIGGER_EDGE:
440 action = trigger_change_;
441 break;
442 default:
443 assert(false);
444 }
445 }
446
447 return action;
448}
449
450const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
451{
452 if (action == trigger_low_)
453 return TriggerMatchType::ZERO;
454 else if (action == trigger_high_)
455 return TriggerMatchType::ONE;
456 else if (action == trigger_rising_)
457 return TriggerMatchType::RISING;
458 else if (action == trigger_falling_)
459 return TriggerMatchType::FALLING;
460 else if (action == trigger_change_)
461 return TriggerMatchType::EDGE;
462 else
463 return nullptr;
464}
465
466void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
467{
468 Signal::populate_popup_form(parent, form);
469
470 signal_height_sb_ = new QSpinBox(parent);
471 signal_height_sb_->setRange(5, 1000);
472 signal_height_sb_->setSingleStep(5);
473 signal_height_sb_->setSuffix(tr(" pixels"));
474 signal_height_sb_->setValue(signal_height_);
475 connect(signal_height_sb_, SIGNAL(valueChanged(int)),
476 this, SLOT(on_signal_height_changed(int)));
477 form->addRow(tr("Trace height"), signal_height_sb_);
478
479 // Trigger settings
480 const vector<int32_t> trig_types = get_trigger_types();
481
482 if (!trig_types.empty()) {
483 trigger_bar_ = new QToolBar(parent);
484 init_trigger_actions(trigger_bar_);
485 trigger_bar_->addAction(trigger_none_);
486 trigger_none_->setChecked(!trigger_match_);
487
488 for (auto type_id : trig_types) {
489 const TriggerMatchType *const type =
490 TriggerMatchType::get(type_id);
491 QAction *const action = action_from_trigger_type(type);
492 trigger_bar_->addAction(action);
493 action->setChecked(trigger_match_ == type);
494 }
495 form->addRow(tr("Trigger"), trigger_bar_);
496 }
497}
498
499void LogicSignal::modify_trigger()
500{
501 auto trigger = session_.session()->trigger();
502 auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
503
504 if (trigger) {
505 for (auto stage : trigger->stages()) {
506 const auto &matches = stage->matches();
507 if (none_of(matches.begin(), matches.end(),
508 [&](shared_ptr<TriggerMatch> match) {
509 return match->channel() != base_->channel(); }))
510 continue;
511
512 auto new_stage = new_trigger->add_stage();
513 for (auto match : stage->matches()) {
514 if (match->channel() == base_->channel())
515 continue;
516 new_stage->add_match(match->channel(), match->type());
517 }
518 }
519 }
520
521 if (trigger_match_) {
522 // Until we can let the user decide how to group trigger matches
523 // into stages, put all of the matches into a single stage --
524 // most devices only support a single trigger stage.
525 if (new_trigger->stages().empty())
526 new_trigger->add_stage();
527
528 new_trigger->stages().back()->add_match(base_->channel(),
529 trigger_match_);
530 }
531
532 session_.session()->set_trigger(
533 new_trigger->stages().empty() ? nullptr : new_trigger);
534
535 if (owner_)
536 owner_->row_item_appearance_changed(false, true);
537}
538
539const QIcon* LogicSignal::get_icon(const char *path)
540{
541 if (!icon_cache_.contains(path)) {
542 const QIcon *icon = new QIcon(path);
543 icon_cache_.insert(path, icon);
544 }
545
546 return icon_cache_.take(path);
547}
548
549const QPixmap* LogicSignal::get_pixmap(const char *path)
550{
551 if (!pixmap_cache_.contains(path)) {
552 const QPixmap *pixmap = new QPixmap(path);
553 pixmap_cache_.insert(path, pixmap);
554 }
555
556 return pixmap_cache_.take(path);
557}
558
559void LogicSignal::on_trigger()
560{
561 QAction *action;
562
563 action_from_trigger_type(trigger_match_)->setChecked(false);
564
565 action = (QAction *)sender();
566 action->setChecked(true);
567 trigger_match_ = trigger_type_from_action(action);
568
569 modify_trigger();
570}
571
572void LogicSignal::on_signal_height_changed(int height)
573{
574 signal_height_ = height;
575
576 if (owner_) {
577 // Call order is important, otherwise the lazy event handler won't work
578 owner_->extents_changed(false, true);
579 owner_->row_item_appearance_changed(false, true);
580 }
581}
582
583} // namespace trace
584} // namespace views
585} // namespace pv