]>
Commit | Line | Data |
---|---|---|
ad908057 SA |
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 | ||
47747218 | 23 | #include <atomic> |
c8a6db0e | 24 | #include <deque> |
47747218 | 25 | #include <condition_variable> |
132a5c6d | 26 | #include <unordered_set> |
ecd07c20 SA |
27 | #include <vector> |
28 | ||
9431e2d3 | 29 | #include <QDebug> |
47747218 | 30 | #include <QSettings> |
ecd07c20 | 31 | |
ad908057 SA |
32 | #include <libsigrokdecode/libsigrokdecode.h> |
33 | ||
a82325d1 | 34 | #include <pv/data/decode/decoder.hpp> |
47747218 SA |
35 | #include <pv/data/decode/row.hpp> |
36 | #include <pv/data/decode/rowdata.hpp> | |
ad908057 | 37 | #include <pv/data/signalbase.hpp> |
946b52e1 | 38 | #include <pv/util.hpp> |
ad908057 | 39 | |
47747218 SA |
40 | using std::atomic; |
41 | using std::condition_variable; | |
c8a6db0e | 42 | using std::deque; |
47747218 SA |
43 | using std::map; |
44 | using std::mutex; | |
ecd07c20 | 45 | using std::vector; |
ad908057 SA |
46 | using std::shared_ptr; |
47 | ||
6a26fc44 SA |
48 | using pv::data::decode::Annotation; |
49 | using pv::data::decode::DecodeBinaryClassInfo; | |
50 | using pv::data::decode::DecodeChannel; | |
51 | using pv::data::decode::Decoder; | |
52 | using pv::data::decode::Row; | |
53 | using pv::data::decode::RowData; | |
54 | ||
ad908057 | 55 | namespace pv { |
47747218 SA |
56 | class Session; |
57 | ||
ad908057 SA |
58 | namespace data { |
59 | ||
ad908057 | 60 | class Logic; |
47747218 | 61 | class LogicSegment; |
9f97b357 | 62 | class SignalBase; |
ad908057 SA |
63 | class SignalData; |
64 | ||
e77de61f | 65 | struct DecodeBinaryDataChunk |
c0c3e62a SA |
66 | { |
67 | vector<uint8_t> data; | |
68 | uint64_t sample; ///< Number of the sample where this data was provided by the PD | |
69 | }; | |
70 | ||
e77de61f SA |
71 | struct DecodeBinaryClass |
72 | { | |
6a26fc44 SA |
73 | const Decoder* decoder; |
74 | const DecodeBinaryClassInfo* info; | |
c8a6db0e | 75 | deque<DecodeBinaryDataChunk> chunks; |
e77de61f SA |
76 | }; |
77 | ||
72435789 SA |
78 | struct DecodeSegment |
79 | { | |
f54e68b0 SA |
80 | // Constructor is a no-op |
81 | DecodeSegment() { }; | |
82 | // Copy constructor is a no-op | |
9431e2d3 | 83 | DecodeSegment(DecodeSegment&& ds) { (void)ds; qCritical() << "Empty DecodeSegment copy constructor called"; }; |
f54e68b0 | 84 | |
1dcd9b18 | 85 | map<const Row*, RowData> annotation_rows; // Note: Row is the same for all segments while RowData is not |
72435789 SA |
86 | pv::util::Timestamp start_time; |
87 | double samplerate; | |
b82908ab | 88 | int64_t samples_decoded_incl, samples_decoded_excl; |
e77de61f | 89 | vector<DecodeBinaryClass> binary_classes; |
f54e68b0 | 90 | deque<const Annotation*> all_annotations; |
72435789 SA |
91 | }; |
92 | ||
ad908057 SA |
93 | class DecodeSignal : public SignalBase |
94 | { | |
95 | Q_OBJECT | |
96 | ||
47747218 SA |
97 | private: |
98 | static const double DecodeMargin; | |
99 | static const double DecodeThreshold; | |
100 | static const int64_t DecodeChunkLength; | |
47747218 | 101 | |
ad908057 | 102 | public: |
47747218 | 103 | DecodeSignal(pv::Session &session); |
ad908057 SA |
104 | virtual ~DecodeSignal(); |
105 | ||
cb630543 SA |
106 | /** |
107 | * Sets the name of the signal. | |
108 | */ | |
109 | virtual void set_name(QString name); | |
110 | ||
111 | /** | |
112 | * Set the color of the signal. | |
113 | */ | |
114 | virtual void set_color(QColor color); | |
115 | ||
ad908057 | 116 | bool is_decode_signal() const; |
6a26fc44 | 117 | const vector< shared_ptr<Decoder> >& decoder_stack() const; |
ad908057 | 118 | |
ed75426f | 119 | void stack_decoder(const srd_decoder *decoder, bool restart_decode=true); |
ad908057 SA |
120 | void remove_decoder(int index); |
121 | bool toggle_decoder_visibility(int index); | |
122 | ||
8ce0e732 | 123 | void reset_decode(bool shutting_down = false); |
946b52e1 | 124 | void begin_decode(); |
556259d2 SA |
125 | void pause_decode(); |
126 | void resume_decode(); | |
127 | bool is_paused() const; | |
ecd07c20 | 128 | |
6a26fc44 SA |
129 | const vector<decode::DecodeChannel> get_channels() const; |
130 | void auto_assign_signals(const shared_ptr<Decoder> dec); | |
cf1541a1 | 131 | void assign_signal(const uint16_t channel_id, shared_ptr<const SignalBase> signal); |
27a3f09b | 132 | int get_assigned_signal_count() const; |
9f97b357 | 133 | |
04b04675 SA |
134 | void update_output_signals(); |
135 | ||
9f97b357 SA |
136 | void set_initial_pin_state(const uint16_t channel_id, const int init_state); |
137 | ||
85125b0f | 138 | virtual double get_samplerate() const; |
72435789 | 139 | const pv::util::Timestamp start_time() const; |
0c5fe73e SA |
140 | |
141 | /** | |
142 | * Returns the number of samples that can be worked on, | |
143 | * i.e. the number of samples where samples are available | |
144 | * for all connected channels. | |
145 | */ | |
5ecf957f | 146 | int64_t get_working_sample_count(uint32_t segment_id) const; |
0c5fe73e | 147 | |
b82908ab SA |
148 | /** |
149 | * Returns the number of processed samples. Newly generated annotations will | |
150 | * have sample numbers greater than this. | |
151 | * | |
152 | * If include_processing is true, this number will include the ones being | |
153 | * currently processed (in case the decoder stack is running). In this case, | |
154 | * newly generated annotations will have sample numbers smaller than this. | |
155 | */ | |
156 | int64_t get_decoded_sample_count(uint32_t segment_id, | |
157 | bool include_processing) const; | |
ff83d980 | 158 | |
6a26fc44 SA |
159 | vector<Row*> get_rows(bool visible_only=false); |
160 | vector<const Row*> get_rows(bool visible_only=false) const; | |
f994f496 | 161 | |
6a26fc44 | 162 | uint64_t get_annotation_count(const Row* row, uint32_t segment_id) const; |
ecd07c20 SA |
163 | |
164 | /** | |
5a914348 SA |
165 | * Extracts annotations from a single row into a vector. |
166 | * Note: The annotations may be unsorted and only annotations that fully | |
4caaaace | 167 | * fit into the sample range are considered. |
ecd07c20 | 168 | */ |
462941e2 | 169 | void get_annotation_subset(deque<const Annotation*> &dest, const Row* row, |
6a26fc44 | 170 | uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const; |
ecd07c20 | 171 | |
5a914348 SA |
172 | /** |
173 | * Extracts annotations from all rows into a vector. | |
174 | * Note: The annotations may be unsorted and only annotations that fully | |
175 | * fit into the sample range are considered. | |
176 | */ | |
462941e2 | 177 | void get_annotation_subset(deque<const Annotation*> &dest, uint32_t segment_id, |
6a26fc44 | 178 | uint64_t start_sample, uint64_t end_sample) const; |
5a914348 | 179 | |
e77de61f | 180 | uint32_t get_binary_data_chunk_count(uint32_t segment_id, |
6a26fc44 SA |
181 | const Decoder* dec, uint32_t bin_class_id) const; |
182 | void get_binary_data_chunk(uint32_t segment_id, const Decoder* dec, | |
ac9494ef | 183 | uint32_t bin_class_id, uint32_t chunk_id, const vector<uint8_t> **dest, |
e77de61f | 184 | uint64_t *size); |
13b726cd | 185 | void get_merged_binary_data_chunks_by_sample(uint32_t segment_id, |
6a26fc44 | 186 | const Decoder* dec, uint32_t bin_class_id, |
13b726cd SA |
187 | uint64_t start_sample, uint64_t end_sample, |
188 | vector<uint8_t> *dest) const; | |
189 | void get_merged_binary_data_chunks_by_offset(uint32_t segment_id, | |
6a26fc44 | 190 | const Decoder* dec, uint32_t bin_class_id, |
13b726cd | 191 | uint64_t start, uint64_t end, |
e77de61f | 192 | vector<uint8_t> *dest) const; |
628b45cc | 193 | const DecodeBinaryClass* get_binary_data_class(uint32_t segment_id, |
6a26fc44 | 194 | const Decoder* dec, uint32_t bin_class_id) const; |
c0c3e62a | 195 | |
f54e68b0 SA |
196 | const deque<const Annotation*>* get_all_annotations_by_segment(uint32_t segment_id) const; |
197 | ||
47747218 SA |
198 | virtual void save_settings(QSettings &settings) const; |
199 | ||
200 | virtual void restore_settings(QSettings &settings); | |
201 | ||
9f97b357 | 202 | private: |
144e72c9 | 203 | bool all_input_segments_complete(uint32_t segment_id) const; |
8a603e13 | 204 | uint32_t get_input_segment_count() const; |
2a12830c | 205 | double get_input_samplerate(uint32_t segment_id) const; |
8a603e13 | 206 | |
6a26fc44 SA |
207 | Decoder* get_decoder_by_instance(const srd_decoder *const srd_dec); |
208 | ||
9f97b357 SA |
209 | void update_channel_list(); |
210 | ||
27a3f09b | 211 | void commit_decoder_channels(); |
47747218 | 212 | |
ed535cd7 | 213 | void mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end); |
27a3f09b | 214 | void logic_mux_proc(); |
47747218 | 215 | |
8a603e13 | 216 | void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count, |
cf1541a1 | 217 | const shared_ptr<const LogicSegment> input_segment); |
47747218 SA |
218 | void decode_proc(); |
219 | ||
e91883bb | 220 | void start_srd_session(); |
ce0b6a40 | 221 | void terminate_srd_session(); |
e91883bb SA |
222 | void stop_srd_session(); |
223 | ||
a8a9222d | 224 | void connect_input_notifiers(); |
db51130d | 225 | void disconnect_input_notifiers(); |
a8a9222d | 226 | |
65efd025 | 227 | void create_decode_segment(); |
72435789 | 228 | |
47747218 | 229 | static void annotation_callback(srd_proto_data *pdata, void *decode_signal); |
c0c3e62a | 230 | static void binary_callback(srd_proto_data *pdata, void *decode_signal); |
04b04675 | 231 | static void logic_output_callback(srd_proto_data *pdata, void *decode_signal); |
47747218 | 232 | |
ad908057 | 233 | Q_SIGNALS: |
e77de61f SA |
234 | void decoder_stacked(void* decoder); ///< decoder is of type decode::Decoder* |
235 | void decoder_removed(void* decoder); ///< decoder is of type decode::Decoder* | |
5ecf957f | 236 | void new_annotations(); // TODO Supply segment for which they belong to |
b2b18d3a | 237 | void new_binary_data(unsigned int segment_id, void* decoder, unsigned int bin_class_id); |
eee3eab9 | 238 | void decode_reset(); |
1b56c646 | 239 | void decode_finished(); |
9f97b357 | 240 | void channels_updated(); |
02078aa1 | 241 | void annotation_visibility_changed(); |
ad908057 SA |
242 | |
243 | private Q_SLOTS: | |
47747218 | 244 | void on_capture_state_changed(int state); |
1b56c646 | 245 | void on_data_cleared(); |
47747218 | 246 | void on_data_received(); |
db51130d | 247 | void on_input_segment_completed(); |
ad908057 | 248 | |
02078aa1 SA |
249 | void on_annotation_visibility_changed(); |
250 | ||
ad908057 | 251 | private: |
47747218 SA |
252 | pv::Session &session_; |
253 | ||
6a26fc44 | 254 | vector<decode::DecodeChannel> channels_; |
47747218 | 255 | |
e91883bb SA |
256 | struct srd_session *srd_session_; |
257 | ||
47747218 | 258 | shared_ptr<Logic> logic_mux_data_; |
ed535cd7 | 259 | uint32_t logic_mux_unit_size_; |
47747218 SA |
260 | bool logic_mux_data_invalid_; |
261 | ||
6a26fc44 | 262 | vector< shared_ptr<Decoder> > stack_; |
e3202557 | 263 | bool stack_config_changed_; |
47747218 | 264 | |
9431e2d3 | 265 | deque<DecodeSegment> segments_; |
72435789 | 266 | uint32_t current_segment_id_; |
4913560f | 267 | |
556259d2 SA |
268 | mutable mutex input_mutex_, output_mutex_, decode_pause_mutex_, logic_mux_mutex_; |
269 | mutable condition_variable decode_input_cond_, decode_pause_cond_, | |
270 | logic_mux_cond_; | |
47747218 SA |
271 | |
272 | std::thread decode_thread_, logic_mux_thread_; | |
273 | atomic<bool> decode_interrupt_, logic_mux_interrupt_; | |
274 | ||
556259d2 | 275 | bool decode_paused_; |
04b04675 SA |
276 | |
277 | map<const srd_decoder*, shared_ptr<Logic>> output_logic_; | |
76da6e9e | 278 | map<const srd_decoder*, vector<uint8_t>> output_logic_muxed_data_; |
04b04675 | 279 | vector< shared_ptr<SignalBase>> output_signals_; |
ad908057 SA |
280 | }; |
281 | ||
282 | } // namespace data | |
283 | } // namespace pv | |
284 | ||
285 | #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP |