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