b569eb1ca4d6ce6366000a98698a897f5fa51e9f
[ffmpeg.git] / libavutil / imgutils.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVUTIL_IMGUTILS_H
20 #define AVUTIL_IMGUTILS_H
21
22 /**
23  * @file
24  * misc image utilities
25  */
26
27 #include "avutil.h"
28 #include "pixdesc.h"
29
30 /**
31  * Compute the max pixel step for each plane of an image with a
32  * format described by pixdesc.
33  *
34  * The pixel step is the distance in bytes between the first byte of
35  * the group of bytes which describe a pixel component and the first
36  * byte of the successive group in the same plane for the same
37  * component.
38  *
39  * @param max_pixsteps an array which is filled with the max pixel step
40  * for each plane. Since a plane may contain different pixel
41  * components, the computed max_pixsteps[plane] is relative to the
42  * component in the plane with the max pixel step.
43  * @param max_pixstep_comps an array which is filled with the component
44  * for each plane which has the max pixel step. May be NULL.
45  */
46 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
47                                 const AVPixFmtDescriptor *pixdesc);
48
49 /**
50  * Compute the size of an image line with format pix_fmt and width
51  * width for the plane plane.
52  *
53  * @return the computed size in bytes
54  */
55 int av_image_get_linesize(enum PixelFormat pix_fmt, int width, int plane);
56
57 /**
58  * Fill plane linesizes for an image with pixel format pix_fmt and
59  * width width.
60  *
61  * @param linesizes array to be filled with the linesize for each plane
62  * @return >= 0 in case of success, a negative error code otherwise
63  */
64 int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
65
66 /**
67  * Fill plane data pointers for an image with pixel format pix_fmt and
68  * height height.
69  *
70  * @param data pointers array to be filled with the pointer for each image plane
71  * @param ptr the pointer to a buffer which will contain the image
72  * @param linesizes[4] the array containing the linesize for each
73  * plane, should be filled by av_image_fill_linesizes()
74  * @return the size in bytes required for the image buffer, a negative
75  * error code in case of failure
76  */
77 int av_image_fill_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
78                            uint8_t *ptr, const int linesizes[4]);
79
80 /**
81  * Allocate an image with size w and h and pixel format pix_fmt, and
82  * fill pointers and linesizes accordingly.
83  * The allocated image buffer has to be freed by using
84  * av_freep(&pointers[0]).
85  *
86  * @param align the value to use for buffer size alignment
87  * @return the size in bytes required for the image buffer, a negative
88  * error code in case of failure
89  */
90 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
91                    int w, int h, enum PixelFormat pix_fmt, int align);
92
93 /**
94  * Copy image plane from src to dst.
95  * That is, copy "height" number of lines of "bytewidth" bytes each.
96  * The first byte of each successive line is separated by *_linesize
97  * bytes.
98  *
99  * @param dst_linesize linesize for the image plane in dst
100  * @param src_linesize linesize for the image plane in src
101  */
102 void av_image_copy_plane(uint8_t       *dst, int dst_linesize,
103                          const uint8_t *src, int src_linesize,
104                          int bytewidth, int height);
105
106 /**
107  * Copy image in src_data to dst_data.
108  *
109  * @param dst_linesize linesizes for the image in dst_data
110  * @param src_linesize linesizes for the image in src_data
111  */
112 void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
113                    const uint8_t *src_data[4], const int src_linesizes[4],
114                    enum PixelFormat pix_fmt, int width, int height);
115
116 /**
117  * Check if the given dimension of an image is valid, meaning that all
118  * bytes of the image can be addressed with a signed int.
119  *
120  * @param w the width of the picture
121  * @param h the height of the picture
122  * @param log_offset the offset to sum to the log level for logging with log_ctx
123  * @param log_ctx the parent logging context, it may be NULL
124  * @return >= 0 if valid, a negative error code otherwise
125  */
126 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
127
128 int ff_set_systematic_pal2(uint32_t pal[256], enum PixelFormat pix_fmt);
129
130 #endif /* AVUTIL_IMGUTILS_H */