UnrealEngineUWP/Engine/Source/Runtime/SignalProcessing/Public/DSP/WaveShaper.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"

namespace Audio
{
	enum class EWaveShaperType : int32
	{
		Sin,
		ATan,
		Tanh,
		Cubic,
		HardClip
	};

	// A digital wave shaping effect to cause audio distortion
	// https://en.wikipedia.org/wiki/Waveshaper
	class SIGNALPROCESSING_API FWaveShaper
	{
	public:
		// Constructor
		FWaveShaper();

		// Destructor
		~FWaveShaper();

		// Initialize the equalizer
		void Init(const float InSampleRate);

		// Sets the amount of wave shapping. 0.0 is no effect.
		void SetAmount(const float InAmount);

		// Set DC offset before processing
		void SetBias(const float InBias);

		// Sets the output gain of the waveshaper
		void SetOutputGainDb(const float InGainDb);

		// Sets the output gain of the waveshaper
		void SetOutputGainLinear(const float InGainLinear);

		void SetType(const EWaveShaperType InType);

		// Processes one Sample, using ATan
		// Deprecating in favor of ProcessAudioBuffer
		void ProcessAudio(const float InSample, float& OutSample);

		// Process an entire buffer of audio
		void ProcessAudioBuffer(const float* InBuffer, float* OutBuffer, int32 NumFrames);

	private:

		float Amount;
		float OutputGain;
		float Bias;
		EWaveShaperType Type;

		float OneOverAtanAmount;
		float OneOverTanhAmount;

		void ProcessHardClip(const float* InBuffer, float* OutBuffer, int32 NumSamples);
		void ProcessTanh(const float* InBuffer, float* OutBuffer, int32 NumSamples);
		void ProcessATan(const float* InBuffer, float* OutBuffer, int32 NumSamples);
		void ProcessCubic(const float* InBuffer, float* OutBuffer, int32 NumSamples);
		void ProcessSin(const float* InBuffer, float* OutBuffer, int32 NumSamples);
	};

}