vpx_codec.h File Reference

Describes the codec algorithm interface to applications. More...

Classes

struct  vpx_codec_ctx
 Codec context structure. More...
 

Typedefs

typedef long vpx_codec_caps_t
 Codec capabilities bitfield. More...
 
typedef long vpx_codec_flags_t
 Initialization-time Feature Enabling. More...
 
typedef const struct vpx_codec_iface vpx_codec_iface_t
 Codec interface structure. More...
 
typedef struct vpx_codec_priv vpx_codec_priv_t
 Codec private data structure. More...
 
typedef const void * vpx_codec_iter_t
 Iterator. More...
 
typedef struct vpx_codec_ctx vpx_codec_ctx_t
 Codec context structure. More...
 
typedef enum vpx_bit_depth vpx_bit_depth_t
 Bit depth for codec

  • This enumeration determines the bit depth of the codec.
More...
 

Enumerations

enum  vpx_codec_err_t {
  VPX_CODEC_OK , VPX_CODEC_ERROR , VPX_CODEC_MEM_ERROR , VPX_CODEC_ABI_MISMATCH ,
  VPX_CODEC_INCAPABLE , VPX_CODEC_UNSUP_BITSTREAM , VPX_CODEC_UNSUP_FEATURE , VPX_CODEC_CORRUPT_FRAME ,
  VPX_CODEC_INVALID_PARAM , VPX_CODEC_LIST_END , VPX_CODEC_OK , VPX_CODEC_ERROR ,
  VPX_CODEC_MEM_ERROR , VPX_CODEC_ABI_MISMATCH , VPX_CODEC_INCAPABLE , VPX_CODEC_UNSUP_BITSTREAM ,
  VPX_CODEC_UNSUP_FEATURE , VPX_CODEC_CORRUPT_FRAME , VPX_CODEC_INVALID_PARAM , VPX_CODEC_LIST_END
}
 Algorithm return codes. More...
 
enum  vpx_bit_depth {
  VPX_BITS_8 = 8 , VPX_BITS_10 = 10 , VPX_BITS_12 = 12 , VPX_BITS_8 = 8 ,
  VPX_BITS_10 = 10 , VPX_BITS_12 = 12
}
 Bit depth for codec

  • This enumeration determines the bit depth of the codec.
More...
 

Functions

int vpx_codec_version (void)
 Return the version information (as an integer) More...
 
const char * vpx_codec_version_str (void)
 Return the version information (as a string) More...
 
const char * vpx_codec_version_extra_str (void)
 Return the version information (as a string) More...
 
const char * vpx_codec_build_config (void)
 Return the build configuration. More...
 
const char * vpx_codec_iface_name (vpx_codec_iface_t *iface)
 Return the name for a given interface. More...
 
const char * vpx_codec_err_to_string (vpx_codec_err_t err)
 Convert error number to printable string. More...
 
const char * vpx_codec_error (vpx_codec_ctx_t *ctx)
 Retrieve error synopsis for codec context. More...
 
const char * vpx_codec_error_detail (vpx_codec_ctx_t *ctx)
 Retrieve detailed error information for codec context. More...
 
vpx_codec_err_t vpx_codec_destroy (vpx_codec_ctx_t *ctx)
 Destroy a codec instance. More...
 
vpx_codec_caps_t vpx_codec_get_caps (vpx_codec_iface_t *iface)
 Get the capabilities of an algorithm. More...
 
vpx_codec_err_t vpx_codec_control_ (vpx_codec_ctx_t *ctx, int ctrl_id,...)
 Control algorithm. More...
 

Detailed Description

Describes the codec algorithm interface to applications.

This file describes the interface between an application and a video codec algorithm.

An application instantiates a specific codec instance by using vpx_codec_init() and a pointer to the algorithm's interface structure:

    my_app.c:
      extern vpx_codec_iface_t my_codec;
      {
          vpx_codec_ctx_t algo;
          res = vpx_codec_init(&algo, &my_codec);
      }
    

Once initialized, the instance is manged using other functions from the vpx_codec_* family.