[pulseview.git] / pv / logicdatasnapshot.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_LOGICDATASNAPSHOT_H
#define PULSEVIEW_PV_LOGICDATASNAPSHOT_H

#include "datasnapshot.h"

#include <utility>
#include <vector>

namespace LogicDataSnapshotTest {
	class Pow2;
	class Basic;
	class LargeData;
	class Pulses;
	class LongPulses;
}

namespace pv {

class LogicDataSnapshot : public DataSnapshot
{
private:
	struct MipMapLevel
	{
		uint64_t length;
		uint64_t data_length;
		void *data;
	};

private:
	static const unsigned int ScaleStepCount = 10;
	static const int MipMapScalePower;
	static const int MipMapScaleFactor;
	static const float LogMipMapScaleFactor;
	static const uint64_t MipMapDataUnit;

public:
	typedef std::pair<int64_t, bool> EdgePair;

public:
	LogicDataSnapshot(const sr_datafeed_logic &logic);

	virtual ~LogicDataSnapshot();

	void append_payload(const sr_datafeed_logic &logic);

private:
	void reallocate_mip_map(MipMapLevel &m);

	void append_payload_to_mipmap();

public:
	uint64_t get_sample(uint64_t index) const;

	/**
	 * Parses a logic data snapshot to generate a list of transitions
	 * in a time interval to a given level of detail.
	 * @param[out] edges The vector to place the edges into.
	 * @param[in] start The start sample index.
	 * @param[in] end The end sample index.
	 * @param[in] min_length The minimum number of samples that
	 * can be resolved at this level of detail.
	 * @param[in] sig_index The index of the signal.
	 **/
	void get_subsampled_edges(std::vector<EdgePair> &edges,
		uint64_t start, uint64_t end,
		float min_length, int sig_index);

private:
	uint64_t get_subsample(int level, uint64_t offset) const;

	static uint64_t pow2_ceil(uint64_t x, unsigned int power);

private:
	struct MipMapLevel _mip_map[ScaleStepCount];
	uint64_t _last_append_sample;

	friend class LogicDataSnapshotTest::Pow2;
	friend class LogicDataSnapshotTest::Basic;
	friend class LogicDataSnapshotTest::LargeData;
	friend class LogicDataSnapshotTest::Pulses;
	friend class LogicDataSnapshotTest::LongPulses;
};

} // namespace pv

#endif // PULSEVIEW_PV_LOGICDATASNAPSHOT_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_LOGICDATASNAPSHOT_H
	22	#define PULSEVIEW_PV_LOGICDATASNAPSHOT_H
	23
	24	#include "datasnapshot.h"
	25
	26	#include <utility>
	27	#include <vector>
	28
	29	namespace LogicDataSnapshotTest {
	30	class Pow2;
	31	class Basic;
	32	class LargeData;
	33	class Pulses;
	34	class LongPulses;
	35	}
	36
	37	namespace pv {
	38
	39	class LogicDataSnapshot : public DataSnapshot
	40	{
	41	private:
	42	struct MipMapLevel
	43	{
	44	uint64_t length;
	45	uint64_t data_length;
	46	void *data;
	47	};
	48
	49	private:
	50	static const unsigned int ScaleStepCount = 10;
	51	static const int MipMapScalePower;
	52	static const int MipMapScaleFactor;
	53	static const float LogMipMapScaleFactor;
	54	static const uint64_t MipMapDataUnit;
	55
	56	public:
	57	typedef std::pair<int64_t, bool> EdgePair;
	58
	59	public:
	60	LogicDataSnapshot(const sr_datafeed_logic &logic);
	61
	62	virtual ~LogicDataSnapshot();
	63
	64	void append_payload(const sr_datafeed_logic &logic);
	65
	66	private:
	67	void reallocate_mip_map(MipMapLevel &m);
	68
	69	void append_payload_to_mipmap();
	70
	71	public:
	72	uint64_t get_sample(uint64_t index) const;
	73
	74	/**
	75	* Parses a logic data snapshot to generate a list of transitions
	76	* in a time interval to a given level of detail.
	77	* @param[out] edges The vector to place the edges into.
	78	* @param[in] start The start sample index.
	79	* @param[in] end The end sample index.
	80	* @param[in] min_length The minimum number of samples that
	81	* can be resolved at this level of detail.
	82	* @param[in] sig_index The index of the signal.
	83	**/
	84	void get_subsampled_edges(std::vector<EdgePair> &edges,
	85	uint64_t start, uint64_t end,
	86	float min_length, int sig_index);
	87
	88	private:
	89	uint64_t get_subsample(int level, uint64_t offset) const;
	90
	91	static uint64_t pow2_ceil(uint64_t x, unsigned int power);
	92
	93	private:
	94	struct MipMapLevel _mip_map[ScaleStepCount];
	95	uint64_t _last_append_sample;
	96
	97	friend class LogicDataSnapshotTest::Pow2;
	98	friend class LogicDataSnapshotTest::Basic;
	99	friend class LogicDataSnapshotTest::LargeData;
	100	friend class LogicDataSnapshotTest::Pulses;
	101	friend class LogicDataSnapshotTest::LongPulses;
	102	};
	103
	104	} // namespace pv
	105
	106	#endif // PULSEVIEW_PV_LOGICDATASNAPSHOT_H