]> sigrok.org Git - pulseview.git/blobdiff - pv/view/decodetrace.cpp
Rename 'probe' to 'channel' (libsigrokdecode change).
[pulseview.git] / pv / view / decodetrace.cpp
index beb83b1f20634febe91707867fca8ca0af93c77f..c3bc1dff0a4981170e86b748fe8f45c1a7206b33 100644 (file)
@@ -25,8 +25,10 @@ extern "C" {
 #include <extdef.h>
 
 #include <boost/foreach.hpp>
+#include <boost/functional/hash.hpp>
 
 #include <QAction>
+#include <QApplication>
 #include <QComboBox>
 #include <QFormLayout>
 #include <QLabel>
@@ -40,14 +42,19 @@ extern "C" {
 #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 {
@@ -62,11 +69,56 @@ const QColor DecodeTrace::DecodeColours[4] = {
 const QColor DecodeTrace::ErrorBgColour = QColor(0xEF, 0x29, 0x29);
 const QColor DecodeTrace::NoDecodeColour = QColor(0x88, 0x8A, 0x85);
 
+const int DecodeTrace::ArrowSize = 4;
+const double DecodeTrace::EndCapWidth = 5;
+const int DecodeTrace::DrawPadding = 100;
+
+const QColor DecodeTrace::Colours[16] = {
+       QColor(0xEF, 0x29, 0x29),
+       QColor(0xF6, 0x6A, 0x32),
+       QColor(0xFC, 0xAE, 0x3E),
+       QColor(0xFB, 0xCA, 0x47),
+       QColor(0xFC, 0xE9, 0x4F),
+       QColor(0xCD, 0xF0, 0x40),
+       QColor(0x8A, 0xE2, 0x34),
+       QColor(0x4E, 0xDC, 0x44),
+       QColor(0x55, 0xD7, 0x95),
+       QColor(0x64, 0xD1, 0xD2),
+       QColor(0x72, 0x9F, 0xCF),
+       QColor(0xD4, 0x76, 0xC4),
+       QColor(0x9D, 0x79, 0xB9),
+       QColor(0xAD, 0x7F, 0xA8),
+       QColor(0xC2, 0x62, 0x9B),
+       QColor(0xD7, 0x47, 0x6F)
+};
+
+const QColor DecodeTrace::OutlineColours[16] = {
+       QColor(0x77, 0x14, 0x14),
+       QColor(0x7B, 0x35, 0x19),
+       QColor(0x7E, 0x57, 0x1F),
+       QColor(0x7D, 0x65, 0x23),
+       QColor(0x7E, 0x74, 0x27),
+       QColor(0x66, 0x78, 0x20),
+       QColor(0x45, 0x71, 0x1A),
+       QColor(0x27, 0x6E, 0x22),
+       QColor(0x2A, 0x6B, 0x4A),
+       QColor(0x32, 0x68, 0x69),
+       QColor(0x39, 0x4F, 0x67),
+       QColor(0x6A, 0x3B, 0x62),
+       QColor(0x4E, 0x3C, 0x5C),
+       QColor(0x56, 0x3F, 0x54),
+       QColor(0x61, 0x31, 0x4D),
+       QColor(0x6B, 0x23, 0x37)
+};
+
 DecodeTrace::DecodeTrace(pv::SigSession &session,
        boost::shared_ptr<pv::data::DecoderStack> decoder_stack, int index) :
-       Trace(session, QString(decoder_stack->stack().front()->decoder()->name)),
+       Trace(QString::fromUtf8(
+               decoder_stack->stack().front()->decoder()->name)),
+       _session(session),
        _decoder_stack(decoder_stack),
-       _delete_mapper(this)
+       _delete_mapper(this),
+       _show_hide_mapper(this)
 {
        assert(_decoder_stack);
 
@@ -76,6 +128,8 @@ DecodeTrace::DecodeTrace(pv::SigSession &session,
                this, SLOT(on_new_decode_data()));
        connect(&_delete_mapper, SIGNAL(mapped(int)),
                this, SLOT(on_delete_decoder(int)));
+       connect(&_show_hide_mapper, SIGNAL(mapped(int)),
+               this, SLOT(on_show_hide_decoder(int)));
 }
 
 bool DecodeTrace::enabled() const
@@ -102,12 +156,14 @@ void DecodeTrace::paint_back(QPainter &p, int left, int right)
 
 void DecodeTrace::paint_mid(QPainter &p, int left, int right)
 {
-       using namespace pv::view::decode;
+       using namespace pv::data::decode;
 
        const double scale = _view->scale();
        assert(scale > 0);
 
-       double samplerate = _decoder_stack->get_samplerate();
+       double samplerate = _decoder_stack->samplerate();
+
+       _cur_row_headings.clear();
 
        // Show sample rate as 1Hz when it is unknown
        if (samplerate == 0.0)
@@ -117,33 +173,109 @@ void DecodeTrace::paint_mid(QPainter &p, int left, int right)
                _decoder_stack->get_start_time()) / scale;
        const double samples_per_pixel = samplerate * scale;
 
-       const int h = (_text_size.height() * 5) / 4;
+       const uint64_t start_sample = (uint64_t)max((left + pixels_offset) *
+               samples_per_pixel, 0.0);
+       const uint64_t end_sample = (uint64_t)max((right + pixels_offset) *
+               samples_per_pixel, 0.0);
+
+       QFontMetrics m(QApplication::font());
+       const int text_height =  m.boundingRect(QRect(), 0, "Tg").height();
+       const int annotation_height = (text_height * 5) / 4;
+       const int row_height = (text_height * 6) / 4;
 
        assert(_decoder_stack);
        const QString err = _decoder_stack->error_message();
        if (!err.isEmpty())
        {
+               draw_unresolved_period(p, annotation_height, left, right,
+                       samples_per_pixel, pixels_offset);
                draw_error(p, err, left, right);
-               draw_unresolved_period(p, h, left, right, samples_per_pixel,
-                       pixels_offset);
                return;
        }
 
+       // Iterate through the rows
        assert(_view);
-       const int y = get_y();
+       int y = get_y();
 
        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(), h, left, right,
-                       samples_per_pixel, pixels_offset, y);
+
+       const vector<Row> rows(_decoder_stack->get_visible_rows());
+       for (size_t i = 0; i < rows.size(); i++)
+       {
+               const Row &row = rows[i];
+
+               size_t base_colour = 0x13579BDF;
+               boost::hash_combine(base_colour, this);
+               boost::hash_combine(base_colour, row.decoder());
+               boost::hash_combine(base_colour, row.row());
+               base_colour >>= 16;
+
+               vector<Annotation> annotations;
+               _decoder_stack->get_annotation_subset(annotations, row,
+                       start_sample, end_sample);
+               if (!annotations.empty()) {
+                       BOOST_FOREACH(const Annotation &a, annotations)
+                               draw_annotation(a, p, get_text_colour(),
+                                       annotation_height, left, right,
+                                       samples_per_pixel, pixels_offset, y,
+                                       base_colour);
+                       y += row_height;
+
+                       _cur_row_headings.push_back(row.title());
+               }
        }
 
-       draw_unresolved_period(p, h, left, right,
+       // Draw the hatching
+       draw_unresolved_period(p, annotation_height, left, right,
                samples_per_pixel, pixels_offset);
 }
 
+void DecodeTrace::paint_fore(QPainter &p, int left, int right)
+{
+       using namespace pv::data::decode;
+
+       (void)right;
+
+       QFontMetrics m(QApplication::font());
+       const int text_height =  m.boundingRect(QRect(), 0, "Tg").height();
+       const int row_height = (text_height * 6) / 4;
+
+       for (size_t i = 0; i < _cur_row_headings.size(); i++)
+       {
+               const int y = i * row_height + get_y();
+
+               p.setPen(QPen(Qt::NoPen));
+               p.setBrush(QApplication::palette().brush(QPalette::WindowText));
+
+               if (i != 0)
+               {
+                       const QPointF points[] = {
+                               QPointF(left, y - ArrowSize),
+                               QPointF(left + ArrowSize, y),
+                               QPointF(left, y + ArrowSize)
+                       };
+                       p.drawPolygon(points, countof(points));
+               }
+
+               const QRect r(left + ArrowSize * 2, y - row_height / 2,
+                       right - left, row_height);
+               const QString h(_cur_row_headings[i]);
+               const int f = Qt::AlignLeft | Qt::AlignVCenter |
+                       Qt::TextDontClip;
+
+               // Draw the outline
+               p.setPen(QApplication::palette().color(QPalette::Base));
+               for (int dx = -1; dx <= 1; dx++)
+                       for (int dy = -1; dy <= 1; dy++)
+                               if (dx != 0 && dy != 0)
+                                       p.drawText(r.translated(dx, dy), f, h);
+
+               // Draw the text
+               p.setPen(QApplication::palette().color(QPalette::WindowText));
+               p.drawText(r, f, h);
+       }
+}
+
 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
 {
        using pv::data::decode::Decoder;
@@ -158,6 +290,7 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
        // Add the decoder options
        _bindings.clear();
        _probe_selectors.clear();
+       _decoder_forms.clear();
 
        const list< shared_ptr<Decoder> >& stack = _decoder_stack->stack();
 
@@ -178,7 +311,7 @@ void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
                }
 
                form->addRow(new QLabel(
-                       tr("<i>* Required Probes</i>"), parent));
+                       tr("<i>* Required channels</i>"), parent));
        }
 
        // Add stacking button
