[pulseview.git] / pv / data / analogsegment.hpp

/*
 * 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP
#define PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP

#include "segment.hpp"

#include <utility>
#include <vector>

#include <QObject>

using std::pair;

namespace AnalogSegmentTest {
struct Basic;
}

namespace pv {
namespace data {

class Analog;

typedef struct {
	uint64_t sample_index, chunk_num, chunk_offs;
	uint8_t* chunk;
	float* value;
} SegmentAnalogDataIterator;

class AnalogSegment : public Segment
{
	Q_OBJECT

public:
	struct EnvelopeSample
	{
		float min;
		float max;
	};

	struct EnvelopeSection
	{
		uint64_t start;
		unsigned int scale;
		uint64_t length;
		EnvelopeSample *samples;
	};

private:
	struct Envelope
	{
		uint64_t length;
		uint64_t data_length;
		EnvelopeSample *samples;
	};

private:
	static const unsigned int ScaleStepCount = 10;
	static const int EnvelopeScalePower;
	static const int EnvelopeScaleFactor;
	static const float LogEnvelopeScaleFactor;
	static const uint64_t EnvelopeDataUnit;

public:
	AnalogSegment(Analog& owner, uint32_t segment_id, uint64_t samplerate);

	virtual ~AnalogSegment();

	void append_interleaved_samples(const float *data,
		size_t sample_count, size_t stride);

	void get_samples(int64_t start_sample, int64_t end_sample, float* dest) const;

	const pair<float, float> get_min_max() const;

	SegmentAnalogDataIterator* begin_sample_iteration(uint64_t start);
	void continue_sample_iteration(SegmentAnalogDataIterator* it, uint64_t increase);
	void end_sample_iteration(SegmentAnalogDataIterator* it);

	void get_envelope_section(EnvelopeSection &s,
		uint64_t start, uint64_t end, float min_length) const;

private:
	void reallocate_envelope(Envelope &e);

	void append_payload_to_envelope_levels();

private:
	Analog& owner_;

	struct Envelope envelope_levels_[ScaleStepCount];

	float min_value_, max_value_;

	friend struct AnalogSegmentTest::Basic;
};

} // namespace data
} // namespace pv

#endif // PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP
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, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP
	21	#define PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP
	22
	23	#include "segment.hpp"
	24
	25	#include <utility>
	26	#include <vector>
	27
	28	#include <QObject>
	29
	30	using std::pair;
	31
	32	namespace AnalogSegmentTest {
	33	struct Basic;
	34	}
	35
	36	namespace pv {
	37	namespace data {
	38
	39	class Analog;
	40
	41	typedef struct {
	42	uint64_t sample_index, chunk_num, chunk_offs;
	43	uint8_t* chunk;
	44	float* value;
	45	} SegmentAnalogDataIterator;
	46
	47	class AnalogSegment : public Segment
	48	{
	49	Q_OBJECT
	50
	51	public:
	52	struct EnvelopeSample
	53	{
	54	float min;
	55	float max;
	56	};
	57
	58	struct EnvelopeSection
	59	{
	60	uint64_t start;
	61	unsigned int scale;
	62	uint64_t length;
	63	EnvelopeSample *samples;
	64	};
	65
	66	private:
	67	struct Envelope
	68	{
	69	uint64_t length;
	70	uint64_t data_length;
	71	EnvelopeSample *samples;
	72	};
	73
	74	private:
	75	static const unsigned int ScaleStepCount = 10;
	76	static const int EnvelopeScalePower;
	77	static const int EnvelopeScaleFactor;
	78	static const float LogEnvelopeScaleFactor;
	79	static const uint64_t EnvelopeDataUnit;
	80
	81	public:
	82	AnalogSegment(Analog& owner, uint32_t segment_id, uint64_t samplerate);
	83
	84	virtual ~AnalogSegment();
	85
	86	void append_interleaved_samples(const float *data,
	87	size_t sample_count, size_t stride);
	88
	89	void get_samples(int64_t start_sample, int64_t end_sample, float* dest) const;
	90
	91	const pair<float, float> get_min_max() const;
	92
	93	SegmentAnalogDataIterator* begin_sample_iteration(uint64_t start);
	94	void continue_sample_iteration(SegmentAnalogDataIterator* it, uint64_t increase);
	95	void end_sample_iteration(SegmentAnalogDataIterator* it);
	96
	97	void get_envelope_section(EnvelopeSection &s,
	98	uint64_t start, uint64_t end, float min_length) const;
	99
	100	private:
	101	void reallocate_envelope(Envelope &e);
	102
	103	void append_payload_to_envelope_levels();
	104
	105	private:
	106	Analog& owner_;
	107
	108	struct Envelope envelope_levels_[ScaleStepCount];
	109
	110	float min_value_, max_value_;
	111
	112	friend struct AnalogSegmentTest::Basic;
	113	};
	114
	115	} // namespace data
	116	} // namespace pv
	117
	118	#endif // PULSEVIEW_PV_DATA_ANALOGSEGMENT_HPP