2 * This file is part of the PulseView project.
4 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
25 #include "logicsegment.hpp"
26 #include "decodesignal.hpp"
27 #include "signaldata.hpp"
29 #include <pv/binding/decoder.hpp>
30 #include <pv/data/decode/decoder.hpp>
31 #include <pv/data/decode/row.hpp>
32 #include <pv/session.hpp>
34 using std::lock_guard;
36 using std::make_shared;
38 using std::shared_ptr;
39 using std::unique_lock;
40 using pv::data::decode::Annotation;
41 using pv::data::decode::Decoder;
42 using pv::data::decode::Row;
47 const double DecodeSignal::DecodeMargin = 1.0;
48 const double DecodeSignal::DecodeThreshold = 0.2;
49 const int64_t DecodeSignal::DecodeChunkLength = 10 * 1024 * 1024;
50 const unsigned int DecodeSignal::DecodeNotifyPeriod = 1024;
52 mutex DecodeSignal::global_srd_mutex_;
55 DecodeSignal::DecodeSignal(pv::Session &session) :
56 SignalBase(nullptr, SignalBase::DecodeChannel),
58 srd_session_(nullptr),
59 logic_mux_data_invalid_(false),
64 frame_complete_(false)
66 connect(&session_, SIGNAL(capture_state_changed(int)),
67 this, SLOT(on_capture_state_changed(int)));
69 set_name(tr("Empty decoder signal"));
72 DecodeSignal::~DecodeSignal()
74 if (decode_thread_.joinable()) {
75 decode_interrupt_ = true;
76 decode_input_cond_.notify_one();
77 decode_thread_.join();
80 if (logic_mux_thread_.joinable()) {
81 logic_mux_interrupt_ = true;
82 logic_mux_cond_.notify_one();
83 logic_mux_thread_.join();
89 const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
94 void DecodeSignal::stack_decoder(srd_decoder *decoder)
97 stack_.push_back(make_shared<decode::Decoder>(decoder));
99 // Set name if this decoder is the first in the list
100 if (stack_.size() == 1)
101 set_name(QString::fromUtf8(decoder->name));
103 // Include the newly created decode channels in the channel lists
104 update_channel_list();
106 auto_assign_signals();
107 commit_decoder_channels();
111 void DecodeSignal::remove_decoder(int index)
114 assert(index < (int)stack_.size());
116 // Find the decoder in the stack
117 auto iter = stack_.begin();
118 for (int i = 0; i < index; i++, iter++)
119 assert(iter != stack_.end());
121 // Delete the element
124 // Update channels and decoded data
125 update_channel_list();
129 bool DecodeSignal::toggle_decoder_visibility(int index)
131 auto iter = stack_.cbegin();
132 for (int i = 0; i < index; i++, iter++)
133 assert(iter != stack_.end());
135 shared_ptr<Decoder> dec = *iter;
137 // Toggle decoder visibility
140 state = !dec->shown();
147 void DecodeSignal::reset_decode()
151 annotation_count_ = 0;
152 frame_complete_ = false;
153 samples_decoded_ = 0;
154 error_message_ = QString();
159 void DecodeSignal::begin_decode()
161 if (decode_thread_.joinable()) {
162 decode_interrupt_ = true;
163 decode_input_cond_.notify_one();
164 decode_thread_.join();
167 if (logic_mux_thread_.joinable()) {
168 logic_mux_interrupt_ = true;
169 logic_mux_cond_.notify_one();
170 logic_mux_thread_.join();
175 if (stack_.size() == 0) {
176 error_message_ = tr("No decoders");
180 assert(channels_.size() > 0);
182 if (get_assigned_signal_count() == 0) {
183 error_message_ = tr("There are no channels assigned to this decoder");
187 // Check that all decoders have the required channels
188 for (const shared_ptr<decode::Decoder> &dec : stack_)
189 if (!dec->have_required_channels()) {
190 error_message_ = tr("One or more required channels "
191 "have not been specified");
195 // Add annotation classes
196 for (const shared_ptr<decode::Decoder> &dec : stack_) {
198 const srd_decoder *const decc = dec->decoder();
199 assert(dec->decoder());
201 // Add a row for the decoder if it doesn't have a row list
202 if (!decc->annotation_rows)
203 rows_[Row(decc)] = decode::RowData();
205 // Add the decoder rows
206 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
207 const srd_decoder_annotation_row *const ann_row =
208 (srd_decoder_annotation_row *)l->data;
211 const Row row(decc, ann_row);
213 // Add a new empty row data object
214 rows_[row] = decode::RowData();
216 // Map out all the classes
217 for (const GSList *ll = ann_row->ann_classes;
219 class_rows_[make_pair(decc,
220 GPOINTER_TO_INT(ll->data))] = row;
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();
228 if (!logic_mux_data_) {
229 const int64_t ch_count = get_assigned_signal_count();
230 const int64_t unit_size = (ch_count + 7) / 8;
231 logic_mux_data_ = make_shared<Logic>(ch_count);
232 segment_ = make_shared<LogicSegment>(*logic_mux_data_, unit_size, samplerate_);
233 logic_mux_data_->push_segment(segment_);
236 // Make sure the logic output data is complete and up-to-date
237 logic_mux_interrupt_ = false;
238 logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this);
240 // Decode the muxed logic data
241 decode_interrupt_ = false;
242 decode_thread_ = std::thread(&DecodeSignal::decode_proc, this);
244 // Receive notifications when new sample data is available
245 connect_input_notifiers();
248 QString DecodeSignal::error_message() const
250 lock_guard<mutex> lock(output_mutex_);
251 return error_message_;
254 const vector<data::DecodeChannel> DecodeSignal::get_channels() const
259 void DecodeSignal::auto_assign_signals()
261 bool new_assignment = false;
263 // Try to auto-select channels that don't have signals assigned yet
264 for (data::DecodeChannel &ch : channels_) {
265 if (ch.assigned_signal)
268 for (shared_ptr<data::SignalBase> s : session_.signalbases())
269 if (s->logic_data() && (ch.name.toLower().contains(s->name().toLower()))) {
270 ch.assigned_signal = s.get();
271 new_assignment = true;
275 if (new_assignment) {
276 logic_mux_data_invalid_ = true;
277 commit_decoder_channels();
282 void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal)
284 for (data::DecodeChannel &ch : channels_)
285 if (ch.id == channel_id) {
286 ch.assigned_signal = signal;
287 logic_mux_data_invalid_ = true;
290 commit_decoder_channels();
295 int DecodeSignal::get_assigned_signal_count() const
297 // Count all channels that have a signal assigned to them
298 return count_if(channels_.begin(), channels_.end(),
299 [](data::DecodeChannel ch) { return ch.assigned_signal; });
302 void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state)
304 for (data::DecodeChannel &ch : channels_)
305 if (ch.id == channel_id)
306 ch.initial_pin_state = init_state;
313 double DecodeSignal::samplerate() const
318 const pv::util::Timestamp& DecodeSignal::start_time() const
323 int64_t DecodeSignal::get_working_sample_count() const
325 // The working sample count is the highest sample number for
326 // which all used signals have data available, so go through
327 // all channels and use the lowest overall sample count of the
330 // TODO Currently, we assume only a single segment exists
332 int64_t count = std::numeric_limits<int64_t>::max();
333 bool no_signals_assigned = true;
335 for (const data::DecodeChannel &ch : channels_)
336 if (ch.assigned_signal) {
337 no_signals_assigned = false;
339 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
340 if (!logic_data || logic_data->logic_segments().empty())
343 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().front();
344 count = min(count, (int64_t)segment->get_sample_count());
347 return (no_signals_assigned ? 0 : count);
350 int64_t DecodeSignal::get_decoded_sample_count() const
352 lock_guard<mutex> decode_lock(output_mutex_);
353 return samples_decoded_;
356 vector<Row> DecodeSignal::visible_rows() const
358 lock_guard<mutex> lock(output_mutex_);
362 for (const shared_ptr<decode::Decoder> &dec : stack_) {
367 const srd_decoder *const decc = dec->decoder();
368 assert(dec->decoder());
370 // Add a row for the decoder if it doesn't have a row list
371 if (!decc->annotation_rows)
372 rows.emplace_back(decc);
374 // Add the decoder rows
375 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
376 const srd_decoder_annotation_row *const ann_row =
377 (srd_decoder_annotation_row *)l->data;
379 rows.emplace_back(decc, ann_row);
386 void DecodeSignal::get_annotation_subset(
387 vector<pv::data::decode::Annotation> &dest,
388 const decode::Row &row, uint64_t start_sample,
389 uint64_t end_sample) const
391 lock_guard<mutex> lock(output_mutex_);
393 const auto iter = rows_.find(row);
394 if (iter != rows_.end())
395 (*iter).second.get_annotation_subset(dest,
396 start_sample, end_sample);
399 void DecodeSignal::save_settings(QSettings &settings) const
401 SignalBase::save_settings(settings);
403 // TODO Save decoder stack, channel mapping and decoder options
406 void DecodeSignal::restore_settings(QSettings &settings)
408 SignalBase::restore_settings(settings);
410 // TODO Restore decoder stack, channel mapping and decoder options
413 uint64_t DecodeSignal::inc_annotation_count()
415 return (annotation_count_++);
418 void DecodeSignal::update_channel_list()
420 vector<data::DecodeChannel> prev_channels = channels_;
425 // Copy existing entries, create new as needed
426 for (shared_ptr<Decoder> decoder : stack_) {
427 const srd_decoder* srd_d = decoder->decoder();
430 // Mandatory channels
431 for (l = srd_d->channels; l; l = l->next) {
432 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
433 bool ch_added = false;
435 // Copy but update ID if this channel was in the list before
436 for (data::DecodeChannel &ch : prev_channels)
437 if (ch.pdch_ == pdch) {
439 channels_.push_back(ch);
445 // Create new entry without a mapped signal
446 data::DecodeChannel ch = {id++, false, nullptr,
447 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
448 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
449 channels_.push_back(ch);
454 for (l = srd_d->opt_channels; l; l = l->next) {
455 const struct srd_channel *const pdch = (struct srd_channel *)l->data;
456 bool ch_added = false;
458 // Copy but update ID if this channel was in the list before
459 for (data::DecodeChannel &ch : prev_channels)
460 if (ch.pdch_ == pdch) {
462 channels_.push_back(ch);
468 // Create new entry without a mapped signal
469 data::DecodeChannel ch = {id++, true, nullptr,
470 QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
471 SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
472 channels_.push_back(ch);
477 // Invalidate the logic output data if the channel assignment changed
478 if (prev_channels.size() != channels_.size()) {
479 // The number of channels changed, there's definitely a difference
480 logic_mux_data_invalid_ = true;
482 // Same number but assignment may still differ, so compare all channels
483 for (size_t i = 0; i < channels_.size(); i++) {
484 const data::DecodeChannel &p_ch = prev_channels[i];
485 const data::DecodeChannel &ch = channels_[i];
487 if ((p_ch.pdch_ != ch.pdch_) ||
488 (p_ch.assigned_signal != ch.assigned_signal)) {
489 logic_mux_data_invalid_ = true;
499 void DecodeSignal::commit_decoder_channels()
501 // Submit channel list to every decoder, containing only the relevant channels
502 for (shared_ptr<decode::Decoder> dec : stack_) {
503 vector<data::DecodeChannel*> channel_list;
505 for (data::DecodeChannel &ch : channels_)
506 if (ch.decoder_ == dec)
507 channel_list.push_back(&ch);
509 dec->set_channels(channel_list);
513 void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end)
515 // Enforce end to be greater than start
519 // Fetch all segments and their data
520 // TODO Currently, we assume only a single segment exists
521 vector<shared_ptr<LogicSegment> > segments;
522 vector<const uint8_t*> signal_data;
523 vector<uint8_t> signal_in_bytepos;
524 vector<uint8_t> signal_in_bitpos;
526 for (data::DecodeChannel &ch : channels_)
527 if (ch.assigned_signal) {
528 const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
529 const shared_ptr<LogicSegment> segment = logic_data->logic_segments().front();
530 segments.push_back(segment);
531 signal_data.push_back(segment->get_samples(start, end));
533 const int bitpos = ch.assigned_signal->logic_bit_index();
534 signal_in_bytepos.push_back(bitpos / 8);
535 signal_in_bitpos.push_back(bitpos % 8);
538 // Perform the muxing of signal data into the output data
539 uint8_t* output = new uint8_t[(end - start) * segment_->unit_size()];
540 unsigned int signal_count = signal_data.size();
542 for (int64_t sample_cnt = 0; sample_cnt < (end - start); sample_cnt++) {
546 const int out_sample_pos = sample_cnt * segment_->unit_size();
547 for (unsigned int i = 0; i < segment_->unit_size(); i++)
548 output[out_sample_pos + i] = 0;
550 for (unsigned int i = 0; i < signal_count; i++) {
551 const int in_sample_pos = sample_cnt * segments[i]->unit_size();
552 const uint8_t in_sample = 1 &
553 ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i]));
555 const uint8_t out_sample = output[out_sample_pos + bytepos];
557 output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos);
567 segment_->append_payload(output, (end - start) * segment_->unit_size());
570 for (const uint8_t* data : signal_data)
574 void DecodeSignal::logic_mux_proc()
577 const uint64_t input_sample_count = get_working_sample_count();
578 const uint64_t output_sample_count = segment_->get_sample_count();
580 const uint64_t samples_to_process =
581 (input_sample_count > output_sample_count) ?
582 (input_sample_count - output_sample_count) : 0;
584 // Process the samples if necessary...
585 if (samples_to_process > 0) {
586 const uint64_t unit_size = segment_->unit_size();
587 const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
589 uint64_t processed_samples = 0;
591 const uint64_t start_sample = output_sample_count + processed_samples;
592 const uint64_t sample_count =
593 min(samples_to_process - processed_samples, chunk_sample_count);
595 mux_logic_samples(start_sample, start_sample + sample_count);
596 processed_samples += sample_count;
598 // ...and process the newly muxed logic data
599 decode_input_cond_.notify_one();
600 } while (processed_samples < samples_to_process);
603 if (session_.get_capture_state() != Session::Stopped) {
604 // Wait for more input
605 unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
606 logic_mux_cond_.wait(logic_mux_lock);
608 } while ((session_.get_capture_state() != Session::Stopped) && !logic_mux_interrupt_);
610 // No more input data and session is stopped, let the decode thread
611 // process any pending data, terminate and release the global SRD mutex
612 // in order to let other decoders run
613 decode_input_cond_.notify_one();
616 void DecodeSignal::query_input_metadata()
618 // Update the samplerate and start time because we cannot start
619 // the libsrd session without the current samplerate
621 // TODO Currently we assume all channels have the same sample rate
623 bool samplerate_valid = false;
625 auto any_channel = find_if(channels_.begin(), channels_.end(),
626 [](data::DecodeChannel ch) { return ch.assigned_signal; });
628 shared_ptr<Logic> logic_data =
629 any_channel->assigned_signal->logic_data();
632 if (!logic_data->logic_segments().empty()) {
633 shared_ptr<LogicSegment> first_segment =
634 any_channel->assigned_signal->logic_data()->logic_segments().front();
635 start_time_ = first_segment->start_time();
636 samplerate_ = first_segment->samplerate();
638 samplerate_valid = true;
641 // Wait until input data is available or an interrupt was requested
642 unique_lock<mutex> input_wait_lock(input_mutex_);
643 decode_input_cond_.wait(input_wait_lock);
644 } while (!samplerate_valid && !decode_interrupt_);
647 void DecodeSignal::decode_data(
648 const int64_t abs_start_samplenum, const int64_t sample_count)
650 const int64_t unit_size = segment_->unit_size();
651 const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
653 for (int64_t i = abs_start_samplenum;
654 !decode_interrupt_ && (i < (abs_start_samplenum + sample_count));
655 i += chunk_sample_count) {
657 const int64_t chunk_end = min(i + chunk_sample_count,
658 abs_start_samplenum + sample_count);
660 const uint8_t* chunk = segment_->get_samples(i, chunk_end);
662 if (srd_session_send(srd_session_, i, chunk_end, chunk,
663 (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
664 error_message_ = tr("Decoder reported an error");
672 lock_guard<mutex> lock(output_mutex_);
673 samples_decoded_ = chunk_end;
678 void DecodeSignal::decode_proc()
680 query_input_metadata();
682 if (decode_interrupt_)
687 uint64_t sample_count;
688 uint64_t abs_start_samplenum = 0;
690 // Keep processing new samples until we exhaust the input data
692 // Prevent any other decode threads from accessing libsigrokdecode
693 lock_guard<mutex> srd_lock(global_srd_mutex_);
696 lock_guard<mutex> input_lock(input_mutex_);
697 sample_count = segment_->get_sample_count() - abs_start_samplenum;
700 if (sample_count > 0) {
701 decode_data(abs_start_samplenum, sample_count);
702 abs_start_samplenum += sample_count;
704 } while (error_message_.isEmpty() && (sample_count > 0));
706 if (error_message_.isEmpty()) {
707 // Make sure all annotations are known to the frontend
710 // Wait for new input data or an interrupt was requested
711 unique_lock<mutex> input_wait_lock(input_mutex_);
712 decode_input_cond_.wait(input_wait_lock);
714 } while (error_message_.isEmpty() && !decode_interrupt_);
717 void DecodeSignal::start_srd_session()
722 // Create the session
723 srd_session_new(&srd_session_);
724 assert(srd_session_);
726 // Create the decoders
727 srd_decoder_inst *prev_di = nullptr;
728 for (const shared_ptr<decode::Decoder> &dec : stack_) {
729 srd_decoder_inst *const di = dec->create_decoder_inst(srd_session_);
732 error_message_ = tr("Failed to create decoder instance");
733 srd_session_destroy(srd_session_);
738 srd_inst_stack(srd_session_, prev_di, di);
744 srd_session_metadata_set(srd_session_, SRD_CONF_SAMPLERATE,
745 g_variant_new_uint64(samplerate_));
747 srd_pd_output_callback_add(srd_session_, SRD_OUTPUT_ANN,
748 DecodeSignal::annotation_callback, this);
750 srd_session_start(srd_session_);
753 void DecodeSignal::stop_srd_session()
756 // Destroy the session
757 srd_session_destroy(srd_session_);
758 srd_session_ = nullptr;
762 void DecodeSignal::connect_input_notifiers()
764 // Disconnect the notification slot from the previous set of signals
765 disconnect(this, SLOT(on_data_received()));
767 // Connect the currently used signals to our slot
768 for (data::DecodeChannel &ch : channels_) {
769 if (!ch.assigned_signal)
772 shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
773 connect(logic_data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
774 this, SLOT(on_data_received()));
778 void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
783 DecodeSignal *const ds = (DecodeSignal*)decode_signal;
786 lock_guard<mutex> lock(ds->output_mutex_);
788 const decode::Annotation a(pdata);
792 assert(pdata->pdo->di);
793 const srd_decoder *const decc = pdata->pdo->di->decoder;
796 auto row_iter = ds->rows_.end();
798 // Try looking up the sub-row of this class
799 const auto r = ds->class_rows_.find(make_pair(decc, a.format()));
800 if (r != ds->class_rows_.end())
801 row_iter = ds->rows_.find((*r).second);
803 // Failing that, use the decoder as a key
804 row_iter = ds->rows_.find(Row(decc));
807 assert(row_iter != ds->rows_.end());
808 if (row_iter == ds->rows_.end()) {
809 qDebug() << "Unexpected annotation: decoder = " << decc <<
810 ", format = " << a.format();
815 // Add the annotation
816 (*row_iter).second.push_annotation(a);
818 // Notify the frontend every DecodeNotifyPeriod annotations
819 if (ds->inc_annotation_count() % DecodeNotifyPeriod == 0)
820 ds->new_annotations();
823 void DecodeSignal::on_capture_state_changed(int state)
825 // If a new acquisition was started, we need to start decoding from scratch
826 if (state == Session::Running)
830 void DecodeSignal::on_data_received()
832 logic_mux_cond_.notify_one();