Replaced Decoder internal GHashTable storage of options with a std::map
[pulseview.git] / 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 namespace decode {
48 class Annotation;
49 }
50
51 }
52
53 namespace data {
54
55 namespace decode {
56 class Decoder;
57 }
58
59 class Logic;
60
61 class DecoderStack : public QObject, public SignalData
62 {
63         Q_OBJECT
64
65 private:
66         static const double DecodeMargin;
67         static const double DecodeThreshold;
68         static const int64_t DecodeChunkLength;
69
70 public:
71         DecoderStack(const srd_decoder *const decoder);
72
73         virtual ~DecoderStack();
74
75         const std::list< boost::shared_ptr<decode::Decoder> >& stack() const;
76         void push(boost::shared_ptr<decode::Decoder> decoder);
77         void remove(int index);
78
79         int64_t samples_decoded() const;
80
81         const std::vector< boost::shared_ptr<pv::view::decode::Annotation> >
82                 annotations() 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         static void annotation_callback(srd_proto_data *pdata,
96                 void *decoder);
97
98 signals:
99         void new_decode_data();
100
101 private:
102
103         /**
104          * This mutex prevents more than one decode operation occuring
105          * concurrently.
106          * @todo A proper solution should be implemented to allow multiple
107          * decode operations.
108          */
109         static boost::mutex _global_decode_mutex;
110
111         std::list< boost::shared_ptr<decode::Decoder> > _stack;
112
113         mutable boost::mutex _mutex;
114         int64_t _samples_decoded;
115         std::vector< boost::shared_ptr<pv::view::decode::Annotation> >
116                 _annotations;
117         QString _error_message;
118
119         boost::thread _decode_thread;
120
121         friend class DecoderStackTest::TwoDecoderStack;
122 };
123
124 } // namespace data
125 } // namespace pv
126
127 #endif // PULSEVIEW_PV_DATA_DECODERSTACK_H