@@ -210,6 +343,107 @@ 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,
+       size_t base_colour) const
+{
+       const double start = a.start_sample() / samples_per_pixel -
+               pixels_offset;
+       const double end = a.end_sample() / samples_per_pixel -
+               pixels_offset;
+
+       const size_t colour = (base_colour + a.format()) % countof(Colours);
+       const QColor &fill = Colours[colour];
+       const QColor &outline = OutlineColours[colour];
+
+       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);
+       if (rect.width() <= 4)
+               return;
+
+       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)
 {
@@ -248,9 +482,9 @@ void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left,
        // 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->data())))
+               if (dec && !dec->channels().empty() &&
+                       ((logic_signal = (*dec->channels().begin()).second)) &&
+                       ((data = logic_signal->logic_data())))
                        break;
 
        if (!data || data->get_snapshots().empty())
@@ -287,46 +521,54 @@ void DecodeTrace::create_decoder_form(int index,
        shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
        QFormLayout *form)
 {
-       const GSList *probe;
+       const GSList *l;
 
        assert(dec);
        const srd_decoder *const decoder = dec->decoder();
        assert(decoder);
 
        pv::widgets::DecoderGroupBox *const group =
-               new pv::widgets::DecoderGroupBox(decoder->name);
+               new pv::widgets::DecoderGroupBox(
+                       QString::fromUtf8(decoder->name));
+       group->set_decoder_visible(dec->shown());
 
        _delete_mapper.setMapping(group, index);
        connect(group, SIGNAL(delete_decoder()), &_delete_mapper, SLOT(map()));
 
+       _show_hide_mapper.setMapping(group, index);
+       connect(group, SIGNAL(show_hide_decoder()),
+               &_show_hide_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) {
-               const struct srd_probe *const p =
-                       (struct srd_probe *)probe->data;
-               QComboBox *const combo = create_probe_selector(parent, dec, p);
+       // Add the mandatory channels
+       for(l = decoder->channels; l; l = l->next) {
+               const struct srd_channel *const pdch =
+                       (struct srd_channel *)l->data;
+               QComboBox *const combo = create_probe_selector(parent, dec, pdch);
                connect(combo, SIGNAL(currentIndexChanged(int)),
                        this, SLOT(on_probe_selected(int)));
                decoder_form->addRow(tr("<b>%1</b> (%2) *")
-                       .arg(p->name).arg(p->desc), combo);
+                       .arg(QString::fromUtf8(pdch->name))
+                       .arg(QString::fromUtf8(pdch->desc)), combo);
 
-               const ProbeSelector s = {combo, dec, p};
+               const ProbeSelector s = {combo, dec, pdch};
                _probe_selectors.push_back(s);
        }
 
-       // Add the optional probes
-       for(probe = decoder->opt_probes; probe; probe = probe->next) {
-               const struct srd_probe *const p =
-                       (struct srd_probe *)probe->data;
-               QComboBox *const combo = create_probe_selector(parent, dec, p);
+       // Add the optional channels
+       for(l = decoder->opt_channels; l; l = l->next) {
+               const struct srd_channel *const pdch =
+                       (struct srd_channel *)l->data;
+               QComboBox *const combo = create_probe_selector(parent, dec, pdch);
                connect(combo, SIGNAL(currentIndexChanged(int)),
                        this, SLOT(on_probe_selected(int)));
                decoder_form->addRow(tr("<b>%1</b> (%2)")
-                       .arg(p->name).arg(p->desc), combo);
+                       .arg(QString::fromUtf8(pdch->name))
+                       .arg(QString::fromUtf8(pdch->desc)), combo);
 
-               const ProbeSelector s = {combo, dec, p};
+               const ProbeSelector s = {combo, dec, pdch};
                _probe_selectors.push_back(s);
        }
 
@@ -338,26 +580,27 @@ void DecodeTrace::create_decoder_form(int index,
        _bindings.push_back(binding);
 
        form->addRow(group);
+       _decoder_forms.push_back(group);
 }
 
 QComboBox* DecodeTrace::create_probe_selector(
        QWidget *parent, const shared_ptr<data::decode::Decoder> &dec,
-       const srd_probe *const probe)
+       const srd_channel *const pdch)
 {
        assert(dec);
 
        const vector< shared_ptr<Signal> > sigs = _session.get_signals();
 
        assert(_decoder_stack);
-       const map<const srd_probe*,
+       const map<const srd_channel*,
                shared_ptr<LogicSignal> >::const_iterator probe_iter =
-               dec->probes().find(probe);
+               dec->channels().find(pdch);
 
        QComboBox *selector = new QComboBox(parent);
 
        selector->addItem("-", qVariantFromValue((void*)NULL));
 
-       if (probe_iter == dec->probes().end())
+       if (probe_iter == dec->channels().end())
                selector->setCurrentIndex(0);
 
        for(size_t i = 0; i < sigs.size(); i++) {
@@ -380,7 +623,7 @@ void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
 {
        assert(dec);
 
-       map<const srd_probe*, shared_ptr<LogicSignal> > probe_map;
+       map<const srd_channel*, shared_ptr<LogicSignal> > probe_map;
        const vector< shared_ptr<Signal> > sigs = _session.get_signals();
 
        BOOST_FOREACH(const ProbeSelector &s, _probe_selectors)
@@ -394,7 +637,7 @@ void DecodeTrace::commit_decoder_probes(shared_ptr<data::decode::Decoder> &dec)
 
                BOOST_FOREACH(shared_ptr<Signal> sig, sigs)
                        if(sig.get() == selection) {
-                               probe_map[s._probe] =
+                               probe_map[s._pdch] =
                                        dynamic_pointer_cast<LogicSignal>(sig);
                                break;
                        }
@@ -455,5 +698,28 @@ void DecodeTrace::on_delete_decoder(int index)
        _decoder_stack->begin_decode();
 }
 
+void DecodeTrace::on_show_hide_decoder(int index)
+{
+       using pv::data::decode::Decoder;
+
+       const list< shared_ptr<Decoder> > stack(_decoder_stack->stack());
+
+       // Find the decoder in the stack
+       list< shared_ptr<Decoder> >::const_iterator iter = stack.begin();
+       for(int i = 0; i < index; i++, iter++)
+               assert(iter != stack.end());
+
+       shared_ptr<Decoder> dec = *iter;
+       assert(dec);
+
+       const bool show = !dec->shown();
+       dec->show(show);
+
+       assert(index < (int)_decoder_forms.size());
+       _decoder_forms[index]->set_decoder_visible(show);
+
+       _view->update_viewport();
+}
+
 } // namespace view
 } // namespace pv