Extract only the subset of annotations that are in view.

[pulseview.git] / pv / data / decoderstack.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <libsigrokdecode/libsigrokdecode.h>

#include <boost/bind.hpp>
#include <boost/foreach.hpp>
#include <boost/thread/thread.hpp>

#include <stdexcept>

#include <QDebug>

#include "decoderstack.h"

#include <pv/data/logic.h>
#include <pv/data/logicsnapshot.h>
#include <pv/data/decode/decoder.h>
#include <pv/data/decode/annotation.h>
#include <pv/view/logicsignal.h>

using boost::lock_guard;
using boost::mutex;
using boost::shared_ptr;
using std::deque;
using std::min;
using std::list;
using std::vector;

namespace pv {
namespace data {

const double DecoderStack::DecodeMargin = 1.0;
const double DecoderStack::DecodeThreshold = 0.2;
const int64_t DecoderStack::DecodeChunkLength = 4096;

mutex DecoderStack::_global_decode_mutex;

DecoderStack::DecoderStack(const srd_decoder *const dec) :
	_samples_decoded(0)
{
	_stack.push_back(shared_ptr<decode::Decoder>(
		new decode::Decoder(dec)));
}

DecoderStack::~DecoderStack()
{
	_decode_thread.interrupt();
	_decode_thread.join();
}

const std::list< boost::shared_ptr<decode::Decoder> >&
DecoderStack::stack() const
{
	return _stack;
}

void DecoderStack::push(boost::shared_ptr<decode::Decoder> decoder)
{
	assert(decoder);
	_stack.push_back(decoder);
}

void DecoderStack::remove(int index)
{
	using pv::data::decode::Decoder;

	assert(index >= 0);
	assert(index < (int)_stack.size());

	// Find the decoder in the stack
	list< shared_ptr<Decoder> >::iterator iter = _stack.begin();
	for(int i = 0; i < index; i++, iter++)
		assert(iter != _stack.end());

	// Delete the element
	_stack.erase(iter);
}

int64_t DecoderStack::samples_decoded() const
{
	lock_guard<mutex> decode_lock(_mutex);
	return _samples_decoded;
}

void DecoderStack::get_annotation_subset(
	std::vector<pv::data::decode::Annotation> &dest,
	uint64_t start_sample, uint64_t end_sample) const
{
	lock_guard<mutex> lock(_mutex);

	const vector<size_t>::const_iterator start_iter =
		lower_bound(_ann_end_index.begin(),
			_ann_end_index.end(), start_sample,
			bind(&DecoderStack::index_entry_end_sample_lt,
				this, _1, _2));

	const vector<size_t>::const_iterator end_iter =
		upper_bound(_ann_start_index.begin(),
			_ann_start_index.end(), end_sample,
			bind(&DecoderStack::index_entry_start_sample_gt,
				this, _1, _2));

	for (vector<size_t>::const_iterator i = start_iter;
		i != _ann_end_index.end() && *i != *end_iter; i++)
		dest.push_back(_annotations[*i]);
}

QString DecoderStack::error_message()
{
	lock_guard<mutex> lock(_mutex);
	return _error_message;
}

void DecoderStack::begin_decode()
{
	shared_ptr<pv::view::LogicSignal> logic_signal;
	shared_ptr<pv::data::Logic> data;

	_decode_thread.interrupt();
	_decode_thread.join();

	_samples_decoded = 0;

	clear();

	// We get the logic data of the first probe in the list.
	// This works because we are currently assuming all
	// LogicSignals have the same data/snapshot
	BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
		if (dec && !dec->probes().empty() &&
			((logic_signal = (*dec->probes().begin()).second)) &&
			((data = logic_signal->logic_data())))
			break;

	if (!data)
		return;

	// Get the samplerate and start time
	_start_time = data->get_start_time();
	_samplerate = data->samplerate();
	if (_samplerate == 0.0)
		_samplerate = 1.0;

	_decode_thread = boost::thread(&DecoderStack::decode_proc, this,
		data);
}

void DecoderStack::clear()
{
	_annotations.clear();
	_ann_start_index.clear();
	_ann_end_index.clear();
}

uint64_t DecoderStack::get_max_sample_count() const
{
	if (_annotations.empty())
		return 0;
	return _annotations.back().end_sample();
}

void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
{
	srd_session *session;
	uint8_t chunk[DecodeChunkLength];
	srd_decoder_inst *prev_di = NULL;

	assert(data);

	const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
		data->get_snapshots();
	if (snapshots.empty())
		return;

	const shared_ptr<pv::data::LogicSnapshot> &snapshot =
		snapshots.front();
	const int64_t sample_count = snapshot->get_sample_count();
	const unsigned int chunk_sample_count =
		DecodeChunkLength / snapshot->unit_size();

	// Clear error message upon every new session run
	_error_message = QString();

	// Create the session
	srd_session_new(&session);
	assert(session);

	// Create the decoders
	BOOST_FOREACH(const shared_ptr<decode::Decoder> &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((uint64_t)_samplerate));

	srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
		DecoderStack::annotation_callback, this);

