vpx_codec/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_t
 Image Descriptor. More...
struct  vpx_image_rect
 Representation of a rectangle on a surface. More...

Defines

#define VPX_IMAGE_ABI_VERSION
 Current ABI version number.
#define IMG_FMT_PLANAR   0x100
#define IMG_FMT_UV_FLIP   0x200
#define IMG_FMT_HAS_ALPHA   0x400
#define PLANE_PACKED   0
#define PLANE_Y   0
#define PLANE_U   1
#define PLANE_V   2
#define PLANE_ALPHA   3

Typedefs

typedef enum img_fmt img_fmt_t
 List of supported image formats.
typedef struct vpx_image_rect vpx_image_rect_t
 Representation of a rectangle on a surface.

Enumerations

enum  img_fmt {
  IMG_FMT_NONE, IMG_FMT_RGB24, IMG_FMT_RGB32, IMG_FMT_RGB565,
  IMG_FMT_RGB555, IMG_FMT_UYVY, IMG_FMT_YUY2, IMG_FMT_YVYU,
  IMG_FMT_BGR24, IMG_FMT_RGB32_LE, IMG_FMT_ARGB, IMG_FMT_ARGB_LE,
  IMG_FMT_RGB565_LE, IMG_FMT_RGB555_LE, IMG_FMT_YV12 = 0x100 | 0x200 | 1, IMG_FMT_I420 = 0x100 | 2,
  IMG_FMT_VPXYV12 = 0x100 | 0x200 | 3, IMG_FMT_VPXI420 = 0x100 | 4
}
 

List of supported image formats.

More...

Functions

vpx_image_tvpx_img_alloc (vpx_image_t *img, 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, 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 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.


Define Documentation

#define IMG_FMT_PLANAR   0x100

Image is a planar format

#define IMG_FMT_UV_FLIP   0x200

V plane precedes U plane in memory

#define IMG_FMT_HAS_ALPHA   0x400

Image has an alpha channel componnent

#define PLANE_PACKED   0

To be used for all packed formats

#define PLANE_Y   0

Y (Luminance) plane

#define PLANE_U   1

U (Chroma) plane

#define PLANE_V   2

V (Chroma) plane

#define PLANE_ALPHA   3

A (Transparancy) plane


Typedef Documentation

typedef enum img_fmt img_fmt_t

List of supported image formats.

alias for enum img_fmt

Representation of a rectangle on a surface.

alias for struct vpx_image_rect


Enumeration Type Documentation

enum img_fmt

List of supported image formats.

Enumerator:
IMG_FMT_RGB24 

24 bit per pixel packed RGB

IMG_FMT_RGB32 

32 bit per pixel packed 0RGB

IMG_FMT_RGB565 

16 bit per pixel, 565

IMG_FMT_RGB555 

16 bit per pixel, 555

IMG_FMT_UYVY 

UYVY packed YUV

IMG_FMT_YUY2 

YUYV packed YUV

IMG_FMT_YVYU 

YVYU packed YUV

IMG_FMT_BGR24 

24 bit per pixel packed BGR

IMG_FMT_RGB32_LE 

32 bit packed BGR0

IMG_FMT_ARGB 

32 bit packed ARGB, alpha=255

IMG_FMT_ARGB_LE 

32 bit packed BGRA, alpha=255

IMG_FMT_RGB565_LE 

16 bit per pixel, gggbbbbb rrrrrggg

IMG_FMT_RGB555_LE 

16 bit per pixel, gggbbbbb 0rrrrrgg

IMG_FMT_YV12 

planar YVU

IMG_FMT_VPXI420 

< planar 4:2:0 format with vpx color space


Function Documentation

vpx_image_t* vpx_img_alloc ( vpx_image_t img,
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] img Pointer to storage for descriptor. If this parameter is NULL, the storage for the descriptor will be allocated on the heap.
[in] fmt Format for the image
[in] d_w Width of the image
[in] d_h Height of the image
[in] align Alignment, in bytes, of each row in 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_image_t* vpx_img_wrap ( vpx_image_t img,
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.

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] img Pointer to storage for descriptor. If this parameter is NULL, the storage for the descriptor will be allocated on the heap.
[in] fmt Format for the image
[in] d_w Width of the image
[in] d_h Height of the image
[in] align Alignment, in bytes, of each row in the image.
[in] img_data Storage 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.
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.

Parameters:
[in] img Image descriptor
[in] x leftmost column
[in] y topmost row
[in] w width
[in] h height
Returns:
0 if the requested rectangle is valid, nonzero otherwise.
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] img Image descriptor
void vpx_img_free ( vpx_image_t img  ) 

Close an image descriptor.

Frees all allocated storage associated with an image descriptor.

Parameters:
[in] img Image descriptor

Generated on 24 Jul 2010 for WebM VP8 Codec SDK by  doxygen 1.6.1