imgutils.h 4.79 KB
Newer Older
1
/*
2
 * This file is part of Libav.
3
 *
4
 * Libav is free software; you can redistribute it and/or
5 6 7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
9
 * Libav is distributed in the hope that it will be useful,
10 11 12 13 14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 17 18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

19 20
#ifndef AVUTIL_IMGUTILS_H
#define AVUTIL_IMGUTILS_H
21 22 23 24 25 26

/**
 * @file
 * misc image utilities
 */

27
#include "libavutil/pixdesc.h"
28
#include "avutil.h"
29

30 31
/**
 * Compute the max pixel step for each plane of an image with a
32
 * format described by pixdesc.
33 34 35 36 37 38
 *
 * The pixel step is the distance in bytes between the first byte of
 * the group of bytes which describe a pixel component and the first
 * byte of the successive group in the same plane for the same
 * component.
 *
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 45
 * for each plane which has the max pixel step. May be NULL.
 */
46
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
47
                                const AVPixFmtDescriptor *pixdesc);
48

49 50 51 52 53 54
/**
 * Compute the size of an image line with format pix_fmt and width
 * width for the plane plane.
 *
 * @return the computed size in bytes
 */
55
int av_image_get_linesize(enum PixelFormat pix_fmt, int width, int plane);
56

57 58 59 60 61 62 63
/**
 * Fill plane linesizes for an image with pixel format pix_fmt and
 * width width.
 *
 * @param linesizes array to be filled with the linesize for each plane
 * @return >= 0 in case of success, a negative error code otherwise
 */
64
int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
65 66 67 68 69 70 71 72

/**
 * Fill plane data pointers for an image with pixel format pix_fmt and
 * height height.
 *
 * @param data pointers array to be filled with the pointer for each image plane
 * @param ptr the pointer to a buffer which will contain the image
 * @param linesizes[4] the array containing the linesize for each
73
 * plane, should be filled by av_image_fill_linesizes()
74 75 76
 * @return the size in bytes required for the image buffer, a negative
 * error code in case of failure
 */
77
int av_image_fill_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
78 79
                           uint8_t *ptr, const int linesizes[4]);

80 81 82 83 84 85 86 87 88 89 90 91 92
/**
 * Allocate an image with size w and h and pixel format pix_fmt, and
 * fill pointers and linesizes accordingly.
 * The allocated image buffer has to be freed by using
 * av_freep(&pointers[0]).
 *
 * @param align the value to use for buffer size alignment
 * @return the size in bytes required for the image buffer, a negative
 * error code in case of failure
 */
int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
                   int w, int h, enum PixelFormat pix_fmt, int align);

93 94 95 96 97 98 99 100 101 102 103 104 105
/**
 * Copy image plane from src to dst.
 * That is, copy "height" number of lines of "bytewidth" bytes each.
 * The first byte of each successive line is separated by *_linesize
 * bytes.
 *
 * @param dst_linesize linesize for the image plane in dst
 * @param src_linesize linesize for the image plane in src
 */
void av_image_copy_plane(uint8_t       *dst, int dst_linesize,
                         const uint8_t *src, int src_linesize,
                         int bytewidth, int height);

106 107 108 109 110 111
/**
 * Copy image in src_data to dst_data.
 *
 * @param dst_linesize linesizes for the image in dst_data
 * @param src_linesize linesizes for the image in src_data
 */
112 113
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
                   const uint8_t *src_data[4], const int src_linesizes[4],
114 115
                   enum PixelFormat pix_fmt, int width, int height);

116 117 118 119 120 121 122 123 124 125
/**
 * Check if the given dimension of an image is valid, meaning that all
 * bytes of the image can be addressed with a signed int.
 *
 * @param w the width of the picture
 * @param h the height of the picture
 * @param log_offset the offset to sum to the log level for logging with log_ctx
 * @param log_ctx the parent logging context, it may be NULL
 * @return >= 0 if valid, a negative error code otherwise
 */
126 127
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);

128 129 130
int ff_set_systematic_pal2(uint32_t pal[256], enum PixelFormat pix_fmt);

#endif /* AVUTIL_IMGUTILS_H */