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 
15 #ifndef VPX_VPX_VPX_IMAGE_H_
16 #define VPX_VPX_VPX_IMAGE_H_
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
30 #define VPX_IMAGE_ABI_VERSION (5)
32 #define VPX_IMG_FMT_PLANAR 0x100
33 #define VPX_IMG_FMT_UV_FLIP 0x200
34 #define VPX_IMG_FMT_HAS_ALPHA 0x400
35 #define VPX_IMG_FMT_HIGHBITDEPTH 0x800
38 typedef enum vpx_img_fmt {
39  VPX_IMG_FMT_NONE,
50 } vpx_img_fmt_t;
53 typedef enum vpx_color_space {
65 typedef enum vpx_color_range {
71 typedef struct vpx_image {
76  /* Image storage dimensions */
77  unsigned int w;
78  unsigned int h;
79  unsigned int bit_depth;
81  /* Image display dimensions */
82  unsigned int d_w;
83  unsigned int d_h;
85  /* Image intended rendering dimensions */
86  unsigned int r_w;
87  unsigned int r_h;
89  /* Chroma subsampling info */
90  unsigned int x_chroma_shift;
91  unsigned int y_chroma_shift;
93 /* Image data pointers. */
94 #define VPX_PLANE_PACKED 0
95 #define VPX_PLANE_Y 0
96 #define VPX_PLANE_U 1
97 #define VPX_PLANE_V 2
98 #define VPX_PLANE_ALPHA 3
99  unsigned char *planes[4];
100  int stride[4];
102  int bps;
107  void *user_priv;
108 
109  /* The following members should be treated as private. */
110  unsigned char *img_data;
114  void *fb_priv;
115 } vpx_image_t;
118 typedef struct vpx_image_rect {
119  unsigned int x;
120  unsigned int y;
121  unsigned int w;
122  unsigned int h;
144  unsigned int d_w, unsigned int d_h,
145  unsigned int align);
146 
166 vpx_image_t *vpx_img_wrap(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w,
167  unsigned int d_h, unsigned int stride_align,
168  unsigned char *img_data);
169 
183 int vpx_img_set_rect(vpx_image_t *img, unsigned int x, unsigned int y,
184  unsigned int w, unsigned int h);
185 
193 void vpx_img_flip(vpx_image_t *img);
194 
201 void vpx_img_free(vpx_image_t *img);
202 
203 #ifdef __cplusplus
204 } // extern "C"
205 #endif
206 
207 #endif // VPX_VPX_VPX_IMAGE_H_
unsigned int r_w
Definition: vpx_image.h:86
Definition: vpx_image.h:49
vpx_color_space
List of supported color spaces.
Definition: vpx_image.h:53
Image Descriptor.
Definition: vpx_image.h:71
Definition: vpx_image.h:56
unsigned int x
Definition: vpx_image.h:119
Definition: vpx_image.h:40
unsigned int r_h
Definition: vpx_image.h:87
int self_allocd
Definition: vpx_image.h:112
Definition: vpx_image.h:60
#define VPX_IMG_FMT_PLANAR
Definition: vpx_image.h:32
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 stride_align, unsigned char *img_data)
Open a descriptor, using existing storage for the underlying image.
#define VPX_IMG_FMT_UV_FLIP
Definition: vpx_image.h:33
int img_data_owner
Definition: vpx_image.h:111
Definition: vpx_image.h:61
Definition: vpx_image.h:58
unsigned int bit_depth
Definition: vpx_image.h:79
vpx_color_range
List of supported color range.
Definition: vpx_image.h:65
enum vpx_color_range vpx_color_range_t
List of supported color range.
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.
vpx_color_range_t range
Definition: vpx_image.h:74
void * fb_priv
Definition: vpx_image.h:114
unsigned int y_chroma_shift
Definition: vpx_image.h:91
unsigned int x_chroma_shift
Definition: vpx_image.h:90
#define VPX_IMG_FMT_HIGHBITDEPTH
Definition: vpx_image.h:35
unsigned int y
Definition: vpx_image.h:120
Representation of a rectangle on a surface.
Definition: vpx_image.h:118
Definition: vpx_image.h:48
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:42
unsigned int h
Definition: vpx_image.h:122
unsigned int d_w
Definition: vpx_image.h:82
Definition: vpx_image.h:47
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:57
void vpx_img_free(vpx_image_t *img)
Close an image descriptor.
vpx_img_fmt_t fmt
Definition: vpx_image.h:72
Definition: vpx_image.h:43
Definition: vpx_image.h:55
unsigned char * img_data
Definition: vpx_image.h:110
void vpx_img_flip(vpx_image_t *img)
Flip the image vertically (top for bottom)
Definition: vpx_image.h:66
unsigned int h
Definition: vpx_image.h:78
Definition: vpx_image.h:46
unsigned int w
Definition: vpx_image.h:121
Definition: vpx_image.h:67
vpx_color_space_t cs
Definition: vpx_image.h:73
Definition: vpx_image.h:44
struct vpx_image vpx_image_t
Image Descriptor.
struct vpx_image_rect vpx_image_rect_t
Representation of a rectangle on a surface.
unsigned int d_h
Definition: vpx_image.h:83
Definition: vpx_image.h:54
unsigned int w
Definition: vpx_image.h:77
Definition: vpx_image.h:59
Definition: vpx_image.h:45