1 /* 2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved. 3 * 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. 9 */ 10 11 12 /*!\file 13 * \brief Describes the vpx image descriptor and associated operations 14 * 15 */ 16 #ifdef __cplusplus 17 extern "C" { 18 #endif 19 20 #ifndef VPX_IMAGE_H 21 #define VPX_IMAGE_H 22 23 /*!\brief Current ABI version number 24 * 25 * \internal 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 30 */ 31 #define VPX_IMAGE_ABI_VERSION (1) /**<\hideinitializer*/ 32 33 34 #define VPX_IMG_FMT_PLANAR 0x100 /**< Image is a planar format */ 35 #define VPX_IMG_FMT_UV_FLIP 0x200 /**< V plane precedes U plane in memory */ 36 #define VPX_IMG_FMT_HAS_ALPHA 0x400 /**< Image has an alpha channel component */ 37 38 39 /*!\brief List of supported image formats */ 40 typedef enum vpx_img_fmt { 41 VPX_IMG_FMT_NONE, 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 /** < planar 4:2:0 format with vpx color space */ 59 } 60 vpx_img_fmt_t; /**< alias for enum vpx_img_fmt */ 61 62 #if !defined(VPX_CODEC_DISABLE_COMPAT) || !VPX_CODEC_DISABLE_COMPAT 63 #define IMG_FMT_PLANAR VPX_IMG_FMT_PLANAR /**< \deprecated Use #VPX_IMG_FMT_PLANAR */ 64 #define IMG_FMT_UV_FLIP VPX_IMG_FMT_UV_FLIP /**< \deprecated Use #VPX_IMG_FMT_UV_FLIP */ 65 #define IMG_FMT_HAS_ALPHA VPX_IMG_FMT_HAS_ALPHA /**< \deprecated Use #VPX_IMG_FMT_HAS_ALPHA */ 66 67 /*!\brief Deprecated list of supported image formats 68 * \deprecated New code should use #vpx_img_fmt 69 */ 70 #define img_fmt vpx_img_fmt 71 /*!\brief alias for enum img_fmt. 72 * \deprecated New code should use #vpx_img_fmt_t 73 */ 74 #define img_fmt_t vpx_img_fmt_t 75 76 #define IMG_FMT_NONE VPX_IMG_FMT_NONE /**< \deprecated Use #VPX_IMG_FMT_NONE */ 77 #define IMG_FMT_RGB24 VPX_IMG_FMT_RGB24 /**< \deprecated Use #VPX_IMG_FMT_RGB24 */ 78 #define IMG_FMT_RGB32 VPX_IMG_FMT_RGB32 /**< \deprecated Use #VPX_IMG_FMT_RGB32 */ 79 #define IMG_FMT_RGB565 VPX_IMG_FMT_RGB565 /**< \deprecated Use #VPX_IMG_FMT_RGB565 */ 80 #define IMG_FMT_RGB555 VPX_IMG_FMT_RGB555 /**< \deprecated Use #VPX_IMG_FMT_RGB555 */ 81 #define IMG_FMT_UYVY VPX_IMG_FMT_UYVY /**< \deprecated Use #VPX_IMG_FMT_UYVY */ 82 #define IMG_FMT_YUY2 VPX_IMG_FMT_YUY2 /**< \deprecated Use #VPX_IMG_FMT_YUY2 */ 83 #define IMG_FMT_YVYU VPX_IMG_FMT_YVYU /**< \deprecated Use #VPX_IMG_FMT_YVYU */ 84 #define IMG_FMT_BGR24 VPX_IMG_FMT_BGR24 /**< \deprecated Use #VPX_IMG_FMT_BGR24 */ 85 #define IMG_FMT_RGB32_LE VPX_IMG_FMT_RGB32_LE /**< \deprecated Use #VPX_IMG_FMT_RGB32_LE */ 86 #define IMG_FMT_ARGB VPX_IMG_FMT_ARGB /**< \deprecated Use #VPX_IMG_FMT_ARGB */ 87 #define IMG_FMT_ARGB_LE VPX_IMG_FMT_ARGB_LE /**< \deprecated Use #VPX_IMG_FMT_ARGB_LE */ 88 #define IMG_FMT_RGB565_LE VPX_IMG_FMT_RGB565_LE /**< \deprecated Use #VPX_IMG_FMT_RGB565_LE */ 89 #define IMG_FMT_RGB555_LE VPX_IMG_FMT_RGB555_LE /**< \deprecated Use #VPX_IMG_FMT_RGB555_LE */ 90 #define IMG_FMT_YV12 VPX_IMG_FMT_YV12 /**< \deprecated Use #VPX_IMG_FMT_YV12 */ 91 #define IMG_FMT_I420 VPX_IMG_FMT_I420 /**< \deprecated Use #VPX_IMG_FMT_I420 */ 92 #define IMG_FMT_VPXYV12 VPX_IMG_FMT_VPXYV12 /**< \deprecated Use #VPX_IMG_FMT_VPXYV12 */ 93 #define IMG_FMT_VPXI420 VPX_IMG_FMT_VPXI420 /**< \deprecated Use #VPX_IMG_FMT_VPXI420 */ 94 #endif /* VPX_CODEC_DISABLE_COMPAT */ 95 96 /**\brief Image Descriptor */ 97 typedef struct vpx_image 98 { 99 vpx_img_fmt_t fmt; /**< Image Format */ 100 101 /* Image storage dimensions */ 102 unsigned int w; /**< Stored image width */ 103 unsigned int h; /**< Stored image height */ 104 105 /* Image display dimensions */ 106 unsigned int d_w; /**< Displayed image width */ 107 unsigned int d_h; /**< Displayed image height */ 108 109 /* Chroma subsampling info */ 110 unsigned int x_chroma_shift; /**< subsampling order, X */ 111 unsigned int y_chroma_shift; /**< subsampling order, Y */ 112 113 /* Image data pointers. */ 114 #define VPX_PLANE_PACKED 0 /**< To be used for all packed formats */ 115 #define VPX_PLANE_Y 0 /**< Y (Luminance) plane */ 116 #define VPX_PLANE_U 1 /**< U (Chroma) plane */ 117 #define VPX_PLANE_V 2 /**< V (Chroma) plane */ 118 #define VPX_PLANE_ALPHA 3 /**< A (Transparency) plane */ 119 #if !defined(VPX_CODEC_DISABLE_COMPAT) || !VPX_CODEC_DISABLE_COMPAT 120 #define PLANE_PACKED VPX_PLANE_PACKED 121 #define PLANE_Y VPX_PLANE_Y 122 #define PLANE_U VPX_PLANE_U 123 #define PLANE_V VPX_PLANE_V 124 #define PLANE_ALPHA VPX_PLANE_ALPHA 125 #endif 126 unsigned char *planes[4]; /**< pointer to the top left pixel for each plane */ 127 int stride[4]; /**< stride between rows for each plane */ 128 129 int bps; /**< bits per sample (for packed formats) */ 130 131 /* The following member may be set by the application to associate data 132 * with this image. 133 */ 134 void *user_priv; /**< may be set by the application to associate data 135 * with this image. */ 136 137 /* The following members should be treated as private. */ 138 unsigned char *img_data; /**< private */ 139 int img_data_owner; /**< private */ 140 int self_allocd; /**< private */ 141 } vpx_image_t; /**< alias for struct vpx_image */ 142 143 /**\brief Representation of a rectangle on a surface */ 144 typedef struct vpx_image_rect 145 { 146 unsigned int x; /**< leftmost column */ 147 unsigned int y; /**< topmost row */ 148 unsigned int w; /**< width */ 149 unsigned int h; /**< height */ 150 } vpx_image_rect_t; /**< alias for struct vpx_image_rect */ 151 152 /*!\brief Open a descriptor, allocating storage for the underlying image 153 * 154 * Returns a descriptor for storing an image of the given format. The 155 * storage for the descriptor is allocated on the heap. 156 * 157 * \param[in] img Pointer to storage for descriptor. If this parameter 158 * is NULL, the storage for the descriptor will be 159 * allocated on the heap. 160 * \param[in] fmt Format for the image 161 * \param[in] d_w Width of the image 162 * \param[in] d_h Height of the image 163 * \param[in] align Alignment, in bytes, of the image buffer and 164 * each row in the image(stride). 165 * 166 * \return Returns a pointer to the initialized image descriptor. If the img 167 * parameter is non-null, the value of the img parameter will be 168 * returned. 169 */ 170 vpx_image_t *vpx_img_alloc(vpx_image_t *img, 171 vpx_img_fmt_t fmt, 172 unsigned int d_w, 173 unsigned int d_h, 174 unsigned int align); 175 176 /*!\brief Open a descriptor, using existing storage for the underlying image 177 * 178 * Returns a descriptor for storing an image of the given format. The 179 * storage for descriptor has been allocated elsewhere, and a descriptor is 180 * desired to "wrap" that storage. 181 * 182 * \param[in] img Pointer to storage for descriptor. If this parameter 183 * is NULL, the storage for the descriptor will be 184 * allocated on the heap. 185 * \param[in] fmt Format for the image 186 * \param[in] d_w Width of the image 187 * \param[in] d_h Height of the image 188 * \param[in] align Alignment, in bytes, of each row in the image. 189 * \param[in] img_data Storage to use for the image 190 * 191 * \return Returns a pointer to the initialized image descriptor. If the img 192 * parameter is non-null, the value of the img parameter will be 193 * returned. 194 */ 195 vpx_image_t *vpx_img_wrap(vpx_image_t *img, 196 vpx_img_fmt_t fmt, 197 unsigned int d_w, 198 unsigned int d_h, 199 unsigned int align, 200 unsigned char *img_data); 201 202 203 /*!\brief Set the rectangle identifying the displayed portion of the image 204 * 205 * Updates the displayed rectangle (aka viewport) on the image surface to 206 * match the specified coordinates and size. 207 * 208 * \param[in] img Image descriptor 209 * \param[in] x leftmost column 210 * \param[in] y topmost row 211 * \param[in] w width 212 * \param[in] h height 213 * 214 * \return 0 if the requested rectangle is valid, nonzero otherwise. 215 */ 216 int vpx_img_set_rect(vpx_image_t *img, 217 unsigned int x, 218 unsigned int y, 219 unsigned int w, 220 unsigned int h); 221 222 223 /*!\brief Flip the image vertically (top for bottom) 224 * 225 * Adjusts the image descriptor's pointers and strides to make the image 226 * be referenced upside-down. 227 * 228 * \param[in] img Image descriptor 229 */ 230 void vpx_img_flip(vpx_image_t *img); 231 232 /*!\brief Close an image descriptor 233 * 234 * Frees all allocated storage associated with an image descriptor. 235 * 236 * \param[in] img Image descriptor 237 */ 238 void vpx_img_free(vpx_image_t *img); 239 240 #endif 241 #ifdef __cplusplus 242 } 243 #endif 244
