FFmpeg
imgutils.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 AVUTIL_IMGUTILS_H
20 #define AVUTIL_IMGUTILS_H
21 
22 /**
23  * @file
24  * misc image utilities
25  *
26  * @addtogroup lavu_picture
27  * @{
28  */
29 
30 #include <stddef.h>
31 #include <stdint.h>
32 #include "pixdesc.h"
33 #include "pixfmt.h"
34 #include "rational.h"
35 
36 /**
37  * Compute the max pixel step for each plane of an image with a
38  * format described by pixdesc.
39  *
40  * The pixel step is the distance in bytes between the first byte of
41  * the group of bytes which describe a pixel component and the first
42  * byte of the successive group in the same plane for the same
43  * component.
44  *
45  * @param max_pixsteps an array which is filled with the max pixel step
46  * for each plane. Since a plane may contain different pixel
47  * components, the computed max_pixsteps[plane] is relative to the
48  * component in the plane with the max pixel step.
49  * @param max_pixstep_comps an array which is filled with the component
50  * for each plane which has the max pixel step. May be NULL.
51  */
52 void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
53  const AVPixFmtDescriptor *pixdesc);
54 
55 /**
56  * Compute the size of an image line with format pix_fmt and width
57  * width for the plane plane.
58  *
59  * @return the computed size in bytes
60  */
61 int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane);
62 
63 /**
64  * Fill plane linesizes for an image with pixel format pix_fmt and
65  * width width.
66  *
67  * @param linesizes array to be filled with the linesize for each plane
68  * @return >= 0 in case of success, a negative error code otherwise
69  */
70 int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width);
71 
72 /**
73  * Fill plane sizes for an image with pixel format pix_fmt and height height.
74  *
75  * @param size the array to be filled with the size of each image plane
76  * @param linesizes the array containing the linesize for each
77  * plane, should be filled by av_image_fill_linesizes()
78  * @return >= 0 in case of success, a negative error code otherwise
79  *
80  * @note The linesize parameters have the type ptrdiff_t here, while they are
81  * int for av_image_fill_linesizes().
82  */
84  int height, const ptrdiff_t linesizes[4]);
85 
86 /**
87  * Fill plane data pointers for an image with pixel format pix_fmt and
88  * height height.
89  *
90  * @param data pointers array to be filled with the pointer for each image plane
91  * @param ptr the pointer to a buffer which will contain the image
92  * @param linesizes the array containing the linesize for each
93  * plane, should be filled by av_image_fill_linesizes()
94  * @return the size in bytes required for the image buffer, a negative
95  * error code in case of failure
96  */
97 int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height,
98  uint8_t *ptr, const int linesizes[4]);
99 
100 /**
101  * Allocate an image with size w and h and pixel format pix_fmt, and
102  * fill pointers and linesizes accordingly.
103  * The allocated image buffer has to be freed by using
104  * av_freep(&pointers[0]).
105  *
106  * @param align the value to use for buffer size alignment
107  * @return the size in bytes required for the image buffer, a negative
108  * error code in case of failure
109  */
110 int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
111  int w, int h, enum AVPixelFormat pix_fmt, int align);
112 
113 /**
114  * Copy image plane from src to dst.
115  * That is, copy "height" number of lines of "bytewidth" bytes each.
116  * The first byte of each successive line is separated by *_linesize
117  * bytes.
118  *
119  * bytewidth must be contained by both absolute values of dst_linesize
120  * and src_linesize, otherwise the function behavior is undefined.
121  *
122  * @param dst_linesize linesize for the image plane in dst
123  * @param src_linesize linesize for the image plane in src
124  */
125 void av_image_copy_plane(uint8_t *dst, int dst_linesize,
126  const uint8_t *src, int src_linesize,
127  int bytewidth, int height);
128 
129 /**
130  * Copy image data located in uncacheable (e.g. GPU mapped) memory. Where
131  * available, this function will use special functionality for reading from such
132  * memory, which may result in greatly improved performance compared to plain
133  * av_image_copy_plane().
134  *
135  * bytewidth must be contained by both absolute values of dst_linesize
136  * and src_linesize, otherwise the function behavior is undefined.
137  *
138  * @note The linesize parameters have the type ptrdiff_t here, while they are
139  * int for av_image_copy_plane().
140  * @note On x86, the linesizes currently need to be aligned to the cacheline
141  * size (i.e. 64) to get improved performance.
142  */
143 void av_image_copy_plane_uc_from(uint8_t *dst, ptrdiff_t dst_linesize,
144  const uint8_t *src, ptrdiff_t src_linesize,
145  ptrdiff_t bytewidth, int height);
146 
147 /**
148  * Copy image in src_data to dst_data.
149  *
150  * @param dst_linesizes linesizes for the image in dst_data
151  * @param src_linesizes linesizes for the image in src_data
152  */
153 void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
154  const uint8_t *src_data[4], const int src_linesizes[4],
155  enum AVPixelFormat pix_fmt, int width, int height);
156 
157 /**
158  * Copy image data located in uncacheable (e.g. GPU mapped) memory. Where
159  * available, this function will use special functionality for reading from such
160  * memory, which may result in greatly improved performance compared to plain
161  * av_image_copy().
162  *
163  * The data pointers and the linesizes must be aligned to the maximum required
164  * by the CPU architecture.
165  *
166  * @note The linesize parameters have the type ptrdiff_t here, while they are
167  * int for av_image_copy().
168  * @note On x86, the linesizes currently need to be aligned to the cacheline
169  * size (i.e. 64) to get improved performance.
170  */
171 void av_image_copy_uc_from(uint8_t *dst_data[4], const ptrdiff_t dst_linesizes[4],
172  const uint8_t *src_data[4], const ptrdiff_t src_linesizes[4],
173  enum AVPixelFormat pix_fmt, int width, int height);
174 
175 /**
176  * Setup the data pointers and linesizes based on the specified image
177  * parameters and the provided array.
178  *
179  * The fields of the given image are filled in by using the src
180  * address which points to the image data buffer. Depending on the
181  * specified pixel format, one or multiple image data pointers and
182  * line sizes will be set. If a planar format is specified, several
183  * pointers will be set pointing to the different picture planes and
184  * the line sizes of the different planes will be stored in the
185  * lines_sizes array. Call with src == NULL to get the required
186  * size for the src buffer.
187  *
188  * To allocate the buffer and fill in the dst_data and dst_linesize in
189  * one call, use av_image_alloc().
190  *
191  * @param dst_data data pointers to be filled in
192  * @param dst_linesize linesizes for the image in dst_data to be filled in
193  * @param src buffer which will contain or contains the actual image data, can be NULL
194  * @param pix_fmt the pixel format of the image
195  * @param width the width of the image in pixels
196  * @param height the height of the image in pixels
197  * @param align the value used in src for linesize alignment
198  * @return the size in bytes required for src, a negative error code
199  * in case of failure
200  */
201 int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
202  const uint8_t *src,
203  enum AVPixelFormat pix_fmt, int width, int height, int align);
204 
205 /**
206  * Return the size in bytes of the amount of data required to store an
207  * image with the given parameters.
208  *
209  * @param pix_fmt the pixel format of the image
210  * @param width the width of the image in pixels
211  * @param height the height of the image in pixels
212  * @param align the assumed linesize alignment
213  * @return the buffer size in bytes, a negative error code in case of failure
214  */
215 int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align);
216 
217 /**
218  * Copy image data from an image into a buffer.
219  *
220  * av_image_get_buffer_size() can be used to compute the required size
221  * for the buffer to fill.
222  *
223  * @param dst a buffer into which picture data will be copied
224  * @param dst_size the size in bytes of dst
225  * @param src_data pointers containing the source image data
226  * @param src_linesize linesizes for the image in src_data
227  * @param pix_fmt the pixel format of the source image
228  * @param width the width of the source image in pixels
229  * @param height the height of the source image in pixels
230  * @param align the assumed linesize alignment for dst
231  * @return the number of bytes written to dst, or a negative value
232  * (error code) on error
233  */
234 int av_image_copy_to_buffer(uint8_t *dst, int dst_size,
235  const uint8_t * const src_data[4], const int src_linesize[4],
236  enum AVPixelFormat pix_fmt, int width, int height, int align);
237 
238 /**
239  * Check if the given dimension of an image is valid, meaning that all
240  * bytes of the image can be addressed with a signed int.
241  *
242  * @param w the width of the picture
243  * @param h the height of the picture
244  * @param log_offset the offset to sum to the log level for logging with log_ctx
245  * @param log_ctx the parent logging context, it may be NULL
246  * @return >= 0 if valid, a negative error code otherwise
247  */
248 int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
249 
250 /**
251  * Check if the given dimension of an image is valid, meaning that all
252  * bytes of a plane of an image with the specified pix_fmt can be addressed
253  * with a signed int.
254  *
255  * @param w the width of the picture
256  * @param h the height of the picture
257  * @param max_pixels the maximum number of pixels the user wants to accept
258  * @param pix_fmt the pixel format, can be AV_PIX_FMT_NONE if unknown.
259  * @param log_offset the offset to sum to the log level for logging with log_ctx
260  * @param log_ctx the parent logging context, it may be NULL
261  * @return >= 0 if valid, a negative error code otherwise
262  */
263 int av_image_check_size2(unsigned int w, unsigned int h, int64_t max_pixels, enum AVPixelFormat pix_fmt, int log_offset, void *log_ctx);
264 
265 /**
266  * Check if the given sample aspect ratio of an image is valid.
267  *
268  * It is considered invalid if the denominator is 0 or if applying the ratio
269  * to the image size would make the smaller dimension less than 1. If the
270  * sar numerator is 0, it is considered unknown and will return as valid.
271  *
272  * @param w width of the image
273  * @param h height of the image
274  * @param sar sample aspect ratio of the image
275  * @return 0 if valid, a negative AVERROR code otherwise
276  */
277 int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar);
278 
279 /**
280  * Overwrite the image data with black. This is suitable for filling a
281  * sub-rectangle of an image, meaning the padding between the right most pixel
282  * and the left most pixel on the next line will not be overwritten. For some
283  * formats, the image size might be rounded up due to inherent alignment.
284  *
285  * If the pixel format has alpha, the alpha is cleared to opaque.
286  *
287  * This can return an error if the pixel format is not supported. Normally, all
288  * non-hwaccel pixel formats should be supported.
289  *
290  * Passing NULL for dst_data is allowed. Then the function returns whether the
291  * operation would have succeeded. (It can return an error if the pix_fmt is
292  * not supported.)
293  *
294  * @param dst_data data pointers to destination image
295  * @param dst_linesize linesizes for the destination image
296  * @param pix_fmt the pixel format of the image
297  * @param range the color range of the image (important for colorspaces such as YUV)
298  * @param width the width of the image in pixels
299  * @param height the height of the image in pixels
300  * @return 0 if the image data was cleared, a negative AVERROR code otherwise
301  */
302 int av_image_fill_black(uint8_t *dst_data[4], const ptrdiff_t dst_linesize[4],
303  enum AVPixelFormat pix_fmt, enum AVColorRange range,
304  int width, int height);
305 
306 /**
307  * @}
308  */
309 
310 
311 #endif /* AVUTIL_IMGUTILS_H */
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
rational.h
pixdesc.h
w
uint8_t w
Definition: llviddspenc.c:38
data
const char data[16]
Definition: mxf.c:146
av_image_copy_plane
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
Definition: imgutils.c:374
av_image_fill_pointers
int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height, uint8_t *ptr, const int linesizes[4])
Fill plane data pointers for an image with pixel format pix_fmt and height height.
Definition: imgutils.c:145
av_image_check_size2
int av_image_check_size2(unsigned int w, unsigned int h, int64_t max_pixels, enum AVPixelFormat pix_fmt, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of a plane of an image with...
Definition: imgutils.c:289
width
#define width
av_image_fill_linesizes
int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width)
Fill plane linesizes for an image with pixel format pix_fmt and width width.
Definition: imgutils.c:89
pointers
Undefined Behavior In the C some operations are like signed integer dereferencing freed pointers
Definition: undefined.txt:4
pix_fmt
static enum AVPixelFormat pix_fmt
Definition: demuxing_decoding.c:41
av_image_fill_plane_sizes
int av_image_fill_plane_sizes(size_t size[4], enum AVPixelFormat pix_fmt, int height, const ptrdiff_t linesizes[4])
Fill plane sizes for an image with pixel format pix_fmt and height height.
Definition: imgutils.c:111
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
av_image_fill_black
int av_image_fill_black(uint8_t *dst_data[4], const ptrdiff_t dst_linesize[4], enum AVPixelFormat pix_fmt, enum AVColorRange range, int width, int height)
Overwrite the image data with black.
Definition: imgutils.c:582
av_image_alloc
int av_image_alloc(uint8_t *pointers[4], int linesizes[4], int w, int h, enum AVPixelFormat pix_fmt, int align)
Allocate an image with size w and h and pixel format pix_fmt, and fill pointers and linesizes accordi...
Definition: imgutils.c:218
av_image_fill_arrays
int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4], const uint8_t *src, enum AVPixelFormat pix_fmt, int width, int height, int align)
Setup the data pointers and linesizes based on the specified image parameters and the provided array.
Definition: imgutils.c:446
size
int size
Definition: twinvq_data.h:10344
height
#define height
av_image_get_buffer_size
int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align)
Return the size in bytes of the amount of data required to store an image with the given parameters.
Definition: imgutils.c:466
av_image_get_linesize
int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane)
Compute the size of an image line with format pix_fmt and width width for the plane plane.
Definition: imgutils.c:76
av_image_copy_uc_from
void av_image_copy_uc_from(uint8_t *dst_data[4], const ptrdiff_t dst_linesizes[4], const uint8_t *src_data[4], const ptrdiff_t src_linesizes[4], enum AVPixelFormat pix_fmt, int width, int height)
Copy image data located in uncacheable (e.g.
Definition: imgutils.c:438
pixfmt.h
av_image_copy_plane_uc_from
void av_image_copy_plane_uc_from(uint8_t *dst, ptrdiff_t dst_linesize, const uint8_t *src, ptrdiff_t src_linesize, ptrdiff_t bytewidth, int height)
Copy image data located in uncacheable (e.g.
Definition: imgutils.c:359
av_image_copy
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], const uint8_t *src_data[4], const int src_linesizes[4], enum AVPixelFormat pix_fmt, int width, int height)
Copy image in src_data to dst_data.
Definition: imgutils.c:422
av_image_fill_max_pixsteps
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], const AVPixFmtDescriptor *pixdesc)
Compute the max pixel step for each plane of an image with a format described by pixdesc.
Definition: imgutils.c:35
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
av_image_copy_to_buffer
int av_image_copy_to_buffer(uint8_t *dst, int dst_size, const uint8_t *const src_data[4], const int src_linesize[4], enum AVPixelFormat pix_fmt, int width, int height, int align)
Copy image data from an image into a buffer.
Definition: imgutils.c:501
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
h
h
Definition: vp9dsp_template.c:2038
av_image_check_sar
int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar)
Check if the given sample aspect ratio of an image is valid.
Definition: imgutils.c:323
av_image_check_size
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:318
AVColorRange
AVColorRange
Visual content value range.
Definition: pixfmt.h:566