FFmpeg
drawutils.h
Go to the documentation of this file.
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>
28 #include "avfilter.h"
29 #include "libavutil/pixfmt.h"
30 
31 int ff_fill_rgba_map(uint8_t *rgba_map, enum AVPixelFormat pix_fmt);
32 
33 #define MAX_PLANES 4
34 
35 typedef struct FFDrawContext {
36  const struct AVPixFmtDescriptor *desc;
38  unsigned nb_planes;
39  int pixelstep[MAX_PLANES]; /*< offset between pixels */
40  uint8_t hsub[MAX_PLANES]; /*< horizontal subsampling */
41  uint8_t vsub[MAX_PLANES]; /*< vertical subsampling */
42  uint8_t hsub_max;
43  uint8_t vsub_max;
45  unsigned flags;
47 
48 typedef struct FFDrawColor {
49  uint8_t rgba[4];
50  union {
51  uint32_t u32[4];
52  uint16_t u16[8];
53  uint8_t u8[16];
54  } comp[MAX_PLANES];
55 } FFDrawColor;
56 
57 /**
58  * Process alpha pixel component.
59  */
60 #define FF_DRAW_PROCESS_ALPHA 1
61 
62 /**
63  * Init a draw context.
64  *
65  * Only a limited number of pixel formats are supported, if format is not
66  * supported the function will return an error.
67  * flags is combination of FF_DRAW_* flags.
68  * @return 0 for success, < 0 for error
69  */
70 int ff_draw_init(FFDrawContext *draw, enum AVPixelFormat format, unsigned flags);
71 
72 /**
73  * Prepare a color.
74  */
75 void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, const uint8_t rgba[4]);
76 
77 /**
78  * Copy a rectangle from an image to another.
79  *
80  * The coordinates must be as even as the subsampling requires.
81  */
83  uint8_t *dst[], int dst_linesize[],
84  uint8_t *src[], int src_linesize[],
85  int dst_x, int dst_y, int src_x, int src_y,
86  int w, int h);
87 
88 /**
89  * Fill a rectangle with an uniform color.
90  *
91  * The coordinates must be as even as the subsampling requires.
92  * The color needs to be inited with ff_draw_color.
93  */
95  uint8_t *dst[], int dst_linesize[],
96  int dst_x, int dst_y, int w, int h);
97 
98 /**
99  * Blend a rectangle with an uniform color.
100  */
102  uint8_t *dst[], int dst_linesize[],
103  int dst_w, int dst_h,
104  int x0, int y0, int w, int h);
105 
106 /**
107  * Blend an alpha mask with an uniform color.
108  *
109  * @param draw draw context
110  * @param color color for the overlay;
111  * @param dst destination image
112  * @param dst_linesize line stride of the destination
113  * @param dst_w width of the destination image
114  * @param dst_h height of the destination image
115  * @param mask mask
116  * @param mask_linesize line stride of the mask
117  * @param mask_w width of the mask
118  * @param mask_h height of the mask
119  * @param l2depth log2 of depth of the mask (0 for 1bpp, 3 for 8bpp)
120  * @param endianness bit order of the mask (0: MSB to the left)
121  * @param x0 horizontal position of the overlay
122  * @param y0 vertical position of the overlay
123  */
125  uint8_t *dst[], int dst_linesize[], int dst_w, int dst_h,
126  const uint8_t *mask, int mask_linesize, int mask_w, int mask_h,
127  int l2depth, unsigned endianness, int x0, int y0);
128 
129 /**
130  * Round a dimension according to subsampling.
131  *
132  * @param draw draw context
133  * @param sub_dir 0 for horizontal, 1 for vertical
134  * @param round_dir 0 nearest, -1 round down, +1 round up
135  * @param value value to round
136  * @return the rounded value
137  */
138 int ff_draw_round_to_sub(FFDrawContext *draw, int sub_dir, int round_dir,
139  int value);
140 
141 /**
142  * Return the list of pixel formats supported by the draw functions.
143  *
144  * The flags are the same as ff_draw_init, i.e., none currently.
145  */
147 
148 #endif /* AVFILTER_DRAWUTILS_H */
FFDrawColor
Definition: drawutils.h:48
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
color
Definition: vf_paletteuse.c:600
FFDrawContext::hsub_max
uint8_t hsub_max
Definition: drawutils.h:42
FFDrawContext::desc
const struct AVPixFmtDescriptor * desc
Definition: drawutils.h:36
w
uint8_t w
Definition: llviddspenc.c:38
FFDrawColor::u16
uint16_t u16[8]
Definition: drawutils.h:52
ff_fill_rgba_map
int ff_fill_rgba_map(uint8_t *rgba_map, enum AVPixelFormat pix_fmt)
Definition: drawutils.c:34
FFDrawColor::rgba
uint8_t rgba[4]
Definition: drawutils.h:49
ff_blend_mask
void ff_blend_mask(FFDrawContext *draw, FFDrawColor *color, uint8_t *dst[], int dst_linesize[], int dst_w, int dst_h, const uint8_t *mask, int mask_linesize, int mask_w, int mask_h, int l2depth, unsigned endianness, int x0, int y0)
Blend an alpha mask with an uniform color.
Definition: drawutils.c:517
ff_draw_color
void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, const uint8_t rgba[4])
Prepare a color.
Definition: drawutils.c:141
ff_blend_rectangle
void ff_blend_rectangle(FFDrawContext *draw, FFDrawColor *color, uint8_t *dst[], int dst_linesize[], int dst_w, int dst_h, int x0, int y0, int w, int h)
Blend a rectangle with an uniform color.
Definition: drawutils.c:336
FFDrawContext::nb_planes
unsigned nb_planes
Definition: drawutils.h:38
FFDrawContext::pixelstep
int pixelstep[MAX_PLANES]
Definition: drawutils.h:39
FFDrawColor::comp
union FFDrawColor::@206 comp[MAX_PLANES]
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:64
FFDrawContext::vsub_max
uint8_t vsub_max
Definition: drawutils.h:43
ff_draw_init
int ff_draw_init(FFDrawContext *draw, enum AVPixelFormat format, unsigned flags)
Init a draw context.
Definition: drawutils.c:79
mask
static const uint16_t mask[17]
Definition: lzw.c:38
FFDrawContext::vsub
uint8_t vsub[MAX_PLANES]
Definition: drawutils.h:41
format
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample format(the sample packing is implied by the sample format) and sample rate. The lists are not just lists
ff_fill_rectangle
void ff_fill_rectangle(FFDrawContext *draw, FFDrawColor *color, uint8_t *dst[], int dst_linesize[], int dst_x, int dst_y, int w, int h)
Fill a rectangle with an uniform color.
Definition: drawutils.c:214
pix_fmt
static enum AVPixelFormat pix_fmt
Definition: demuxing_decoding.c:41
FFDrawColor::u8
uint8_t u8[16]
Definition: drawutils.h:53
ff_copy_rectangle2
void ff_copy_rectangle2(FFDrawContext *draw, uint8_t *dst[], int dst_linesize[], uint8_t *src[], int src_linesize[], int dst_x, int dst_y, int src_x, int src_y, int w, int h)
Copy a rectangle from an image to another.
Definition: drawutils.c:192
FFDrawColor::u32
uint32_t u32[4]
Definition: drawutils.h:51
FFDrawContext::format
enum AVPixelFormat format
Definition: drawutils.h:37
ff_draw_round_to_sub
int ff_draw_round_to_sub(FFDrawContext *draw, int sub_dir, int round_dir, int value)
Round a dimension according to subsampling.
Definition: drawutils.c:618
MAX_PLANES
#define MAX_PLANES
Definition: drawutils.h:33
value
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default value
Definition: writing_filters.txt:86
FFDrawContext
Definition: drawutils.h:35
ff_draw_supported_pixel_formats
AVFilterFormats * ff_draw_supported_pixel_formats(unsigned flags)
Return the list of pixel formats supported by the draw functions.
Definition: drawutils.c:630
pixfmt.h
FFDrawContext::hsub
uint8_t hsub[MAX_PLANES]
Definition: drawutils.h:40
avfilter.h
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
FFDrawContext::flags
unsigned flags
Definition: drawutils.h:45
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
h
h
Definition: vp9dsp_template.c:2038
FFDrawContext::full_range
int full_range
Definition: drawutils.h:44