AOMedia AV1 Codec
yv12config.h
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 #ifndef AOM_AOM_SCALE_YV12CONFIG_H_
13 #define AOM_AOM_SCALE_YV12CONFIG_H_
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 #include <stdbool.h>
20 
21 #include "config/aom_config.h"
22 
23 #include "aom/aom_codec.h"
24 #include "aom/aom_frame_buffer.h"
25 #include "aom/aom_integer.h"
26 #include "aom/internal/aom_image_internal.h"
27 
30 #define AOMINNERBORDERINPIXELS 160
31 #define AOM_INTERP_EXTEND 4
32 #define AOM_BORDER_IN_PIXELS 288
33 #define AOM_ENC_NO_SCALE_BORDER 160
34 #define AOM_ENC_ALLINTRA_BORDER 64
35 #define AOM_DEC_BORDER_IN_PIXELS 64
36 
37 #if CONFIG_AV1_ENCODER && !CONFIG_REALTIME_ONLY
38 struct image_pyramid;
39 struct corner_list;
40 #endif // CONFIG_AV1_ENCODER && !CONFIG_REALTIME_ONLY
41 
46 typedef struct yv12_buffer_config {
48  union {
49  struct {
50  // The aligned frame width of luma.
51  // It is aligned to a multiple of 8:
52  // y_width = (y_crop_width + 7) & ~7
53  int y_width;
54  // The aligned frame width of chroma.
55  // uv_width = y_width >> subsampling_x
56  int uv_width;
57  };
58  int widths[2];
59  };
60  union {
61  struct {
62  // The aligned frame height of luma.
63  // It is aligned to a multiple of 8:
64  // y_height = (y_crop_height + 7) & ~7
65  int y_height;
66  // The aligned frame height of chroma.
67  // uv_height = y_height >> subsampling_y
68  int uv_height;
69  };
70  int heights[2];
71  };
72  // The frame size en/decoded by AV1
73  union {
74  struct {
75  int y_crop_width;
76  int uv_crop_width;
77  };
78  int crop_widths[2];
79  };
80  union {
81  struct {
82  int y_crop_height;
83  int uv_crop_height;
84  };
85  int crop_heights[2];
86  };
87  union {
88  struct {
89  int y_stride;
90  int uv_stride;
91  };
92  int strides[2];
93  };
94  union {
95  struct {
96  uint8_t *y_buffer;
97  uint8_t *u_buffer;
98  uint8_t *v_buffer;
99  };
100  uint8_t *buffers[3];
101  };
102 
103  // Indicate whether y_buffer, u_buffer, and v_buffer points to the internally
104  // allocated memory or external buffers.
105  int use_external_reference_buffers;
106  // This is needed to store y_buffer, u_buffer, and v_buffer when set reference
107  // uses an external refernece, and restore those buffer pointers after the
108  // external reference frame is no longer used.
109  uint8_t *store_buf_adr[3];
110 
111  // Global motion search data
112 #if CONFIG_AV1_ENCODER && !CONFIG_REALTIME_ONLY
113  // 8-bit downsampling pyramid for the Y plane
114  struct image_pyramid *y_pyramid;
115  struct corner_list *corners;
116 #endif // CONFIG_AV1_ENCODER && !CONFIG_REALTIME_ONLY
117 
118  uint8_t *buffer_alloc;
119  size_t buffer_alloc_sz;
120  int border;
121  size_t frame_size;
122  int subsampling_x;
123  int subsampling_y;
124  unsigned int bit_depth;
125  aom_color_primaries_t color_primaries;
126  aom_transfer_characteristics_t transfer_characteristics;
127  aom_matrix_coefficients_t matrix_coefficients;
128  uint8_t monochrome;
129  aom_chroma_sample_position_t chroma_sample_position;
130  aom_color_range_t color_range;
131  int render_width;
132  int render_height;
133 
134  int corrupted;
135  int flags;
136  aom_metadata_array_t *metadata;
139 
142 #define YV12_FLAG_HIGHBITDEPTH 8
143 
144 // Allocate a frame buffer
145 //
146 // If ybf currently contains an image, all associated memory will be freed and
147 // then reallocated. In contrast, aom_realloc_frame_buffer() will reuse any
148 // existing allocations where possible. So, if ybf is likely to already be
149 // set up, please consider aom_realloc_frame_buffer() instead.
150 //
151 // See aom_realloc_frame_buffer() for the meanings of the arguments, and
152 // available return values.
153 int aom_alloc_frame_buffer(YV12_BUFFER_CONFIG *ybf, int width, int height,
154  int ss_x, int ss_y, int use_highbitdepth, int border,
155  int byte_alignment, bool alloc_pyramid,
156  int alloc_y_plane_only);
157 
158 // Updates the yv12 buffer config with the frame buffer. |byte_alignment| must
159 // be a power of 2, from 32 to 1024. 0 sets legacy alignment. If cb is not
160 // NULL, then libaom is using the frame buffer callbacks to handle memory.
161 // If cb is not NULL, libaom will call cb with minimum size in bytes needed
162 // to decode the current frame. If cb is NULL, libaom will allocate memory
163 // internally to decode the current frame.
164 //
165 // If alloc_pyramid is true, then an image pyramid will be allocated
166 // for use in global motion estimation. This is only needed if this frame
167 // buffer will be used to store a source frame or a reference frame in
168 // the encoder. Any other framebuffers (eg, intermediates for filtering,
169 // or any buffer in the decoder) can set alloc_pyramid = false.
170 //
171 // Returns 0 on success. Returns < 0 on failure.
172 int aom_realloc_frame_buffer(YV12_BUFFER_CONFIG *ybf, int width, int height,
173  int ss_x, int ss_y, int use_highbitdepth,
174  int border, int byte_alignment,
176  aom_get_frame_buffer_cb_fn_t cb, void *cb_priv,
177  bool alloc_pyramid, int alloc_y_plane_only);
178 
179 int aom_free_frame_buffer(YV12_BUFFER_CONFIG *ybf);
180 
189 void aom_remove_metadata_from_frame_buffer(YV12_BUFFER_CONFIG *ybf);
190 
204 int aom_copy_metadata_to_frame_buffer(YV12_BUFFER_CONFIG *ybf,
205  const aom_metadata_array_t *arr);
206 
215 static AOM_INLINE int aom_calc_y_stride(int aligned_width, int border) {
216  return ((aligned_width + 2 * border) + 31) & ~31;
217 }
218 
219 #ifdef __cplusplus
220 }
221 #endif
222 
223 #endif // AOM_AOM_SCALE_YV12CONFIG_H_
Describes the codec algorithm interface to applications.
Describes the decoder external frame buffer interface.
int(* aom_get_frame_buffer_cb_fn_t)(void *priv, size_t min_size, aom_codec_frame_buffer_t *fb)
get frame buffer callback prototype
Definition: aom_frame_buffer.h:64
enum aom_chroma_sample_position aom_chroma_sample_position_t
List of chroma sample positions.
struct aom_metadata_array aom_metadata_array_t
Array of aom_metadata structs for an image.
Definition: aom_image.h:171
enum aom_transfer_characteristics aom_transfer_characteristics_t
List of supported transfer functions.
enum aom_color_range aom_color_range_t
List of supported color range.
enum aom_color_primaries aom_color_primaries_t
List of supported color primaries.
enum aom_matrix_coefficients aom_matrix_coefficients_t
List of supported matrix coefficients.
External frame buffer.
Definition: aom_frame_buffer.h:40
YV12 frame buffer data structure.
Definition: yv12config.h:46