#include <pv/binding/decoder.hpp>
#include <pv/data/decode/decoder.hpp>
#include <pv/data/decode/row.hpp>
+#include <pv/globalsettings.hpp>
#include <pv/session.hpp>
using std::lock_guard;
using std::make_pair;
using std::make_shared;
using std::min;
+using std::out_of_range;
using std::shared_ptr;
using std::unique_lock;
using pv::data::decode::Annotation;
const double DecodeSignal::DecodeThreshold = 0.2;
const int64_t DecodeSignal::DecodeChunkLength = 256 * 1024;
-mutex DecodeSignal::global_srd_mutex_;
-
DecodeSignal::DecodeSignal(pv::Session &session) :
SignalBase(nullptr, SignalBase::DecodeChannel),
{
connect(&session_, SIGNAL(capture_state_changed(int)),
this, SLOT(on_capture_state_changed(int)));
-
- set_name(tr("Empty decoder signal"));
}
DecodeSignal::~DecodeSignal()
{
- 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();
- }
-
- stop_srd_session();
+ reset_decode();
}
const vector< shared_ptr<Decoder> >& DecodeSignal::decoder_stack() const
return stack_;
}
-void DecodeSignal::stack_decoder(srd_decoder *decoder)
+void DecodeSignal::stack_decoder(const srd_decoder *decoder)
{
assert(decoder);
- stack_.push_back(make_shared<decode::Decoder>(decoder));
+ const shared_ptr<Decoder> dec = make_shared<decode::Decoder>(decoder);
+
+ stack_.push_back(dec);
// Set name if this decoder is the first in the list
if (stack_.size() == 1)
// Include the newly created decode channels in the channel lists
update_channel_list();
- auto_assign_signals();
+ auto_assign_signals(dec);
commit_decoder_channels();
begin_decode();
}
void DecodeSignal::reset_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();
+ }
+
stop_srd_session();
frame_complete_ = false;
samples_decoded_ = 0;
+ currently_processed_segment_ = 0;
error_message_ = QString();
- rows_.clear();
+
+ segmented_rows_.clear();
+ current_rows_= nullptr;
class_rows_.clear();
+
+ logic_mux_data_.reset();
+ logic_mux_data_invalid_ = true;
+
+ decode_reset();
}
void DecodeSignal::begin_decode()
return;
}
- // Add annotation classes
+ // Map out all the annotation classes
for (const shared_ptr<decode::Decoder> &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;
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,
}
}
+ create_new_annotation_segment();
+
+ // TODO Allow logic_mux_data and logic_mux_segment to work with multiple segments
+
// Free the logic data and its segment(s) if it needs to be updated
if (logic_mux_data_invalid_)
logic_mux_data_.reset();
const int64_t ch_count = get_assigned_signal_count();
const int64_t unit_size = (ch_count + 7) / 8;
logic_mux_data_ = make_shared<Logic>(ch_count);
- segment_ = make_shared<LogicSegment>(*logic_mux_data_, unit_size, samplerate_);
- logic_mux_data_->push_segment(segment_);
+ logic_mux_segment_ = make_shared<LogicSegment>(*logic_mux_data_, unit_size, samplerate_);
+ logic_mux_data_->push_segment(logic_mux_segment_);
}
// Make sure the logic output data is complete and up-to-date
return channels_;
}
-void DecodeSignal::auto_assign_signals()
+void DecodeSignal::auto_assign_signals(const shared_ptr<Decoder> dec)
{
bool new_assignment = false;
// Try to auto-select channels that don't have signals assigned yet
for (data::DecodeChannel &ch : channels_) {
+ // If a decoder is given, auto-assign only its channels
+ if (dec && (ch.decoder_ != dec))
+ continue;
+
if (ch.assigned_signal)
continue;
return start_time_;
}
-int64_t DecodeSignal::get_working_sample_count() const
+int64_t DecodeSignal::get_working_sample_count(uint32_t segment_id) 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<int64_t>::max();
bool no_signals_assigned = true;
if (!logic_data || logic_data->logic_segments().empty())
return 0;
- const shared_ptr<LogicSegment> segment = logic_data->logic_segments().front();
- count = min(count, (int64_t)segment->get_sample_count());
+ try {
+ const shared_ptr<LogicSegment> segment = logic_data->logic_segments().at(segment_id);
+ count = min(count, (int64_t)segment->get_sample_count());
+ } catch (out_of_range) {
+ return 0;
+ }
}
return (no_signals_assigned ? 0 : count);
}
-int64_t DecodeSignal::get_decoded_sample_count() const
+int64_t DecodeSignal::get_decoded_sample_count(uint32_t segment_id) const
{
lock_guard<mutex> decode_lock(output_mutex_);
- return samples_decoded_;
+
+ int64_t result = 0;
+
+ if (segment_id == currently_processed_segment_)
+ result = samples_decoded_;
+ else
+ if (segment_id < currently_processed_segment_)
+ // Segment was already decoded fully
+ result = get_working_sample_count(segment_id);
+ else
+ // Segment wasn't decoded at all yet
+ result = 0;
+
+ return result;
}
vector<Row> DecodeSignal::visible_rows() const
{
lock_guard<mutex> lock(output_mutex_);
- const auto iter = rows_.find(row);
- if (iter != rows_.end())
+ if (!current_rows_)
+ return;
+
+ // TODO Instead of current_rows_, use segmented_rows_ and the ID of the segment
+
+ const auto iter = current_rows_->find(row);
+ if (iter != current_rows_->end())
(*iter).second.get_annotation_subset(dest,
start_sample, end_sample);
}
{
SignalBase::save_settings(settings);
- // TODO Save decoder stack, channel mapping and decoder options
+ settings.setValue("decoders", (int)(stack_.size()));
+
+ // Save decoder stack
+ int decoder_idx = 0;
+ for (shared_ptr<decode::Decoder> decoder : stack_) {
+ settings.beginGroup("decoder" + QString::number(decoder_idx++));
+
+ settings.setValue("id", decoder->decoder()->id);
+
+ // Save decoder options
+ const map<string, GVariant*>& options = decoder->options();
+
+ settings.setValue("options", (int)options.size());
+
+ // Note: decode::Decoder::options() returns only the options
+ // that differ from the default. See binding::Decoder::getter()
+ int i = 0;
+ for (auto option : options) {
+ settings.beginGroup("option" + QString::number(i));
+ settings.setValue("name", QString::fromStdString(option.first));
+ GlobalSettings::store_gvariant(settings, option.second);
+ settings.endGroup();
+ i++;
+ }
+
+ settings.endGroup();
+ }
+
+ // Save channel mapping
+ settings.setValue("channels", (int)channels_.size());
+
+ for (unsigned int channel_id = 0; channel_id < channels_.size(); channel_id++) {
+ auto channel = find_if(channels_.begin(), channels_.end(),
+ [&](data::DecodeChannel ch) { return ch.id == channel_id; });
+
+ if (channel == channels_.end()) {
+ qDebug() << "ERROR: Gap in channel index:" << channel_id;
+ continue;
+ }
+
+ settings.beginGroup("channel" + QString::number(channel_id));
+
+ settings.setValue("name", channel->name); // Useful for debugging
+ settings.setValue("initial_pin_state", channel->initial_pin_state);
+
+ if (channel->assigned_signal)
+ settings.setValue("assigned_signal_name", channel->assigned_signal->name());
+
+ settings.endGroup();
+ }
}
void DecodeSignal::restore_settings(QSettings &settings)
{
SignalBase::restore_settings(settings);
- // TODO Restore decoder stack, channel mapping and decoder options
+ // Restore decoder stack
+ GSList *dec_list = g_slist_copy((GSList*)srd_decoder_list());
+
+ int decoders = settings.value("decoders").toInt();
+
+ for (int decoder_idx = 0; decoder_idx < decoders; decoder_idx++) {
+ settings.beginGroup("decoder" + QString::number(decoder_idx));
+
+ QString id = settings.value("id").toString();
+
+ for (GSList *entry = dec_list; entry; entry = entry->next) {
+ const srd_decoder *dec = (srd_decoder*)entry->data;
+ if (!dec)
+ continue;
+
+ if (QString::fromUtf8(dec->id) == id) {
+ shared_ptr<decode::Decoder> decoder =
+ make_shared<decode::Decoder>(dec);
+
+ stack_.push_back(decoder);
+
+ // Restore decoder options that differ from their default
+ int options = settings.value("options").toInt();
+
+ for (int i = 0; i < options; i++) {
+ settings.beginGroup("option" + QString::number(i));
+ QString name = settings.value("name").toString();
+ GVariant *value = GlobalSettings::restore_gvariant(settings);
+ decoder->set_option(name.toUtf8(), value);
+ settings.endGroup();
+ }
+
+ // Include the newly created decode channels in the channel lists
+ update_channel_list();
+ break;
+ }
+ }
+
+ settings.endGroup();
+ channels_updated();
+ }
+
+ // Restore channel mapping
+ unsigned int channels = settings.value("channels").toInt();
+
+ const unordered_set< shared_ptr<data::SignalBase> > signalbases =
+ session_.signalbases();
+
+ for (unsigned int channel_id = 0; channel_id < channels; channel_id++) {
+ auto channel = find_if(channels_.begin(), channels_.end(),
+ [&](data::DecodeChannel ch) { return ch.id == channel_id; });
+
+ if (channel == channels_.end()) {
+ qDebug() << "ERROR: Non-existant channel index:" << channel_id;
+ continue;
+ }
+
+ settings.beginGroup("channel" + QString::number(channel_id));
+
+ QString assigned_signal_name = settings.value("assigned_signal_name").toString();
+
+ for (shared_ptr<data::SignalBase> signal : signalbases)
+ if (signal->name() == assigned_signal_name)
+ channel->assigned_signal = signal.get();
+
+ channel->initial_pin_state = settings.value("initial_pin_state").toInt();
+
+ settings.endGroup();
+ }
+
+ // Update the internal structures
+ update_channel_list();
+ commit_decoder_channels();
+
+ begin_decode();
}
void DecodeSignal::update_channel_list()
if (!ch_added) {
// Create new entry without a mapped signal
- data::DecodeChannel ch = {id++, false, nullptr,
+ data::DecodeChannel ch = {id++, 0, false, nullptr,
QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
channels_.push_back(ch);
if (!ch_added) {
// Create new entry without a mapped signal
- data::DecodeChannel ch = {id++, true, nullptr,
+ data::DecodeChannel ch = {id++, 0, true, nullptr,
QString::fromUtf8(pdch->name), QString::fromUtf8(pdch->desc),
SRD_INITIAL_PIN_SAME_AS_SAMPLE0, decoder, pdch};
channels_.push_back(ch);
dec->set_channels(channel_list);
}
+
+ // Channel bit IDs must be in sync with the channel's apperance in channels_
+ int id = 0;
+ for (data::DecodeChannel &ch : channels_)
+ if (ch.assigned_signal)
+ ch.bit_id = id++;
}
void DecodeSignal::mux_logic_samples(const int64_t start, const int64_t end)
const shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
const shared_ptr<LogicSegment> segment = logic_data->logic_segments().front();
segments.push_back(segment);
- signal_data.push_back(segment->get_samples(start, end));
+
+ uint8_t* data = new uint8_t[(end - start) * segment->unit_size()];
+ segment->get_samples(start, end, data);
+ signal_data.push_back(data);
const int bitpos = ch.assigned_signal->logic_bit_index();
signal_in_bytepos.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()];
+ uint8_t* output = new uint8_t[(end - start) * logic_mux_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++)
+ const int out_sample_pos = sample_cnt * logic_mux_segment_->unit_size();
+ for (unsigned int i = 0; i < logic_mux_segment_->unit_size(); i++)
output[out_sample_pos + i] = 0;
for (unsigned int i = 0; i < signal_count; i++) {
}
}
- segment_->append_payload(output, (end - start) * segment_->unit_size());
+ logic_mux_segment_->append_payload(output, (end - start) * logic_mux_segment_->unit_size());
delete[] output;
for (const uint8_t* data : signal_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 input_sample_count = get_working_sample_count(currently_processed_segment_);
+ const uint64_t output_sample_count = logic_mux_segment_->get_sample_count();
const uint64_t samples_to_process =
(input_sample_count > output_sample_count) ?
// Process the samples if necessary...
if (samples_to_process > 0) {
- const uint64_t unit_size = segment_->unit_size();
+ const uint64_t unit_size = logic_mux_segment_->unit_size();
const uint64_t chunk_sample_count = DecodeChunkLength / unit_size;
uint64_t processed_samples = 0;
}
if (samples_to_process == 0) {
+ logic_mux_data_invalid_ = false;
+
// Wait for more input
unique_lock<mutex> logic_mux_lock(logic_mux_mutex_);
logic_mux_cond_.wait(logic_mux_lock);
}
} while (!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::query_input_metadata()
// TODO Currently we assume all channels have the same sample rate
// and start time
bool samplerate_valid = false;
+ data::DecodeChannel *any_channel;
+ shared_ptr<Logic> logic_data;
- auto any_channel = find_if(channels_.begin(), channels_.end(),
- [](data::DecodeChannel ch) { return ch.assigned_signal; });
+ do {
+ any_channel = &(*find_if(channels_.begin(), channels_.end(),
+ [](data::DecodeChannel ch) { return ch.assigned_signal; }));
- shared_ptr<Logic> logic_data =
- any_channel->assigned_signal->logic_data();
+ logic_data = any_channel->assigned_signal->logic_data();
+
+ if (!logic_data) {
+ // Wait until input data is available or an interrupt was requested
+ unique_lock<mutex> input_wait_lock(input_mutex_);
+ decode_input_cond_.wait(input_wait_lock);
+ }
+ } while (!logic_data && !decode_interrupt_);
+
+ if (decode_interrupt_)
+ return;
do {
if (!logic_data->logic_segments().empty()) {
void DecodeSignal::decode_data(
const int64_t abs_start_samplenum, const int64_t sample_count)
{
- const int64_t unit_size = segment_->unit_size();
+ const int64_t unit_size = logic_mux_segment_->unit_size();
const int64_t chunk_sample_count = DecodeChunkLength / unit_size;
for (int64_t i = abs_start_samplenum;
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);
+ int64_t data_size = (chunk_end - i) * unit_size;
+ uint8_t* chunk = new uint8_t[data_size];
+ logic_mux_segment_->get_samples(i, chunk_end, chunk);
if (srd_session_send(srd_session_, i, chunk_end, chunk,
- (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
+ data_size, unit_size) != SRD_OK) {
error_message_ = tr("Decoder reported an error");
delete[] chunk;
break;
delete[] chunk;
- // Notify the frontend that we processed some data and
- // possibly have new annotations as well
- new_annotations();
-
{
lock_guard<mutex> lock(output_mutex_);
samples_decoded_ = chunk_end;
}
+
+ // Notify the frontend that we processed some data and
+ // possibly have new annotations as well
+ new_annotations();
}
}
do {
// Keep processing new samples until we exhaust the input data
do {
- // Prevent any other decode threads from accessing libsigrokdecode
- lock_guard<mutex> srd_lock(global_srd_mutex_);
-
- {
- lock_guard<mutex> input_lock(input_mutex_);
- sample_count = segment_->get_sample_count() - abs_start_samplenum;
- }
+ lock_guard<mutex> input_lock(input_mutex_);
+ sample_count = logic_mux_segment_->get_sample_count() - abs_start_samplenum;
if (sample_count > 0) {
decode_data(abs_start_samplenum, sample_count);
abs_start_samplenum += sample_count;
}
- } while (error_message_.isEmpty() && (sample_count > 0));
+ } while (error_message_.isEmpty() && (sample_count > 0) && !decode_interrupt_);
+
+ if (error_message_.isEmpty() && !decode_interrupt_) {
+ if (sample_count == 0)
+ decode_finished();
- if (error_message_.isEmpty()) {
// Wait for new input data or an interrupt was requested
unique_lock<mutex> input_wait_lock(input_mutex_);
decode_input_cond_.wait(input_wait_lock);
void DecodeSignal::connect_input_notifiers()
{
// Disconnect the notification slot from the previous set of signals
+ disconnect(this, SLOT(on_data_cleared()));
disconnect(this, SLOT(on_data_received()));
// Connect the currently used signals to our slot
if (!ch.assigned_signal)
continue;
- shared_ptr<Logic> logic_data = ch.assigned_signal->logic_data();
- connect(logic_data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
+ const data::SignalBase *signal = ch.assigned_signal;
+ connect(signal, SIGNAL(samples_cleared()),
+ this, SLOT(on_data_cleared()));
+ connect(signal, SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
this, SLOT(on_data_received()));
}
}
+void DecodeSignal::create_new_annotation_segment()
+{
+ segmented_rows_.emplace_back(map<const decode::Row, decode::RowData>());
+ current_rows_ = &(segmented_rows_.back());
+
+ // Add annotation classes
+ for (const shared_ptr<decode::Decoder> &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)
+ (*current_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
+ (*current_rows_)[row] = decode::RowData();
+ }
+ }
+}
+
void DecodeSignal::annotation_callback(srd_proto_data *pdata, void *decode_signal)
{
assert(pdata);
- assert(decoder);
+ assert(decode_signal);
DecodeSignal *const ds = (DecodeSignal*)decode_signal;
assert(ds);
lock_guard<mutex> 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);
+ assert(ds->current_rows_);
+
+ const srd_proto_data_annotation *const pda =
+ (const srd_proto_data_annotation*)pdata->data;
+ assert(pda);
- auto row_iter = ds->rows_.end();
+ auto row_iter = ds->current_rows_->end();
// Try looking up the sub-row of this class
- const auto r = ds->class_rows_.find(make_pair(decc, a.format()));
+ const auto format = pda->ann_class;
+ const auto r = ds->class_rows_.find(make_pair(decc, format));
if (r != ds->class_rows_.end())
- row_iter = ds->rows_.find((*r).second);
+ row_iter = ds->current_rows_->find((*r).second);
else {
// Failing that, use the decoder as a key
- row_iter = ds->rows_.find(Row(decc));
+ row_iter = ds->current_rows_->find(Row(decc));
}
- assert(row_iter != ds->rows_.end());
- if (row_iter == ds->rows_.end()) {
+ if (row_iter == ds->current_rows_->end()) {
qDebug() << "Unexpected annotation: decoder = " << decc <<
- ", format = " << a.format();
+ ", format = " << format;
assert(false);
return;
}
// Add the annotation
- (*row_iter).second.push_annotation(a);
+ (*row_iter).second.emplace_annotation(pdata);
}
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)
+ if (state == Session::Running) {
+ logic_mux_data_invalid_ = true;
begin_decode();
+ }
+}
+
+void DecodeSignal::on_data_cleared()
+{
+ reset_decode();
}
void DecodeSignal::on_data_received()
{
- logic_mux_cond_.notify_one();
+ if (!logic_mux_thread_.joinable())
+ begin_decode();
+ else
+ logic_mux_cond_.notify_one();
}
} // namespace data