	srd_session_start(session);

	for (int64_t i = 0;
		!boost::this_thread::interruption_requested() &&
			i < sample_count;
		i += chunk_sample_count)
	{
		lock_guard<mutex> decode_lock(_global_decode_mutex);

		const int64_t chunk_end = min(
			i + chunk_sample_count, sample_count);
		snapshot->get_samples(chunk, i, chunk_end);

		if (srd_session_send(session, i, i + sample_count,
				chunk, chunk_end - i) != SRD_OK) {
			_error_message = tr("Decoder reported an error");
			break;
		}

		{
			lock_guard<mutex> lock(_mutex);
			_samples_decoded = chunk_end;
		}
	}

	// Destroy the session
	srd_session_destroy(session);
}

bool DecoderStack::index_entry_start_sample_gt(
	const uint64_t sample, const size_t index) const
{
	assert(index < _annotations.size());
	return _annotations[index].start_sample() > sample;
}

bool DecoderStack::index_entry_end_sample_lt(
	const size_t index, const uint64_t sample) const
{
	assert(index < _annotations.size());
	return _annotations[index].end_sample() < sample;
}

bool DecoderStack::index_entry_end_sample_gt(
	const uint64_t sample, const size_t index) const
{
	assert(index < _annotations.size());
	return _annotations[index].end_sample() > sample;
}

void DecoderStack::insert_annotation_into_start_index(
	const pv::data::decode::Annotation &a, const size_t storage_offset)
{
	vector<size_t>::iterator i = _ann_start_index.end();
	if (!_ann_start_index.empty() &&
		_annotations[_ann_start_index.back()].start_sample() >
			a.start_sample())
		i = upper_bound(_ann_start_index.begin(),
			_ann_start_index.end(), a.start_sample(),
			bind(&DecoderStack::index_entry_start_sample_gt,
				this, _1, _2));

	_ann_start_index.insert(i, storage_offset);
}

void DecoderStack::insert_annotation_into_end_index(
	const pv::data::decode::Annotation &a, const size_t storage_offset)
{
	vector<size_t>::iterator i = _ann_end_index.end();
	if (!_ann_end_index.empty() &&
		_annotations[_ann_end_index.back()].end_sample() <
			a.end_sample())
		i = upper_bound(_ann_end_index.begin(),
			_ann_end_index.end(), a.end_sample(),
			bind(&DecoderStack::index_entry_end_sample_gt,
				this, _1, _2));

	_ann_end_index.insert(i, storage_offset);
}

void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
{
	using pv::data::decode::Annotation;

	GSList *l, *ll;
	int row, ann_class, idx = 0;
	struct srd_decoder_annotation_row *ann_row;
	struct srd_decoder *decc;

	assert(pdata);
	assert(decoder);

	DecoderStack *const d = (DecoderStack*)decoder;

	lock_guard<mutex> lock(d->_mutex);

	Annotation a = Annotation(pdata);

	decc = pdata->pdo->di->decoder;
	BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, d->stack()) {
		if (dec->decoder() == decc)
			break;
		idx++;
	}
	a.set_pd_index(idx);

	for (l = decc->annotation_rows, row = 0; l; l = l->next, row++)
	{
		ann_row = (struct srd_decoder_annotation_row *)l->data;

		for (ll = ann_row->ann_classes, ann_class = 0; ll;
					ll = ll->next, ann_class++)
		{
			if (GPOINTER_TO_INT(ll->data) == a.format())
				a.set_row(row);
		}
	}

	const size_t offset = d->_annotations.size();
	d->_annotations.push_back(a);

	d->insert_annotation_into_start_index(a, offset);
	d->insert_annotation_into_end_index(a, offset);

	d->new_decode_data();
}

} // namespace data
} // namespace pv