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