WebM Codec SDK

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

vpx_decoder.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 #ifndef VPX_VPX_DECODER_H_
11 #define VPX_VPX_DECODER_H_
12
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include "./vpx_codec.h"
33 #include "./vpx_frame_buffer.h"
34
43 #define VPX_DECODER_ABI_VERSION (3 + VPX_CODEC_ABI_VERSION)
53 #define VPX_CODEC_CAP_PUT_SLICE 0x10000
54 #define VPX_CODEC_CAP_PUT_FRAME 0x20000
55 #define VPX_CODEC_CAP_POSTPROC 0x40000
56 #define VPX_CODEC_CAP_ERROR_CONCEALMENT 0x80000
58 #define VPX_CODEC_CAP_INPUT_FRAGMENTS 0x100000
68 #define VPX_CODEC_CAP_FRAME_THREADING 0x200000
70 #define VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER 0x400000
73 #define VPX_CODEC_USE_POSTPROC 0x10000
74 #define VPX_CODEC_USE_ERROR_CONCEALMENT 0x20000
76 #define VPX_CODEC_USE_INPUT_FRAGMENTS 0x40000
79 #define VPX_CODEC_USE_FRAME_THREADING 0x80000
88 typedef struct vpx_codec_stream_info {
89 unsigned int sz;
90 unsigned int w;
91 unsigned int h;
92 unsigned int is_kf;
93 } vpx_codec_stream_info_t;
94
95 /* REQUIRED FUNCTIONS
96 *
97 * The following functions are required to be implemented for all decoders.
98 * They represent the base case functionality expected of all decoders.
99 */
100
101
107 typedef struct vpx_codec_dec_cfg {
108 unsigned int threads;
109 unsigned int w;
110 unsigned int h;
111 } vpx_codec_dec_cfg_t;
136 vpx_codec_err_t vpx_codec_dec_init_ver(vpx_codec_ctx_t *ctx,
137 vpx_codec_iface_t *iface,
138 const vpx_codec_dec_cfg_t *cfg,
139 vpx_codec_flags_t flags,
140 int ver);
141
146 #define vpx_codec_dec_init(ctx, iface, cfg, flags) \
147 vpx_codec_dec_init_ver(ctx, iface, cfg, flags, VPX_DECODER_ABI_VERSION)
148
149
167 vpx_codec_err_t vpx_codec_peek_stream_info(vpx_codec_iface_t *iface,
168 const uint8_t *data,
169 unsigned int data_sz,
170 vpx_codec_stream_info_t *si);
171
172
186 vpx_codec_err_t vpx_codec_get_stream_info(vpx_codec_ctx_t *ctx,
187 vpx_codec_stream_info_t *si);
188
189
220 vpx_codec_err_t vpx_codec_decode(vpx_codec_ctx_t *ctx,
221 const uint8_t *data,
222 unsigned int data_sz,
223 void *user_priv,
224 long deadline);
225
226
242 vpx_image_t *vpx_codec_get_frame(vpx_codec_ctx_t *ctx,
243 vpx_codec_iter_t *iter);
244
245
260 typedef void (*vpx_codec_put_frame_cb_fn_t)(void *user_priv,
261 const vpx_image_t *img);
262
263
279 vpx_codec_err_t vpx_codec_register_put_frame_cb(vpx_codec_ctx_t *ctx,
280 vpx_codec_put_frame_cb_fn_t cb,
281 void *user_priv);
282
283
300 typedef void (*vpx_codec_put_slice_cb_fn_t)(void *user_priv,
301 const vpx_image_t *img,
302 const vpx_image_rect_t *valid,
303 const vpx_image_rect_t *update);
304
305
321 vpx_codec_err_t vpx_codec_register_put_slice_cb(vpx_codec_ctx_t *ctx,
322 vpx_codec_put_slice_cb_fn_t cb,
323 void *user_priv);
324
325
366 vpx_codec_err_t vpx_codec_set_frame_buffer_functions(
367 vpx_codec_ctx_t *ctx,
368 vpx_get_frame_buffer_cb_fn_t cb_get,
369 vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv);
370
374 #ifdef __cplusplus
375 }
376 #endif
377 #endif // VPX_VPX_DECODER_H_
378
vpx_image
Image Descriptor.
Definition: vpx_image.h:82
vpx_codec_put_slice_cb_fn_t
void(* vpx_codec_put_slice_cb_fn_t)(void *user_priv, const vpx_image_t *img, const vpx_image_rect_t *valid, const vpx_image_rect_t *update)
put slice callback prototype
Definition: vpx_decoder.h:308
vpx_codec_dec_cfg::threads
unsigned int threads
Definition: vpx_decoder.h:116
vpx_codec_stream_info
Stream properties.
Definition: vpx_decoder.h:96
vpx_codec_dec_cfg::w
unsigned int w
Definition: vpx_decoder.h:117
vpx_codec_register_put_frame_cb
vpx_codec_err_t vpx_codec_register_put_frame_cb(vpx_codec_ctx_t *ctx, vpx_codec_put_frame_cb_fn_t cb, void *user_priv)
Register for notification of frame completion.
vpx_frame_buffer.h
Describes the decoder external frame buffer interface.
vpx_codec_peek_stream_info
vpx_codec_err_t vpx_codec_peek_stream_info(vpx_codec_iface_t *iface, const uint8_t *data, unsigned int data_sz, vpx_codec_stream_info_t *si)
Parse stream info from a buffer.
vpx_codec_register_put_slice_cb
vpx_codec_err_t vpx_codec_register_put_slice_cb(vpx_codec_ctx_t *ctx, vpx_codec_put_slice_cb_fn_t cb, void *user_priv)
Register for notification of slice completion.
vpx_get_frame_buffer_cb_fn_t
int(* vpx_get_frame_buffer_cb_fn_t)(void *priv, size_t min_size, vpx_codec_frame_buffer_t *fb)
get frame buffer callback prototype
Definition: vpx_frame_buffer.h:63
vpx_image_rect
Representation of a rectangle on a surface.
Definition: vpx_image.h:125
vpx_codec_dec_cfg::h
unsigned int h
Definition: vpx_decoder.h:118
vpx_codec_decode
vpx_codec_err_t vpx_codec_decode(vpx_codec_ctx_t *ctx, const uint8_t *data, unsigned int data_sz, void *user_priv, long deadline)
Decode data.
vpx_codec_iface_t
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition: vpx_codec.h:173
vpx_codec_flags_t
long vpx_codec_flags_t
Initialization-time Feature Enabling.
Definition: vpx_codec.h:165
vpx_codec_err_t
vpx_codec_err_t
Algorithm return codes.
Definition: vpx_codec.h:89
vpx_codec_stream_info_t
struct vpx_codec_stream_info vpx_codec_stream_info_t
Stream properties.
vpx_codec_put_frame_cb_fn_t
void(* vpx_codec_put_frame_cb_fn_t)(void *user_priv, const vpx_image_t *img)
put frame callback prototype
Definition: vpx_decoder.h:268
vpx_codec_dec_init_ver
vpx_codec_err_t vpx_codec_dec_init_ver(vpx_codec_ctx_t *ctx, vpx_codec_iface_t *iface, const vpx_codec_dec_cfg_t *cfg, vpx_codec_flags_t flags, int ver)
Initialize a decoder instance.
vpx_release_frame_buffer_cb_fn_t
int(* vpx_release_frame_buffer_cb_fn_t)(void *priv, vpx_codec_frame_buffer_t *fb)
release frame buffer callback prototype
Definition: vpx_frame_buffer.h:76
vpx_codec_get_stream_info
vpx_codec_err_t vpx_codec_get_stream_info(vpx_codec_ctx_t *ctx, vpx_codec_stream_info_t *si)
Return information about the current stream.
vpx_codec.h
Describes the codec algorithm interface to applications.
vpx_codec_set_frame_buffer_functions
vpx_codec_err_t vpx_codec_set_frame_buffer_functions(vpx_codec_ctx_t *ctx, vpx_get_frame_buffer_cb_fn_t cb_get, vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv)
Pass in external frame buffers for the decoder to use.
vpx_codec_dec_cfg
Initialization Configurations.
Definition: vpx_decoder.h:115
vpx_codec_iter_t
const void * vpx_codec_iter_t
Iterator.
Definition: vpx_codec.h:188
vpx_codec_get_frame
vpx_image_t * vpx_codec_get_frame(vpx_codec_ctx_t *ctx, vpx_codec_iter_t *iter)
Decoded frames iterator.
vpx_codec_dec_cfg_t
struct vpx_codec_dec_cfg vpx_codec_dec_cfg_t
Initialization Configurations.
vpx_codec_ctx
Codec context structure.
Definition: vpx_codec.h:199