]> sigrok.org Git - pulseview.git/blobdiff - pv/view/decodetrace.cpp
pv::view::DecodeTrace: Draw annotation rows according to PD metadata.
[pulseview.git] / pv / view / decodetrace.cpp
index 7e2051a4022202ff77ea496e5259c147f07475e9..8c230ad42384cc093ba094ac9bd401377997061d 100644 (file)
@@ -27,6 +27,7 @@ extern "C" {
 #include <boost/foreach.hpp>
 
 #include <QAction>
+#include <QApplication>
 #include <QComboBox>
 #include <QFormLayout>
 #include <QLabel>
@@ -38,13 +39,21 @@ extern "C" {
 #include <pv/sigsession.h>
 #include <pv/data/decoderstack.h>
 #include <pv/data/decode/decoder.h>
+#include <pv/data/logic.h>
+#include <pv/data/logicsnapshot.h>
+#include <pv/data/decode/annotation.h>
 #include <pv/view/logicsignal.h>
 #include <pv/view/view.h>
-#include <pv/view/decode/annotation.h>
+#include <pv/widgets/decodergroupbox.h>
 #include <pv/widgets/decodermenu.h>
 
-using namespace boost;
-using namespace std;
+using boost::dynamic_pointer_cast;
+using boost::shared_ptr;
+using std::list;
+using std::max;
+using std::map;
+using std::min;
+using std::vector;
 
 namespace pv {
 namespace view {
@@ -57,11 +66,27 @@ const QColor DecodeTrace::DecodeColours[4] = {
 };
 
 const QColor DecodeTrace::ErrorBgColour = QColor(0xEF, 0x29, 0x29);
+const QColor DecodeTrace::NoDecodeColour = QColor(0x88, 0x8A, 0x85);
+
+const double DecodeTrace::EndCapWidth = 5;
+const int DecodeTrace::DrawPadding = 100;
+
+const QColor DecodeTrace::Colours[7] = {
+       QColor(0xFC, 0xE9, 0x4F),       // Light Butter
+       QColor(0xFC, 0xAF, 0x3E),       // Light Orange
+       QColor(0xE9, 0xB9, 0x6E),       // Light Chocolate
+       QColor(0x8A, 0xE2, 0x34),       // Light Green
+       QColor(0x72, 0x9F, 0xCF),       // Light Blue
+       QColor(0xAD, 0x7F, 0xA8),       // Light Plum
+       QColor(0xEF, 0x29, 0x29)        // Light Red
+};
 
 DecodeTrace::DecodeTrace(pv::SigSession &session,
        boost::shared_ptr<pv::data::DecoderStack> decoder_stack, int index) :
-       Trace(session, QString(decoder_stack->stack().front()->decoder()->name)),
-       _decoder_stack(decoder_stack)
+       Trace(session, QString::fromUtf8(
+               decoder_stack->stack().front()->decoder()->name)),
+       _decoder_stack(decoder_stack),
+       _delete_mapper(this)
 {
        assert(_decoder_stack);
 
@@ -69,6 +94,8 @@ DecodeTrace::DecodeTrace(pv::SigSession &session,
 
        connect(_decoder_stack.get(), SIGNAL(new_decode_data()),
                this, SLOT(on_new_decode_data()));
+       connect(&_delete_mapper, SIGNAL(mapped(int)),
+               this, SLOT(on_delete_decoder(int)));
 }
 
 bool DecodeTrace::enabled() const
@@ -89,27 +116,18 @@ void DecodeTrace::set_view(pv::view::View *view)
 
 void DecodeTrace::paint_back(QPainter &p, int left, int right)
 {
+       Trace::paint_back(p, left, right);
        paint_axis(p, get_y(), left, right);
 }
 
 void DecodeTrace::paint_mid(QPainter &p, int left, int right)
 {
-       using namespace pv::view::decode;
-
-       assert(_decoder_stack);
-       const QString err = _decoder_stack->error_message();
-       if (!err.isEmpty()) {
-               draw_error(p, err, left, right);
-               return;
-       }
-
-       assert(_view);
-       const int y = get_y();
+       using pv::data::decode::Annotation;
 
        const double scale = _view->scale();
        assert(scale > 0);
 
-       double samplerate = _decoder_stack->get_samplerate();
+       double samplerate = _decoder_stack->samplerate();
 
        // Show sample rate as 1Hz when it is unknown
        if (samplerate == 0.0)
@@ -119,17 +137,42 @@ void DecodeTrace::paint_mid(QPainter &p, int left, int right)
                _decoder_stack->get_start_time()) / scale;
        const double samples_per_pixel = samplerate * scale;
 
+       QFontMetrics m(QApplication::font());
+       const int h = (m.boundingRect(QRect(), 0, "Tg").height() * 5) / 4;
+
        assert(_decoder_stack);
-       vector< shared_ptr<Annotation> > annotations(_decoder_stack->annotations());
-       BOOST_FOREACH(shared_ptr<Annotation> a, annotations) {
-               assert(a);
-               a->paint(p, get_text_colour(), _text_size.height(),
-                       left, right, samples_per_pixel, pixels_offset, y);
+       const QString err = _decoder_stack->error_message();
+       if (!err.isEmpty())
+       {
+               draw_error(p, err, left, right);
+               draw_unresolved_period(p, h, left, right, samples_per_pixel,
+                       pixels_offset);
+               return;
        }
+
+       assert(_view);
+       const int y = get_y();
+
+       assert(_decoder_stack);
+       vector<Annotation> annotations(_decoder_stack->annotations());
+
+       BOOST_FOREACH(const Annotation &a, annotations) {
+               // Every annotation row is 20 pixels further down.
+               int y_ann_row_offset = a.row() * 20;
+
+               draw_annotation(a, p, get_text_colour(), h, left, right,
+                       samples_per_pixel, pixels_offset,
+                       y + y_ann_row_offset);
+       }
+
+       draw_unresolved_period(p, h, left, right,
+               samples_per_pixel, pixels_offset);
 }
 
 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
 {
+       using pv::data::decode::Decoder;
+
        assert(form);
        assert(parent);
        assert(_decoder_stack);
@@ -141,12 +184,27 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
        _bindings.clear();
        _probe_selectors.clear();
 
-       BOOST_FOREACH(shared_ptr<data::decode::Decoder> dec,
-               _decoder_stack->stack())
-               create_decoder_form(dec, parent, form);
+       const list< shared_ptr<Decoder> >& stack = _decoder_stack->stack();
 
-       form->addRow(new QLabel(
-               tr("<i>* Required Probes</i>"), parent));
+       if (stack.empty())
+       {
+               QLabel *const l = new QLabel(
+                       tr("<p><i>No decoders in the stack</i></p>"));
+               l->setAlignment(Qt::AlignCenter);
+               form->addRow(l);
+       }
+       else
+       {
+               list< shared_ptr<Decoder> >::const_iterator iter =
+                       stack.begin();
+               for (int i = 0; i < (int)stack.size(); i++, iter++) {
+                       shared_ptr<Decoder> dec(*iter);
+                       create_decoder_form(i, dec, parent, form);
+               }
+
+               form->addRow(new QLabel(
+                       tr("<i>* Required Probes</i>"), parent));
+       }
 
        // Add stacking button
        pv::widgets::DecoderMenu *const decoder_menu =
@@ -177,6 +235,102 @@ QMenu* DecodeTrace::create_context_menu(QWidget *parent)
        return menu;
 }
 
+void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
+       QColor text_color, int h, int left, int right, double samples_per_pixel,
+       double pixels_offset, int y) const
+{
+       const double start = a.start_sample() / samples_per_pixel -
+               pixels_offset;
+       const double end = a.end_sample() / samples_per_pixel -
+               pixels_offset;
+       const QColor fill = Colours[(a.format() * (countof(Colours) / 2 + 1)) %
+               countof(Colours)];
+       const QColor outline(fill.darker());
+
+       if (start > right + DrawPadding || end < left - DrawPadding)
+               return;
+
+       if (a.start_sample() == a.end_sample())
+               draw_instant(a, p, fill, outline, text_color, h,
+                       start, y);
+       else
+               draw_range(a, p, fill, outline, text_color, h,
+                       start, end, y);
+}
+
+void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
+       QColor fill, QColor outline, QColor text_color, int h, double x, int y) const
+{
+       const QString text = a.annotations().empty() ?
+               QString() : a.annotations().back();
+       const double w = min(p.boundingRect(QRectF(), 0, text).width(),
+               0.0) + h;
+       const QRectF rect(x - w / 2, y - h / 2, w, h);
+
+       p.setPen(outline);
+       p.setBrush(fill);
+       p.drawRoundedRect(rect, h / 2, h / 2);
+
+       p.setPen(text_color);
+       p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
+}
+
+void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
+       QColor fill, QColor outline, QColor text_color, int h, double start,
+       double end, int y) const
+{
+       const double top = y + .5 - h / 2;
+       const double bottom = y + .5 + h / 2;
+       const vector<QString> annotations = a.annotations();
+
+       p.setPen(outline);
+       p.setBrush(fill);
+
+       // If the two ends are within 1 pixel, draw a vertical line
+       if (start + 1.0 > end)
+       {
+               p.drawLine(QPointF(start, top), QPointF(start, bottom));
+               return;
+       }
+
+       const double cap_width = min((end - start) / 4, EndCapWidth);
+
+       QPointF pts[] = {
+               QPointF(start, y + .5f),
+               QPointF(start + cap_width, top),
+               QPointF(end - cap_width, top),
+               QPointF(end, y + .5f),
+               QPointF(end - cap_width, bottom),
+               QPointF(start + cap_width, bottom)
+       };
+
+       p.drawConvexPolygon(pts, countof(pts));
+
+       if (annotations.empty())
+               return;
+
+       QRectF rect(start + cap_width, y - h / 2,
+               end - start - cap_width * 2, h);
+       p.setPen(text_color);
+
+       // Try to find an annotation that will fit
+       QString best_annotation;
+       int best_width = 0;
+
+       BOOST_FOREACH(const QString &a, annotations) {
+               const int w = p.boundingRect(QRectF(), 0, a).width();
+               if (w <= rect.width() && w > best_width)
+                       best_annotation = a, best_width = w;
+       }
+
+       if (best_annotation.isEmpty())
+               best_annotation = annotations.back();
+
+       // If not ellide the last in the list
+       p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
+               best_annotation, Qt::ElideRight, rect.width()));
+}
+
 void DecodeTrace::draw_error(QPainter &p, const QString &message,
        int left, int right)
 {
@@ -198,8 +352,61 @@ void DecodeTrace::draw_error(QPainter &p, const QString &message,
        p.drawText(text_rect, message);
 }
 
-void DecodeTrace::create_decoder_form(shared_ptr<data::decode::Decoder> &dec,
-       QWidget *parent, QFormLayout *form)
+void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
+       int right, double samples_per_pixel, double pixels_offset) 
+{
+       using namespace pv::data;
+       using pv::data::decode::Decoder;
+
+       assert(_decoder_stack); 
+
+       shared_ptr<Logic> data;
+       shared_ptr<LogicSignal> logic_signal;
+
+       const list< shared_ptr<Decoder> > &stack = _decoder_stack->stack();
+
+       // We get the logic data of the first probe in the list.
+       // This works because we are currently assuming all
+       // LogicSignals have the same data/snapshot
+       BOOST_FOREACH (const shared_ptr<Decoder> &dec, stack)
+               if (dec && !dec->probes().empty() &&
+                       ((logic_signal = (*dec->probes().begin()).second)) &&
+                       ((data = logic_signal->logic_data())))
+                       break;
+
+       if (!data || data->get_snapshots().empty())
+               return;
+
+       const shared_ptr<LogicSnapshot> snapshot =
+               data->get_snapshots().front();
+       assert(snapshot);
+       const int64_t sample_count = (int64_t)snapshot->get_sample_count();
+       if (sample_count == 0)
+               return;
+
+       const int64_t samples_decoded = _decoder_stack->samples_decoded();
+       if (sample_count == samples_decoded)
+               return;
+
+       const int y = get_y();
+       const double start = max(samples_decoded /
+               samples_per_pixel - pixels_offset, left - 1.0);
+       const double end = min(sample_count / samples_per_pixel -
+               pixels_offset, right + 1.0);
+       const QRectF no_decode_rect(start, y - h/2 + 0.5, end - start, h);
+
+       p.setPen(QPen(Qt::NoPen));
+       p.setBrush(Qt::white);
+       p.drawRect(no_decode_rect);
+
+       p.setPen(NoDecodeColour);
+       p.setBrush(QBrush(NoDecodeColour, Qt::Dense6Pattern));
+       p.drawRect(no_decode_rect);
+}
+
+void DecodeTrace::create_decoder_form(int index,
+       shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
+       QFormLayout *form)
 {
        const GSList *probe;
 
@@ -207,7 +414,15 @@ void DecodeTrace::create_decoder_form(shared_ptr<data::decode::Decoder> &dec,
        const srd_decoder *const decoder = dec->decoder();
        assert(decoder);
 
-       form->addRow(new QLabel(tr("<h3>%1</h3>").arg(decoder->name), parent));
+       pv::widgets::DecoderGroupBox *const group =
+               new pv::widgets::DecoderGroupBox(
+                       QString::fromUtf8(decoder->name));
+
+       _delete_mapper.setMapping(group, index);
+       connect(group, SIGNAL(delete_decoder()), &_delete_mapper, SLOT(map()));
+
+       QFormLayout *const decoder_form = new QFormLayout;
+       group->add_layout(decoder_form);
 
        // Add the mandatory probes
        for(probe = decoder->probes; probe; probe = probe->next) {
@@ -216,7 +431,7 @@ void DecodeTrace::create_decoder_form(shared_ptr<data::decode::Decoder> &dec,
                QComboBox *const combo = create_probe_selector(parent, dec, p);
                connect(combo, SIGNAL(currentIndexChanged(int)),
                        this, SLOT(on_probe_selected(int)));
-               form->addRow(tr("<b>%1</b> (%2) *")
+               decoder_form->addRow(tr("<b>%1</b> (%2) *")
                        .arg(p->name).arg(p->desc), combo);
 
                const ProbeSelector s = {combo, dec, p};
@@ -230,7 +445,7 @@ void DecodeTrace::create_decoder_form(shared_ptr<data::decode::Decoder> &dec,
                QComboBox *const combo = create_probe_selector(parent, dec, p);
                connect(combo, SIGNAL(currentIndexChanged(int)),
                        this, SLOT(on_probe_selected(int)));
-               form->addRow(tr("<b>%1</b> (%2)")
+               decoder_form->addRow(tr("<b>%1</b> (%2)")
                        .arg(p->name).arg(p->desc), combo);
 
                const ProbeSelector s = {combo, dec, p};
@@ -240,9 +455,11 @@ void DecodeTrace::create_decoder_form(shared_ptr<data::decode::Decoder> &dec,
        // Add the options
        shared_ptr<prop::binding::DecoderOptions> binding(
                new prop::binding::DecoderOptions(_decoder_stack, dec));
-       binding->add_properties_to_form(form, true);
+       binding->add_properties_to_form(decoder_form, true);
 
        _bindings.push_back(binding);
+
+       form->addRow(group);
 }
 
 QComboBox* DecodeTrace::create_probe_selector(
@@ -346,6 +563,18 @@ void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
        _decoder_stack->push(shared_ptr<data::decode::Decoder>(
                new data::decode::Decoder(decoder)));
        _decoder_stack->begin_decode();
+
+       create_popup_form();
+}
+
+void DecodeTrace::on_delete_decoder(int index)
+{
+       _decoder_stack->remove(index);
+
+       // Update the popup
+       create_popup_form();    
+
+       _decoder_stack->begin_decode();
 }
 
 } // namespace view