// Copyright (c) 2008-2010 Raynaldo (Wildicv) Rivera, Joshua (Dark_Kilauea) Jones
// This file is part of the "cAudio Engine"
// For conditions of distribution and use, see copyright notice in cAudio.h

#ifndef IAUDIOMANAGER_H
#define IAUDIOMANAGER_H

#include "IListener.h"
#include "cAudioDefines.h"
#include "EAudioFormats.h"
#include "IAudioEffects.h"
#include "IDataSourceFactory.h"
#include "IManagerEventHandler.h"

namespace cAudio
{
	class IAudioSource;
	class IAudioDecoderFactory;

    class IAudioManager
    {
    public:
		IAudioManager() { }
		virtual ~IAudioManager() { }

		//!Inits the audio manager calling the alut/etc start ups
		virtual bool initialize(const char* deviceName = 0x0, int outputFrequency = -1, int eaxEffectSlots = 4) = 0;
		//!Shuts everything down
		virtual void shutDown() = 0;
		//!Updates the cAudio playback
		virtual void update() = 0;
		//!Returns an IAudio object by its "name" and 0 if the name is not found
		virtual IAudioSource* getSoundByName(const char* name) = 0;
		//!Releases "ALL" cAudio objects (but does not shutdown the manager)
		virtual void releaseAllSources() = 0;
		//!Releases a single cAudio source
		virtual void release(IAudioSource* source) = 0;

		//! Returns the name of an available playback device.
		/** \param index: Specify which name to retrieve ( Range: 0 to getAvailableDeviceCount()-1 ) */
		virtual const char* getAvailableDeviceName(unsigned int index) = 0;
		//! Returns the number of playback devices available for use.
		virtual unsigned int getAvailableDeviceCount() = 0;
		//! Returns the name of the default system playback device.
		virtual const char* getDefaultDeviceName() = 0;
		
		//!Creates the cAudio object using the highest priority data source that has it
		virtual IAudioSource* create(const char* name, const char* filename, bool stream = false) = 0;
		//!Loads audio from memory or virtual file system
		virtual IAudioSource* createFromMemory(const char* name, const char* data, size_t length, const char* extension) = 0;
		//!Loads raw audio from memory.
		virtual IAudioSource* createFromRaw(const char* name, const char* data, size_t length, unsigned int frequency, AudioFormats format) = 0;

		//!Register Audio Codec
		virtual bool registerAudioDecoder(IAudioDecoderFactory* factory, const char* extension) = 0;
		//!Unregister Audio Codec (allows you to prevent an file type from being playable with new sound sources)
		//!Note that all current sound sources will still continue to use any currently allocated decoders.
		//!Will NOT delete any user added factory instance, you must do that yourself
		virtual void unRegisterAudioDecoder(const char* extension) = 0;
		//!Returns whether an audio decoder is currently registered for this file type
		virtual bool isAudioDecoderRegistered(const char* extension) = 0;
		//!Returns a registered audio decoder factory
		virtual IAudioDecoderFactory* getAudioDecoderFactory(const char* extension) = 0;
		//!Unregisters all Audio Codecs
		//!Note that all current sound sources will still continue to use any currently allocated decoders.
		//!Will NOT delete any user added factory instance, you must do that yourself
		virtual void unRegisterAllAudioDecoders() = 0;

		virtual bool registerDataSource(IDataSourceFactory* factory, const char* name, int priority) = 0;
		virtual void unRegisterDataSource(const char* name) = 0;
		virtual bool isDataSourceRegistered(const char* name) = 0;
		virtual IDataSourceFactory* getDataSourceFactory(const char* name) = 0;
		virtual void unRegisterAllDataSources() = 0;

		//!Registers a new event handler to the manager
		virtual void registerEventHandler(IManagerEventHandler* handler) = 0;
		//!Unregisters specified event handler from manager
		virtual void unRegisterEventHandler(IManagerEventHandler* handler) = 0;
		//!Unregisters all event handlers attached to the manager
		virtual void unRegisterAllEventHandlers() = 0;

		//!Returns an interface for the listener
		virtual IListener* getListener() = 0;

#ifdef CAUDIO_EFX_ENABLED
		virtual IAudioEffects* getEffects() = 0;
#endif

    protected:
    private:
    };

    //! Creates an interface to an Audio Manager
	/** Note: This is the only way to get access to the audio playback capabilities of cAudio.
	You must delete this interface using destroyAudioManager() once you are done with it.
	\param initializeDefault: Whether to return an object initialized with the default settings.  If set to false, you must make a call to initialize before you can create audio sources
	\return A pointer to the created object, NULL if the object could not be allocated.
	*/
	CAUDIO_API IAudioManager* createAudioManager(bool initializeDefault = true);

	//! Destroys an interface to a previously created Audio Manager and frees the memory allocated for it
	/** 
	\param capture: The object to destroy
	*/
	CAUDIO_API void destroyAudioManager(IAudioManager* manager);

	//! Returns if the thread used to update all Audio Managers is running
	/** Note: Will always return false if threading is disabled.
	The library automatically shuts down the thread if no Audio Managers exist and will restart the thread on creation of a new manager.
	\return True if the thread is currently running, false otherwise.
	*/
	CAUDIO_API bool isAudioManagerThreadRunning();
}
#endif //! IAUDIOMANAGER_H