aom_image Struct Reference

Image Descriptor. More...

#include <aom_image.h>

Data Fields
aom_img_fmt_t	fmt
aom_color_primaries_t	cp
	CICP Color Primaries. More...
aom_transfer_characteristics_t	tc
	CICP Transfer Characteristics. More...
aom_matrix_coefficients_t	mc
	CICP Matrix Coefficients. More...
int	monochrome
	Whether image is monochrome. More...
aom_chroma_sample_position_t	csp
	Chroma sample position. More...
aom_color_range_t	range
	Color Range. More...
unsigned int	w
unsigned int	h
unsigned int	bit_depth
unsigned int	d_w
unsigned int	d_h
unsigned int	r_w
unsigned int	r_h
unsigned int	x_chroma_shift
unsigned int	y_chroma_shift
unsigned char *	planes [3]
int	stride [3]
size_t	sz
int	bps
int	temporal_id
int	spatial_id
void *	user_priv
	The following member may be set by the application to associate data with this image.
unsigned char *	img_data
int	img_data_owner
int	self_allocd
aom_metadata_array_t *	metadata
void *	fb_priv

Detailed Description

Image Descriptor.

Field Documentation

aom_img_fmt_t aom_image::fmt

Image Format

aom_color_primaries_t aom_image::cp

CICP Color Primaries.

Attention

Only set by the decoder. To control the value used by the encoder, use the AV1E_SET_COLOR_PRIMARIES codec control.

aom_transfer_characteristics_t aom_image::tc

CICP Transfer Characteristics.

Attention

Only set by the decoder. To control the value used by the encoder, use the AV1E_SET_TRANSFER_CHARACTERISTICS codec control.

aom_matrix_coefficients_t aom_image::mc

CICP Matrix Coefficients.

Attention

Only set by the decoder. To control the value used by the encoder, use the AV1E_SET_MATRIX_COEFFICIENTS codec control.

int aom_image::monochrome

Whether image is monochrome.

Attention

Only set by the decoder. To control the encoder behavior, set aom_codec_enc_cfg_t::monochrome.

aom_chroma_sample_position_t aom_image::csp

Chroma sample position.

Attention

Only set by the decoder. To control the value used by the encoder, use the AV1E_SET_CHROMA_SAMPLE_POSITION codec control.

aom_color_range_t aom_image::range

Color Range.

Attention

Only set by the decoder. To control the value used by the encoder, use the AV1E_SET_COLOR_RANGE codec control.

unsigned int aom_image::w

Stored image width

unsigned int aom_image::h

Stored image height

unsigned int aom_image::bit_depth

Stored image bit-depth

unsigned int aom_image::d_w

Displayed image width

unsigned int aom_image::d_h

Displayed image height

unsigned int aom_image::r_w

Intended rendering image width

unsigned int aom_image::r_h

Intended rendering image height

unsigned int aom_image::x_chroma_shift

subsampling order, X

unsigned int aom_image::y_chroma_shift

subsampling order, Y

unsigned char* aom_image::planes[3]

pointer to the top left pixel for each plane

int aom_image::stride[3]

Stride between rows for each plane

Note

With planar formats, stride[AOM_PLANE_U] must be the same as stride[AOM_PLANE_V].

size_t aom_image::sz

data size

int aom_image::bps

bits per sample (for packed formats)

int aom_image::temporal_id

Temporal layer Id of image

int aom_image::spatial_id

Spatial layer Id of image

unsigned char* aom_image::img_data

private

int aom_image::img_data_owner

private

int aom_image::self_allocd

private

aom_metadata_array_t* aom_image::metadata

Metadata payloads associated with the image.

void* aom_image::fb_priv

Frame buffer data associated with the image.

---

The documentation for this struct was generated from the following file:

• aom/aom_image.h