WebM Codec SDK
Data Structures | Macros | Typedefs | Enumerations | Functions
vpx_image.h File Reference

Describes the vpx image descriptor and associated operations. More...

Go to the source code of this file.

Data Structures

struct  vpx_image
 Image Descriptor. More...
 
struct  vpx_image_rect
 Representation of a rectangle on a surface. More...
 

Macros

#define VPX_IMAGE_ABI_VERSION
 Current ABI version number.
 
#define VPX_IMG_FMT_PLANAR   0x100
 
#define VPX_IMG_FMT_UV_FLIP   0x200
 
#define VPX_IMG_FMT_HAS_ALPHA   0x400
 
#define VPX_IMG_FMT_HIGHBITDEPTH   0x800
 
#define VPX_PLANE_PACKED   0
 
#define VPX_PLANE_Y   0
 
#define VPX_PLANE_U   1
 
#define VPX_PLANE_V   2
 
#define VPX_PLANE_ALPHA   3
 

Typedefs

typedef enum vpx_img_fmt vpx_img_fmt_t
 List of supported image formats.
 
typedef enum vpx_color_space vpx_color_space_t
 List of supported color spaces.
 
typedef enum vpx_color_range vpx_color_range_t
 List of supported color range.
 
typedef struct vpx_image vpx_image_t
 Image Descriptor.
 
typedef struct vpx_image_rect vpx_image_rect_t
 Representation of a rectangle on a surface.
 

Enumerations

enum  vpx_img_fmt {
  VPX_IMG_FMT_NONE , VPX_IMG_FMT_YV12 , VPX_IMG_FMT_I420 = 0x100 | 2 , VPX_IMG_FMT_I422 = 0x100 | 5 ,
  VPX_IMG_FMT_I444 = 0x100 | 6 , VPX_IMG_FMT_I440 = 0x100 | 7 , VPX_IMG_FMT_NV12 = 0x100 | 9 , VPX_IMG_FMT_I42016 = VPX_IMG_FMT_I420 | 0x800 ,
  VPX_IMG_FMT_I42216 = VPX_IMG_FMT_I422 | 0x800 , VPX_IMG_FMT_I44416 = VPX_IMG_FMT_I444 | 0x800 , VPX_IMG_FMT_I44016 = VPX_IMG_FMT_I440 | 0x800
}
 List of supported image formats. More...
 
enum  vpx_color_space {
  VPX_CS_UNKNOWN = 0 , VPX_CS_BT_601 = 1 , VPX_CS_BT_709 = 2 , VPX_CS_SMPTE_170 = 3 ,
  VPX_CS_SMPTE_240 = 4 , VPX_CS_BT_2020 = 5 , VPX_CS_RESERVED = 6 , VPX_CS_SRGB = 7
}
 List of supported color spaces. More...
 
enum  vpx_color_range { VPX_CR_STUDIO_RANGE = 0 , VPX_CR_FULL_RANGE = 1 }
 List of supported color range. More...
 

Functions

vpx_image_tvpx_img_alloc (vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align)
 Open a descriptor, allocating storage for the underlying image.
 
vpx_image_tvpx_img_wrap (vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int stride_align, unsigned char *img_data)
 Open a descriptor, using existing storage for the underlying image.
 
int vpx_img_set_rect (vpx_image_t *img, unsigned int x, unsigned int y, unsigned int w, unsigned int h)
 Set the rectangle identifying the displayed portion of the image.
 
void vpx_img_flip (vpx_image_t *img)
 Flip the image vertically (top for bottom)
 
void vpx_img_free (vpx_image_t *img)
 Close an image descriptor.
 

Detailed Description

Describes the vpx image descriptor and associated operations.

Macro Definition Documentation

◆ VPX_IMG_FMT_PLANAR

#define VPX_IMG_FMT_PLANAR   0x100

Image is a planar format.

◆ VPX_IMG_FMT_UV_FLIP

#define VPX_IMG_FMT_UV_FLIP   0x200

V plane precedes U in memory.

◆ VPX_IMG_FMT_HAS_ALPHA

#define VPX_IMG_FMT_HAS_ALPHA   0x400

Image has an alpha channel.

◆ VPX_IMG_FMT_HIGHBITDEPTH

#define VPX_IMG_FMT_HIGHBITDEPTH   0x800

Image uses 16bit framebuffer.

◆ VPX_PLANE_PACKED

#define VPX_PLANE_PACKED   0

To be used for all packed formats

◆ VPX_PLANE_Y

#define VPX_PLANE_Y   0

Y (Luminance) plane

◆ VPX_PLANE_U

#define VPX_PLANE_U   1

U (Chroma) plane

◆ VPX_PLANE_V

#define VPX_PLANE_V   2

V (Chroma) plane

◆ VPX_PLANE_ALPHA

#define VPX_PLANE_ALPHA   3

A (Transparency) plane

Typedef Documentation

