2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
22 #include <libsigrokdecode/libsigrokdecode.h>
27 #include <boost/foreach.hpp>
30 #include <QApplication>
32 #include <QFormLayout>
35 #include <QPushButton>
37 #include "decodetrace.h"
39 #include <pv/sigsession.h>
40 #include <pv/data/decoderstack.h>
41 #include <pv/data/decode/decoder.h>
42 #include <pv/data/logic.h>
43 #include <pv/data/logicsnapshot.h>
44 #include <pv/data/decode/annotation.h>
45 #include <pv/view/logicsignal.h>
46 #include <pv/view/view.h>
47 #include <pv/widgets/decodergroupbox.h>
48 #include <pv/widgets/decodermenu.h>
50 using boost::dynamic_pointer_cast;
51 using boost::shared_ptr;
61 const QColor DecodeTrace::DecodeColours[4] = {
62 QColor(0xEF, 0x29, 0x29), // Red
63 QColor(0xFC, 0xE9, 0x4F), // Yellow
64 QColor(0x8A, 0xE2, 0x34), // Green
65 QColor(0x72, 0x9F, 0xCF) // Blue
68 const QColor DecodeTrace::ErrorBgColour = QColor(0xEF, 0x29, 0x29);
69 const QColor DecodeTrace::NoDecodeColour = QColor(0x88, 0x8A, 0x85);
71 const double DecodeTrace::EndCapWidth = 5;
72 const int DecodeTrace::DrawPadding = 100;
74 const 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
84 DecodeTrace::DecodeTrace(pv::SigSession &session,
85 boost::shared_ptr<pv::data::DecoderStack> decoder_stack, int index) :
86 Trace(session, QString::fromUtf8(
87 decoder_stack->stack().front()->decoder()->name)),
88 _decoder_stack(decoder_stack),
91 assert(_decoder_stack);
93 _colour = DecodeColours[index % countof(DecodeColours)];
95 connect(_decoder_stack.get(), SIGNAL(new_decode_data()),
96 this, SLOT(on_new_decode_data()));
97 connect(&_delete_mapper, SIGNAL(mapped(int)),
98 this, SLOT(on_delete_decoder(int)));
101 bool DecodeTrace::enabled() const
106 const boost::shared_ptr<pv::data::DecoderStack>& DecodeTrace::decoder() const
108 return _decoder_stack;
111 void DecodeTrace::set_view(pv::view::View *view)
114 Trace::set_view(view);
117 void DecodeTrace::paint_back(QPainter &p, int left, int right)
119 Trace::paint_back(p, left, right);
120 paint_axis(p, get_y(), left, right);
123 void DecodeTrace::paint_mid(QPainter &p, int left, int right)
125 using pv::data::decode::Annotation;
127 const double scale = _view->scale();
130 double samplerate = _decoder_stack->samplerate();
132 // Show sample rate as 1Hz when it is unknown
133 if (samplerate == 0.0)
136 const double pixels_offset = (_view->offset() -
137 _decoder_stack->get_start_time()) / scale;
138 const double samples_per_pixel = samplerate * scale;
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);
145 QFontMetrics m(QApplication::font());
146 const int h = (m.boundingRect(QRect(), 0, "Tg").height() * 5) / 4;
148 assert(_decoder_stack);
149 const QString err = _decoder_stack->error_message();
152 draw_error(p, err, left, right);
153 draw_unresolved_period(p, h, left, right, samples_per_pixel,
159 const int y = get_y();
161 assert(_decoder_stack);
162 vector<Annotation> annotations;
163 _decoder_stack->get_annotation_subset(annotations,
164 start_sample, end_sample);
166 BOOST_FOREACH(const Annotation &a, annotations)
168 // Every stacked PD is 60 pixels further down.
169 int y_stack_offset = a.pd_index() * 60;
171 // Every annotation row is 20 pixels further down.
172 int y_ann_row_offset = a.row() * 20;
174 draw_annotation(a, p, get_text_colour(), h, left, right,
175 samples_per_pixel, pixels_offset,
176 y + y_stack_offset + y_ann_row_offset);
179 draw_unresolved_period(p, h, left, right,
180 samples_per_pixel, pixels_offset);
183 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
185 using pv::data::decode::Decoder;
189 assert(_decoder_stack);
191 // Add the standard options
192 Trace::populate_popup_form(parent, form);
194 // Add the decoder options
196 _probe_selectors.clear();
198 const list< shared_ptr<Decoder> >& stack = _decoder_stack->stack();
202 QLabel *const l = new QLabel(
203 tr("<p><i>No decoders in the stack</i></p>"));
204 l->setAlignment(Qt::AlignCenter);
209 list< shared_ptr<Decoder> >::const_iterator iter =
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);
216 form->addRow(new QLabel(
217 tr("<i>* Required Probes</i>"), parent));
220 // Add stacking button
221 pv::widgets::DecoderMenu *const decoder_menu =
222 new pv::widgets::DecoderMenu(parent);
223 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
224 this, SLOT(on_stack_decoder(srd_decoder*)));
226 QPushButton *const stack_button =
227 new QPushButton(tr("Stack Decoder"), parent);
228 stack_button->setMenu(decoder_menu);
230 QHBoxLayout *stack_button_box = new QHBoxLayout;
231 stack_button_box->addWidget(stack_button, 0, Qt::AlignRight);
232 form->addRow(stack_button_box);
235 QMenu* DecodeTrace::create_context_menu(QWidget *parent)
237 QMenu *const menu = Trace::create_context_menu(parent);
239 menu->addSeparator();
241 QAction *const del = new QAction(tr("Delete"), this);
242 del->setShortcuts(QKeySequence::Delete);
243 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
244 menu->addAction(del);
249 void 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
253 const double start = a.start_sample() / samples_per_pixel -
255 const double end = a.end_sample() / samples_per_pixel -
257 const QColor fill = Colours[(a.format() * (countof(Colours) / 2 + 1)) %
259 const QColor outline(fill.darker());
261 if (start > right + DrawPadding || end < left - DrawPadding)
264 if (a.start_sample() == a.end_sample())
265 draw_instant(a, p, fill, outline, text_color, h,
268 draw_range(a, p, fill, outline, text_color, h,
272 void 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
275 const QString text = a.annotations().empty() ?
276 QString() : a.annotations().back();
277 const double w = min(p.boundingRect(QRectF(), 0, text).width(),
279 const QRectF rect(x - w / 2, y - h / 2, w, h);
283 p.drawRoundedRect(rect, h / 2, h / 2);
285 p.setPen(text_color);
286 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
289 void 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
293 const double top = y + .5 - h / 2;
294 const double bottom = y + .5 + h / 2;
295 const vector<QString> annotations = a.annotations();
300 // If the two ends are within 1 pixel, draw a vertical line
301 if (start + 1.0 > end)
303 p.drawLine(QPointF(start, top), QPointF(start, bottom));
307 const double cap_width = min((end - start) / 4, EndCapWidth);
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)
318 p.drawConvexPolygon(pts, countof(pts));
320 if (annotations.empty())
323 QRectF rect(start + cap_width, y - h / 2,
324 end - start - cap_width * 2, h);
325 p.setPen(text_color);
327 // Try to find an annotation that will fit
328 QString best_annotation;
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;
337 if (best_annotation.isEmpty())
338 best_annotation = annotations.back();
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()));
345 void DecodeTrace::draw_error(QPainter &p, const QString &message,
348 const int y = get_y();
350 p.setPen(ErrorBgColour.darker());
351 p.setBrush(ErrorBgColour);
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;
359 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r,
362 p.setPen(get_text_colour());
363 p.drawText(text_rect, message);
366 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
367 int right, double samples_per_pixel, double pixels_offset)
369 using namespace pv::data;
370 using pv::data::decode::Decoder;
372 assert(_decoder_stack);
374 shared_ptr<Logic> data;
375 shared_ptr<LogicSignal> logic_signal;
377 const list< shared_ptr<Decoder> > &stack = _decoder_stack->stack();
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)) &&
385 ((data = logic_signal->logic_data())))
388 if (!data || data->get_snapshots().empty())
391 const shared_ptr<LogicSnapshot> snapshot =
392 data->get_snapshots().front();
394 const int64_t sample_count = (int64_t)snapshot->get_sample_count();
395 if (sample_count == 0)
398 const int64_t samples_decoded = _decoder_stack->samples_decoded();
399 if (sample_count == samples_decoded)
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);
409 p.setPen(QPen(Qt::NoPen));
410 p.setBrush(Qt::white);
411 p.drawRect(no_decode_rect);
413 p.setPen(NoDecodeColour);
414 p.setBrush(QBrush(NoDecodeColour, Qt::Dense6Pattern));
415 p.drawRect(no_decode_rect);
418 void DecodeTrace::create_decoder_form(int index,
419 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
425 const srd_decoder *const decoder = dec->decoder();
428 pv::widgets::DecoderGroupBox *const group =
429 new pv::widgets::DecoderGroupBox(
430 QString::fromUtf8(decoder->name));
432 _delete_mapper.setMapping(group, index);
433 connect(group, SIGNAL(delete_decoder()), &_delete_mapper, SLOT(map()));
435 QFormLayout *const decoder_form = new QFormLayout;
436 group->add_layout(decoder_form);
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)));
445 decoder_form->addRow(tr("<b>%1</b> (%2) *")
446 .arg(p->name).arg(p->desc), combo);
448 const ProbeSelector s = {combo, dec, p};
449 _probe_selectors.push_back(s);
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)));
459 decoder_form->addRow(tr("<b>%1</b> (%2)")
460 .arg(p->name).arg(p->desc), combo);
462 const ProbeSelector s = {combo, dec, p};
463 _probe_selectors.push_back(s);
467 shared_ptr<prop::binding::DecoderOptions> binding(
468 new prop::binding::DecoderOptions(_decoder_stack, dec));
469 binding->add_properties_to_form(decoder_form, true);
471 _bindings.push_back(binding);
476 QComboBox* DecodeTrace::create_probe_selector(
477 QWidget *parent, const shared_ptr<data::decode::Decoder> &dec,
478 const srd_probe *const probe)
482 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
484 assert(_decoder_stack);
485 const map<const srd_probe*,
486 shared_ptr<LogicSignal> >::const_iterator probe_iter =
487 dec->probes().find(probe);
489 QComboBox *selector = new QComboBox(parent);
491 selector->addItem("-", qVariantFromValue((void*)NULL));
493 if (probe_iter == dec->probes().end())
494 selector->setCurrentIndex(0);
496 for(size_t i = 0; i < sigs.size(); i++) {
497 const shared_ptr<view::Signal> s(sigs[i]);
500 if (dynamic_pointer_cast<LogicSignal>(s) && s->enabled())
502 selector->addItem(s->get_name(),
503 qVariantFromValue((void*)s.get()));
504 if ((*probe_iter).second == s)
505 selector->setCurrentIndex(i + 1);
512 void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
516 map<const srd_probe*, shared_ptr<LogicSignal> > probe_map;
517 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
519 BOOST_FOREACH(const ProbeSelector &s, _probe_selectors)
521 if(s._decoder != dec)
524 const LogicSignal *const selection =
525 (LogicSignal*)s._combo->itemData(
526 s._combo->currentIndex()).value<void*>();
528 BOOST_FOREACH(shared_ptr<Signal> sig, sigs)
529 if(sig.get() == selection) {
530 probe_map[s._probe] =
531 dynamic_pointer_cast<LogicSignal>(sig);
536 dec->set_probes(probe_map);
539 void DecodeTrace::commit_probes()
541 assert(_decoder_stack);
542 BOOST_FOREACH(shared_ptr<data::decode::Decoder> dec,
543 _decoder_stack->stack())
544 commit_decoder_probes(dec);
546 _decoder_stack->begin_decode();
549 void DecodeTrace::on_new_decode_data()
552 _view->update_viewport();
555 void DecodeTrace::delete_pressed()
560 void DecodeTrace::on_delete()
562 _session.remove_decode_signal(this);
565 void DecodeTrace::on_probe_selected(int)
570 void DecodeTrace::on_stack_decoder(srd_decoder *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();
581 void DecodeTrace::on_delete_decoder(int index)
583 _decoder_stack->remove(index);
588 _decoder_stack->begin_decode();