WebM Codec SDK: vpx/vpx_codec.h Source File

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
41#ifndef VPX_VPX_VPX_CODEC_H_
42#define VPX_VPX_VPX_CODEC_H_
43
44#ifdef __cplusplus
45extern "C" {
46#endif
47
48#include "./vpx_image.h"
49#include "./vpx_integer.h"
50
52#ifndef VPX_DEPRECATED
53#if defined(__GNUC__)
54#define VPX_DEPRECATED __attribute__((deprecated))
55#elif defined(_MSC_VER)
56#define VPX_DEPRECATED
57#else
58#define VPX_DEPRECATED
59#endif
60#endif /* VPX_DEPRECATED */
61
62#ifndef VPX_DECLSPEC_DEPRECATED
63#if defined(__GNUC__)
64#define VPX_DECLSPEC_DEPRECATED
65#elif defined(_MSC_VER)
67#define VPX_DECLSPEC_DEPRECATED __declspec(deprecated)
68#else
69#define VPX_DECLSPEC_DEPRECATED
70#endif
71#endif /* VPX_DECLSPEC_DEPRECATED */
72
74#ifndef VPX_UNUSED
75#if defined(__GNUC__) || defined(__clang__)
76#define VPX_UNUSED __attribute__((unused))
77#else
78#define VPX_UNUSED
79#endif
80#endif /* VPX_UNUSED */
81
90#define VPX_CODEC_ABI_VERSION (4 + VPX_IMAGE_ABI_VERSION)
93 typedef enum {
95 VPX_CODEC_OK,
96
98 VPX_CODEC_ERROR,
99
101 VPX_CODEC_MEM_ERROR,
102
104 VPX_CODEC_ABI_MISMATCH,
105
107 VPX_CODEC_INCAPABLE,
108
114 VPX_CODEC_UNSUP_BITSTREAM,
115
123 VPX_CODEC_UNSUP_FEATURE,
124
133 VPX_CODEC_CORRUPT_FRAME,
134
138 VPX_CODEC_INVALID_PARAM,
139
143 VPX_CODEC_LIST_END
144
145} vpx_codec_err_t;
146
155 typedef long vpx_codec_caps_t;
156#define VPX_CODEC_CAP_DECODER 0x1
157#define VPX_CODEC_CAP_ENCODER 0x2
161#define VPX_CODEC_CAP_HIGHBITDEPTH 0x4
162
170 typedef long vpx_codec_flags_t;
171
177 typedef const struct vpx_codec_iface vpx_codec_iface_t;
178
184 typedef struct vpx_codec_priv vpx_codec_priv_t;
185
190 typedef const void *vpx_codec_iter_t;
191
200 typedef struct vpx_codec_ctx {
201 const char *name;
202 vpx_codec_iface_t *iface;
203 vpx_codec_err_t err;
204 const char *err_detail;
205 vpx_codec_flags_t init_flags;
206 union {
208 const struct vpx_codec_dec_cfg *dec;
210 const struct vpx_codec_enc_cfg *enc;
211 const void *raw;
212 } config;
213 vpx_codec_priv_t *priv;
214} vpx_codec_ctx_t;
215
220 typedef enum vpx_bit_depth {
221 VPX_BITS_8 = 8,
222 VPX_BITS_10 = 10,
223 VPX_BITS_12 = 12,
224} vpx_bit_depth_t;
225
226/*
227 * Library Version Number Interface
228 *
229 * For example, see the following sample return values:
230 * vpx_codec_version() (1<<16 | 2<<8 | 3)
231 * vpx_codec_version_str() "v1.2.3-rc1-16-gec6a1ba"
232 * vpx_codec_version_extra_str() "rc1-16-gec6a1ba"
233 */
234
245 int vpx_codec_version(void);
246#define VPX_VERSION_MAJOR(v) \
247 (((v) >> 16) & 0xff)
248#define VPX_VERSION_MINOR(v) \
249 (((v) >> 8) & 0xff)
250#define VPX_VERSION_PATCH(v) \
251 (((v) >> 0) & 0xff)
254#define vpx_codec_version_major() ((vpx_codec_version() >> 16) & 0xff)
255
257#define vpx_codec_version_minor() ((vpx_codec_version() >> 8) & 0xff)
258
260#define vpx_codec_version_patch() ((vpx_codec_version() >> 0) & 0xff)
261
271 const char *vpx_codec_version_str(void);
272
280 const char *vpx_codec_version_extra_str(void);
281
288 const char *vpx_codec_build_config(void);
289
297 const char *vpx_codec_iface_name(vpx_codec_iface_t *iface);
298
309 const char *vpx_codec_err_to_string(vpx_codec_err_t err);
310
321 const char *vpx_codec_error(const vpx_codec_ctx_t *ctx);
322
335 const char *vpx_codec_error_detail(const vpx_codec_ctx_t *ctx);
336
337/* REQUIRED FUNCTIONS
338 *
339 * The following functions are required to be implemented for all codecs.
340 * They represent the base case functionality expected of all codecs.
341 */
342
356 vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx);
357
365 vpx_codec_caps_t vpx_codec_get_caps(vpx_codec_iface_t *iface);
366
391 vpx_codec_err_t vpx_codec_control_(vpx_codec_ctx_t *ctx, int ctrl_id, ...);
392#if defined(VPX_DISABLE_CTRL_TYPECHECKS) && VPX_DISABLE_CTRL_TYPECHECKS
393#define vpx_codec_control(ctx, id, data) vpx_codec_control_(ctx, id, data)
394#define VPX_CTRL_USE_TYPE(id, typ)
395#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ)
396#define VPX_CTRL_VOID(id, typ)
397
398#else
408#define vpx_codec_control(ctx, id, data) \
409 vpx_codec_control_##id(ctx, id, data)
422#define VPX_CTRL_USE_TYPE(id, typ) \
423 static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *, int, typ) \
424 VPX_UNUSED; \
425 \
426 static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *ctx, \
427 int ctrl_id, typ data) { \
428 return vpx_codec_control_(ctx, ctrl_id, data); \
429 }
441#define VPX_CTRL_USE_TYPE_DEPRECATED(id, typ) \
442 VPX_DECLSPEC_DEPRECATED static vpx_codec_err_t vpx_codec_control_##id( \
443 vpx_codec_ctx_t *, int, typ) VPX_DEPRECATED VPX_UNUSED; \
444 \
445 VPX_DECLSPEC_DEPRECATED static vpx_codec_err_t vpx_codec_control_##id( \
446 vpx_codec_ctx_t *ctx, int ctrl_id, typ data) { \
447 return vpx_codec_control_(ctx, ctrl_id, data); \
448 }
460#define VPX_CTRL_VOID(id) \
461 static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *, int) \
462 VPX_UNUSED; \
463 \
464 static vpx_codec_err_t vpx_codec_control_##id(vpx_codec_ctx_t *ctx, \
465 int ctrl_id) { \
466 return vpx_codec_control_(ctx, ctrl_id); \
467 }
469#endif
470
472#ifdef __cplusplus
473}
474#endif
475#endif // VPX_VPX_VPX_CODEC_H_
vpx_codec_version
int vpx_codec_version(void)
Return the version information (as an integer)
vpx_codec_priv_t
struct vpx_codec_priv vpx_codec_priv_t
Codec private data structure.
Definition vpx_codec.h:184
vpx_codec_error_detail
const char * vpx_codec_error_detail(const vpx_codec_ctx_t *ctx)
Retrieve detailed error information for codec context.
vpx_codec_flags_t
long vpx_codec_flags_t
Initialization-time Feature Enabling.
Definition vpx_codec.h:170
vpx_codec_get_caps
vpx_codec_caps_t vpx_codec_get_caps(vpx_codec_iface_t *iface)
Get the capabilities of an algorithm.
vpx_codec_err_to_string
const char * vpx_codec_err_to_string(vpx_codec_err_t err)
Convert error number to printable string.
vpx_codec_ctx_t
struct vpx_codec_ctx vpx_codec_ctx_t
Codec context structure.
vpx_codec_version_str
const char * vpx_codec_version_str(void)
Return the version information (as a string)
vpx_codec_destroy
vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx)
Destroy a codec instance.
vpx_codec_iter_t
const void * vpx_codec_iter_t
Iterator.
Definition vpx_codec.h:190
vpx_codec_iface_name
const char * vpx_codec_iface_name(vpx_codec_iface_t *iface)
Return the name for a given interface.
vpx_codec_build_config
const char * vpx_codec_build_config(void)
Return the build configuration.
vpx_bit_depth_t
enum vpx_bit_depth vpx_bit_depth_t
Bit depth for codecThis enumeration determines the bit depth of the codec.
vpx_codec_error
const char * vpx_codec_error(const vpx_codec_ctx_t *ctx)
Retrieve error synopsis for codec context.
vpx_codec_caps_t
long vpx_codec_caps_t
Codec capabilities bitfield.
Definition vpx_codec.h:155
vpx_codec_err_t
vpx_codec_err_t
Algorithm return codes.
Definition vpx_codec.h:93
vpx_codec_version_extra_str
const char * vpx_codec_version_extra_str(void)
Return the version information (as a string)
vpx_codec_iface_t
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition vpx_codec.h:177
vpx_bit_depth
vpx_bit_depth
Bit depth for codecThis enumeration determines the bit depth of the codec.
Definition vpx_codec.h:220
vpx_codec_control_
vpx_codec_err_t vpx_codec_control_(vpx_codec_ctx_t *ctx, int ctrl_id,...)
Control algorithm.
VPX_CODEC_CORRUPT_FRAME
@ VPX_CODEC_CORRUPT_FRAME
The coded data for this stream is corrupt or incomplete.
Definition vpx_codec.h:133
VPX_CODEC_INCAPABLE
@ VPX_CODEC_INCAPABLE
Algorithm does not have required capability.
Definition vpx_codec.h:107
VPX_CODEC_LIST_END
@ VPX_CODEC_LIST_END
An iterator reached the end of list.
Definition vpx_codec.h:143
VPX_CODEC_UNSUP_FEATURE
@ VPX_CODEC_UNSUP_FEATURE
Encoded bitstream uses an unsupported feature.
Definition vpx_codec.h:123
VPX_CODEC_MEM_ERROR
@ VPX_CODEC_MEM_ERROR
Memory operation failed.
Definition vpx_codec.h:101
VPX_CODEC_INVALID_PARAM
@ VPX_CODEC_INVALID_PARAM
An application-supplied parameter is not valid.
Definition vpx_codec.h:138
VPX_CODEC_ERROR
@ VPX_CODEC_ERROR
Unspecified error.
Definition vpx_codec.h:98
VPX_CODEC_OK
@ VPX_CODEC_OK
Operation completed without error.
Definition vpx_codec.h:95
VPX_CODEC_ABI_MISMATCH
@ VPX_CODEC_ABI_MISMATCH
ABI version mismatch.
Definition vpx_codec.h:104
VPX_CODEC_UNSUP_BITSTREAM
@ VPX_CODEC_UNSUP_BITSTREAM
The given bitstream is not supported.
Definition vpx_codec.h:114
VPX_BITS_8
@ VPX_BITS_8
Definition vpx_codec.h:221
VPX_BITS_12
@ VPX_BITS_12
Definition vpx_codec.h:223
VPX_BITS_10
@ VPX_BITS_10
Definition vpx_codec.h:222
vpx_codec_ctx
Codec context structure.
Definition vpx_codec.h:200
vpx_codec_ctx::dec
const struct vpx_codec_dec_cfg * dec
Definition vpx_codec.h:208
vpx_codec_ctx::err
vpx_codec_err_t err
Definition vpx_codec.h:203
vpx_codec_ctx::config
union vpx_codec_ctx::@0 config
vpx_codec_ctx::init_flags
vpx_codec_flags_t init_flags
Definition vpx_codec.h:205
vpx_codec_ctx::name
const char * name
Definition vpx_codec.h:201
vpx_codec_ctx::priv
vpx_codec_priv_t * priv
Definition vpx_codec.h:213
vpx_codec_ctx::err_detail
const char * err_detail
Definition vpx_codec.h:204
vpx_codec_ctx::iface
vpx_codec_iface_t * iface
Definition vpx_codec.h:202
vpx_codec_dec_cfg
Initialization Configurations.
Definition vpx_decoder.h:106
vpx_codec_enc_cfg
Encoder configuration structure.
Definition vpx_encoder.h:276
vpx_image.h
Describes the vpx image descriptor and associated operations.