[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/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::make_pair;
using std::max;
using std::min;
using std::list;
using std::map;
using std::pair;
using std::vector;

using namespace pv::data::decode;

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)
{
	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;
}

std::vector<Row> DecoderStack::get_rows() const
{
	lock_guard<mutex> lock(_mutex);

	vector<Row> rows;

	BOOST_FOREACH (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.push_back(Row(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.push_back(Row(decc, ann_row));
		}
	}

	return rows;
}

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

	std::map<const Row, decode::RowData>::const_iterator iter =
		_rows.find(row);
	if (iter != _rows.end())
		(*iter).second.get_annotation_subset(dest,
			start_sample, end_sample);
}

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

void DecoderStack::clear()
{
	_samples_decoded = 0;
	_error_message = QString();
	_rows.clear();
	_class_rows.clear();
}

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

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

	clear();

	// Add classes
	BOOST_FOREACH (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;
			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;
		}
	}

	// 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);
}

uint64_t DecoderStack::get_max_sample_count() const
{
	uint64_t max_sample_count = 0;

	for (map<const Row, RowData>::const_iterator i = _rows.begin();
		i != _rows.end(); i++)
		max_sample_count = max(max_sample_count,
			(*i).second.get_max_sample());

	return max_sample_count;
}

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();

	// 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);
}

void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
{
	assert(pdata);
	assert(decoder);

	DecoderStack *const d = (DecoderStack*)decoder;
	assert(d);

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

	const Annotation a(pdata);

	// Find the row
	assert(pdata->pdo);
	assert(pdata->pdo->di);
	const srd_decoder *const decc = pdata->pdo->di->decoder;
	assert(decc);

	map<const Row, decode::RowData>::iterator row_iter = d->_rows.end();
	
	// Try looking up the sub-row of this class
	const map<pair<const srd_decoder*, int>, Row>::const_iterator r =
		d->_class_rows.find(make_pair(decc, a.format()));
	if (r != d->_class_rows.end())
		row_iter = d->_rows.find((*r).second);
	else
	{
		// Failing that, use the decoder as a key
		row_iter = d->_rows.find(Row(decc));	
	}

	assert(row_iter != d->_rows.end());
	if (row_iter == d->_rows.end()) {
		qDebug() << "Unexpected annotation: decoder = " << decc <<
			", format = " << a.format();
		assert(0);
		return;
	}

	// Add the annotation
	(*row_iter).second.push_annotation(a);

	d->new_decode_data();
}

} // namespace data
} // namespace pv
Commit	Line	Data
119aff65 JH	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
	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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
e332f6d3 JH	21	#include <libsigrokdecode/libsigrokdecode.h>
e332f6d3 JH	22
7491a29f	23	#include <boost/foreach.hpp>
e0fc5810 JH	24	#include <boost/thread/thread.hpp>
e0fc5810 JH	25
e92cd4e4 JH	26	#include <stdexcept>
e92cd4e4 JH	27
b213ef09 JH	28	#include <QDebug>
b213ef09 JH	29
6e89374a	30	#include "decoderstack.h"
119aff65	31
e0fc5810 JH	32	#include <pv/data/logic.h>
e0fc5810 JH	33	#include <pv/data/logicsnapshot.h>
7491a29f	34	#include <pv/data/decode/decoder.h>
06e810f2	35	#include <pv/data/decode/annotation.h>
e0fc5810	36	#include <pv/view/logicsignal.h>
708c5523	37
819f4c25 JH	38	using boost::lock_guard;
	39	using boost::mutex;
	40	using boost::shared_ptr;
	41	using std::deque;
