X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fdata%2Fdecodesignal.cpp;h=cfc98cd55bb2cfc48706d9400a4d01df5d7c2631;hp=253e3a987c6dbeb59e1f6344deff7d76c5aa4692;hb=27a3f09baf61c7f9b8c07630d34df75ddfdd476b;hpb=ecd07c20d34ce940163ac2e7fb26cb7ceac565bb diff --git a/pv/data/decodesignal.cpp b/pv/data/decodesignal.cpp index 253e3a98..cfc98cd5 100644 --- a/pv/data/decodesignal.cpp +++ b/pv/data/decodesignal.cpp @@ -17,6 +17,10 @@ * along with this program; if not, see . */ +#include + +#include + #include "logic.hpp" #include "logicsegment.hpp" #include "decodesignal.hpp" @@ -25,67 +29,109 @@ #include #include #include -#include #include +using std::lock_guard; +using std::make_pair; using std::make_shared; +using std::min; using std::shared_ptr; +using std::unique_lock; +using pv::data::decode::Annotation; using pv::data::decode::Decoder; using pv::data::decode::Row; namespace pv { namespace data { -DecodeSignal::DecodeSignal(shared_ptr decoder_stack) : +const double DecodeSignal::DecodeMargin = 1.0; +const double DecodeSignal::DecodeThreshold = 0.2; +const int64_t DecodeSignal::DecodeChunkLength = 10 * 1024 * 1024; +const unsigned int DecodeSignal::DecodeNotifyPeriod = 1024; + +mutex DecodeSignal::global_srd_mutex_; + + +DecodeSignal::DecodeSignal(pv::Session &session) : SignalBase(nullptr, SignalBase::DecodeChannel), - decoder_stack_(decoder_stack) + session_(session), + logic_mux_data_invalid_(false), + start_time_(0), + samplerate_(0), + annotation_count_(0), + samples_decoded_(0), + frame_complete_(false) { - set_name(QString::fromUtf8(decoder_stack_->stack().front()->decoder()->name)); + connect(&session_, SIGNAL(capture_state_changed(int)), + this, SLOT(on_capture_state_changed(int))); + connect(&session_, SIGNAL(data_received()), + this, SLOT(on_data_received())); + connect(&session_, SIGNAL(frame_ended()), + this, SLOT(on_frame_ended())); - connect(decoder_stack_.get(), SIGNAL(new_annotations()), - this, SLOT(on_new_annotations())); + set_name(tr("Empty decoder signal")); } DecodeSignal::~DecodeSignal() { -} - -bool DecodeSignal::is_decode_signal() const -{ - return true; -} + if (decode_thread_.joinable()) { + decode_interrupt_ = true; + decode_input_cond_.notify_one(); + decode_thread_.join(); + } -shared_ptr DecodeSignal::decoder_stack() const -{ - return decoder_stack_; + if (logic_mux_thread_.joinable()) { + logic_mux_interrupt_ = true; + logic_mux_cond_.notify_one(); + logic_mux_thread_.join(); + } } -const list< shared_ptr >& DecodeSignal::decoder_stack_list() const +const vector< shared_ptr >& DecodeSignal::decoder_stack() const { - return decoder_stack_->stack(); + return stack_; } void DecodeSignal::stack_decoder(srd_decoder *decoder) { assert(decoder); - assert(decoder_stack); - decoder_stack_->push(make_shared(decoder)); - decoder_stack_->begin_decode(); + stack_.push_back(make_shared(decoder)); + + // Set name if this decoder is the first in the list + if (stack_.size() == 1) + set_name(QString::fromUtf8(decoder->name)); + + // Include the newly created decode channels in the channel lists + update_channel_list(); + + auto_assign_signals(); + commit_decoder_channels(); + begin_decode(); } void DecodeSignal::remove_decoder(int index) { - decoder_stack_->remove(index); - decoder_stack_->begin_decode(); + assert(index >= 0); + assert(index < (int)stack_.size()); + + // Find the decoder in the stack + auto iter = stack_.begin(); + for (int i = 0; i < index; i++, iter++) + assert(iter != stack_.end()); + + // Delete the element + stack_.erase(iter); + + // Update channels and decoded data + update_channel_list(); + begin_decode(); } bool DecodeSignal::toggle_decoder_visibility(int index) { - const list< shared_ptr > stack(decoder_stack_->stack()); - - auto iter = stack.cbegin(); + auto iter = stack_.cbegin(); for (int i = 0; i < index; i++, iter++) - assert(iter != stack.end()); + assert(iter != stack_.end()); shared_ptr dec = *iter; @@ -99,14 +145,251 @@ bool DecodeSignal::toggle_decoder_visibility(int index) return state; } +void DecodeSignal::reset_decode() +{ + annotation_count_ = 0; + frame_complete_ = false; + samples_decoded_ = 0; + error_message_ = QString(); + rows_.clear(); + class_rows_.clear(); +} + +void DecodeSignal::begin_decode() +{ + if (decode_thread_.joinable()) { + decode_interrupt_ = true; + decode_input_cond_.notify_one(); + decode_thread_.join(); + } + + if (logic_mux_thread_.joinable()) { + logic_mux_interrupt_ = true; + logic_mux_cond_.notify_one(); + logic_mux_thread_.join(); + } + + reset_decode(); + + if (stack_.size() == 0) { + error_message_ = tr("No decoders"); + return; + } + + assert(channels_.size() > 0); + + if (get_assigned_signal_count() == 0) { + error_message_ = tr("There are no channels assigned to this decoder"); + return; + } + + // Check that all decoders have the required channels + for (const shared_ptr &dec : stack_) + if (!dec->have_required_channels()) { + error_message_ = tr("One or more required channels " + "have not been specified"); + return; + } + + // Add annotation classes + for (const shared_ptr &dec : stack_) { + assert(dec); + const srd_decoder *const decc = dec->decoder(); + assert(dec->decoder()); + + // Add a row for the decoder if it doesn't have a row list + if (!decc->annotation_rows) + rows_[Row(decc)] = decode::RowData(); + + // Add the decoder rows + for (const GSList *l = decc->annotation_rows; l; l = l->next) { + const srd_decoder_annotation_row *const ann_row = + (srd_decoder_annotation_row *)l->data; + assert(ann_row); + + const Row row(decc, ann_row); + + // Add a new empty row data object + rows_[row] = decode::RowData(); + + // Map out all the classes + for (const GSList *ll = ann_row->ann_classes; + ll; ll = ll->next) + class_rows_[make_pair(decc, + GPOINTER_TO_INT(ll->data))] = row; + } + } + + // TODO Currently we assume all channels have the same sample rate + auto any_channel = find_if(channels_.begin(), channels_.end(), + [](data::DecodeChannel ch) { return ch.assigned_signal; }); + shared_ptr first_segment = + any_channel->assigned_signal->logic_data()->logic_segments().front(); + samplerate_ = first_segment->samplerate(); + + // Free the logic data and its segment(s) if it needs to be updated + if (logic_mux_data_invalid_) + logic_mux_data_.reset(); + + if (!logic_mux_data_) { + const int64_t ch_count = get_assigned_signal_count(); + const int64_t unit_size = (ch_count + 7) / 8; + logic_mux_data_ = make_shared(ch_count); + segment_ = make_shared(*logic_mux_data_, unit_size, samplerate_); + logic_mux_data_->push_segment(segment_); + } + + // Update the samplerate and start time + start_time_ = segment_->start_time(); + samplerate_ = segment_->samplerate(); + if (samplerate_ == 0.0) + samplerate_ = 1.0; + + // Make sure the logic output data is complete and up-to-date + logic_mux_interrupt_ = false; + logic_mux_thread_ = std::thread(&DecodeSignal::logic_mux_proc, this); + + // Decode the muxed logic data + decode_interrupt_ = false; + decode_thread_ = std::thread(&DecodeSignal::decode_proc, this); +} + QString DecodeSignal::error_message() const { - return decoder_stack_->error_message(); + lock_guard lock(output_mutex_); + return error_message_; +} + +const vector DecodeSignal::get_channels() const +{ + return channels_; +} + +void DecodeSignal::auto_assign_signals() +{ + bool new_assignment = false; + + // Try to auto-select channels that don't have signals assigned yet + for (data::DecodeChannel &ch : channels_) { + if (ch.assigned_signal) + continue; + + for (shared_ptr s : session_.signalbases()) + if (s->logic_data() && (ch.name.toLower().contains(s->name().toLower()))) { + ch.assigned_signal = s.get(); + new_assignment = true; + } + } + + if (new_assignment) { + logic_mux_data_invalid_ = true; + commit_decoder_channels(); + channels_updated(); + } +} + +void DecodeSignal::assign_signal(const uint16_t channel_id, const SignalBase *signal) +{ + for (data::DecodeChannel &ch : channels_) + if (ch.id == channel_id) { + ch.assigned_signal = signal; + logic_mux_data_invalid_ = true; + } + + commit_decoder_channels(); + channels_updated(); + begin_decode(); +} + +int DecodeSignal::get_assigned_signal_count() const +{ + // Count all channels that have a signal assigned to them + return count_if(channels_.begin(), channels_.end(), + [](data::DecodeChannel ch) { return ch.assigned_signal; }); +} + +void DecodeSignal::set_initial_pin_state(const uint16_t channel_id, const int init_state) +{ + for (data::DecodeChannel &ch : channels_) + if (ch.id == channel_id) + ch.initial_pin_state = init_state; + + channels_updated(); + + begin_decode(); +} + +double DecodeSignal::samplerate() const +{ + return samplerate_; +} + +const pv::util::Timestamp& DecodeSignal::start_time() const +{ + return start_time_; +} + +int64_t DecodeSignal::get_working_sample_count() const +{ + // The working sample count is the highest sample number for + // which all used signals have data available, so go through + // all channels and use the lowest overall sample count of the + // current segment + + // TODO Currently, we assume only a single segment exists + + int64_t count = std::numeric_limits::max(); + bool no_signals_assigned = true; + + for (const data::DecodeChannel &ch : channels_) + if (ch.assigned_signal) { + no_signals_assigned = false; + + const shared_ptr logic_data = ch.assigned_signal->logic_data(); + if (!logic_data || logic_data->logic_segments().empty()) + return 0; + + const shared_ptr segment = logic_data->logic_segments().front(); + count = min(count, (int64_t)segment->get_sample_count()); + } + + return (no_signals_assigned ? 0 : count); +} + +int64_t DecodeSignal::get_decoded_sample_count() const +{ + lock_guard decode_lock(output_mutex_); + return samples_decoded_; } vector DecodeSignal::visible_rows() const { - return decoder_stack_->get_visible_rows(); + lock_guard lock(output_mutex_); + + vector rows; + + for (const shared_ptr &dec : stack_) { + assert(dec); + if (!dec->shown()) + continue; + + const srd_decoder *const decc = dec->decoder(); + assert(dec->decoder()); + + // Add a row for the decoder if it doesn't have a row list + if (!decc->annotation_rows) + rows.emplace_back(decc); + + // Add the decoder rows + for (const GSList *l = decc->annotation_rows; l; l = l->next) { + const srd_decoder_annotation_row *const ann_row = + (srd_decoder_annotation_row *)l->data; + assert(ann_row); + rows.emplace_back(decc, ann_row); + } + } + + return rows; } void DecodeSignal::get_annotation_subset( @@ -114,14 +397,394 @@ void DecodeSignal::get_annotation_subset( const decode::Row &row, uint64_t start_sample, uint64_t end_sample) const { - return decoder_stack_->get_annotation_subset(dest, row, - start_sample, end_sample); + lock_guard lock(output_mutex_); + + const auto iter = rows_.find(row); + if (iter != rows_.end()) + (*iter).second.get_annotation_subset(dest, + start_sample, end_sample); } -void DecodeSignal::on_new_annotations() +void DecodeSignal::save_settings(QSettings &settings) const { - // Forward the signal to the frontend + SignalBase::save_settings(settings); + + // TODO Save decoder stack, channel mapping and decoder options +} + +void DecodeSignal::restore_settings(QSettings &settings) +{ + SignalBase::restore_settings(settings); + + // TODO Restore decoder stack, channel mapping and decoder options +} + +uint64_t DecodeSignal::inc_annotation_count() +{ + return (annotation_count_++); +} + +void DecodeSignal::update_channel_list() +{ + vector prev_channels = channels_; + channels_.clear(); + + uint16_t id = 0; + + // Copy existing entries, create new as needed + for (shared_ptr decoder : stack_) { + const srd_decoder* srd_d = decoder->decoder(); + const GSList *l; + + // Mandatory channels + for (l = srd_d->channels; l; l = l->next) { + const struct srd_channel *const pdch = (struct srd_channel *)l->data; + bool ch_added = false; + + // Copy but update ID if this channel was in the list before + for (data::DecodeChannel &ch : prev_channels) + if (ch.pdch_ == pdch) { + ch.id = id++; + channels_.push_back(ch); + ch_added = true; + break; + } + + if (!ch_added) { + // Create new entry without a mapped signal + data::DecodeChannel ch = {id++, false, nullptr, + QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc), + SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch}; + channels_.push_back(ch); + } + } + + // Optional channels + for (l = srd_d->opt_channels; l; l = l->next) { + const struct srd_channel *const pdch = (struct srd_channel *)l->data; + bool ch_added = false; + + // Copy but update ID if this channel was in the list before + for (data::DecodeChannel &ch : prev_channels) + if (ch.pdch_ == pdch) { + ch.id = id++; + channels_.push_back(ch); + ch_added = true; + break; + } + + if (!ch_added) { + // Create new entry without a mapped signal + data::DecodeChannel ch = {id++, true, nullptr, + QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc), + SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch}; + channels_.push_back(ch); + } + } + } + + // Invalidate the logic output data if the channel assignment changed + if (prev_channels.size() != channels_.size()) { + // The number of channels changed, there's definitely a difference + logic_mux_data_invalid_ = true; + } else { + // Same number but assignment may still differ, so compare all channels + for (size_t i = 0; i < channels_.size(); i++) { + const data::DecodeChannel &p_ch = prev_channels[i]; + const data::DecodeChannel &ch = channels_[i]; + + if ((p_ch.pdch_ != ch.pdch_) || + (p_ch.assigned_signal != ch.assigned_signal)) { + logic_mux_data_invalid_ = true; + break; + } + } + + } + + channels_updated(); +} + +void DecodeSignal::commit_decoder_channels() +{ + // Submit channel list to every decoder, containing only the relevant channels + for (shared_ptr dec : stack_) { + vector channel_list; + + for (data::DecodeChannel &ch : channels_) + if (ch.decoder_ == dec) + channel_list.push_back(&ch); + + dec->set_channels(channel_list); + } +} + +void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end) +{ + // Enforce end to be greater than start + if (end <= start) + return; + + // Fetch all segments and their data + // TODO Currently, we assume only a single segment exists + vector > segments; + vector signal_data; + vector signal_in_bytepos; + vector signal_in_bitpos; + + for (data::DecodeChannel &ch : channels_) + if (ch.assigned_signal) { + const shared_ptr logic_data = ch.assigned_signal->logic_data(); + const shared_ptr segment = logic_data->logic_segments().front(); + segments.push_back(segment); + signal_data.push_back(segment->get_samples(start, end)); + + const int bitpos = ch.assigned_signal->logic_bit_index(); + signal_in_bytepos.push_back(bitpos / 8); + signal_in_bitpos.push_back(bitpos % 8); + } + + // Perform the muxing of signal data into the output data + uint8_t* output = new uint8_t[(end - start) * segment_->unit_size()]; + unsigned int signal_count = signal_data.size(); + + for (int64_t sample_cnt = 0; sample_cnt < (end - start); sample_cnt++) { + int bitpos = 0; + uint8_t bytepos = 0; + + const int out_sample_pos = sample_cnt * segment_->unit_size(); + for (unsigned int i = 0; i < segment_->unit_size(); i++) + output[out_sample_pos + i] = 0; + + for (unsigned int i = 0; i < signal_count; i++) { + const int in_sample_pos = sample_cnt * segments[i]->unit_size(); + const uint8_t in_sample = 1 & + ((signal_data[i][in_sample_pos + signal_in_bytepos[i]]) >> (signal_in_bitpos[i])); + + const uint8_t out_sample = output[out_sample_pos + bytepos]; + + output[out_sample_pos + bytepos] = out_sample | (in_sample << bitpos); + + bitpos++; + if (bitpos > 7) { + bitpos = 0; + bytepos++; + } + } + } + + segment_->append_payload(output, (end - start) * segment_->unit_size()); + delete[] output; + + for (const uint8_t* data : signal_data) + delete[] data; +} + +void DecodeSignal::logic_mux_proc() +{ + do { + + const uint64_t input_sample_count = get_working_sample_count(); + const uint64_t output_sample_count = segment_->get_sample_count(); + + const uint64_t samples_to_process = + (input_sample_count > output_sample_count) ? + (input_sample_count - output_sample_count) : 0; + + // Process the samples if necessary... + if (samples_to_process > 0) { + const uint64_t unit_size = segment_->unit_size(); + const uint64_t chunk_sample_count = DecodeChunkLength / unit_size; + + uint64_t processed_samples = 0; + do { + const uint64_t start_sample = output_sample_count + processed_samples; + const uint64_t sample_count = + min(samples_to_process - processed_samples, chunk_sample_count); + + mux_logic_samples(start_sample, start_sample + sample_count); + processed_samples += sample_count; + + // ...and process the newly muxed logic data + decode_input_cond_.notify_one(); + } while (processed_samples < samples_to_process); + } + + if (session_.get_capture_state() != Session::Stopped) { + // Wait for more input + unique_lock logic_mux_lock(logic_mux_mutex_); + logic_mux_cond_.wait(logic_mux_lock); + } + } while ((session_.get_capture_state() != Session::Stopped) && !logic_mux_interrupt_); + + // No more input data and session is stopped, let the decode thread + // process any pending data, terminate and release the global SRD mutex + // in order to let other decoders run + decode_input_cond_.notify_one(); +} + +void DecodeSignal::decode_data( + const int64_t abs_start_samplenum, const int64_t sample_count, + srd_session *const session) +{ + const int64_t unit_size = segment_->unit_size(); + const int64_t chunk_sample_count = DecodeChunkLength / unit_size; + + for (int64_t i = abs_start_samplenum; + !decode_interrupt_ && (i < (abs_start_samplenum + sample_count)); + i += chunk_sample_count) { + + const int64_t chunk_end = min(i + chunk_sample_count, + abs_start_samplenum + sample_count); + + const uint8_t* chunk = segment_->get_samples(i, chunk_end); + + if (srd_session_send(session, i, chunk_end, chunk, + (chunk_end - i) * unit_size, unit_size) != SRD_OK) { + error_message_ = tr("Decoder reported an error"); + delete[] chunk; + break; + } + delete[] chunk; + + { + lock_guard lock(output_mutex_); + samples_decoded_ = chunk_end; + } + } +} + +void DecodeSignal::decode_proc() +{ + srd_session *session; + srd_decoder_inst *prev_di = nullptr; + + // Prevent any other decode threads from accessing libsigrokdecode + lock_guard srd_lock(global_srd_mutex_); + + // Create the session + srd_session_new(&session); + assert(session); + + // Create the decoders + for (const shared_ptr &dec : stack_) { + srd_decoder_inst *const di = dec->create_decoder_inst(session); + + if (!di) { + error_message_ = tr("Failed to create decoder instance"); + srd_session_destroy(session); + return; + } + + if (prev_di) + srd_inst_stack(session, prev_di, di); + + prev_di = di; + } + + // Start the session + srd_session_metadata_set(session, SRD_CONF_SAMPLERATE, + g_variant_new_uint64(samplerate_)); + + srd_pd_output_callback_add(session, SRD_OUTPUT_ANN, + DecodeSignal::annotation_callback, this); + + srd_session_start(session); + + uint64_t sample_count; + uint64_t abs_start_samplenum = 0; + do { + // Keep processing new samples until we exhaust the input data + do { + { + lock_guard input_lock(input_mutex_); + sample_count = segment_->get_sample_count() - abs_start_samplenum; + } + + if (sample_count > 0) { + decode_data(abs_start_samplenum, sample_count, session); + abs_start_samplenum += sample_count; + } + } while (error_message_.isEmpty() && (sample_count > 0)); + + // Terminate if we exhausted the input data + if ((int64_t)segment_->get_sample_count() == get_working_sample_count()) + break; + + if (error_message_.isEmpty()) { + // Wait for new input data or an interrupt request + unique_lock input_wait_lock(input_mutex_); + decode_input_cond_.wait(input_wait_lock); + } + } while (error_message_.isEmpty() && !decode_interrupt_); + + // Make sure all annotations are known to the frontend new_annotations(); + + // Destroy the session + srd_session_destroy(session); +} + +void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal) +{ + assert(pdata); + assert(decoder); + + DecodeSignal *const ds = (DecodeSignal*)decode_signal; + assert(ds); + + lock_guard lock(ds->output_mutex_); + + const decode::Annotation a(pdata); + + // Find the row + assert(pdata->pdo); + assert(pdata->pdo->di); + const srd_decoder *const decc = pdata->pdo->di->decoder; + assert(decc); + + auto row_iter = ds->rows_.end(); + + // Try looking up the sub-row of this class + const auto r = ds->class_rows_.find(make_pair(decc, a.format())); + if (r != ds->class_rows_.end()) + row_iter = ds->rows_.find((*r).second); + else { + // Failing that, use the decoder as a key + row_iter = ds->rows_.find(Row(decc)); + } + + assert(row_iter != ds->rows_.end()); + if (row_iter == ds->rows_.end()) { + qDebug() << "Unexpected annotation: decoder = " << decc << + ", format = " << a.format(); + assert(false); + return; + } + + // Add the annotation + (*row_iter).second.push_annotation(a); + + // Notify the frontend every DecodeNotifyPeriod annotations + if (ds->inc_annotation_count() % DecodeNotifyPeriod == 0) + ds->new_annotations(); +} + +void DecodeSignal::on_capture_state_changed(int state) +{ + // If a new acquisition was started, we need to start decoding from scratch + if (state == Session::Running) + begin_decode(); +} + +void DecodeSignal::on_data_received() +{ + logic_mux_cond_.notify_one(); +} + +void DecodeSignal::on_frame_ended() +{ + logic_mux_cond_.notify_one(); } } // namespace data