View: Fix view item positioning
[pulseview.git] / pv / view / 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/session.hpp>
35 #include <pv/devicemanager.hpp>
36 #include <pv/devices/device.hpp>
37 #include <pv/data/logic.hpp>
38 #include <pv/data/logicsegment.hpp>
39 #include <pv/data/signalbase.hpp>
40 #include <pv/view/view.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::pair;
49 using std::shared_ptr;
50 using std::vector;
51
52 using sigrok::ConfigKey;
53 using sigrok::Capability;
54 using sigrok::Error;
55 using sigrok::Trigger;
56 using sigrok::TriggerStage;
57 using sigrok::TriggerMatch;
58 using sigrok::TriggerMatchType;
59
60 namespace pv {
61 namespace views {
62 namespace TraceView {
63
64 const float LogicSignal::Oversampling = 2.0f;
65
66 const QColor LogicSignal::EdgeColour(0x80, 0x80, 0x80);
67 const QColor LogicSignal::HighColour(0x00, 0xC0, 0x00);
68 const QColor LogicSignal::LowColour(0xC0, 0x00, 0x00);
69
70 const QColor LogicSignal::SignalColours[10] = {
71         QColor(0x16, 0x19, 0x1A),       // Black
72         QColor(0x8F, 0x52, 0x02),       // Brown
73         QColor(0xCC, 0x00, 0x00),       // Red
74         QColor(0xF5, 0x79, 0x00),       // Orange
75         QColor(0xED, 0xD4, 0x00),       // Yellow
76         QColor(0x73, 0xD2, 0x16),       // Green
77         QColor(0x34, 0x65, 0xA4),       // Blue
78         QColor(0x75, 0x50, 0x7B),       // Violet
79         QColor(0x88, 0x8A, 0x85),       // Grey
80         QColor(0xEE, 0xEE, 0xEC),       // White
81 };
82
83 QColor LogicSignal::TriggerMarkerBackgroundColour = QColor(0xED, 0xD4, 0x00);
84 const int LogicSignal::TriggerMarkerPadding = 2;
85 const char* LogicSignal::TriggerMarkerIcons[8] = {
86         nullptr,
87         ":/icons/trigger-marker-low.svg",
88         ":/icons/trigger-marker-high.svg",
89         ":/icons/trigger-marker-rising.svg",
90         ":/icons/trigger-marker-falling.svg",
91         ":/icons/trigger-marker-change.svg",
92         nullptr,
93         nullptr
94 };
95
96 QCache<QString, const QIcon> LogicSignal::icon_cache_;
97 QCache<QString, const QPixmap> LogicSignal::pixmap_cache_;
98
99 LogicSignal::LogicSignal(
100         pv::Session &session,
101         shared_ptr<devices::Device> device,
102         shared_ptr<data::SignalBase> base) :
103         Signal(session, base),
104         signal_height_(QFontMetrics(QApplication::font()).height() * 2),
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         /* Populate this channel's trigger setting with whatever we
118          * find in the current session trigger, if anything. */
119         trigger_match_ = nullptr;
120         if ((trigger = session_.session()->trigger()))
121                 for (auto stage : trigger->stages())
122                         for (auto match : stage->matches())
123                                 if (match->channel() == base_->channel())
124                                         trigger_match_ = match->type();
125 }
126
127 shared_ptr<pv::data::SignalData> LogicSignal::data() const
128 {
129         return base_->logic_data();
130 }
131
132 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
133 {
134         return base_->logic_data();
135 }
136
137 std::pair<int, int> LogicSignal::v_extents() const
138 {
139         const int signal_margin =
140                 QFontMetrics(QApplication::font()).height() / 2;
141         return make_pair(-signal_height_ - signal_margin, signal_margin);
142 }
143
144 int LogicSignal::scale_handle_offset() const
145 {
146         return -signal_height_;
147 }
148
149 void LogicSignal::scale_handle_dragged(int offset)
150 {
151         const int font_height = QFontMetrics(QApplication::font()).height();
152         const int units = (-offset / font_height);
153         signal_height_ = ((units < 1) ? 1 : units) * font_height;
154 }
155
156 void LogicSignal::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
157 {
158         QLineF *line;
159
160         vector< pair<int64_t, bool> > edges;
161
162         assert(base_);
163         assert(owner_);
164
165         const int y = get_visual_y();
166
167         if (!base_->enabled())
168                 return;
169
170         const float high_offset = y - signal_height_ + 0.5f;
171         const float low_offset = y + 0.5f;
172
173         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
174                 base_->logic_data()->logic_segments();
175         if (segments.empty())
176                 return;
177
178         const shared_ptr<pv::data::LogicSegment> &segment =
179                 segments.front();
180
181         double samplerate = segment->samplerate();
182
183         // Show sample rate as 1Hz when it is unknown
184         if (samplerate == 0.0)
185                 samplerate = 1.0;
186
187         const double pixels_offset = pp.pixels_offset();
188         const pv::util::Timestamp& start_time = segment->start_time();
189         const int64_t last_sample = segment->get_sample_count() - 1;
190         const double samples_per_pixel = samplerate * pp.scale();
191         const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
192         const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
193
194         const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
195                 (int64_t)0), last_sample);
196         const uint64_t end_sample = min(max(ceil(end).convert_to<int64_t>(),
197                 (int64_t)0), last_sample);
198
199         segment->get_subsampled_edges(edges, start_sample, end_sample,
200                 samples_per_pixel / Oversampling, base_->index());
201         assert(edges.size() >= 2);
202
203         // Paint the edges
204         const unsigned int edge_count = edges.size() - 2;
205         QLineF *const edge_lines = new QLineF[edge_count];
206         line = edge_lines;
207
208         for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
209                 const float x = ((*i).first / samples_per_pixel -
210                         pixels_offset) + pp.left();
211                 *line++ = QLineF(x, high_offset, x, low_offset);
212         }
213
214         p.setPen(EdgeColour);
215         p.drawLines(edge_lines, edge_count);
216         delete[] edge_lines;
217
218         // Paint the caps
219         const unsigned int max_cap_line_count = edges.size();
220         QLineF *const cap_lines = new QLineF[max_cap_line_count];
221
222         p.setPen(HighColour);
223         paint_caps(p, cap_lines, edges, true, samples_per_pixel,
224                 pixels_offset, pp.left(), high_offset);
225         p.setPen(LowColour);
226         paint_caps(p, cap_lines, edges, false, samples_per_pixel,
227                 pixels_offset, pp.left(), low_offset);
228
229         delete[] cap_lines;
230 }
231
232 void LogicSignal::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
233 {
234         // Draw the trigger marker
235         if (!trigger_match_ || !base_->enabled())
236                 return;
237
238         const int y = get_visual_y();
239         const vector<int32_t> trig_types = get_trigger_types();
240         for (int32_t type_id : trig_types) {
241                 const TriggerMatchType *const type =
242                         TriggerMatchType::get(type_id);
243                 if (trigger_match_ != type || type_id < 0 ||
244                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
245                         !TriggerMarkerIcons[type_id])
246                         continue;
247
248                 const QPixmap *const pixmap = get_pixmap(
249                         TriggerMarkerIcons[type_id]);
250                 if (!pixmap)
251                         continue;
252
253                 const float pad = TriggerMarkerPadding - 0.5f;
254                 const QSize size = pixmap->size();
255                 const QPoint point(
256                         pp.right() - size.width() - pad * 2,
257                         y - (signal_height_ + size.height()) / 2);
258
259                 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
260                 p.setBrush(TriggerMarkerBackgroundColour);
261                 p.drawRoundedRect(QRectF(point, size).adjusted(
262                         -pad, -pad, pad, pad), pad, pad);
263                 p.drawPixmap(point, *pixmap);
264
265                 break;
266         }
267 }
268
269 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
270         vector< pair<int64_t, bool> > &edges, bool level,
271         double samples_per_pixel, double pixels_offset, float x_offset,
272         float y_offset)
273 {
274         QLineF *line = lines;
275
276         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
277                 if ((*i).second == level) {
278                         *line++ = QLineF(
279                                 ((*i).first / samples_per_pixel -
280                                         pixels_offset) + x_offset, y_offset,
281                                 ((*(i+1)).first / samples_per_pixel -
282                                         pixels_offset) + x_offset, y_offset);
283                 }
284
285         p.drawLines(lines, line - lines);
286 }
287
288 void LogicSignal::init_trigger_actions(QWidget *parent)
289 {
290         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
291                 tr("No trigger"), parent);
292         trigger_none_->setCheckable(true);
293         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
294
295         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
296                 tr("Trigger on rising edge"), parent);
297         trigger_rising_->setCheckable(true);
298         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
299
300         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
301                 tr("Trigger on high level"), parent);
302         trigger_high_->setCheckable(true);
303         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
304
305         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
306                 tr("Trigger on falling edge"), parent);
307         trigger_falling_->setCheckable(true);
308         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
309
310         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
311                 tr("Trigger on low level"), parent);
312         trigger_low_->setCheckable(true);
313         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
314
315         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
316                 tr("Trigger on rising or falling edge"), parent);
317         trigger_change_->setCheckable(true);
318         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
319 }
320
321 const vector<int32_t> LogicSignal::get_trigger_types() const
322 {
323         const auto sr_dev = device_->device();
324         if (sr_dev->config_check(ConfigKey::TRIGGER_MATCH, Capability::LIST)) {
325                 const Glib::VariantContainerBase gvar =
326                         sr_dev->config_list(ConfigKey::TRIGGER_MATCH);
327
328                 vector<int32_t> ttypes;
329
330                 for (unsigned int i = 0; i < gvar.get_n_children(); i++) {
331                         Glib::VariantBase tmp_vb;
332                         gvar.get_child(tmp_vb, i);
333
334                         Glib::Variant<int32_t> tmp_v =
335                                 Glib::VariantBase::cast_dynamic< Glib::Variant<int32_t> >(tmp_vb);
336
337                         ttypes.push_back(tmp_v.get());
338                 }
339
340                 return ttypes;
341         } else {
342                 return vector<int32_t>();
343         }
344 }
345
346 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
347 {
348         QAction *action;
349
350         action = trigger_none_;
351         if (type) {
352                 switch (type->id()) {
353                 case SR_TRIGGER_ZERO:
354                         action = trigger_low_;
355                         break;
356                 case SR_TRIGGER_ONE:
357                         action = trigger_high_;
358                         break;
359                 case SR_TRIGGER_RISING:
360                         action = trigger_rising_;
361                         break;
362                 case SR_TRIGGER_FALLING:
363                         action = trigger_falling_;
364                         break;
365                 case SR_TRIGGER_EDGE:
366                         action = trigger_change_;
367                         break;
368                 default:
369                         assert(0);
370                 }
371         }
372
373         return action;
374 }
375
376 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
377 {
378         if (action == trigger_low_)
379                 return TriggerMatchType::ZERO;
380         else if (action == trigger_high_)
381                 return TriggerMatchType::ONE;
382         else if (action == trigger_rising_)
383                 return TriggerMatchType::RISING;
384         else if (action == trigger_falling_)
385                 return TriggerMatchType::FALLING;
386         else if (action == trigger_change_)
387                 return TriggerMatchType::EDGE;
388         else
389                 return nullptr;
390 }
391
392 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
393 {
394         Signal::populate_popup_form(parent, form);
395
396         const vector<int32_t> trig_types = get_trigger_types();
397
398         if (!trig_types.empty()) {
399                 trigger_bar_ = new QToolBar(parent);
400                 init_trigger_actions(trigger_bar_);
401                 trigger_bar_->addAction(trigger_none_);
402                 trigger_none_->setChecked(!trigger_match_);
403
404                 for (auto type_id : trig_types) {
405                         const TriggerMatchType *const type =
406                                 TriggerMatchType::get(type_id);
407                         QAction *const action = action_from_trigger_type(type);
408                         trigger_bar_->addAction(action);
409                         action->setChecked(trigger_match_ == type);
410                 }
411                 form->addRow(tr("Trigger"), trigger_bar_);
412         }
413 }
414
415 void LogicSignal::modify_trigger()
416 {
417         auto trigger = session_.session()->trigger();
418         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
419
420         if (trigger) {
421                 for (auto stage : trigger->stages()) {
422                         const auto &matches = stage->matches();
423                         if (std::none_of(matches.begin(), matches.end(),
424                             [&](shared_ptr<TriggerMatch> match) {
425                                         return match->channel() != base_->channel(); }))
426                                 continue;
427
428                         auto new_stage = new_trigger->add_stage();
429                         for (auto match : stage->matches()) {
430                                 if (match->channel() == base_->channel())
431                                         continue;
432                                 new_stage->add_match(match->channel(), match->type());
433                         }
434                 }
435         }
436
437         if (trigger_match_) {
438                 // Until we can let the user decide how to group trigger matches
439                 // into stages, put all of the matches into a single stage --
440                 // most devices only support a single trigger stage.
441                 if (new_trigger->stages().empty())
442                         new_trigger->add_stage();
443
444                 new_trigger->stages().back()->add_match(base_->channel(),
445                         trigger_match_);
446         }
447
448         session_.session()->set_trigger(
449                 new_trigger->stages().empty() ? nullptr : new_trigger);
450
451         if (owner_)
452                 owner_->row_item_appearance_changed(false, true);
453 }
454
455 const QIcon* LogicSignal::get_icon(const char *path)
456 {
457         if (!icon_cache_.contains(path)) {
458                 const QIcon *icon = new QIcon(path);
459                 icon_cache_.insert(path, icon);
460         }
461
462         return icon_cache_.take(path);
463 }
464
465 const QPixmap* LogicSignal::get_pixmap(const char *path)
466 {
467         if (!pixmap_cache_.contains(path)) {
468                 const QPixmap *pixmap = new QPixmap(path);
469                 pixmap_cache_.insert(path, pixmap);
470         }
471
472         return pixmap_cache_.take(path);
473 }
474
475 void LogicSignal::on_trigger()
476 {
477         QAction *action;
478
479         action_from_trigger_type(trigger_match_)->setChecked(false);
480
481         action = (QAction *)sender();
482         action->setChecked(true);
483         trigger_match_ = trigger_type_from_action(action);
484
485         modify_trigger();
486 }
487
488 } // namespace TraceView
489 } // namespace views
490 } // namespace pv