WebM Codec SDK
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_VPX_DECODER_H_
11 #define VPX_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 \
44  (3 + VPX_CODEC_ABI_VERSION)
54 #define VPX_CODEC_CAP_PUT_SLICE 0x10000
55 #define VPX_CODEC_CAP_PUT_FRAME 0x20000
56 #define VPX_CODEC_CAP_POSTPROC 0x40000
58 #define VPX_CODEC_CAP_ERROR_CONCEALMENT 0x80000
60 #define VPX_CODEC_CAP_INPUT_FRAGMENTS 0x100000
62 #define VPX_CODEC_CAP_FRAME_THREADING 0x200000
64 #define VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER 0x400000
65 
73 #define VPX_CODEC_USE_POSTPROC 0x10000
75 #define VPX_CODEC_USE_ERROR_CONCEALMENT 0x20000
78 #define VPX_CODEC_USE_INPUT_FRAGMENTS 0x40000
80 #define VPX_CODEC_USE_FRAME_THREADING 0x80000
81 
88 typedef struct vpx_codec_stream_info {
89  unsigned int sz;
90  unsigned int w;
91  unsigned int h;
92  unsigned int is_kf;
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 
106 typedef struct vpx_codec_dec_cfg {
107  unsigned int threads;
108  unsigned int w;
109  unsigned int h;
135  vpx_codec_iface_t *iface,
136  const vpx_codec_dec_cfg_t *cfg,
137  vpx_codec_flags_t flags, int ver);
138 
143 #define vpx_codec_dec_init(ctx, iface, cfg, flags) \
144  vpx_codec_dec_init_ver(ctx, iface, cfg, flags, VPX_DECODER_ABI_VERSION)
145 
164  const uint8_t *data,
165  unsigned int data_sz,
167 
183 
215  unsigned int data_sz, void *user_priv,
216  long deadline);
217 
235 
250 typedef void (*vpx_codec_put_frame_cb_fn_t)(void *user_priv,
251  const vpx_image_t *img);
252 
271  void *user_priv);
272 
289 typedef void (*vpx_codec_put_slice_cb_fn_t)(void *user_priv,
290  const vpx_image_t *img,
291  const vpx_image_rect_t *valid,
292  const vpx_image_rect_t *update);
293 
312  void *user_priv);
313 
357  vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv);
358 
362 #ifdef __cplusplus
363 }
364 #endif
365 #endif // VPX_VPX_VPX_DECODER_H_
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_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.
void(* vpx_codec_put_frame_cb_fn_t)(void *user_priv, const vpx_image_t *img)
put frame callback prototype
Definition: vpx_decoder.h:250
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:289
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.
long vpx_codec_flags_t
Initialization-time Feature Enabling.
Definition: vpx_codec.h:170
const void * vpx_codec_iter_t
Iterator.
Definition: vpx_codec.h:190
vpx_codec_err_t
Algorithm return codes.
Definition: vpx_codec.h:93
const struct vpx_codec_iface vpx_codec_iface_t
Codec interface structure.
Definition: vpx_codec.h:177
vpx_image_t * vpx_codec_get_frame(vpx_codec_ctx_t *ctx, vpx_codec_iter_t *iter)
Decoded frames iterator.
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_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_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.
struct vpx_codec_dec_cfg vpx_codec_dec_cfg_t
Initialization Configurations.
struct vpx_codec_stream_info vpx_codec_stream_info_t
Stream properties.
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.
Codec context structure.
Definition: vpx_codec.h:200
Initialization Configurations.
Definition: vpx_decoder.h:106
unsigned int h
Definition: vpx_decoder.h:109
unsigned int w
Definition: vpx_decoder.h:108
unsigned int threads
Definition: vpx_decoder.h:107
Stream properties.
Definition: vpx_decoder.h:88
unsigned int is_kf
Definition: vpx_decoder.h:92
unsigned int sz
Definition: vpx_decoder.h:89
unsigned int w
Definition: vpx_decoder.h:90
unsigned int h
Definition: vpx_decoder.h:91
Representation of a rectangle on a surface.
Definition: vpx_image.h:119
Image Descriptor.
Definition: vpx_image.h:72
Describes the codec algorithm interface to applications.
Describes the decoder external frame buffer interface.
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
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