OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    Media_Scaler Class Reference

    SwsContext wrapper - tool performing image scaling and pixel format conversion. More...

    #include <Media_Scaler.hxx>

    Inheritance diagram for Media_Scaler:
    Inheritance graph
    [legend]

    Public Member Functions

     Media_Scaler ()
     Empty constructor.
     ~Media_Scaler () override
     Destructor.
    void Release ()
     sws_freeContext() wrapper.
    bool Init (const NCollection_Vec2< int > &theSrcDims, int theSrcFormat, const NCollection_Vec2< int > &theResDims, int theResFormat)
     sws_getContext() wrapper - creates conversion context.
    bool Convert (const occ::handle< Media_Frame > &theSrc, const occ::handle< Media_Frame > &theRes)
     Convert one frame to another.
    bool IsValid () const
     Return TRUE if context was initialized.
    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.

    Protected Attributes

    SwsContext * mySwsContext
     conversion context
    NCollection_Vec2< int > mySrcDims
     dimensions of input frame
    int mySrcFormat
     pixel format (AVPixelFormat) of input frame
    NCollection_Vec2< int > myResDims
     dimensions of destination frame
    int myResFormat
     pixel format (AVPixelFormat) of destination frame

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    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.

    Detailed Description

    SwsContext wrapper - tool performing image scaling and pixel format conversion.

    Constructor & Destructor Documentation

    ◆ Media_Scaler()

    Media_Scaler::Media_Scaler ( )

    Empty constructor.

    ◆ ~Media_Scaler()

    Media_Scaler::~Media_Scaler ( )
    		override

    Destructor.

    Member Function Documentation

    ◆ Convert()

    bool Media_Scaler::Convert ( const occ::handle< Media_Frame > & theSrc,
    const occ::handle< Media_Frame > & theRes )

    Convert one frame to another.

    ◆ Init()

    bool Media_Scaler::Init ( const NCollection_Vec2< int > & theSrcDims,
    int theSrcFormat,
    const NCollection_Vec2< int > & theResDims,
    int theResFormat )

    sws_getContext() wrapper - creates conversion context.

    Parameters
    theSrcDimsdimensions of input frame
    theSrcFormatpixel format (AVPixelFormat) of input frame
    theResDimsdimensions of destination frame
    theResFormatpixel format (AVPixelFormat) of destination frame

    ◆ IsValid()

    bool Media_Scaler::IsValid ( ) const
    		inline

    Return TRUE if context was initialized.

    ◆ Release()

    void Media_Scaler::Release ( )

    sws_freeContext() wrapper.

    Field Documentation

    ◆ myResDims

    NCollection_Vec2<int> Media_Scaler::myResDims
    		protected

    dimensions of destination frame

    ◆ myResFormat

    int Media_Scaler::myResFormat
    		protected

    pixel format (AVPixelFormat) of destination frame

    ◆ mySrcDims

    NCollection_Vec2<int> Media_Scaler::mySrcDims
    		protected

    dimensions of input frame

    ◆ mySrcFormat

    int Media_Scaler::mySrcFormat
    		protected

    pixel format (AVPixelFormat) of input frame

    ◆ mySwsContext

    SwsContext* Media_Scaler::mySwsContext
    		protected

    conversion context

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