vpx/vpx_image.h

   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 /*!\file
  12  * \brief Describes the vpx image descriptor and associated operations
  13  *
  14  */
  15 #ifndef VPX_VPX_IMAGE_H_
  16 #define VPX_VPX_IMAGE_H_
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 /*!\brief Current ABI version number
  23  *
  24  * \internal
  25  * If this file is altered in any way that changes the ABI, this value
  26  * must be bumped.  Examples include, but are not limited to, changing
  27  * types, removing or reassigning enums, adding/removing/rearranging
  28  * fields to structures
  29  */
  30 #define VPX_IMAGE_ABI_VERSION (4) /**<\hideinitializer*/
  31
  32 #define VPX_IMG_FMT_PLANAR 0x100       /**< Image is a planar format. */
  33 #define VPX_IMG_FMT_UV_FLIP 0x200      /**< V plane precedes U in memory. */
  34 #define VPX_IMG_FMT_HAS_ALPHA 0x400    /**< Image has an alpha channel. */
  35 #define VPX_IMG_FMT_HIGHBITDEPTH 0x800 /**< Image uses 16bit framebuffer. */
  36
  37 /*!\brief List of supported image formats */
  38 typedef enum vpx_img_fmt {
  39   VPX_IMG_FMT_NONE,
  40   VPX_IMG_FMT_RGB24,     /**< 24 bit per pixel packed RGB */
  41   VPX_IMG_FMT_RGB32,     /**< 32 bit per pixel packed 0RGB */
  42   VPX_IMG_FMT_RGB565,    /**< 16 bit per pixel, 565 */
  43   VPX_IMG_FMT_RGB555,    /**< 16 bit per pixel, 555 */
  44   VPX_IMG_FMT_UYVY,      /**< UYVY packed YUV */
  45   VPX_IMG_FMT_YUY2,      /**< YUYV packed YUV */
  46   VPX_IMG_FMT_YVYU,      /**< YVYU packed YUV */
  47   VPX_IMG_FMT_BGR24,     /**< 24 bit per pixel packed BGR */
  48   VPX_IMG_FMT_RGB32_LE,  /**< 32 bit packed BGR0 */
  49   VPX_IMG_FMT_ARGB,      /**< 32 bit packed ARGB, alpha=255 */
  50   VPX_IMG_FMT_ARGB_LE,   /**< 32 bit packed BGRA, alpha=255 */
  51   VPX_IMG_FMT_RGB565_LE, /**< 16 bit per pixel, gggbbbbb rrrrrggg */
  52   VPX_IMG_FMT_RGB555_LE, /**< 16 bit per pixel, gggbbbbb 0rrrrrgg */
  53   VPX_IMG_FMT_YV12 =
  54       VPX_IMG_FMT_PLANAR | VPX_IMG_FMT_UV_FLIP | 1, /**< planar YVU */
  55   VPX_IMG_FMT_I420 = VPX_IMG_FMT_PLANAR | 2,
  56   VPX_IMG_FMT_VPXYV12 = VPX_IMG_FMT_PLANAR | VPX_IMG_FMT_UV_FLIP |
  57                         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 */
  68
  69 /*!\brief List of supported color spaces */
  70 typedef enum vpx_color_space {
  71   VPX_CS_UNKNOWN = 0,   /**< Unknown */
  72   VPX_CS_BT_601 = 1,    /**< BT.601 */
  73   VPX_CS_BT_709 = 2,    /**< BT.709 */
  74   VPX_CS_SMPTE_170 = 3, /**< SMPTE.170 */
  75   VPX_CS_SMPTE_240 = 4, /**< SMPTE.240 */
  76   VPX_CS_BT_2020 = 5,   /**< BT.2020 */
  77   VPX_CS_RESERVED = 6,  /**< Reserved */
  78   VPX_CS_SRGB = 7       /**< sRGB */
  79 } vpx_color_space_t;    /**< alias for enum vpx_color_space */
  80
  81 /*!\brief List of supported color range */
  82 typedef enum vpx_color_range {
  83   VPX_CR_STUDIO_RANGE = 0, /**< Y [16..235], UV [16..240] */
  84   VPX_CR_FULL_RANGE = 1    /**< YUV/RGB [0..255] */
  85 } vpx_color_range_t;       /**< alias for enum vpx_color_range */
  86
  87 /**\brief Image Descriptor */
  88 typedef struct vpx_image {
  89   vpx_img_fmt_t fmt;       /**< Image Format */
  90   vpx_color_space_t cs;    /**< Color Space */
  91   vpx_color_range_t range; /**< Color Range */
  92
  93   /* Image storage dimensions */
  94   unsigned int w;         /**< Stored image width */
  95   unsigned int h;         /**< Stored image height */
  96   unsigned int bit_depth; /**< Stored image bit-depth */
  97
  98   /* Image display dimensions */
  99   unsigned int d_w; /**< Displayed image width */
 100   unsigned int d_h; /**< Displayed image height */
 101
 102   /* Image intended rendering dimensions */
 103   unsigned int r_w; /**< Intended rendering image width */
 104   unsigned int r_h; /**< Intended rendering image height */
 105
 106   /* Chroma subsampling info */
 107   unsigned int x_chroma_shift; /**< subsampling order, X */
 108   unsigned int y_chroma_shift; /**< subsampling order, Y */
 109
 110 /* Image data pointers. */
 111 #define VPX_PLANE_PACKED 0  /**< To be used for all packed formats */
 112 #define VPX_PLANE_Y 0       /**< Y (Luminance) plane */
 113 #define VPX_PLANE_U 1       /**< U (Chroma) plane */
 114 #define VPX_PLANE_V 2       /**< V (Chroma) plane */
 115 #define VPX_PLANE_ALPHA 3   /**< A (Transparency) plane */
 116   unsigned char *planes[4]; /**< pointer to the top left pixel for each plane */
 117   int stride[4];            /**< stride between rows for each plane */
 118
 119   int bps; /**< bits per sample (for packed formats) */
 120
 121   /*!\brief The following member may be set by the application to associate
 122    * data with this image.
 123    */
 124   void *user_priv;
 125
 126   /* The following members should be treated as private. */
 127   unsigned char *img_data; /**< private */
 128   int img_data_owner;      /**< private */
 129   int self_allocd;         /**< private */
 130
 131   void *fb_priv; /**< Frame buffer data associated with the image. */
 132 } vpx_image_t;   /**< alias for struct vpx_image */
 133
 134 /**\brief Representation of a rectangle on a surface */
 135 typedef struct vpx_image_rect {
 136   unsigned int x;   /**< leftmost column */
 137   unsigned int y;   /**< topmost row */
 138   unsigned int w;   /**< width */
 139   unsigned int h;   /**< height */
 140 } vpx_image_rect_t; /**< alias for struct vpx_image_rect */
 141
 142 /*!\brief Open a descriptor, allocating storage for the underlying image
 143  *
 144  * Returns a descriptor for storing an image of the given format. The
 145  * storage for the descriptor is allocated on the heap.
 146  *
 147  * \param[in]    img       Pointer to storage for descriptor. If this parameter
 148  *                         is NULL, the storage for the descriptor will be
 149  *                         allocated on the heap.
 150  * \param[in]    fmt       Format for the image
 151  * \param[in]    d_w       Width of the image
 152  * \param[in]    d_h       Height of the image
 153  * \param[in]    align     Alignment, in bytes, of the image buffer and
 154  *                         each row in the image(stride).
 155  *
 156  * \return Returns a pointer to the initialized image descriptor. If the img
 157  *         parameter is non-null, the value of the img parameter will be
 158  *         returned.
 159  */
 160 vpx_image_t *vpx_img_alloc(vpx_image_t *img, vpx_img_fmt_t fmt,
 161                            unsigned int d_w, unsigned int d_h,
 162                            unsigned int align);
 163
 164 /*!\brief Open a descriptor, using existing storage for the underlying image
 165  *
 166  * Returns a descriptor for storing an image of the given format. The
 167  * storage for descriptor has been allocated elsewhere, and a descriptor is
 168  * desired to "wrap" that storage.
 169  *
 170  * \param[in]    img       Pointer to storage for descriptor. If this parameter
 171  *                         is NULL, the storage for the descriptor will be
 172  *                         allocated on the heap.
 173  * \param[in]    fmt       Format for the image
 174  * \param[in]    d_w       Width of the image
 175  * \param[in]    d_h       Height of the image
 176  * \param[in]    align     Alignment, in bytes, of each row in the image.
 177  * \param[in]    img_data  Storage to use for the image
 178  *
 179  * \return Returns a pointer to the initialized image descriptor. If the img
 180  *         parameter is non-null, the value of the img parameter will be
 181  *         returned.
 182  */
 183 vpx_image_t *vpx_img_wrap(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w,
 184                           unsigned int d_h, unsigned int align,
 185                           unsigned char *img_data);
 186
 187 /*!\brief Set the rectangle identifying the displayed portion of the image
 188  *
 189  * Updates the displayed rectangle (aka viewport) on the image surface to
 190  * match the specified coordinates and size.
 191  *
 192  * \param[in]    img       Image descriptor
 193  * \param[in]    x         leftmost column
 194  * \param[in]    y         topmost row
 195  * \param[in]    w         width
 196  * \param[in]    h         height
 197  *
 198  * \return 0 if the requested rectangle is valid, nonzero otherwise.
 199  */
 200 int vpx_img_set_rect(vpx_image_t *img, unsigned int x, unsigned int y,
 201                      unsigned int w, unsigned int h);
 202
 203 /*!\brief Flip the image vertically (top for bottom)
 204  *
 205  * Adjusts the image descriptor's pointers and strides to make the image
 206  * be referenced upside-down.
 207  *
 208  * \param[in]    img       Image descriptor
 209  */
 210 void vpx_img_flip(vpx_image_t *img);
 211
 212 /*!\brief Close an image descriptor
 213  *
 214  * Frees all allocated storage associated with an image descriptor.
 215  *
 216  * \param[in]    img       Image descriptor
 217  */
 218 void vpx_img_free(vpx_image_t *img);
 219
 220 #ifdef __cplusplus
 221 }  // extern "C"
 222 #endif
 223
 224 #endif  // VPX_VPX_IMAGE_H_