UnrealEngine/Engine/Plugins/Media/ElectraPlayer/Source/ElectraPlayerRuntime/Private/Runtime/OutputHandlerVideo.cpp

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

#include "OutputHandler.h"

namespace Electra
{

	FOutputHandlerVideo::FOutputHandlerVideo()
	{
	}

	FOutputHandlerVideo::~FOutputHandlerVideo()
	{
		// TBD: Would there be a reason to explicitly unbind the delegates or reset the output texture pool?
	}

	bool FOutputHandlerVideo::PreparePool(const FParamDict& InParameters)
	{
		// How many samples are asked for?
		NumOutputSamples = (int32) InParameters.GetValue(OutputHandlerOptionKeys::NumBuffers).SafeGetInt64(0);
		// Set this in this pool's configuration.
		PoolProperties.Set(OutputHandlerOptionKeys::NumBuffers, FVariantValue((int64)NumOutputSamples));
		// For now this is all we do. The pool itself is not being limited.
		return true;
	}

	void FOutputHandlerVideo::ClosePool()
	{
		ensure(PendingOutputSamples.IsEmpty());
		NumOutputSamples = 0;
		PoolProperties.Clear();
	}

	const FParamDict& FOutputHandlerVideo::GetPoolProperties()
	{
		return PoolProperties;
	}

	void FOutputHandlerVideo::SetClock(TSharedPtr<IMediaRenderClock, ESPMode::ThreadSafe> InClock)
	{
		Clock = MoveTemp(InClock);
	}

	void FOutputHandlerVideo::StartOutput()
	{
		SendAllPendingSamples();
		bSendOutput = true;
	}

	void FOutputHandlerVideo::StopOutput()
	{
		bSendOutput = false;
	}

	void FOutputHandlerVideo::Flush()
	{
		// Anything not sent yet we unbind our release notification callback and just drop here.
		PendingOutputSamplesLock.Lock();
		while(PendingOutputSamples.Num())
		{
			FPendingSample ps = PendingOutputSamples[0];
			PendingOutputSamples.RemoveAt(0);
			ps.Sample->GetReleaseDelegate().Unbind();
			PendingOutputSamplesLock.Unlock();
			ps.Sample.Reset();
			PendingOutputSamplesLock.Lock();
		}
		PendingOutputSamplesLock.Unlock();

		// Notify the registered sample flush delegate.
		if (!bIsDetached)
		{
			OutputQueueFlushSamplesDelegate().ExecuteIfBound();
		}

		// Anything that has not been returned by now we drop from the sample info stats.
		EnqueuedSampleInfosLock.Lock();
		EnqueuedSampleInfos.Empty();
		EnqueuedSampleDuration = FTimespan::Zero();
		EnqueuedSampleInfosLock.Unlock();

		// Allow sending the next first frame right away again.
		bDidSendFirst = false;
	}

	FTimespan FOutputHandlerVideo::GetEnqueuedSampleDuration()
	{
		FScopeLock lock(&EnqueuedSampleInfosLock);
		return EnqueuedSampleDuration;
	}

	void FOutputHandlerVideo::GetEnqueuedSampleInfo(TArray<FEnqueuedSampleInfo>& OutOptionalSampleInfos)
	{
		FScopeLock lock(&EnqueuedSampleInfosLock);
		OutOptionalSampleInfos = EnqueuedSampleInfos;
	}

	void FOutputHandlerVideo::SetOutputTexturePool(TSharedPtr<FElectraTextureSamplePool, ESPMode::ThreadSafe> InOutputTexturePool)
	{
		OutputTexturePool = MoveTemp(InOutputTexturePool);
	}

	void FOutputHandlerVideo::DetachPlayer()
	{
		bIsDetached = true;
	}

	FOutputHandlerVideo::FCanOutputQueueReceive& FOutputHandlerVideo::CanOutputQueueReceiveDelegate()
	{
		return CanOutputQueueReceiveDlg;
	}

	FOutputHandlerVideo::FOutputQueueReceiveSample& FOutputHandlerVideo::OutputQueueReceiveSampleDelegate()
	{
		return OutputQueueReceiveSampleDlg;
	}

	FOutputHandlerVideo::FOutputQueueFlushSamples& FOutputHandlerVideo::OutputQueueFlushSamplesDelegate()
	{
		return OutputQueueFlushSamplesDlg;
	}

