Source.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 "../base/Types.h"
#include "../base/ReferenceCount.h"
#include "../base/Locks.h"

#include <string>
#include <memory>
#include <vector>

//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);

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


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

    class WavFileSource: public Source
    {
    public:
        WavFileSource(const std::string &filename);
        virtual ~WavFileSource();

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

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

    private:
        void LoadFailed();

        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;
    };

#ifdef AUDIO_OGG_VORBIS_ENABLED

    class VorbisFileSource: public Source
    {
    public:
        VorbisFileSource(const std::string &filename);
        VorbisFileSource(const void *pFileInMemory, uint32 memoryLength);
        virtual ~VorbisFileSource();

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

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

    private:
        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;

        //things for reading directly from memory rather than a file
        struct VorbisMemoryData
        {
            inline VorbisMemoryData(): Cursor(0) {}

            std::vector<unsigned char> Data;
            uint32 Cursor;
        } vorbisInMemory;

        static size_t VorbisMemoryRead(void *ptr, size_t size, size_t nmemb, void *datasource);
        static int VorbisMemorySeek(void *datasource, sint64 offset, int whence);
        static int VorbisMemoryClose(void *datasource);
        static long VorbisMemoryTell(void *datasource);

    };
#endif

#ifdef AUDIO_OGG_FLAC_ENABLED
    class InternalMpmaFlacDecoder;

    class FlacFileSource: public Source
    {
    public:
        FlacFileSource(const std::string &filename);
        virtual ~FlacFileSource();

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

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

    private:
        InternalMpmaFlacDecoder *flac;
        std::string filename;

        bool hitEof;

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

    class LoopSource: public Source
    {
    public:
        LoopSource(std::shared_ptr<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 source->IsStereo(); }
        inline nuint GetSampleRate() const { return source->GetSampleRate(); }

    private:
        std::shared_ptr<Source> source;
        nuint loopStart;
        nuint loopEnd;
        nuint currentSample;
    };

    class MonoToStereoSource: public Source
    {
    public:
        MonoToStereoSource(std::shared_ptr<Source> sourceLeft, std::shared_ptr<Source> sourceRight);

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

    private:
        std::shared_ptr<Source> sourceL, sourceR;
    };

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

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

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

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

#endif //#ifdef MPMA_COMPILE_AUDIO