lavfi/vf_libvmaf: convert to framesync2.
[ffmpeg.git] / libavfilter / drawutils.h
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 int ff_fill_line_with_color(uint8_t *line[4], int pixel_step[4], int w,
34                             uint8_t dst_color[4],
35                             enum AVPixelFormat pix_fmt, uint8_t rgba_color[4],
36                             int *is_packed_rgba, uint8_t rgba_map[4]);
37
38 void ff_draw_rectangle(uint8_t *dst[4], int dst_linesize[4],
39                        uint8_t *src[4], int pixelstep[4],
40                        int hsub, int vsub, int x, int y, int w, int h);
41
42 void ff_copy_rectangle(uint8_t *dst[4], int dst_linesize[4],
43                        uint8_t *src[4], int src_linesize[4], int pixelstep[4],
44                        int hsub, int vsub, int x, int y, int y2, int w, int h);
45
46 #define MAX_PLANES 4
47
48 typedef struct FFDrawContext {
49     const struct AVPixFmtDescriptor *desc;
50     enum AVPixelFormat format;
51     unsigned nb_planes;
52     int pixelstep[MAX_PLANES]; /*< offset between pixels */
53     uint8_t comp_mask[MAX_PLANES]; /*< bitmask of used non-alpha components */
54     uint8_t hsub[MAX_PLANES];  /*< horizontal subsampling */
55     uint8_t vsub[MAX_PLANES];  /*< vertical subsampling */
56     uint8_t hsub_max;
57     uint8_t vsub_max;
58     unsigned flags;
59 } FFDrawContext;
60
61 typedef struct FFDrawColor {
62     uint8_t rgba[4];
63     union {
64         uint32_t u32[4];
65         uint16_t u16[8];
66         uint8_t  u8[16];
67     } comp[MAX_PLANES];
68 } FFDrawColor;
69
70 /**
71   * Process alpha pixel component.
72   */
73 #define FF_DRAW_PROCESS_ALPHA 1
74
75 /**
76  * Init a draw context.
77  *
78  * Only a limited number of pixel formats are supported, if format is not
79  * supported the function will return an error.
80  * flags is combination of FF_DRAW_* flags.
81  * @return  0 for success, < 0 for error
82  */
83 int ff_draw_init(FFDrawContext *draw, enum AVPixelFormat format, unsigned flags);
84
85 /**
86  * Prepare a color.
87  */
88 void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, const uint8_t rgba[4]);
89
90 /**
91  * Copy a rectangle from an image to another.
92  *
93  * The coordinates must be as even as the subsampling requires.
94  */
95 void ff_copy_rectangle2(FFDrawContext *draw,
96                         uint8_t *dst[], int dst_linesize[],
97                         uint8_t *src[], int src_linesize[],
98                         int dst_x, int dst_y, int src_x, int src_y,
99                         int w, int h);
100
101 /**
102  * Fill a rectangle with an uniform color.
103  *
104  * The coordinates must be as even as the subsampling requires.
105  * The color needs to be inited with ff_draw_color.
106  */
107 void ff_fill_rectangle(FFDrawContext *draw, FFDrawColor *color,
108                        uint8_t *dst[], int dst_linesize[],
109                        int dst_x, int dst_y, int w, int h);
110
111 /**
112  * Blend a rectangle with an uniform color.
113  */
114 void ff_blend_rectangle(FFDrawContext *draw, FFDrawColor *color,
115                         uint8_t *dst[], int dst_linesize[],
116                         int dst_w, int dst_h,
117                         int x0, int y0, int w, int h);
118
119 /**
120  * Blend an alpha mask with an uniform color.
121  *
122  * @param draw           draw context
123  * @param color          color for the overlay;
124  * @param dst            destination image
125  * @param dst_linesize   line stride of the destination
126  * @param dst_w          width of the destination image
127  * @param dst_h          height of the destination image
128  * @param mask           mask
129  * @param mask_linesize  line stride of the mask
130  * @param mask_w         width of the mask
131  * @param mask_h         height of the mask
132  * @param l2depth        log2 of depth of the mask (0 for 1bpp, 3 for 8bpp)
133  * @param endianness     bit order of the mask (0: MSB to the left)
134  * @param x0             horizontal position of the overlay
135  * @param y0             vertical position of the overlay
136  */
137 void ff_blend_mask(FFDrawContext *draw, FFDrawColor *color,
138                    uint8_t *dst[], int dst_linesize[], int dst_w, int dst_h,
139                    const uint8_t *mask, int mask_linesize, int mask_w, int mask_h,
140                    int l2depth, unsigned endianness, int x0, int y0);
141
142 /**
143  * Round a dimension according to subsampling.
144  *
145  * @param draw       draw context
146  * @param sub_dir    0 for horizontal, 1 for vertical
147  * @param round_dir  0 nearest, -1 round down, +1 round up
148  * @param value      value to round
149  * @return  the rounded value
150  */
151 int ff_draw_round_to_sub(FFDrawContext *draw, int sub_dir, int round_dir,
152                          int value);
153
154 /**
155  * Return the list of pixel formats supported by the draw functions.
156  *
157  * The flags are the same as ff_draw_init, i.e., none currently.
158  */
159 AVFilterFormats *ff_draw_supported_pixel_formats(unsigned flags);
160
161 #endif /* AVFILTER_DRAWUTILS_H */