IBufferedAudioOutput.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
 
class FAudioDevice;
 
class IPushableAudioOutput
{
public:
    struct FOnNewBufferParams
    {
        const float* AudioData = nullptr;
        int32 Id = INDEX_NONE;
        int32 NumSamples = INDEX_NONE;
        int32 NumChannels = INDEX_NONE;
        int32 SampleRate = INDEX_NONE;
    };
    virtual void PushNewBuffer(const FOnNewBufferParams&) = 0;  
    virtual void LastBuffer(int32 InId) = 0;
};
 
class IBufferedAudioOutput 
{
protected:
    IBufferedAudioOutput() = default;
 
public:
    virtual ~IBufferedAudioOutput() = default;
 
    struct FBufferFormat
    {
        int32 NumSamplesPerBlock = 0;
        int32 NumChannels = 0;
        int32 NumSamplesPerSec = 0;
 
        bool operator==(const FBufferFormat& InRhs) const
        {
            return InRhs.NumChannels == NumChannels && 
                InRhs.NumSamplesPerBlock == NumSamplesPerBlock && 
                InRhs.NumSamplesPerSec == NumSamplesPerSec;
        }
    };
 
    // Delegates.
    DECLARE_DELEGATE_OneParam(FOnFormatKnown, FBufferFormat);
    virtual void SetFormatKnownDelegate(FOnFormatKnown InFormatKnownDelegate) = 0;
 
    struct FBufferStreamEnd
    {
        int32 Id = INDEX_NONE;
    };
 
    // Delegates.
    DECLARE_DELEGATE_OneParam(FOnBufferStreamEnd, FBufferStreamEnd);
    virtual void SetBufferStreamEndDelegate(FOnBufferStreamEnd InBufferStreamEndDelegate) = 0;
 
    virtual bool Start(FAudioDevice* InAudioDevice) = 0;
    virtual void Stop(FAudioDevice* InAudioDevice) = 0;
 
    virtual bool PopBuffer(float* InBuffer, int32 InBufferSizeInSamples, int32& OutSamplesWritten) = 0;
 
    virtual bool GetFormat(FBufferFormat& OutFormat) const = 0;
 
    virtual void Reserve(int32 InNumSamplesToReserve, int32 InNumSamplesOfSilence = 0) = 0;
 
    virtual IPushableAudioOutput* GetPushableInterface() { return nullptr; }
    virtual const IPushableAudioOutput* GetPushableInterface() const { return nullptr; }
};
 
using FWeakBufferedOutputPtr = TWeakPtr<IBufferedAudioOutput, ESPMode::ThreadSafe>;
using FSharedBufferedOutputPtr = TSharedPtr<IBufferedAudioOutput, ESPMode::ThreadSafe>;