[pulseview.git] / pv / data / segment.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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef PULSEVIEW_PV_DATA_SNAPSHOT_HPP
#define PULSEVIEW_PV_DATA_SNAPSHOT_HPP

#include <thread>
#include <mutex>
#include <vector>

namespace pv {
namespace data {

class Segment
{
public:
	Segment(uint64_t samplerate, unsigned int unit_size);

	virtual ~Segment();

	uint64_t get_sample_count() const;

	double start_time() const;

	double samplerate() const;
	void set_samplerate(double samplerate);

	unsigned int unit_size() const;

	/**
	 * @brief Increase the capacity of the segment.
	 *
	 * Increasing the capacity allows samples to be appended without needing
	 * to reallocate memory.
	 *
	 * For the best efficiency @c set_capacity() should be called once before
	 * @c append_data() is called to set up the segment with the expected number
	 * of samples that will be appended in total.
	 *
	 * @note The capacity will automatically be increased when @c append_data()
	 * is called if there is not enough capacity in the buffer to store the samples.
	 *
	 * @param[in] new_capacity The new capacity of the segment. If this value is
	 * 	smaller or equal than the current capacity then the method has no effect.
	 */
	void set_capacity(uint64_t new_capacity);

	/**
	 * @brief Get the current capacity of the segment.
	 *
	 * The capacity can be increased by calling @c set_capacity().
	 *
	 * @return The current capacity of the segment.
	 */
	uint64_t capacity() const;

protected:
	void append_data(void *data, uint64_t samples);

protected:
	mutable std::recursive_mutex mutex_;
	std::vector<uint8_t> data_;
	uint64_t sample_count_;
	double start_time_;
	double samplerate_;
	uint64_t capacity_;
	unsigned int unit_size_;
};

} // namespace data
} // namespace pv

#endif // PULSEVIEW_PV_DATA_SNAPSHOT_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, 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_SNAPSHOT_HPP
	22	#define PULSEVIEW_PV_DATA_SNAPSHOT_HPP
	23
	24	#include <thread>
	25	#include <mutex>
	26	#include <vector>
	27
	28	namespace pv {
	29	namespace data {
	30
	31	class Segment
	32	{
	33	public:
	34	Segment(uint64_t samplerate, unsigned int unit_size);
	35
	36	virtual ~Segment();
	37
	38	uint64_t get_sample_count() const;
	39
	40	double start_time() const;
	41
	42	double samplerate() const;
	43	void set_samplerate(double samplerate);
	44
	45	unsigned int unit_size() const;
	46
	47	/**
	48	* @brief Increase the capacity of the segment.
	49	*
	50	* Increasing the capacity allows samples to be appended without needing
	51	* to reallocate memory.
	52	*
	53	* For the best efficiency @c set_capacity() should be called once before
	54	* @c append_data() is called to set up the segment with the expected number
	55	* of samples that will be appended in total.
	56	*
	57	* @note The capacity will automatically be increased when @c append_data()
	58	* is called if there is not enough capacity in the buffer to store the samples.
	59	*
	60	* @param[in] new_capacity The new capacity of the segment. If this value is
	61	* smaller or equal than the current capacity then the method has no effect.
	62	*/
	63	void set_capacity(uint64_t new_capacity);
	64
	65	/**
	66	* @brief Get the current capacity of the segment.
	67	*
	68	* The capacity can be increased by calling @c set_capacity().
	69	*
	70	* @return The current capacity of the segment.
	71	*/
	72	uint64_t capacity() const;
	73
	74	protected:
	75	void append_data(void *data, uint64_t samples);
	76
	77	protected:
	78	mutable std::recursive_mutex mutex_;
	79	std::vector<uint8_t> data_;
	80	uint64_t sample_count_;
	81	double start_time_;
	82	double samplerate_;
	83	uint64_t capacity_;
	84	unsigned int unit_size_;
	85	};
	86
	87	} // namespace data
	88	} // namespace pv
	89
	90	#endif // PULSEVIEW_PV_DATA_SNAPSHOT_HPP