]>
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; | |
45 | using std::pair; | |
ecd07c20 | 46 | using std::vector; |
ad908057 SA |
47 | using std::shared_ptr; |
48 | ||
49 | namespace pv { | |
47747218 SA |
50 | class Session; |
51 | ||
ad908057 SA |
52 | namespace data { |
53 | ||
ecd07c20 SA |
54 | namespace decode { |
55 | class Annotation; | |
56 | class Decoder; | |
57 | class Row; | |
58 | } | |
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 | { | |
73 | const decode::Decoder* decoder; | |
74 | const decode::DecodeBinaryClassInfo* info; | |
c8a6db0e | 75 | deque<DecodeBinaryDataChunk> chunks; |
e77de61f SA |
76 | }; |
77 | ||
72435789 SA |
78 | struct DecodeSegment |
79 | { | |
80 | map<const decode::Row, decode::RowData> annotation_rows; | |
81 | pv::util::Timestamp start_time; | |
82 | double samplerate; | |
b82908ab | 83 | int64_t samples_decoded_incl, samples_decoded_excl; |
e77de61f | 84 | vector<DecodeBinaryClass> binary_classes; |
72435789 SA |
85 | }; |
86 | ||
ad908057 SA |
87 | class DecodeSignal : public SignalBase |
88 | { | |
89 | Q_OBJECT | |
90 | ||
47747218 SA |
91 | private: |
92 | static const double DecodeMargin; | |
93 | static const double DecodeThreshold; | |
94 | static const int64_t DecodeChunkLength; | |
47747218 | 95 | |
ad908057 | 96 | public: |
47747218 | 97 | DecodeSignal(pv::Session &session); |
ad908057 SA |
98 | virtual ~DecodeSignal(); |
99 | ||
100 | bool is_decode_signal() const; | |
47747218 | 101 | const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const; |
ad908057 | 102 | |
c8e60bdf | 103 | void stack_decoder(const srd_decoder *decoder); |
ad908057 SA |
104 | void remove_decoder(int index); |
105 | bool toggle_decoder_visibility(int index); | |
106 | ||
8ce0e732 | 107 | void reset_decode(bool shutting_down = false); |
946b52e1 | 108 | void begin_decode(); |
556259d2 SA |
109 | void pause_decode(); |
110 | void resume_decode(); | |
111 | bool is_paused() const; | |
ecd07c20 SA |
112 | QString error_message() const; |
113 | ||
a82325d1 | 114 | const vector<data::decode::DecodeChannel> get_channels() const; |
762ab7a4 | 115 | void auto_assign_signals(const shared_ptr<pv::data::decode::Decoder> dec); |
9f97b357 | 116 | void assign_signal(const uint16_t channel_id, const SignalBase *signal); |
27a3f09b | 117 | int get_assigned_signal_count() const; |
9f97b357 SA |
118 | |
119 | void set_initial_pin_state(const uint16_t channel_id, const int init_state); | |
120 | ||
ff83d980 | 121 | double samplerate() const; |
72435789 | 122 | const pv::util::Timestamp start_time() const; |
0c5fe73e SA |
123 | |
124 | /** | |
125 | * Returns the number of samples that can be worked on, | |
126 | * i.e. the number of samples where samples are available | |
127 | * for all connected channels. | |
128 | */ | |
5ecf957f | 129 | int64_t get_working_sample_count(uint32_t segment_id) const; |
0c5fe73e | 130 | |
b82908ab SA |
131 | /** |
132 | * Returns the number of processed samples. Newly generated annotations will | |
133 | * have sample numbers greater than this. | |
134 | * | |
135 | * If include_processing is true, this number will include the ones being | |
136 | * currently processed (in case the decoder stack is running). In this case, | |
137 | * newly generated annotations will have sample numbers smaller than this. | |
138 | */ | |
139 | int64_t get_decoded_sample_count(uint32_t segment_id, | |
140 | bool include_processing) const; | |
ff83d980 | 141 | |
ab185f78 | 142 | vector<decode::Row> get_rows(bool visible_only) const; |
ecd07c20 SA |
143 | |
144 | /** | |
5a914348 SA |
145 | * Extracts annotations from a single row into a vector. |
146 | * Note: The annotations may be unsorted and only annotations that fully | |
4caaaace | 147 | * fit into the sample range are considered. |
ecd07c20 SA |
148 | */ |
149 | void get_annotation_subset( | |
150 | vector<pv::data::decode::Annotation> &dest, | |
72435789 | 151 | const decode::Row &row, uint32_t segment_id, uint64_t start_sample, |
ecd07c20 SA |
152 | uint64_t end_sample) const; |
153 | ||
5a914348 SA |
154 | /** |
155 | * Extracts annotations from all rows into a vector. | |
156 | * Note: The annotations may be unsorted and only annotations that fully | |
157 | * fit into the sample range are considered. | |
158 | */ | |
159 | void get_annotation_subset( | |
160 | vector<pv::data::decode::Annotation> &dest, | |
161 | uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const; | |
162 | ||
e77de61f | 163 | uint32_t get_binary_data_chunk_count(uint32_t segment_id, |
ac9494ef | 164 | const data::decode::Decoder* dec, uint32_t bin_class_id) const; |
e77de61f | 165 | void get_binary_data_chunk(uint32_t segment_id, const data::decode::Decoder* dec, |
ac9494ef | 166 | uint32_t bin_class_id, uint32_t chunk_id, const vector<uint8_t> **dest, |
e77de61f SA |
167 | uint64_t *size); |
168 | void get_binary_data_chunks_merged(uint32_t segment_id, const data::decode::Decoder* dec, | |
ac9494ef | 169 | uint32_t bin_class_id, uint64_t start_sample, uint64_t end_sample, |
e77de61f | 170 | vector<uint8_t> *dest) const; |
628b45cc | 171 | const DecodeBinaryClass* get_binary_data_class(uint32_t segment_id, |
ac9494ef | 172 | const data::decode::Decoder* dec, uint32_t bin_class_id) const; |
c0c3e62a | 173 | |
47747218 SA |
174 | virtual void save_settings(QSettings &settings) const; |
175 | ||
176 | virtual void restore_settings(QSettings &settings); | |
177 | ||
9f97b357 | 178 | private: |
403c3e87 SA |
179 | void set_error_message(QString msg); |
180 | ||
8a603e13 SA |
181 | uint32_t get_input_segment_count() const; |
182 | ||
183 | uint32_t get_input_samplerate(uint32_t segment_id) const; | |
184 | ||
9f97b357 SA |
185 | void update_channel_list(); |
186 | ||
27a3f09b | 187 | void commit_decoder_channels(); |
47747218 | 188 | |
ed535cd7 | 189 | void mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end); |
27a3f09b SA |
190 | |
191 | void logic_mux_proc(); | |
47747218 | 192 | |
8a603e13 SA |
193 | void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count, |
194 | const shared_ptr<LogicSegment> input_segment); | |
47747218 SA |
195 | |
196 | void decode_proc(); | |
197 | ||
e91883bb | 198 | void start_srd_session(); |
ce0b6a40 | 199 | void terminate_srd_session(); |
e91883bb SA |
200 | void stop_srd_session(); |
201 | ||
a8a9222d SA |
202 | void connect_input_notifiers(); |
203 | ||
65efd025 | 204 | void create_decode_segment(); |
72435789 | 205 | |
47747218 | 206 | static void annotation_callback(srd_proto_data *pdata, void *decode_signal); |
c0c3e62a | 207 | static void binary_callback(srd_proto_data *pdata, void *decode_signal); |
47747218 | 208 | |
ad908057 | 209 | Q_SIGNALS: |
e77de61f SA |
210 | void decoder_stacked(void* decoder); ///< decoder is of type decode::Decoder* |
211 | void decoder_removed(void* decoder); ///< decoder is of type decode::Decoder* | |
5ecf957f | 212 | void new_annotations(); // TODO Supply segment for which they belong to |
b2b18d3a | 213 | void new_binary_data(unsigned int segment_id, void* decoder, unsigned int bin_class_id); |
eee3eab9 | 214 | void decode_reset(); |
1b56c646 | 215 | void decode_finished(); |
9f97b357 | 216 | void channels_updated(); |
ad908057 SA |
217 | |
218 | private Q_SLOTS: | |
47747218 | 219 | void on_capture_state_changed(int state); |
1b56c646 | 220 | void on_data_cleared(); |
47747218 | 221 | void on_data_received(); |
ad908057 SA |
222 | |
223 | private: | |
47747218 SA |
224 | pv::Session &session_; |
225 | ||
a82325d1 | 226 | vector<data::decode::DecodeChannel> channels_; |
47747218 | 227 | |
e91883bb SA |
228 | struct srd_session *srd_session_; |
229 | ||
47747218 | 230 | shared_ptr<Logic> logic_mux_data_; |
ed535cd7 | 231 | uint32_t logic_mux_unit_size_; |
47747218 SA |
232 | bool logic_mux_data_invalid_; |
233 | ||
47747218 | 234 | vector< shared_ptr<decode::Decoder> > stack_; |
e3202557 | 235 | bool stack_config_changed_; |
47747218 SA |
236 | map<pair<const srd_decoder*, int>, decode::Row> class_rows_; |
237 | ||
72435789 SA |
238 | vector<DecodeSegment> segments_; |
239 | uint32_t current_segment_id_; | |
4913560f | 240 | |
556259d2 SA |
241 | mutable mutex input_mutex_, output_mutex_, decode_pause_mutex_, logic_mux_mutex_; |
242 | mutable condition_variable decode_input_cond_, decode_pause_cond_, | |
243 | logic_mux_cond_; | |
47747218 SA |
244 | |
245 | std::thread decode_thread_, logic_mux_thread_; | |
246 | atomic<bool> decode_interrupt_, logic_mux_interrupt_; | |
247 | ||
556259d2 SA |
248 | bool decode_paused_; |
249 | ||
47747218 | 250 | QString error_message_; |
ad908057 SA |
251 | }; |
252 | ||
253 | } // namespace data | |
254 | } // namespace pv | |
255 | ||
256 | #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP |