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
19extern "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
72typedef struct vpx_image {
77 /* Image storage dimensions */
78 unsigned int w;
79 unsigned int h;
80 unsigned int bit_depth;
82 /* Image display dimensions */
83 unsigned int d_w;
84 unsigned int d_h;
86 /* Image intended rendering dimensions */
87 unsigned int r_w;
88 unsigned int r_h;
90 /* Chroma subsampling info */
91 unsigned int x_chroma_shift;
92 unsigned int y_chroma_shift;
94/* Image data pointers. */
95#define VPX_PLANE_PACKED 0
96#define VPX_PLANE_Y 0
97#define VPX_PLANE_U 1
98#define VPX_PLANE_V 2
99#define VPX_PLANE_ALPHA 3
100 unsigned char *planes[4];
101 int stride[4];
103 int bps;
109
110 /* The following members should be treated as private. */
111 unsigned char *img_data;
115 void *fb_priv;
119typedef struct vpx_image_rect {
120 unsigned int x;
121 unsigned int y;
122 unsigned int w;
123 unsigned int h;
148 unsigned int d_w, unsigned int d_h,
149 unsigned int align);
150
174 unsigned int d_h, unsigned int stride_align,
175 unsigned char *img_data);
176
191int vpx_img_set_rect(vpx_image_t *img, unsigned int x, unsigned int y,
192 unsigned int w, unsigned int h);
193
202
210
211#ifdef __cplusplus
212} // extern "C"
213#endif
214
215#endif // VPX_VPX_VPX_IMAGE_H_
Representation of a rectangle on a surface.
Definition vpx_image.h:119
unsigned int w
Definition vpx_image.h:122
unsigned int y
Definition vpx_image.h:121
unsigned int x
Definition vpx_image.h:120
unsigned int h
Definition vpx_image.h:123
Image Descriptor.
Definition vpx_image.h:72
vpx_img_fmt_t fmt
Definition vpx_image.h:73
unsigned int y_chroma_shift
Definition vpx_image.h:92
unsigned int r_w
Definition vpx_image.h:87
void * user_priv
The following member may be set by the application to associate data with this image.
Definition vpx_image.h:108
unsigned int d_h
Definition vpx_image.h:84
int self_allocd
Definition vpx_image.h:113
unsigned char * img_data
Definition vpx_image.h:111
void * fb_priv
Definition vpx_image.h:115
int img_data_owner
Definition vpx_image.h:112
int bps
Definition vpx_image.h:103
unsigned int d_w
Definition vpx_image.h:83
vpx_color_space_t cs
Definition vpx_image.h:74
unsigned int h
Definition vpx_image.h:79
unsigned int bit_depth
Definition vpx_image.h:80
unsigned char * planes[4]
Definition vpx_image.h:100
unsigned int w
Definition vpx_image.h:78
int stride[4]
Definition vpx_image.h:101
unsigned int r_h
Definition vpx_image.h:88
vpx_color_range_t range
Definition vpx_image.h:75
unsigned int x_chroma_shift
Definition vpx_image.h:91
void vpx_img_flip(vpx_image_t *img)
Flip the image vertically (top for bottom)
vpx_color_space
List of supported color spaces.
Definition vpx_image.h:54
@ VPX_CS_BT_709
Definition vpx_image.h:57
@ VPX_CS_SRGB
Definition vpx_image.h:62
@ VPX_CS_BT_601
Definition vpx_image.h:56
@ VPX_CS_BT_2020
Definition vpx_image.h:60
@ VPX_CS_SMPTE_170
Definition vpx_image.h:58
@ VPX_CS_UNKNOWN
Definition vpx_image.h:55
@ VPX_CS_SMPTE_240
Definition vpx_image.h:59
@ VPX_CS_RESERVED
Definition vpx_image.h:61
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.
#define VPX_IMG_FMT_HIGHBITDEPTH
Definition vpx_image.h:35
#define VPX_IMG_FMT_UV_FLIP
Definition vpx_image.h:33
vpx_img_fmt
List of supported image formats.
Definition vpx_image.h:38
@ VPX_IMG_FMT_I42216
Definition vpx_image.h:48
@ VPX_IMG_FMT_I44016
Definition vpx_image.h:50
@ VPX_IMG_FMT_NV12
Definition vpx_image.h:46
@ VPX_IMG_FMT_YV12
Definition vpx_image.h:40
@ VPX_IMG_FMT_I42016
Definition vpx_image.h:47
@ VPX_IMG_FMT_I444
Definition vpx_image.h:44
@ VPX_IMG_FMT_I440
Definition vpx_image.h:45
@ VPX_IMG_FMT_I44416
Definition vpx_image.h:49
@ VPX_IMG_FMT_I420
Definition vpx_image.h:42
@ VPX_IMG_FMT_I422
Definition vpx_image.h:43
enum vpx_color_space vpx_color_space_t
List of supported color spaces.
vpx_color_range
List of supported color range.
Definition vpx_image.h:66
@ VPX_CR_STUDIO_RANGE
Definition vpx_image.h:67
@ VPX_CR_FULL_RANGE
Definition vpx_image.h:68
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.
#define VPX_IMG_FMT_PLANAR
Definition vpx_image.h:32
struct vpx_image_rect vpx_image_rect_t
Representation of a rectangle on a surface.
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.
enum vpx_img_fmt vpx_img_fmt_t
List of supported image formats.
struct vpx_image vpx_image_t
Image Descriptor.
void vpx_img_free(vpx_image_t *img)
Close an image descriptor.
enum vpx_color_range vpx_color_range_t
List of supported color range.