AOMedia Codec SDK
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
20extern "C" {
21#endif
22
23#include "aom/aom_integer.h"
24
33#define AOM_IMAGE_ABI_VERSION (5)
35#define AOM_IMG_FMT_PLANAR 0x100
36#define AOM_IMG_FMT_UV_FLIP 0x200
38#define AOM_IMG_FMT_HIGHBITDEPTH 0x800
41typedef enum aom_img_fmt {
42 AOM_IMG_FMT_NONE,
47 3,
58typedef enum aom_color_primaries {
68 8,
91 10,
115 9,
119 12,
124
126typedef enum aom_color_range {
134 AOM_CSP_VERTICAL = 1,
141typedef struct aom_image {
150 /* Image storage dimensions */
151 unsigned int w;
152 unsigned int h;
153 unsigned int bit_depth;
155 /* Image display dimensions */
156 unsigned int d_w;
157 unsigned int d_h;
159 /* Image intended rendering dimensions */
160 unsigned int r_w;
161 unsigned int r_h;
163 /* Chroma subsampling info */
164 unsigned int x_chroma_shift;
165 unsigned int y_chroma_shift;
167/* Image data pointers. */
168#define AOM_PLANE_PACKED 0
169#define AOM_PLANE_Y 0
170#define AOM_PLANE_U 1
171#define AOM_PLANE_V 2
172 unsigned char *planes[3];
173 int stride[3];
174 size_t sz;
176 int bps;
185
186 /* The following members should be treated as private. */
187 unsigned char *img_data;
191 void *fb_priv;
195typedef struct aom_image_rect {
196 unsigned int x;
197 unsigned int y;
198 unsigned int w;
199 unsigned int h;
221 unsigned int d_w, unsigned int d_h,
222 unsigned int align);
223
245 unsigned int d_h, unsigned int align,
246 unsigned char *img_data);
247
270 unsigned int d_w, unsigned int d_h,
271 unsigned int align,
272 unsigned int size_align,
273 unsigned int border);
274
289int aom_img_set_rect(aom_image_t *img, unsigned int x, unsigned int y,
290 unsigned int w, unsigned int h, unsigned int border);
291
300
308
316int aom_img_plane_width(const aom_image_t *img, int plane);
317
325int aom_img_plane_height(const aom_image_t *img, int plane);
326
327#ifdef __cplusplus
328} // extern "C"
329#endif
330
331#endif // AOM_AOM_AOM_IMAGE_H_
struct aom_image_rect aom_image_rect_t
Representation of a rectangle on a surface.
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_chroma_sample_position
List of chroma sample positions.
Definition: aom_image.h:132
@ AOM_CSP_COLOCATED
Definition: aom_image.h:136
@ AOM_CSP_UNKNOWN
Definition: aom_image.h:133
@ AOM_CSP_RESERVED
Definition: aom_image.h:137
@ AOM_CSP_VERTICAL
Definition: aom_image.h:134
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.
void aom_img_flip(aom_image_t *img)
Flip the image vertically (top for bottom)
enum aom_chroma_sample_position aom_chroma_sample_position_t
List of chroma sample positions.
aom_transfer_characteristics
List of supported transfer functions.
Definition: aom_image.h:79
@ AOM_CICP_TC_BT_2020_10_BIT
Definition: aom_image.h:95
@ AOM_CICP_TC_RESERVED_19
Definition: aom_image.h:100
@ AOM_CICP_TC_RESERVED_0
Definition: aom_image.h:80
@ AOM_CICP_TC_BT_470_M
Definition: aom_image.h:84
@ AOM_CICP_TC_HLG
Definition: aom_image.h:99
@ AOM_CICP_TC_SMPTE_428
Definition: aom_image.h:98
@ AOM_CICP_TC_RESERVED_3
Definition: aom_image.h:83
@ AOM_CICP_TC_LOG_100
Definition: aom_image.h:89
@ AOM_CICP_TC_IEC_61966
Definition: aom_image.h:92
@ AOM_CICP_TC_BT_601
Definition: aom_image.h:86
@ AOM_CICP_TC_BT_470_B_G
Definition: aom_image.h:85
@ AOM_CICP_TC_LOG_100_SQRT10
Definition: aom_image.h:90
@ AOM_CICP_TC_UNSPECIFIED
Definition: aom_image.h:82
@ AOM_CICP_TC_SRGB
Definition: aom_image.h:94
@ AOM_CICP_TC_LINEAR
Definition: aom_image.h:88
@ AOM_CICP_TC_SMPTE_2084
Definition: aom_image.h:97
@ AOM_CICP_TC_SMPTE_240
Definition: aom_image.h:87
@ AOM_CICP_TC_BT_1361
Definition: aom_image.h:93
@ AOM_CICP_TC_BT_2020_12_BIT
Definition: aom_image.h:96
@ AOM_CICP_TC_BT_709
Definition: aom_image.h:81
enum aom_transfer_characteristics aom_transfer_characteristics_t
List of supported transfer functions.
aom_color_primaries
List of supported color primaries.
Definition: aom_image.h:58
@ AOM_CICP_CP_UNSPECIFIED
Definition: aom_image.h:61
@ AOM_CICP_CP_SMPTE_240
Definition: aom_image.h:66
@ AOM_CICP_CP_SMPTE_432
Definition: aom_image.h:72
@ AOM_CICP_CP_RESERVED_23
Definition: aom_image.h:75
@ AOM_CICP_CP_BT_601
Definition: aom_image.h:65
@ AOM_CICP_CP_RESERVED_13
Definition: aom_image.h:73
@ AOM_CICP_CP_SMPTE_431
Definition: aom_image.h:71
@ AOM_CICP_CP_BT_470_M
Definition: aom_image.h:63
@ AOM_CICP_CP_XYZ
Definition: aom_image.h:70
@ AOM_CICP_CP_BT_2020
Definition: aom_image.h:69
@ AOM_CICP_CP_RESERVED_0
Definition: aom_image.h:59
@ AOM_CICP_CP_BT_470_B_G
Definition: aom_image.h:64
@ AOM_CICP_CP_GENERIC_FILM
Definition: aom_image.h:67
@ AOM_CICP_CP_BT_709
Definition: aom_image.h:60
@ AOM_CICP_CP_EBU_3213
Definition: aom_image.h:74
@ AOM_CICP_CP_RESERVED_3
Definition: aom_image.h:62
enum aom_color_range aom_color_range_t
List of supported color range.
#define AOM_IMG_FMT_HIGHBITDEPTH
Definition: aom_image.h:38
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_matrix_coefficients
List of supported matrix coefficients.
Definition: aom_image.h:104
@ AOM_CICP_MC_UNSPECIFIED
Definition: aom_image.h:107
@ AOM_CICP_MC_BT_601
Definition: aom_image.h:111
@ AOM_CICP_MC_IDENTITY
Definition: aom_image.h:105
@ AOM_CICP_MC_RESERVED_15
Definition: aom_image.h:122
@ AOM_CICP_MC_CHROMAT_NCL
Definition: aom_image.h:118
@ AOM_CICP_MC_BT_2020_CL
Definition: aom_image.h:116
@ AOM_CICP_MC_SMPTE_2085
Definition: aom_image.h:117
@ AOM_CICP_MC_SMPTE_240
Definition: aom_image.h:112
@ AOM_CICP_MC_RESERVED_3
Definition: aom_image.h:108
@ AOM_CICP_MC_ICTCP
Definition: aom_image.h:121
@ AOM_CICP_MC_SMPTE_YCGCO
Definition: aom_image.h:113
@ AOM_CICP_MC_CHROMAT_CL
Definition: aom_image.h:120
@ AOM_CICP_MC_BT_709
Definition: aom_image.h:106
@ AOM_CICP_MC_BT_2020_NCL
Definition: aom_image.h:114
@ AOM_CICP_MC_FCC
Definition: aom_image.h:109
@ AOM_CICP_MC_BT_470_B_G
Definition: aom_image.h:110
#define AOM_IMG_FMT_PLANAR
Definition: aom_image.h:35
enum aom_color_primaries aom_color_primaries_t
List of supported color primaries.
aom_img_fmt
List of supported image formats.
Definition: aom_image.h:41
@ AOM_IMG_FMT_I42216
Definition: aom_image.h:53
@ AOM_IMG_FMT_I42016
Definition: aom_image.h:51
@ AOM_IMG_FMT_AOMI420
Definition: aom_image.h:48
@ AOM_IMG_FMT_YV1216
Definition: aom_image.h:52
@ AOM_IMG_FMT_I444
Definition: aom_image.h:50
@ AOM_IMG_FMT_I422
Definition: aom_image.h:49
@ AOM_IMG_FMT_I44416
Definition: aom_image.h:54
@ AOM_IMG_FMT_I420
Definition: aom_image.h:45
@ AOM_IMG_FMT_YV12
Definition: aom_image.h:43
@ AOM_IMG_FMT_AOMYV12
Definition: aom_image.h:46
enum aom_matrix_coefficients aom_matrix_coefficients_t
List of supported matrix coefficients.
enum aom_img_fmt aom_img_fmt_t
List of supported image formats.
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.
int aom_img_plane_height(const aom_image_t *img, int plane)
Get the height of a plane.
aom_color_range
List of supported color range.
Definition: aom_image.h:126
@ AOM_CR_STUDIO_RANGE
Definition: aom_image.h:127
@ AOM_CR_FULL_RANGE
Definition: aom_image.h:128
int aom_img_plane_width(const aom_image_t *img, int plane)
Get the width of a plane.
#define AOM_IMG_FMT_UV_FLIP
Definition: aom_image.h:36
struct aom_image aom_image_t
Image Descriptor.
void aom_img_free(aom_image_t *img)
Close an image descriptor.
Representation of a rectangle on a surface.
Definition: aom_image.h:195
unsigned int x
Definition: aom_image.h:196
unsigned int h
Definition: aom_image.h:199
unsigned int y
Definition: aom_image.h:197
unsigned int w
Definition: aom_image.h:198
Image Descriptor.
Definition: aom_image.h:141
int temporal_id
Definition: aom_image.h:178
int spatial_id
Definition: aom_image.h:179
unsigned int h
Definition: aom_image.h:152
unsigned int bit_depth
Definition: aom_image.h:153
aom_matrix_coefficients_t mc
Definition: aom_image.h:145
aom_chroma_sample_position_t csp
Definition: aom_image.h:147
void * user_priv
The following member may be set by the application to associate data with this image.
Definition: aom_image.h:184
unsigned int y_chroma_shift
Definition: aom_image.h:165
unsigned int w
Definition: aom_image.h:151
aom_img_fmt_t fmt
Definition: aom_image.h:142
int stride[3]
Definition: aom_image.h:173
unsigned char * img_data
Definition: aom_image.h:187
unsigned int x_chroma_shift
Definition: aom_image.h:164
unsigned int d_w
Definition: aom_image.h:156
int bps
Definition: aom_image.h:176
unsigned int r_w
Definition: aom_image.h:160
aom_transfer_characteristics_t tc
Definition: aom_image.h:144
unsigned int r_h
Definition: aom_image.h:161
void * fb_priv
Definition: aom_image.h:191
int monochrome
Definition: aom_image.h:146
unsigned int d_h
Definition: aom_image.h:157
aom_color_range_t range
Definition: aom_image.h:148
unsigned char * planes[3]
Definition: aom_image.h:172
int img_data_owner
Definition: aom_image.h:188
int self_allocd
Definition: aom_image.h:189
aom_color_primaries_t cp
Definition: aom_image.h:143
size_t sz
Definition: aom_image.h:174