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
  12 /*!\file
  13  * \brief Describes the vpx image descriptor and associated operations
  14  *
  15  */
  16 #ifndef VPX_VPX_IMAGE_H_
  17 #define VPX_VPX_IMAGE_H_
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  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 (2) /**<\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 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. */
  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,
  59     VPX_IMG_FMT_I422    = VPX_IMG_FMT_PLANAR | 5,
  60     VPX_IMG_FMT_I444    = VPX_IMG_FMT_PLANAR | 6,
  61     VPX_IMG_FMT_444A    = VPX_IMG_FMT_PLANAR | VPX_IMG_FMT_HAS_ALPHA | 7,
  62     VPX_IMG_FMT_I42016    = VPX_IMG_FMT_I420 | VPX_IMG_FMT_HIGHBITDEPTH,
  63     VPX_IMG_FMT_I42216    = VPX_IMG_FMT_I422 | VPX_IMG_FMT_HIGHBITDEPTH,
  64     VPX_IMG_FMT_I44416    = VPX_IMG_FMT_I444 | VPX_IMG_FMT_HIGHBITDEPTH
  65   } vpx_img_fmt_t; /**< alias for enum vpx_img_fmt */
  66
  67   /**\brief Image Descriptor */
  68   typedef struct vpx_image {
  69     vpx_img_fmt_t fmt; /**< Image Format */
  70
  71     /* Image storage dimensions */
  72     unsigned int  w;           /**< Stored image width */
  73     unsigned int  h;           /**< Stored image height */
  74     unsigned int  bit_depth;   /**< Stored image bit-depth */
  75
  76     /* Image display dimensions */
  77     unsigned int  d_w;   /**< Displayed image width */
  78     unsigned int  d_h;   /**< Displayed image height */
  79
  80     /* Chroma subsampling info */
  81     unsigned int  x_chroma_shift;   /**< subsampling order, X */
  82     unsigned int  y_chroma_shift;   /**< subsampling order, Y */
  83
  84     /* Image data pointers. */
  85 #define VPX_PLANE_PACKED 0   /**< To be used for all packed formats */
  86 #define VPX_PLANE_Y      0   /**< Y (Luminance) plane */
  87 #define VPX_PLANE_U      1   /**< U (Chroma) plane */
  88 #define VPX_PLANE_V      2   /**< V (Chroma) plane */
  89 #define VPX_PLANE_ALPHA  3   /**< A (Transparency) plane */
  90     unsigned char *planes[4];  /**< pointer to the top left pixel for each plane */
  91     int      stride[4];  /**< stride between rows for each plane */
  92
  93     int     bps; /**< bits per sample (for packed formats) */
  94
  95     /* The following member may be set by the application to associate data
  96      * with this image.
  97      */
  98     void    *user_priv; /**< may be set by the application to associate data
  99                          *   with this image. */
 100
 101     /* The following members should be treated as private. */
 102     unsigned char *img_data;       /**< private */
 103     int      img_data_owner; /**< private */
 104     int      self_allocd;    /**< private */
 105
 106     void    *fb_priv; /**< Frame buffer data associated with the image. */
 107   } vpx_image_t; /**< alias for struct vpx_image */
 108
 109   /**\brief Representation of a rectangle on a surface */
 110   typedef struct vpx_image_rect {
 111     unsigned int x; /**< leftmost column */
 112     unsigned int y; /**< topmost row */
 113     unsigned int w; /**< width */
 114     unsigned int h; /**< height */
 115   } vpx_image_rect_t; /**< alias for struct vpx_image_rect */
 116
 117   /*!\brief Open a descriptor, allocating storage for the underlying image
 118    *
 119    * Returns a descriptor for storing an image of the given format. The
 120    * storage for the descriptor is allocated on the heap.
 121    *
 122    * \param[in]    img       Pointer to storage for descriptor. If this parameter
 123    *                         is NULL, the storage for the descriptor will be
 124    *                         allocated on the heap.
 125    * \param[in]    fmt       Format for the image
 126    * \param[in]    d_w       Width of the image
 127    * \param[in]    d_h       Height of the image
 128    * \param[in]    align     Alignment, in bytes, of the image buffer and
 129    *                         each row in the image(stride).
 130    *
 131    * \return Returns a pointer to the initialized image descriptor. If the img
 132    *         parameter is non-null, the value of the img parameter will be
 133    *         returned.
 134    */
 135   vpx_image_t *vpx_img_alloc(vpx_image_t  *img,
 136                              vpx_img_fmt_t fmt,
 137                              unsigned int d_w,
 138                              unsigned int d_h,
 139                              unsigned int align);
 140
 141   /*!\brief Open a descriptor, using existing storage for the underlying image
 142    *
 143    * Returns a descriptor for storing an image of the given format. The
 144    * storage for descriptor has been allocated elsewhere, and a descriptor is
 145    * desired to "wrap" that storage.
 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 each row in the image.
 154    * \param[in]    img_data  Storage to use for the image
 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_wrap(vpx_image_t  *img,
 161                             vpx_img_fmt_t fmt,
 162                             unsigned int d_w,
 163                             unsigned int d_h,
 164                             unsigned int align,
 165                             unsigned char      *img_data);
 166
 167
 168   /*!\brief Set the rectangle identifying the displayed portion of the image
 169    *
 170    * Updates the displayed rectangle (aka viewport) on the image surface to
 171    * match the specified coordinates and size.
 172    *
 173    * \param[in]    img       Image descriptor
 174    * \param[in]    x         leftmost column
 175    * \param[in]    y         topmost row
 176    * \param[in]    w         width
 177    * \param[in]    h         height
 178    *
 179    * \return 0 if the requested rectangle is valid, nonzero otherwise.
 180    */
 181   int vpx_img_set_rect(vpx_image_t  *img,
 182                        unsigned int  x,
 183                        unsigned int  y,
 184                        unsigned int  w,
 185                        unsigned int  h);
 186
 187
 188   /*!\brief Flip the image vertically (top for bottom)
 189    *
 190    * Adjusts the image descriptor's pointers and strides to make the image
 191    * be referenced upside-down.
 192    *
 193    * \param[in]    img       Image descriptor
 194    */
 195   void vpx_img_flip(vpx_image_t *img);
 196
 197   /*!\brief Close an image descriptor
 198    *
 199    * Frees all allocated storage associated with an image descriptor.
 200    *
 201    * \param[in]    img       Image descriptor
 202    */
 203   void vpx_img_free(vpx_image_t *img);
 204
 205 #ifdef __cplusplus
 206 }  // extern "C"
 207 #endif
 208
 209 #endif  // VPX_VPX_IMAGE_H_