Frame-Based Decoding Functions

The following function is required to be implemented for all decoders that advertise the VPX_CODEC_CAP_PUT_FRAME capability. More...

Typedefs
typedef void(*	vpx_codec_put_frame_cb_fn_t) (void *user_priv, const vpx_image_t *img)
	put frame callback prototype More...
typedef void(*	vpx_codec_put_frame_cb_fn_t) (void *user_priv, const vpx_image_t *img)
	put frame callback prototype More...

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

Detailed Description

The following function is required to be implemented for all decoders that advertise the VPX_CODEC_CAP_PUT_FRAME capability.

The following functions are required to be implemented for all decoders that advertise the VPX_CODEC_CAP_PUT_FRAME capability.

Calling this function for codecs that don't advertise this capability will result in an error code being returned, usually VPX_CODEC_INCAPABLE.

Calling these functions for codecs that don't advertise this capability will result in an error code being returned, usually VPX_CODEC_ERROR

Typedef Documentation

vpx_codec_put_frame_cb_fn_t [1/2]

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.

vpx_codec_put_frame_cb_fn_t [2/2]

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.

Function Documentation

vpx_codec_register_put_frame_cb()

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.
VPX_CODEC_INCAPABLE	Algorithm not capable of posting 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.