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