1 /*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 #ifndef AVFILTER_DRAWUTILS_H
20 #define AVFILTER_DRAWUTILS_H
21
22 /**
23 * @file
24 * misc drawing utilities
25 */
26
27 #include <stdint.h>
30
33
35
51
54 union {
60
61 /**
62 * Process alpha pixel component.
63 */
64 #define FF_DRAW_PROCESS_ALPHA 1
65
66 /**
67 * Init a draw context.
68 *
69 * Only a limited number of pixel formats are supported, if format is not
70 * supported the function will return an error.
71 * @param format pixel format of the frames that will be drawn onto
72 * @param csp color space of the frames that will be drawn onto,
73 * defaulting to BT601 or RGB depending on the specified format
74 * when AVCOL_SPC_UNSPECIFIED is passed.
75 * @param range sample value range of the frames that will be drawn onto,
76 * defaulting to TV-range unless using a legacy J format
77 * when AVCOL_RANGE_UNSPECIFIED is passed.
78 * @param flags combination of FF_DRAW_* flags.
79 * @return 0 for success, < 0 for error
80 */
83
84 /**
85 * Init a draw context, taking the format, colorspace and range from the given
86 * filter link.
87 */
90
91 /*
92 * Legacy wrapper for ff_draw_init2.
93 */
95
96
97
98 /**
99 * Prepare a color. The rgba value passed is always 8-bit full-range in the RGB space
100 * corresponding to the space set at initialization.
101 */
103
104 /**
105 * Copy a rectangle from an image to another.
106 *
107 * The coordinates must be as even as the subsampling requires.
108 */
110 uint8_t *
dst[],
int dst_linesize[],
111 uint8_t *
src[],
int src_linesize[],
112 int dst_x, int dst_y, int src_x, int src_y,
114
115 /**
116 * Fill a rectangle with an uniform color.
117 *
118 * The coordinates must be as even as the subsampling requires.
119 * The color needs to be inited with ff_draw_color.
120 */
122 uint8_t *
dst[],
int dst_linesize[],
123 int dst_x,
int dst_y,
int w,
int h);
124
125 /**
126 * Blend a rectangle with an uniform color.
127 */
129 uint8_t *
dst[],
int dst_linesize[],
130 int dst_w, int dst_h,
131 int x0,
int y0,
int w,
int h);
132
133 /**
134 * Blend an alpha mask with an uniform color.
135 *
136 * @param draw draw context
137 * @param color color for the overlay;
138 * @param dst destination image
139 * @param dst_linesize line stride of the destination
140 * @param dst_w width of the destination image
141 * @param dst_h height of the destination image
142 * @param mask mask
143 * @param mask_linesize line stride of the mask
144 * @param mask_w width of the mask
145 * @param mask_h height of the mask
146 * @param l2depth log2 of depth of the mask (0 for 1bpp, 3 for 8bpp)
147 * @param endianness bit order of the mask (0: MSB to the left)
148 * @param x0 horizontal position of the overlay
149 * @param y0 vertical position of the overlay
150 */
152 uint8_t *
dst[],
int dst_linesize[],
int dst_w,
int dst_h,
153 const uint8_t *
mask,
int mask_linesize,
int mask_w,
int mask_h,
154 int l2depth,
unsigned endianness,
int x0,
int y0);
155
156 /**
157 * Round a dimension according to subsampling.
158 *
159 * @param draw draw context
160 * @param sub_dir 0 for horizontal, 1 for vertical
161 * @param round_dir 0 nearest, -1 round down, +1 round up
162 * @param value value to round
163 * @return the rounded value
164 */
167
168 /**
169 * Return the list of pixel formats supported by the draw functions.
170 *
171 * The flags are the same as ff_draw_init, i.e., none currently.
172 */
174
175 #endif /* AVFILTER_DRAWUTILS_H */