vpx_codec.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */


#ifdef __cplusplus
extern "C" {
#endif

#ifndef VPX_CODEC_H
#define VPX_CODEC_H
#include "vpx_integer.h"
#include "vpx_image.h"

#ifndef DEPRECATED
#if defined(__GNUC__) && __GNUC__
#define DEPRECATED          __attribute__ ((deprecated))
#elif defined(_MSC_VER)
#define DEPRECATED
#else
#define DEPRECATED
#endif
#endif  /* DEPRECATED */

#ifndef DECLSPEC_DEPRECATED
#if defined(__GNUC__) && __GNUC__
#define DECLSPEC_DEPRECATED 
#elif defined(_MSC_VER)
#define DECLSPEC_DEPRECATED __declspec(deprecated) 
#else
#define DECLSPEC_DEPRECATED 
#endif
#endif  /* DECLSPEC_DEPRECATED */

#ifdef UNUSED
#elif __GNUC__
#define UNUSED __attribute__ ((unused))
#else
#define UNUSED
#endif

#define VPX_CODEC_ABI_VERSION (2 + VPX_IMAGE_ABI_VERSION) 
  typedef enum {

    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_err_t;


  typedef long vpx_codec_caps_t;
#define VPX_CODEC_CAP_DECODER 0x1 
#define VPX_CODEC_CAP_ENCODER 0x2 
#define VPX_CODEC_CAP_XMA     0x4 
  typedef long vpx_codec_flags_t;
#define VPX_CODEC_USE_XMA 0x00000001    
  typedef const struct vpx_codec_iface vpx_codec_iface_t;


  typedef       struct vpx_codec_priv  vpx_codec_priv_t;


  typedef const void *vpx_codec_iter_t;


  typedef struct vpx_codec_ctx {
    const char              *name;        
    vpx_codec_iface_t       *iface;       
    vpx_codec_err_t          err;         
    const char              *err_detail;  
    vpx_codec_flags_t        init_flags;  
    union {
      struct vpx_codec_dec_cfg  *dec;   
      struct vpx_codec_enc_cfg  *enc;   
      void                      *raw;
    }                        config;      
    vpx_codec_priv_t        *priv;        
  } vpx_codec_ctx_t;


  /*
   * Library Version Number Interface
   *
   * For example, see the following sample return values:
   *     vpx_codec_version()           (1<<16 | 2<<8 | 3)
   *     vpx_codec_version_str()       "v1.2.3-rc1-16-gec6a1ba"
   *     vpx_codec_version_extra_str() "rc1-16-gec6a1ba"
   */

  int vpx_codec_version(void);
#define VPX_VERSION_MAJOR(v) ((v>>16)&0xff) 
#define VPX_VERSION_MINOR(v) ((v>>8)&0xff)  
#define VPX_VERSION_PATCH(v) ((v>>0)&0xff)  
#define vpx_codec_version_major() ((vpx_codec_version()>>16)&0xff)

#define vpx_codec_version_minor() ((vpx_codec_version()>>8)&0xff)

#define vpx_codec_version_patch() ((vpx_codec_version()>>0)&0xff)


  const char *vpx_codec_version_str(void);


  const char *vpx_codec_version_extra_str(void);


  const char *vpx_codec_build_config(void);


  const char *vpx_codec_iface_name(vpx_codec_iface_t *iface);


  const char *vpx_codec_err_to_string(vpx_codec_err_t  err);


  const char *vpx_codec_error(vpx_codec_ctx_t  *ctx);


  const char *vpx_codec_error_detail(vpx_codec_ctx_t  *ctx);


  /* REQUIRED FUNCTIONS
   *
   * The following functions are required to be implemented for all codecs.
   * They represent the base case functionality expected of all codecs.
   */

  vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx);


  vpx_codec_caps_t vpx_codec_get_caps(vpx_codec_iface_t *iface);


  vpx_codec_err_t vpx_codec_control_(vpx_codec_ctx_t  *ctx,
                                     int               ctrl_id,
                                     ...);
#if defined(VPX_DISABLE_CTRL_TYPECHECKS) && VPX_DISABLE_CTRL_TYPECHECKS
#    define vpx_codec_control(ctx,id,data) vpx_codec_control_(ctx,id,data)
#    define VPX_CTRL_USE_TYPE(id, typ)
#    define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
#    define VPX_CTRL_VOID(id, typ)

#else

#    define vpx_codec_control(ctx,id,data) vpx_codec_control_##id(ctx,id,data)\

#    define VPX_CTRL_USE_TYPE(id, typ) \
  static vpx_codec_err_t \
  vpx_codec_control_##id(vpx_codec_ctx_t*, int, typ) UNUSED;\
  \
  static vpx_codec_err_t \
  vpx_codec_control_##id(vpx_codec_ctx_t  *ctx, int ctrl_id, typ data) {\
    return vpx_codec_control_(ctx, ctrl_id, data);\
  } 
#    define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ) \
  DECLSPEC_DEPRECATED static vpx_codec_err_t \
  vpx_codec_control_##id(vpx_codec_ctx_t*, int, typ) DEPRECATED UNUSED;\
  \
  DECLSPEC_DEPRECATED static vpx_codec_err_t \
  vpx_codec_control_##id(vpx_codec_ctx_t  *ctx, int ctrl_id, typ data) {\
    return vpx_codec_control_(ctx, ctrl_id, data);\
  } 
#    define VPX_CTRL_VOID(id) \
  static vpx_codec_err_t \
  vpx_codec_control_##id(vpx_codec_ctx_t*, int) UNUSED;\
  \
  static vpx_codec_err_t \
  vpx_codec_control_##id(vpx_codec_ctx_t  *ctx, int ctrl_id) {\
    return vpx_codec_control_(ctx, ctrl_id);\
  } 
#endif


  typedef struct vpx_codec_mmap {
    /*
     * The following members are set by the codec when requesting a segment
     */
    unsigned int   id;     
    unsigned long  sz;     
    unsigned int   align;  
    unsigned int   flags;  
#define VPX_CODEC_MEM_ZERO     0x1  
#define VPX_CODEC_MEM_WRONLY   0x2  
#define VPX_CODEC_MEM_FAST     0x4  
    /* The following members are to be filled in by the allocation function */
    void          *base;   
    void (*dtor)(struct vpx_codec_mmap *map);         
    void          *priv;   
  } vpx_codec_mmap_t; 
  vpx_codec_err_t vpx_codec_get_mem_map(vpx_codec_ctx_t                *ctx,
                                        vpx_codec_mmap_t               *mmap,
                                        vpx_codec_iter_t               *iter);


  vpx_codec_err_t  vpx_codec_set_mem_map(vpx_codec_ctx_t   *ctx,
                                         vpx_codec_mmap_t  *mmaps,
                                         unsigned int       num_maps);

#endif
#ifdef __cplusplus
}
#endif