Files
UnrealEngineUWP/Engine/Source/Runtime/GameplayMediaEncoder/Public/GameplayMediaEncoder.h
Rob Gay 3edb251273 - Move to using SharedPtr/Refs for Submix listeners & deprecate old references, moving clients where possible to be constructed as shared pointers
- Deprecate more references to "master" submixes, labeling the single "main" submix as such and reverb, eq, etc. as "required" submixes
#rb max.hayes
#jira none
#rnx
#fyi sondra.moyls
#fyi William.Belcher
#fyi jimmy.smith
#fyi jeremie.roy

[CL 27148564 by Rob Gay in ue5-main branch]
2023-08-16 14:28:25 -04:00

162 lines
5.1 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "ISubmixBufferListener.h"
#include "Logging/LogMacros.h"
#include "AudioMixerDevice.h"
#include "RHI.h"
#include "RHIResources.h"
#include "HAL/Thread.h"
THIRD_PARTY_INCLUDES_START
#pragma warning(push)
#pragma warning(disable: 4596 6319 6323)
#pragma warning(pop)
THIRD_PARTY_INCLUDES_END
#include "AudioEncoder.h"
#include "VideoEncoder.h"
#include "MediaPacket.h"
#include "Templates/SharedPointer.h"
#include "Templates/SharedPointerInternals.h"
#include "VideoEncoderInput.h"
class SWindow;
class IGameplayMediaEncoderListener
{
public:
virtual void OnMediaSample(const AVEncoder::FMediaPacket& Sample) = 0;
};
class FGameplayMediaEncoder final : public ISubmixBufferListener, public AVEncoder::IAudioEncoderListener
{
public:
/**
* Get the singleton
*/
static GAMEPLAYMEDIAENCODER_API FGameplayMediaEncoder* Get();
GAMEPLAYMEDIAENCODER_API ~FGameplayMediaEncoder();
GAMEPLAYMEDIAENCODER_API bool RegisterListener(IGameplayMediaEncoderListener* Listener);
GAMEPLAYMEDIAENCODER_API void UnregisterListener(IGameplayMediaEncoderListener* Listener);
GAMEPLAYMEDIAENCODER_API void SetVideoBitrate(uint32 Bitrate);
GAMEPLAYMEDIAENCODER_API void SetVideoFramerate(uint32 Framerate);
///**
// * Returns the audio codec name and configuration
// */
//TPair<FString, AVEncoder::FAudioConfig> GetAudioConfig() const;
//TPair<FString, AVEncoder::FVideoConfig> GetVideoConfig() const;
GAMEPLAYMEDIAENCODER_API bool Initialize();
GAMEPLAYMEDIAENCODER_API void Shutdown();
GAMEPLAYMEDIAENCODER_API bool Start();
GAMEPLAYMEDIAENCODER_API void Stop();
static void InitializeCmd()
{
// We call Get(), so it creates the singleton
Get()->Initialize();
}
static void ShutdownCmd()
{
// We call Get(), so it creates the singleton
Get()->Shutdown();
}
static void StartCmd()
{
// We call Get(), so it creates the singleton
Get()->Start();
}
static void StopCmd()
{
// We call Get(), so it creates the singleton
Get()->Stop();
}
GAMEPLAYMEDIAENCODER_API AVEncoder::FAudioConfig GetAudioConfig() const;
AVEncoder::FVideoConfig GetVideoConfig() const { return VideoConfig; }
private:
template <typename ObjectType, ESPMode Mode>
friend class SharedPointerInternals::TIntrusiveReferenceController;
// Private to control how our single instance is created
GAMEPLAYMEDIAENCODER_API FGameplayMediaEncoder();
// Returns how long it has been recording for.
GAMEPLAYMEDIAENCODER_API FTimespan GetMediaTimestamp() const;
// Back buffer capture
GAMEPLAYMEDIAENCODER_API void OnFrameBufferReady(SWindow& SlateWindow, const FTexture2DRHIRef& FrameBuffer);
// ISubmixBufferListener interface
GAMEPLAYMEDIAENCODER_API const FString& GetListenerName() const override;
GAMEPLAYMEDIAENCODER_API void OnNewSubmixBuffer(const USoundSubmix* OwningSubmix, float* AudioData, int32 NumSamples, int32 NumChannels, const int32 SampleRate, double AudioClock) override;
GAMEPLAYMEDIAENCODER_API void ProcessAudioFrame(const float* AudioData, int32 NumSamples, int32 NumChannels, int32 SampleRate);
GAMEPLAYMEDIAENCODER_API void ProcessVideoFrame(const FTexture2DRHIRef& FrameBuffer);
GAMEPLAYMEDIAENCODER_API void UpdateVideoConfig();
GAMEPLAYMEDIAENCODER_API void OnEncodedAudioFrame(const AVEncoder::FMediaPacket& Packet) override;
GAMEPLAYMEDIAENCODER_API void OnEncodedVideoFrame(uint32 LayerIndex, const TSharedPtr<AVEncoder::FVideoEncoderInputFrame> Frame, const AVEncoder::FCodecPacket& Packet);
GAMEPLAYMEDIAENCODER_API TSharedPtr<AVEncoder::FVideoEncoderInputFrame> ObtainInputFrame();
GAMEPLAYMEDIAENCODER_API void CopyTexture(const FTexture2DRHIRef& SourceTexture, FTexture2DRHIRef& DestinationTexture) const;
GAMEPLAYMEDIAENCODER_API void FloatToPCM16(float const* floatSamples, int32 numSamples, TArray<int16>& out) const;
FCriticalSection ListenersCS;
TArray<IGameplayMediaEncoderListener*> Listeners;
FCriticalSection AudioProcessingCS;
FCriticalSection VideoProcessingCS;
TUniquePtr<AVEncoder::FAudioEncoder> AudioEncoder;
AVEncoder::FVideoConfig VideoConfig;
TUniquePtr<AVEncoder::FVideoEncoder> VideoEncoder;
TSharedPtr<AVEncoder::FVideoEncoderInput> VideoEncoderInput;
uint64 NumCapturedFrames = 0;
FTimespan StartTime = 0;
// Instead of using the AudioClock parameter ISubmixBufferListener::OnNewSubmixBuffer gives us, we calculate our own, by
// advancing it as we receive more data.
// This is so that we can adjust the clock if things get out of sync, such as if we break into the debugger.
double AudioClock = 0;
FTimespan LastVideoInputTimestamp = 0;
bool bAudioFormatChecked = false;
bool bDoFrameSkipping = false;
friend class FGameplayMediaEncoderModule;
static GAMEPLAYMEDIAENCODER_API TSharedPtr<FGameplayMediaEncoder, ESPMode::ThreadSafe> Singleton;
// live streaming: quality adaptation to available uplink b/w
TAtomic<uint32> NewVideoBitrate{ 0 };
FThreadSafeBool bChangeBitrate = false;
TAtomic<uint32> NewVideoFramerate{ 0 };
FThreadSafeBool bChangeFramerate = false;
TArray<int16> PCM16;
TMap<TSharedPtr<AVEncoder::FVideoEncoderInputFrame>, FTexture2DRHIRef> BackBuffers;
};