]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the PulseView project. | |
3 | * | |
4 | * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk> | |
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, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
21 | #include <libsigrokdecode/libsigrokdecode.h> | |
22 | ||
23 | #include <boost/foreach.hpp> | |
24 | #include <boost/thread/thread.hpp> | |
25 | ||
26 | #include <stdexcept> | |
27 | ||
28 | #include <QDebug> | |
29 | ||
30 | #include "decoderstack.h" | |
31 | ||
32 | #include <pv/data/logic.h> | |
33 | #include <pv/data/logicsnapshot.h> | |
34 | #include <pv/data/decode/decoder.h> | |
35 | #include <pv/data/decode/annotation.h> | |
36 | #include <pv/view/logicsignal.h> | |
37 | ||
38 | using boost::lock_guard; | |
39 | using boost::mutex; | |
40 | using boost::shared_ptr; | |
41 | using std::deque; | |
42 | using std::make_pair; | |
43 | using std::max; | |
44 | using std::min; | |
45 | using std::list; | |
46 | using std::map; | |
47 | using std::pair; | |
48 | using std::vector; | |
49 | ||
50 | using namespace pv::data::decode; | |
51 | ||
52 | namespace pv { | |
53 | namespace data { | |
54 | ||
55 | const double DecoderStack::DecodeMargin = 1.0; | |
56 | const double DecoderStack::DecodeThreshold = 0.2; | |
57 | const int64_t DecoderStack::DecodeChunkLength = 4096; | |
58 | ||
59 | mutex DecoderStack::_global_decode_mutex; | |
60 | ||
61 | DecoderStack::DecoderStack(const srd_decoder *const dec) : | |
62 | _samples_decoded(0) | |
63 | { | |
64 | _stack.push_back(shared_ptr<decode::Decoder>( | |
65 | new decode::Decoder(dec))); | |
66 | } | |
67 | ||
68 | DecoderStack::~DecoderStack() | |
69 | { | |
70 | _decode_thread.interrupt(); | |
71 | _decode_thread.join(); | |
72 | } | |
73 | ||
74 | const std::list< boost::shared_ptr<decode::Decoder> >& | |
75 | DecoderStack::stack() const | |
76 | { | |
77 | return _stack; | |
78 | } | |
79 | ||
80 | void DecoderStack::push(boost::shared_ptr<decode::Decoder> decoder) | |
81 | { | |
82 | assert(decoder); | |
83 | _stack.push_back(decoder); | |
84 | } | |
85 | ||
86 | void DecoderStack::remove(int index) | |
87 | { | |
88 | assert(index >= 0); | |
89 | assert(index < (int)_stack.size()); | |
90 | ||
91 | // Find the decoder in the stack | |
92 | list< shared_ptr<Decoder> >::iterator iter = _stack.begin(); | |
93 | for(int i = 0; i < index; i++, iter++) | |
94 | assert(iter != _stack.end()); | |
95 | ||
96 | // Delete the element | |
97 | _stack.erase(iter); | |
98 | } | |
99 | ||
100 | int64_t DecoderStack::samples_decoded() const | |
101 | { | |
102 | lock_guard<mutex> decode_lock(_mutex); | |
103 | return _samples_decoded; | |
104 | } | |
105 | ||
106 | std::vector<Row> DecoderStack::get_visible_rows() const | |
107 | { | |
108 | lock_guard<mutex> lock(_mutex); | |
109 | ||
110 | vector<Row> rows; | |
111 | ||
112 | BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack) | |
113 | { | |
114 | assert(dec); | |
115 | if (!dec->shown()) | |
116 | continue; | |
117 | ||
118 | const srd_decoder *const decc = dec->decoder(); | |
119 | assert(dec->decoder()); | |
120 | ||
121 | // Add a row for the decoder if it doesn't have a row list | |
122 | if (!decc->annotation_rows) | |
123 | rows.push_back(Row(decc)); | |
124 | ||
125 | // Add the decoder rows | |
126 | for (const GSList *l = decc->annotation_rows; l; l = l->next) | |
127 | { | |
128 | const srd_decoder_annotation_row *const ann_row = | |
129 | (srd_decoder_annotation_row *)l->data; | |
130 | assert(ann_row); | |
131 | rows.push_back(Row(decc, ann_row)); | |
132 | } | |
133 | } | |
134 | ||
135 | return rows; | |
136 | } | |
137 | ||
138 | void DecoderStack::get_annotation_subset( | |
139 | std::vector<pv::data::decode::Annotation> &dest, | |
140 | const Row &row, uint64_t start_sample, | |
141 | uint64_t end_sample) const | |
142 | { | |
143 | lock_guard<mutex> lock(_mutex); | |
144 | ||
145 | std::map<const Row, decode::RowData>::const_iterator iter = | |
146 | _rows.find(row); | |
147 | if (iter != _rows.end()) | |
148 | (*iter).second.get_annotation_subset(dest, | |
149 | start_sample, end_sample); | |
150 | } | |
151 | ||
152 | QString DecoderStack::error_message() | |
153 | { | |
154 | lock_guard<mutex> lock(_mutex); | |
155 | return _error_message; | |
156 | } | |
157 | ||
158 | void DecoderStack::clear() | |
159 | { | |
160 | _samples_decoded = 0; | |
161 | _error_message = QString(); | |
162 | _rows.clear(); | |
163 | _class_rows.clear(); | |
164 | } | |
165 | ||
166 | void DecoderStack::begin_decode() | |
167 | { | |
168 | shared_ptr<pv::view::LogicSignal> logic_signal; | |
169 | shared_ptr<pv::data::Logic> data; | |
170 | ||
171 | _decode_thread.interrupt(); | |
172 | _decode_thread.join(); | |
173 | ||
174 | clear(); | |
175 | ||
176 | // Add classes | |
177 | BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack) | |
178 | { | |
179 | assert(dec); | |
180 | const srd_decoder *const decc = dec->decoder(); | |
181 | assert(dec->decoder()); | |
182 | ||
183 | // Add a row for the decoder if it doesn't have a row list | |
184 | if (!decc->annotation_rows) | |
185 | _rows[Row(decc)] = decode::RowData(); | |
186 | ||
187 | // Add the decoder rows | |
188 | for (const GSList *l = decc->annotation_rows; l; l = l->next) | |
189 | { | |
190 | const srd_decoder_annotation_row *const ann_row = | |
191 | (srd_decoder_annotation_row *)l->data; | |
192 | assert(ann_row); | |
193 | ||
194 | const Row row(decc, ann_row); | |
195 | ||
196 | // Add a new empty row data object | |
197 | _rows[row] = decode::RowData(); | |
198 | ||
199 | // Map out all the classes | |
200 | for (const GSList *ll = ann_row->ann_classes; | |
201 | ll; ll = ll->next) | |
202 | _class_rows[make_pair(decc, | |
203 | GPOINTER_TO_INT(ll->data))] = row; | |
204 | } | |
205 | } | |
206 | ||
207 | // We get the logic data of the first probe in the list. | |
208 | // This works because we are currently assuming all | |
209 | // LogicSignals have the same data/snapshot | |
210 | BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack) | |
211 | if (dec && !dec->probes().empty() && | |
212 | ((logic_signal = (*dec->probes().begin()).second)) && | |
213 | ((data = logic_signal->logic_data()))) | |
214 | break; | |
215 | ||
216 | if (!data) | |
217 | return; | |
218 | ||
219 | // Get the samplerate and start time | |
220 | _start_time = data->get_start_time(); | |
221 | _samplerate = data->samplerate(); | |
222 | if (_samplerate == 0.0) | |
223 | _samplerate = 1.0; | |
224 | ||
225 | _decode_thread = boost::thread(&DecoderStack::decode_proc, this, | |
226 | data); | |
227 | } | |
228 | ||
229 | uint64_t DecoderStack::get_max_sample_count() const | |
230 | { | |
231 | uint64_t max_sample_count = 0; | |
232 | ||
233 | for (map<const Row, RowData>::const_iterator i = _rows.begin(); | |
234 | i != _rows.end(); i++) | |
235 | max_sample_count = max(max_sample_count, | |
236 | (*i).second.get_max_sample()); | |
237 | ||
238 | return max_sample_count; | |
239 | } | |
240 | ||
241 | void DecoderStack::decode_proc(shared_ptr<data::Logic> data) | |
242 | { | |
243 | srd_session *session; | |
244 | uint8_t chunk[DecodeChunkLength]; | |
245 | srd_decoder_inst *prev_di = NULL; | |
246 | ||
247 | assert(data); | |
248 | ||
249 | // Check we have a snapshot of data | |
250 | const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots = | |
251 | data->get_snapshots(); | |
252 | if (snapshots.empty()) | |
253 | return; | |
254 | ||
255 | // Check that all decoders have the required probes | |
256 | BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack) | |
257 | if (!dec->have_required_probes()) | |
258 | return; | |
259 | ||
260 | const shared_ptr<pv::data::LogicSnapshot> &snapshot = | |
261 | snapshots.front(); | |
262 | const int64_t sample_count = snapshot->get_sample_count(); | |
263 | const unsigned int chunk_sample_count = | |
264 | DecodeChunkLength / snapshot->unit_size(); | |
265 | ||
266 | // Create the session | |
267 | srd_session_new(&session); | |
268 | assert(session); | |
269 | ||
270 | // Create the decoders | |
271 | BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack) | |
272 | { | |
273 | srd_decoder_inst *const di = dec->create_decoder_inst(session); | |
274 | ||
275 | if (!di) | |
276 | { | |
277 | _error_message = tr("Failed to create decoder instance"); | |
278 | srd_session_destroy(session); | |
279 | return; | |
280 | } | |
281 | ||
282 | if (prev_di) | |
283 | srd_inst_stack (session, prev_di, di); | |
284 | ||
285 | prev_di = di; | |
286 | } | |
287 | ||
288 | // Start the session | |
289 | srd_session_metadata_set(session, SRD_CONF_SAMPLERATE, | |
290 | g_variant_new_uint64((uint64_t)_samplerate)); | |
291 | ||
292 | srd_pd_output_callback_add(session, SRD_OUTPUT_ANN, | |
293 | DecoderStack::annotation_callback, this); | |
294 | ||
295 | srd_session_start(session); | |
296 | ||
297 | for (int64_t i = 0; | |
298 | !boost::this_thread::interruption_requested() && | |
299 | i < sample_count; | |
300 | i += chunk_sample_count) | |
301 | { | |
302 | lock_guard<mutex> decode_lock(_global_decode_mutex); | |
303 | ||
304 | const int64_t chunk_end = min( | |
305 | i + chunk_sample_count, sample_count); | |
306 | snapshot->get_samples(chunk, i, chunk_end); | |
307 | ||
308 | if (srd_session_send(session, i, i + sample_count, | |
309 | chunk, chunk_end - i) != SRD_OK) { | |
310 | _error_message = tr("Decoder reported an error"); | |
311 | break; | |
312 | } | |
313 | ||
314 | { | |
315 | lock_guard<mutex> lock(_mutex); | |
316 | _samples_decoded = chunk_end; | |
317 | } | |
318 | } | |
319 | ||
320 | // Destroy the session | |
321 | srd_session_destroy(session); | |
322 | } | |
323 | ||
324 | void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder) | |
325 | { | |
326 | assert(pdata); | |
327 | assert(decoder); | |
328 | ||
329 | DecoderStack *const d = (DecoderStack*)decoder; | |
330 | assert(d); | |
331 | ||
332 | lock_guard<mutex> lock(d->_mutex); | |
333 | ||
334 | const Annotation a(pdata); | |
335 | ||
336 | // Find the row | |
337 | assert(pdata->pdo); | |
338 | assert(pdata->pdo->di); | |
339 | const srd_decoder *const decc = pdata->pdo->di->decoder; | |
340 | assert(decc); | |
341 | ||
342 | map<const Row, decode::RowData>::iterator row_iter = d->_rows.end(); | |
343 | ||
344 | // Try looking up the sub-row of this class | |
345 | const map<pair<const srd_decoder*, int>, Row>::const_iterator r = | |
346 | d->_class_rows.find(make_pair(decc, a.format())); | |
347 | if (r != d->_class_rows.end()) | |
348 | row_iter = d->_rows.find((*r).second); | |
349 | else | |
350 | { | |
351 | // Failing that, use the decoder as a key | |
352 | row_iter = d->_rows.find(Row(decc)); | |
353 | } | |
354 | ||
355 | assert(row_iter != d->_rows.end()); | |
356 | if (row_iter == d->_rows.end()) { | |
357 | qDebug() << "Unexpected annotation: decoder = " << decc << | |
358 | ", format = " << a.format(); | |
359 | assert(0); | |
360 | return; | |
361 | } | |
362 | ||
363 | // Add the annotation | |
364 | (*row_iter).second.push_annotation(a); | |
365 | ||
366 | d->new_decode_data(); | |
367 | } | |
368 | ||
369 | } // namespace data | |
370 | } // namespace pv |