VorbisAudioInfo.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    VorbisAudioInfo.h: Unreal audio vorbis decompression interface object.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/ThreadSafeBool.h"
#include "AudioDecompress.h"
 
#ifndef WITH_OGGVORBIS
    #define WITH_OGGVORBIS 0
#endif
 
#ifndef WITH_OGGVORBIS_DLL
    #define WITH_OGGVORBIS_DLL (PLATFORM_WINDOWS)
#endif
 
 
namespace VorbisChannelInfo
{
    extern VORBISAUDIODECODER_API const int32 Order[8][8];
}
 
VORBISAUDIODECODER_API void LoadVorbisLibraries();
#if WITH_OGGVORBIS
 
class FVorbisAudioInfo : public ICompressedAudioInfo
{
public:
    VORBISAUDIODECODER_API FVorbisAudioInfo( void );
    VORBISAUDIODECODER_API virtual ~FVorbisAudioInfo( void );
    size_t          ReadMemory( void *ptr, uint32 size );
    int             SeekMemory( uint32 offset, int whence );
    int             CloseMemory( void );
    long            TellMemory( void );
 
    size_t          ReadStreaming( void *ptr, uint32 size );
    int             CloseStreaming( void );
 
    bool GetCompressedInfoCommon(void*  Callbacks, FSoundQualityInfo* QualityInfo);
 
    VORBISAUDIODECODER_API virtual bool ReadCompressedInfo( const uint8* InSrcBufferData, uint32 InSrcBufferDataSize, struct FSoundQualityInfo* QualityInfo ) override;
    VORBISAUDIODECODER_API virtual bool ReadCompressedData( uint8* InDestination, bool bLooping, uint32 BufferSize ) override;
    VORBISAUDIODECODER_API virtual void SeekToTime( const float SeekTime ) override;
    VORBISAUDIODECODER_API virtual void SeekToFrame(const uint32 SeekFrame) override;
    VORBISAUDIODECODER_API virtual void ExpandFile( uint8* DstBuffer, struct FSoundQualityInfo* QualityInfo ) override;
    VORBISAUDIODECODER_API virtual void EnableHalfRate( bool HalfRate ) override;
    virtual uint32 GetSourceBufferSize() const override { return SrcBufferDataSize; }
 
    virtual bool UsesVorbisChannelOrdering() const override { return true; }
    virtual int GetStreamBufferSize() const override { return MONO_PCM_BUFFER_SIZE; }
 
    // Additional overrides for streaming
    virtual bool SupportsStreaming() const override {return true;}
    virtual bool StreamCompressedData(uint8* InDestination, bool bLooping, uint32 BufferSize, int32& OutNumBytesStreamed) override;
    virtual int32 GetCurrentChunkIndex() const override {return CurrentStreamingChunkIndex;}
    virtual int32 GetCurrentChunkOffset() const override {return BufferOffset % CurrentStreamingChunksSize;}
    virtual bool HasError() const override;
    // End of ICompressedAudioInfo Interface
 
protected:
    virtual bool StreamCompressedInfoInternal(const FSoundWaveProxyPtr& InWaveProxy, struct FSoundQualityInfo* QualityInfo) override;
 
    friend class FAudioFormatOgg;
    VORBISAUDIODECODER_API int32 GetAudioDataStartOffset() const;
private:
    using Super = ICompressedAudioInfo; 
    const uint8* GetLoadedChunk(FSoundWaveProxyPtr InSoundWave, uint32 ChunkIndex, uint32& OutChunkSize);
 
    struct FVorbisFileWrapper* VFWrapper;
    const uint8* SrcBufferData;
    uint32 SrcBufferDataSize;
    uint32 BufferOffset;
    uint32 CurrentBufferChunkOffset;
 
    // In case Ogg Vorbis fails to return any compressed audio for an asset,
    // we use this counter to exit out of the decoder's while loop early.
    int32 TimesLoopedWithoutDecompressedAudio;
 
    mutable FCriticalSection VorbisCriticalSection;
 
    uint8 const* CurrentStreamingChunkData;
    int32 CurrentStreamingChunkIndex;
    int32 NextStreamingChunkIndex;
    uint32 CurrentStreamingChunksSize;
    bool bHeaderParsed;
    bool bHasError = false;
    int32 LastErrorCode = 0;
 
    // This handle is used to ensure that a chunk currently being decoded isn't evicted until we are done with it.
    FAudioChunkHandle CurCompressedChunkHandle;
};
#endif