Typedefs | Functions

Frame-Based Decoding Functions
[Decoder Algorithm Interface]

Collaboration diagram for Frame-Based Decoding Functions:

Typedefs

typedef void(* vpx_codec_put_frame_cb_fn_t )(void *user_priv, const vpx_image_t *img)
 put frame callback prototype
typedef void(* vpx_dec_put_frame_cb_fn_t )(void *user_priv, const vpx_image_t *img)
 put frame callback prototype

Functions

vpx_codec_err_t vpx_codec_register_put_frame_cb (vpx_codec_ctx_t *ctx, vpx_codec_put_frame_cb_fn_t cb, void *user_priv)
 Register for notification of frame completion.
vpx_dec_err_t vpx_dec_register_put_frame_cb (vpx_dec_ctx_t *ctx, vpx_dec_put_frame_cb_fn_t cb, void *user_priv) DEPRECATED
 Register for notification of frame completion.

Detailed Description

The following functions are required to be implemented for all decoders that advertise the VPX_CODEC_CAP_PUT_FRAME capability. Calling these functions for codecs that don't advertise this capability will result in an error code being returned, usually VPX_CODEC_ERROR

The following functions are required to be implemented for all decoders that advertise the VPX_DEC_CAP_PUT_FRAME capability. Calling these functions for codecs that don't advertise this capability will result in an error code being returned, usually VPX_DEC_ERROR


Typedef Documentation

typedef void(* vpx_codec_put_frame_cb_fn_t)(void *user_priv, const vpx_image_t *img)

put frame callback prototype

This callback is invoked by the decoder to notify the application of the availability of decoded image data.

typedef void(* vpx_dec_put_frame_cb_fn_t)(void *user_priv, const vpx_image_t *img)

put frame callback prototype

This callback is invoked by the decoder to notify the application of the availability of decoded image data.


Function Documentation

vpx_codec_err_t vpx_codec_register_put_frame_cb ( vpx_codec_ctx_t ctx,
vpx_codec_put_frame_cb_fn_t  cb,
void *  user_priv 
)

Register for notification of frame completion.

Registers a given function to be called when a decoded frame is available.

Parameters:
[in] ctx Pointer to this instance's context
[in] cb Pointer to the callback function
[in] user_priv User's private data
Return values:
VPX_CODEC_OK Callback successfully registered.
VPX_CODEC_ERROR Decoder context not initialized, or algorithm not capable of posting slice completion.
vpx_dec_err_t vpx_dec_register_put_frame_cb ( vpx_dec_ctx_t ctx,
vpx_dec_put_frame_cb_fn_t  cb,
void *  user_priv 
)

Register for notification of frame completion.

Registers a given function to be called when a decoded frame is available.

Parameters:
[in] ctx Pointer to this instance's context
[in] cb Pointer to the callback function
[in] user_priv User's private data
Return values:
VPX_DEC_OK Callback successfully registered.
VPX_DEC_ERROR Decoder context not initialized, or algorithm not capable of posting slice completion.