AVFrame wrapper - the frame (decoded image/audio sample data) holder. More...

#include <Media_Frame.hxx>

Inheritance diagram for Media_Frame:

Public Member Functions
	Media_Frame ()
	Empty constructor.

virtual	~Media_Frame ()
	Destructor.

bool	IsEmpty () const
	Return true if frame does not contain any data.

void	Unref ()
	av_frame_unref() wrapper.

Graphic3d_Vec2i	Size () const
	Return image dimensions.

int	SizeX () const
	Return image width.

int	SizeY () const
	Return image height.

int	Format () const
	Return pixel format (AVPixelFormat).

bool	IsFullRangeYUV () const
	Return TRUE if YUV range is full.

uint8_t *	Plane (int thePlaneId) const
	Access data plane for specified Id.

int	LineSize (int thePlaneId) const

int64_t	BestEffortTimestamp () const

const AVFrame *	Frame () const
	Return frame.

AVFrame *	ChangeFrame ()
	Return frame.

double	Pts () const
	Return presentation timestamp (PTS).

void	SetPts (double thePts)
	Set presentation timestamp (PTS).

float	PixelAspectRatio () const
	Return PAR.

void	SetPixelAspectRatio (float theRatio)
	Set PAR.

bool	IsLocked () const
	Return locked state.

void	SetLocked (bool theToLock)
	Lock/free frame for edition.

bool	InitWrapper (const Handle< Image_PixMap > &thePixMap)
	Wrap allocated image pixmap.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Image_Format	FormatFFmpeg2Occt (int theFormat)
	Convert pixel format from FFmpeg (AVPixelFormat) to OCCT.

static int	FormatOcct2FFmpeg (Image_Format theFormat)
	Convert pixel format from OCCT to FFmpeg (AVPixelFormat). Returns -1 (AV_PIX_FMT_NONE) if undefined.

static void	Swap (const Handle< Media_Frame > &theFrame1, const Handle< Media_Frame > &theFrame2)
	Swap AVFrame* within two frames.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Attributes
AVFrame *	myFrame
	frame

double	myFramePts
	presentation timestamp

float	myPixelRatio
	pixel aspect ratio

bool	myIsLocked
	locked state

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

AVFrame wrapper - the frame (decoded image/audio sample data) holder.

Constructor & Destructor Documentation

◆ Media_Frame()

Media_Frame::Media_Frame ( )

Empty constructor.

◆ ~Media_Frame()

virtual Media_Frame::~Media_Frame ( )

virtual

Destructor.

Member Function Documentation

◆ BestEffortTimestamp()

int64_t Media_Frame::BestEffortTimestamp ( ) const

Returns: frame timestamp estimated using various heuristics, in stream time base

◆ ChangeFrame()

AVFrame * Media_Frame::ChangeFrame ( )

inline

Return frame.

◆ Format()

int Media_Frame::Format ( ) const

Return pixel format (AVPixelFormat).

◆ FormatFFmpeg2Occt()

static Image_Format Media_Frame::FormatFFmpeg2Occt ( int theFormat )

static

Convert pixel format from FFmpeg (AVPixelFormat) to OCCT.

◆ FormatOcct2FFmpeg()

static int Media_Frame::FormatOcct2FFmpeg ( Image_Format theFormat )

static

Convert pixel format from OCCT to FFmpeg (AVPixelFormat). Returns -1 (AV_PIX_FMT_NONE) if undefined.

◆ Frame()

const AVFrame * Media_Frame::Frame ( ) const

inline

Return frame.

◆ InitWrapper()

bool Media_Frame::InitWrapper ( const Handle< Image_PixMap > & thePixMap )

Wrap allocated image pixmap.

◆ IsEmpty()

bool Media_Frame::IsEmpty ( ) const

Return true if frame does not contain any data.

◆ IsFullRangeYUV()

bool Media_Frame::IsFullRangeYUV ( ) const

Return TRUE if YUV range is full.

◆ IsLocked()

bool Media_Frame::IsLocked ( ) const

inline

Return locked state.

◆ LineSize()

int Media_Frame::LineSize ( int thePlaneId ) const

Returns: linesize in bytes for specified data plane

◆ PixelAspectRatio()

float Media_Frame::PixelAspectRatio ( ) const

inline

Return PAR.

◆ Plane()

uint8_t * Media_Frame::Plane ( int thePlaneId ) const

Access data plane for specified Id.

◆ Pts()

double Media_Frame::Pts ( ) const

inline

Return presentation timestamp (PTS).

◆ SetLocked()

void Media_Frame::SetLocked ( bool theToLock )

inline

Lock/free frame for edition.

◆ SetPixelAspectRatio()

void Media_Frame::SetPixelAspectRatio ( float theRatio )

inline

Set PAR.

◆ SetPts()

void Media_Frame::SetPts ( double thePts )

inline

Set presentation timestamp (PTS).

◆ Size()

Graphic3d_Vec2i Media_Frame::Size ( ) const

inline

Return image dimensions.

◆ SizeX()

int Media_Frame::SizeX ( ) const

Return image width.

◆ SizeY()

int Media_Frame::SizeY ( ) const

Return image height.

◆ Swap()

static void Media_Frame::Swap	(	const Handle< Media_Frame > &	theFrame1,
		const Handle< Media_Frame > &	theFrame2 )

static

Swap AVFrame* within two frames.

◆ Unref()

void Media_Frame::Unref ( )

av_frame_unref() wrapper.

Field Documentation

◆ myFrame

AVFrame* Media_Frame::myFrame

protected

frame

◆ myFramePts

double Media_Frame::myFramePts

protected

presentation timestamp

◆ myIsLocked

bool Media_Frame::myIsLocked

protected

locked state

◆ myPixelRatio

float Media_Frame::myPixelRatio

protected

pixel aspect ratio

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

Media_Frame.hxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Media_Frame()

◆ ~Media_Frame()

Member Function Documentation

◆ BestEffortTimestamp()

◆ ChangeFrame()

◆ Format()

◆ FormatFFmpeg2Occt()

◆ FormatOcct2FFmpeg()

◆ Frame()

◆ InitWrapper()

◆ IsEmpty()

◆ IsFullRangeYUV()

◆ IsLocked()

◆ LineSize()

◆ PixelAspectRatio()

◆ Plane()

◆ Pts()

◆ SetLocked()

◆ SetPixelAspectRatio()

◆ SetPts()

◆ Size()

◆ SizeX()

◆ SizeY()

◆ Swap()

◆ Unref()

Field Documentation

◆ myFrame

◆ myFramePts

◆ myIsLocked

◆ myPixelRatio