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