AOMedia Codec SDK: aom/aom.h Source File

AOMedia Codec SDK

aom.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3 *
4 * This source code is subject to the terms of the BSD 2 Clause License and
5 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6 * was not distributed with this source code in the LICENSE file, you can
7 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8 * Media Patent License 1.0 was not distributed with this source code in the
9 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10 */
11
31 #ifndef AOM_AOM_AOM_H_
32 #define AOM_AOM_AOM_H_
33
34 #include "aom/aom_codec.h"
35 #include "aom/aom_image.h"
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
45 enum aom_com_control_id {
46 /* TODO(https://crbug.com/aomedia/2671): The encoder overlaps the range of
47 * these values for its control ids, see the NOTEs in aom/aomcx.h. These
48 * should be migrated to something like the AOM_DECODER_CTRL_ID_START range
49 * next time we're ready to break the ABI.
50 */
51 AV1_GET_REFERENCE = 128,
53 AV1_SET_REFERENCE = 129,
55 AV1_COPY_REFERENCE = 130,
57 AOM_COMMON_CTRL_ID_MAX,
58
59 AV1_GET_NEW_FRAME_IMAGE =
60 192,
61 AV1_COPY_NEW_FRAME_IMAGE = 193,
64 AOM_DECODER_CTRL_ID_START = 256
65 };
66
71 typedef struct av1_ref_frame {
72 int idx;
73 int use_external_ref;
74 aom_image_t img;
75 } av1_ref_frame_t;
76
87 AOM_CTRL_USE_TYPE(AV1_GET_REFERENCE, av1_ref_frame_t *)
88 #define AOM_CTRL_AV1_GET_REFERENCE
89
90 AOM_CTRL_USE_TYPE(AV1_SET_REFERENCE, av1_ref_frame_t *)
91 #define AOM_CTRL_AV1_SET_REFERENCE
92
93 AOM_CTRL_USE_TYPE(AV1_COPY_REFERENCE, av1_ref_frame_t *)
94 #define AOM_CTRL_AV1_COPY_REFERENCE
95
96 AOM_CTRL_USE_TYPE(AV1_GET_NEW_FRAME_IMAGE, aom_image_t *)
97 #define AOM_CTRL_AV1_GET_NEW_FRAME_IMAGE
98
99 AOM_CTRL_USE_TYPE(AV1_COPY_NEW_FRAME_IMAGE, aom_image_t *)
100 #define AOM_CTRL_AV1_COPY_NEW_FRAME_IMAGE
101
105 #ifdef __cplusplus
106 } // extern "C"
107 #endif
108
109 #endif // AOM_AOM_AOM_H_
aom_codec.h
Describes the codec algorithm interface to applications.
aom_image.h
Describes the aom image descriptor and associated operations.
av1_ref_frame_t
struct av1_ref_frame av1_ref_frame_t
AV1 specific reference frame data struct.
aom_com_control_id
aom_com_control_id
Control functions.
Definition: aom.h:45
AV1_GET_NEW_FRAME_IMAGE
@ AV1_GET_NEW_FRAME_IMAGE
Definition: aom.h:59
AV1_GET_REFERENCE
@ AV1_GET_REFERENCE
Definition: aom.h:51
AV1_SET_REFERENCE
@ AV1_SET_REFERENCE
Definition: aom.h:53
AV1_COPY_NEW_FRAME_IMAGE
@ AV1_COPY_NEW_FRAME_IMAGE
Definition: aom.h:61
AV1_COPY_REFERENCE
@ AV1_COPY_REFERENCE
Definition: aom.h:55
AOM_CTRL_USE_TYPE
#define AOM_CTRL_USE_TYPE(id, typ)
Creates typechecking mechanisms for aom_codec_control.
Definition: aom_codec.h:436
aom_image
Image Descriptor.
Definition: aom_image.h:171
av1_ref_frame
AV1 specific reference frame data struct.
Definition: aom.h:71
av1_ref_frame::use_external_ref
int use_external_ref
Definition: aom.h:73
av1_ref_frame::img
aom_image_t img
Definition: aom.h:74
av1_ref_frame::idx
int idx
Definition: aom.h:72