Open CASCADE Technology  7.4.1.dev
Public Member Functions | Static Public Member Functions | Protected Attributes
Media_FormatContext Class Reference

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

#include <Media_FormatContext.hxx>

Inheritance diagram for Media_FormatContext:
Inheritance graph
[legend]

Public Member Functions

 Media_FormatContext ()
 Constructor. More...
 
virtual ~Media_FormatContext ()
 Destructor. More...
 
AVFormatContext * Context () const
 Return context. More...
 
bool OpenInput (const TCollection_AsciiString &theInput)
 Open input. More...
 
void Close ()
 Close input. More...
 
unsigned int NbSteams () const
 Return amount of streams. More...
 
const AVStream & Stream (unsigned int theIndex) const
 Return stream. More...
 
TCollection_AsciiString StreamInfo (unsigned int theIndex, AVCodecContext *theCodecCtx=NULL) const
 Format stream info. More...
 
double PtsStartBase () const
 Return PTS start base in seconds. More...
 
double Duration () const
 Return duration in seconds. More...
 
bool ReadPacket (const Handle< Media_Packet > &thePacket)
 av_read_frame() wrapper. More...
 
bool SeekStream (unsigned int theStreamId, double theSeekPts, bool toSeekBack)
 Seek stream to specified position. More...
 
bool Seek (double theSeekPts, bool toSeekBack)
 Seek context to specified position. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static TCollection_AsciiString FormatAVErrorDescription (int theErrCodeAV)
 Returns string description for AVError code. More...
 
static double FormatUnitsToSeconds (int64_t theTimeUnits)
 Convert time units into seconds for context. More...
 
static double UnitsToSeconds (const AVRational &theTimeBase, int64_t theTimeUnits)
 Convert time units into seconds. Returns zero for invalid value. More...
 
static double StreamUnitsToSeconds (const AVStream &theStream, int64_t theTimeUnits)
 Convert time units into seconds using stream base. More...
 
static int64_t SecondsToUnits (double theTimeSeconds)
 Convert seconds into time units for context. More...
 
static int64_t SecondsToUnits (const AVRational &theTimeBase, double theTimeSeconds)
 Convert seconds into time units. More...
 
static int64_t StreamSecondsToUnits (const AVStream &theStream, double theTimeSeconds)
 Convert seconds into time units for stream. More...
 
static TCollection_AsciiString FormatTime (double theSeconds)
 Time formatter. More...
 
static TCollection_AsciiString FormatTimeProgress (double theProgress, double theDuration)
 Time progress / duration formatter. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Protected Attributes

AVFormatContext * myFormatCtx
 format context More...
 
double myPtsStartBase
 start time More...
 
double myDuration
 duration More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

AVFormatContext wrapper - the media input/output stream holder.

Constructor & Destructor Documentation

◆ Media_FormatContext()

Media_FormatContext::Media_FormatContext ( )

Constructor.

◆ ~Media_FormatContext()

virtual Media_FormatContext::~Media_FormatContext ( )
virtual

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
theTimeUnitsvalue 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 Handle< Media_Packet > &  thePacket)

av_read_frame() wrapper.

◆ SecondsToUnits() [1/2]

static int64_t Media_FormatContext::SecondsToUnits ( double  theTimeSeconds)
static

Convert seconds into time units for context.

Parameters
theTimeSecondsvalue to convert
Returns
time units

◆ SecondsToUnits() [2/2]

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

Convert seconds into time units.

Parameters
theTimeBasethe timebase
theTimeSecondsvalue 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 = NULL 
) 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
theStreamthe stream
theTimeSecondsvalue 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
theStreamthe stream;
theTimeUnitsvalue 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
theTimeBasethe timebase
theTimeUnitsvalue 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: