yading@11: /* yading@11: * This file is part of FFmpeg. yading@11: * yading@11: * FFmpeg is free software; you can redistribute it and/or yading@11: * modify it under the terms of the GNU Lesser General Public yading@11: * License as published by the Free Software Foundation; either yading@11: * version 2.1 of the License, or (at your option) any later version. yading@11: * yading@11: * FFmpeg is distributed in the hope that it will be useful, yading@11: * but WITHOUT ANY WARRANTY; without even the implied warranty of yading@11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU yading@11: * Lesser General Public License for more details. yading@11: * yading@11: * You should have received a copy of the GNU Lesser General Public yading@11: * License along with FFmpeg; if not, write to the Free Software yading@11: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA yading@11: */ yading@11: yading@11: #ifndef AVUTIL_IMGUTILS_H yading@11: #define AVUTIL_IMGUTILS_H yading@11: yading@11: /** yading@11: * @file yading@11: * misc image utilities yading@11: * yading@11: * @addtogroup lavu_picture yading@11: * @{ yading@11: */ yading@11: yading@11: #include "avutil.h" yading@11: #include "pixdesc.h" yading@11: yading@11: /** yading@11: * Compute the max pixel step for each plane of an image with a yading@11: * format described by pixdesc. yading@11: * yading@11: * The pixel step is the distance in bytes between the first byte of yading@11: * the group of bytes which describe a pixel component and the first yading@11: * byte of the successive group in the same plane for the same yading@11: * component. yading@11: * yading@11: * @param max_pixsteps an array which is filled with the max pixel step yading@11: * for each plane. Since a plane may contain different pixel yading@11: * components, the computed max_pixsteps[plane] is relative to the yading@11: * component in the plane with the max pixel step. yading@11: * @param max_pixstep_comps an array which is filled with the component yading@11: * for each plane which has the max pixel step. May be NULL. yading@11: */ yading@11: void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], yading@11: const AVPixFmtDescriptor *pixdesc); yading@11: yading@11: /** yading@11: * Compute the size of an image line with format pix_fmt and width yading@11: * width for the plane plane. yading@11: * yading@11: * @return the computed size in bytes yading@11: */ yading@11: int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane); yading@11: yading@11: /** yading@11: * Fill plane linesizes for an image with pixel format pix_fmt and yading@11: * width width. yading@11: * yading@11: * @param linesizes array to be filled with the linesize for each plane yading@11: * @return >= 0 in case of success, a negative error code otherwise yading@11: */ yading@11: int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width); yading@11: yading@11: /** yading@11: * Fill plane data pointers for an image with pixel format pix_fmt and yading@11: * height height. yading@11: * yading@11: * @param data pointers array to be filled with the pointer for each image plane yading@11: * @param ptr the pointer to a buffer which will contain the image yading@11: * @param linesizes the array containing the linesize for each yading@11: * plane, should be filled by av_image_fill_linesizes() yading@11: * @return the size in bytes required for the image buffer, a negative yading@11: * error code in case of failure yading@11: */ yading@11: int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height, yading@11: uint8_t *ptr, const int linesizes[4]); yading@11: yading@11: /** yading@11: * Allocate an image with size w and h and pixel format pix_fmt, and yading@11: * fill pointers and linesizes accordingly. yading@11: * The allocated image buffer has to be freed by using yading@11: * av_freep(&pointers[0]). yading@11: * yading@11: * @param align the value to use for buffer size alignment yading@11: * @return the size in bytes required for the image buffer, a negative yading@11: * error code in case of failure yading@11: */ yading@11: int av_image_alloc(uint8_t *pointers[4], int linesizes[4], yading@11: int w, int h, enum AVPixelFormat pix_fmt, int align); yading@11: yading@11: /** yading@11: * Copy image plane from src to dst. yading@11: * That is, copy "height" number of lines of "bytewidth" bytes each. yading@11: * The first byte of each successive line is separated by *_linesize yading@11: * bytes. yading@11: * yading@11: * bytewidth must be contained by both absolute values of dst_linesize yading@11: * and src_linesize, otherwise the function behavior is undefined. yading@11: * yading@11: * @param dst_linesize linesize for the image plane in dst yading@11: * @param src_linesize linesize for the image plane in src yading@11: */ yading@11: void av_image_copy_plane(uint8_t *dst, int dst_linesize, yading@11: const uint8_t *src, int src_linesize, yading@11: int bytewidth, int height); yading@11: yading@11: /** yading@11: * Copy image in src_data to dst_data. yading@11: * yading@11: * @param dst_linesizes linesizes for the image in dst_data yading@11: * @param src_linesizes linesizes for the image in src_data yading@11: */ yading@11: void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], yading@11: const uint8_t *src_data[4], const int src_linesizes[4], yading@11: enum AVPixelFormat pix_fmt, int width, int height); yading@11: yading@11: /** yading@11: * Setup the data pointers and linesizes based on the specified image yading@11: * parameters and the provided array. yading@11: * yading@11: * The fields of the given image are filled in by using the src yading@11: * address which points to the image data buffer. Depending on the yading@11: * specified pixel format, one or multiple image data pointers and yading@11: * line sizes will be set. If a planar format is specified, several yading@11: * pointers will be set pointing to the different picture planes and yading@11: * the line sizes of the different planes will be stored in the yading@11: * lines_sizes array. Call with src == NULL to get the required yading@11: * size for the src buffer. yading@11: * yading@11: * To allocate the buffer and fill in the dst_data and dst_linesize in yading@11: * one call, use av_image_alloc(). yading@11: * yading@11: * @param dst_data data pointers to be filled in yading@11: * @param dst_linesizes linesizes for the image in dst_data to be filled in yading@11: * @param src buffer which will contain or contains the actual image data, can be NULL yading@11: * @param pix_fmt the pixel format of the image yading@11: * @param width the width of the image in pixels yading@11: * @param height the height of the image in pixels yading@11: * @param align the value used in src for linesize alignment yading@11: * @return the size in bytes required for src, a negative error code yading@11: * in case of failure yading@11: */ yading@11: int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4], yading@11: const uint8_t *src, yading@11: enum AVPixelFormat pix_fmt, int width, int height, int align); yading@11: yading@11: /** yading@11: * Return the size in bytes of the amount of data required to store an yading@11: * image with the given parameters. yading@11: * yading@11: * @param[in] align the assumed linesize alignment yading@11: */ yading@11: int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align); yading@11: yading@11: /** yading@11: * Copy image data from an image into a buffer. yading@11: * yading@11: * av_image_get_buffer_size() can be used to compute the required size yading@11: * for the buffer to fill. yading@11: * yading@11: * @param dst a buffer into which picture data will be copied yading@11: * @param dst_size the size in bytes of dst yading@11: * @param src_data pointers containing the source image data yading@11: * @param src_linesizes linesizes for the image in src_data yading@11: * @param pix_fmt the pixel format of the source image yading@11: * @param width the width of the source image in pixels yading@11: * @param height the height of the source image in pixels yading@11: * @param align the assumed linesize alignment for dst yading@11: * @return the number of bytes written to dst, or a negative value yading@11: * (error code) on error yading@11: */ yading@11: int av_image_copy_to_buffer(uint8_t *dst, int dst_size, yading@11: const uint8_t * const src_data[4], const int src_linesize[4], yading@11: enum AVPixelFormat pix_fmt, int width, int height, int align); yading@11: yading@11: /** yading@11: * Check if the given dimension of an image is valid, meaning that all yading@11: * bytes of the image can be addressed with a signed int. yading@11: * yading@11: * @param w the width of the picture yading@11: * @param h the height of the picture yading@11: * @param log_offset the offset to sum to the log level for logging with log_ctx yading@11: * @param log_ctx the parent logging context, it may be NULL yading@11: * @return >= 0 if valid, a negative error code otherwise yading@11: */ yading@11: int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx); yading@11: yading@11: int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt); yading@11: yading@11: /** yading@11: * @} yading@11: */ yading@11: yading@11: yading@11: #endif /* AVUTIL_IMGUTILS_H */