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/optional.hpp>
  29 #include <boost/shared_ptr.hpp>
  30 #include <boost/thread.hpp>
  31
  32 #include <QObject>
  33 #include <QString>
  34
  35 #include <pv/data/decode/row.h>
  36 #include <pv/data/decode/rowdata.h>
  37
  38 struct srd_decoder;
  39 struct srd_decoder_annotation_row;
  40 struct srd_probe;
  41 struct srd_proto_data;
  42 struct srd_session;
  43
  44 namespace DecoderStackTest {
  45 class TwoDecoderStack;
  46 }
  47
  48 namespace pv {
  49
  50 class SigSession;
  51
  52 namespace view {
  53 class LogicSignal;
  54 }
  55
  56 namespace data {
  57
  58 class LogicSnapshot;
  59
  60 namespace decode {
  61 class Annotation;
  62 class Decoder;
  63 }
  64
  65 class Logic;
  66
  67 class DecoderStack : public QObject, public SignalData
  68 {
  69         Q_OBJECT
  70
  71 private:
  72         static const double DecodeMargin;
  73         static const double DecodeThreshold;
  74         static const int64_t DecodeChunkLength;
  75         static const unsigned int DecodeNotifyPeriod;
  76
  77 public:
  78         DecoderStack(pv::SigSession &_session,
  79                 const srd_decoder *const decoder);
  80
  81         virtual ~DecoderStack();
  82
  83         const std::list< boost::shared_ptr<decode::Decoder> >& stack() const;
  84         void push(boost::shared_ptr<decode::Decoder> decoder);
  85         void remove(int index);
  86
  87         int64_t samples_decoded() const;
  88
  89         std::vector<decode::Row> get_visible_rows() const;
  90
  91         /**
  92          * Extracts sorted annotations between two period into a vector.
  93          */
  94         void get_annotation_subset(
  95                 std::vector<pv::data::decode::Annotation> &dest,
  96                 const decode::Row &row, uint64_t start_sample,
  97                 uint64_t end_sample) const;
  98
  99         QString error_message();
 100
 101         void clear();
 102
 103         uint64_t get_max_sample_count() const;
 104
 105         void begin_decode();
 106
 107 private:
 108         boost::optional<int64_t> wait_for_data() const;
 109
 110         void decode_data(const int64_t sample_count,
 111                 const unsigned int unit_size, srd_session *const session);
 112
 113         void decode_proc();
 114
 115         static void annotation_callback(srd_proto_data *pdata,
 116                 void *decoder);
 117
 118 private slots:
 119         void on_new_frame();
 120
 121         void on_data_received();
 122
 123         void on_frame_ended();
 124
 125 signals:
 126         void new_decode_data();
 127
 128 private:
 129         pv::SigSession &_session;
 130
 131         /**
 132          * This mutex prevents more than one decode operation occuring
 133          * concurrently.
 134          * @todo A proper solution should be implemented to allow multiple
 135          * decode operations.
 136          */
 137         static boost::mutex _global_decode_mutex;
 138
 139         std::list< boost::shared_ptr<decode::Decoder> > _stack;
 140
 141         boost::shared_ptr<pv::data::LogicSnapshot> _snapshot;
 142
 143         mutable boost::mutex _input_mutex;
 144         mutable boost::condition_variable _input_cond;
 145         int64_t _sample_count;
 146         bool _frame_complete;
 147
 148         mutable boost::mutex _output_mutex;
 149         int64_t _samples_decoded;
 150
 151         std::map<const decode::Row, decode::RowData> _rows;
 152
 153         std::map<std::pair<const srd_decoder*, int>, decode::Row> _class_rows;
 154
 155         QString _error_message;
 156
 157         boost::thread _decode_thread;
 158
 159         friend class DecoderStackTest::TwoDecoderStack;
 160 };
 161
 162 } // namespace data
 163 } // namespace pv
 164
 165 #endif // PULSEVIEW_PV_DATA_DECODERSTACK_H