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 comp_mask[MAX_PLANES]; /*< bitmask of used non-alpha components */
41  uint8_t hsub[MAX_PLANES]; /*< horizontal subsampling */
42  uint8_t vsub[MAX_PLANES]; /*< vertical subsampling */
46  unsigned flags;
48 
49 typedef struct FFDrawColor {
51  union {
52  uint32_t u32[4];
53  uint16_t u16[8];
54  uint8_t u8[16];
55  } comp[MAX_PLANES];
56 } FFDrawColor;
57 
58 /**
59  * Process alpha pixel component.
60  */
61 #define FF_DRAW_PROCESS_ALPHA 1
62 
63 /**
64  * Init a draw context.
65  *
66  * Only a limited number of pixel formats are supported, if format is not
67  * supported the function will return an error.
68  * flags is combination of FF_DRAW_* flags.
69  * @return 0 for success, < 0 for error
70  */
71 int ff_draw_init(FFDrawContext *draw, enum AVPixelFormat format, unsigned flags);
72 
73 /**
74  * Prepare a color.
75  */
76 void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, const uint8_t rgba[4]);
77 
78 /**
79  * Copy a rectangle from an image to another.
80  *
81  * The coordinates must be as even as the subsampling requires.
82  */
84  uint8_t *dst[], int dst_linesize[],
85  uint8_t *src[], int src_linesize[],
86  int dst_x, int dst_y, int src_x, int src_y,
87  int w, int h);
88 
89 /**
90  * Fill a rectangle with an uniform color.
91  *
92  * The coordinates must be as even as the subsampling requires.
93  * The color needs to be inited with ff_draw_color.
94  */
96  uint8_t *dst[], int dst_linesize[],
97  int dst_x, int dst_y, int w, int h);
98 
99 /**
100  * Blend a rectangle with an uniform color.
101  */
103  uint8_t *dst[], int dst_linesize[],
104  int dst_w, int dst_h,
105  int x0, int y0, int w, int h);
106 
107 /**
108  * Blend an alpha mask with an uniform color.
109  *
110  * @param draw draw context
111  * @param color color for the overlay;
112  * @param dst destination image
113  * @param dst_linesize line stride of the destination
114  * @param dst_w width of the destination image
115  * @param dst_h height of the destination image
116  * @param mask mask
117  * @param mask_linesize line stride of the mask
118  * @param mask_w width of the mask
119  * @param mask_h height of the mask
120  * @param l2depth log2 of depth of the mask (0 for 1bpp, 3 for 8bpp)
121  * @param endianness bit order of the mask (0: MSB to the left)
122  * @param x0 horizontal position of the overlay
123  * @param y0 vertical position of the overlay
124  */
126  uint8_t *dst[], int dst_linesize[], int dst_w, int dst_h,
127  const uint8_t *mask, int mask_linesize, int mask_w, int mask_h,
128  int l2depth, unsigned endianness, int x0, int y0);
129 
130 /**
131  * Round a dimension according to subsampling.
132  *
133  * @param draw draw context
134  * @param sub_dir 0 for horizontal, 1 for vertical
135  * @param round_dir 0 nearest, -1 round down, +1 round up
136  * @param value value to round
137  * @return the rounded value
138  */
139 int ff_draw_round_to_sub(FFDrawContext *draw, int sub_dir, int round_dir,
140  int value);
141 
142 /**
143  * Return the list of pixel formats supported by the draw functions.
144  *
145  * The flags are the same as ff_draw_init, i.e., none currently.
146  */
148 
149 #endif /* AVFILTER_DRAWUTILS_H */
FFDrawColor
Definition: drawutils.h:49
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
color
Definition: vf_paletteuse.c:583
FFDrawContext::hsub_max
uint8_t hsub_max
Definition: drawutils.h:43
FFDrawContext::desc
const struct AVPixFmtDescriptor * desc
Definition: drawutils.h:36
w
uint8_t w
Definition: llviddspenc.c:39
FFDrawColor::u16
uint16_t u16[8]
Definition: drawutils.h:53
ff_fill_rgba_map
int ff_fill_rgba_map(uint8_t *rgba_map, enum AVPixelFormat pix_fmt)
Definition: drawutils.c:35
FFDrawColor::rgba
uint8_t rgba[4]
Definition: drawutils.h:50
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:528
ff_draw_color
void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, const uint8_t rgba[4])
Prepare a color.
Definition: drawutils.c:137
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:351
FFDrawContext::nb_planes
unsigned nb_planes
Definition: drawutils.h:38
FFDrawContext::pixelstep
int pixelstep[MAX_PLANES]
Definition: drawutils.h:39
AVFilterFormats
A list of supported formats for one end of a filter link.
Definition: formats.h:65
FFDrawContext::vsub_max
uint8_t vsub_max
Definition: drawutils.h:44
ff_draw_init
int ff_draw_init(FFDrawContext *draw, enum AVPixelFormat format, unsigned flags)
Init a draw context.
Definition: drawutils.c:84
FFDrawColor::comp
union FFDrawColor::@204 comp[MAX_PLANES]
mask
static const uint16_t mask[17]
Definition: lzw.c:38
FFDrawContext::vsub
uint8_t vsub[MAX_PLANES]
Definition: drawutils.h:42
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:224
pix_fmt
static enum AVPixelFormat pix_fmt
Definition: demuxing_decoding.c:40
src
#define src
Definition: vp8dsp.c:255
FFDrawColor::u8
uint8_t u8[16]
Definition: drawutils.h:54
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:202
FFDrawColor::u32
uint32_t u32[4]
Definition: drawutils.h:52
FFDrawContext::format
enum AVPixelFormat format
Definition: drawutils.h:37
FFDrawContext::comp_mask
uint8_t comp_mask[MAX_PLANES]
Definition: drawutils.h:40
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:625
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
uint8_t
uint8_t
Definition: audio_convert.c:194
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:637
pixfmt.h
FFDrawContext::hsub
uint8_t hsub[MAX_PLANES]
Definition: drawutils.h:41
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:81
format
fg outputs[0] format
Definition: ffmpeg_filter.c:177
FFDrawContext::flags
unsigned flags
Definition: drawutils.h:46
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:45