Player.h

Go to the documentation of this file.

//Luke Lenhart, 2008-2011
//See /docs/License.txt for details on how this code may be used.

#pragma once

#include "../base/Setup.h"

#ifdef MPMA_COMPILE_AUDIO

#include <list>
#include <vector>
#include <memory>
#include "Source.h"
#include "AL_Include.h"

namespace AUDIO_INTERNAL
{
    class StreamBuffer;
}

namespace AUDIO
{
    enum RenderMode
    {
        POSITIONAL=0x200,
        FIXED
    };

    void SetBackgroundStreaming(bool enable);

    uint32 UpdateStreams();

    class StaticBuffer
    {
    public:
        StaticBuffer(std::shared_ptr<Source> source);

        virtual ~StaticBuffer();

    private:
        ALuint buffer;

        friend class Player;
    };

    class Player
    {
    public:
        static std::shared_ptr<Player> Create(bool allocateNow=false);

        virtual ~Player();

        bool PlayStreaming(std::shared_ptr<Source> source, RenderMode mode, float streamSizeInSeconds=0.2f);

        bool PlayStatic(std::shared_ptr<StaticBuffer> buffer, RenderMode mode);

        void Stop();

        bool IsPlaying() const;

        void SetVolume(float value);
        static void SetDefaultVolume(float value);

        void SetPitchMultiplier(float value);
        static void SetDefaultPitchMultiplier(float value);

        void SetPosition(float x, float y, float z);
        template <typename VectorType>
        inline void SetPosition(const VectorType &pos)
            { SetPosition(pos[0], pos[1], pos[2]); }

        void SetVelocity(float x, float y, float z);
        template <typename VectorType>
        inline void SetVelocity(const VectorType &vel)
            { SetVelocity(vel[0], vel[1], vel[2]); }

        void SetCone(float dirX, float dirY, float dirZ, float coneInnerAngle, float coneOutterAngle, float coneOutterAngleVolume);
        template <typename VectorType>
        inline void SetCone(const VectorType &dir, float coneInnerAngle, float coneOutterAngle, float coneOutterAngleVolume)
            { SetCone(dir[0], dir[1], dir[2], coneInnerAngle, coneOutterAngle, coneOutterAngleVolume); }

        void SetDistanceVolumeLimits(float minVolume, float maxVolume);
        static void SetDefaultDistanceVolumeLimits(float minVolume, float maxVolume);

        void SetReferenceDistance(float value);
        static void SetDefaultReferenceDistance(float value);

        void SetMaxDistance(float value);
        static void SetDefaultMaxDistance(float value);

        void SetRolloffFactor(float value);
        static void SetDefaultRolloffFactor(float value);

        //TODO: effects (reverb etc)

        void SetDefaults();

    private:
        Player();
        void Reset();

        ALuint player; //(openal source) - this is lazy initialized but kept around until the class is freed after that
        bool isStatic; //whether the data is static or being streamed

        //used by for playing static buffers
        std::shared_ptr<StaticBuffer> staticBuffer;

        //used for playing streaming sources
        std::shared_ptr<Source> streamSource;
        std::shared_ptr<AUDIO_INTERNAL::StreamBuffer> streamBuffer;
        std::weak_ptr<Player> self;

        friend class AUDIO_INTERNAL::StreamBuffer;
    };
}

#endif //#ifdef MPMA_COMPILE_AUDIO