audio-drain/audio/drain/EndPointRead.hpp

/** @file
 * @author Edouard DUPIN 
 * @copyright 2011, Edouard DUPIN, all right reserved
 * @license MPL v2.0 (see license file)
 */
#pragma once

#include <audio/drain/EndPoint.hpp>

namespace audio {
	namespace drain{
		class EndPointRead : public EndPoint {
			protected:
				/**
				 * @brief Constructor
				 */
				EndPointRead();
				void init();
			public:
				static ememory::SharedPtr<EndPointRead> create();
				/**
				 * @brief Destructor
				 */
				virtual ~EndPointRead() {};
				virtual void configurationChange();
				virtual bool process(audio::Time& _time,
				                     void* _input,
				                     size_t _inputNbChunk,
				                     void*& _output,
				                     size_t& _outputNbChunk);
				/**
				 * @brief Set buffer size in chunk number
				 * @param[in] _nbChunk Number of chunk in the buffer
				 */
				virtual void setBufferSize(size_t _nbChunk);
				/**
				 * @brief Set buffer size size of the buffer with the stored time in <EFBFBD>s
				 * @param[in] _time Time in microsecond of the buffer
				 */
				virtual void setBufferSize(const echrono::microseconds& _time);
				/**
				 * @brief get buffer size in chunk number
				 * @return Number of chunk that can be written in the buffer
				 */
				virtual size_t getBufferSize();
				/**
				 * @brief Set buffer size size of the buffer with the stored time in <EFBFBD>s
				 * @return Time in microsecond that can be written in the buffer
				 */
				virtual echrono::microseconds getBufferSizeMicrosecond();
				/**
				 * @brief Get buffer size filled in chunk number
				 * @return Number of chunk in the buffer (that might be read/write)
				 */
				virtual size_t getBufferFillSize();
				/**
				 * @brief Set buffer size size of the buffer with the stored time in <EFBFBD>s
				 * @return Time in microsecond of the buffer (that might be read/write)
				 */
				virtual echrono::microseconds getBufferFillSizeMicrosecond();
		};
	}
}