2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
13 * \brief Describes the vpx image descriptor and associated operations
16 #ifndef VPX_VPX_IMAGE_H_
17 #define VPX_VPX_IMAGE_H_
23 /*!\brief Current ABI version number
26 * If this file is altered in any way that changes the ABI, this value
27 * must be bumped. Examples include, but are not limited to, changing
28 * types, removing or reassigning enums, adding/removing/rearranging
29 * fields to structures
31 #define VPX_IMAGE_ABI_VERSION (2) /**<\hideinitializer*/
34 #define VPX_IMG_FMT_PLANAR 0x100 /**< Image is a planar format. */
35 #define VPX_IMG_FMT_UV_FLIP 0x200 /**< V plane precedes U in memory. */
36 #define VPX_IMG_FMT_HAS_ALPHA 0x400 /**< Image has an alpha channel. */
37 #define VPX_IMG_FMT_HIGHBITDEPTH 0x800 /**< Image uses 16bit framebuffer. */
39 /*!\brief List of supported image formats */
40 typedef enum vpx_img_fmt {
42 VPX_IMG_FMT_RGB24, /**< 24 bit per pixel packed RGB */
43 VPX_IMG_FMT_RGB32, /**< 32 bit per pixel packed 0RGB */
44 VPX_IMG_FMT_RGB565, /**< 16 bit per pixel, 565 */
45 VPX_IMG_FMT_RGB555, /**< 16 bit per pixel, 555 */
46 VPX_IMG_FMT_UYVY, /**< UYVY packed YUV */
47 VPX_IMG_FMT_YUY2, /**< YUYV packed YUV */
48 VPX_IMG_FMT_YVYU, /**< YVYU packed YUV */
49 VPX_IMG_FMT_BGR24, /**< 24 bit per pixel packed BGR */
50 VPX_IMG_FMT_RGB32_LE, /**< 32 bit packed BGR0 */
51 VPX_IMG_FMT_ARGB, /**< 32 bit packed ARGB, alpha=255 */
52 VPX_IMG_FMT_ARGB_LE, /**< 32 bit packed BGRA, alpha=255 */
53 VPX_IMG_FMT_RGB565_LE, /**< 16 bit per pixel, gggbbbbb rrrrrggg */
54 VPX_IMG_FMT_RGB555_LE, /**< 16 bit per pixel, gggbbbbb 0rrrrrgg */
55 VPX_IMG_FMT_YV12 = VPX_IMG_FMT_PLANAR | VPX_IMG_FMT_UV_FLIP | 1, /**< planar YVU */
56 VPX_IMG_FMT_I420 = VPX_IMG_FMT_PLANAR | 2,
57 VPX_IMG_FMT_VPXYV12 = VPX_IMG_FMT_PLANAR | VPX_IMG_FMT_UV_FLIP | 3, /** < planar 4:2:0 format with vpx color space */
58 VPX_IMG_FMT_VPXI420 = VPX_IMG_FMT_PLANAR | 4,
59 VPX_IMG_FMT_I422 = VPX_IMG_FMT_PLANAR | 5,
60 VPX_IMG_FMT_I444 = VPX_IMG_FMT_PLANAR | 6,
61 VPX_IMG_FMT_I440 = VPX_IMG_FMT_PLANAR | 7,
62 VPX_IMG_FMT_444A = VPX_IMG_FMT_PLANAR | VPX_IMG_FMT_HAS_ALPHA | 6,
63 VPX_IMG_FMT_I42016 = VPX_IMG_FMT_I420 | VPX_IMG_FMT_HIGHBITDEPTH,
64 VPX_IMG_FMT_I42216 = VPX_IMG_FMT_I422 | VPX_IMG_FMT_HIGHBITDEPTH,
65 VPX_IMG_FMT_I44416 = VPX_IMG_FMT_I444 | VPX_IMG_FMT_HIGHBITDEPTH,
66 VPX_IMG_FMT_I44016 = VPX_IMG_FMT_I440 | VPX_IMG_FMT_HIGHBITDEPTH
67 } vpx_img_fmt_t; /**< alias for enum vpx_img_fmt */
69 /**\brief Image Descriptor */
70 typedef struct vpx_image {
71 vpx_img_fmt_t fmt; /**< Image Format */
73 /* Image storage dimensions */
74 unsigned int w; /**< Stored image width */
75 unsigned int h; /**< Stored image height */
76 unsigned int bit_depth; /**< Stored image bit-depth */
78 /* Image display dimensions */
79 unsigned int d_w; /**< Displayed image width */
80 unsigned int d_h; /**< Displayed image height */
82 /* Chroma subsampling info */
83 unsigned int x_chroma_shift; /**< subsampling order, X */
84 unsigned int y_chroma_shift; /**< subsampling order, Y */
86 /* Image data pointers. */
87 #define VPX_PLANE_PACKED 0 /**< To be used for all packed formats */
88 #define VPX_PLANE_Y 0 /**< Y (Luminance) plane */
89 #define VPX_PLANE_U 1 /**< U (Chroma) plane */
90 #define VPX_PLANE_V 2 /**< V (Chroma) plane */
91 #define VPX_PLANE_ALPHA 3 /**< A (Transparency) plane */
92 unsigned char *planes[4]; /**< pointer to the top left pixel for each plane */
93 int stride[4]; /**< stride between rows for each plane */
95 int bps; /**< bits per sample (for packed formats) */
97 /* The following member may be set by the application to associate data
100 void *user_priv; /**< may be set by the application to associate data
101 * with this image. */
103 /* The following members should be treated as private. */
104 unsigned char *img_data; /**< private */
105 int img_data_owner; /**< private */
106 int self_allocd; /**< private */
108 void *fb_priv; /**< Frame buffer data associated with the image. */
109 } vpx_image_t; /**< alias for struct vpx_image */
111 /**\brief Representation of a rectangle on a surface */
112 typedef struct vpx_image_rect {
113 unsigned int x; /**< leftmost column */
114 unsigned int y; /**< topmost row */
115 unsigned int w; /**< width */
116 unsigned int h; /**< height */
117 } vpx_image_rect_t; /**< alias for struct vpx_image_rect */
119 /*!\brief Open a descriptor, allocating storage for the underlying image
121 * Returns a descriptor for storing an image of the given format. The
122 * storage for the descriptor is allocated on the heap.
124 * \param[in] img Pointer to storage for descriptor. If this parameter
125 * is NULL, the storage for the descriptor will be
126 * allocated on the heap.
127 * \param[in] fmt Format for the image
128 * \param[in] d_w Width of the image
129 * \param[in] d_h Height of the image
130 * \param[in] align Alignment, in bytes, of the image buffer and
131 * each row in the image(stride).
133 * \return Returns a pointer to the initialized image descriptor. If the img
134 * parameter is non-null, the value of the img parameter will be
137 vpx_image_t *vpx_img_alloc(vpx_image_t *img,
143 /*!\brief Open a descriptor, using existing storage for the underlying image
145 * Returns a descriptor for storing an image of the given format. The
146 * storage for descriptor has been allocated elsewhere, and a descriptor is
147 * desired to "wrap" that storage.
149 * \param[in] img Pointer to storage for descriptor. If this parameter
150 * is NULL, the storage for the descriptor will be
151 * allocated on the heap.
152 * \param[in] fmt Format for the image
153 * \param[in] d_w Width of the image
154 * \param[in] d_h Height of the image
155 * \param[in] align Alignment, in bytes, of each row in the image.
156 * \param[in] img_data Storage to use for the image
158 * \return Returns a pointer to the initialized image descriptor. If the img
159 * parameter is non-null, the value of the img parameter will be
162 vpx_image_t *vpx_img_wrap(vpx_image_t *img,
167 unsigned char *img_data);
170 /*!\brief Set the rectangle identifying the displayed portion of the image
172 * Updates the displayed rectangle (aka viewport) on the image surface to
173 * match the specified coordinates and size.
175 * \param[in] img Image descriptor
176 * \param[in] x leftmost column
177 * \param[in] y topmost row
179 * \param[in] h height
181 * \return 0 if the requested rectangle is valid, nonzero otherwise.
183 int vpx_img_set_rect(vpx_image_t *img,
190 /*!\brief Flip the image vertically (top for bottom)
192 * Adjusts the image descriptor's pointers and strides to make the image
193 * be referenced upside-down.
195 * \param[in] img Image descriptor
197 void vpx_img_flip(vpx_image_t *img);
199 /*!\brief Close an image descriptor
201 * Frees all allocated storage associated with an image descriptor.
203 * \param[in] img Image descriptor
205 void vpx_img_free(vpx_image_t *img);
211 #endif // VPX_VPX_IMAGE_H_