WebM Codec SDK
vpx_codec.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
3  *
4  * Use of this source code is governed by a BSD-style license
5  * that can be found in the LICENSE file in the root of the source
6  * tree. An additional intellectual property rights grant can be found
7  * in the file PATENTS. All contributing project authors may
8  * be found in the AUTHORS file in the root of the source tree.
9  */
10 
38 #ifndef VPX_VPX_CODEC_H_
39 #define VPX_VPX_CODEC_H_
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 #include "./vpx_integer.h"
46 #include "./vpx_image.h"
47 
49 #ifndef DEPRECATED
50 #if defined(__GNUC__) && __GNUC__
51 #define DEPRECATED __attribute__((deprecated))
52 #elif defined(_MSC_VER)
53 #define DEPRECATED
54 #else
55 #define DEPRECATED
56 #endif
57 #endif /* DEPRECATED */
58 
59 #ifndef DECLSPEC_DEPRECATED
60 #if defined(__GNUC__) && __GNUC__
61 #define DECLSPEC_DEPRECATED
62 #elif defined(_MSC_VER)
63 
64 #define DECLSPEC_DEPRECATED __declspec(deprecated)
65 #else
66 #define DECLSPEC_DEPRECATED
67 #endif
68 #endif /* DECLSPEC_DEPRECATED */
69 
71 #ifdef UNUSED
72 #elif defined(__GNUC__) || defined(__clang__)
73 #define UNUSED __attribute__((unused))
74 #else
75 #define UNUSED
76 #endif
77 
86 #define VPX_CODEC_ABI_VERSION (3 + VPX_IMAGE_ABI_VERSION)
89 typedef enum {
90 
92 
95 
98 
101 
104 
111 
120 
130 
135 
140 
142 
151 typedef long vpx_codec_caps_t;
152 #define VPX_CODEC_CAP_DECODER 0x1
153 #define VPX_CODEC_CAP_ENCODER 0x2
162 typedef long vpx_codec_flags_t;
163 
169 typedef const struct vpx_codec_iface vpx_codec_iface_t;
170 
176 typedef struct vpx_codec_priv vpx_codec_priv_t;
177 
182 typedef const void *vpx_codec_iter_t;
183 
192 typedef struct vpx_codec_ctx {
193  const char *name;
196  const char *err_detail;
198  union {
200  const struct vpx_codec_dec_cfg *dec;
202  const struct vpx_codec_enc_cfg *enc;
203  const void *raw;
204  } config;
207 
212 typedef enum vpx_bit_depth {
214  VPX_BITS_10 = 10,
215  VPX_BITS_12 = 12,
217 
218 /*
219  * Library Version Number Interface
220  *
221  * For example, see the following sample return values:
222  * vpx_codec_version() (1<<16 | 2<<8 | 3)
223  * vpx_codec_version_str() "v1.2.3-rc1-16-gec6a1ba"
224  * vpx_codec_version_extra_str() "rc1-16-gec6a1ba"
225  */
226 
237 int vpx_codec_version(void);
238 #define VPX_VERSION_MAJOR(v) \
239  ((v >> 16) & 0xff)
240 #define VPX_VERSION_MINOR(v) \
241  ((v >> 8) & 0xff)
242 #define VPX_VERSION_PATCH(v) \
243  ((v >> 0) & 0xff)
246 #define vpx_codec_version_major() ((vpx_codec_version() >> 16) & 0xff)
247 
249 #define vpx_codec_version_minor() ((vpx_codec_version() >> 8) & 0xff)
250 
252 #define vpx_codec_version_patch() ((vpx_codec_version() >> 0) & 0xff)
253 
263 const char *vpx_codec_version_str(void);
264 
272 const char *vpx_codec_version_extra_str(void);
273 
280 const char *vpx_codec_build_config(void);
281 
289 const char *vpx_codec_iface_name(vpx_codec_iface_t *iface);
290 
302 
313 const char *vpx_codec_error(vpx_codec_ctx_t *ctx);
314 
325 const char *vpx_codec_error_detail(vpx_codec_ctx_t *ctx);
326 
327 /* REQUIRED FUNCTIONS
328  *
329  * The following functions are required to be implemented for all codecs.
330  * They represent the base case functionality expected of all codecs.
331  */
332 
345 
354 
379 vpx_codec_err_t vpx_codec_control_(vpx_codec_ctx_t *ctx, int ctrl_id, ...);
380 #if defined(VPX_DISABLE_CTRL_TYPECHECKS) && VPX_DISABLE_CTRL_TYPECHECKS
381 #define vpx_codec_control(ctx, id, data) vpx_codec_control_(ctx, id, data)
382 #define VPX_CTRL_USE_TYPE(id, typ)
383 #define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
384 #define VPX_CTRL_VOID(id, typ)
385 
386 #else
387 
396 #define vpx_codec_control(ctx, id, data) \
397  vpx_codec_control_##id(ctx, id, data)
410 #define VPX_CTRL_USE_TYPE(id, typ) \
411  static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *, int, typ) \
412  UNUSED; \
413  \
414  static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *ctx, \
415  int ctrl_id, typ data) { \
416  return vpx_codec_control_(ctx, ctrl_id, data); \
417  }
429 #define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ) \
430  DECLSPEC_DEPRECATED static vpx_codec_err_t vpx_codec_control_##id( \
431  vpx_codec_ctx_t *, int, typ) DEPRECATED UNUSED; \
432  \
433  DECLSPEC_DEPRECATED static vpx_codec_err_t vpx_codec_control_##id( \
434  vpx_codec_ctx_t *ctx, int ctrl_id, typ data) { \
435  return vpx_codec_control_(ctx, ctrl_id, data); \
436  }
448 #define VPX_CTRL_VOID(id) \
449  static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *, int) \
450  UNUSED; \
451  \
452  static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *ctx, \
453  int ctrl_id) { \
454  return vpx_codec_control_(ctx, ctrl_id); \
455  }
457 #endif
458 
460 #ifdef __cplusplus
461 }
462 #endif
463 #endif // VPX_VPX_CODEC_H_
struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition: vpx_codec.h:169
const char * vpx_codec_iface_name(vpx_codec_iface_t *iface)
Return the name for a given interface.
const char * vpx_codec_err_to_string(vpx_codec_err_t err)
Convert error number to printable string.
vpx_codec_flags_t init_flags
Definition: vpx_codec.h:197
Unspecified error.
Definition: vpx_codec.h:94
The given bitstream is not supported.
Definition: vpx_codec.h:110
Memory operation failed.
Definition: vpx_codec.h:97
Encoder configuration structure.
Definition: vpx_encoder.h:285
The coded data for this stream is corrupt or incomplete.
Definition: vpx_codec.h:129
int vpx_codec_version(void)
Return the version information (as an integer)
An application-supplied parameter is not valid.
Definition: vpx_codec.h:134
const char * vpx_codec_version_extra_str(void)
Return the version information (as a string)
const char * vpx_codec_build_config(void)
Return the build configuration.
const char * name
Definition: vpx_codec.h:193
enum vpx_bit_depth vpx_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
vpx_codec_caps_t vpx_codec_get_caps(vpx_codec_iface_t *iface)
Get the capabilities of an algorithm.
Operation completed without error.
Definition: vpx_codec.h:91
struct vpx_codec_ctx vpx_codec_ctx_t
Codec context structure.
vpx_bit_depth
Bit depth for codecThis enumeration determines the bit depth of the codec.
Definition: vpx_codec.h:212
vpx_codec_iface_t * iface
Definition: vpx_codec.h:194
Describes the vpx image descriptor and associated operations.
Definition: vpx_codec.h:215
long vpx_codec_flags_t
Initialization-time Feature Enabling.
Definition: vpx_codec.h:162
const char * err_detail
Definition: vpx_codec.h:196
const char * vpx_codec_error_detail(vpx_codec_ctx_t *ctx)
Retrieve detailed error information for codec context.
const char * vpx_codec_version_str(void)
Return the version information (as a string)
vpx_codec_err_t
Algorithm return codes.
Definition: vpx_codec.h:89
struct vpx_codec_priv vpx_codec_priv_t
Codec private data structure.
Definition: vpx_codec.h:176
Encoded bitstream uses an unsupported feature.
Definition: vpx_codec.h:119
ABI version mismatch.
Definition: vpx_codec.h:100
union vpx_codec_ctx::@0 config
vpx_codec_err_t vpx_codec_control_(vpx_codec_ctx_t *ctx, int ctrl_id,...)
Control algorithm.
An iterator reached the end of list.
Definition: vpx_codec.h:139
vpx_codec_priv_t * priv
Definition: vpx_codec.h:205
struct vpx_codec_dec_cfg * dec
Definition: vpx_codec.h:200
vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx)
Destroy a codec instance.
long vpx_codec_caps_t
Codec capabilities bitfield.
Definition: vpx_codec.h:151
Definition: vpx_codec.h:213
Algorithm does not have required capability.
Definition: vpx_codec.h:103
vpx_codec_err_t err
Definition: vpx_codec.h:195
const char * vpx_codec_error(vpx_codec_ctx_t *ctx)
Retrieve error synopsis for codec context.
Initialization Configurations.
Definition: vpx_decoder.h:107
Definition: vpx_codec.h:214
const void * vpx_codec_iter_t
Iterator.
Definition: vpx_codec.h:182
Codec context structure.
Definition: vpx_codec.h:192