◆ vpx_img_fmt_t

typedef enum vpx_img_fmt vpx_img_fmt_t

List of supported image formats.

alias for enum vpx_img_fmt

◆ vpx_color_space_t

List of supported color spaces.

alias for enum vpx_color_space

◆ vpx_color_range_t

List of supported color range.

alias for enum vpx_color_range

◆ vpx_image_t

typedef struct vpx_image vpx_image_t

Image Descriptor.

alias for struct vpx_image

◆ vpx_image_rect_t

Representation of a rectangle on a surface.

alias for struct vpx_image_rect

Enumeration Type Documentation

◆ vpx_img_fmt

List of supported image formats.

Enumerator
VPX_IMG_FMT_YV12 

Image is a planar format. V plane precedes U in memory. planar YVU

VPX_IMG_FMT_I420 

Image is a planar format.

VPX_IMG_FMT_I422 

Image is a planar format.

VPX_IMG_FMT_I444 

Image is a planar format.

VPX_IMG_FMT_I440 

Image is a planar format.

VPX_IMG_FMT_NV12 

Image is a planar format.

VPX_IMG_FMT_I42016 

Image uses 16bit framebuffer.

VPX_IMG_FMT_I42216 

Image uses 16bit framebuffer.

VPX_IMG_FMT_I44416 

Image uses 16bit framebuffer.

VPX_IMG_FMT_I44016 

Image uses 16bit framebuffer.

◆ vpx_color_space

List of supported color spaces.

Enumerator
VPX_CS_UNKNOWN 

Unknown

VPX_CS_BT_601 

BT.601

VPX_CS_BT_709 

BT.709

VPX_CS_SMPTE_170 

SMPTE.170

VPX_CS_SMPTE_240 

SMPTE.240

VPX_CS_BT_2020 

BT.2020

VPX_CS_RESERVED 

Reserved

VPX_CS_SRGB 

sRGB

◆ vpx_color_range

List of supported color range.

Enumerator
VPX_CR_STUDIO_RANGE 

Y [16..235], UV [16..240]

VPX_CR_FULL_RANGE 

YUV/RGB [0..255]

Function Documentation

◆ vpx_img_alloc()

vpx_image_t * vpx_img_alloc ( vpx_image_t * img,
vpx_img_fmt_t fmt,
unsigned int d_w,
unsigned int d_h,
unsigned int align )

Open a descriptor, allocating storage for the underlying image.

Returns a descriptor for storing an image of the given format. The storage for the descriptor is allocated on the heap.

Parameters
[in]imgPointer to storage for descriptor. If this parameter is NULL, the storage for the descriptor will be allocated on the heap.
[in]fmtFormat for the image
[in]d_wWidth of the image
[in]d_hHeight of the image
[in]alignAlignment, in bytes, of the image buffer and each row in the image(stride).
Returns
Returns a pointer to the initialized image descriptor. If the img parameter is non-null, the value of the img parameter will be returned.

◆ vpx_img_wrap()

vpx_image_t * vpx_img_wrap ( vpx_image_t * img,
vpx_img_fmt_t fmt,
unsigned int d_w,
unsigned int d_h,
unsigned int stride_align,
unsigned char * img_data )

Open a descriptor, using existing storage for the underlying image.

Returns a descriptor for storing an image of the given format. The storage for descriptor has been allocated elsewhere, and a descriptor is desired to "wrap" that storage.

Parameters
[in]imgPointer to storage for descriptor. If this parameter is NULL, the storage for the descriptor will be allocated on the heap.
[in]fmtFormat for the image
[in]d_wWidth of the image
[in]d_hHeight of the image
[in]stride_alignAlignment, in bytes, of each row in the image.
[in]img_dataStorage to use for the image
Returns
Returns a pointer to the initialized image descriptor. If the img parameter is non-null, the value of the img parameter will be returned.

◆ vpx_img_set_rect()

int vpx_img_set_rect ( vpx_image_t * img,
unsigned int x,
unsigned int y,
unsigned int w,
unsigned int h )

Set the rectangle identifying the displayed portion of the image.

Updates the displayed rectangle (aka viewport) on the image surface to match the specified coordinates and size. Specifically, sets img->d_w, img->d_h, and elements of the img->planes[] array.

Parameters
[in]imgImage descriptor
[in]xleftmost column
[in]ytopmost row
[in]wwidth
[in]hheight
Returns
0 if the requested rectangle is valid, nonzero (-1) otherwise.

◆ vpx_img_flip()

void vpx_img_flip ( vpx_image_t * img)

Flip the image vertically (top for bottom)

Adjusts the image descriptor's pointers and strides to make the image be referenced upside-down.

Parameters
[in]imgImage descriptor

◆ vpx_img_free()

void vpx_img_free ( vpx_image_t * img)

Close an image descriptor.

Frees all allocated storage associated with an image descriptor.

Parameters
[in]imgImage descriptor