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 12 /*!\defgroup aom AOM 13 * \ingroup codecs 14 * AOM is aom's newest video compression algorithm that uses motion 15 * compensated prediction, Discrete Cosine Transform (DCT) coding of the 16 * prediction error signal and context dependent entropy coding techniques 17 * based on arithmetic principles. It features: 18 * - YUV 4:2:0 image format 19 * - Macro-block based coding (16x16 luma plus two 8x8 chroma) 20 * - 1/4 (1/8) pixel accuracy motion compensated prediction 21 * - 4x4 DCT transform 22 * - 128 level linear quantizer 23 * - In loop deblocking filter 24 * - Context-based entropy coding 25 * 26 * @{ 27 */ 28 /*!\file 29 * \brief Provides controls common to both the AOM encoder and decoder. 30 */ 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 41 /*!\brief Control functions 42 * 43 * The set of macros define the control functions of AOM interface 44 */ 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, /**< get a pointer to a reference frame, 52 av1_ref_frame_t* parameter */ 53 AV1_SET_REFERENCE = 129, /**< write a frame into a reference buffer, 54 av1_ref_frame_t* parameter */ 55 AV1_COPY_REFERENCE = 130, /**< get a copy of reference frame from the decoderm 56 av1_ref_frame_t* parameter */ 57 AOM_COMMON_CTRL_ID_MAX, 58 59 AV1_GET_NEW_FRAME_IMAGE = 60 192, /**< get a pointer to the new frame, aom_image_t* parameter */ 61 AV1_COPY_NEW_FRAME_IMAGE = 193, /**< copy the new frame to an external buffer, 62 aom_image_t* parameter */ 63 64 AOM_DECODER_CTRL_ID_START = 256 65 }; 66 67 /*!\brief AV1 specific reference frame data struct 68 * 69 * Define the data struct to access av1 reference frames. 70 */ 71 typedef struct av1_ref_frame { 72 int idx; /**< frame index to get (input) */ 73 int use_external_ref; /**< Directly use external ref buffer(decoder only) */ 74 aom_image_t img; /**< img structure to populate (output) */ 75 } av1_ref_frame_t; 76 77 /*!\cond */ 78 /*!\brief aom decoder control function parameter type 79 * 80 * Defines the data type for each of AOM decoder control function requires. 81 * 82 * \note For each control ID "X", a macro-define of 83 * AOM_CTRL_X is provided. It is used at compile time to determine 84 * if the control ID is supported by the libaom library available, 85 * when the libaom version cannot be controlled. 86 */ 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 102 /*!\endcond */ 103 /*! @} - end defgroup aom */ 104 105 #ifdef __cplusplus 106 } // extern "C" 107 #endif 108 109 #endif // AOM_AOM_AOM_H_ 110