// Copyright (c) 2006, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   * Redistributions of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//   * Neither the name of the Aegisub Group nor the names of its contributors
//     may be used to endorse or promote products derived from this software
//     without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$

/// @file audio_provider_stream.h
/// @see audio_provider_stream.cpp
/// @ingroup audio_input
///


#pragma once


///////////
// Headers
#include <list>
#include <vector>
#include "include/aegisub/audio_provider.h"



/// DOCME
/// @class StreamAudioProvider
/// @brief DOCME
///
/// DOCME
class StreamAudioProvider : public AudioProvider {
private:

	/// DOCME
	/// @class BufferChunk
	/// @brief DOCME
	///
	/// DOCME
	class BufferChunk {
	public:

		/// DOCME
		std::vector<short> buf;

		/// DOCME
		bool isFree;
		BufferChunk();
	};


	/// DOCME
	std::list<BufferChunk*> buffer;

	/// DOCME
	int startPos;

	/// DOCME
	int endPos;

	/// DOCME
	int bufLen;


	/// DOCME
	int buffered;

	/// DOCME
	bool hasBuf;

public:
	StreamAudioProvider();
	~StreamAudioProvider();

	// The AreSamplesNativeEndian() method is intentionally missing.
	// This class was used with the experimental scrubbing code but never
	// used outside that.
	// The method is left out to make it break compilation in case it does
	// get used again, so it can get a review and stuff.

	void GetAudio(void *buf, int64_t start, int64_t count);
	void Append(void *buf, int64_t count);
	void SetParams(int channels,int rate,int bps);
};


