BansheeEngine/Source/BansheeOpenAudio/Include/BsOAFileReader.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsOAPrerequisites.h"

namespace BansheeEngine
{
	/** @addtogroup OpenAudio
	 *  @{
	 */

	/** Interface used for implementations that parse audio formats into a set of samples. */
	class OAFileReader
	{
	public:
		virtual ~OAFileReader() { }

		/** 
		 * Attempts to open audio data from the provided stream. Must be called before any reads or seeks. 
		 *
		 * @param[in]	stream	Data stream audio data is stored in.
		 * @param[out]	info	Output information describing meta-data of the audio in the stream.
		 * @return				True if the data is valid, false otherwise.
		 */
		virtual bool open(const SPtr<DataStream>& stream, AudioFileInfo& info) = 0;

		/** 
		 * Moves the read pointer to the specified offset. Any further read() calls will read from this location. User must
		 * ensure not to seek past the end of the data.
		 *
		 * @param[in]	offset	Offset to move the pointer in. In number of samples.
		 */
		virtual void seek(UINT32 offset) = 0;

		/**
		 * Reads a set of samples from the audio data.
		 *
		 * @param[out]	samples		Pre-allocated buffer to store the samples in.
		 * @param[in]	numSamples	Number of samples to read.
		 * @return					Number of samples that were actually read (can be less than requested if the more data
		 *							in the stream).
		 *
		 * @note 8-bit sample data is returned as unsigned values, while higher bit-depth all use signed values.
		 */
		virtual UINT32 read(UINT8* samples, UINT32 numSamples) = 0;

		/** 
		 * Checks if the data in the provided stream valid audio data for the current format. You should check this before
		 * calling open().
		 */
		virtual bool isValid(const SPtr<DataStream>& stream) = 0;
	};

	/** @} */
}