AOMedia AV1 Codec
aom_image.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 
16 #ifndef AOM_AOM_AOM_IMAGE_H_
17 #define AOM_AOM_AOM_IMAGE_H_
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 #include "aom/aom_integer.h"
24 
33 #define AOM_IMAGE_ABI_VERSION (9)
35 #define AOM_IMG_FMT_PLANAR 0x100
36 #define AOM_IMG_FMT_UV_FLIP 0x200
38 #define AOM_IMG_FMT_HIGHBITDEPTH 0x800
41 typedef enum aom_img_fmt {
42  AOM_IMG_FMT_NONE,
47  3,
55 } aom_img_fmt_t;
58 typedef enum aom_color_primaries {
68  8,
91  10,
115  9,
119  12,
124 
126 typedef enum aom_color_range {
158 
160 typedef struct aom_metadata_array aom_metadata_array_t;
161 
163 typedef struct aom_metadata {
164  uint32_t type;
165  uint8_t *payload;
166  size_t sz;
169 
171 typedef struct aom_image {
180  /* Image storage dimensions */
181  unsigned int w;
182  unsigned int h;
183  unsigned int bit_depth;
185  /* Image display dimensions */
186  unsigned int d_w;
187  unsigned int d_h;
189  /* Image intended rendering dimensions */
190  unsigned int r_w;
191  unsigned int r_h;
193  /* Chroma subsampling info */
194  unsigned int x_chroma_shift;
195  unsigned int y_chroma_shift;
197 /* Image data pointers. */
198 #define AOM_PLANE_PACKED 0
199 #define AOM_PLANE_Y 0
200 #define AOM_PLANE_U 1
201 #define AOM_PLANE_V 2
202  unsigned char *planes[3];
203  int stride[3];
204  size_t sz;
206  int bps;
208  int temporal_id;
209  int spatial_id;
214  void *user_priv;
215 
216  /* The following members should be treated as private. */
217  unsigned char *img_data;
224  void *fb_priv;
225 } aom_image_t;
246  unsigned int d_w, unsigned int d_h,
247  unsigned int align);
248 
269 aom_image_t *aom_img_wrap(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w,
270  unsigned int d_h, unsigned int align,
271  unsigned char *img_data);
272 
295  unsigned int d_w, unsigned int d_h,
296  unsigned int align,
297  unsigned int size_align,
298  unsigned int border);
299 
315 int aom_img_set_rect(aom_image_t *img, unsigned int x, unsigned int y,
316  unsigned int w, unsigned int h, unsigned int border);
317 
325 void aom_img_flip(aom_image_t *img);
326 
333 void aom_img_free(aom_image_t *img);
334 
342 int aom_img_plane_width(const aom_image_t *img, int plane);
343 
351 int aom_img_plane_height(const aom_image_t *img, int plane);
352 
368 int aom_img_add_metadata(aom_image_t *img, uint32_t type, const uint8_t *data,
369  size_t sz, aom_metadata_insert_flags_t insert_flag);
370 
383  size_t index);
384 
396 size_t aom_img_num_metadata(const aom_image_t *img);
397 
406 
421 aom_metadata_t *aom_img_metadata_alloc(uint32_t type, const uint8_t *data,
422  size_t sz,
423  aom_metadata_insert_flags_t insert_flag);
424 
431 void aom_img_metadata_free(aom_metadata_t *metadata);
432 
433 #ifdef __cplusplus
434 } // extern "C"
435 #endif
436 
437 #endif // AOM_AOM_AOM_IMAGE_H_
AOM_IMG_FMT_I420
@ AOM_IMG_FMT_I420
Definition: aom_image.h:45
aom_img_remove_metadata
void aom_img_remove_metadata(aom_image_t *img)
Remove metadata from image.
aom_image::fmt
aom_img_fmt_t fmt
Definition: aom_image.h:172
AOM_CICP_TC_IEC_61966
@ AOM_CICP_TC_IEC_61966
Definition: aom_image.h:92
AOM_IMG_FMT_YV12
@ AOM_IMG_FMT_YV12
Definition: aom_image.h:43
AOM_CICP_TC_BT_2020_12_BIT
@ AOM_CICP_TC_BT_2020_12_BIT
Definition: aom_image.h:96
aom_metadata
Metadata payload.
Definition: aom_image.h:163
AOM_CICP_CP_BT_2020
@ AOM_CICP_CP_BT_2020
Definition: aom_image.h:69
AOM_CICP_CP_SMPTE_431
@ AOM_CICP_CP_SMPTE_431
Definition: aom_image.h:71
AOM_CR_FULL_RANGE
@ AOM_CR_FULL_RANGE
Definition: aom_image.h:128
aom_image::monochrome
int monochrome
Definition: aom_image.h:176
AOM_CICP_TC_SMPTE_240
@ AOM_CICP_TC_SMPTE_240
Definition: aom_image.h:87
aom_img_add_metadata
int aom_img_add_metadata(aom_image_t *img, uint32_t type, const uint8_t *data, size_t sz, aom_metadata_insert_flags_t insert_flag)
Add metadata to image.
aom_chroma_sample_position_t
enum aom_chroma_sample_position aom_chroma_sample_position_t
List of chroma sample positions.
aom_img_fmt_t
enum aom_img_fmt aom_img_fmt_t
List of supported image formats.
AOM_CICP_CP_BT_601
@ AOM_CICP_CP_BT_601
Definition: aom_image.h:65
AOM_CICP_TC_BT_709
@ AOM_CICP_TC_BT_709
Definition: aom_image.h:81
AOM_IMG_FMT_I444
@ AOM_IMG_FMT_I444
Definition: aom_image.h:50
aom_metadata_t
struct aom_metadata aom_metadata_t
Metadata payload.
aom_img_set_rect
int aom_img_set_rect(aom_image_t *img, unsigned int x, unsigned int y, unsigned int w, unsigned int h, unsigned int border)
Set the rectangle identifying the displayed portion of the image.
aom_img_metadata_free
void aom_img_metadata_free(aom_metadata_t *metadata)
Free metadata struct.
aom_metadata::type
uint32_t type
Definition: aom_image.h:164
aom_image::d_h
unsigned int d_h
Definition: aom_image.h:187
AOM_CICP_MC_ICTCP
@ AOM_CICP_MC_ICTCP
Definition: aom_image.h:121
AOM_CICP_CP_BT_470_B_G
@ AOM_CICP_CP_BT_470_B_G
Definition: aom_image.h:64
AOM_CSP_UNKNOWN
@ AOM_CSP_UNKNOWN
Definition: aom_image.h:133
aom_img_wrap
aom_image_t * aom_img_wrap(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align, unsigned char *img_data)
Open a descriptor, using existing storage for the underlying image.
AOM_CICP_MC_SMPTE_2085
@ AOM_CICP_MC_SMPTE_2085
Definition: aom_image.h:117
aom_transfer_characteristics_t
enum aom_transfer_characteristics aom_transfer_characteristics_t
List of supported transfer functions.
AOM_CICP_CP_BT_709
@ AOM_CICP_CP_BT_709
Definition: aom_image.h:60
AOM_CR_STUDIO_RANGE
@ AOM_CR_STUDIO_RANGE
Definition: aom_image.h:127
AOM_CICP_TC_UNSPECIFIED
@ AOM_CICP_TC_UNSPECIFIED
Definition: aom_image.h:82
aom_color_primaries_t
enum aom_color_primaries aom_color_primaries_t
List of supported color primaries.
AOM_CICP_CP_SMPTE_240
@ AOM_CICP_CP_SMPTE_240
Definition: aom_image.h:66
aom_chroma_sample_position
aom_chroma_sample_position
List of chroma sample positions.
Definition: aom_image.h:132
aom_metadata::payload
uint8_t * payload
Definition: aom_image.h:165
AOM_IMG_FMT_I422
@ AOM_IMG_FMT_I422
Definition: aom_image.h:49
aom_metadata_insert_flags_t
enum aom_metadata_insert_flags aom_metadata_insert_flags_t
List of insert flags for Metadata.
AOM_CICP_MC_BT_2020_NCL
@ AOM_CICP_MC_BT_2020_NCL
Definition: aom_image.h:114
aom_metadata::sz
size_t sz
Definition: aom_image.h:166
aom_img_free
void aom_img_free(aom_image_t *img)
Close an image descriptor.
AOM_IMG_FMT_AOMI420
@ AOM_IMG_FMT_AOMI420
Definition: aom_image.h:48
aom_image::y_chroma_shift
unsigned int y_chroma_shift
Definition: aom_image.h:195
aom_img_metadata_alloc
aom_metadata_t * aom_img_metadata_alloc(uint32_t type, const uint8_t *data, size_t sz, aom_metadata_insert_flags_t insert_flag)
Allocate memory for aom_metadata struct.
AOM_CICP_TC_LOG_100
@ AOM_CICP_TC_LOG_100
Definition: aom_image.h:89
AOM_CICP_TC_RESERVED_3
@ AOM_CICP_TC_RESERVED_3
Definition: aom_image.h:83
AOM_CICP_CP_SMPTE_432
@ AOM_CICP_CP_SMPTE_432
Definition: aom_image.h:72
aom_img_alloc_with_border
aom_image_t * aom_img_alloc_with_border(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align, unsigned int size_align, unsigned int border)
Open a descriptor, allocating storage for the underlying image with a border.
aom_img_alloc
aom_image_t * aom_img_alloc(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align)
Open a descriptor, allocating storage for the underlying image.
aom_img_plane_width
int aom_img_plane_width(const aom_image_t *img, int plane)
Get the width of a plane.
AOM_CICP_MC_BT_470_B_G
@ AOM_CICP_MC_BT_470_B_G
Definition: aom_image.h:110
AOM_IMG_FMT_I42216
@ AOM_IMG_FMT_I42216
Definition: aom_image.h:53
aom_image::w
unsigned int w
Definition: aom_image.h:181
AOM_CICP_CP_RESERVED_3
@ AOM_CICP_CP_RESERVED_3
Definition: aom_image.h:62
AOM_IMG_FMT_I44416
@ AOM_IMG_FMT_I44416
Definition: aom_image.h:54
AOM_CICP_TC_SMPTE_428
@ AOM_CICP_TC_SMPTE_428
Definition: aom_image.h:98
AOM_CICP_CP_RESERVED_13
@ AOM_CICP_CP_RESERVED_13
Definition: aom_image.h:73
AOM_CICP_MC_BT_601
@ AOM_CICP_MC_BT_601
Definition: aom_image.h:111
AOM_CICP_CP_XYZ
@ AOM_CICP_CP_XYZ
Definition: aom_image.h:70
AOM_CICP_TC_LINEAR
@ AOM_CICP_TC_LINEAR
Definition: aom_image.h:88
AOM_IMG_FMT_YV1216
@ AOM_IMG_FMT_YV1216
Definition: aom_image.h:52
AOM_CICP_TC_BT_1361
@ AOM_CICP_TC_BT_1361
Definition: aom_image.h:93
AOM_CSP_VERTICAL
@ AOM_CSP_VERTICAL
Definition: aom_image.h:134
aom_image::tc
aom_transfer_characteristics_t tc
Definition: aom_image.h:174
aom_metadata_insert_flags
aom_metadata_insert_flags
List of insert flags for Metadata.
Definition: aom_image.h:153
AOM_CICP_MC_UNSPECIFIED
@ AOM_CICP_MC_UNSPECIFIED
Definition: aom_image.h:107
AOM_CICP_MC_SMPTE_YCGCO
@ AOM_CICP_MC_SMPTE_YCGCO
Definition: aom_image.h:113
aom_transfer_characteristics
aom_transfer_characteristics
List of supported transfer functions.
Definition: aom_image.h:79
AOM_CSP_COLOCATED
@ AOM_CSP_COLOCATED
Definition: aom_image.h:136
aom_color_primaries
aom_color_primaries
List of supported color primaries.
Definition: aom_image.h:58
AOM_CICP_TC_BT_2020_10_BIT
@ AOM_CICP_TC_BT_2020_10_BIT
Definition: aom_image.h:95
AOM_CICP_MC_RESERVED_3
@ AOM_CICP_MC_RESERVED_3
Definition: aom_image.h:108
aom_color_range_t
enum aom_color_range aom_color_range_t
List of supported color range.
AOM_CICP_CP_EBU_3213
@ AOM_CICP_CP_EBU_3213
Definition: aom_image.h:74
AOM_CICP_TC_LOG_100_SQRT10
@ AOM_CICP_TC_LOG_100_SQRT10
Definition: aom_image.h:90
aom_image::metadata
aom_metadata_array_t * metadata
Definition: aom_image.h:222
aom_img_num_metadata
size_t aom_img_num_metadata(const aom_image_t *img)
Return the number of metadata blocks within the image.
aom_image::self_allocd
int self_allocd
Definition: aom_image.h:219
aom_image::x_chroma_shift
unsigned int x_chroma_shift
Definition: aom_image.h:194
AOM_CICP_TC_HLG
@ AOM_CICP_TC_HLG
Definition: aom_image.h:99
AOM_CICP_MC_BT_2020_CL
@ AOM_CICP_MC_BT_2020_CL
Definition: aom_image.h:116
AOM_MIF_KEY_FRAME
@ AOM_MIF_KEY_FRAME
Definition: aom_image.h:155
AOM_CSP_RESERVED
@ AOM_CSP_RESERVED
Definition: aom_image.h:137
aom_image_t
struct aom_image aom_image_t
Image Descriptor.
aom_img_flip
void aom_img_flip(aom_image_t *img)
Flip the image vertically (top for bottom)
AOM_IMG_FMT_I42016
@ AOM_IMG_FMT_I42016
Definition: aom_image.h:51
AOM_CICP_MC_FCC
@ AOM_CICP_MC_FCC
Definition: aom_image.h:109
aom_image::csp
aom_chroma_sample_position_t csp
Definition: aom_image.h:177
aom_metadata_array_t
struct aom_metadata_array aom_metadata_array_t
Array of aom_metadata structs for an image.
Definition: aom_image.h:160
AOM_CICP_MC_IDENTITY
@ AOM_CICP_MC_IDENTITY
Definition: aom_image.h:105
aom_image::bit_depth
unsigned int bit_depth
Definition: aom_image.h:183
aom_image::h
unsigned int h
Definition: aom_image.h:182
aom_img_get_metadata
const aom_metadata_t * aom_img_get_metadata(const aom_image_t *img, size_t index)
Return a metadata payload stored within the image metadata array.
AOM_CICP_CP_BT_470_M
@ AOM_CICP_CP_BT_470_M
Definition: aom_image.h:63
AOM_CICP_MC_CHROMAT_CL
@ AOM_CICP_MC_CHROMAT_CL
Definition: aom_image.h:120
aom_image::d_w
unsigned int d_w
Definition: aom_image.h:186
aom_metadata::insert_flag
aom_metadata_insert_flags_t insert_flag
Definition: aom_image.h:167
AOM_CICP_MC_CHROMAT_NCL
@ AOM_CICP_MC_CHROMAT_NCL
Definition: aom_image.h:118
AOM_CICP_TC_SMPTE_2084
@ AOM_CICP_TC_SMPTE_2084
Definition: aom_image.h:97
aom_color_range
aom_color_range
List of supported color range.
Definition: aom_image.h:126
AOM_CICP_TC_BT_470_M
@ AOM_CICP_TC_BT_470_M
Definition: aom_image.h:84
AOM_CICP_CP_RESERVED_0
@ AOM_CICP_CP_RESERVED_0
Definition: aom_image.h:59
aom_matrix_coefficients
aom_matrix_coefficients
List of supported matrix coefficients.
Definition: aom_image.h:104
AOM_MIF_ANY_FRAME
@ AOM_MIF_ANY_FRAME
Definition: aom_image.h:156
AOM_CICP_TC_SRGB
@ AOM_CICP_TC_SRGB
Definition: aom_image.h:94
AOM_IMG_FMT_PLANAR
#define AOM_IMG_FMT_PLANAR
Definition: aom_image.h:35
AOM_CICP_MC_BT_709
@ AOM_CICP_MC_BT_709
Definition: aom_image.h:106
AOM_CICP_TC_RESERVED_19
@ AOM_CICP_TC_RESERVED_19
Definition: aom_image.h:100
AOM_CICP_MC_SMPTE_240
@ AOM_CICP_MC_SMPTE_240
Definition: aom_image.h:112
aom_image
Image Descriptor.
Definition: aom_image.h:171
AOM_IMG_FMT_UV_FLIP
#define AOM_IMG_FMT_UV_FLIP
Definition: aom_image.h:36
aom_image::range
aom_color_range_t range
Definition: aom_image.h:178
AOM_CICP_TC_BT_601
@ AOM_CICP_TC_BT_601
Definition: aom_image.h:86
aom_matrix_coefficients_t
enum aom_matrix_coefficients aom_matrix_coefficients_t
List of supported matrix coefficients.
aom_image::fb_priv
void * fb_priv
Definition: aom_image.h:224
AOM_CICP_TC_BT_470_B_G
@ AOM_CICP_TC_BT_470_B_G
Definition: aom_image.h:85
aom_image::r_w
unsigned int r_w
Definition: aom_image.h:190
aom_image::r_h
unsigned int r_h
Definition: aom_image.h:191
AOM_IMG_FMT_AOMYV12
@ AOM_IMG_FMT_AOMYV12
Definition: aom_image.h:46
aom_img_plane_height
int aom_img_plane_height(const aom_image_t *img, int plane)
Get the height of a plane.
AOM_CICP_CP_GENERIC_FILM
@ AOM_CICP_CP_GENERIC_FILM
Definition: aom_image.h:67
AOM_CICP_MC_RESERVED_15
@ AOM_CICP_MC_RESERVED_15
Definition: aom_image.h:122
AOM_CICP_CP_RESERVED_23
@ AOM_CICP_CP_RESERVED_23
Definition: aom_image.h:75
AOM_CICP_TC_RESERVED_0
@ AOM_CICP_TC_RESERVED_0
Definition: aom_image.h:80
aom_image::img_data_owner
int img_data_owner
Definition: aom_image.h:218
AOM_IMG_FMT_HIGHBITDEPTH
#define AOM_IMG_FMT_HIGHBITDEPTH
Definition: aom_image.h:38
AOM_MIF_NON_KEY_FRAME
@ AOM_MIF_NON_KEY_FRAME
Definition: aom_image.h:154
aom_image::mc
aom_matrix_coefficients_t mc
Definition: aom_image.h:175
aom_image::cp
aom_color_primaries_t cp
Definition: aom_image.h:173
aom_image::img_data
unsigned char * img_data
Definition: aom_image.h:217
AOM_CICP_CP_UNSPECIFIED
@ AOM_CICP_CP_UNSPECIFIED
Definition: aom_image.h:61