f9101a91 JH	42	using std::make_pair;
f9101a91 JH	43	using std::max;
819f4c25 JH	44	using std::min;
819f4c25 JH	45	using std::list;
f9101a91 JH	46	using std::map;
f9101a91 JH	47	using std::pair;
819f4c25	48	using std::vector;
e332f6d3	49
f9101a91 JH	50	using namespace pv::data::decode;
f9101a91 JH	51
119aff65 JH	52	namespace pv {
	53	namespace data {
	54
6e89374a JH	55	const double DecoderStack::DecodeMargin = 1.0;
	56	const double DecoderStack::DecodeThreshold = 0.2;
	57	const int64_t DecoderStack::DecodeChunkLength = 4096;
e0fc5810	58
6e89374a	59	mutex DecoderStack::_global_decode_mutex;
fe89c961	60
5dfeb70f JH	61	DecoderStack::DecoderStack(const srd_decoder *const dec) :
5dfeb70f JH	62	_samples_decoded(0)
119aff65	63	{
7491a29f JH	64	_stack.push_back(shared_ptr<decode::Decoder>(
7491a29f JH	65	new decode::Decoder(dec)));
119aff65 JH	66	}
119aff65 JH	67
6e89374a	68	DecoderStack::~DecoderStack()
640d69ce JH	69	{
	70	_decode_thread.interrupt();
	71	_decode_thread.join();
4e5a4405 JH	72	}
4e5a4405 JH	73
7491a29f JH	74	const std::list< boost::shared_ptr<decode::Decoder> >&
7491a29f JH	75	DecoderStack::stack() const
4e5a4405	76	{
7491a29f	77	return _stack;
4e5a4405 JH	78	}
4e5a4405 JH	79
7491a29f	80	void DecoderStack::push(boost::shared_ptr<decode::Decoder> decoder)
4e5a4405	81	{
7491a29f JH	82	assert(decoder);
7491a29f JH	83	_stack.push_back(decoder);
4e5a4405 JH	84	}
4e5a4405 JH	85
613d097c JH	86	void DecoderStack::remove(int index)
613d097c JH	87	{
613d097c JH	88	assert(index >= 0);
	89	assert(index < (int)_stack.size());
	90
	91	// Find the decoder in the stack
	92	list< shared_ptr<Decoder> >::iterator iter = _stack.begin();
	93	for(int i = 0; i < index; i++, iter++)
	94	assert(iter != _stack.end());
	95
	96	// Delete the element
	97	_stack.erase(iter);
	98	}
	99
5dfeb70f JH	100	int64_t DecoderStack::samples_decoded() const
	101	{
	102	lock_guard<mutex> decode_lock(_mutex);
	103	return _samples_decoded;
	104	}
	105
f9101a91 JH	106	std::vector<Row> DecoderStack::get_rows() const
	107	{
	108	lock_guard<mutex> lock(_mutex);
	109
	110	vector<Row> rows;
	111
	112	BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
	113	{
	114	assert(dec);
	115	const srd_decoder *const decc = dec->decoder();
	116	assert(dec->decoder());
	117
	118	// Add a row for the decoder if it doesn't have a row list
	119	if (!decc->annotation_rows)
	120	rows.push_back(Row(decc));
	121
	122	// Add the decoder rows
	123	for (const GSList *l = decc->annotation_rows; l; l = l->next)
	124	{
	125	const srd_decoder_annotation_row *const ann_row =
	126	(srd_decoder_annotation_row *)l->data;
	127	assert(ann_row);
	128	rows.push_back(Row(decc, ann_row));
	129	}
	130	}
	131
	132	return rows;
	133	}
	134
92421299 JH	135	void DecoderStack::get_annotation_subset(
92421299 JH	136	std::vector<pv::data::decode::Annotation> &dest,
f9101a91 JH	137	const Row &row, uint64_t start_sample,
f9101a91 JH	138	uint64_t end_sample) const
e0fc5810	139	{
b6b267bb	140	lock_guard<mutex> lock(_mutex);
92421299	141
f9101a91 JH	142	std::map<const Row, decode::RowData>::const_iterator iter =
	143	_rows.find(row);
	144	if (iter != _rows.end())
	145	(*iter).second.get_annotation_subset(dest,
	146	start_sample, end_sample);
e0fc5810 JH	147	}
e0fc5810 JH	148
6e89374a	149	QString DecoderStack::error_message()
b6b267bb JH	150	{
	151	lock_guard<mutex> lock(_mutex);
	152	return _error_message;
	153	}
	154
f9101a91 JH	155	void DecoderStack::clear()
	156	{
	157	_samples_decoded = 0;
	158	_error_message = QString();
	159	_rows.clear();
	160	_class_rows.clear();
	161	}
	162
6e89374a	163	void DecoderStack::begin_decode()
640d69ce	164	{
7491a29f JH	165	shared_ptr<pv::view::LogicSignal> logic_signal;
	166	shared_ptr<pv::data::Logic> data;
	167
640d69ce JH	168	_decode_thread.interrupt();
	169	_decode_thread.join();
	170
92421299	171	clear();
4e5a4405	172
f9101a91 JH	173	// Add classes
	174	BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
	175	{
	176	assert(dec);
	177	const srd_decoder *const decc = dec->decoder();
	178	assert(dec->decoder());
	179
	180	// Add a row for the decoder if it doesn't have a row list
	181	if (!decc->annotation_rows)
	182	_rows[Row(decc)] = decode::RowData();
	183
	184	// Add the decoder rows
	185	for (const GSList *l = decc->annotation_rows; l; l = l->next)
	186	{
	187	const srd_decoder_annotation_row *const ann_row =
	188	(srd_decoder_annotation_row *)l->data;
	189	assert(ann_row);
	190
	191	const Row row(decc, ann_row);
	192
	193	// Add a new empty row data object
	194	_rows[row] = decode::RowData();
	195
	196	// Map out all the classes
	197	for (const GSList *ll = ann_row->ann_classes;
	198	ll; ll = ll->next)
	199	_class_rows[make_pair(decc,
	200	GPOINTER_TO_INT(ll->data))] = row;
	201	}
	202	}
	203
e0fc5810 JH	204	// We get the logic data of the first probe in the list.
	205	// This works because we are currently assuming all
	206	// LogicSignals have the same data/snapshot
7491a29f JH	207	BOOST_FOREACH (const shared_ptr<decode::Decoder> &dec, _stack)
	208	if (dec && !dec->probes().empty() &&
	209	((logic_signal = (*dec->probes().begin()).second)) &&
7aa09b00	210	((data = logic_signal->logic_data())))
7491a29f JH	211	break;
	212
	213	if (!data)
	214	return;
	215
	216	// Get the samplerate and start time
	217	_start_time = data->get_start_time();
9d28da5a	218	_samplerate = data->samplerate();
7491a29f JH	219	if (_samplerate == 0.0)
7491a29f JH	220	_samplerate = 1.0;
e0fc5810	221
6e89374a	222	_decode_thread = boost::thread(&DecoderStack::decode_proc, this,
e0fc5810	223	data);
640d69ce JH	224	}
640d69ce JH	225
a007f5ad JH	226	uint64_t DecoderStack::get_max_sample_count() const
a007f5ad JH	227	{
f9101a91 JH	228	uint64_t max_sample_count = 0;
	229
	230	for (map<const Row, RowData>::const_iterator i = _rows.begin();
	231	i != _rows.end(); i++)
	232	max_sample_count = max(max_sample_count,
	233	(*i).second.get_max_sample());
	234
	235	return max_sample_count;
a007f5ad JH	236	}
a007f5ad JH	237
6e89374a	238	void DecoderStack::decode_proc(shared_ptr<data::Logic> data)
119aff65	239	{
b6b267bb	240	srd_session *session;
e0fc5810	241	uint8_t chunk[DecodeChunkLength];
7491a29f	242	srd_decoder_inst *prev_di = NULL;
e0fc5810 JH	243
	244	assert(data);
	245
e0fc5810 JH	246	const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
	247	data->get_snapshots();
	248	if (snapshots.empty())
	249	return;
	250
	251	const shared_ptr<pv::data::LogicSnapshot> &snapshot =
	252	snapshots.front();
c02f1e09	253	const int64_t sample_count = snapshot->get_sample_count();
064a7f42 JH	254	const unsigned int chunk_sample_count =
064a7f42 JH	255	DecodeChunkLength / snapshot->unit_size();
e0fc5810	256
b6b267bb JH	257	// Create the session
	258	srd_session_new(&session);
	259	assert(session);
e0fc5810	260
7491a29f JH	261	// Create the decoders
	262	BOOST_FOREACH(const shared_ptr<decode::Decoder> &dec, _stack)
	263	{
	264	srd_decoder_inst *const di = dec->create_decoder_inst(session);
e0fc5810	265
7491a29f JH	266	if (!di)
7491a29f JH	267	{
8a290daf	268	_error_message = tr("Failed to create decoder instance");
7491a29f JH	269	srd_session_destroy(session);
	270	return;
	271	}
b6b267bb	272
7491a29f JH	273	if (prev_di)
7491a29f JH	274	srd_inst_stack (session, prev_di, di);
b6b267bb	275
7491a29f	276	prev_di = di;
b6b267bb JH	277	}
b6b267bb JH	278
b6b267bb	279	// Start the session
7491a29f JH	280	srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
	281	g_variant_new_uint64((uint64_t)_samplerate));
	282
	283	srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
	284	DecoderStack::annotation_callback, this);
	285
b6b267bb JH	286	srd_session_start(session);
b6b267bb JH	287
e0fc5810	288	for (int64_t i = 0;
819f4c25 JH	289	!boost::this_thread::interruption_requested() &&
819f4c25 JH	290	i < sample_count;
064a7f42	291	i += chunk_sample_count)
e0fc5810	292	{
fe89c961 JH	293	lock_guard<mutex> decode_lock(_global_decode_mutex);
fe89c961 JH	294
e0fc5810	295	const int64_t chunk_end = min(
064a7f42	296	i + chunk_sample_count, sample_count);
e0fc5810 JH	297	snapshot->get_samples(chunk, i, chunk_end);
e0fc5810 JH	298
f00fc2a9 BV	299	if (srd_session_send(session, i, i + sample_count,
f00fc2a9 BV	300	chunk, chunk_end - i) != SRD_OK) {
8a290daf	301	_error_message = tr("Decoder reported an error");
e0fc5810	302	break;
b6b267bb	303	}
5dfeb70f JH	304
	305	{
	306	lock_guard<mutex> lock(_mutex);
	307	_samples_decoded = chunk_end;
	308	}
e0fc5810	309	}
b6b267bb JH	310
	311	// Destroy the session
	312	srd_session_destroy(session);
e0fc5810 JH	313	}
e0fc5810 JH	314
6e89374a	315	void DecoderStack::annotation_callback(srd_proto_data pdata, void decoder)
e0fc5810	316	{
e0fc5810 JH	317	assert(pdata);
	318	assert(decoder);
	319
6e89374a	320	DecoderStack const d = (DecoderStack)decoder;
f9101a91	321	assert(d);
e0fc5810	322
b6b267bb	323	lock_guard<mutex> lock(d->_mutex);
6d8b0562	324
f9101a91 JH	325	const Annotation a(pdata);
	326
	327	// Find the row
	328	assert(pdata->pdo);
	329	assert(pdata->pdo->di);
	330	const srd_decoder *const decc = pdata->pdo->di->decoder;
	331	assert(decc);
	332
	333	map<const Row, decode::RowData>::iterator row_iter = d->_rows.end();
	334
	335	// Try looking up the sub-row of this class
	336	const map<pair<const srd_decoder*, int>, Row>::const_iterator r =
	337	d->_class_rows.find(make_pair(decc, a.format()));
	338	if (r != d->_class_rows.end())
	339	row_iter = d->_rows.find((*r).second);
	340	else
6d8b0562	341	{
f9101a91 JH	342	// Failing that, use the decoder as a key
f9101a91 JH	343	row_iter = d->_rows.find(Row(decc));
6d8b0562 UH	344	}
6d8b0562 UH	345
f9101a91 JH	346	assert(row_iter != d->_rows.end());
	347	if (row_iter == d->_rows.end()) {
	348	qDebug() << "Unexpected annotation: decoder = " << decc <<
	349	", format = " << a.format();
	350	assert(0);
	351	return;
	352	}
9cef9567	353
f9101a91 JH	354	// Add the annotation
f9101a91 JH	355	(*row_iter).second.push_annotation(a);
92421299	356
9cef9567	357	d->new_decode_data();
119aff65 JH	358	}
	359
	360	} // namespace data
	361	} // namespace pv