drawutils: new API.
[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 PixelFormat 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 PixelFormat 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 PixelFormat format;
51     unsigned nb_planes;
52     int pixelstep[MAX_PLANES]; /*< offset between pixels */
53     uint8_t hsub[MAX_PLANES];  /*< horizontal subsamling */
54     uint8_t vsub[MAX_PLANES];  /*< vertical subsamling */
55     uint8_t hsub_max;
56     uint8_t vsub_max;
57 } FFDrawContext;
58
59 typedef struct FFDrawColor {
60     union {
61         uint32_t u32;
62         uint16_t u16;
63         uint8_t  u8[4];
64     } comp[MAX_PLANES];
65 } FFDrawColor;
66
67 /**
68  * Init a draw context.
69  *
70  * Only a limited number of pixel formats are supported, if format is not
71  * supported the function will return an error.
72  * No flags currently defined.
73  * @return  0 for success, < 0 for error
74  */
75 int ff_draw_init(FFDrawContext *draw, enum PixelFormat format, unsigned flags);
76
77 /**
78  * Prepare a color.
79  */
80 void ff_draw_color(FFDrawContext *draw, FFDrawColor *color, uint8_t rgba[4]);
81
82 /**
83  * Copy a rectangle from an image to another.
84  *
85  * The coordinates must be as even as the subsampling requires.
86  */
87 void ff_copy_rectangle2(FFDrawContext *draw,
88                         uint8_t *dst[], int dst_linesize[],
89                         uint8_t *src[], int src_linesize[],
90                         int dst_x, int dst_y, int src_x, int src_y,
91                         int w, int h);
92
93 /**
94  * Fill a rectangle with an uniform color.
95  *
96  * The coordinates must be as even as the subsampling requires.
97  * The color needs to be inited with ff_draw_color.
98  */
99 void ff_fill_rectangle(FFDrawContext *draw, FFDrawColor *color,
100                        uint8_t *dst[], int dst_linesize[],
101                        int dst_x, int dst_y, int w, int h);
102
103 /**
104  * Round a dimension according to subsampling.
105  *
106  * @param draw       draw context
107  * @param sub_dir    0 for horizontal, 1 for vertical
108  * @param round_dir  0 nearest, -1 round down, +1 round up
109  * @param value      value to round
110  * @return  the rounded value
111  */
112 int ff_draw_round_to_sub(FFDrawContext *draw, int sub_dir, int round_dir,
113                          int value);
114
115 /**
116  * Return the list of pixel formats supported by the draw functions.
117  *
118  * The flags are the same as ff_draw_init, i.e., none currently.
119  */
120 AVFilterFormats *ff_draw_supported_pixel_formats(unsigned flags);
121
122 #endif /* AVFILTER_DRAWUTILS_H */