WebM Codec SDK
vpx_image.h
Go to the documentation of this file.
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 
16 #ifndef VPX_VPX_IMAGE_H_
17 #define VPX_VPX_IMAGE_H_
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
31 #define VPX_IMAGE_ABI_VERSION (3)
34 #define VPX_IMG_FMT_PLANAR 0x100
35 #define VPX_IMG_FMT_UV_FLIP 0x200
36 #define VPX_IMG_FMT_HAS_ALPHA 0x400
37 #define VPX_IMG_FMT_HIGHBITDEPTH 0x800
40  typedef enum vpx_img_fmt {
41  VPX_IMG_FMT_NONE,
67  } vpx_img_fmt_t;
70  typedef enum vpx_color_space {
82  typedef struct vpx_image {
86  /* Image storage dimensions */
87  unsigned int w;
88  unsigned int h;
89  unsigned int bit_depth;
91  /* Image display dimensions */
92  unsigned int d_w;
93  unsigned int d_h;
95  /* Chroma subsampling info */
96  unsigned int x_chroma_shift;
97  unsigned int y_chroma_shift;
99  /* Image data pointers. */
100 #define VPX_PLANE_PACKED 0
101 #define VPX_PLANE_Y 0
102 #define VPX_PLANE_U 1
103 #define VPX_PLANE_V 2
104 #define VPX_PLANE_ALPHA 3
105  unsigned char *planes[4];
106  int stride[4];
108  int bps;
110  /* The following member may be set by the application to associate data
111  * with this image.
112  */
113  void *user_priv;
116  /* The following members should be treated as private. */
117  unsigned char *img_data;
121  void *fb_priv;
122  } vpx_image_t;
125  typedef struct vpx_image_rect {
126  unsigned int x;
127  unsigned int y;
128  unsigned int w;
129  unsigned int h;
130  } vpx_image_rect_t;
151  vpx_img_fmt_t fmt,
152  unsigned int d_w,
153  unsigned int d_h,
154  unsigned int align);
155 
176  vpx_img_fmt_t fmt,
177  unsigned int d_w,
178  unsigned int d_h,
179  unsigned int align,
180  unsigned char *img_data);
181 
182 
196  int vpx_img_set_rect(vpx_image_t *img,
197  unsigned int x,
198  unsigned int y,
199  unsigned int w,
200  unsigned int h);
201 
202 
210  void vpx_img_flip(vpx_image_t *img);
211 
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_
Definition: vpx_image.h:66
vpx_color_space
List of supported color spaces.
Definition: vpx_image.h:70
Definition: vpx_image.h:46
Image Descriptor.
Definition: vpx_image.h:82
Definition: vpx_image.h:62
Definition: vpx_image.h:73
Definition: vpx_image.h:58
unsigned int x
Definition: vpx_image.h:126
Definition: vpx_image.h:55
int self_allocd
Definition: vpx_image.h:119
Definition: vpx_image.h:77
#define VPX_IMG_FMT_PLANAR
Definition: vpx_image.h:34
#define VPX_IMG_FMT_UV_FLIP
Definition: vpx_image.h:35
int img_data_owner
Definition: vpx_image.h:118
Definition: vpx_image.h:45
Definition: vpx_image.h:78
Definition: vpx_image.h:75
unsigned int bit_depth
Definition: vpx_image.h:89
int vpx_img_set_rect(vpx_image_t *img, unsigned int x, unsigned int y, unsigned int w, unsigned int h)
Set the rectangle identifying the displayed portion of the image.
void * fb_priv
Definition: vpx_image.h:121
unsigned int y_chroma_shift
Definition: vpx_image.h:97
unsigned int x_chroma_shift
Definition: vpx_image.h:96
#define VPX_IMG_FMT_HIGHBITDEPTH
Definition: vpx_image.h:37
Definition: vpx_image.h:53
unsigned int y
Definition: vpx_image.h:127
Definition: vpx_image.h:54
Representation of a rectangle on a surface.
Definition: vpx_image.h:125
Definition: vpx_image.h:65
vpx_image_t * vpx_img_alloc(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align)
Open a descriptor, allocating storage for the underlying image.
Definition: vpx_image.h:56
unsigned int h
Definition: vpx_image.h:129
unsigned int d_w
Definition: vpx_image.h:92
Definition: vpx_image.h:64
Definition: vpx_image.h:51
enum vpx_color_space vpx_color_space_t
List of supported color spaces.
enum vpx_img_fmt vpx_img_fmt_t
List of supported image formats.
Definition: vpx_image.h:47
Definition: vpx_image.h:74
void vpx_img_free(vpx_image_t *img)
Close an image descriptor.
vpx_img_fmt_t fmt
Definition: vpx_image.h:83
Definition: vpx_image.h:59
Definition: vpx_image.h:72
unsigned char * img_data
Definition: vpx_image.h:117
void vpx_img_flip(vpx_image_t *img)
Flip the image vertically (top for bottom)
Definition: vpx_image.h:43
unsigned int h
Definition: vpx_image.h:88
Definition: vpx_image.h:57
vpx_image_t * vpx_img_wrap(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align, unsigned char *img_data)
Open a descriptor, using existing storage for the underlying image.
Definition: vpx_image.h:63
unsigned int w
Definition: vpx_image.h:128
vpx_color_space_t cs
Definition: vpx_image.h:84
Definition: vpx_image.h:60
struct vpx_image vpx_image_t
Image Descriptor.
struct vpx_image_rect vpx_image_rect_t
Representation of a rectangle on a surface.
Definition: vpx_image.h:49
Definition: vpx_image.h:48
#define VPX_IMG_FMT_HAS_ALPHA
Definition: vpx_image.h:36
void * user_priv
Definition: vpx_image.h:113
unsigned int d_h
Definition: vpx_image.h:93
Definition: vpx_image.h:71
Definition: vpx_image.h:52
Definition: vpx_image.h:50
unsigned int w
Definition: vpx_image.h:87
Definition: vpx_image.h:44
Definition: vpx_image.h:42
Definition: vpx_image.h:76
Definition: vpx_image.h:61