StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Display Class Referenceabstract

Consumer-owned combined video, audio and subtitle presentation sink. More...

#include <StormByte/multimedia/display.hxx>

Public Member Functions

 Display ()=default
 Construct a sink.
 Display (const Display &)=delete
 Display (Display &&)=delete
virtual ~Display () noexcept=default
 Release this sink, not managed by player Close.
Display & operator= (const Display &)=delete
Display & operator= (Display &&)=delete
virtual void Invalidate (std::uint64_t epoch, bool active_video)=0
 Flush presentation and synchronously invalidate old deliveries.
virtual bool InvalidateAudio (std::uint64_t epoch)
 Flush only audio while retaining video, cues and the delivery epoch.
virtual void Pause (bool paused, std::uint64_t epoch)=0
 Freeze or resume device audio and subtitle timers; invalidate an old pause timer.
virtual void Video (Safe::Shared< const PreviewVideo > image)=0
 Present an owned image after its scheduled time.
virtual void Audio (Safe::Shared< const PreviewAudio > audio)=0
 Queue a PCM block without blocking for playback.
virtual void Subtitle (Safe::Shared< const PreviewSubtitle > subtitle)=0
 Present a cue; expire it at m_end on the supplied media clock.
virtual AudioPresentation AudioClock (std::uint64_t epoch)=0
 Read current epoch's audio device cursor and latency.
virtual void Position (double position, std::uint64_t epoch)=0
 Advance subtitle timing, including when audio is disabled.
virtual bool Drained (std::uint64_t epoch)=0
 Whether all queued audio and GUI deliveries have completed.

Detailed Description

Consumer-owned combined video, audio and subtitle presentation sink.

Callbacks run on worker or control-caller threads and must be bounded and thread-safe. Do not reenter any player method. Throw on device or delivery failure. Maintain bounded audio and GUI queues; audio starts at most the player's PreviewBuffering::AudioAhead (500 ms by default) ahead, plus the duration of the submitted block. Invalidate synchronously publishes a new epoch, flushes audio and cues, and clears the old image even when video remains active. Queued GUI deliveries must check that epoch at execution, not merely enqueue time. The consumer implements its Qt/SDL/native integration; destruction of a player never closes this shared widget or its application.

Constructor & Destructor Documentation

◆ Display() [1/3]

StormByte::Multimedia::Display::Display ( )
default

Construct a sink.

◆ Display() [2/3]

StormByte::Multimedia::Display::Display ( const Display & )
delete

◆ Display() [3/3]

StormByte::Multimedia::Display::Display ( Display && )
delete

◆ ~Display()

virtual StormByte::Multimedia::Display::~Display ( )
virtualdefaultnoexcept

Release this sink, not managed by player Close.

Member Function Documentation

◆ Audio()

virtual void StormByte::Multimedia::Display::Audio ( Safe::Shared< const PreviewAudio > audio)
pure virtual

Queue a PCM block without blocking for playback.

Parameters
audioOwned samples with timeline position.

◆ AudioClock()

virtual AudioPresentation StormByte::Multimedia::Display::AudioClock ( std::uint64_t epoch)
pure virtual

Read current epoch's audio device cursor and latency.

Parameters
epochCurrent generation.
Returns
Device clock feedback.

◆ Drained()

virtual bool StormByte::Multimedia::Display::Drained ( std::uint64_t epoch)
pure virtual

Whether all queued audio and GUI deliveries have completed.

Parameters
epochCurrent generation.
Returns
True only after presentation has drained.

◆ Invalidate()

virtual void StormByte::Multimedia::Display::Invalidate ( std::uint64_t epoch,
bool active_video )
pure virtual

Flush presentation and synchronously invalidate old deliveries.

Parameters
epochNew generation.
active_videoWhether an ordinary video track is selected.

◆ InvalidateAudio()

virtual bool StormByte::Multimedia::Display::InvalidateAudio ( std::uint64_t epoch)
inlinevirtual

Flush only audio while retaining video, cues and the delivery epoch.

Parameters
epochCurrent generation.
Returns
True when audio was flushed; false without changing presentation if unsupported, in which case track selection uses the legacy global seek.

Serialized with all sink callbacks. Reset device clock validity and pending PCM synchronously. The player reapplies Pause before sending new audio.

◆ operator=() [1/2]

Display & StormByte::Multimedia::Display::operator= ( const Display & )
delete

◆ operator=() [2/2]

Display & StormByte::Multimedia::Display::operator= ( Display && )
delete

◆ Pause()

virtual void StormByte::Multimedia::Display::Pause ( bool paused,
std::uint64_t epoch )
pure virtual

Freeze or resume device audio and subtitle timers; invalidate an old pause timer.

Parameters
pausedWhether presentation is paused.
epochCurrent generation.

◆ Position()

virtual void StormByte::Multimedia::Display::Position ( double position,
std::uint64_t epoch )
pure virtual

Advance subtitle timing, including when audio is disabled.

Parameters
positionMedia seconds; frozen during pause.
epochCurrent generation.

◆ Subtitle()

virtual void StormByte::Multimedia::Display::Subtitle ( Safe::Shared< const PreviewSubtitle > subtitle)
pure virtual

Present a cue; expire it at m_end on the supplied media clock.

Parameters
subtitleOwned cue. Preserve overlapping cue identities.

Empty m_regions clears m_id, or all cues when m_id is zero. Infinite m_end remains active until such a clear; Position expires finite cues.

◆ Video()

virtual void StormByte::Multimedia::Display::Video ( Safe::Shared< const PreviewVideo > image)
pure virtual

Present an owned image after its scheduled time.

Parameters
imageImage; reject stale epochs at GUI execution.

The documentation for this class was generated from the following file: