Source.h

Go to the documentation of this file.

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

#pragma once

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

#ifdef MPMA_COMPILE_AUDIO

#include "../base/Types.h"
#include "../base/ReferenceCount.h"
#include "../base/Locks.h"

#include <string>

//forward declarations
struct OggVorbis_File;

namespace AUDIO
{
    const nuint FINITE_DATA=(nuint)(0-2);
    const nuint INFINITE_DATA=(nuint)(0-1);

    class Source
    {
    public:
        Source();
        virtual ~Source();

        virtual nuint FillData(void *data, nuint maxSamples)=0;

        virtual nuint GetRemainingSamples() const=0;

        virtual bool IsStereo() const=0;

        virtual nuint GetSampleRate() const=0;

        virtual void Seek(nuint sampleNumber=0);

        virtual Source* Duplicate()=0;

        virtual void FreeDuplicate(Source *source)=0;

        inline nuint GetSampleSize() const
            { return IsStereo()?4:2; }
    };


    // -- below are a several convenient implementations of Source

    //used by LoopSource to store its state.
    struct SharedLoopSourceData
    {
        Source *source;
        nuint loopStart;
        nuint loopEnd;
        nuint currentSample;

        inline SharedLoopSourceData(): source(0)
        {}
        ~SharedLoopSourceData();
    };

    class LoopSource: public Source, public MPMA::ReferenceCountedData<SharedLoopSourceData>
    {
    public:
        LoopSource(Source &source, nuint loopStartSample=0, nuint loopEndSample=~0);

        virtual nuint FillData(void *data, nuint maxSamples);
        inline nuint GetRemainingSamples() const { return INFINITE_DATA; }
        inline bool IsStereo() const { return Data().source->IsStereo(); }
        inline nuint GetSampleRate() const { return Data().source->GetSampleRate(); }
        virtual LoopSource* Duplicate();
        virtual void FreeDuplicate(Source *source);
    };

    //used by WavFileSource to store its state.
    struct SharedWavFileSourceData
    {
        inline SharedWavFileSourceData(): fileHandle(0), rate(0), sourceBits(0), isStereo(false), dataStartSeekPos(0), hitEof(false), bad(0)
            {}

        void *fileHandle;
        std::string filename;
        nuint rate;
        nuint sourceBits;
        bool isStereo;
        nuint dataStartSeekPos;

        bool hitEof;

        Source *bad; //bad source to use if we failed to load
        MPMA::SpinLock lock;
    };

    class WavFileSource: public Source, public MPMA::ReferenceCountedData<SharedWavFileSourceData>
    {
    public:
        WavFileSource(const std::string &filename);
        virtual ~WavFileSource();

        inline bool IsLoaded() const
            { return Data().fileHandle!=0; }

        virtual nuint FillData(void *data, nuint maxSamples);
        virtual nuint GetRemainingSamples() const;
        virtual bool IsStereo() const;
        virtual nuint GetSampleRate() const;
        virtual WavFileSource* Duplicate();
        virtual void FreeDuplicate(Source *source);
        virtual void Seek(nuint sampleNumber=0);

    private:
        void LoadFailed();
    };

#ifdef AUDIO_OGG_VORBIS_ENABLED
    //used by VorbisFileSource to store its state.
    struct SharedVorbisFileSourceData
    {
        inline SharedVorbisFileSourceData(): vorbisFile(0), rate(0), sourceBits(0), isStereo(false), hitEof(false), bad(0)
            {}

        OggVorbis_File *vorbisFile;
        std::string filename;
        nuint rate;
        nuint sourceBits;
        bool isStereo;

        bool hitEof;

        Source *bad; //bad source to use if we failed to load
        MPMA::SpinLock lock;
    };

    class VorbisFileSource: public Source, public MPMA::ReferenceCountedData<SharedVorbisFileSourceData>
    {
    public:
        VorbisFileSource(const std::string &filename);
        virtual ~VorbisFileSource();

        inline bool IsLoaded() const
            { return Data().vorbisFile!=0; }

        virtual nuint FillData(void *data, nuint maxSamples);
        virtual nuint GetRemainingSamples() const;
        virtual bool IsStereo() const;
        virtual nuint GetSampleRate() const;
        virtual VorbisFileSource* Duplicate();
        virtual void FreeDuplicate(Source *source);
        virtual void Seek(nuint sampleNumber=0);
    };
#endif

#ifdef AUDIO_OGG_FLAC_ENABLED
    class InternalMpmaFlacDecoder;

    //used by FlacFileSource to store its state.
    struct SharedFlacFileSourceData
    {
        inline SharedFlacFileSourceData(): flac(0), hitEof(false), bad(0)
            {}

        InternalMpmaFlacDecoder *flac;
        std::string filename;

        bool hitEof;

        Source *bad; //bad source to use if we failed to load
        MPMA::SpinLock lock;
    };

    class FlacFileSource: public Source, public MPMA::ReferenceCountedData<SharedFlacFileSourceData>
    {
    public:
        FlacFileSource(const std::string &filename);
        virtual ~FlacFileSource();

        inline bool IsLoaded() const
            { return Data().flac!=0; }

        virtual nuint FillData(void *data, nuint maxSamples);
        virtual nuint GetRemainingSamples() const;
        virtual bool IsStereo() const;
        virtual nuint GetSampleRate() const;
        virtual FlacFileSource* Duplicate();
        virtual void FreeDuplicate(Source *source);
        virtual void Seek(nuint sampleNumber=0);
    };
#endif

    //used by MonoToStereoSource to store its state
    struct SharedMonoToStereoSourceData
    {
        Source *sourceL, *sourceR;

        inline SharedMonoToStereoSourceData(): sourceL(0), sourceR(0)
            {}
        inline ~SharedMonoToStereoSourceData()
        {
            if (sourceL) sourceL->FreeDuplicate(sourceL);
            if (sourceR) sourceR->FreeDuplicate(sourceR);
        }
    };

    class MonoToStereoSource: public Source, public MPMA::ReferenceCountedData<SharedMonoToStereoSourceData>
    {
    public:
        MonoToStereoSource(Source &sourceLeft, Source &sourceRight);

        virtual nuint FillData(void *data, nuint maxSamples);
        virtual nuint GetRemainingSamples() const;
        virtual bool IsStereo() const;
        virtual nuint GetSampleRate() const;
        virtual MonoToStereoSource* Duplicate();
        virtual void FreeDuplicate(Source *source);
        virtual void Seek(nuint sampleNumber=0);
    };

    class EmptySource: public Source
    {
    public:
        virtual nuint FillData(void *data, nuint maxSamples);
        virtual nuint GetRemainingSamples() const;
        virtual bool IsStereo() const;
        virtual nuint GetSampleRate() const;
        virtual EmptySource* Duplicate();
        virtual void FreeDuplicate(Source *source);
    };

    class WhiteNoiseSource: public Source
    {
    public:
        WhiteNoiseSource(float seconds=0, nuint sampleRate=44100);

        virtual nuint FillData(void *data, nuint maxSamples);
        virtual nuint GetRemainingSamples() const;
        virtual bool IsStereo() const;
        virtual nuint GetSampleRate() const;
        virtual WhiteNoiseSource* Duplicate();
        virtual void FreeDuplicate(Source *source);
        virtual void Seek(nuint sampleNumber=0);

    private:
        nuint samplesRemaining;
        nuint rate;
        float origTimeLeft;
        uint32 lastSample;
    };
}

#endif //#ifdef MPMA_COMPILE_AUDIO