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 struct srd_decoder;
  35 struct srd_probe;
  36 struct srd_proto_data;
  37
  38 namespace DecoderStackTest {
  39 class TwoDecoderStack;
  40 }
  41
  42 namespace pv {
  43
  44 namespace view {
  45 class LogicSignal;
  46 }
  47
  48 namespace data {
  49
  50 namespace decode {
  51 class Annotation;
  52 class Decoder;
  53 }
  54
  55 class Logic;
  56
  57 class DecoderStack : public QObject, public SignalData
  58 {
  59         Q_OBJECT
  60
  61 private:
  62         static const double DecodeMargin;
  63         static const double DecodeThreshold;
  64         static const int64_t DecodeChunkLength;
  65
  66 public:
  67         DecoderStack(const srd_decoder *const decoder);
  68
  69         virtual ~DecoderStack();
  70
  71         const std::list< boost::shared_ptr<decode::Decoder> >& stack() const;
  72         void push(boost::shared_ptr<decode::Decoder> decoder);
  73         void remove(int index);
  74
  75         int64_t samples_decoded() const;
  76
  77         /**
  78          * Extracts sorted annotations between two period into a vector.
  79          */
  80         void get_annotation_subset(
  81                 std::vector<pv::data::decode::Annotation> &dest,
  82                 uint64_t start_sample, uint64_t end_sample) const;
  83
  84         QString error_message();
  85
  86         void clear();
  87
  88         uint64_t get_max_sample_count() const;
  89
  90         void begin_decode();
  91
  92 private:
  93         void decode_proc(boost::shared_ptr<data::Logic> data);
  94
  95         bool index_entry_start_sample_gt(
  96                 const uint64_t sample, const size_t index) const;
  97         bool index_entry_end_sample_lt(
  98                 const size_t index, const uint64_t sample) const;
  99         bool index_entry_end_sample_gt(
 100                 const uint64_t sample, const size_t index) const;
 101
 102         void insert_annotation_into_start_index(
 103                 const pv::data::decode::Annotation &a,
 104                 const size_t storage_offset);
 105         void insert_annotation_into_end_index(
 106                 const pv::data::decode::Annotation &a,
 107                 const size_t storage_offset);
 108
 109         static void annotation_callback(srd_proto_data *pdata,
 110                 void *decoder);
 111
 112 signals:
 113         void new_decode_data();
 114
 115 private:
 116
 117         /**
 118          * This mutex prevents more than one decode operation occuring
 119          * concurrently.
 120          * @todo A proper solution should be implemented to allow multiple
 121          * decode operations.
 122          */
 123         static boost::mutex _global_decode_mutex;
 124
 125         std::list< boost::shared_ptr<decode::Decoder> > _stack;
 126
 127         mutable boost::mutex _mutex;
 128         int64_t _samples_decoded;
 129         std::vector<pv::data::decode::Annotation> _annotations;
 130
 131         /**
 132          * _ann_start_index and _ann_end_index contain lists of annotions
 133          * (represented by offsets in the _annotations vector), sorted in
 134          * ascending ordered by the start_sample and end_sample respectively.
 135          */
 136         std::vector<size_t> _ann_start_index, _ann_end_index;
 137
 138         QString _error_message;
 139
 140         boost::thread _decode_thread;
 141
 142         friend class DecoderStackTest::TwoDecoderStack;
 143 };
 144
 145 } // namespace data
 146 } // namespace pv
 147
 148 #endif // PULSEVIEW_PV_DATA_DECODERSTACK_H