pv/data/decoderstack.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #ifndef PULSEVIEW_PV_DATA_DECODERSTACK_H
  22 #define PULSEVIEW_PV_DATA_DECODERSTACK_H
  23
  24 #include "signaldata.h"
  25
  26 #include <list>
  27
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/thread.hpp>
  30
  31 #include <QObject>
  32 #include <QString>
  33
  34 #include <pv/data/decode/row.h>
  35 #include <pv/data/decode/rowdata.h>
  36
  37 struct srd_decoder;
  38 struct srd_decoder_annotation_row;
  39 struct srd_probe;
  40 struct srd_proto_data;
  41
  42 namespace DecoderStackTest {
  43 class TwoDecoderStack;
  44 }
  45
  46 namespace pv {
  47
  48 class SigSession;
  49
  50 namespace view {
  51 class LogicSignal;
  52 }
  53
  54 namespace data {
  55
  56 namespace decode {
  57 class Annotation;
  58 class Decoder;
  59 }
  60
  61 class Logic;
  62
  63 class DecoderStack : public QObject, public SignalData
  64 {
  65         Q_OBJECT
  66
  67 private:
  68         static const double DecodeMargin;
  69         static const double DecodeThreshold;
  70         static const int64_t DecodeChunkLength;
  71
  72 public:
  73         DecoderStack(pv::SigSession &_session,
  74                 const srd_decoder *const decoder);
  75
  76         virtual ~DecoderStack();
  77
  78         const std::list< boost::shared_ptr<decode::Decoder> >& stack() const;
  79         void push(boost::shared_ptr<decode::Decoder> decoder);
  80         void remove(int index);
  81
  82         int64_t samples_decoded() const;
  83
  84         std::vector<decode::Row> get_visible_rows() const;
  85
  86         /**
  87          * Extracts sorted annotations between two period into a vector.
  88          */
  89         void get_annotation_subset(
  90                 std::vector<pv::data::decode::Annotation> &dest,
  91                 const decode::Row &row, uint64_t start_sample,
  92                 uint64_t end_sample) const;
  93
  94         QString error_message();
  95
  96         void clear();
  97
  98         uint64_t get_max_sample_count() const;
  99
 100         void begin_decode();
 101
 102 private:
 103         void decode_proc(boost::shared_ptr<data::Logic> data);
 104
 105         static void annotation_callback(srd_proto_data *pdata,
 106                 void *decoder);
 107
 108 signals:
 109         void new_decode_data();
 110
 111 private:
 112         pv::SigSession &_session;
 113
 114         /**
 115          * This mutex prevents more than one decode operation occuring
 116          * concurrently.
 117          * @todo A proper solution should be implemented to allow multiple
 118          * decode operations.
 119          */
 120         static boost::mutex _global_decode_mutex;
 121
 122         std::list< boost::shared_ptr<decode::Decoder> > _stack;
 123
 124         mutable boost::mutex _mutex;
 125         int64_t _samples_decoded;
 126
 127         std::map<const decode::Row, decode::RowData> _rows;
 128
 129         std::map<std::pair<const srd_decoder*, int>, decode::Row> _class_rows;
 130
 131         QString _error_message;
 132
 133         boost::thread _decode_thread;
 134
 135         friend class DecoderStackTest::TwoDecoderStack;
 136 };
 137
 138 } // namespace data
 139 } // namespace pv
 140
 141 #endif // PULSEVIEW_PV_DATA_DECODERSTACK_H