	bool FOutputHandlerVideo::CanReceiveOutputSample()
	{
		if (bIsDetached)
		{
			return false;
		}
		bool bCanRcv = true;
		PendingOutputSamplesLock.Lock();
		int32 NumPendingOutputSamples = PendingOutputSamples.Num();
		PendingOutputSamplesLock.Unlock();
		if (1 + NumPendingOutputSamples > NumOutputSamples)
		{
			return false;
		}
		CanOutputQueueReceiveDelegate().ExecuteIfBound(bCanRcv, 1 + NumPendingOutputSamples);
		return bCanRcv;
	}

	IOutputHandlerBase::EBufferResult FOutputHandlerVideo::ObtainOutputSample(FElectraTextureSamplePtr& OutTextureSample)
	{
		if (OutputTexturePool)
		{
			OutTextureSample = OutputTexturePool->AcquireShared();
			return IOutputHandlerBase::EBufferResult::Ok;
		}
		return IOutputHandlerBase::EBufferResult::NoBuffer;
	}

	void FOutputHandlerVideo::ReturnOutputSample(FElectraTextureSamplePtr InTextureSampleToReturn, EReturnSampleType InSendToOutputQueueType)
	{
		if (InTextureSampleToReturn && InSendToOutputQueueType != EReturnSampleType::DontSendToQueue && !bIsDetached)
		{
			uint64 SampleID = ++NextSampleID;

			// Log the timestamp and duration of the sample
			FEnqueuedSampleInfo si;
			si.Timestamp = InTextureSampleToReturn->GetTime();
			si.Duration = InTextureSampleToReturn->GetDuration();
			si.SampleID = SampleID;
			si.bIsDummy = InSendToOutputQueueType == EReturnSampleType::DummySample;
			EnqueuedSampleInfosLock.Lock();
			EnqueuedSampleDuration += si.Duration;
			EnqueuedSampleInfos.Emplace(si);	// do not move, this is needed below.
			EnqueuedSampleInfosLock.Unlock();

			// Set our notification callback when the sample is being returned to the pool.
			InTextureSampleToReturn->GetReleaseDelegate().BindThreadSafeSP(AsShared(), &FOutputHandlerVideo::ReleaseSampleToPool, SampleID);

			// When not sending output, send the first frame anyway to get displayed when scrubbing.
			bool bHoldBack = !bSendOutput && bDidSendFirst;
			if (!bHoldBack)
			{
				bDidSendFirst = true;
				// Do not pass up dummy samples. We only keep them tracked for their duration
				// to ensure the pipeline is not running dry.
				if (!si.bIsDummy)
				{
					OutputQueueReceiveSampleDelegate().ExecuteIfBound(InTextureSampleToReturn);
				}
			}
			else
			{
				FPendingSample ps;
				ps.SampleInfo = si;
				ps.Sample = MoveTemp(InTextureSampleToReturn);
				PendingOutputSamplesLock.Lock();
				PendingOutputSamples.Emplace(MoveTemp(ps));
				PendingOutputSamplesLock.Unlock();
			}
		}
	}

	void FOutputHandlerVideo::SendAllPendingSamples()
	{
		PendingOutputSamplesLock.Lock();
		while(PendingOutputSamples.Num())
		{
			FPendingSample ps = PendingOutputSamples[0];
			PendingOutputSamples.RemoveAt(0);
			PendingOutputSamplesLock.Unlock();
			if (!bIsDetached && !ps.SampleInfo.bIsDummy)
			{
				OutputQueueReceiveSampleDelegate().ExecuteIfBound(MoveTemp(ps.Sample));
			}
			ps.Sample.Reset();
			PendingOutputSamplesLock.Lock();
		}
		PendingOutputSamplesLock.Unlock();
	}

	void FOutputHandlerVideo::ReleaseSampleToPool(IElectraTextureSampleBase* InTextureSampleToReturn, uint64 InSampleID)
	{
		FTimeValue RenderTime;

		// Remove the sample stats.
		FEnqueuedSampleInfo si;
		EnqueuedSampleInfosLock.Lock();
		for(int32 i=0, iMax=EnqueuedSampleInfos.Num(); i<iMax; ++i)
		{
			if (EnqueuedSampleInfos[i].SampleID == InSampleID)
			{
				RenderTime.SetFromTimespan(EnqueuedSampleInfos[i].Timestamp.GetTime(), EnqueuedSampleInfos[i].Timestamp.GetIndexValue());
				EnqueuedSampleDuration -= EnqueuedSampleInfos[i].Duration;
				EnqueuedSampleInfos.RemoveAt(i);
				break;
			}
		}
		EnqueuedSampleInfosLock.Unlock();

		if (Clock && RenderTime.IsValid())
		{
			Clock->SetCurrentTime(IMediaRenderClock::ERendererType::Video, RenderTime);
		}
	}



} // namespace Electra