AVFormatContext wrapper - the media input/output stream holder. More...

#include <Media_FormatContext.hxx>

Inheritance diagram for Media_FormatContext:

Public Member Functions
	Media_FormatContext ()
	Constructor.

	~Media_FormatContext () override
	Destructor.

AVFormatContext *	Context () const
	Return context.

bool	OpenInput (const TCollection_AsciiString &theInput)
	Open input.

void	Close ()
	Close input.

unsigned int	NbSteams () const
	Return amount of streams.

const AVStream &	Stream (unsigned int theIndex) const
	Return stream.

TCollection_AsciiString	StreamInfo (unsigned int theIndex, AVCodecContext *theCodecCtx=nullptr) const
	Format stream info.

double	PtsStartBase () const
	Return PTS start base in seconds.

double	Duration () const
	Return duration in seconds.

bool	ReadPacket (const occ::handle< Media_Packet > &thePacket)
	av_read_frame() wrapper.

bool	SeekStream (unsigned int theStreamId, double theSeekPts, bool toSeekBack)
	Seek stream to specified position.

bool	Seek (double theSeekPts, bool toSeekBack)
	Seek context to specified position.

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 ()=default
	Destructor must be virtual.

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

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

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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

Static Public Member Functions
static TCollection_AsciiString	FormatAVErrorDescription (int theErrCodeAV)
	Returns string description for AVError code.

static double	FormatUnitsToSeconds (int64_t theTimeUnits)
	Convert time units into seconds for context.

static double	UnitsToSeconds (const AVRational &theTimeBase, int64_t theTimeUnits)
	Convert time units into seconds. Returns zero for invalid value.

static double	StreamUnitsToSeconds (const AVStream &theStream, int64_t theTimeUnits)
	Convert time units into seconds using stream base.

static int64_t	SecondsToUnits (double theTimeSeconds)
	Convert seconds into time units for context.

static int64_t	SecondsToUnits (const AVRational &theTimeBase, double theTimeSeconds)
	Convert seconds into time units.

static int64_t	StreamSecondsToUnits (const AVStream &theStream, double theTimeSeconds)
	Convert seconds into time units for stream.

static TCollection_AsciiString	FormatTime (double theSeconds)
	Time formatter.

static TCollection_AsciiString	FormatTimeProgress (double theProgress, double theDuration)
	Time progress / duration formatter.

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
AVFormatContext *	myFormatCtx
	format context

double	myPtsStartBase
	start time

double	myDuration
	duration

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

Detailed Description

AVFormatContext wrapper - the media input/output stream holder.

Constructor & Destructor Documentation

◆ Media_FormatContext()

Media_FormatContext::Media_FormatContext ( )

Constructor.

◆ ~Media_FormatContext()

Media_FormatContext::~Media_FormatContext ( )

override

Destructor.

Member Function Documentation

◆ Close()

void Media_FormatContext::Close ( )

Close input.

◆ Context()

AVFormatContext * Media_FormatContext::Context ( ) const

inline

Return context.

◆ Duration()

double Media_FormatContext::Duration ( ) const

inline

Return duration in seconds.

◆ FormatAVErrorDescription()

static TCollection_AsciiString Media_FormatContext::FormatAVErrorDescription ( int theErrCodeAV )

static

Returns string description for AVError code.

◆ FormatTime()

static TCollection_AsciiString Media_FormatContext::FormatTime ( double theSeconds )

static

Time formatter.

◆ FormatTimeProgress()

static TCollection_AsciiString Media_FormatContext::FormatTimeProgress	(	double	theProgress,
		double	theDuration )

static

Time progress / duration formatter.

◆ FormatUnitsToSeconds()

static double Media_FormatContext::FormatUnitsToSeconds ( int64_t theTimeUnits )

static

Convert time units into seconds for context.

Parameters

theTimeUnits value to convert

Returns: converted time units in seconds

◆ NbSteams()

unsigned int Media_FormatContext::NbSteams ( ) const

Return amount of streams.

◆ OpenInput()

bool Media_FormatContext::OpenInput ( const TCollection_AsciiString & theInput )

Open input.

◆ PtsStartBase()

double Media_FormatContext::PtsStartBase ( ) const

inline

Return PTS start base in seconds.

◆ ReadPacket()

bool Media_FormatContext::ReadPacket ( const occ::handle< Media_Packet > & thePacket )

av_read_frame() wrapper.

◆ SecondsToUnits() [1/2]

static int64_t Media_FormatContext::SecondsToUnits	(	const AVRational &	theTimeBase,
		double	theTimeSeconds )

static

Convert seconds into time units.

Parameters

theTimeBase	the timebase
theTimeSeconds	value to convert

Returns: time units

◆ SecondsToUnits() [2/2]

static int64_t Media_FormatContext::SecondsToUnits ( double theTimeSeconds )

static

Convert seconds into time units for context.

Parameters

theTimeSeconds value to convert

Returns: time units

◆ Seek()

bool Media_FormatContext::Seek	(	double	theSeekPts,
		bool	toSeekBack )

Seek context to specified position.

◆ SeekStream()

bool Media_FormatContext::SeekStream	(	unsigned int	theStreamId,
		double	theSeekPts,
		bool	toSeekBack )

Seek stream to specified position.

◆ Stream()

const AVStream & Media_FormatContext::Stream ( unsigned int theIndex ) const

Return stream.

◆ StreamInfo()

TCollection_AsciiString Media_FormatContext::StreamInfo	(	unsigned int	theIndex,
		AVCodecContext *	theCodecCtx = nullptr ) const

Format stream info.

◆ StreamSecondsToUnits()

static int64_t Media_FormatContext::StreamSecondsToUnits	(	const AVStream &	theStream,
		double	theTimeSeconds )

static

Convert seconds into time units for stream.

Parameters

theStream	the stream
theTimeSeconds	value to convert

Returns: time units

◆ StreamUnitsToSeconds()

static double Media_FormatContext::StreamUnitsToSeconds	(	const AVStream &	theStream,
		int64_t	theTimeUnits )

static

Convert time units into seconds using stream base.

Parameters

theStream	the stream;
theTimeUnits	value to convert;

Returns: converted time units in seconds.

◆ UnitsToSeconds()

static double Media_FormatContext::UnitsToSeconds	(	const AVRational &	theTimeBase,
		int64_t	theTimeUnits )

static

Convert time units into seconds. Returns zero for invalid value.

Parameters

theTimeBase	the timebase
theTimeUnits	value to convert

Returns: converted time units in seconds

Field Documentation

◆ myDuration

double Media_FormatContext::myDuration

protected

duration

◆ myFormatCtx

AVFormatContext* Media_FormatContext::myFormatCtx

protected

format context

◆ myPtsStartBase

double Media_FormatContext::myPtsStartBase

protected

start time

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

Media_FormatContext.hxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Media_FormatContext()

◆ ~Media_FormatContext()

Member Function Documentation

◆ Close()

◆ Context()

◆ Duration()

◆ FormatAVErrorDescription()

◆ FormatTime()

◆ FormatTimeProgress()

◆ FormatUnitsToSeconds()

◆ NbSteams()

◆ OpenInput()

◆ PtsStartBase()

◆ ReadPacket()

◆ SecondsToUnits() [1/2]

◆ SecondsToUnits() [2/2]

◆ Seek()

◆ SeekStream()

◆ Stream()

◆ StreamInfo()

◆ StreamSecondsToUnits()

◆ StreamUnitsToSeconds()

◆ UnitsToSeconds()

Field Documentation

◆ myDuration

◆ myFormatCtx

◆ myPtsStartBase