ConvolutionAlgorithm.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Features/IModularFeature.h"
 
namespace Audio
{
    struct FConvolutionSettings
    {
        bool bEnableHardwareAcceleration = true;
 
        int32 BlockNumSamples = 256;
 
        int32 NumInputChannels = 0;
 
        int32 NumOutputChannels = 0;
 
        int32 NumImpulseResponses = 0;
 
        int32 MaxNumImpulseResponseSamples = 0;
 
        bool operator==(const FConvolutionSettings& Other)
        {
            return bEnableHardwareAcceleration == Other.bEnableHardwareAcceleration
                && BlockNumSamples == Other.BlockNumSamples
                && NumInputChannels == Other.NumInputChannels
                && NumOutputChannels == Other.NumOutputChannels
                && NumImpulseResponses == Other.NumImpulseResponses
                && MaxNumImpulseResponseSamples == Other.MaxNumImpulseResponseSamples;
        }
 
        bool operator!=(const FConvolutionSettings& Other)
        {
            return !(*this == Other);
        }
    };
 
 
    class IConvolutionAlgorithm 
    {
        public:
 
            virtual ~IConvolutionAlgorithm() {}
 
            virtual int32 GetNumSamplesInBlock() const = 0;
 
            virtual int32 GetNumAudioInputs() const = 0;
 
            virtual int32 GetNumAudioOutputs() const = 0;
 
            virtual void ProcessAudioBlock(const float* const InSamples[], float* const OutSamples[]) = 0;
 
            virtual void ResetAudioHistory() = 0;
 
            virtual int32 GetMaxNumImpulseResponseSamples() const = 0;
 
 
            virtual int32 GetNumImpulseResponses() const = 0;
 
            virtual int32 GetNumImpulseResponseSamples(int32 InImpulseResponseIndex) const = 0;
 
            virtual void SetImpulseResponse(int32 InImpulseResponseIndex, const float* InSamples, int32 NumSamples) = 0;
 
            virtual void SetMatrixGain(int32 InAudioInputIndex, int32 InImpulseResponseIndex, int32 InAudioOutputIndex, float InGain) = 0;
 
            virtual float GetMatrixGain(int32 InAudioInputIndex, int32 InImpulseResponseIndex, int32 InAudioOutputIndex) const = 0;
    };
 
    class IConvolutionAlgorithmFactory : public IModularFeature
    {
        public:
            SIGNALPROCESSING_API virtual ~IConvolutionAlgorithmFactory();
 
            static SIGNALPROCESSING_API const FName GetModularFeatureName();
 
            virtual const FName GetFactoryName() const = 0;
 
            virtual bool IsHardwareAccelerated() const = 0;
 
            virtual bool AreConvolutionSettingsSupported(const FConvolutionSettings& InSettings) const = 0;
 
            virtual TUniquePtr<IConvolutionAlgorithm> NewConvolutionAlgorithm(const FConvolutionSettings& InSettings) = 0;
    };
 
    class FConvolutionFactory
    {
        public:
            static SIGNALPROCESSING_API const FName AnyAlgorithmFactory;
 
            static SIGNALPROCESSING_API TUniquePtr<IConvolutionAlgorithm> NewConvolutionAlgorithm(const FConvolutionSettings& InSettings, const FName& InAlgorithmFactoryName = AnyAlgorithmFactory);
    };
}