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