Rename ENABLE_GSTREAMERMM to ENABLE_FLOW.
[pulseview.git] / pv / data / decodesignal.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
21 #define PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
22
23 #include <atomic>
24 #include <condition_variable>
25 #include <unordered_set>
26 #include <vector>
27
28 #include <QSettings>
29 #include <QString>
30
31 #include <libsigrokdecode/libsigrokdecode.h>
32
33 #include <pv/data/decode/row.hpp>
34 #include <pv/data/decode/rowdata.hpp>
35 #include <pv/data/signalbase.hpp>
36 #include <pv/util.hpp>
37
38 using std::atomic;
39 using std::condition_variable;
40 using std::map;
41 using std::mutex;
42 using std::pair;
43 using std::vector;
44 using std::shared_ptr;
45
46 namespace pv {
47 class Session;
48
49 namespace data {
50
51 namespace decode {
52 class Annotation;
53 class Decoder;
54 class Row;
55 }
56
57 class Logic;
58 class LogicSegment;
59 class SignalBase;
60 class SignalData;
61
62 struct DecodeChannel
63 {
64         uint16_t id;     ///< Global numerical ID for the decode channels in the stack
65         uint16_t bit_id; ///< Tells which bit within a sample represents this channel
66         const bool is_optional;
67         const pv::data::SignalBase *assigned_signal;
68         const QString name, desc;
69         int initial_pin_state;
70         const shared_ptr<pv::data::decode::Decoder> decoder_;
71         const srd_channel *pdch_;
72 };
73
74 struct DecodeSegment
75 {
76         map<const decode::Row, decode::RowData> annotation_rows;
77         pv::util::Timestamp start_time;
78         double samplerate;
79         int64_t samples_decoded_incl, samples_decoded_excl;
80 };
81
82 class DecodeSignal : public SignalBase
83 {
84         Q_OBJECT
85
86 private:
87         static const double DecodeMargin;
88         static const double DecodeThreshold;
89         static const int64_t DecodeChunkLength;
90
91 public:
92         DecodeSignal(pv::Session &session);
93         virtual ~DecodeSignal();
94
95         bool is_decode_signal() const;
96         const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const;
97
98         void stack_decoder(const srd_decoder *decoder);
99         void remove_decoder(int index);
100         bool toggle_decoder_visibility(int index);
101
102         void reset_decode(bool shutting_down = false);
103         void begin_decode();
104         void pause_decode();
105         void resume_decode();
106         bool is_paused() const;
107         QString error_message() const;
108
109         const vector<data::DecodeChannel> get_channels() const;
110         void auto_assign_signals(const shared_ptr<pv::data::decode::Decoder> dec);
111         void assign_signal(const uint16_t channel_id, const SignalBase *signal);
112         int get_assigned_signal_count() const;
113
114         void set_initial_pin_state(const uint16_t channel_id, const int init_state);
115
116         double samplerate() const;
117         const pv::util::Timestamp start_time() const;
118
119         /**
120          * Returns the number of samples that can be worked on,
121          * i.e. the number of samples where samples are available
122          * for all connected channels.
123          */
124         int64_t get_working_sample_count(uint32_t segment_id) const;
125
126         /**
127          * Returns the number of processed samples. Newly generated annotations will
128          * have sample numbers greater than this.
129          *
130          * If include_processing is true, this number will include the ones being
131          * currently processed (in case the decoder stack is running). In this case,
132          * newly generated annotations will have sample numbers smaller than this.
133          */
134         int64_t get_decoded_sample_count(uint32_t segment_id,
135                 bool include_processing) const;
136
137         vector<decode::Row> visible_rows() const;
138
139         /**
140          * Extracts annotations from a single row into a vector.
141          * Note: The annotations may be unsorted and only annotations that fully
142          * fit into the sample range are considered.
143          */
144         void get_annotation_subset(
145                 vector<pv::data::decode::Annotation> &dest,
146                 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
147                 uint64_t end_sample) const;
148
149         /**
150          * Extracts annotations from all rows into a vector.
151          * Note: The annotations may be unsorted and only annotations that fully
152          * fit into the sample range are considered.
153          */
154         void get_annotation_subset(
155                 vector<pv::data::decode::Annotation> &dest,
156                 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const;
157
158         virtual void save_settings(QSettings &settings) const;
159
160         virtual void restore_settings(QSettings &settings);
161
162 private:
163         void set_error_message(QString msg);
164
165         uint32_t get_input_segment_count() const;
166
167         uint32_t get_input_samplerate(uint32_t segment_id) const;
168
169         void update_channel_list();
170
171         void commit_decoder_channels();
172
173         void mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end);
174
175         void logic_mux_proc();
176
177         void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count,
178                 const shared_ptr<LogicSegment> input_segment);
179
180         void decode_proc();
181
182         void start_srd_session();
183         void terminate_srd_session();
184         void stop_srd_session();
185
186         void connect_input_notifiers();
187
188         void create_decode_segment();
189
190         static void annotation_callback(srd_proto_data *pdata, void *decode_signal);
191
192 Q_SIGNALS:
193         void new_annotations(); // TODO Supply segment for which they belong to
194         void decode_reset();
195         void decode_finished();
196         void channels_updated();
197
198 private Q_SLOTS:
199         void on_capture_state_changed(int state);
200         void on_data_cleared();
201         void on_data_received();
202
203 private:
204         pv::Session &session_;
205
206         vector<data::DecodeChannel> channels_;
207
208         struct srd_session *srd_session_;
209
210         shared_ptr<Logic> logic_mux_data_;
211         uint32_t logic_mux_unit_size_;
212         bool logic_mux_data_invalid_;
213
214         vector< shared_ptr<decode::Decoder> > stack_;
215         bool stack_config_changed_;
216         map<pair<const srd_decoder*, int>, decode::Row> class_rows_;
217
218         vector<DecodeSegment> segments_;
219         uint32_t current_segment_id_;
220
221         mutable mutex input_mutex_, output_mutex_, decode_pause_mutex_, logic_mux_mutex_;
222         mutable condition_variable decode_input_cond_, decode_pause_cond_,
223                 logic_mux_cond_;
224
225         std::thread decode_thread_, logic_mux_thread_;
226         atomic<bool> decode_interrupt_, logic_mux_interrupt_;
227
228         bool decode_paused_;
229
230         QString error_message_;
231 };
232
233 } // namespace data
234 } // namespace pv
235
236 #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP