/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

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 3 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/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
//////////////////////////////////////////////////////////////////////////////
//																			//
//	plAudioFileReader - Microsoft's way of making our lives difficult when	//
//				  reading in .WMA files. Hacking Winamp's plugins is		//
//				  probably easier...										//
//																			//
//////////////////////////////////////////////////////////////////////////////

#ifndef _plAudioFileReader_h
#define _plAudioFileReader_h

#include "plAudioCore.h"
#include "hsTemplates.h"

//// Class Definition ////////////////////////////////////////////////////////

class plUnifiedTime;
class plWAVHeader;
class plAudioFileReader
{
public:
	virtual ~plAudioFileReader() {}
	virtual plWAVHeader	&GetHeader( void ) = 0;

	enum StreamType
	{
		kStreamRAM,		// Stream from a WAV loaded into RAM
		kStreamWAV,		// Stream from a WAV on disk
		kStreamNative,	// Stream from the native type (ie, an Ogg on disk)
	};

	virtual void	Open(){}
	virtual void	Close( void ) = 0;

	virtual UInt32	GetDataSize( void ) = 0;
	virtual float	GetLengthInSecs( void ) = 0;

	virtual hsBool	SetPosition( UInt32 numBytes ) = 0;
	virtual hsBool	Read( UInt32 numBytes, void *buffer ) = 0;
	virtual UInt32	NumBytesLeft( void ) = 0;

	virtual hsBool	OpenForWriting( const char *path, plWAVHeader &header ) { return false; }
	virtual UInt32	Write( UInt32 bytes, void *buffer ) { return 0; }

	virtual hsBool	IsValid( void ) = 0;

	static plAudioFileReader* CreateReader(const char* path, plAudioCore::ChannelSelect whichChan = plAudioCore::kAll, StreamType type = kStreamWAV);
	static plAudioFileReader* CreateWriter(const char* path, plWAVHeader& header);

	// Decompresses a compressed file to the cache directory
	static void	CacheFile(const char* path, bool splitChannels=false, bool noOverwrite=false);

protected:
	static void IGetCachedPath(const char* path, char* cachedPath, plAudioCore::ChannelSelect whichChan);
	static void ICacheFile(const char* path, bool noOverwrite, plAudioCore::ChannelSelect whichChan);	
};

#endif //_plAudioFileReader_h