]> sigrok.org Git - pulseview.git/blame - pv/view/decodetrace.cpp
Extract only the subset of annotations that are in view.
[pulseview.git] / pv / view / decodetrace.cpp
CommitLineData
55d3603d
JH
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
21extern "C" {
22#include <libsigrokdecode/libsigrokdecode.h>
23}
24
06bb4e6a
JH
25#include <extdef.h>
26
b213ef09
JH
27#include <boost/foreach.hpp>
28
c51482b3 29#include <QAction>
d7c0ca4a 30#include <QApplication>
4e5a4405
JH
31#include <QComboBox>
32#include <QFormLayout>
33#include <QLabel>
b213ef09 34#include <QMenu>
ce94e4fd 35#include <QPushButton>
c51482b3 36
b9329558 37#include "decodetrace.h"
55d3603d 38
06bb4e6a 39#include <pv/sigsession.h>
6e89374a 40#include <pv/data/decoderstack.h>
7491a29f 41#include <pv/data/decode/decoder.h>
5dfeb70f
JH
42#include <pv/data/logic.h>
43#include <pv/data/logicsnapshot.h>
06e810f2 44#include <pv/data/decode/annotation.h>
4e5a4405 45#include <pv/view/logicsignal.h>
e0fc5810 46#include <pv/view/view.h>
204bae45 47#include <pv/widgets/decodergroupbox.h>
ce94e4fd 48#include <pv/widgets/decodermenu.h>
119aff65 49
819f4c25
JH
50using boost::dynamic_pointer_cast;
51using boost::shared_ptr;
52using std::list;
53using std::max;
54using std::map;
55using std::min;
56using std::vector;
55d3603d
JH
57
58namespace pv {
59namespace view {
60
b9329558 61const QColor DecodeTrace::DecodeColours[4] = {
06bb4e6a
JH
62 QColor(0xEF, 0x29, 0x29), // Red
63 QColor(0xFC, 0xE9, 0x4F), // Yellow
64 QColor(0x8A, 0xE2, 0x34), // Green
65 QColor(0x72, 0x9F, 0xCF) // Blue
66};
67
b9329558 68const QColor DecodeTrace::ErrorBgColour = QColor(0xEF, 0x29, 0x29);
5dfeb70f 69const QColor DecodeTrace::NoDecodeColour = QColor(0x88, 0x8A, 0x85);
ad50ac1a 70
06e810f2
JH
71const double DecodeTrace::EndCapWidth = 5;
72const int DecodeTrace::DrawPadding = 100;
73
74const QColor DecodeTrace::Colours[7] = {
75 QColor(0xFC, 0xE9, 0x4F), // Light Butter
76 QColor(0xFC, 0xAF, 0x3E), // Light Orange
77 QColor(0xE9, 0xB9, 0x6E), // Light Chocolate
78 QColor(0x8A, 0xE2, 0x34), // Light Green
79 QColor(0x72, 0x9F, 0xCF), // Light Blue
80 QColor(0xAD, 0x7F, 0xA8), // Light Plum
81 QColor(0xEF, 0x29, 0x29) // Light Red
82};
83
b9329558 84DecodeTrace::DecodeTrace(pv::SigSession &session,
6e89374a 85 boost::shared_ptr<pv::data::DecoderStack> decoder_stack, int index) :
27e8df22
JH
86 Trace(session, QString::fromUtf8(
87 decoder_stack->stack().front()->decoder()->name)),
613d097c
JH
88 _decoder_stack(decoder_stack),
89 _delete_mapper(this)
55d3603d 90{
6e89374a 91 assert(_decoder_stack);
e0fc5810 92
06bb4e6a 93 _colour = DecodeColours[index % countof(DecodeColours)];
9cef9567 94
6e89374a 95 connect(_decoder_stack.get(), SIGNAL(new_decode_data()),
9cef9567 96 this, SLOT(on_new_decode_data()));
613d097c
JH
97 connect(&_delete_mapper, SIGNAL(mapped(int)),
98 this, SLOT(on_delete_decoder(int)));
55d3603d
JH
99}
100
b9329558 101bool DecodeTrace::enabled() const
55d3603d
JH
102{
103 return true;
104}
105
6e89374a 106const boost::shared_ptr<pv::data::DecoderStack>& DecodeTrace::decoder() const
b6b267bb 107{
6e89374a 108 return _decoder_stack;
b6b267bb
JH
109}
110
b9329558 111void DecodeTrace::set_view(pv::view::View *view)
e0fc5810
JH
112{
113 assert(view);
114 Trace::set_view(view);
115}
116
b9329558 117void DecodeTrace::paint_back(QPainter &p, int left, int right)
fe08b6e8 118{
5dfeb70f 119 Trace::paint_back(p, left, right);
fe08b6e8
JH
120 paint_axis(p, get_y(), left, right);
121}
122
b9329558 123void DecodeTrace::paint_mid(QPainter &p, int left, int right)
55d3603d 124{
06e810f2 125 using pv::data::decode::Annotation;
9472f447 126
9472f447
JH
127 const double scale = _view->scale();
128 assert(scale > 0);
129
9d28da5a 130 double samplerate = _decoder_stack->samplerate();
9472f447
JH
131
132 // Show sample rate as 1Hz when it is unknown
133 if (samplerate == 0.0)
134 samplerate = 1.0;
135
136 const double pixels_offset = (_view->offset() -
6e89374a 137 _decoder_stack->get_start_time()) / scale;
9472f447
JH
138 const double samples_per_pixel = samplerate * scale;
139
92421299
JH
140 const uint64_t start_sample = (uint64_t)max((left + pixels_offset) *
141 samples_per_pixel, 0.0);
142 const uint64_t end_sample = (uint64_t)max((right + pixels_offset) *
143 samples_per_pixel, 0.0);
144
d7c0ca4a
JH
145 QFontMetrics m(QApplication::font());
146 const int h = (m.boundingRect(QRect(), 0, "Tg").height() * 5) / 4;
5dfeb70f
JH
147
148 assert(_decoder_stack);
149 const QString err = _decoder_stack->error_message();
150 if (!err.isEmpty())
151 {
152 draw_error(p, err, left, right);
153 draw_unresolved_period(p, h, left, right, samples_per_pixel,
154 pixels_offset);
155 return;
156 }
157
158 assert(_view);
159 const int y = get_y();
160
6e89374a 161 assert(_decoder_stack);
92421299
JH
162 vector<Annotation> annotations;
163 _decoder_stack->get_annotation_subset(annotations,
164 start_sample, end_sample);
7e674e43 165
92421299
JH
166 BOOST_FOREACH(const Annotation &a, annotations)
167 {
bc870bcf
UH
168 // Every stacked PD is 60 pixels further down.
169 int y_stack_offset = a.pd_index() * 60;
170
7e674e43
UH
171 // Every annotation row is 20 pixels further down.
172 int y_ann_row_offset = a.row() * 20;
173
06e810f2 174 draw_annotation(a, p, get_text_colour(), h, left, right,
7e674e43 175 samples_per_pixel, pixels_offset,
bc870bcf 176 y + y_stack_offset + y_ann_row_offset);
7e674e43 177 }
5dfeb70f
JH
178
179 draw_unresolved_period(p, h, left, right,
180 samples_per_pixel, pixels_offset);
55d3603d
JH
181}
182
b9329558 183void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
4e5a4405 184{
613d097c
JH
185 using pv::data::decode::Decoder;
186
4e5a4405
JH
187 assert(form);
188 assert(parent);
6e89374a 189 assert(_decoder_stack);
4e5a4405 190
7491a29f 191 // Add the standard options
4e5a4405
JH
192 Trace::populate_popup_form(parent, form);
193
7491a29f
JH
194 // Add the decoder options
195 _bindings.clear();
196 _probe_selectors.clear();
4e5a4405 197
613d097c 198 const list< shared_ptr<Decoder> >& stack = _decoder_stack->stack();
4e5a4405 199
5069084a
JH
200 if (stack.empty())
201 {
202 QLabel *const l = new QLabel(
203 tr("<p><i>No decoders in the stack</i></p>"));
204 l->setAlignment(Qt::AlignCenter);
205 form->addRow(l);
206 }
207 else
208 {
209 list< shared_ptr<Decoder> >::const_iterator iter =
210 stack.begin();
211 for (int i = 0; i < (int)stack.size(); i++, iter++) {
212 shared_ptr<Decoder> dec(*iter);
213 create_decoder_form(i, dec, parent, form);
214 }
215
216 form->addRow(new QLabel(
217 tr("<i>* Required Probes</i>"), parent));
218 }
4e5a4405 219
ce94e4fd 220 // Add stacking button
ce94e4fd
JH
221 pv::widgets::DecoderMenu *const decoder_menu =
222 new pv::widgets::DecoderMenu(parent);
7491a29f
JH
223 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
224 this, SLOT(on_stack_decoder(srd_decoder*)));
225
226 QPushButton *const stack_button =
227 new QPushButton(tr("Stack Decoder"), parent);
ce94e4fd
JH
228 stack_button->setMenu(decoder_menu);
229
230 QHBoxLayout *stack_button_box = new QHBoxLayout;
231 stack_button_box->addWidget(stack_button, 0, Qt::AlignRight);
232 form->addRow(stack_button_box);
4e5a4405
JH
233}
234
b9329558 235QMenu* DecodeTrace::create_context_menu(QWidget *parent)
c51482b3
JH
236{
237 QMenu *const menu = Trace::create_context_menu(parent);
238
239 menu->addSeparator();
240
241 QAction *const del = new QAction(tr("Delete"), this);
a2d21018 242 del->setShortcuts(QKeySequence::Delete);
c51482b3
JH
243 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
244 menu->addAction(del);
245
246 return menu;
247}
248
06e810f2
JH
249void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
250 QColor text_color, int h, int left, int right, double samples_per_pixel,
251 double pixels_offset, int y) const
252{
253 const double start = a.start_sample() / samples_per_pixel -
254 pixels_offset;
255 const double end = a.end_sample() / samples_per_pixel -
256 pixels_offset;
257 const QColor fill = Colours[(a.format() * (countof(Colours) / 2 + 1)) %
258 countof(Colours)];
259 const QColor outline(fill.darker());
260
261 if (start > right + DrawPadding || end < left - DrawPadding)
262 return;
263
264 if (a.start_sample() == a.end_sample())
265 draw_instant(a, p, fill, outline, text_color, h,
266 start, y);
267 else
268 draw_range(a, p, fill, outline, text_color, h,
269 start, end, y);
270}
271
272void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
273 QColor fill, QColor outline, QColor text_color, int h, double x, int y) const
274{
275 const QString text = a.annotations().empty() ?
276 QString() : a.annotations().back();
277 const double w = min(p.boundingRect(QRectF(), 0, text).width(),
278 0.0) + h;
279 const QRectF rect(x - w / 2, y - h / 2, w, h);
280
281 p.setPen(outline);
282 p.setBrush(fill);
283 p.drawRoundedRect(rect, h / 2, h / 2);
284
285 p.setPen(text_color);
286 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
287}
288
289void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
290 QColor fill, QColor outline, QColor text_color, int h, double start,
291 double end, int y) const
292{
293 const double top = y + .5 - h / 2;
294 const double bottom = y + .5 + h / 2;
295 const vector<QString> annotations = a.annotations();
296
297 p.setPen(outline);
298 p.setBrush(fill);
299
300 // If the two ends are within 1 pixel, draw a vertical line
301 if (start + 1.0 > end)
302 {
303 p.drawLine(QPointF(start, top), QPointF(start, bottom));
304 return;
305 }
306
307 const double cap_width = min((end - start) / 4, EndCapWidth);
308
309 QPointF pts[] = {
310 QPointF(start, y + .5f),
311 QPointF(start + cap_width, top),
312 QPointF(end - cap_width, top),
313 QPointF(end, y + .5f),
314 QPointF(end - cap_width, bottom),
315 QPointF(start + cap_width, bottom)
316 };
317
318 p.drawConvexPolygon(pts, countof(pts));
319
320 if (annotations.empty())
321 return;
322
323 QRectF rect(start + cap_width, y - h / 2,
324 end - start - cap_width * 2, h);
325 p.setPen(text_color);
326
327 // Try to find an annotation that will fit
328 QString best_annotation;
329 int best_width = 0;
330
331 BOOST_FOREACH(const QString &a, annotations) {
332 const int w = p.boundingRect(QRectF(), 0, a).width();
333 if (w <= rect.width() && w > best_width)
334 best_annotation = a, best_width = w;
335 }
336
337 if (best_annotation.isEmpty())
338 best_annotation = annotations.back();
339
340 // If not ellide the last in the list
341 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
342 best_annotation, Qt::ElideRight, rect.width()));
343}
344
b9329558 345void DecodeTrace::draw_error(QPainter &p, const QString &message,
ad50ac1a
JH
346 int left, int right)
347{
348 const int y = get_y();
349
350 p.setPen(ErrorBgColour.darker());
351 p.setBrush(ErrorBgColour);
352
353 const QRectF bounding_rect =
354 QRectF(left, INT_MIN / 2 + y, right - left, INT_MAX);
355 const QRectF text_rect = p.boundingRect(bounding_rect,
356 Qt::AlignCenter, message);
357 const float r = text_rect.height() / 4;
358
359 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r,
360 Qt::AbsoluteSize);
361
362 p.setPen(get_text_colour());
363 p.drawText(text_rect, message);
364}
365
5dfeb70f
JH
366void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
367 int right, double samples_per_pixel, double pixels_offset)
368{
369 using namespace pv::data;
370 using pv::data::decode::Decoder;
371
372 assert(_decoder_stack);
373
374 shared_ptr<Logic> data;
375 shared_ptr<LogicSignal> logic_signal;
376
377 const list< shared_ptr<Decoder> > &stack = _decoder_stack->stack();
378
379 // We get the logic data of the first probe in the list.
380 // This works because we are currently assuming all
381 // LogicSignals have the same data/snapshot
382 BOOST_FOREACH (const shared_ptr<Decoder> &dec, stack)
383 if (dec && !dec->probes().empty() &&
384 ((logic_signal = (*dec->probes().begin()).second)) &&
7aa09b00 385 ((data = logic_signal->logic_data())))
5dfeb70f
JH
386 break;
387
388 if (!data || data->get_snapshots().empty())
389 return;
390
391 const shared_ptr<LogicSnapshot> snapshot =
392 data->get_snapshots().front();
393 assert(snapshot);
394 const int64_t sample_count = (int64_t)snapshot->get_sample_count();
395 if (sample_count == 0)
396 return;
397
398 const int64_t samples_decoded = _decoder_stack->samples_decoded();
399 if (sample_count == samples_decoded)
400 return;
401
402 const int y = get_y();
403 const double start = max(samples_decoded /
404 samples_per_pixel - pixels_offset, left - 1.0);
405 const double end = min(sample_count / samples_per_pixel -
406 pixels_offset, right + 1.0);
407 const QRectF no_decode_rect(start, y - h/2 + 0.5, end - start, h);
408
409 p.setPen(QPen(Qt::NoPen));
410 p.setBrush(Qt::white);
411 p.drawRect(no_decode_rect);
412
413 p.setPen(NoDecodeColour);
414 p.setBrush(QBrush(NoDecodeColour, Qt::Dense6Pattern));
415 p.drawRect(no_decode_rect);
416}
417
613d097c
JH
418void DecodeTrace::create_decoder_form(int index,
419 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
420 QFormLayout *form)
7491a29f
JH
421{
422 const GSList *probe;
423
424 assert(dec);
425 const srd_decoder *const decoder = dec->decoder();
426 assert(decoder);
427
204bae45 428 pv::widgets::DecoderGroupBox *const group =
27e8df22
JH
429 new pv::widgets::DecoderGroupBox(
430 QString::fromUtf8(decoder->name));
613d097c
JH
431
432 _delete_mapper.setMapping(group, index);
433 connect(group, SIGNAL(delete_decoder()), &_delete_mapper, SLOT(map()));
434
204bae45
JH
435 QFormLayout *const decoder_form = new QFormLayout;
436 group->add_layout(decoder_form);
7491a29f
JH
437
438 // Add the mandatory probes
439 for(probe = decoder->probes; probe; probe = probe->next) {
440 const struct srd_probe *const p =
441 (struct srd_probe *)probe->data;
442 QComboBox *const combo = create_probe_selector(parent, dec, p);
443 connect(combo, SIGNAL(currentIndexChanged(int)),
444 this, SLOT(on_probe_selected(int)));
204bae45 445 decoder_form->addRow(tr("<b>%1</b> (%2) *")
7491a29f
JH
446 .arg(p->name).arg(p->desc), combo);
447
448 const ProbeSelector s = {combo, dec, p};
449 _probe_selectors.push_back(s);
450 }
451
452 // Add the optional probes
453 for(probe = decoder->opt_probes; probe; probe = probe->next) {
454 const struct srd_probe *const p =
455 (struct srd_probe *)probe->data;
456 QComboBox *const combo = create_probe_selector(parent, dec, p);
457 connect(combo, SIGNAL(currentIndexChanged(int)),
458 this, SLOT(on_probe_selected(int)));
204bae45 459 decoder_form->addRow(tr("<b>%1</b> (%2)")
7491a29f
JH
460 .arg(p->name).arg(p->desc), combo);
461
462 const ProbeSelector s = {combo, dec, p};
463 _probe_selectors.push_back(s);
464 }
465
466 // Add the options
467 shared_ptr<prop::binding::DecoderOptions> binding(
468 new prop::binding::DecoderOptions(_decoder_stack, dec));
204bae45 469 binding->add_properties_to_form(decoder_form, true);
7491a29f
JH
470
471 _bindings.push_back(binding);
204bae45
JH
472
473 form->addRow(group);
7491a29f
JH
474}
475
b9329558 476QComboBox* DecodeTrace::create_probe_selector(
7491a29f
JH
477 QWidget *parent, const shared_ptr<data::decode::Decoder> &dec,
478 const srd_probe *const probe)
4e5a4405 479{
7491a29f
JH
480 assert(dec);
481
4e5a4405
JH
482 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
483
6e89374a 484 assert(_decoder_stack);
4e5a4405
JH
485 const map<const srd_probe*,
486 shared_ptr<LogicSignal> >::const_iterator probe_iter =
7491a29f 487 dec->probes().find(probe);
4e5a4405
JH
488
489 QComboBox *selector = new QComboBox(parent);
490
491 selector->addItem("-", qVariantFromValue((void*)NULL));
492
7491a29f 493 if (probe_iter == dec->probes().end())
4e5a4405
JH
494 selector->setCurrentIndex(0);
495
496 for(size_t i = 0; i < sigs.size(); i++) {
497 const shared_ptr<view::Signal> s(sigs[i]);
498 assert(s);
499
500 if (dynamic_pointer_cast<LogicSignal>(s) && s->enabled())
501 {
502 selector->addItem(s->get_name(),
503 qVariantFromValue((void*)s.get()));
504 if ((*probe_iter).second == s)
505 selector->setCurrentIndex(i + 1);
506 }
507 }
508
509 return selector;
510}
511
7491a29f 512void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
4e5a4405 513{
7491a29f 514 assert(dec);
4e5a4405
JH
515
516 map<const srd_probe*, shared_ptr<LogicSignal> > probe_map;
517 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
518
7491a29f 519 BOOST_FOREACH(const ProbeSelector &s, _probe_selectors)
4e5a4405 520 {
7491a29f
JH
521 if(s._decoder != dec)
522 break;
523
4e5a4405 524 const LogicSignal *const selection =
7491a29f
JH
525 (LogicSignal*)s._combo->itemData(
526 s._combo->currentIndex()).value<void*>();
4e5a4405 527
7491a29f
JH
528 BOOST_FOREACH(shared_ptr<Signal> sig, sigs)
529 if(sig.get() == selection) {
530 probe_map[s._probe] =
531 dynamic_pointer_cast<LogicSignal>(sig);
4e5a4405
JH
532 break;
533 }
534 }
535
7491a29f
JH
536 dec->set_probes(probe_map);
537}
538
539void DecodeTrace::commit_probes()
540{
541 assert(_decoder_stack);
542 BOOST_FOREACH(shared_ptr<data::decode::Decoder> dec,
543 _decoder_stack->stack())
544 commit_decoder_probes(dec);
545
546 _decoder_stack->begin_decode();
4e5a4405
JH
547}
548
b9329558 549void DecodeTrace::on_new_decode_data()
9cef9567
JH
550{
551 if (_view)
552 _view->update_viewport();
553}
554
b9329558 555void DecodeTrace::delete_pressed()
5ed1adf5
JH
556{
557 on_delete();
558}
559
b9329558 560void DecodeTrace::on_delete()
c51482b3
JH
561{
562 _session.remove_decode_signal(this);
563}
564
b9329558 565void DecodeTrace::on_probe_selected(int)
4e5a4405
JH
566{
567 commit_probes();
568}
569
7491a29f
JH
570void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
571{
572 assert(decoder);
573 assert(_decoder_stack);
574 _decoder_stack->push(shared_ptr<data::decode::Decoder>(
575 new data::decode::Decoder(decoder)));
576 _decoder_stack->begin_decode();
37fd11b1
JH
577
578 create_popup_form();
7491a29f
JH
579}
580
613d097c
JH
581void DecodeTrace::on_delete_decoder(int index)
582{
583 _decoder_stack->remove(index);
584
585 // Update the popup
586 create_popup_form();
587
588 _decoder_stack->begin_decode();
589}
590
55d3603d
JH
591} // namespace view
592} // namespace pv