source.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL 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 2, or (at your option)
 * any later version.

 * NEVRAX NEL 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 NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_SOURCE_H
#define NL_SOURCE_H
#include <nel/misc/types_nl.h>

#include <nel/misc/vector.h>
#include "sound_driver.h"

#define NLSOUND_MIN_GAIN 0.0f

#define NLSOUND_MAX_GAIN 1.0f

#define NLSOUND_MIN_PITCH 0.0f

#define NLSOUND_MAX_PITCH 8.0f

#define NLSOUND_DEFAULT_GAIN 1.0f

#define NLSOUND_DEFAULT_PITCH 1.0f

#define NLSOUND_DEFAULT_DIRECT_GAIN 1.0f

#define NLSOUND_DEFAULT_EFFECT_GAIN 1.0f

#define NLSOUND_DEFAULT_FILTER_PASS_HF 5000.0f

#define NLSOUND_DEFAULT_FILTER_PASS_LF 250.0f

#define NLSOUND_DEFAULT_FILTER_PASS_GAIN 1.0f

namespace NLSOUND {
    class IBuffer;
    class ILoader;
    class IEffect;

class ISource
{
public:
    enum TFilter
    {
        FilterLowPass, 
        FilterBandPass, 
        FilterHighPass, 
    };
    
    ISource() { }
    virtual ~ISource() { }
    


    virtual void setStreaming(bool streaming = true) = 0;
    virtual void setStaticBuffer(IBuffer *buffer) = 0;
    virtual IBuffer *getStaticBuffer() = 0;
    virtual void submitStreamingBuffer(IBuffer *buffer) = 0;
    virtual uint countStreamingBuffers() const = 0;
    


    virtual void setLooping(bool l = true) = 0;
    virtual bool getLooping() const = 0;
    
    virtual bool play() = 0;
    virtual void stop() = 0;
    virtual void pause() = 0;
    virtual bool isPlaying() const = 0;
    virtual bool isStopped() const = 0;
    virtual bool isPaused() const = 0;
    virtual uint32 getTime() = 0;
    


    virtual void setPos(const NLMISC::CVector& pos, bool deffered = true) = 0;
    virtual const NLMISC::CVector &getPos() const = 0;
    virtual void setVelocity(const NLMISC::CVector& vel, bool deferred = true) = 0;
    virtual void getVelocity(NLMISC::CVector& vel) const = 0;
    virtual void setDirection(const NLMISC::CVector& dir) = 0;
    virtual void getDirection(NLMISC::CVector& dir) const = 0;
    virtual void setGain(float gain = NLSOUND_DEFAULT_GAIN) = 0;
    virtual float getGain() const = 0;
    virtual void setPitch(float pitch = NLSOUND_DEFAULT_PITCH) = 0;
    virtual float getPitch() const = 0;
    virtual void setSourceRelativeMode(bool mode = true) = 0;
    virtual bool getSourceRelativeMode() const = 0;
    virtual void setMinMaxDistances(float mindist, float maxdist, bool deferred = true) = 0;
    virtual void getMinMaxDistances(float& mindist, float& maxdist) const = 0;
    virtual void setCone(float innerAngle, float outerAngle, float outerGain) = 0;
    virtual void getCone(float& innerAngle, float& outerAngle, float& outerGain) const = 0;
    virtual void setAlpha(double a) = 0;
    


    virtual void setDirect(bool enable = true) = 0;
    virtual bool getDirect() const = 0;
    virtual void setDirectGain(float gain = NLSOUND_DEFAULT_DIRECT_GAIN) = 0;
    virtual float getDirectGain() const = 0;
    
    virtual void enableDirectFilter(bool enable = true) = 0;
    virtual bool isDirectFilterEnabled() const = 0;
    virtual void setDirectFilter(TFilter filter, float lowFrequency = NLSOUND_DEFAULT_FILTER_PASS_LF, float highFrequency = NLSOUND_DEFAULT_FILTER_PASS_HF, float passGain = NLSOUND_DEFAULT_FILTER_PASS_GAIN) = 0;
    virtual void getDirectFilter(TFilter &filterType, float &lowFrequency, float &highFrequency, float &passGain) const = 0;
    virtual void setDirectFilterPassGain(float passGain = NLSOUND_DEFAULT_FILTER_PASS_GAIN) = 0;
    virtual float getDirectFilterPassGain() const = 0;
    


    virtual void setEffect(IReverbEffect *reverbEffect) = 0;
    virtual IEffect *getEffect() const = 0;
    virtual void setEffectGain(float gain = NLSOUND_DEFAULT_EFFECT_GAIN) = 0;
    virtual float getEffectGain() const = 0;
    
    virtual void enableEffectFilter(bool enable = true) = 0;
    virtual bool isEffectFilterEnabled() const = 0;
    virtual void setEffectFilter(TFilter filter, float lowFrequency = NLSOUND_DEFAULT_FILTER_PASS_LF, float highFrequency = NLSOUND_DEFAULT_FILTER_PASS_HF, float passGain = NLSOUND_DEFAULT_FILTER_PASS_GAIN) = 0;
    virtual void getEffectFilter(TFilter &filterType, float &lowFrequency, float &highFrequency, float &passGain) const = 0;
    virtual void setEffectFilterPassGain(float passGain = NLSOUND_DEFAULT_FILTER_PASS_GAIN) = 0;
    virtual float getEffectFilterPassGain() const = 0;
    
protected:
    
    // common method used only with OptionManualRolloff. return the volume in 1/100th DB  ( = mB)modified
    static sint32 computeManualRollOff(sint32 volumeMB, sint32 mbMin, sint32 mbMax, double alpha, float sqrdist, float distMin, float distMax);
    // common method used only with OptionManualRolloff. return the rolloff in amplitude ratio (gain)
    static float computeManualRolloff(double alpha, float sqrdist, float distMin, float distMax);
};


} // NLSOUND


#endif // NL_SOURCE_H

/* End of source.h */