]>
Commit | Line | Data |
---|---|---|
119aff65 JH |
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 | ||
e332f6d3 JH |
21 | #include <libsigrokdecode/libsigrokdecode.h> |
22 | ||
e92cd4e4 JH |
23 | #include <stdexcept> |
24 | ||
b213ef09 JH |
25 | #include <QDebug> |
26 | ||
2acdb232 | 27 | #include "decoderstack.hpp" |
119aff65 | 28 | |
2acdb232 | 29 | #include <pv/data/logic.hpp> |
f3d66e52 | 30 | #include <pv/data/logicsegment.hpp> |
2acdb232 JH |
31 | #include <pv/data/decode/decoder.hpp> |
32 | #include <pv/data/decode/annotation.hpp> | |
f65cd27b | 33 | #include <pv/session.hpp> |
2acdb232 | 34 | #include <pv/view/logicsignal.hpp> |
708c5523 | 35 | |
3b68d03d JH |
36 | using std::lock_guard; |
37 | using std::mutex; | |
f70d8673 | 38 | using boost::optional; |
3b68d03d | 39 | using std::unique_lock; |
819f4c25 | 40 | using std::deque; |
f9101a91 JH |
41 | using std::make_pair; |
42 | using std::max; | |
819f4c25 JH |
43 | using std::min; |
44 | using std::list; | |
f9101a91 JH |
45 | using std::map; |
46 | using std::pair; | |
f9abf97e | 47 | using std::shared_ptr; |
819f4c25 | 48 | using std::vector; |
e332f6d3 | 49 | |
f9101a91 JH |
50 | using namespace pv::data::decode; |
51 | ||
119aff65 JH |
52 | namespace pv { |
53 | namespace data { | |
54 | ||
6e89374a JH |
55 | const double DecoderStack::DecodeMargin = 1.0; |
56 | const double DecoderStack::DecodeThreshold = 0.2; | |
57 | const int64_t DecoderStack::DecodeChunkLength = 4096; | |
4c581c79 | 58 | const unsigned int DecoderStack::DecodeNotifyPeriod = 65536; |
e0fc5810 | 59 | |
a1a3656b | 60 | mutex DecoderStack::global_srd_mutex_; |
fe89c961 | 61 | |
2b81ae46 | 62 | DecoderStack::DecoderStack(pv::Session &session, |
bdc5c3b0 | 63 | const srd_decoder *const dec) : |
8dbbc7f0 | 64 | session_(session), |
f054289f JH |
65 | start_time_(0), |
66 | samplerate_(0), | |
8dbbc7f0 JH |
67 | sample_count_(0), |
68 | frame_complete_(false), | |
69 | samples_decoded_(0) | |
119aff65 | 70 | { |
8dbbc7f0 | 71 | connect(&session_, SIGNAL(frame_began()), |
f70d8673 | 72 | this, SLOT(on_new_frame())); |
8dbbc7f0 | 73 | connect(&session_, SIGNAL(data_received()), |
f70d8673 | 74 | this, SLOT(on_data_received())); |
8dbbc7f0 | 75 | connect(&session_, SIGNAL(frame_ended()), |
f70d8673 | 76 | this, SLOT(on_frame_ended())); |
82f50b10 | 77 | |
8dbbc7f0 | 78 | stack_.push_back(shared_ptr<decode::Decoder>( |
7491a29f | 79 | new decode::Decoder(dec))); |
119aff65 JH |
80 | } |
81 | ||
6e89374a | 82 | DecoderStack::~DecoderStack() |
640d69ce | 83 | { |
8dbbc7f0 JH |
84 | if (decode_thread_.joinable()) { |
85 | interrupt_ = true; | |
86 | input_cond_.notify_one(); | |
87 | decode_thread_.join(); | |
6d483b8b | 88 | } |
4e5a4405 JH |
89 | } |
90 | ||
f9abf97e | 91 | const std::list< std::shared_ptr<decode::Decoder> >& |
7491a29f | 92 | DecoderStack::stack() const |
4e5a4405 | 93 | { |
8dbbc7f0 | 94 | return stack_; |
4e5a4405 JH |
95 | } |
96 | ||
f9abf97e | 97 | void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder) |
4e5a4405 | 98 | { |
7491a29f | 99 | assert(decoder); |
8dbbc7f0 | 100 | stack_.push_back(decoder); |
4e5a4405 JH |
101 | } |
102 | ||
613d097c JH |
103 | void DecoderStack::remove(int index) |
104 | { | |
613d097c | 105 | assert(index >= 0); |
8dbbc7f0 | 106 | assert(index < (int)stack_.size()); |
613d097c JH |
107 | |
108 | // Find the decoder in the stack | |
8dbbc7f0 | 109 | auto iter = stack_.begin(); |
f3290553 | 110 | for (int i = 0; i < index; i++, iter++) |
8dbbc7f0 | 111 | assert(iter != stack_.end()); |
613d097c JH |
112 | |
113 | // Delete the element | |
8dbbc7f0 | 114 | stack_.erase(iter); |
613d097c JH |
115 | } |
116 | ||
f054289f JH |
117 | double DecoderStack::samplerate() const |
118 | { | |
119 | return samplerate_; | |
120 | } | |
121 | ||
60d9b99a | 122 | const pv::util::Timestamp& DecoderStack::start_time() const |
f054289f JH |
123 | { |
124 | return start_time_; | |
125 | } | |
126 | ||
5dfeb70f JH |
127 | int64_t DecoderStack::samples_decoded() const |
128 | { | |
8dbbc7f0 JH |
129 | lock_guard<mutex> decode_lock(output_mutex_); |
130 | return samples_decoded_; | |
5dfeb70f JH |
131 | } |
132 | ||
dd048a7e | 133 | std::vector<Row> DecoderStack::get_visible_rows() const |
f9101a91 | 134 | { |
8dbbc7f0 | 135 | lock_guard<mutex> lock(output_mutex_); |
f9101a91 JH |
136 | |
137 | vector<Row> rows; | |
138 | ||
2ad82c2e | 139 | for (const shared_ptr<decode::Decoder> &dec : stack_) { |
f9101a91 | 140 | assert(dec); |
dd048a7e JH |
141 | if (!dec->shown()) |
142 | continue; | |
143 | ||
f9101a91 JH |
144 | const srd_decoder *const decc = dec->decoder(); |
145 | assert(dec->decoder()); | |
146 | ||
147 | // Add a row for the decoder if it doesn't have a row list | |
148 | if (!decc->annotation_rows) | |
149 | rows.push_back(Row(decc)); | |
150 | ||
151 | // Add the decoder rows | |
2ad82c2e | 152 | for (const GSList *l = decc->annotation_rows; l; l = l->next) { |
f9101a91 JH |
153 | const srd_decoder_annotation_row *const ann_row = |
154 | (srd_decoder_annotation_row *)l->data; | |
155 | assert(ann_row); | |
156 | rows.push_back(Row(decc, ann_row)); | |
157 | } | |
158 | } | |
159 | ||
160 | return rows; | |
161 | } | |
162 | ||
92421299 JH |
163 | void DecoderStack::get_annotation_subset( |
164 | std::vector<pv::data::decode::Annotation> &dest, | |
f9101a91 JH |
165 | const Row &row, uint64_t start_sample, |
166 | uint64_t end_sample) const | |
e0fc5810 | 167 | { |
8dbbc7f0 | 168 | lock_guard<mutex> lock(output_mutex_); |
92421299 | 169 | |
8dbbc7f0 JH |
170 | const auto iter = rows_.find(row); |
171 | if (iter != rows_.end()) | |
f9101a91 JH |
172 | (*iter).second.get_annotation_subset(dest, |
173 | start_sample, end_sample); | |
e0fc5810 JH |
174 | } |
175 | ||
6e89374a | 176 | QString DecoderStack::error_message() |
b6b267bb | 177 | { |
8dbbc7f0 JH |
178 | lock_guard<mutex> lock(output_mutex_); |
179 | return error_message_; | |
b6b267bb JH |
180 | } |
181 | ||
f9101a91 JH |
182 | void DecoderStack::clear() |
183 | { | |
8dbbc7f0 JH |
184 | sample_count_ = 0; |
185 | frame_complete_ = false; | |
186 | samples_decoded_ = 0; | |
187 | error_message_ = QString(); | |
188 | rows_.clear(); | |
189 | class_rows_.clear(); | |
f9101a91 JH |
190 | } |
191 | ||
6e89374a | 192 | void DecoderStack::begin_decode() |
640d69ce | 193 | { |
7491a29f JH |
194 | shared_ptr<pv::view::LogicSignal> logic_signal; |
195 | shared_ptr<pv::data::Logic> data; | |
196 | ||
8dbbc7f0 JH |
197 | if (decode_thread_.joinable()) { |
198 | interrupt_ = true; | |
199 | input_cond_.notify_one(); | |
200 | decode_thread_.join(); | |
6d483b8b | 201 | } |
640d69ce | 202 | |
92421299 | 203 | clear(); |
4e5a4405 | 204 | |
8bd26d8b | 205 | // Check that all decoders have the required channels |
8dbbc7f0 | 206 | for (const shared_ptr<decode::Decoder> &dec : stack_) |
6ac6242b | 207 | if (!dec->have_required_channels()) { |
8dbbc7f0 | 208 | error_message_ = tr("One or more required channels " |
df4c1a06 JH |
209 | "have not been specified"); |
210 | return; | |
211 | } | |
212 | ||
f9101a91 | 213 | // Add classes |
2ad82c2e | 214 | for (const shared_ptr<decode::Decoder> &dec : stack_) { |
f9101a91 JH |
215 | assert(dec); |
216 | const srd_decoder *const decc = dec->decoder(); | |
217 | assert(dec->decoder()); | |
218 | ||
219 | // Add a row for the decoder if it doesn't have a row list | |
220 | if (!decc->annotation_rows) | |
8dbbc7f0 | 221 | rows_[Row(decc)] = decode::RowData(); |
f9101a91 JH |
222 | |
223 | // Add the decoder rows | |
2ad82c2e | 224 | for (const GSList *l = decc->annotation_rows; l; l = l->next) { |
f9101a91 JH |
225 | const srd_decoder_annotation_row *const ann_row = |
226 | (srd_decoder_annotation_row *)l->data; | |
227 | assert(ann_row); | |
228 | ||
229 | const Row row(decc, ann_row); | |
230 | ||
231 | // Add a new empty row data object | |
8dbbc7f0 | 232 | rows_[row] = decode::RowData(); |
f9101a91 JH |
233 | |
234 | // Map out all the classes | |
235 | for (const GSList *ll = ann_row->ann_classes; | |
236 | ll; ll = ll->next) | |
8dbbc7f0 | 237 | class_rows_[make_pair(decc, |
f9101a91 JH |
238 | GPOINTER_TO_INT(ll->data))] = row; |
239 | } | |
240 | } | |
241 | ||
8bd26d8b | 242 | // We get the logic data of the first channel in the list. |
e0fc5810 | 243 | // This works because we are currently assuming all |
f3d66e52 | 244 | // LogicSignals have the same data/segment |
8dbbc7f0 | 245 | for (const shared_ptr<decode::Decoder> &dec : stack_) |
8bd26d8b UH |
246 | if (dec && !dec->channels().empty() && |
247 | ((logic_signal = (*dec->channels().begin()).second)) && | |
7aa09b00 | 248 | ((data = logic_signal->logic_data()))) |
7491a29f JH |
249 | break; |
250 | ||
251 | if (!data) | |
252 | return; | |
253 | ||
f3d66e52 JH |
254 | // Check we have a segment of data |
255 | const deque< shared_ptr<pv::data::LogicSegment> > &segments = | |
256 | data->logic_segments(); | |
257 | if (segments.empty()) | |
f70d8673 | 258 | return; |
f3d66e52 | 259 | segment_ = segments.front(); |
f70d8673 | 260 | |
7491a29f | 261 | // Get the samplerate and start time |
f3d66e52 JH |
262 | start_time_ = segment_->start_time(); |
263 | samplerate_ = segment_->samplerate(); | |
8dbbc7f0 JH |
264 | if (samplerate_ == 0.0) |
265 | samplerate_ = 1.0; | |
e0fc5810 | 266 | |
8dbbc7f0 JH |
267 | interrupt_ = false; |
268 | decode_thread_ = std::thread(&DecoderStack::decode_proc, this); | |
640d69ce JH |
269 | } |
270 | ||
e45b13b5 | 271 | uint64_t DecoderStack::max_sample_count() const |
a007f5ad | 272 | { |
f9101a91 JH |
273 | uint64_t max_sample_count = 0; |
274 | ||
27c05210 | 275 | for (const auto& row : rows_) |
f9101a91 | 276 | max_sample_count = max(max_sample_count, |
da50281d | 277 | row.second.get_max_sample()); |
f9101a91 JH |
278 | |
279 | return max_sample_count; | |
a007f5ad JH |
280 | } |
281 | ||
f70d8673 JH |
282 | optional<int64_t> DecoderStack::wait_for_data() const |
283 | { | |
8dbbc7f0 | 284 | unique_lock<mutex> input_lock(input_mutex_); |
cc10c409 SA |
285 | |
286 | // Do wait if we decoded all samples but we're still capturing | |
287 | // Do not wait if we're done capturing | |
f3290553 | 288 | while (!interrupt_ && !frame_complete_ && |
cc10c409 SA |
289 | (samples_decoded_ >= sample_count_) && |
290 | (session_.get_capture_state() != Session::Stopped)) { | |
291 | ||
8dbbc7f0 | 292 | input_cond_.wait(input_lock); |
cc10c409 SA |
293 | } |
294 | ||
295 | // Return value is valid if we're not aborting the decode, | |
8dbbc7f0 | 296 | return boost::make_optional(!interrupt_ && |
cc10c409 SA |
297 | // and there's more work to do... |
298 | (samples_decoded_ < sample_count_ || !frame_complete_) && | |
299 | // and if the end of the data hasn't been reached yet | |
300 | (!((samples_decoded_ >= sample_count_) && (session_.get_capture_state() == Session::Stopped))), | |
8dbbc7f0 | 301 | sample_count_); |
f70d8673 JH |
302 | } |
303 | ||
f67d9e9b | 304 | void DecoderStack::decode_data( |
f70d8673 | 305 | const int64_t sample_count, const unsigned int unit_size, |
f67d9e9b JH |
306 | srd_session *const session) |
307 | { | |
308 | uint8_t chunk[DecodeChunkLength]; | |
309 | ||
f67d9e9b | 310 | const unsigned int chunk_sample_count = |
f3d66e52 | 311 | DecodeChunkLength / segment_->unit_size(); |
f67d9e9b | 312 | |
8dbbc7f0 | 313 | for (int64_t i = 0; !interrupt_ && i < sample_count; |
2ad82c2e | 314 | i += chunk_sample_count) { |
f67d9e9b JH |
315 | |
316 | const int64_t chunk_end = min( | |
317 | i + chunk_sample_count, sample_count); | |
f3d66e52 | 318 | segment_->get_samples(chunk, i, chunk_end); |
f67d9e9b | 319 | |
ba5cd8cb | 320 | if (srd_session_send(session, i, chunk_end, chunk, |
c4dd1e4e | 321 | (chunk_end - i) * unit_size, unit_size) != SRD_OK) { |
8dbbc7f0 | 322 | error_message_ = tr("Decoder reported an error"); |
f67d9e9b JH |
323 | break; |
324 | } | |
325 | ||
326 | { | |
8dbbc7f0 JH |
327 | lock_guard<mutex> lock(output_mutex_); |
328 | samples_decoded_ = chunk_end; | |
f67d9e9b | 329 | } |
4c581c79 JH |
330 | |
331 | if (i % DecodeNotifyPeriod == 0) | |
332 | new_decode_data(); | |
f67d9e9b JH |
333 | } |
334 | ||
1c5fb759 | 335 | new_decode_data(); |
f67d9e9b JH |
336 | } |
337 | ||
c1b2865e | 338 | void DecoderStack::decode_proc() |
119aff65 | 339 | { |
f70d8673 | 340 | optional<int64_t> sample_count; |
b6b267bb | 341 | srd_session *session; |
4c60462b | 342 | srd_decoder_inst *prev_di = nullptr; |
e0fc5810 | 343 | |
f3d66e52 | 344 | assert(segment_); |
e0fc5810 | 345 | |
a1a3656b SA |
346 | // Prevent any other decode threads from accessing libsigrokdecode |
347 | lock_guard<mutex> srd_lock(global_srd_mutex_); | |
348 | ||
b6b267bb JH |
349 | // Create the session |
350 | srd_session_new(&session); | |
351 | assert(session); | |
e0fc5810 | 352 | |
7491a29f | 353 | // Create the decoders |
f3d66e52 | 354 | const unsigned int unit_size = segment_->unit_size(); |
f67d9e9b | 355 | |
2ad82c2e | 356 | for (const shared_ptr<decode::Decoder> &dec : stack_) { |
c4dd1e4e | 357 | srd_decoder_inst *const di = dec->create_decoder_inst(session); |
e0fc5810 | 358 | |
2ad82c2e | 359 | if (!di) { |
8dbbc7f0 | 360 | error_message_ = tr("Failed to create decoder instance"); |
7491a29f JH |
361 | srd_session_destroy(session); |
362 | return; | |
363 | } | |
b6b267bb | 364 | |
7491a29f JH |
365 | if (prev_di) |
366 | srd_inst_stack (session, prev_di, di); | |
b6b267bb | 367 | |
7491a29f | 368 | prev_di = di; |
b6b267bb JH |
369 | } |
370 | ||
f70d8673 JH |
371 | // Get the intial sample count |
372 | { | |
8dbbc7f0 | 373 | unique_lock<mutex> input_lock(input_mutex_); |
f3d66e52 | 374 | sample_count = sample_count_ = segment_->get_sample_count(); |
f70d8673 JH |
375 | } |
376 | ||
b6b267bb | 377 | // Start the session |
7491a29f | 378 | srd_session_metadata_set(session, SRD_CONF_SAMPLERATE, |
8dbbc7f0 | 379 | g_variant_new_uint64((uint64_t)samplerate_)); |
7491a29f JH |
380 | |
381 | srd_pd_output_callback_add(session, SRD_OUTPUT_ANN, | |
382 | DecoderStack::annotation_callback, this); | |
383 | ||
b6b267bb JH |
384 | srd_session_start(session); |
385 | ||
f70d8673 JH |
386 | do { |
387 | decode_data(*sample_count, unit_size, session); | |
f3290553 | 388 | } while (error_message_.isEmpty() && (sample_count = wait_for_data())); |
b6b267bb JH |
389 | |
390 | // Destroy the session | |
391 | srd_session_destroy(session); | |
e0fc5810 JH |
392 | } |
393 | ||
6e89374a | 394 | void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder) |
e0fc5810 | 395 | { |
e0fc5810 JH |
396 | assert(pdata); |
397 | assert(decoder); | |
398 | ||
6e89374a | 399 | DecoderStack *const d = (DecoderStack*)decoder; |
f9101a91 | 400 | assert(d); |
e0fc5810 | 401 | |
8dbbc7f0 | 402 | lock_guard<mutex> lock(d->output_mutex_); |
6d8b0562 | 403 | |
f9101a91 JH |
404 | const Annotation a(pdata); |
405 | ||
406 | // Find the row | |
407 | assert(pdata->pdo); | |
408 | assert(pdata->pdo->di); | |
409 | const srd_decoder *const decc = pdata->pdo->di->decoder; | |
410 | assert(decc); | |
411 | ||
8dbbc7f0 | 412 | auto row_iter = d->rows_.end(); |
360ab9be | 413 | |
f9101a91 | 414 | // Try looking up the sub-row of this class |
8dbbc7f0 JH |
415 | const auto r = d->class_rows_.find(make_pair(decc, a.format())); |
416 | if (r != d->class_rows_.end()) | |
417 | row_iter = d->rows_.find((*r).second); | |
2ad82c2e | 418 | else { |
f9101a91 | 419 | // Failing that, use the decoder as a key |
8dbbc7f0 | 420 | row_iter = d->rows_.find(Row(decc)); |
6d8b0562 UH |
421 | } |
422 | ||
8dbbc7f0 JH |
423 | assert(row_iter != d->rows_.end()); |
424 | if (row_iter == d->rows_.end()) { | |
f9101a91 JH |
425 | qDebug() << "Unexpected annotation: decoder = " << decc << |
426 | ", format = " << a.format(); | |
427 | assert(0); | |
428 | return; | |
429 | } | |
9cef9567 | 430 | |
f9101a91 JH |
431 | // Add the annotation |
432 | (*row_iter).second.push_annotation(a); | |
119aff65 JH |
433 | } |
434 | ||
82f50b10 JH |
435 | void DecoderStack::on_new_frame() |
436 | { | |
437 | begin_decode(); | |
438 | } | |
439 | ||
f70d8673 JH |
440 | void DecoderStack::on_data_received() |
441 | { | |
442 | { | |
8dbbc7f0 | 443 | unique_lock<mutex> lock(input_mutex_); |
f3d66e52 JH |
444 | if (segment_) |
445 | sample_count_ = segment_->get_sample_count(); | |
f70d8673 | 446 | } |
8dbbc7f0 | 447 | input_cond_.notify_one(); |
f70d8673 JH |
448 | } |
449 | ||
450 | void DecoderStack::on_frame_ended() | |
451 | { | |
452 | { | |
8dbbc7f0 | 453 | unique_lock<mutex> lock(input_mutex_); |
f3d66e52 | 454 | if (segment_) |
8dbbc7f0 | 455 | frame_complete_ = true; |
f70d8673 | 456 | } |
8dbbc7f0 | 457 | input_cond_.notify_one(); |
f70d8673 JH |
458 | } |
459 | ||
119aff65 JH |
460 | } // namespace data |
461 | } // namespace pv |