]>
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 | ||
47747218 | 29 | #include <QSettings> |
ecd07c20 SA |
30 | #include <QString> |
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 | |
83 | DecodeSegment(DecodeSegment&& ds) { (void)ds; }; | |
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 | ||
106 | bool is_decode_signal() const; | |
6a26fc44 | 107 | const vector< shared_ptr<Decoder> >& decoder_stack() const; |
ad908057 | 108 | |
ed75426f | 109 | void stack_decoder(const srd_decoder *decoder, bool restart_decode=true); |
ad908057 SA |
110 | void remove_decoder(int index); |
111 | bool toggle_decoder_visibility(int index); | |
112 | ||
8ce0e732 | 113 | void reset_decode(bool shutting_down = false); |
946b52e1 | 114 | void begin_decode(); |
556259d2 SA |
115 | void pause_decode(); |
116 | void resume_decode(); | |
117 | bool is_paused() const; | |
ecd07c20 SA |
118 | QString error_message() const; |
119 | ||
6a26fc44 SA |
120 | const vector<decode::DecodeChannel> get_channels() const; |
121 | void auto_assign_signals(const shared_ptr<Decoder> dec); | |
9f97b357 | 122 | void assign_signal(const uint16_t channel_id, const SignalBase *signal); |
27a3f09b | 123 | int get_assigned_signal_count() const; |
9f97b357 SA |
124 | |
125 | void set_initial_pin_state(const uint16_t channel_id, const int init_state); | |
126 | ||
85125b0f | 127 | virtual double get_samplerate() const; |
72435789 | 128 | const pv::util::Timestamp start_time() const; |
0c5fe73e SA |
129 | |
130 | /** | |
131 | * Returns the number of samples that can be worked on, | |
132 | * i.e. the number of samples where samples are available | |
133 | * for all connected channels. | |
134 | */ | |
5ecf957f | 135 | int64_t get_working_sample_count(uint32_t segment_id) const; |
0c5fe73e | 136 | |
b82908ab SA |
137 | /** |
138 | * Returns the number of processed samples. Newly generated annotations will | |
139 | * have sample numbers greater than this. | |
140 | * | |
141 | * If include_processing is true, this number will include the ones being | |
142 | * currently processed (in case the decoder stack is running). In this case, | |
143 | * newly generated annotations will have sample numbers smaller than this. | |
144 | */ | |
145 | int64_t get_decoded_sample_count(uint32_t segment_id, | |
146 | bool include_processing) const; | |
ff83d980 | 147 | |
6a26fc44 SA |
148 | vector<Row*> get_rows(bool visible_only=false); |
149 | vector<const Row*> get_rows(bool visible_only=false) const; | |
f994f496 | 150 | |
6a26fc44 | 151 | uint64_t get_annotation_count(const Row* row, uint32_t segment_id) const; |
ecd07c20 SA |
152 | |
153 | /** | |
5a914348 SA |
154 | * Extracts annotations from a single row into a vector. |
155 | * Note: The annotations may be unsorted and only annotations that fully | |
4caaaace | 156 | * fit into the sample range are considered. |
ecd07c20 | 157 | */ |
462941e2 | 158 | void get_annotation_subset(deque<const Annotation*> &dest, const Row* row, |
6a26fc44 | 159 | uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const; |
ecd07c20 | 160 | |
5a914348 SA |
161 | /** |
162 | * Extracts annotations from all rows into a vector. | |
163 | * Note: The annotations may be unsorted and only annotations that fully | |
164 | * fit into the sample range are considered. | |
165 | */ | |
462941e2 | 166 | void get_annotation_subset(deque<const Annotation*> &dest, uint32_t segment_id, |
6a26fc44 | 167 | uint64_t start_sample, uint64_t end_sample) const; |
5a914348 | 168 | |
e77de61f | 169 | uint32_t get_binary_data_chunk_count(uint32_t segment_id, |
6a26fc44 SA |
170 | const Decoder* dec, uint32_t bin_class_id) const; |
171 | void get_binary_data_chunk(uint32_t segment_id, const Decoder* dec, | |
ac9494ef | 172 | uint32_t bin_class_id, uint32_t chunk_id, const vector<uint8_t> **dest, |
e77de61f | 173 | uint64_t *size); |
13b726cd | 174 | void get_merged_binary_data_chunks_by_sample(uint32_t segment_id, |
6a26fc44 | 175 | const Decoder* dec, uint32_t bin_class_id, |
13b726cd SA |
176 | uint64_t start_sample, uint64_t end_sample, |
177 | vector<uint8_t> *dest) const; | |
178 | void get_merged_binary_data_chunks_by_offset(uint32_t segment_id, | |
6a26fc44 | 179 | const Decoder* dec, uint32_t bin_class_id, |
13b726cd | 180 | uint64_t start, uint64_t end, |
e77de61f | 181 | vector<uint8_t> *dest) const; |
628b45cc | 182 | const DecodeBinaryClass* get_binary_data_class(uint32_t segment_id, |
6a26fc44 | 183 | const Decoder* dec, uint32_t bin_class_id) const; |
c0c3e62a | 184 | |
f54e68b0 SA |
185 | const deque<const Annotation*>* get_all_annotations_by_segment(uint32_t segment_id) const; |
186 | ||
47747218 SA |
187 | virtual void save_settings(QSettings &settings) const; |
188 | ||
189 | virtual void restore_settings(QSettings &settings); | |
190 | ||
9f97b357 | 191 | private: |
403c3e87 SA |
192 | void set_error_message(QString msg); |
193 | ||
8a603e13 | 194 | uint32_t get_input_segment_count() const; |
8a603e13 SA |
195 | uint32_t get_input_samplerate(uint32_t segment_id) const; |
196 | ||
6a26fc44 SA |
197 | Decoder* get_decoder_by_instance(const srd_decoder *const srd_dec); |
198 | ||
9f97b357 SA |
199 | void update_channel_list(); |
200 | ||
27a3f09b | 201 | void commit_decoder_channels(); |
47747218 | 202 | |
ed535cd7 | 203 | void mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end); |
27a3f09b | 204 | void logic_mux_proc(); |
47747218 | 205 | |
8a603e13 SA |
206 | void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count, |
207 | const shared_ptr<LogicSegment> input_segment); | |
47747218 SA |
208 | void decode_proc(); |
209 | ||
e91883bb | 210 | void start_srd_session(); |
ce0b6a40 | 211 | void terminate_srd_session(); |
e91883bb SA |
212 | void stop_srd_session(); |
213 | ||
a8a9222d SA |
214 | void connect_input_notifiers(); |
215 | ||
65efd025 | 216 | void create_decode_segment(); |
72435789 | 217 | |
47747218 | 218 | static void annotation_callback(srd_proto_data *pdata, void *decode_signal); |
c0c3e62a | 219 | static void binary_callback(srd_proto_data *pdata, void *decode_signal); |
47747218 | 220 | |
ad908057 | 221 | Q_SIGNALS: |
e77de61f SA |
222 | void decoder_stacked(void* decoder); ///< decoder is of type decode::Decoder* |
223 | void decoder_removed(void* decoder); ///< decoder is of type decode::Decoder* | |
5ecf957f | 224 | void new_annotations(); // TODO Supply segment for which they belong to |
b2b18d3a | 225 | void new_binary_data(unsigned int segment_id, void* decoder, unsigned int bin_class_id); |
eee3eab9 | 226 | void decode_reset(); |
1b56c646 | 227 | void decode_finished(); |
9f97b357 | 228 | void channels_updated(); |
02078aa1 | 229 | void annotation_visibility_changed(); |
ad908057 SA |
230 | |
231 | private Q_SLOTS: | |
47747218 | 232 | void on_capture_state_changed(int state); |
1b56c646 | 233 | void on_data_cleared(); |
47747218 | 234 | void on_data_received(); |
ad908057 | 235 | |
02078aa1 SA |
236 | void on_annotation_visibility_changed(); |
237 | ||
ad908057 | 238 | private: |
47747218 SA |
239 | pv::Session &session_; |
240 | ||
6a26fc44 | 241 | vector<decode::DecodeChannel> channels_; |
47747218 | 242 | |
e91883bb SA |
243 | struct srd_session *srd_session_; |
244 | ||
47747218 | 245 | shared_ptr<Logic> logic_mux_data_; |
ed535cd7 | 246 | uint32_t logic_mux_unit_size_; |
47747218 SA |
247 | bool logic_mux_data_invalid_; |
248 | ||
6a26fc44 | 249 | vector< shared_ptr<Decoder> > stack_; |
e3202557 | 250 | bool stack_config_changed_; |
47747218 | 251 | |
72435789 SA |
252 | vector<DecodeSegment> segments_; |
253 | uint32_t current_segment_id_; | |
4913560f | 254 | |
556259d2 SA |
255 | mutable mutex input_mutex_, output_mutex_, decode_pause_mutex_, logic_mux_mutex_; |
256 | mutable condition_variable decode_input_cond_, decode_pause_cond_, | |
257 | logic_mux_cond_; | |
47747218 SA |
258 | |
259 | std::thread decode_thread_, logic_mux_thread_; | |
260 | atomic<bool> decode_interrupt_, logic_mux_interrupt_; | |
261 | ||
556259d2 SA |
262 | bool decode_paused_; |
263 | ||
47747218 | 264 | QString error_message_; |
ad908057 SA |
265 | }; |
266 | ||
267 | } // namespace data | |
268 | } // namespace pv | |
269 | ||
270 | #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP |