IAudioSource.h

// 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 IAUDIOSOURCE_H
#define IAUDIOSOURCE_H

#include "cAudioDefines.h"
#include "IRefCounted.h"
#include "IAudioDecoder.h"
#include "cVector3.h"
#include "IEffect.h"
#include "IFilter.h"
#include "ISourceEventHandler.h"

namespace cAudio
{
    class IAudioSource : public IRefCounted
    {
    public:
                IAudioSource() {}
                virtual ~IAudioSource() {}


                virtual bool play() = 0;


                virtual bool play2d(const bool& toLoop = false) = 0;


                virtual bool play3d(const cVector3& position, const float& soundstr = 1.0 , const bool& toLoop = false) = 0;
                
                virtual void pause() = 0;

                virtual void stop() = 0;


                virtual void loop(const bool& toLoop) = 0;


                virtual bool seek(const float& seconds, bool relative = false) = 0;

                virtual float getTotalAudioTime() = 0;

                virtual int getTotalAudioSize() = 0;

                virtual int getCompressedAudioSize() = 0;

                virtual float getCurrentAudioTime() = 0;

                virtual int getCurrentAudioPosition() = 0;

                virtual int getCurrentCompressedAudioPosition() = 0;

                virtual bool update() = 0;

                virtual void release() = 0;

                virtual const bool isValid() const = 0;

                virtual const bool isPlaying() const = 0;

                virtual const bool isPaused() const = 0;

                virtual const bool isStopped() const = 0;

                virtual const bool isLooping() const = 0;


                virtual void setPosition(const cVector3& position) = 0;


                virtual void setVelocity(const cVector3& velocity) = 0;


                virtual void setDirection(const cVector3& direction) = 0;


                virtual void setRolloffFactor(const float& rolloff) = 0;


                virtual void setStrength(const float& soundstrength) = 0;


                virtual void setMinDistance(const float& minDistance) = 0;


                virtual void setMaxDistance(const float& maxDistance) = 0;


                virtual void setPitch(const float& pitch) = 0;


                virtual void setVolume(const float& volume) = 0;


                virtual void setMinVolume(const float& minVolume) = 0;


                virtual void setMaxVolume(const float& maxVolume) = 0;


                virtual void setInnerConeAngle(const float& innerAngle) = 0;


                virtual void setOuterConeAngle(const float& outerAngle) = 0;


                virtual void setOuterConeVolume(const float& outerVolume) = 0;


                virtual void setDopplerStrength(const float& dstrength) = 0; 


                virtual void setDopplerVelocity(const cVector3& dvelocity) = 0;


                virtual void move(const cVector3& position) = 0;

                virtual const cVector3 getPosition() const = 0;

                virtual const cVector3 getVelocity() const = 0;

                virtual const cVector3 getDirection() const = 0;

                virtual const float getRolloffFactor() const = 0;

                virtual const float getStrength() const = 0;

                virtual const float getMinDistance() const = 0;

                virtual const float getMaxDistance() const = 0;

                virtual const float getPitch() const = 0;

                virtual const float getVolume() const = 0;

                virtual const float getMinVolume() const = 0;

                virtual const float getMaxVolume() const = 0;

                virtual const float getInnerConeAngle() const = 0;

                virtual const float getOuterConeAngle() const = 0;

                virtual const float getOuterConeVolume() const = 0;

                virtual const float getDopplerStrength() const = 0;

                virtual const cVector3 getDopplerVelocity() const = 0;


                virtual void registerEventHandler(ISourceEventHandler* handler) = 0;


                virtual void unRegisterEventHandler(ISourceEventHandler* handler) = 0;

                virtual void unRegisterAllEventHandlers() = 0;

#ifdef CAUDIO_EFX_ENABLED
                virtual unsigned int getNumEffectSlotsAvailable() const = 0;


                virtual bool attachEffect(unsigned int slot, IEffect* effect) = 0;


                virtual void removeEffect(unsigned int slot) = 0;


                virtual bool attachFilter(IFilter* filter) = 0;

                virtual void removeFilter() = 0;
#endif

    protected:
    private:
    };
};
#endif