Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
CDVDOverlayContainer Class Reference

#include <DVDOverlayContainer.h>

Inheritance diagram for CDVDOverlayContainer:
CCriticalSection XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >

Public Member Functions

 CDVDOverlayContainer ()
 
virtual ~CDVDOverlayContainer ()
 
void ProcessAndAddOverlayIfValid (CDVDOverlay *pPicture)
 Adds an overlay into the container by processing the existing overlay collection first. More...
 
VecOverlaysGetOverlays ()
 
bool ContainsOverlayType (DVDOverlayType type)
 
void Clear ()
 
void Flush ()
 
void CleanUp (double pts)
 
size_t GetSize ()
 
void UpdateOverlayInfo (const std::shared_ptr< CDVDInputStreamNavigator > &pStream, CDVDDemuxSPU *pSpu, int iAction)
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Additional Inherited Members

- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

Constructor & Destructor Documentation

◆ CDVDOverlayContainer()

CDVDOverlayContainer::CDVDOverlayContainer ( )
default

◆ ~CDVDOverlayContainer()

CDVDOverlayContainer::~CDVDOverlayContainer ( )
virtual

Member Function Documentation

◆ CleanUp()

void CDVDOverlayContainer::CleanUp ( double  pts)

◆ Clear()

void CDVDOverlayContainer::Clear ( )

◆ ContainsOverlayType()

bool CDVDOverlayContainer::ContainsOverlayType ( DVDOverlayType  type)

◆ Flush()

void CDVDOverlayContainer::Flush ( )

◆ GetOverlays()

VecOverlays * CDVDOverlayContainer::GetOverlays ( )

◆ GetSize()

size_t CDVDOverlayContainer::GetSize ( )

◆ ProcessAndAddOverlayIfValid()

void CDVDOverlayContainer::ProcessAndAddOverlayIfValid ( CDVDOverlay pPicture)

Adds an overlay into the container by processing the existing overlay collection first.

Processes the overlay collection whenever a new overlay is added. Useful to change the overlay's PTS values of previously added overlays if the collection itself is sequential. This is, for example, the case of ASS subtitles in which a single call to ass_render_frame generates all the subtitle images on a single call even if two subtitles exist at the same time frame. Other cases might exist where an overlay shouldn't be added to the collection if completely contained in another overlay.

Parameters
pPicturepointer to the overlay to be evaluated and possibly added to the collection

◆ UpdateOverlayInfo()

void CDVDOverlayContainer::UpdateOverlayInfo ( const std::shared_ptr< CDVDInputStreamNavigator > &  pStream,
CDVDDemuxSPU pSpu,
int  iAction 
)

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