]> sigrok.org Git - pulseview.git/blame - pv/data/decodesignal.cpp
Fix #1629 by not reallocating DecodeSegments
[pulseview.git] / pv / data / decodesignal.cpp
CommitLineData
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
c0c3e62a 20#include <cstring>
5a914348 21#include <forward_list>
0c5fe73e
SA
22#include <limits>
23
47747218
SA
24#include <QDebug>
25
ad908057
SA
26#include "logic.hpp"
27#include "logicsegment.hpp"
28#include "decodesignal.hpp"
29#include "signaldata.hpp"
30
ad908057 31#include <pv/data/decode/decoder.hpp>
ecd07c20 32#include <pv/data/decode/row.hpp>
d3feec23 33#include <pv/globalsettings.hpp>
ad908057
SA
34#include <pv/session.hpp>
35
47747218 36using std::lock_guard;
ad908057 37using std::make_shared;
0c5fe73e 38using std::min;
5ecf957f 39using std::out_of_range;
ad908057 40using std::shared_ptr;
47747218 41using std::unique_lock;
6a26fc44 42using pv::data::decode::AnnotationClass;
a82325d1 43using pv::data::decode::DecodeChannel;
ad908057
SA
44
45namespace pv {
46namespace data {
47
47747218
SA
48const double DecodeSignal::DecodeMargin = 1.0;
49const double DecodeSignal::DecodeThreshold = 0.2;
3fbddf7f 50const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
ad908057 51
ad908057 52
47747218
SA
53DecodeSignal::DecodeSignal(pv::Session &session) :
54 SignalBase(nullptr, SignalBase::DecodeChannel),
55 session_(session),
e91883bb 56 srd_session_(nullptr),
47747218 57 logic_mux_data_invalid_(false),
e3202557 58 stack_config_changed_(true),
f6a93932 59 current_segment_id_(0)
ad908057 60{
47747218
SA
61 connect(&session_, SIGNAL(capture_state_changed(int)),
62 this, SLOT(on_capture_state_changed(int)));
ad908057
SA
63}
64
47747218 65DecodeSignal::~DecodeSignal()
ad908057 66{
8ce0e732 67 reset_decode(true);
ad908057
SA
68}
69
47747218 70const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
ecd07c20 71{
47747218 72 return stack_;
ecd07c20
SA
73}
74
ed75426f 75void DecodeSignal::stack_decoder(const srd_decoder *decoder, bool restart_decode)
ad908057
SA
76{
77 assert(decoder);
762ab7a4 78
b9591f3a 79 // Set name if this decoder is the first in the list or the name is unchanged
6a26fc44
SA
80 const srd_decoder* prev_dec = stack_.empty() ? nullptr : stack_.back()->get_srd_decoder();
81 const QString prev_dec_name = prev_dec ? QString::fromUtf8(prev_dec->name) : QString();
47747218 82
b9591f3a 83 if ((stack_.empty()) || ((stack_.size() > 0) && (name() == prev_dec_name)))
47747218 84 set_name(QString::fromUtf8(decoder->name));
132a5c6d 85
f54e68b0 86 const shared_ptr<Decoder> dec = make_shared<Decoder>(decoder, stack_.size());
b9591f3a
SA
87 stack_.push_back(dec);
88
02078aa1
SA
89 connect(dec.get(), SIGNAL(annotation_visibility_changed()),
90 this, SLOT(on_annotation_visibility_changed()));
91
27a3f09b 92 // Include the newly created decode channels in the channel lists
9f97b357 93 update_channel_list();
132a5c6d 94
e3202557 95 stack_config_changed_ = true;
762ab7a4 96 auto_assign_signals(dec);
27a3f09b 97 commit_decoder_channels();
e77de61f
SA
98
99 decoder_stacked((void*)dec.get());
100
ed75426f
SA
101 if (restart_decode)
102 begin_decode();
ad908057
SA
103}
104
105void DecodeSignal::remove_decoder(int index)
106{
47747218
SA
107 assert(index >= 0);
108 assert(index < (int)stack_.size());
109
110 // Find the decoder in the stack
f9a0fd83
SA
111 auto iter = stack_.begin() + index;
112 assert(iter != stack_.end());
47747218 113
f9a0fd83
SA
114 shared_ptr<Decoder> dec = *iter;
115
116 decoder_removed(dec.get());
e77de61f 117
47747218
SA
118 // Delete the element
119 stack_.erase(iter);
120
121 // Update channels and decoded data
e3202557 122 stack_config_changed_ = true;
9f97b357 123 update_channel_list();
47747218 124 begin_decode();
ad908057
SA
125}
126
127bool DecodeSignal::toggle_decoder_visibility(int index)
128{
47747218 129 auto iter = stack_.cbegin();
ad908057 130 for (int i = 0; i < index; i++, iter++)
47747218 131 assert(iter != stack_.end());
ad908057
SA
132
133 shared_ptr<Decoder> dec = *iter;
134
135 // Toggle decoder visibility
136 bool state = false;
137 if (dec) {
5d3ca591
SA
138 state = !dec->visible();
139 dec->set_visible(state);
ad908057
SA
140 }
141
142 return state;
143}
144
8ce0e732 145void DecodeSignal::reset_decode(bool shutting_down)
47747218 146{
8b24af15
SA
147 resume_decode(); // Make sure the decode thread isn't blocked by pausing
148
8ce0e732 149 if (stack_config_changed_ || shutting_down)
e3202557
SA
150 stop_srd_session();
151 else
152 terminate_srd_session();
ce0b6a40 153
1b56c646
SA
154 if (decode_thread_.joinable()) {
155 decode_interrupt_ = true;
156 decode_input_cond_.notify_one();
157 decode_thread_.join();
158 }
159
160 if (logic_mux_thread_.joinable()) {
161 logic_mux_interrupt_ = true;
162 logic_mux_cond_.notify_one();
163 logic_mux_thread_.join();
164 }
165
8a603e13 166 current_segment_id_ = 0;
72435789 167 segments_.clear();
1b56c646
SA
168
169 logic_mux_data_.reset();
170 logic_mux_data_invalid_ = true;
eee3eab9 171
403c3e87 172 if (!error_message_.isEmpty()) {
66b6f41b 173 error_message_.clear();
fe060a48
SA
174 // TODO Emulate noquote()
175 qDebug().nospace() << name() << ": Error cleared";
403c3e87 176 }
72435789 177
eee3eab9 178 decode_reset();
47747218
SA
179}
180
946b52e1
SA
181void DecodeSignal::begin_decode()
182{
47747218
SA
183 if (decode_thread_.joinable()) {
184 decode_interrupt_ = true;
185 decode_input_cond_.notify_one();
186 decode_thread_.join();
187 }
188
189 if (logic_mux_thread_.joinable()) {
190 logic_mux_interrupt_ = true;
191 logic_mux_cond_.notify_one();
192 logic_mux_thread_.join();
193 }
194
195 reset_decode();
196
27a3f09b 197 if (stack_.size() == 0) {
403c3e87 198 set_error_message(tr("No decoders"));
27a3f09b
SA
199 return;
200 }
201
202 assert(channels_.size() > 0);
203
204 if (get_assigned_signal_count() == 0) {
403c3e87 205 set_error_message(tr("There are no channels assigned to this decoder"));
27a3f09b
SA
206 return;
207 }
208
04627946
SA
209 // Make sure that all assigned channels still provide logic data
210 // (can happen when a converted signal was assigned but the
211 // conversion removed in the meanwhile)
a82325d1 212 for (decode::DecodeChannel& ch : channels_)
04627946
SA
213 if (ch.assigned_signal && !(ch.assigned_signal->logic_data() != nullptr))
214 ch.assigned_signal = nullptr;
215
47747218 216 // Check that all decoders have the required channels
6a26fc44 217 for (const shared_ptr<Decoder>& dec : stack_)
47747218 218 if (!dec->have_required_channels()) {
403c3e87
SA
219 set_error_message(tr("One or more required channels "
220 "have not been specified"));
47747218
SA
221 return;
222 }
223
27a3f09b
SA
224 // Free the logic data and its segment(s) if it needs to be updated
225 if (logic_mux_data_invalid_)
226 logic_mux_data_.reset();
227
228 if (!logic_mux_data_) {
72435789 229 const uint32_t ch_count = get_assigned_signal_count();
ed535cd7 230 logic_mux_unit_size_ = (ch_count + 7) / 8;
27a3f09b 231 logic_mux_data_ = make_shared<Logic>(ch_count);
27a3f09b 232 }
47747218 233
ed535cd7
SA
234 // Receive notifications when new sample data is available
235 connect_input_notifiers();
236
144e72c9 237 if (get_input_segment_count() == 0)
403c3e87 238 set_error_message(tr("No input data"));
ed535cd7 239
27a3f09b
SA
240 // Make sure the logic output data is complete and up-to-date
241 logic_mux_interrupt_ = false;
242 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
243
244 // Decode the muxed logic data
47747218
SA
245 decode_interrupt_ = false;
246 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
946b52e1
SA
247}
248
556259d2
SA
249void DecodeSignal::pause_decode()
250{
251 decode_paused_ = true;
252}
253
254void DecodeSignal::resume_decode()
255{
256 // Manual unlocking is done before notifying, to avoid waking up the
257 // waiting thread only to block again (see notify_one for details)
258 decode_pause_mutex_.unlock();
259 decode_pause_cond_.notify_one();
260 decode_paused_ = false;
261}
262
263bool DecodeSignal::is_paused() const
264{
265 return decode_paused_;
266}
267
a82325d1 268const vector<decode::DecodeChannel> DecodeSignal::get_channels() const
9f97b357
SA
269{
270 return channels_;
271}
272
762ab7a4 273void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
132a5c6d 274{
47747218
SA
275 bool new_assignment = false;
276
132a5c6d 277 // Try to auto-select channels that don't have signals assigned yet
a82325d1 278 for (decode::DecodeChannel& ch : channels_) {
762ab7a4
SA
279 // If a decoder is given, auto-assign only its channels
280 if (dec && (ch.decoder_ != dec))
281 continue;
282
132a5c6d
SA
283 if (ch.assigned_signal)
284 continue;
285
c526a8fd
SA
286 QString ch_name = ch.name.toLower();
287 ch_name = ch_name.replace(QRegExp("[-_.]"), " ");
a8030bb0
SA
288
289 shared_ptr<data::SignalBase> match;
f4ab4b5c 290 for (const shared_ptr<data::SignalBase>& s : session_.signalbases()) {
f9ebf303
SA
291 if (!s->enabled())
292 continue;
293
c526a8fd
SA
294 QString s_name = s->name().toLower();
295 s_name = s_name.replace(QRegExp("[-_.]"), " ");
692f6093
SA
296
297 if (s->logic_data() &&
298 ((ch_name.contains(s_name)) || (s_name.contains(ch_name)))) {
a8030bb0
SA
299 if (!match)
300 match = s;
301 else {
302 // Only replace an existing match if it matches more characters
303 int old_unmatched = ch_name.length() - match->name().length();
304 int new_unmatched = ch_name.length() - s->name().length();
305 if (abs(new_unmatched) < abs(old_unmatched))
306 match = s;
307 }
47747218 308 }
692f6093 309 }
a8030bb0 310
8ff61402
SA
311 // Prevent using a signal more than once as D1 would match e.g. D1 and D10
312 bool signal_not_already_used = true;
313 for (decode::DecodeChannel& ch : channels_)
314 if (ch.assigned_signal && (ch.assigned_signal == match))
315 signal_not_already_used = false;
316
317 if (match && signal_not_already_used) {
cf1541a1 318 ch.assigned_signal = match;
a8030bb0
SA
319 new_assignment = true;
320 }
47747218
SA
321 }
322
323 if (new_assignment) {
324 logic_mux_data_invalid_ = true;
e3202557 325 stack_config_changed_ = true;
27a3f09b 326 commit_decoder_channels();
47747218 327 channels_updated();
132a5c6d
SA
328 }
329}
330
cf1541a1 331void DecodeSignal::assign_signal(const uint16_t channel_id, shared_ptr<const SignalBase> signal)
9f97b357 332{
a82325d1 333 for (decode::DecodeChannel& ch : channels_)
47747218 334 if (ch.id == channel_id) {
9f97b357 335 ch.assigned_signal = signal;
47747218
SA
336 logic_mux_data_invalid_ = true;
337 }
9f97b357 338
e3202557 339 stack_config_changed_ = true;
27a3f09b 340 commit_decoder_channels();
9f97b357 341 channels_updated();
47747218 342 begin_decode();
9f97b357
SA
343}
344
27a3f09b
SA
345int DecodeSignal::get_assigned_signal_count() const
346{
347 // Count all channels that have a signal assigned to them
348 return count_if(channels_.begin(), channels_.end(),
cf1541a1 349 [](decode::DecodeChannel ch) { return ch.assigned_signal.get(); });
27a3f09b
SA
350}
351
9f97b357
SA
352void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
353{
a82325d1 354 for (decode::DecodeChannel& ch : channels_)
9f97b357
SA
355 if (ch.id == channel_id)
356 ch.initial_pin_state = init_state;
357
e3202557 358 stack_config_changed_ = true;
9f97b357 359 channels_updated();
47747218 360 begin_decode();
9f97b357
SA
361}
362
85125b0f 363double DecodeSignal::get_samplerate() const
ff83d980 364{
72435789
SA
365 double result = 0;
366
367 // TODO For now, we simply return the first samplerate that we have
8a603e13
SA
368 if (segments_.size() > 0)
369 result = segments_.front().samplerate;
72435789
SA
370
371 return result;
ff83d980
SA
372}
373
72435789 374const pv::util::Timestamp DecodeSignal::start_time() const
ff83d980 375{
72435789
SA
376 pv::util::Timestamp result;
377
378 // TODO For now, we simply return the first start time that we have
8a603e13
SA
379 if (segments_.size() > 0)
380 result = segments_.front().start_time;
72435789
SA
381
382 return result;
ff83d980
SA
383}
384
5ecf957f 385int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) const
0c5fe73e
SA
386{
387 // The working sample count is the highest sample number for
ed535cd7
SA
388 // which all used signals have data available, so go through all
389 // channels and use the lowest overall sample count of the segment
0c5fe73e 390
0c5fe73e
SA
391 int64_t count = std::numeric_limits<int64_t>::max();
392 bool no_signals_assigned = true;
393
a82325d1 394 for (const decode::DecodeChannel& ch : channels_)
0c5fe73e 395 if (ch.assigned_signal) {
1774d669
SA
396 if (!ch.assigned_signal->logic_data())
397 return 0;
398
0c5fe73e
SA
399 no_signals_assigned = false;
400
401 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
1774d669 402 if (logic_data->logic_segments().empty())
0c5fe73e
SA
403 return 0;
404
1774d669 405 if (segment_id >= logic_data->logic_segments().size())
5ecf957f 406 return 0;
1774d669 407
cf1541a1
SA
408 const shared_ptr<const LogicSegment> segment = logic_data->logic_segments()[segment_id]->get_shared_ptr();
409 if (segment)
410 count = min(count, (int64_t)segment->get_sample_count());
0c5fe73e
SA
411 }
412
413 return (no_signals_assigned ? 0 : count);
414}
415
b82908ab
SA
416int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id,
417 bool include_processing) const
ff83d980 418{
47747218 419 lock_guard<mutex> decode_lock(output_mutex_);
5ecf957f
SA
420
421 int64_t result = 0;
422
c8a6db0e
SA
423 if (segment_id >= segments_.size())
424 return result;
425
426 if (include_processing)
427 result = segments_[segment_id].samples_decoded_incl;
428 else
429 result = segments_[segment_id].samples_decoded_excl;
5ecf957f
SA
430
431 return result;
ff83d980
SA
432}
433
6a26fc44 434vector<Row*> DecodeSignal::get_rows(bool visible_only)
ecd07c20 435{
6a26fc44 436 vector<Row*> rows;
47747218 437
6a26fc44 438 for (const shared_ptr<Decoder>& dec : stack_) {
47747218 439 assert(dec);
5d3ca591 440 if (visible_only && !dec->visible())
cbb2e4da
SA
441 continue;
442
6a26fc44
SA
443 for (Row* row : dec->get_rows())
444 rows.push_back(row);
445 }
47747218 446
6a26fc44
SA
447 return rows;
448}
47747218 449
6a26fc44
SA
450vector<const Row*> DecodeSignal::get_rows(bool visible_only) const
451{
452 vector<const Row*> rows;
453
454 for (const shared_ptr<Decoder>& dec : stack_) {
455 assert(dec);
5d3ca591 456 if (visible_only && !dec->visible())
6a26fc44
SA
457 continue;
458
459 for (const Row* row : dec->get_rows())
460 rows.push_back(row);
47747218
SA
461 }
462
463 return rows;
ecd07c20
SA
464}
465
6a26fc44
SA
466
467uint64_t DecodeSignal::get_annotation_count(const Row* row, uint32_t segment_id) const
f994f496
SA
468{
469 if (segment_id >= segments_.size())
470 return 0;
471
6a26fc44 472 const DecodeSegment* segment = &(segments_.at(segment_id));
f994f496 473
6a26fc44 474 auto row_it = segment->annotation_rows.find(row);
f994f496 475
6a26fc44 476 const RowData* rd;
5a9146ac 477 if (row_it == segment->annotation_rows.end())
6a26fc44 478 return 0;
5a9146ac 479 else
6a26fc44
SA
480 rd = &(row_it->second);
481
482 return rd->get_annotation_count();
f994f496
SA
483}
484
462941e2 485void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
6a26fc44 486 const Row* row, uint32_t segment_id, uint64_t start_sample,
ecd07c20
SA
487 uint64_t end_sample) const
488{
47747218
SA
489 lock_guard<mutex> lock(output_mutex_);
490
c8a6db0e
SA
491 if (segment_id >= segments_.size())
492 return;
72435789 493
6a26fc44
SA
494 const DecodeSegment* segment = &(segments_.at(segment_id));
495
496 auto row_it = segment->annotation_rows.find(row);
c8a6db0e 497
6a26fc44 498 const RowData* rd;
5a9146ac 499 if (row_it == segment->annotation_rows.end())
6a26fc44 500 return;
5a9146ac 501 else
6a26fc44
SA
502 rd = &(row_it->second);
503
504 rd->get_annotation_subset(dest, start_sample, end_sample);
47747218
SA
505}
506
462941e2 507void DecodeSignal::get_annotation_subset(deque<const Annotation*> &dest,
5a914348
SA
508 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const
509{
462941e2
SA
510 for (const Row* row : get_rows())
511 get_annotation_subset(dest, row, segment_id, start_sample, end_sample);
5a914348
SA
512}
513
e77de61f 514uint32_t DecodeSignal::get_binary_data_chunk_count(uint32_t segment_id,
ac9494ef 515 const Decoder* dec, uint32_t bin_class_id) const
c0c3e62a 516{
1774d669 517 if ((segments_.size() == 0) || (segment_id >= segments_.size()))
c8a6db0e
SA
518 return 0;
519
1774d669 520 const DecodeSegment *segment = &(segments_[segment_id]);
e77de61f 521
1774d669
SA
522 for (const DecodeBinaryClass& bc : segment->binary_classes)
523 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
524 return bc.chunks.size();
c0c3e62a 525
e77de61f 526 return 0;
c0c3e62a
SA
527}
528
e77de61f 529void DecodeSignal::get_binary_data_chunk(uint32_t segment_id,
ac9494ef 530 const Decoder* dec, uint32_t bin_class_id, uint32_t chunk_id,
c0c3e62a
SA
531 const vector<uint8_t> **dest, uint64_t *size)
532{
1774d669
SA
533 if (segment_id >= segments_.size())
534 return;
e77de61f 535
1774d669
SA
536 const DecodeSegment *segment = &(segments_[segment_id]);
537
538 for (const DecodeBinaryClass& bc : segment->binary_classes)
539 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id)) {
540 if (dest) *dest = &(bc.chunks.at(chunk_id).data);
541 if (size) *size = bc.chunks.at(chunk_id).data.size();
542 return;
543 }
c0c3e62a
SA
544}
545
13b726cd 546void DecodeSignal::get_merged_binary_data_chunks_by_sample(uint32_t segment_id,
ac9494ef 547 const Decoder* dec, uint32_t bin_class_id, uint64_t start_sample,
e77de61f 548 uint64_t end_sample, vector<uint8_t> *dest) const
c0c3e62a
SA
549{
550 assert(dest != nullptr);
551
1774d669
SA
552 if (segment_id >= segments_.size())
553 return;
554
555 const DecodeSegment *segment = &(segments_[segment_id]);
556
557 const DecodeBinaryClass* bin_class = nullptr;
558 for (const DecodeBinaryClass& bc : segment->binary_classes)
559 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
560 bin_class = &bc;
561
562 // Determine overall size before copying to resize dest vector only once
563 uint64_t size = 0;
564 uint64_t matches = 0;
565 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
566 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
567 size += chunk.data.size();
568 matches++;
569 }
570 dest->resize(size);
571
572 uint64_t offset = 0;
573 uint64_t matches2 = 0;
574 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks)
575 if ((chunk.sample >= start_sample) && (chunk.sample < end_sample)) {
576 memcpy(dest->data() + offset, chunk.data.data(), chunk.data.size());
577 offset += chunk.data.size();
578 matches2++;
579
580 // Make sure we don't overwrite memory if the array grew in the meanwhile
581 if (matches2 == matches)
582 break;
583 }
c0c3e62a
SA
584}
585
13b726cd 586void DecodeSignal::get_merged_binary_data_chunks_by_offset(uint32_t segment_id,
6a26fc44
SA
587 const Decoder* dec, uint32_t bin_class_id, uint64_t start, uint64_t end,
588 vector<uint8_t> *dest) const
13b726cd
SA
589{
590 assert(dest != nullptr);
591
1774d669
SA
592 if (segment_id >= segments_.size())
593 return;
13b726cd 594
1774d669
SA
595 const DecodeSegment *segment = &(segments_[segment_id]);
596
597 const DecodeBinaryClass* bin_class = nullptr;
598 for (const DecodeBinaryClass& bc : segment->binary_classes)
599 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
600 bin_class = &bc;
601
602 // Determine overall size before copying to resize dest vector only once
603 uint64_t size = 0;
604 uint64_t offset = 0;
605 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
606 if (offset >= start)
607 size += chunk.data.size();
608 offset += chunk.data.size();
609 if (offset >= end)
610 break;
611 }
612 dest->resize(size);
613
614 offset = 0;
615 uint64_t dest_offset = 0;
616 for (const DecodeBinaryDataChunk& chunk : bin_class->chunks) {
617 if (offset >= start) {
618 memcpy(dest->data() + dest_offset, chunk.data.data(), chunk.data.size());
619 dest_offset += chunk.data.size();
13b726cd 620 }
1774d669
SA
621 offset += chunk.data.size();
622 if (offset >= end)
623 break;
13b726cd
SA
624 }
625}
626
628b45cc 627const DecodeBinaryClass* DecodeSignal::get_binary_data_class(uint32_t segment_id,
6a26fc44 628 const Decoder* dec, uint32_t bin_class_id) const
628b45cc 629{
1774d669
SA
630 if (segment_id >= segments_.size())
631 return nullptr;
628b45cc 632
1774d669
SA
633 const DecodeSegment *segment = &(segments_[segment_id]);
634
635 for (const DecodeBinaryClass& bc : segment->binary_classes)
636 if ((bc.decoder == dec) && (bc.info->bin_class_id == bin_class_id))
637 return &bc;
628b45cc
SA
638
639 return nullptr;
640}
c0c3e62a 641
f54e68b0
SA
642const deque<const Annotation*>* DecodeSignal::get_all_annotations_by_segment(
643 uint32_t segment_id) const
644{
1774d669
SA
645 if (segment_id >= segments_.size())
646 return nullptr;
f54e68b0 647
1774d669
SA
648 const DecodeSegment *segment = &(segments_[segment_id]);
649
650 return &(segment->all_annotations);
f54e68b0
SA
651}
652
47747218
SA
653void DecodeSignal::save_settings(QSettings &settings) const
654{
655 SignalBase::save_settings(settings);
656
c8e60bdf
SA
657 settings.setValue("decoders", (int)(stack_.size()));
658
8b5ea5a1 659 // Save decoder stack
c8e60bdf 660 int decoder_idx = 0;
6a26fc44 661 for (const shared_ptr<Decoder>& decoder : stack_) {
c8e60bdf
SA
662 settings.beginGroup("decoder" + QString::number(decoder_idx++));
663
6a26fc44 664 settings.setValue("id", decoder->get_srd_decoder()->id);
5d3ca591 665 settings.setValue("visible", decoder->visible());
c8e60bdf 666
d3feec23
SA
667 // Save decoder options
668 const map<string, GVariant*>& options = decoder->options();
669
670 settings.setValue("options", (int)options.size());
671
6a26fc44 672 // Note: Decoder::options() returns only the options
d3feec23
SA
673 // that differ from the default. See binding::Decoder::getter()
674 int i = 0;
f4ab4b5c 675 for (auto& option : options) {
d3feec23
SA
676 settings.beginGroup("option" + QString::number(i));
677 settings.setValue("name", QString::fromStdString(option.first));
678 GlobalSettings::store_gvariant(settings, option.second);
679 settings.endGroup();
680 i++;
681 }
682
e4cb8bcf
SA
683 // Save row properties
684 i = 0;
685 for (const Row* row : decoder->get_rows()) {
686 settings.beginGroup("row" + QString::number(i));
687 settings.setValue("visible", row->visible());
688 settings.endGroup();
689 i++;
690 }
691
692 // Save class properties
693 i = 0;
694 for (const AnnotationClass* ann_class : decoder->ann_classes()) {
695 settings.beginGroup("ann_class" + QString::number(i));
02078aa1 696 settings.setValue("visible", ann_class->visible());
e4cb8bcf
SA
697 settings.endGroup();
698 i++;
699 }
700
c8e60bdf
SA
701 settings.endGroup();
702 }
703
8b5ea5a1
SA
704 // Save channel mapping
705 settings.setValue("channels", (int)channels_.size());
706
707 for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
708 auto channel = find_if(channels_.begin(), channels_.end(),
a82325d1 709 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
8b5ea5a1
SA
710
711 if (channel == channels_.end()) {
712 qDebug() << "ERROR: Gap in channel index:" << channel_id;
713 continue;
714 }
715
716 settings.beginGroup("channel" + QString::number(channel_id));
717
718 settings.setValue("name", channel->name); // Useful for debugging
719 settings.setValue("initial_pin_state", channel->initial_pin_state);
720
721 if (channel->assigned_signal)
722 settings.setValue("assigned_signal_name", channel->assigned_signal->name());
723
724 settings.endGroup();
725 }
47747218
SA
726}
727
728void DecodeSignal::restore_settings(QSettings &settings)
729{
730 SignalBase::restore_settings(settings);
731
8b5ea5a1 732 // Restore decoder stack
c8e60bdf
SA
733 GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
734
735 int decoders = settings.value("decoders").toInt();
736
737 for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
738 settings.beginGroup("decoder" + QString::number(decoder_idx));
739
740 QString id = settings.value("id").toString();
741
742 for (GSList *entry = dec_list; entry; entry = entry->next) {
743 const srd_decoder *dec = (srd_decoder*)entry->data;
744 if (!dec)
745 continue;
746
747 if (QString::fromUtf8(dec->id) == id) {
f54e68b0 748 shared_ptr<Decoder> decoder = make_shared<Decoder>(dec, stack_.size());
d3feec23 749
02078aa1
SA
750 connect(decoder.get(), SIGNAL(annotation_visibility_changed()),
751 this, SLOT(on_annotation_visibility_changed()));
752
d3feec23 753 stack_.push_back(decoder);
5d3ca591 754 decoder->set_visible(settings.value("visible", true).toBool());
d3feec23
SA
755
756 // Restore decoder options that differ from their default
757 int options = settings.value("options").toInt();
758
759 for (int i = 0; i < options; i++) {
760 settings.beginGroup("option" + QString::number(i));
761 QString name = settings.value("name").toString();
762 GVariant *value = GlobalSettings::restore_gvariant(settings);
763 decoder->set_option(name.toUtf8(), value);
764 settings.endGroup();
765 }
c8e60bdf
SA
766
767 // Include the newly created decode channels in the channel lists
768 update_channel_list();
e4cb8bcf
SA
769
770 // Restore row properties
771 int i = 0;
772 for (Row* row : decoder->get_rows()) {
773 settings.beginGroup("row" + QString::number(i));
774 row->set_visible(settings.value("visible", true).toBool());
775 settings.endGroup();
776 i++;
777 }
778
779 // Restore class properties
780 i = 0;
781 for (AnnotationClass* ann_class : decoder->ann_classes()) {
782 settings.beginGroup("ann_class" + QString::number(i));
02078aa1 783 ann_class->set_visible(settings.value("visible", true).toBool());
e4cb8bcf
SA
784 settings.endGroup();
785 i++;
786 }
787
c8e60bdf
SA
788 break;
789 }
790 }
791
792 settings.endGroup();
4ca06ec3 793 channels_updated();
c8e60bdf
SA
794 }
795
8b5ea5a1
SA
796 // Restore channel mapping
797 unsigned int channels = settings.value("channels").toInt();
798
56c4de9a 799 const vector< shared_ptr<data::SignalBase> > signalbases =
8b5ea5a1
SA
800 session_.signalbases();
801
802 for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
803 auto channel = find_if(channels_.begin(), channels_.end(),
a82325d1 804 [&](decode::DecodeChannel ch) { return ch.id == channel_id; });
8b5ea5a1
SA
805
806 if (channel == channels_.end()) {
807 qDebug() << "ERROR: Non-existant channel index:" << channel_id;
808 continue;
809 }
810
811 settings.beginGroup("channel" + QString::number(channel_id));
812
813 QString assigned_signal_name = settings.value("assigned_signal_name").toString();
814
f4ab4b5c 815 for (const shared_ptr<data::SignalBase>& signal : signalbases)
2cc02460 816 if ((signal->name() == assigned_signal_name) && (signal->type() != SignalBase::DecodeChannel))
cf1541a1 817 channel->assigned_signal = signal;
8b5ea5a1
SA
818
819 channel->initial_pin_state = settings.value("initial_pin_state").toInt();
820
821 settings.endGroup();
822 }
823
aa71890d 824 // Update the internal structures
e3202557 825 stack_config_changed_ = true;
aa71890d
SA
826 update_channel_list();
827 commit_decoder_channels();
828
8b5ea5a1 829 begin_decode();
47747218
SA
830}
831
144e72c9
SA
832bool DecodeSignal::all_input_segments_complete(uint32_t segment_id) const
833{
834 bool all_complete = true;
835
836 for (const decode::DecodeChannel& ch : channels_)
837 if (ch.assigned_signal) {
838 if (!ch.assigned_signal->logic_data())
839 continue;
840
841 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
842 if (logic_data->logic_segments().empty())
843 return false;
844
845 if (segment_id >= logic_data->logic_segments().size())
846 return false;
847
cf1541a1
SA
848 const shared_ptr<const LogicSegment> segment = logic_data->logic_segments()[segment_id]->get_shared_ptr();
849 if (segment && !segment->is_complete())
144e72c9
SA
850 all_complete = false;
851 }
852
853 return all_complete;
854}
855
8a603e13
SA
856uint32_t DecodeSignal::get_input_segment_count() const
857{
858 uint64_t count = std::numeric_limits<uint64_t>::max();
859 bool no_signals_assigned = true;
860
a82325d1 861 for (const decode::DecodeChannel& ch : channels_)
8a603e13
SA
862 if (ch.assigned_signal) {
863 no_signals_assigned = false;
864
865 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
866 if (!logic_data || logic_data->logic_segments().empty())
867 return 0;
868
869 // Find the min value of all segment counts
870 if ((uint64_t)(logic_data->logic_segments().size()) < count)
871 count = logic_data->logic_segments().size();
872 }
873
874 return (no_signals_assigned ? 0 : count);
875}
876
2a12830c 877double DecodeSignal::get_input_samplerate(uint32_t segment_id) const
8a603e13
SA
878{
879 double samplerate = 0;
880
a82325d1 881 for (const decode::DecodeChannel& ch : channels_)
8a603e13
SA
882 if (ch.assigned_signal) {
883 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
884 if (!logic_data || logic_data->logic_segments().empty())
885 continue;
886
887 try {
cf1541a1
SA
888 const shared_ptr<const LogicSegment> segment =
889 logic_data->logic_segments().at(segment_id)->get_shared_ptr();
890 if (segment)
891 samplerate = segment->samplerate();
30677c13 892 } catch (out_of_range&) {
8a603e13
SA
893 // Do nothing
894 }
895 break;
896 }
897
898 return samplerate;
899}
900
6a26fc44
SA
901Decoder* DecodeSignal::get_decoder_by_instance(const srd_decoder *const srd_dec)
902{
903 for (shared_ptr<Decoder>& d : stack_)
904 if (d->get_srd_decoder() == srd_dec)
905 return d.get();
906
907 return nullptr;
908}
909
9f97b357
SA
910void DecodeSignal::update_channel_list()
911{
a82325d1 912 vector<decode::DecodeChannel> prev_channels = channels_;
9f97b357
SA
913 channels_.clear();
914
915 uint16_t id = 0;
916
917 // Copy existing entries, create new as needed
f4ab4b5c 918 for (shared_ptr<Decoder>& decoder : stack_) {
6a26fc44 919 const srd_decoder* srd_dec = decoder->get_srd_decoder();
9f97b357
SA
920 const GSList *l;
921
922 // Mandatory channels
6a26fc44 923 for (l = srd_dec->channels; l; l = l->next) {
9f97b357
SA
924 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
925 bool ch_added = false;
926
927 // Copy but update ID if this channel was in the list before
a82325d1 928 for (decode::DecodeChannel& ch : prev_channels)
9f97b357
SA
929 if (ch.pdch_ == pdch) {
930 ch.id = id++;
931 channels_.push_back(ch);
932 ch_added = true;
933 break;
934 }
935
936 if (!ch_added) {
937 // Create new entry without a mapped signal
a82325d1 938 decode::DecodeChannel ch = {id++, 0, false, nullptr,
9f97b357
SA
939 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
940 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
941 channels_.push_back(ch);
942 }
943 }
944
945 // Optional channels
6a26fc44 946 for (l = srd_dec->opt_channels; l; l = l->next) {
9f97b357
SA
947 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
948 bool ch_added = false;
949
950 // Copy but update ID if this channel was in the list before
a82325d1 951 for (decode::DecodeChannel& ch : prev_channels)
9f97b357
SA
952 if (ch.pdch_ == pdch) {
953 ch.id = id++;
954 channels_.push_back(ch);
955 ch_added = true;
956 break;
957 }
958
959 if (!ch_added) {
960 // Create new entry without a mapped signal
a82325d1 961 decode::DecodeChannel ch = {id++, 0, true, nullptr,
9f97b357
SA
962 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
963 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
964 channels_.push_back(ch);
965 }
966 }
967 }
968
47747218
SA
969 // Invalidate the logic output data if the channel assignment changed
970 if (prev_channels.size() != channels_.size()) {
971 // The number of channels changed, there's definitely a difference
972 logic_mux_data_invalid_ = true;
973 } else {
974 // Same number but assignment may still differ, so compare all channels
975 for (size_t i = 0; i < channels_.size(); i++) {
a82325d1
SA
976 const decode::DecodeChannel& p_ch = prev_channels[i];
977 const decode::DecodeChannel& ch = channels_[i];
47747218
SA
978
979 if ((p_ch.pdch_ != ch.pdch_) ||
980 (p_ch.assigned_signal != ch.assigned_signal)) {
981 logic_mux_data_invalid_ = true;
982 break;
983 }
984 }
985
986 }
987
9f97b357
SA
988 channels_updated();
989}
990
27a3f09b 991void DecodeSignal::commit_decoder_channels()
ad908057 992{
27a3f09b 993 // Submit channel list to every decoder, containing only the relevant channels
6a26fc44 994 for (shared_ptr<Decoder> dec : stack_) {
a82325d1 995 vector<decode::DecodeChannel*> channel_list;
27a3f09b 996
a82325d1 997 for (decode::DecodeChannel& ch : channels_)
27a3f09b
SA
998 if (ch.decoder_ == dec)
999 channel_list.push_back(&ch);
47747218 1000
27a3f09b
SA
1001 dec->set_channels(channel_list);
1002 }
aa71890d
SA
1003
1004 // Channel bit IDs must be in sync with the channel's apperance in channels_
1005 int id = 0;
a82325d1 1006 for (decode::DecodeChannel& ch : channels_)
aa71890d
SA
1007 if (ch.assigned_signal)
1008 ch.bit_id = id++;
47747218
SA
1009}
1010
ed535cd7 1011void DecodeSignal::mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end)
47747218 1012{
27a3f09b
SA
1013 // Enforce end to be greater than start
1014 if (end <= start)
1015 return;
1016
ed535cd7 1017 // Fetch the channel segments and their data
cf1541a1 1018 vector<shared_ptr<const LogicSegment> > segments;
27a3f09b
SA
1019 vector<const uint8_t*> signal_data;
1020 vector<uint8_t> signal_in_bytepos;
1021 vector<uint8_t> signal_in_bitpos;
1022
a82325d1 1023 for (decode::DecodeChannel& ch : channels_)
27a3f09b
SA
1024 if (ch.assigned_signal) {
1025 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
ed535cd7 1026
cf1541a1 1027 shared_ptr<const LogicSegment> segment;
f5a26d5e 1028 if (segment_id < logic_data->logic_segments().size()) {
cf1541a1 1029 segment = logic_data->logic_segments().at(segment_id)->get_shared_ptr();
f5a26d5e 1030 } else {
ed535cd7
SA
1031 qDebug() << "Muxer error for" << name() << ":" << ch.assigned_signal->name() \
1032 << "has no logic segment" << segment_id;
cf1541a1 1033 logic_mux_interrupt_ = true;
ed535cd7
SA
1034 return;
1035 }
cf1541a1 1036
f5a26d5e
SA
1037 if (!segment)
1038 return;
cf1541a1 1039
27a3f09b 1040 segments.push_back(segment);
b82243f7
SA
1041
1042 uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
1043 segment->get_samples(start, end, data);
1044 signal_data.push_back(data);
27a3f09b
SA
1045
1046 const int bitpos = ch.assigned_signal->logic_bit_index();
1047 signal_in_bytepos.push_back(bitpos / 8);
1048 signal_in_bitpos.push_back(bitpos % 8);
1049 }
1050
ed535cd7
SA
1051 shared_ptr<LogicSegment> output_segment;
1052 try {
1053 output_segment = logic_mux_data_->logic_segments().at(segment_id);
30677c13 1054 } catch (out_of_range&) {
ed535cd7
SA
1055 qDebug() << "Muxer error for" << name() << ": no logic mux segment" \
1056 << segment_id << "in mux_logic_samples(), mux segments size is" \
1057 << logic_mux_data_->logic_segments().size();
cf1541a1 1058 logic_mux_interrupt_ = true;
ed535cd7
SA
1059 return;
1060 }
1061
27a3f09b 1062 // Perform the muxing of signal data into the output data
8a603e13 1063 uint8_t* output = new uint8_t[(end - start) * output_segment->unit_size()];
27a3f09b
SA
1064 unsigned int signal_count = signal_data.size();
1065
3b5282a2
SA
1066 for (int64_t sample_cnt = 0; !logic_mux_interrupt_ && (sample_cnt < (end - start));
1067 sample_cnt++) {
1068
27a3f09b
SA
1069 int bitpos = 0;
1070 uint8_t bytepos = 0;
1071
8a603e13
SA
1072 const int out_sample_pos = sample_cnt * output_segment->unit_size();
1073 for (unsigned int i = 0; i < output_segment->unit_size(); i++)
27a3f09b 1074 output[out_sample_pos + i] = 0;
47747218 1075
27a3f09b
SA
1076 for (unsigned int i = 0; i < signal_count; i++) {
1077 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
1078 const uint8_t in_sample = 1 &
1079 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
47747218 1080
27a3f09b
SA
1081 const uint8_t out_sample = output[out_sample_pos + bytepos];
1082
1083 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
1084
1085 bitpos++;
1086 if (bitpos > 7) {
1087 bitpos = 0;
1088 bytepos++;
1089 }
1090 }
47747218
SA
1091 }
1092
8a603e13 1093 output_segment->append_payload(output, (end - start) * output_segment->unit_size());
27a3f09b
SA
1094 delete[] output;
1095
1096 for (const uint8_t* data : signal_data)
1097 delete[] data;
1098}
1099
1100void DecodeSignal::logic_mux_proc()
1101{
144e72c9
SA
1102 uint32_t input_segment_count;
1103 do {
1104 input_segment_count = get_input_segment_count();
1105 if (input_segment_count == 0) {
1106 // Wait for input data
1107 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1108 logic_mux_cond_.wait(logic_mux_lock);
1109 }
1110 } while ((!logic_mux_interrupt_) && (input_segment_count == 0));
1111
1112 if (logic_mux_interrupt_)
1113 return;
ed535cd7 1114
8a603e13
SA
1115 assert(logic_mux_data_);
1116
144e72c9
SA
1117 uint32_t segment_id = 0;
1118
65efd025
SA
1119 // Create initial logic mux segment
1120 shared_ptr<LogicSegment> output_segment =
cf1541a1 1121 make_shared<LogicSegment>(*logic_mux_data_, segment_id, logic_mux_unit_size_, 0);
65efd025 1122 logic_mux_data_->push_segment(output_segment);
8a603e13
SA
1123
1124 output_segment->set_samplerate(get_input_samplerate(0));
ed535cd7 1125
144e72c9
SA
1126 // Logic mux data is being updated
1127 logic_mux_data_invalid_ = false;
1128
1129 uint64_t samples_to_process;
27a3f09b 1130 do {
144e72c9
SA
1131 do {
1132 const uint64_t input_sample_count = get_working_sample_count(segment_id);
1133 const uint64_t output_sample_count = output_segment->get_sample_count();
27a3f09b 1134
144e72c9
SA
1135 samples_to_process =
1136 (input_sample_count > output_sample_count) ?
1137 (input_sample_count - output_sample_count) : 0;
ed535cd7 1138
144e72c9
SA
1139 if (samples_to_process > 0) {
1140 const uint64_t unit_size = output_segment->unit_size();
1141 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
ba5f2186 1142
144e72c9
SA
1143 uint64_t processed_samples = 0;
1144 do {
1145 const uint64_t start_sample = output_sample_count + processed_samples;
1146 const uint64_t sample_count =
1147 min(samples_to_process - processed_samples, chunk_sample_count);
1148
1149 mux_logic_samples(segment_id, start_sample, start_sample + sample_count);
1150 processed_samples += sample_count;
1151
1152 // ...and process the newly muxed logic data
1153 decode_input_cond_.notify_one();
1154 } while (!logic_mux_interrupt_ && (processed_samples < samples_to_process));
1155 }
1156 } while (!logic_mux_interrupt_ && (samples_to_process > 0));
1157
1158 if (!logic_mux_interrupt_) {
1159 // samples_to_process is now 0, we've exhausted the currently available input data
1160
1161 // If the input segments are complete, we've completed this segment
1162 if (all_input_segments_complete(segment_id)) {
1163 if (!output_segment->is_complete())
1164 output_segment->set_complete();
1165
1166 if (segment_id < get_input_segment_count() - 1) {
1167 // Process next segment
1168 segment_id++;
ed535cd7 1169
144e72c9
SA
1170 output_segment =
1171 make_shared<LogicSegment>(*logic_mux_data_, segment_id,
1172 logic_mux_unit_size_, 0);
1173 logic_mux_data_->push_segment(output_segment);
1174
1175 output_segment->set_samplerate(get_input_samplerate(segment_id));
9431e2d3
SA
1176 } else {
1177 // Wait for more input data if we're processing the currently last segment
1178 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
1179 logic_mux_cond_.wait(logic_mux_lock);
144e72c9 1180 }
69e95096 1181 }
27a3f09b 1182 }
1ec191ed 1183 } while (!logic_mux_interrupt_);
47747218
SA
1184}
1185
1186void DecodeSignal::decode_data(
8a603e13 1187 const int64_t abs_start_samplenum, const int64_t sample_count,
cf1541a1 1188 const shared_ptr<const LogicSegment> input_segment)
47747218 1189{
8a603e13 1190 const int64_t unit_size = input_segment->unit_size();
27a3f09b 1191 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
47747218
SA
1192
1193 for (int64_t i = abs_start_samplenum;
69e95096 1194 !decode_interrupt_ && (i < (abs_start_samplenum + sample_count));
47747218
SA
1195 i += chunk_sample_count) {
1196
1197 const int64_t chunk_end = min(i + chunk_sample_count,
1198 abs_start_samplenum + sample_count);
1199
e06cf18d
SA
1200 {
1201 lock_guard<mutex> lock(output_mutex_);
b82908ab
SA
1202 // Update the sample count showing the samples including currently processed ones
1203 segments_.at(current_segment_id_).samples_decoded_incl = chunk_end;
e06cf18d
SA
1204 }
1205
b82243f7
SA
1206 int64_t data_size = (chunk_end - i) * unit_size;
1207 uint8_t* chunk = new uint8_t[data_size];
8a603e13 1208 input_segment->get_samples(i, chunk_end, chunk);
47747218 1209
e91883bb 1210 if (srd_session_send(srd_session_, i, chunk_end, chunk,
144e72c9 1211 data_size, unit_size) != SRD_OK) {
403c3e87 1212 set_error_message(tr("Decoder reported an error"));
144e72c9
SA
1213 decode_interrupt_ = true;
1214 }
a3ebd556 1215
47747218
SA
1216 delete[] chunk;
1217
b82908ab
SA
1218 {
1219 lock_guard<mutex> lock(output_mutex_);
1220 // Now that all samples are processed, the exclusive sample count catches up
1221 segments_.at(current_segment_id_).samples_decoded_excl = chunk_end;
1222 }
1223
1b56c646
SA
1224 // Notify the frontend that we processed some data and
1225 // possibly have new annotations as well
1226 new_annotations();
556259d2
SA
1227
1228 if (decode_paused_) {
1229 unique_lock<mutex> pause_wait_lock(decode_pause_mutex_);
1230 decode_pause_cond_.wait(pause_wait_lock);
1231 }
47747218
SA
1232 }
1233}
1234
1235void DecodeSignal::decode_proc()
1236{
65efd025
SA
1237 current_segment_id_ = 0;
1238
1239 // If there is no input data available yet, wait until it is or we're interrupted
144e72c9
SA
1240 do {
1241 if (logic_mux_data_->logic_segments().size() == 0) {
1242 // Wait for input data
1243 unique_lock<mutex> input_wait_lock(input_mutex_);
1244 decode_input_cond_.wait(input_wait_lock);
1245 }
1246 } while ((!decode_interrupt_) && (logic_mux_data_->logic_segments().size() == 0));
a3ebd556
SA
1247
1248 if (decode_interrupt_)
1249 return;
1250
cf1541a1
SA
1251 shared_ptr<const LogicSegment> input_segment = logic_mux_data_->logic_segments().front()->get_shared_ptr();
1252 if (!input_segment)
1253 return;
65efd025
SA
1254
1255 // Create the initial segment and set its sample rate so that we can pass it to SRD
1256 create_decode_segment();
8a603e13 1257 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
65efd025 1258 segments_.at(current_segment_id_).start_time = input_segment->start_time();
8a603e13 1259
65efd025
SA
1260 start_srd_session();
1261
144e72c9 1262 uint64_t samples_to_process = 0;
27a3f09b 1263 uint64_t abs_start_samplenum = 0;
47747218 1264 do {
27a3f09b
SA
1265 // Keep processing new samples until we exhaust the input data
1266 do {
144e72c9 1267 samples_to_process = input_segment->get_sample_count() - abs_start_samplenum;
27a3f09b 1268
144e72c9
SA
1269 if (samples_to_process > 0) {
1270 decode_data(abs_start_samplenum, samples_to_process, input_segment);
1271 abs_start_samplenum += samples_to_process;
27a3f09b 1272 }
144e72c9
SA
1273 } while (!decode_interrupt_ && (samples_to_process > 0));
1274
1275 if (!decode_interrupt_) {
1276 // samples_to_process is now 0, we've exhausted the currently available input data
1277
1278 // If the input segment is complete, we've exhausted this segment
1279 if (input_segment->is_complete()) {
69e95096 1280 if (current_segment_id_ < (logic_mux_data_->logic_segments().size() - 1)) {
144e72c9
SA
1281 // Process next segment
1282 current_segment_id_++;
1283
1284 try {
1285 input_segment = logic_mux_data_->logic_segments().at(current_segment_id_);
1286 } catch (out_of_range&) {
1287 qDebug() << "Decode error for" << name() << ": no logic mux segment" \
1288 << current_segment_id_ << "in decode_proc(), mux segments size is" \
1289 << logic_mux_data_->logic_segments().size();
1290 decode_interrupt_ = true;
1291 return;
1292 }
1293 abs_start_samplenum = 0;
1294
1295 // Create the next segment and set its metadata
1296 create_decode_segment();
1297 segments_.at(current_segment_id_).samplerate = input_segment->samplerate();
1298 segments_.at(current_segment_id_).start_time = input_segment->start_time();
1299
1300 // Reset decoder state but keep the decoder stack intact
1301 terminate_srd_session();
1302 } else {
1303 // All segments have been processed
f5a26d5e
SA
1304 if (!decode_interrupt_)
1305 decode_finished();
9431e2d3
SA
1306
1307 // Wait for more input data
1308 unique_lock<mutex> input_wait_lock(input_mutex_);
1309 decode_input_cond_.wait(input_wait_lock);
8a603e13 1310 }
69e95096
SA
1311 }
1312
27a3f09b 1313 }
144e72c9 1314 } while (!decode_interrupt_);
e91883bb
SA
1315}
1316
1317void DecodeSignal::start_srd_session()
1318{
8ce0e732
SA
1319 // If there were stack changes, the session has been destroyed by now, so if
1320 // it hasn't been destroyed, we can just reset and re-use it
ce0b6a40
GS
1321 if (srd_session_) {
1322 // When a decoder stack was created before, re-use it
1323 // for the next stream of input data, after terminating
1324 // potentially still executing operations, and resetting
1325 // internal state. Skip the rather expensive (teardown
1326 // and) construction of another decoder stack.
1327
1328 // TODO Reduce redundancy, use a common code path for
72486b78 1329 // the meta/start sequence?
ce0b6a40 1330 terminate_srd_session();
72486b78
SA
1331
1332 // Metadata is cleared also, so re-set it
ba5b52e1 1333 uint64_t samplerate = 0;
7dd518b8 1334 if (segments_.size() > 0)
ba5b52e1
GS
1335 samplerate = segments_.at(current_segment_id_).samplerate;
1336 if (samplerate)
7dd518b8 1337 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
ba5b52e1 1338 g_variant_new_uint64(samplerate));
6a26fc44 1339 for (const shared_ptr<Decoder>& dec : stack_)
72486b78 1340 dec->apply_all_options();
ce0b6a40 1341 srd_session_start(srd_session_);
72486b78 1342
ce0b6a40
GS
1343 return;
1344 }
e91883bb 1345
a3ebd556
SA
1346 // Create the session
1347 srd_session_new(&srd_session_);
1348 assert(srd_session_);
47747218 1349
a3ebd556
SA
1350 // Create the decoders
1351 srd_decoder_inst *prev_di = nullptr;
6a26fc44 1352 for (const shared_ptr<Decoder>& dec : stack_) {
a3ebd556 1353 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
e91883bb 1354
a3ebd556 1355 if (!di) {
403c3e87 1356 set_error_message(tr("Failed to create decoder instance"));
a3ebd556 1357 srd_session_destroy(srd_session_);
c5f9553c 1358 srd_session_ = nullptr;
a3ebd556
SA
1359 return;
1360 }
e91883bb 1361
a3ebd556
SA
1362 if (prev_di)
1363 srd_inst_stack(srd_session_, prev_di, di);
e91883bb 1364
a3ebd556 1365 prev_di = di;
e91883bb 1366 }
a3ebd556
SA
1367
1368 // Start the session
7dd518b8
SA
1369 if (segments_.size() > 0)
1370 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
1371 g_variant_new_uint64(segments_.at(current_segment_id_).samplerate));
a3ebd556
SA
1372
1373 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
1374 DecodeSignal::annotation_callback, this);
1375
c0c3e62a
SA
1376 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_BINARY,
1377 DecodeSignal::binary_callback, this);
1378
a3ebd556 1379 srd_session_start(srd_session_);
e3202557
SA
1380
1381 // We just recreated the srd session, so all stack changes are applied now
1382 stack_config_changed_ = false;
e91883bb 1383}
47747218 1384
ce0b6a40
GS
1385void DecodeSignal::terminate_srd_session()
1386{
1387 // Call the "terminate and reset" routine for the decoder stack
1388 // (if available). This does not harm those stacks which already
1389 // have completed their operation, and reduces response time for
1390 // those stacks which still are processing data while the
1391 // application no longer wants them to.
72486b78 1392 if (srd_session_) {
ce0b6a40 1393 srd_session_terminate_reset(srd_session_);
72486b78
SA
1394
1395 // Metadata is cleared also, so re-set it
ba5b52e1 1396 uint64_t samplerate = 0;
7dd518b8 1397 if (segments_.size() > 0)
ba5b52e1
GS
1398 samplerate = segments_.at(current_segment_id_).samplerate;
1399 if (samplerate)
7dd518b8 1400 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
ba5b52e1 1401 g_variant_new_uint64(samplerate));
6a26fc44 1402 for (const shared_ptr<Decoder>& dec : stack_)
72486b78
SA
1403 dec->apply_all_options();
1404 }
ce0b6a40
GS
1405}
1406
e91883bb
SA
1407void DecodeSignal::stop_srd_session()
1408{
1409 if (srd_session_) {
1410 // Destroy the session
1411 srd_session_destroy(srd_session_);
1412 srd_session_ = nullptr;
8ce0e732
SA
1413
1414 // Mark the decoder instances as non-existant since they were deleted
6a26fc44 1415 for (const shared_ptr<Decoder>& dec : stack_)
8ce0e732 1416 dec->invalidate_decoder_inst();
e91883bb 1417 }
47747218
SA
1418}
1419
a8a9222d
SA
1420void DecodeSignal::connect_input_notifiers()
1421{
1422 // Disconnect the notification slot from the previous set of signals
1b56c646 1423 disconnect(this, SLOT(on_data_cleared()));
a8a9222d
SA
1424 disconnect(this, SLOT(on_data_received()));
1425
1426 // Connect the currently used signals to our slot
a82325d1 1427 for (decode::DecodeChannel& ch : channels_) {
a8a9222d
SA
1428 if (!ch.assigned_signal)
1429 continue;
1430
cf1541a1 1431 const data::SignalBase *signal = ch.assigned_signal.get();
144e72c9
SA
1432 connect(signal, &data::SignalBase::samples_cleared,
1433 this, &DecodeSignal::on_data_cleared);
1434 connect(signal, &data::SignalBase::samples_added,
1435 this, &DecodeSignal::on_data_received);
a8a9222d
SA
1436 }
1437}
1438
65efd025 1439void DecodeSignal::create_decode_segment()
4913560f 1440{
65efd025 1441 // Create annotation segment
f54e68b0 1442 segments_.emplace_back();
72435789 1443
65efd025 1444 // Add annotation classes
feda6c6b 1445 for (const shared_ptr<Decoder>& dec : stack_)
6a26fc44
SA
1446 for (Row* row : dec->get_rows())
1447 segments_.back().annotation_rows.emplace(row, RowData(row));
e77de61f
SA
1448
1449 // Prepare our binary output classes
6a26fc44 1450 for (const shared_ptr<Decoder>& dec : stack_) {
ac9494ef 1451 uint32_t n = dec->get_binary_class_count();
e77de61f 1452
ac9494ef 1453 for (uint32_t i = 0; i < n; i++)
e77de61f 1454 segments_.back().binary_classes.push_back(
c8a6db0e 1455 {dec.get(), dec->get_binary_class(i), deque<DecodeBinaryDataChunk>()});
e77de61f 1456 }
4913560f
SA
1457}
1458
47747218
SA
1459void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
1460{
1461 assert(pdata);
b21501d6 1462 assert(decode_signal);
47747218
SA
1463
1464 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1465 assert(ds);
1466
3b5282a2
SA
1467 if (ds->decode_interrupt_)
1468 return;
1469
02c87df7
SA
1470 if (ds->segments_.empty())
1471 return;
1472
47747218
SA
1473 lock_guard<mutex> lock(ds->output_mutex_);
1474
c0c3e62a 1475 // Get the decoder and the annotation data
47747218
SA
1476 assert(pdata->pdo);
1477 assert(pdata->pdo->di);
6a26fc44
SA
1478 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1479 assert(srd_dec);
47747218 1480
c0c3e62a 1481 const srd_proto_data_annotation *const pda = (const srd_proto_data_annotation*)pdata->data;
1becee23
UH
1482 assert(pda);
1483
c0c3e62a 1484 // Find the row
6a26fc44
SA
1485 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
1486 assert(dec);
47747218 1487
6a26fc44 1488 AnnotationClass* ann_class = dec->get_ann_class_by_id(pda->ann_class);
4526de63
SA
1489 if (!ann_class) {
1490 qWarning() << "Decoder" << ds->display_name() << "wanted to add annotation" <<
1491 "with class ID" << pda->ann_class << "but there are only" <<
1492 dec->ann_classes().size() << "known classes";
1493 return;
1494 }
6a26fc44
SA
1495
1496 const Row* row = ann_class->row;
1497
1498 if (!row)
1499 row = dec->get_row_by_id(0);
47747218 1500
f54e68b0
SA
1501 RowData& row_data = ds->segments_[ds->current_segment_id_].annotation_rows.at(row);
1502
1503 // Add the annotation to the row
1504 const Annotation* ann = row_data.emplace_annotation(pdata);
1505
ca9a5918
SA
1506 // We insert the annotation into the global annotation list in a way so that
1507 // the annotation list is sorted by start sample and length. Otherwise, we'd
1508 // have to sort the model, which is expensive
f54e68b0
SA
1509 deque<const Annotation*>& all_annotations =
1510 ds->segments_[ds->current_segment_id_].all_annotations;
ca9a5918
SA
1511
1512 if (all_annotations.empty()) {
1513 all_annotations.emplace_back(ann);
1514 } else {
1515 const uint64_t new_ann_len = (pdata->end_sample - pdata->start_sample);
1516 bool ann_has_earlier_start = (pdata->start_sample < all_annotations.back()->start_sample());
1517 bool ann_is_longer = (new_ann_len >
1518 (all_annotations.back()->end_sample() - all_annotations.back()->start_sample()));
1519
1520 if (ann_has_earlier_start && ann_is_longer) {
1521 bool ann_has_same_start;
1522 auto it = all_annotations.end();
1523
1524 do {
1525 it--;
1526 ann_has_earlier_start = (pdata->start_sample < (*it)->start_sample());
1527 ann_has_same_start = (pdata->start_sample == (*it)->start_sample());
d656b010 1528 ann_is_longer = (new_ann_len > (*it)->length());
ca9a5918
SA
1529 } while ((ann_has_earlier_start || (ann_has_same_start && ann_is_longer)) && (it != all_annotations.begin()));
1530
1531 // Allow inserting at the front
1532 if (it != all_annotations.begin())
1533 it++;
1534
1535 all_annotations.emplace(it, ann);
1536 } else
1537 all_annotations.emplace_back(ann);
1538 }
88a25978
SA
1539
1540 // When emplace_annotation() inserts instead of appends an annotation,
1541 // the pointers in all_annotations that follow the inserted annotation and
1542 // point to annotations for this row are off by one and must be updated
1543 if (&(row_data.annotations().back()) != ann) {
1544 // Search backwards until we find the annotation we just added
1545 auto row_it = row_data.annotations().end();
1546 auto all_it = all_annotations.end();
1547 do {
1548 all_it--;
1549 if ((*all_it)->row_data() == &row_data)
1550 row_it--;
1551 } while (&(*row_it) != ann);
1552
1553 // Update the annotation addresses for this row's annotations until the end
1554 do {
1555 if ((*all_it)->row_data() == &row_data) {
1556 *all_it = &(*row_it);
1557 row_it++;
1558 }
1559 all_it++;
1560 } while (all_it != all_annotations.end());
1561 }
47747218
SA
1562}
1563
c0c3e62a
SA
1564void DecodeSignal::binary_callback(srd_proto_data *pdata, void *decode_signal)
1565{
1566 assert(pdata);
1567 assert(decode_signal);
1568
1569 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
1570 assert(ds);
1571
1572 if (ds->decode_interrupt_)
1573 return;
1574
e77de61f
SA
1575 // Get the decoder and the binary data
1576 assert(pdata->pdo);
1577 assert(pdata->pdo->di);
6a26fc44
SA
1578 const srd_decoder *const srd_dec = pdata->pdo->di->decoder;
1579 assert(srd_dec);
e77de61f 1580
c0c3e62a
SA
1581 const srd_proto_data_binary *const pdb = (const srd_proto_data_binary*)pdata->data;
1582 assert(pdb);
1583
e77de61f 1584 // Find the matching DecodeBinaryClass
c0c3e62a
SA
1585 DecodeSegment* segment = &(ds->segments_.at(ds->current_segment_id_));
1586
e77de61f
SA
1587 DecodeBinaryClass* bin_class = nullptr;
1588 for (DecodeBinaryClass& bc : segment->binary_classes)
6a26fc44
SA
1589 if ((bc.decoder->get_srd_decoder() == srd_dec) &&
1590 (bc.info->bin_class_id == (uint32_t)pdb->bin_class))
e77de61f 1591 bin_class = &bc;
c0c3e62a 1592
e77de61f
SA
1593 if (!bin_class) {
1594 qWarning() << "Could not find valid DecodeBinaryClass in segment" <<
1595 ds->current_segment_id_ << "for binary class ID" << pdb->bin_class <<
1596 ", segment only knows" << segment->binary_classes.size() << "classes";
1597 return;
1598 }
c0c3e62a 1599
e77de61f
SA
1600 // Add the data chunk
1601 bin_class->chunks.emplace_back();
1602 DecodeBinaryDataChunk* chunk = &(bin_class->chunks.back());
1603
1604 chunk->sample = pdata->start_sample;
1605 chunk->data.resize(pdb->size);
1606 memcpy(chunk->data.data(), pdb->data, pdb->size);
1607
6a26fc44 1608 Decoder* dec = ds->get_decoder_by_instance(srd_dec);
b2b18d3a
SA
1609
1610 ds->new_binary_data(ds->current_segment_id_, (void*)dec, pdb->bin_class);
c0c3e62a
SA
1611}
1612
47747218
SA
1613void DecodeSignal::on_capture_state_changed(int state)
1614{
1615 // If a new acquisition was started, we need to start decoding from scratch
ba5f2186
SA
1616 if (state == Session::Running) {
1617 logic_mux_data_invalid_ = true;
47747218 1618 begin_decode();
ba5f2186 1619 }
47747218
SA
1620}
1621
1b56c646
SA
1622void DecodeSignal::on_data_cleared()
1623{
1624 reset_decode();
1625}
1626
47747218
SA
1627void DecodeSignal::on_data_received()
1628{
5620539c
SA
1629 // If we detected a lack of input data when trying to start decoding,
1630 // we have set an error message. Only try again if we now have data
1631 // to work with
1632 if ((!error_message_.isEmpty()) && (get_input_segment_count() == 0))
1633 return;
69e95096
SA
1634 else {
1635 error_message_.clear();
1636 // TODO Emulate noquote()
1637 qDebug().nospace() << name() << ": Error cleared";
1638 }
5620539c 1639
1b56c646
SA
1640 if (!logic_mux_thread_.joinable())
1641 begin_decode();
1642 else
1643 logic_mux_cond_.notify_one();
47747218
SA
1644}
1645
02078aa1
SA
1646void DecodeSignal::on_annotation_visibility_changed()
1647{
1648 annotation_visibility_changed();
1649}
1650
ad908057
SA
1651} // namespace data
1652} // namespace pv