vpx_codec.h 15.2 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
5 6
 *  that can be found in the LICENSE file in the root of the source
 *  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.
John Koleszar's avatar
John Koleszar committed
9 10 11 12 13 14 15 16 17
 */

/*!\defgroup codec Common Algorithm Interface
 * This abstraction allows applications to easily support multiple video
 * formats with minimal code duplication. This section describes the interface
 * common to all codecs (both encoders and decoders).
 * @{
 */

James Zern's avatar
James Zern committed
18
/*!\file
John Koleszar's avatar
John Koleszar committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 * \brief 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:
 *     <pre>
 *     my_app.c:
 *       extern vpx_codec_iface_t my_codec;
 *       {
 *           vpx_codec_ctx_t algo;
 *           res = vpx_codec_init(&algo, &my_codec);
 *       }
 *     </pre>
 *
 * Once initialized, the instance is manged using other functions from
 * the vpx_codec_* family.
 */
James Zern's avatar
James Zern committed
38 39
#ifndef VPX_VPX_CODEC_H_
#define VPX_VPX_CODEC_H_
Adrian Grange's avatar
Adrian Grange committed
40

John Koleszar's avatar
John Koleszar committed
41 42 43 44
#ifdef __cplusplus
extern "C" {
#endif

45 46
#include "./vpx_integer.h"
#include "./vpx_image.h"
John Koleszar's avatar
John Koleszar committed
47

clang-format's avatar
clang-format committed
48
/*!\brief Decorator indicating a function is deprecated */
John Koleszar's avatar
John Koleszar committed
49 50
#ifndef DEPRECATED
#if defined(__GNUC__) && __GNUC__
clang-format's avatar
clang-format committed
51
#define DEPRECATED __attribute__((deprecated))
John Koleszar's avatar
John Koleszar committed
52 53 54 55 56
#elif defined(_MSC_VER)
#define DEPRECATED
#else
#define DEPRECATED
#endif
clang-format's avatar
clang-format committed
57
#endif /* DEPRECATED */
58 59 60 61 62

#ifndef DECLSPEC_DEPRECATED
#if defined(__GNUC__) && __GNUC__
#define DECLSPEC_DEPRECATED /**< \copydoc #DEPRECATED */
#elif defined(_MSC_VER)
clang-format's avatar
clang-format committed
63 64
#define DECLSPEC_DEPRECATED __declspec(deprecated)
/**< \copydoc #DEPRECATED */
65 66
#else
#define DECLSPEC_DEPRECATED /**< \copydoc #DEPRECATED */
John Koleszar's avatar
John Koleszar committed
67
#endif
clang-format's avatar
clang-format committed
68
#endif /* DECLSPEC_DEPRECATED */
John Koleszar's avatar
John Koleszar committed
69

clang-format's avatar
clang-format committed
70
/*!\brief Decorator indicating a function is potentially unused */
John Koleszar's avatar
John Koleszar committed
71
#ifdef UNUSED
72
#elif defined(__GNUC__) || defined(__clang__)
clang-format's avatar
clang-format committed
73
#define UNUSED __attribute__((unused))
John Koleszar's avatar
John Koleszar committed
74 75 76 77
#else
#define UNUSED
#endif

clang-format's avatar
clang-format committed
78 79 80 81 82 83 84 85
/*!\brief Current ABI version number
 *
 * \internal
 * If this file is altered in any way that changes the ABI, this value
 * must be bumped.  Examples include, but are not limited to, changing
 * types, removing or reassigning enums, adding/removing/rearranging
 * fields to structures
 */
James Zern's avatar
James Zern committed
86
#define VPX_CODEC_ABI_VERSION (3 + VPX_IMAGE_ABI_VERSION) /**<\hideinitializer*/
John Koleszar's avatar
John Koleszar committed
87

clang-format's avatar
clang-format committed
88 89 90 91
/*!\brief Algorithm return codes */
typedef enum {
  /*!\brief Operation completed without error */
  VPX_CODEC_OK,
John Koleszar's avatar
John Koleszar committed
92

clang-format's avatar
clang-format committed
93 94
  /*!\brief Unspecified error */
  VPX_CODEC_ERROR,
John Koleszar's avatar
John Koleszar committed
95

clang-format's avatar
clang-format committed
96 97
  /*!\brief Memory operation failed */
  VPX_CODEC_MEM_ERROR,
John Koleszar's avatar
John Koleszar committed
98

clang-format's avatar
clang-format committed
99 100
  /*!\brief ABI version mismatch */
  VPX_CODEC_ABI_MISMATCH,
John Koleszar's avatar
John Koleszar committed
101

clang-format's avatar
clang-format committed
102 103
  /*!\brief Algorithm does not have required capability */
  VPX_CODEC_INCAPABLE,
John Koleszar's avatar
John Koleszar committed
104

clang-format's avatar
clang-format committed
105
  /*!\brief The given bitstream is not supported.
John Koleszar's avatar
John Koleszar committed
106
   *
clang-format's avatar
clang-format committed
107 108 109 110
   * The bitstream was unable to be parsed at the highest level. The decoder
   * is unable to proceed. This error \ref SHOULD be treated as fatal to the
   * stream. */
  VPX_CODEC_UNSUP_BITSTREAM,
John Koleszar's avatar
John Koleszar committed
111

clang-format's avatar
clang-format committed
112
  /*!\brief Encoded bitstream uses an unsupported feature
John Koleszar's avatar
John Koleszar committed
113
   *
clang-format's avatar
clang-format committed
114 115 116 117
   * The decoder does not implement a feature required by the encoder. This
   * return code should only be used for features that prevent future
   * pictures from being properly decoded. This error \ref MAY be treated as
   * fatal to the stream or \ref MAY be treated as fatal to the current GOP.
John Koleszar's avatar
John Koleszar committed
118
   */
clang-format's avatar
clang-format committed
119
  VPX_CODEC_UNSUP_FEATURE,
John Koleszar's avatar
John Koleszar committed
120

clang-format's avatar
clang-format committed
121
  /*!\brief The coded data for this stream is corrupt or incomplete
John Koleszar's avatar
John Koleszar committed
122
   *
clang-format's avatar
clang-format committed
123 124 125 126 127
   * There was a problem decoding the current frame.  This return code
   * should only be used for failures that prevent future pictures from
   * being properly decoded. This error \ref MAY be treated as fatal to the
   * stream or \ref MAY be treated as fatal to the current GOP. If decoding
   * is continued for the current GOP, artifacts may be present.
John Koleszar's avatar
John Koleszar committed
128
   */
clang-format's avatar
clang-format committed
129 130 131
  VPX_CODEC_CORRUPT_FRAME,

  /*!\brief An application-supplied parameter is not valid.
John Koleszar's avatar
John Koleszar committed
132 133
   *
   */
clang-format's avatar
clang-format committed
134
  VPX_CODEC_INVALID_PARAM,
John Koleszar's avatar
John Koleszar committed
135

clang-format's avatar
clang-format committed
136
  /*!\brief An iterator reached the end of list.
John Koleszar's avatar
John Koleszar committed
137 138
   *
   */
clang-format's avatar
clang-format committed
139
  VPX_CODEC_LIST_END
John Koleszar's avatar
John Koleszar committed
140

clang-format's avatar
clang-format committed
141
} vpx_codec_err_t;
John Koleszar's avatar
John Koleszar committed
142

clang-format's avatar
clang-format committed
143 144 145 146 147 148 149 150 151 152 153
/*! \brief Codec capabilities bitfield
 *
 *  Each codec advertises the capabilities it supports as part of its
 *  ::vpx_codec_iface_t interface structure. Capabilities are extra interfaces
 *  or functionality, and are not required to be supported.
 *
 *  The available flags are specified by VPX_CODEC_CAP_* defines.
 */
typedef long vpx_codec_caps_t;
#define VPX_CODEC_CAP_DECODER 0x1 /**< Is a decoder */
#define VPX_CODEC_CAP_ENCODER 0x2 /**< Is an encoder */
John Koleszar's avatar
John Koleszar committed
154

clang-format's avatar
clang-format committed
155 156 157 158 159 160 161 162
/*! \brief Initialization-time Feature Enabling
 *
 *  Certain codec features must be known at initialization time, to allow for
 *  proper memory allocation.
 *
 *  The available flags are specified by VPX_CODEC_USE_* defines.
 */
typedef long vpx_codec_flags_t;
John Koleszar's avatar
John Koleszar committed
163

clang-format's avatar
clang-format committed
164 165 166 167 168 169
/*!\brief Codec interface structure.
 *
 * Contains function pointers and other data private to the codec
 * implementation. This structure is opaque to the application.
 */
typedef const struct vpx_codec_iface vpx_codec_iface_t;
John Koleszar's avatar
John Koleszar committed
170

clang-format's avatar
clang-format committed
171 172 173 174 175 176
/*!\brief Codec private data structure.
 *
 * Contains data private to the codec implementation. This structure is opaque
 * to the application.
 */
typedef struct vpx_codec_priv vpx_codec_priv_t;
John Koleszar's avatar
John Koleszar committed
177

clang-format's avatar
clang-format committed
178 179 180 181 182
/*!\brief Iterator
 *
 * Opaque storage used for iterating over lists.
 */
typedef const void *vpx_codec_iter_t;
John Koleszar's avatar
John Koleszar committed
183

clang-format's avatar
clang-format committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
/*!\brief Codec context structure
 *
 * All codecs \ref MUST support this context structure fully. In general,
 * this data should be considered private to the codec algorithm, and
 * not be manipulated or examined by the calling application. Applications
 * may reference the 'name' member to get a printable description of the
 * algorithm.
 */
typedef struct vpx_codec_ctx {
  const char *name;             /**< Printable interface name */
  vpx_codec_iface_t *iface;     /**< Interface pointers */
  vpx_codec_err_t err;          /**< Last returned error */
  const char *err_detail;       /**< Detailed info, if available */
  vpx_codec_flags_t init_flags; /**< Flags passed at init time */
  union {
    /**< Decoder Configuration Pointer */
    const struct vpx_codec_dec_cfg *dec;
    /**< Encoder Configuration Pointer */
    const struct vpx_codec_enc_cfg *enc;
    const void *raw;
  } config;               /**< Configuration pointer aliasing union */
  vpx_codec_priv_t *priv; /**< Algorithm private storage */
} vpx_codec_ctx_t;

/*!\brief Bit depth for codec
 * *
 * This enumeration determines the bit depth of the codec.
 */
typedef enum vpx_bit_depth {
  VPX_BITS_8 = 8,   /**<  8 bits */
  VPX_BITS_10 = 10, /**< 10 bits */
  VPX_BITS_12 = 12, /**< 12 bits */
} vpx_bit_depth_t;
John Koleszar's avatar
John Koleszar committed
217

clang-format's avatar
clang-format committed
218 219 220 221 222 223 224 225
/*
 * 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"
 */
John Koleszar's avatar
John Koleszar committed
226

clang-format's avatar
clang-format committed
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
/*!\brief Return the version information (as an integer)
 *
 * Returns a packed encoding of the library version number. This will only
 * include
 * the major.minor.patch component of the version number. Note that this encoded
 * value should be accessed through the macros provided, as the encoding may
 * change
 * in the future.
 *
 */
int vpx_codec_version(void);
#define VPX_VERSION_MAJOR(v) \
  ((v >> 16) & 0xff) /**< extract major from packed version */
#define VPX_VERSION_MINOR(v) \
  ((v >> 8) & 0xff) /**< extract minor from packed version */
#define VPX_VERSION_PATCH(v) \
  ((v >> 0) & 0xff) /**< extract patch from packed version */
John Koleszar's avatar
John Koleszar committed
244

clang-format's avatar
clang-format committed
245 246
/*!\brief Return the version major number */
#define vpx_codec_version_major() ((vpx_codec_version() >> 16) & 0xff)
John Koleszar's avatar
John Koleszar committed
247

clang-format's avatar
clang-format committed
248 249
/*!\brief Return the version minor number */
#define vpx_codec_version_minor() ((vpx_codec_version() >> 8) & 0xff)
John Koleszar's avatar
John Koleszar committed
250

clang-format's avatar
clang-format committed
251 252
/*!\brief Return the version patch number */
#define vpx_codec_version_patch() ((vpx_codec_version() >> 0) & 0xff)
John Koleszar's avatar
John Koleszar committed
253

clang-format's avatar
clang-format committed
254 255 256 257 258 259 260 261 262 263
/*!\brief Return the version information (as a string)
 *
 * Returns a printable string containing the full library version number. This
 * may
 * contain additional text following the three digit version number, as to
 * indicate
 * release candidates, prerelease versions, etc.
 *
 */
const char *vpx_codec_version_str(void);
John Koleszar's avatar
John Koleszar committed
264

clang-format's avatar
clang-format committed
265 266 267 268 269 270 271 272
/*!\brief Return the version information (as a string)
 *
 * Returns a printable "extra string". This is the component of the string
 * returned
 * by vpx_codec_version_str() following the three digit version number.
 *
 */
const char *vpx_codec_version_extra_str(void);
John Koleszar's avatar
John Koleszar committed
273

clang-format's avatar
clang-format committed
274 275 276 277 278 279 280
/*!\brief Return the build configuration
 *
 * Returns a printable string containing an encoded version of the build
 * configuration. This may be useful to vpx support.
 *
 */
const char *vpx_codec_build_config(void);
John Koleszar's avatar
John Koleszar committed
281

clang-format's avatar
clang-format committed
282 283 284 285 286 287 288 289
/*!\brief Return the name for a given interface
 *
 * Returns a human readable string for name of the given codec interface.
 *
 * \param[in]    iface     Interface pointer
 *
 */
const char *vpx_codec_iface_name(vpx_codec_iface_t *iface);
John Koleszar's avatar
John Koleszar committed
290

clang-format's avatar
clang-format committed
291 292 293 294 295 296 297 298 299 300 301
/*!\brief Convert error number to printable string
 *
 * Returns a human readable string for the last error returned by the
 * algorithm. The returned error will be one line and will not contain
 * any newline characters.
 *
 *
 * \param[in]    err     Error number.
 *
 */
const char *vpx_codec_err_to_string(vpx_codec_err_t err);
John Koleszar's avatar
John Koleszar committed
302

clang-format's avatar
clang-format committed
303 304 305 306 307 308 309 310 311 312 313
/*!\brief Retrieve error synopsis for codec context
 *
 * Returns a human readable string for the last error returned by the
 * algorithm. The returned error will be one line and will not contain
 * any newline characters.
 *
 *
 * \param[in]    ctx     Pointer to this instance's context.
 *
 */
const char *vpx_codec_error(vpx_codec_ctx_t *ctx);
John Koleszar's avatar
John Koleszar committed
314

clang-format's avatar
clang-format committed
315 316 317 318 319 320 321 322 323 324 325
/*!\brief Retrieve detailed error information for codec context
 *
 * Returns a human readable string providing detailed information about
 * the last error.
 *
 * \param[in]    ctx     Pointer to this instance's context.
 *
 * \retval NULL
 *     No detailed information is available.
 */
const char *vpx_codec_error_detail(vpx_codec_ctx_t *ctx);
John Koleszar's avatar
John Koleszar committed
326

clang-format's avatar
clang-format committed
327 328 329 330 331
/* REQUIRED FUNCTIONS
 *
 * The following functions are required to be implemented for all codecs.
 * They represent the base case functionality expected of all codecs.
 */
John Koleszar's avatar
John Koleszar committed
332

clang-format's avatar
clang-format committed
333 334 335 336 337 338 339 340 341 342 343 344
/*!\brief Destroy a codec instance
 *
 * Destroys a codec context, freeing any associated memory buffers.
 *
 * \param[in] ctx   Pointer to this instance's context
 *
 * \retval #VPX_CODEC_OK
 *     The codec algorithm initialized.
 * \retval #VPX_CODEC_MEM_ERROR
 *     Memory allocation failed.
 */
vpx_codec_err_t vpx_codec_destroy(vpx_codec_ctx_t *ctx);
John Koleszar's avatar
John Koleszar committed
345

clang-format's avatar
clang-format committed
346 347 348 349 350 351 352 353
/*!\brief Get the capabilities of an algorithm.
 *
 * Retrieves the capabilities bitfield from the algorithm's interface.
 *
 * \param[in] iface   Pointer to the algorithm interface
 *
 */
vpx_codec_caps_t vpx_codec_get_caps(vpx_codec_iface_t *iface);
John Koleszar's avatar
John Koleszar committed
354

clang-format's avatar
clang-format committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
/*!\brief Control algorithm
 *
 * This function is used to exchange algorithm specific data with the codec
 * instance. This can be used to implement features specific to a particular
 * algorithm.
 *
 * This wrapper function dispatches the request to the helper function
 * associated with the given ctrl_id. It tries to call this function
 * transparently, but will return #VPX_CODEC_ERROR if the request could not
 * be dispatched.
 *
 * Note that this function should not be used directly. Call the
 * #vpx_codec_control wrapper macro instead.
 *
 * \param[in]     ctx              Pointer to this instance's context
 * \param[in]     ctrl_id          Algorithm specific control identifier
 *
 * \retval #VPX_CODEC_OK
 *     The control request was processed.
 * \retval #VPX_CODEC_ERROR
 *     The control request was not processed.
 * \retval #VPX_CODEC_INVALID_PARAM
 *     The data was not valid.
 */
vpx_codec_err_t vpx_codec_control_(vpx_codec_ctx_t *ctx, int ctrl_id, ...);
John Koleszar's avatar
John Koleszar committed
380
#if defined(VPX_DISABLE_CTRL_TYPECHECKS) && VPX_DISABLE_CTRL_TYPECHECKS
clang-format's avatar
clang-format committed
381 382 383 384
#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)
John Koleszar's avatar
John Koleszar committed
385 386

#else
clang-format's avatar
clang-format committed
387 388 389 390 391 392 393 394 395 396 397
/*!\brief vpx_codec_control wrapper macro
 *
 * This macro allows for type safe conversions across the variadic parameter
 * to vpx_codec_control_().
 *
 * \internal
 * It works by dispatching the call to the control function through a wrapper
 * function named with the id parameter.
 */
#define vpx_codec_control(ctx, id, data) \
  vpx_codec_control_##id(ctx, id, data) /**<\hideinitializer*/
John Koleszar's avatar
John Koleszar committed
398

clang-format's avatar
clang-format committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
/*!\brief vpx_codec_control type definition macro
 *
 * This macro allows for type safe conversions across the variadic parameter
 * to vpx_codec_control_(). It defines the type of the argument for a given
 * control identifier.
 *
 * \internal
 * It defines a static function with
 * the correctly typed arguments as a wrapper to the type-unsafe internal
 * function.
 */
#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);                           \
John Koleszar's avatar
John Koleszar committed
417 418
  } /**<\hideinitializer*/

