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 stacked PD is 60 pixels further down.
161 int y_stack_offset = a.pd_index() * 60;
163 // Every annotation row is 20 pixels further down.
164 int y_ann_row_offset = a.row() * 20;
166 draw_annotation(a, p, get_text_colour(), h, left, right,
167 samples_per_pixel, pixels_offset,
168 y + y_stack_offset + y_ann_row_offset);
171 draw_unresolved_period(p, h, left, right,
172 samples_per_pixel, pixels_offset);
175 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
177 using pv::data::decode::Decoder;
181 assert(_decoder_stack);
183 // Add the standard options
184 Trace::populate_popup_form(parent, form);
186 // Add the decoder options
188 _probe_selectors.clear();
190 const list< shared_ptr<Decoder> >& stack = _decoder_stack->stack();
194 QLabel *const l = new QLabel(
195 tr("<p><i>No decoders in the stack</i></p>"));
196 l->setAlignment(Qt::AlignCenter);
201 list< shared_ptr<Decoder> >::const_iterator iter =
203 for (int i = 0; i < (int)stack.size(); i++, iter++) {
204 shared_ptr<Decoder> dec(*iter);
205 create_decoder_form(i, dec, parent, form);
208 form->addRow(new QLabel(
209 tr("<i>* Required Probes</i>"), parent));
212 // Add stacking button
213 pv::widgets::DecoderMenu *const decoder_menu =
214 new pv::widgets::DecoderMenu(parent);
215 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
216 this, SLOT(on_stack_decoder(srd_decoder*)));
218 QPushButton *const stack_button =
219 new QPushButton(tr("Stack Decoder"), parent);
220 stack_button->setMenu(decoder_menu);
222 QHBoxLayout *stack_button_box = new QHBoxLayout;
223 stack_button_box->addWidget(stack_button, 0, Qt::AlignRight);
224 form->addRow(stack_button_box);
227 QMenu* DecodeTrace::create_context_menu(QWidget *parent)
229 QMenu *const menu = Trace::create_context_menu(parent);
231 menu->addSeparator();
233 QAction *const del = new QAction(tr("Delete"), this);
234 del->setShortcuts(QKeySequence::Delete);
235 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
236 menu->addAction(del);
241 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
242 QColor text_color, int h, int left, int right, double samples_per_pixel,
243 double pixels_offset, int y) const
245 const double start = a.start_sample() / samples_per_pixel -
247 const double end = a.end_sample() / samples_per_pixel -
249 const QColor fill = Colours[(a.format() * (countof(Colours) / 2 + 1)) %
251 const QColor outline(fill.darker());
253 if (start > right + DrawPadding || end < left - DrawPadding)
256 if (a.start_sample() == a.end_sample())
257 draw_instant(a, p, fill, outline, text_color, h,
260 draw_range(a, p, fill, outline, text_color, h,
264 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
265 QColor fill, QColor outline, QColor text_color, int h, double x, int y) const
267 const QString text = a.annotations().empty() ?
268 QString() : a.annotations().back();
269 const double w = min(p.boundingRect(QRectF(), 0, text).width(),
271 const QRectF rect(x - w / 2, y - h / 2, w, h);
275 p.drawRoundedRect(rect, h / 2, h / 2);
277 p.setPen(text_color);
278 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
281 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
282 QColor fill, QColor outline, QColor text_color, int h, double start,
283 double end, int y) const
285 const double top = y + .5 - h / 2;
286 const double bottom = y + .5 + h / 2;
287 const vector<QString> annotations = a.annotations();
292 // If the two ends are within 1 pixel, draw a vertical line
293 if (start + 1.0 > end)
295 p.drawLine(QPointF(start, top), QPointF(start, bottom));
299 const double cap_width = min((end - start) / 4, EndCapWidth);
302 QPointF(start, y + .5f),
303 QPointF(start + cap_width, top),
304 QPointF(end - cap_width, top),
305 QPointF(end, y + .5f),
306 QPointF(end - cap_width, bottom),
307 QPointF(start + cap_width, bottom)
310 p.drawConvexPolygon(pts, countof(pts));
312 if (annotations.empty())
315 QRectF rect(start + cap_width, y - h / 2,
316 end - start - cap_width * 2, h);
317 p.setPen(text_color);
319 // Try to find an annotation that will fit
320 QString best_annotation;
323 BOOST_FOREACH(const QString &a, annotations) {
324 const int w = p.boundingRect(QRectF(), 0, a).width();
325 if (w <= rect.width() && w > best_width)
326 best_annotation = a, best_width = w;
329 if (best_annotation.isEmpty())
330 best_annotation = annotations.back();
332 // If not ellide the last in the list
333 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
334 best_annotation, Qt::ElideRight, rect.width()));
337 void DecodeTrace::draw_error(QPainter &p, const QString &message,
340 const int y = get_y();
342 p.setPen(ErrorBgColour.darker());
343 p.setBrush(ErrorBgColour);
345 const QRectF bounding_rect =
346 QRectF(left, INT_MIN / 2 + y, right - left, INT_MAX);
347 const QRectF text_rect = p.boundingRect(bounding_rect,
348 Qt::AlignCenter, message);
349 const float r = text_rect.height() / 4;
351 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r,
354 p.setPen(get_text_colour());
355 p.drawText(text_rect, message);
358 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
359 int right, double samples_per_pixel, double pixels_offset)
361 using namespace pv::data;
362 using pv::data::decode::Decoder;
364 assert(_decoder_stack);
366 shared_ptr<Logic> data;
367 shared_ptr<LogicSignal> logic_signal;
369 const list< shared_ptr<Decoder> > &stack = _decoder_stack->stack();
371 // We get the logic data of the first probe in the list.
372 // This works because we are currently assuming all
373 // LogicSignals have the same data/snapshot
374 BOOST_FOREACH (const shared_ptr<Decoder> &dec, stack)
375 if (dec && !dec->probes().empty() &&
376 ((logic_signal = (*dec->probes().begin()).second)) &&
377 ((data = logic_signal->logic_data())))
380 if (!data || data->get_snapshots().empty())
383 const shared_ptr<LogicSnapshot> snapshot =
384 data->get_snapshots().front();
386 const int64_t sample_count = (int64_t)snapshot->get_sample_count();
387 if (sample_count == 0)
390 const int64_t samples_decoded = _decoder_stack->samples_decoded();
391 if (sample_count == samples_decoded)
394 const int y = get_y();
395 const double start = max(samples_decoded /
396 samples_per_pixel - pixels_offset, left - 1.0);
397 const double end = min(sample_count / samples_per_pixel -
398 pixels_offset, right + 1.0);
399 const QRectF no_decode_rect(start, y - h/2 + 0.5, end - start, h);
401 p.setPen(QPen(Qt::NoPen));
402 p.setBrush(Qt::white);
403 p.drawRect(no_decode_rect);
405 p.setPen(NoDecodeColour);
406 p.setBrush(QBrush(NoDecodeColour, Qt::Dense6Pattern));
407 p.drawRect(no_decode_rect);
410 void DecodeTrace::create_decoder_form(int index,
411 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
417 const srd_decoder *const decoder = dec->decoder();
420 pv::widgets::DecoderGroupBox *const group =
421 new pv::widgets::DecoderGroupBox(
422 QString::fromUtf8(decoder->name));
424 _delete_mapper.setMapping(group, index);
425 connect(group, SIGNAL(delete_decoder()), &_delete_mapper, SLOT(map()));
427 QFormLayout *const decoder_form = new QFormLayout;
428 group->add_layout(decoder_form);
430 // Add the mandatory probes
431 for(probe = decoder->probes; probe; probe = probe->next) {
432 const struct srd_probe *const p =
433 (struct srd_probe *)probe->data;
434 QComboBox *const combo = create_probe_selector(parent, dec, p);
435 connect(combo, SIGNAL(currentIndexChanged(int)),
436 this, SLOT(on_probe_selected(int)));
437 decoder_form->addRow(tr("<b>%1</b> (%2) *")
438 .arg(p->name).arg(p->desc), combo);
440 const ProbeSelector s = {combo, dec, p};
441 _probe_selectors.push_back(s);
444 // Add the optional probes
445 for(probe = decoder->opt_probes; probe; probe = probe->next) {
446 const struct srd_probe *const p =
447 (struct srd_probe *)probe->data;
448 QComboBox *const combo = create_probe_selector(parent, dec, p);
449 connect(combo, SIGNAL(currentIndexChanged(int)),
450 this, SLOT(on_probe_selected(int)));
451 decoder_form->addRow(tr("<b>%1</b> (%2)")
452 .arg(p->name).arg(p->desc), combo);
454 const ProbeSelector s = {combo, dec, p};
455 _probe_selectors.push_back(s);
459 shared_ptr<prop::binding::DecoderOptions> binding(
460 new prop::binding::DecoderOptions(_decoder_stack, dec));
461 binding->add_properties_to_form(decoder_form, true);
463 _bindings.push_back(binding);
468 QComboBox* DecodeTrace::create_probe_selector(
469 QWidget *parent, const shared_ptr<data::decode::Decoder> &dec,
470 const srd_probe *const probe)
474 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
476 assert(_decoder_stack);
477 const map<const srd_probe*,
478 shared_ptr<LogicSignal> >::const_iterator probe_iter =
479 dec->probes().find(probe);
481 QComboBox *selector = new QComboBox(parent);
483 selector->addItem("-", qVariantFromValue((void*)NULL));
485 if (probe_iter == dec->probes().end())
486 selector->setCurrentIndex(0);
488 for(size_t i = 0; i < sigs.size(); i++) {
489 const shared_ptr<view::Signal> s(sigs[i]);
492 if (dynamic_pointer_cast<LogicSignal>(s) && s->enabled())
494 selector->addItem(s->get_name(),
495 qVariantFromValue((void*)s.get()));
496 if ((*probe_iter).second == s)
497 selector->setCurrentIndex(i + 1);
504 void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
508 map<const srd_probe*, shared_ptr<LogicSignal> > probe_map;
509 const vector< shared_ptr<Signal> > sigs = _session.get_signals();
511 BOOST_FOREACH(const ProbeSelector &s, _probe_selectors)
513 if(s._decoder != dec)
516 const LogicSignal *const selection =
517 (LogicSignal*)s._combo->itemData(
518 s._combo->currentIndex()).value<void*>();
520 BOOST_FOREACH(shared_ptr<Signal> sig, sigs)
521 if(sig.get() == selection) {
522 probe_map[s._probe] =
523 dynamic_pointer_cast<LogicSignal>(sig);
528 dec->set_probes(probe_map);
531 void DecodeTrace::commit_probes()
533 assert(_decoder_stack);
534 BOOST_FOREACH(shared_ptr<data::decode::Decoder> dec,
535 _decoder_stack->stack())
536 commit_decoder_probes(dec);
538 _decoder_stack->begin_decode();
541 void DecodeTrace::on_new_decode_data()
544 _view->update_viewport();
547 void DecodeTrace::delete_pressed()
552 void DecodeTrace::on_delete()
554 _session.remove_decode_signal(this);
557 void DecodeTrace::on_probe_selected(int)
562 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
565 assert(_decoder_stack);
566 _decoder_stack->push(shared_ptr<data::decode::Decoder>(
567 new data::decode::Decoder(decoder)));
568 _decoder_stack->begin_decode();
573 void DecodeTrace::on_delete_decoder(int index)
575 _decoder_stack->remove(index);
580 _decoder_stack->begin_decode();