MFXVideoCORE

This class of functions consists of auxiliary functions that all functions of the SDK implementation can call.

Member Functions

 

MFXVideoCORE_SetHandle

Sets system handles that the SDK implementation might need

MFXVideoCORE_GetHandle

Obtains system handles previously set

MFXVideoCORE_SetBufferAllocator

Sets the external system buffer allocator

MFXVideoCORE_SetFrameAllocator

Sets the external frame allocator

MFXVideoCORE_SyncOperation

Initializes execution of the specified sync point and returns a status code

 

 

Syntax

 

mfxStatus MFXVideoCORE_SetHandle(mfxSession session, mfxHandleType type, mfxHDL hdl);

Parameters

 

session

SDK session handle

 

type

Handle type

 

hdl

Handle to be set

Description

 

This function sets any essential system handle that SDK might use.

If the specified system handle is a COM interface, the reference counter of the COM interface will increase. The counter will decrease when the SDK session closes.

Return Status

 

MFX_ERR_NONE

The function completed successfully.

 

MFX_ERR_UNDEFINED_BEHAVIOR

The same handle is redefined. For example, the function has been called twice with the same handle type or internal handle has been created by the SDK before this function call.

Change History

 

This function is available since SDK API 1.0.

 

 

 

Syntax

 

mfxStatus MFXVideoCORE_GetHandle(mfxSession session, mfxHandleType type, mfxHDL *hdl);

Parameters

 

session

SDK session handle

 

type

Handle type

 

hdl

Pointer to the handle to be set

Description

 

This function obtains system handles previously set by the MFXVideoCORE_SetHandle function. If the handler is a COM interface, the reference counter of the interface increases. The calling application must release the COM interface.

Return Status

 

MFX_ERR_NONE

The function completed successfully.

 

MFX_ERR_NOT_FOUND

Specified handle type not found.

Change History

 

This function is available since SDK API 1.0.

 

 

 

Syntax

 

mfxStatus MFXVideoCORE_SetBufferAllocator(mfxSession session, mfxBufferAllocator *allocator);

Parameters

 

session

SDK session handle

 

allocator

Pointer to the mfxBufferAllocator structure

Description

 

This function is deprecated.

Return Status

 

MFX_ERR_NONE

The function completed successfully.

Change History

 

 

This function is available since SDK API 1.0.

Deprecated since SDK API 1.17.

 

 

 

 

Syntax

 

mfxStatus MFXVideoCORE_SetFrameAllocator(mfxSession session, mfxFrameAllocator *allocator);

Parameters

 

session

SDK session handle

 

allocator

Pointer to the mfxFrameAllocator structure

Description

 

This function sets the external allocator callback structure for frame allocation. If the allocator argument is NULL, the SDK uses the default allocator, which allocates frames from system memory or hardware devices.

The behavior of the SDK is undefined if it uses this function while the previous allocator is in use. A general guideline is to set the allocator immediately after initializing the session.

Return Status

 

MFX_ERR_NONE

The function completed successfully.

Change History

 

 

This function is available since SDK API 1.0.

 

 

 

 

Syntax

 

mfxStatus MFXVideoCORE_QueryPlatform(mfxSession session, mfxPlatform *platform);

Parameters

 

session

SDK session handle

 

platform

Pointer to the mfxPlatform structure

Description

 

This function returns information about current hardware platform.

Return Status

 

MFX_ERR_NONE

The function completed successfully.

Change History

 

 

This function is available since SDK API 1.19.

 

Syntax

 

mfxStatus MFXVideoCORE_SyncOperation(mfxSession session, mfxSyncPoint syncp, mfxU32 wait);

Parameters

 

session

SDK session handle

 

syncp

Sync point

 

wait

Wait time in milliseconds

Description

 

This function initiates execution of an asynchronous function not already started and returns the status code after the specified asynchronous operation completes. If wait is zero, the function returns immediately.

Return Status

 

MFX_ERR_NONE

The function completed successfully.

 

MFX_WRN_IN_EXECUTION

The specified asynchronous function is in execution.

 

MFX_ERR_ABORTED

The specified asynchronous function aborted due to data dependency on a previous asynchronous function that did not complete.

Change History

 

 

This function is available since SDK API 1.0.

 

Remarks

 

See status codes for specific asynchronous functions.

 

For more complete information about compiler optimizations, see our Optimization Notice.