Header: Make get_mouse_over_item return shared_ptr<ViewItem>
[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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #include <extdef.h>
22
23 #include <cassert>
24 #include <cmath>
25
26 #include <algorithm>
27
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/data/logic.hpp>
37 #include <pv/data/logicsegment.hpp>
38 #include <pv/view/view.hpp>
39
40 #include <libsigrok/libsigrok.hpp>
41
42 using std::deque;
43 using std::max;
44 using std::make_pair;
45 using std::min;
46 using std::pair;
47 using std::shared_ptr;
48 using std::vector;
49
50 using sigrok::Channel;
51 using sigrok::ConfigKey;
52 using sigrok::Device;
53 using sigrok::Error;
54 using sigrok::Trigger;
55 using sigrok::TriggerStage;
56 using sigrok::TriggerMatch;
57 using sigrok::TriggerMatchType;
58
59 namespace pv {
60 namespace view {
61
62 const int LogicSignal::SignalHeight = 30;
63 const int LogicSignal::SignalMargin = 10;
64
65 const float LogicSignal::Oversampling = 2.0f;
66
67 const QColor LogicSignal::EdgeColour(0x80, 0x80, 0x80);
68 const QColor LogicSignal::HighColour(0x00, 0xC0, 0x00);
69 const QColor LogicSignal::LowColour(0xC0, 0x00, 0x00);
70
71 const 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
84 QColor LogicSignal::TriggerMarkerBackgroundColour = 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<Device> device,
103         shared_ptr<Channel> channel,
104         shared_ptr<data::Logic> data) :
105         Signal(session, channel),
106         device_(device),
107         data_(data),
108         trigger_none_(NULL),
109         trigger_rising_(NULL),
110         trigger_high_(NULL),
111         trigger_falling_(NULL),
112         trigger_low_(NULL),
113         trigger_change_(NULL)
114 {
115         shared_ptr<Trigger> trigger;
116
117         colour_ = SignalColours[channel->index() % countof(SignalColours)];
118
119         /* Populate this channel's trigger setting with whatever we
120          * find in the current session trigger, if anything. */
121         trigger_match_ = nullptr;
122         if ((trigger = session_.session()->trigger()))
123                 for (auto stage : trigger->stages())
124                         for (auto match : stage->matches())
125                                 if (match->channel() == channel_)
126                                         trigger_match_ = match->type();
127 }
128
129 LogicSignal::~LogicSignal()
130 {
131 }
132
133 shared_ptr<pv::data::SignalData> LogicSignal::data() const
134 {
135         return data_;
136 }
137
138 shared_ptr<pv::data::Logic> LogicSignal::logic_data() const
139 {
140         return data_;
141 }
142
143 std::pair<int, int> LogicSignal::v_extents() const
144 {
145         return make_pair(-SignalHeight - SignalMargin, SignalMargin);
146 }
147
148 void LogicSignal::paint_back(QPainter &p, const ViewItemPaintParams &pp)
149 {
150         if (channel_->enabled())
151                 paint_axis(p, pp, get_visual_y());
152 }
153
154 void LogicSignal::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
155 {
156         QLineF *line;
157
158         vector< pair<int64_t, bool> > edges;
159
160         assert(channel_);
161         assert(data_);
162         assert(owner_);
163
164         const int y = get_visual_y();
165
166         if (!channel_->enabled())
167                 return;
168
169         const float high_offset = y - SignalHeight + 0.5f;
170         const float low_offset = y + 0.5f;
171
172         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
173                 data_->logic_segments();
174         if (segments.empty())
175                 return;
176
177         const shared_ptr<pv::data::LogicSegment> &segment =
178                 segments.front();
179
180         double samplerate = segment->samplerate();
181
182         // Show sample rate as 1Hz when it is unknown
183         if (samplerate == 0.0)
184                 samplerate = 1.0;
185
186         const double pixels_offset = pp.pixels_offset();
187         const double start_time = segment->start_time();
188         const int64_t last_sample = segment->get_sample_count() - 1;
189         const double samples_per_pixel = samplerate * pp.scale();
190         const double start = samplerate * (pp.offset() - start_time);
191         const double end = start + samples_per_pixel * pp.width();
192
193         segment->get_subsampled_edges(edges,
194                 min(max((int64_t)floor(start), (int64_t)0), last_sample),
195                 min(max((int64_t)ceil(end), (int64_t)0), last_sample),
196                 samples_per_pixel / Oversampling, channel_->index());
197         assert(edges.size() >= 2);
198
199         // Paint the edges
200         const unsigned int edge_count = edges.size() - 2;
201         QLineF *const edge_lines = new QLineF[edge_count];
202         line = edge_lines;
203
204         for (auto i = edges.cbegin() + 1; i != edges.cend() - 1; i++) {
205                 const float x = ((*i).first / samples_per_pixel -
206                         pixels_offset) + pp.left();
207                 *line++ = QLineF(x, high_offset, x, low_offset);
208         }
209
210         p.setPen(EdgeColour);
211         p.drawLines(edge_lines, edge_count);
212         delete[] edge_lines;
213
214         // Paint the caps
215         const unsigned int max_cap_line_count = edges.size();
216         QLineF *const cap_lines = new QLineF[max_cap_line_count];
217
218         p.setPen(HighColour);
219         paint_caps(p, cap_lines, edges, true, samples_per_pixel,
220                 pixels_offset, pp.left(), high_offset);
221         p.setPen(LowColour);
222         paint_caps(p, cap_lines, edges, false, samples_per_pixel,
223                 pixels_offset, pp.left(), low_offset);
224
225         delete[] cap_lines;
226 }
227
228 void LogicSignal::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
229 {
230         // Draw the trigger marker
231         if (!trigger_match_)
232                 return;
233
234         const int y = get_visual_y();
235         const vector<int32_t> trig_types = get_trigger_types();
236         for (int32_t type_id : trig_types) {
237                 const TriggerMatchType *const type =
238                         TriggerMatchType::get(type_id);
239                 if (trigger_match_ != type || type_id < 0 ||
240                         (size_t)type_id >= countof(TriggerMarkerIcons) ||
241                         !TriggerMarkerIcons[type_id])
242                         continue;
243
244                 const QPixmap *const pixmap = get_pixmap(
245                         TriggerMarkerIcons[type_id]);
246                 if (!pixmap)
247                         continue;
248
249                 const float pad = TriggerMarkerPadding - 0.5f;
250                 const QSize size = pixmap->size();
251                 const QPoint point(
252                         pp.right() - size.width() - pad * 2,
253                         y - (SignalHeight + size.height()) / 2);
254
255                 p.setPen(QPen(TriggerMarkerBackgroundColour.darker()));
256                 p.setBrush(TriggerMarkerBackgroundColour);
257                 p.drawRoundedRect(QRectF(point, size).adjusted(
258                         -pad, -pad, pad, pad), pad, pad);
259                 p.drawPixmap(point, *pixmap);
260
261                 break;
262         }
263 }
264
265 void LogicSignal::paint_caps(QPainter &p, QLineF *const lines,
266         vector< pair<int64_t, bool> > &edges, bool level,
267         double samples_per_pixel, double pixels_offset, float x_offset,
268         float y_offset)
269 {
270         QLineF *line = lines;
271
272         for (auto i = edges.begin(); i != (edges.end() - 1); i++)
273                 if ((*i).second == level) {
274                         *line++ = QLineF(
275                                 ((*i).first / samples_per_pixel -
276                                         pixels_offset) + x_offset, y_offset,
277                                 ((*(i+1)).first / samples_per_pixel -
278                                         pixels_offset) + x_offset, y_offset);
279                 }
280
281         p.drawLines(lines, line - lines);
282 }
283
284 void LogicSignal::init_trigger_actions(QWidget *parent)
285 {
286         trigger_none_ = new QAction(*get_icon(":/icons/trigger-none.svg"),
287                 tr("No trigger"), parent);
288         trigger_none_->setCheckable(true);
289         connect(trigger_none_, SIGNAL(triggered()), this, SLOT(on_trigger()));
290
291         trigger_rising_ = new QAction(*get_icon(":/icons/trigger-rising.svg"),
292                 tr("Trigger on rising edge"), parent);
293         trigger_rising_->setCheckable(true);
294         connect(trigger_rising_, SIGNAL(triggered()), this, SLOT(on_trigger()));
295
296         trigger_high_ = new QAction(*get_icon(":/icons/trigger-high.svg"),
297                 tr("Trigger on high level"), parent);
298         trigger_high_->setCheckable(true);
299         connect(trigger_high_, SIGNAL(triggered()), this, SLOT(on_trigger()));
300
301         trigger_falling_ = new QAction(*get_icon(":/icons/trigger-falling.svg"),
302                 tr("Trigger on falling edge"), parent);
303         trigger_falling_->setCheckable(true);
304         connect(trigger_falling_, SIGNAL(triggered()), this, SLOT(on_trigger()));
305
306         trigger_low_ = new QAction(*get_icon(":/icons/trigger-low.svg"),
307                 tr("Trigger on low level"), parent);
308         trigger_low_->setCheckable(true);
309         connect(trigger_low_, SIGNAL(triggered()), this, SLOT(on_trigger()));
310
311         trigger_change_ = new QAction(*get_icon(":/icons/trigger-change.svg"),
312                 tr("Trigger on rising or falling edge"), parent);
313         trigger_change_->setCheckable(true);
314         connect(trigger_change_, SIGNAL(triggered()), this, SLOT(on_trigger()));
315 }
316
317 const vector<int32_t> LogicSignal::get_trigger_types() const
318 {
319         try {
320                 const Glib::VariantContainerBase gvar =
321                         device_->config_list(ConfigKey::TRIGGER_MATCH);
322                 return Glib::VariantBase::cast_dynamic<
323                         Glib::Variant<vector<int32_t>>>(gvar).get();
324         } catch (Error e) {
325                 return vector<int32_t>();
326         }
327 }
328
329 QAction* LogicSignal::action_from_trigger_type(const TriggerMatchType *type)
330 {
331         QAction *action;
332
333         action = trigger_none_;
334         if (type) {
335                 switch (type->id()) {
336                 case SR_TRIGGER_ZERO:
337                         action = trigger_low_;
338                         break;
339                 case SR_TRIGGER_ONE:
340                         action = trigger_high_;
341                         break;
342                 case SR_TRIGGER_RISING:
343                         action = trigger_rising_;
344                         break;
345                 case SR_TRIGGER_FALLING:
346                         action = trigger_falling_;
347                         break;
348                 case SR_TRIGGER_EDGE:
349                         action = trigger_change_;
350                         break;
351                 default:
352                         assert(0);
353                 }
354         }
355
356         return action;
357 }
358
359 const TriggerMatchType *LogicSignal::trigger_type_from_action(QAction *action)
360 {
361         if (action == trigger_low_)
362                 return TriggerMatchType::ZERO;
363         else if (action == trigger_high_)
364                 return TriggerMatchType::ONE;
365         else if (action == trigger_rising_)
366                 return TriggerMatchType::RISING;
367         else if (action == trigger_falling_)
368                 return TriggerMatchType::FALLING;
369         else if (action == trigger_change_)
370                 return TriggerMatchType::EDGE;
371         else
372                 return nullptr;
373 }
374
375 void LogicSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
376 {
377         Signal::populate_popup_form(parent, form);
378
379         trigger_bar_ = new QToolBar(parent);
380         init_trigger_actions(trigger_bar_);
381         trigger_bar_->addAction(trigger_none_);
382         trigger_none_->setChecked(!trigger_match_);
383
384         const vector<int32_t> trig_types = get_trigger_types();
385         for (auto type_id : trig_types) {
386                 const TriggerMatchType *const type =
387                         TriggerMatchType::get(type_id);
388                 QAction *const action = action_from_trigger_type(type);
389                 trigger_bar_->addAction(action);
390                 action->setChecked(trigger_match_ == type);
391         }
392         form->addRow(tr("Trigger"), trigger_bar_);
393
394 }
395
396 void LogicSignal::modify_trigger()
397 {
398         auto trigger = session_.session()->trigger();
399         auto new_trigger = session_.device_manager().context()->create_trigger("pulseview");
400
401         if (trigger) {
402                 for (auto stage : trigger->stages()) {
403                         const auto &matches = stage->matches();
404                         if (std::none_of(begin(matches), end(matches),
405                             [&](shared_ptr<TriggerMatch> match) {
406                                         return match->channel() != channel_; }))
407                                 continue;
408
409                         auto new_stage = new_trigger->add_stage();
410                         for (auto match : stage->matches()) {
411                                 if (match->channel() == channel_)
412                                         continue;
413                                 new_stage->add_match(match->channel(), match->type());
414                         }
415                 }
416         }
417
418         if (trigger_match_)
419                 new_trigger->add_stage()->add_match(channel_, trigger_match_);
420
421         session_.session()->set_trigger(
422                 new_trigger->stages().empty() ? nullptr : new_trigger);
423
424         if (owner_)
425                 owner_->row_item_appearance_changed(false, true);
426 }
427
428 const QIcon* LogicSignal::get_icon(const char *path)
429 {
430         const QIcon *icon = icon_cache_.take(path);
431         if (!icon) {
432                 icon = new QIcon(path);
433                 icon_cache_.insert(path, icon);
434         }
435
436         return icon;
437 }
438
439 const QPixmap* LogicSignal::get_pixmap(const char *path)
440 {
441         const QPixmap *pixmap = pixmap_cache_.take(path);
442         if (!pixmap) {
443                 pixmap = new QPixmap(path);
444                 pixmap_cache_.insert(path, pixmap);
445         }
446
447         return pixmap;
448 }
449
450 void LogicSignal::on_trigger()
451 {
452         QAction *action;
453
454         action_from_trigger_type(trigger_match_)->setChecked(false);
455
456         action = (QAction *)sender();
457         action->setChecked(true);
458         trigger_match_ = trigger_type_from_action(action);
459
460         modify_trigger();
461 }
462
463 } // namespace view
464 } // namespace pv