clang-format's avatar
clang-format committed
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
/*!\brief vpx_codec_control deprecated type definition macro
 *
 * Like #VPX_CTRL_USE_TYPE, but indicates that the specified control is
 * deprecated and should not be used. Consult the documentation for your
 * codec for more information.
 *
 * \internal
 * It defines a static function with the correctly typed arguments as a
 * wrapper to the type-unsafe internal function.
 */
#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);                   \
John Koleszar's avatar
John Koleszar committed
436 437
  } /**<\hideinitializer*/

clang-format's avatar
clang-format committed
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
/*!\brief vpx_codec_control void type definition macro
 *
 * This macro allows for type safe conversions across the variadic parameter
 * to vpx_codec_control_(). It indicates that a given control identifier takes
 * no argument.
 *
 * \internal
 * It defines a static function without a data argument as a wrapper to the
 * type-unsafe internal function.
 */
#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);                            \
John Koleszar's avatar
John Koleszar committed
455
  } /**<\hideinitializer*/
John Koleszar's avatar
John Koleszar committed
456 457 458

#endif

clang-format's avatar
clang-format committed
459
/*!@} - end defgroup codec*/
John Koleszar's avatar
John Koleszar committed
460 461 462
#ifdef __cplusplus
}
#endif
James Zern's avatar
James Zern committed
463
#endif  // VPX_VPX_CODEC_H_