[pulseview.git] / pv / data / decoder.h

/*
 * 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
 */

#ifndef PULSEVIEW_PV_DATA_DECODER_H
#define PULSEVIEW_PV_DATA_DECODER_H

#include "signaldata.h"

#include <map>

#include <boost/shared_ptr.hpp>
#include <boost/thread.hpp>

#include <QObject>
#include <QString>

#include <glib.h>

struct srd_decoder;
struct srd_probe;
struct srd_proto_data;

namespace DecoderTest {
class TwoDecoder;
}

namespace pv {

namespace view {
class LogicSignal;

namespace decode {
class Annotation;
}

}

namespace data {

class Logic;

class Decoder : public QObject, public SignalData
{
	Q_OBJECT

private:
	static const double DecodeMargin;
	static const double DecodeThreshold;
	static const int64_t DecodeChunkLength;

public:
	Decoder(const srd_decoder *const decoder,
		std::map<const srd_probe*,
			boost::shared_ptr<pv::view::LogicSignal> > probes,
		GHashTable *options);

	virtual ~Decoder();

	const srd_decoder* get_decoder() const;

	const std::vector< boost::shared_ptr<pv::view::decode::Annotation> >
		annotations() const;

	QString error_message();

	void clear_snapshots();

private:
	void begin_decode();

	void init_decoder();

	void decode_proc(boost::shared_ptr<data::Logic> data);

	static void annotation_callback(srd_proto_data *pdata,
		void *decoder);

signals:
	void new_decode_data();

private:

	/**
	 * This mutex prevents more than one decode operation occuring
	 * concurrently.
	 * @todo A proper solution should be implemented to allow multiple
	 * decode operations.
	 */
	static boost::mutex _global_decode_mutex;

	const srd_decoder *const _decoder;
	std::map<const srd_probe*, boost::shared_ptr<view::LogicSignal> >
		_probes;
	GHashTable *_options;

	mutable boost::mutex _mutex;
	std::vector< boost::shared_ptr<pv::view::decode::Annotation> >
		_annotations;
	QString _error_message;

	boost::thread _decode_thread;

	friend class DecoderTest::TwoDecoder;
};

} // namespace data
} // namespace pv

#endif // PULSEVIEW_PV_DATA_DECODER_H
Commit	Line	Data
	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
	21	#ifndef PULSEVIEW_PV_DATA_DECODER_H
	22	#define PULSEVIEW_PV_DATA_DECODER_H
	23
	24	#include "signaldata.h"
	25
	26	#include <map>
	27
	28	#include <boost/shared_ptr.hpp>
	29	#include <boost/thread.hpp>
	30
	31	#include <QObject>
	32	#include <QString>
	33
	34	#include <glib.h>
	35
	36	struct srd_decoder;
	37	struct srd_probe;
	38	struct srd_proto_data;
	39
	40	namespace DecoderTest {
	41	class TwoDecoder;
	42	}
	43
	44	namespace pv {
	45
	46	namespace view {
	47	class LogicSignal;
	48
	49	namespace decode {
	50	class Annotation;
	51	}
	52
	53	}
	54
	55	namespace data {
	56
	57	class Logic;
	58
	59	class Decoder : public QObject, public SignalData
	60	{
	61	Q_OBJECT
	62
	63	private:
	64	static const double DecodeMargin;
	65	static const double DecodeThreshold;
	66	static const int64_t DecodeChunkLength;
	67
	68	public:
	69	Decoder(const srd_decoder *const decoder,
	70	std::map<const srd_probe*,
	71	boost::shared_ptr<pv::view::LogicSignal> > probes,
	72	GHashTable *options);
	73
	74	virtual ~Decoder();
	75
	76	const srd_decoder* get_decoder() const;
	77
	78	const std::vector< boost::shared_ptr<pv::view::decode::Annotation> >
	79	annotations() const;
	80
	81	QString error_message();
	82
	83	void clear_snapshots();
	84
	85	private:
	86	void begin_decode();
	87
	88	void init_decoder();
	89
	90	void decode_proc(boost::shared_ptr<data::Logic> data);
	91
	92	static void annotation_callback(srd_proto_data *pdata,
	93	void *decoder);
	94
	95	signals:
	96	void new_decode_data();
	97
	98	private:
	99
	100	/**
	101	* This mutex prevents more than one decode operation occuring
	102	* concurrently.
	103	* @todo A proper solution should be implemented to allow multiple
	104	* decode operations.
	105	*/
	106	static boost::mutex _global_decode_mutex;
	107
	108	const srd_decoder *const _decoder;
	109	std::map<const srd_probe*, boost::shared_ptr<view::LogicSignal> >
	110	_probes;
	111	GHashTable *_options;
	112
	113	mutable boost::mutex _mutex;
	114	std::vector< boost::shared_ptr<pv::view::decode::Annotation> >
	115	_annotations;
	116	QString _error_message;
	117
	118	boost::thread _decode_thread;
	119
	120	friend class DecoderTest::TwoDecoder;
	121	};
	122
	123	} // namespace data
	124	} // namespace pv
	125
	126	#endif // PULSEVIEW_PV_DATA_DECODER_H