MediaSampleSink.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/Timespan.h"
#include "Templates/SharedPointer.h"
#include "Delegates/Delegate.h"
#include "IMediaTimeSource.h"
#include "IMediaTracks.h"
 
class UMediaPlayer;
 
enum class EMediaSampleSinkEvent
{
    Attached,               
    Detached,               
    PlayerPluginChange,     
    SampleDataUpdate,       
    FlushWasRequested,      
    MediaClosed,            
    PlaybackEndReached,     
    PlaybackRateChanged,    
};
 
struct FMediaSampleSinkEventData
{
    union {
        struct
        {
            UMediaPlayer* MediaPlayer;
        } Attached;
        struct
        {
            UMediaPlayer* MediaPlayer;
        } Detached;
        struct
        {
            UMediaPlayer* MediaPlayer;
        } PlayerPluginChange;
        struct
        {
            uint32 Dummy;
        } SampleDataUpdate;
        struct
        {
            UMediaPlayer* MediaPlayer;
        } FlushWasRequested;
        struct
        {
            uint32 Dummy;
        } MediaClosed;
        struct
        {
            uint32 Dummy;
        } PlaybackEndReached;
        struct
        {
            float PlaybackRate;
        } PlaybackRateChanged;
    };
};
 
template<typename SampleType>
class TMediaSampleSink
{
public:
 
    virtual bool Enqueue(const TSharedRef<SampleType, ESPMode::ThreadSafe>& Sample) = 0;
 
    virtual int32 Num() const = 0;
 
    virtual bool CanAcceptSamples(int32 NumSamples) const
    {
        return true;
    }
 
    virtual void RequestFlush() = 0;
 
    virtual uint32 GetFlushCount() const = 0;
 
    void ReceiveEvent(EMediaSampleSinkEvent Event, const FMediaSampleSinkEventData& Data)
    {
        MediaSampleSinkEvent.Broadcast(Event, Data);
    }
 
    DECLARE_EVENT_TwoParams(TMediaSampleSink<SampleType>, FOnMediaSampleSinkEvent, EMediaSampleSinkEvent /*Event*/, const FMediaSampleSinkEventData& /*Data*/)
    FOnMediaSampleSinkEvent& OnMediaSampleSinkEvent()
    {
        return MediaSampleSinkEvent;
    }
 
public:
 
    virtual ~TMediaSampleSink() { }
 
private:
    FOnMediaSampleSinkEvent MediaSampleSinkEvent;
};
 
 
class FMediaAudioSampleSink : public TMediaSampleSink<class IMediaAudioSample>
{
public:
    virtual FMediaTimeStampSample GetAudioTime() const = 0;
    virtual void InvalidateAudioTime() = 0;
};
 
typedef TMediaSampleSink<class IMediaBinarySample> FMediaBinarySampleSink;
 
typedef TMediaSampleSink<class IMediaOverlaySample> FMediaOverlaySampleSink;
 
typedef TMediaSampleSink<class IMediaTextureSample> FMediaTextureSampleSink;