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 QFontMetrics m(QApplication::font());
141 const int h = (m.boundingRect(QRect(), 0, "Tg").height() * 5) / 4;
143 assert(_decoder_stack);
144 const QString err = _decoder_stack->error_message();
147 draw_error(p, err, left, right);
148 draw_unresolved_period(p, h, left, right, samples_per_pixel,
154 const int y = get_y();
156 assert(_decoder_stack);
157 vector<Annotation> annotations(_decoder_stack->annotations());
159 BOOST_FOREACH(const Annotation &a, annotations) {
160 // Every annotation row is 20 pixels further down.
161 int y_ann_row_offset = a.row() * 20;
163 draw_annotation(a, p, get_text_colour(), h, left, right,
164 samples_per_pixel, pixels_offset,
165 y + y_ann_row_offset);
168 draw_unresolved_period(p, h, left, right,
169 samples_per_pixel, pixels_offset);
172 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
174 using pv::data::decode::Decoder;
178 assert(_decoder_stack);
180 // Add the standard options
181 Trace::populate_popup_form(parent, form);
183 // Add the decoder options
185 _probe_selectors.clear();
187 const list< shared_ptr<Decoder> >& stack = _decoder_stack->stack();
191 QLabel *const l = new QLabel(
192 tr("<p><i>No decoders in the stack</i></p>"));
193 l->setAlignment(Qt::AlignCenter);
198 list< shared_ptr<Decoder> >::const_iterator iter =
200 for (int i = 0; i < (int)stack.size(); i++, iter++) {
201 shared_ptr<Decoder> dec(*iter);
202 create_decoder_form(i, dec, parent, form);
205 form->addRow(new QLabel(
206 tr("<i>* Required Probes</i>"), parent));
209 // Add stacking button
210 pv::widgets::DecoderMenu *const decoder_menu =
211 new pv::widgets::DecoderMenu(parent);
212 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
213 this, SLOT(on_stack_decoder(srd_decoder*)));
215 QPushButton *const stack_button =
216 new QPushButton(tr("Stack Decoder"), parent);
217 stack_button->setMenu(decoder_menu);
219 QHBoxLayout *stack_button_box = new QHBoxLayout;
220 stack_button_box->addWidget(stack_button, 0, Qt::AlignRight);
221 form->addRow(stack_button_box);
224 QMenu* DecodeTrace::create_context_menu(QWidget *parent)
226 QMenu *const menu = Trace::create_context_menu(parent);
228 menu->addSeparator();
230 QAction *const del = new QAction(tr("Delete"), this);
231 del->setShortcuts(QKeySequence::Delete);
232 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
233 menu->addAction(del);
238 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
239 QColor text_color, int h, int left, int right, double samples_per_pixel,
240 double pixels_offset, int y) const
242 const double start = a.start_sample() / samples_per_pixel -
244 const double end = a.end_sample() / samples_per_pixel -
246 const QColor fill = Colours[(a.format() * (countof(Colours) / 2 + 1)) %
248 const QColor outline(fill.darker());
250 if (start > right + DrawPadding || end < left - DrawPadding)
253 if (a.start_sample() == a.end_sample())
254 draw_instant(a, p, fill, outline, text_color, h,
257 draw_range(a, p, fill, outline, text_color, h,
261 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
262 QColor fill, QColor outline, QColor text_color, int h, double x, int y) const
264 const QString text = a.annotations().empty() ?
265 QString() : a.annotations().back();
266 const double w = min(p.boundingRect(QRectF(), 0, text).width(),
268 const QRectF rect(x - w / 2, y - h / 2, w, h);
272 p.drawRoundedRect(rect, h / 2, h / 2);
274 p.setPen(text_color);
275 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
278 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
279 QColor fill, QColor outline, QColor text_color, int h, double start,
280 double end, int y) const
282 const double top = y + .5 - h / 2;
283 const double bottom = y + .5 + h / 2;
284 const vector<QString> annotations = a.annotations();
289 // If the two ends are within 1 pixel, draw a vertical line
290 if (start + 1.0 > end)
292 p.drawLine(QPointF(start, top), QPointF(start, bottom));
296 const double cap_width = min((end - start) / 4, EndCapWidth);
299 QPointF(start, y + .5f),
300 QPointF(start + cap_width, top),
301 QPointF(end - cap_width, top),
302 QPointF(end, y + .5f),
303 QPointF(end - cap_width, bottom),
304 QPointF(start + cap_width, bottom)
307 p.drawConvexPolygon(pts, countof(pts));
309 if (annotations.empty())
312 QRectF rect(start + cap_width, y - h / 2,
313 end - start - cap_width * 2, h);
314 p.setPen(text_color);
316 // Try to find an annotation that will fit
317 QString best_annotation;
320 BOOST_FOREACH(const QString &a, annotations) {
321 const int w = p.boundingRect(QRectF(), 0, a).width();
322 if (w <= rect.width() && w > best_width)
323 best_annotation = a, best_width = w;
326 if (best_annotation.isEmpty())
327 best_annotation = annotations.back();
329 // If not ellide the last in the list
330 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
331 best_annotation, Qt::ElideRight, rect.width()));
334 void DecodeTrace::draw_error(QPainter &p, const QString &message,
337 const int y = get_y();
339 p.setPen(ErrorBgColour.darker());
340 p.setBrush(ErrorBgColour);
342 const QRectF bounding_rect =
343 QRectF(left, INT_MIN / 2 + y, right - left, INT_MAX);
344 const QRectF text_rect = p.boundingRect(bounding_rect,
345 Qt::AlignCenter, message);
346 const float r = text_rect.height() / 4;
348 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r,
351 p.setPen(get_text_colour());
352 p.drawText(text_rect, message);
355 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
356 int right, double samples_per_pixel, double pixels_offset)
358 using namespace pv::data;
359 using pv::data::decode::Decoder;
361 assert(_decoder_stack);
363 shared_ptr<Logic> data;
364 shared_ptr<LogicSignal> logic_signal;
366 const list< shared_ptr<Decoder> > &stack = _decoder_stack->stack();
368 // We get the logic data of the first probe in the list.
369 // This works because we are currently assuming all
370 // LogicSignals have the same data/snapshot
371 BOOST_FOREACH (const shared_ptr<Decoder> &dec, stack)
372 if (dec && !dec->probes().empty() &&
373 ((logic_signal = (*dec->probes().begin()).second)) &&
374 ((data = logic_signal->logic_data())))
377 if (!data || data->get_snapshots().empty())
380 const shared_ptr<LogicSnapshot> snapshot =
381 data->get_snapshots().front();
383 const int64_t sample_count = (int64_t)snapshot->get_sample_count();
384 if (sample_count == 0)
387 const int64_t samples_decoded = _decoder_stack->samples_decoded();
388 if (sample_count == samples_decoded)
391 const int y = get_y();
392 const double start = max(samples_decoded /
393 samples_per_pixel - pixels_offset, left - 1.0);
394 const double end = min(sample_count / samples_per_pixel -
395 pixels_offset, right + 1.0);
396 const QRectF no_decode_rect(start, y - h/2 + 0.5, end - start, h);
398 p.setPen(QPen(Qt::NoPen));
399 p.setBrush(Qt::white);
400 p.drawRect(no_decode_rect);
402 p.setPen(NoDecodeColour);
403 p.setBrush(QBrush(NoDecodeColour, Qt::Dense6Pattern));
404 p.drawRect(no_decode_rect);
407 void DecodeTrace::create_decoder_form(int index,
408 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
414 const srd_decoder *const decoder = dec->decoder();
417 pv::widgets::DecoderGroupBox *const group =
418 new pv::widgets::DecoderGroupBox(
419 QString::fromUtf8(decoder->name));
421 _delete_mapper.setMapping(group, index);
422 connect(group, SIGNAL(delete_decoder()), &_delete_mapper, SLOT(map()));
424 QFormLayout *const decoder_form = new QFormLayout;
425 group->add_layout(decoder_form);
427 // Add the mandatory probes
428 for(probe = decoder->probes; probe; probe = probe->next) {
429 const struct srd_probe *const p =
430 (struct srd_probe *)probe->data;
431 QComboBox *const combo = create_probe_selector(parent, dec, p);
432 connect(combo, SIGNAL(currentIndexChanged(int)),
433 this, SLOT(on_probe_selected(int)));
434 decoder_form->addRow(tr("<b>%1</b> (%2) *")
435 .arg(p->name).arg(p->desc), combo);
437 const ProbeSelector s = {combo, dec, p};
438 _probe_selectors.push_back(s);
441 // Add the optional probes
442 for(probe = decoder->opt_probes; probe; probe = probe->next) {
443 const struct srd_probe *const p =
444 (struct srd_probe *)probe->data;
445 QComboBox *const combo = create_probe_selector(parent, dec, p);
446 connect(combo, SIGNAL(currentIndexChanged(int)),
447 this, SLOT(on_probe_selected(int)));
448 decoder_form->addRow(tr("<b>%1</b> (%2)")
449 .arg(p->name).arg(p->desc), combo);
451 const ProbeSelector s = {combo, dec, p};
452 _probe_selectors.push_back(s);
456 shared_ptr<prop::binding::DecoderOptions> binding(
457 new prop::binding::DecoderOptions(_decoder_stack, dec));
458 binding->add_properties_to_form(decoder_form, true);
460 _bindings.push_back(binding);
465 QComboBox* DecodeTrace::create_probe_selector(
466 QWidget *parent, const shared_ptr<data::decode::Decoder> &dec,
467 const srd_probe *const probe)
471 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
473 assert(_decoder_stack);
474 const map<const srd_probe*,
475 shared_ptr<LogicSignal> >::const_iterator probe_iter =
476 dec->probes().find(probe);
478 QComboBox *selector = new QComboBox(parent);
480 selector->addItem("-", qVariantFromValue((void*)NULL));
482 if (probe_iter == dec->probes().end())
483 selector->setCurrentIndex(0);
485 for(size_t i = 0; i < sigs.size(); i++) {
486 const shared_ptr<view::Signal> s(sigs[i]);
489 if (dynamic_pointer_cast<LogicSignal>(s) && s->enabled())
491 selector->addItem(s->get_name(),
492 qVariantFromValue((void*)s.get()));
493 if ((*probe_iter).second == s)
494 selector->setCurrentIndex(i + 1);
501 void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
505 map<const srd_probe*, shared_ptr<LogicSignal> > probe_map;
506 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
508 BOOST_FOREACH(const ProbeSelector &s, _probe_selectors)
510 if(s._decoder != dec)
513 const LogicSignal *const selection =
514 (LogicSignal*)s._combo->itemData(
515 s._combo->currentIndex()).value<void*>();
517 BOOST_FOREACH(shared_ptr<Signal> sig, sigs)
518 if(sig.get() == selection) {
519 probe_map[s._probe] =
520 dynamic_pointer_cast<LogicSignal>(sig);
525 dec->set_probes(probe_map);
528 void DecodeTrace::commit_probes()
530 assert(_decoder_stack);
531 BOOST_FOREACH(shared_ptr<data::decode::Decoder> dec,
532 _decoder_stack->stack())
533 commit_decoder_probes(dec);
535 _decoder_stack->begin_decode();
538 void DecodeTrace::on_new_decode_data()
541 _view->update_viewport();
544 void DecodeTrace::delete_pressed()
549 void DecodeTrace::on_delete()
551 _session.remove_decode_signal(this);
554 void DecodeTrace::on_probe_selected(int)
559 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
562 assert(_decoder_stack);
563 _decoder_stack->push(shared_ptr<data::decode::Decoder>(
564 new data::decode::Decoder(decoder)));
565 _decoder_stack->begin_decode();
570 void DecodeTrace::on_delete_decoder(int index)
572 _decoder_stack->remove(index);
577 _decoder_stack->begin_decode();