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_VPX_IMAGE_H_
  16 #define VPX_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 (5) /**<\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_YV12 =
  41       VPX_IMG_FMT_PLANAR | VPX_IMG_FMT_UV_FLIP | 1, /**< planar YVU */
  42   VPX_IMG_FMT_I420 = VPX_IMG_FMT_PLANAR | 2,
  43   VPX_IMG_FMT_I422 = VPX_IMG_FMT_PLANAR | 5,
  44   VPX_IMG_FMT_I444 = VPX_IMG_FMT_PLANAR | 6,
  45   VPX_IMG_FMT_I440 = VPX_IMG_FMT_PLANAR | 7,
  46   VPX_IMG_FMT_NV12 = VPX_IMG_FMT_PLANAR | 9,
  47   VPX_IMG_FMT_I42016 = VPX_IMG_FMT_I420 | VPX_IMG_FMT_HIGHBITDEPTH,
  48   VPX_IMG_FMT_I42216 = VPX_IMG_FMT_I422 | VPX_IMG_FMT_HIGHBITDEPTH,
  49   VPX_IMG_FMT_I44416 = VPX_IMG_FMT_I444 | VPX_IMG_FMT_HIGHBITDEPTH,
  50   VPX_IMG_FMT_I44016 = VPX_IMG_FMT_I440 | VPX_IMG_FMT_HIGHBITDEPTH
  51 } vpx_img_fmt_t; /**< alias for enum vpx_img_fmt */
  52
  53 /*!\brief List of supported color spaces */
  54 typedef enum vpx_color_space {
  55   VPX_CS_UNKNOWN = 0,   /**< Unknown */
  56   VPX_CS_BT_601 = 1,    /**< BT.601 */
  57   VPX_CS_BT_709 = 2,    /**< BT.709 */
  58   VPX_CS_SMPTE_170 = 3, /**< SMPTE.170 */
  59   VPX_CS_SMPTE_240 = 4, /**< SMPTE.240 */
  60   VPX_CS_BT_2020 = 5,   /**< BT.2020 */
  61   VPX_CS_RESERVED = 6,  /**< Reserved */
  62   VPX_CS_SRGB = 7       /**< sRGB */
  63 } vpx_color_space_t;    /**< alias for enum vpx_color_space */
  64
  65 /*!\brief List of supported color range */
  66 typedef enum vpx_color_range {
  67   VPX_CR_STUDIO_RANGE = 0, /**< Y [16..235], UV [16..240] */
  68   VPX_CR_FULL_RANGE = 1    /**< YUV/RGB [0..255] */
  69 } vpx_color_range_t;       /**< alias for enum vpx_color_range */
  70
  71 /**\brief Image Descriptor */
  72 typedef struct vpx_image {
  73   vpx_img_fmt_t fmt;       /**< Image Format */
  74   vpx_color_space_t cs;    /**< Color Space */
  75   vpx_color_range_t range; /**< Color Range */
  76
  77   /* Image storage dimensions */
  78   unsigned int w;         /**< Stored image width */
  79   unsigned int h;         /**< Stored image height */
  80   unsigned int bit_depth; /**< Stored image bit-depth */
  81
  82   /* Image display dimensions */
  83   unsigned int d_w; /**< Displayed image width */
  84   unsigned int d_h; /**< Displayed image height */
  85
  86   /* Image intended rendering dimensions */
  87   unsigned int r_w; /**< Intended rendering image width */
  88   unsigned int r_h; /**< Intended rendering image height */
  89
  90   /* Chroma subsampling info */
  91   unsigned int x_chroma_shift; /**< subsampling order, X */
  92   unsigned int y_chroma_shift; /**< subsampling order, Y */
  93
  94 /* Image data pointers. */
  95 #define VPX_PLANE_PACKED 0  /**< To be used for all packed formats */
  96 #define VPX_PLANE_Y 0       /**< Y (Luminance) plane */
  97 #define VPX_PLANE_U 1       /**< U (Chroma) plane */
  98 #define VPX_PLANE_V 2       /**< V (Chroma) plane */
  99 #define VPX_PLANE_ALPHA 3   /**< A (Transparency) plane */
 100   unsigned char *planes[4]; /**< pointer to the top left pixel for each plane */
 101   int stride[4];            /**< stride between rows for each plane */
 102
 103   int bps; /**< bits per sample (for packed formats) */
 104
 105   /*!\brief The following member may be set by the application to associate
 106    * data with this image.
 107    */
 108   void *user_priv;
 109
 110   /* The following members should be treated as private. */
 111   unsigned char *img_data; /**< private */
 112   int img_data_owner;      /**< private */
 113   int self_allocd;         /**< private */
 114
 115   void *fb_priv; /**< Frame buffer data associated with the image. */
 116 } vpx_image_t;   /**< alias for struct vpx_image */
 117
 118 /**\brief Representation of a rectangle on a surface */
 119 typedef struct vpx_image_rect {
 120   unsigned int x;   /**< leftmost column */
 121   unsigned int y;   /**< topmost row */
 122   unsigned int w;   /**< width */
 123   unsigned int h;   /**< height */
 124 } vpx_image_rect_t; /**< alias for struct vpx_image_rect */
 125
 126 /*!\brief Open a descriptor, allocating storage for the underlying image
 127  *
 128  * Returns a descriptor for storing an image of the given format. The
 129  * storage for the descriptor is allocated on the heap.
 130  *
 131  * \param[in]    img       Pointer to storage for descriptor. If this parameter
 132  *                         is NULL, the storage for the descriptor will be
 133  *                         allocated on the heap.
 134  * \param[in]    fmt       Format for the image
 135  * \param[in]    d_w       Width of the image
 136  * \param[in]    d_h       Height of the image
 137  * \param[in]    align     Alignment, in bytes, of the image buffer and
 138  *                         each row in the image(stride).
 139  *
 140  * \return Returns a pointer to the initialized image descriptor. If the img
 141  *         parameter is non-null, the value of the img parameter will be
 142  *         returned.
 143  */
 144 vpx_image_t *vpx_img_alloc(vpx_image_t *img, vpx_img_fmt_t fmt,
 145                            unsigned int d_w, unsigned int d_h,
 146                            unsigned int align);
 147
 148 /*!\brief Open a descriptor, using existing storage for the underlying image
 149  *
 150  * Returns a descriptor for storing an image of the given format. The
 151  * storage for descriptor has been allocated elsewhere, and a descriptor is
 152  * desired to "wrap" that storage.
 153  *
 154  * \param[in]    img           Pointer to storage for descriptor. If this
 155  *                             parameter is NULL, the storage for the descriptor
 156  *                             will be allocated on the heap.
 157  * \param[in]    fmt           Format for the image
 158  * \param[in]    d_w           Width of the image
 159  * \param[in]    d_h           Height of the image
 160  * \param[in]    stride_align  Alignment, in bytes, of each row in the image.
 161  * \param[in]    img_data      Storage to use for the image
 162  *
 163  * \return Returns a pointer to the initialized image descriptor. If the img
 164  *         parameter is non-null, the value of the img parameter will be
 165  *         returned.
 166  */
 167 vpx_image_t *vpx_img_wrap(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w,
 168                           unsigned int d_h, unsigned int stride_align,
 169                           unsigned char *img_data);
 170
 171 /*!\brief Set the rectangle identifying the displayed portion of the image
 172  *
 173  * Updates the displayed rectangle (aka viewport) on the image surface to
 174  * match the specified coordinates and size. Specifically, sets img->d_w,
 175  * img->d_h, and elements of the img->planes[] array.
 176  *
 177  * \param[in]    img       Image descriptor
 178  * \param[in]    x         leftmost column
 179  * \param[in]    y         topmost row
 180  * \param[in]    w         width
 181  * \param[in]    h         height
 182  *
 183  * \return 0 if the requested rectangle is valid, nonzero (-1) otherwise.
 184  */
 185 int vpx_img_set_rect(vpx_image_t *img, unsigned int x, unsigned int y,
 186                      unsigned int w, unsigned int h);
 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_VPX_IMAGE_H_