Statistics
| Branch: | Revision:

ffmpeg / libavcore / imgutils.h @ 5d6e4c16

History | View | Annotate | Download (4.91 KB)

1 e7bd48a6 Stefano Sabatini
/*
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 AVCORE_IMGUTILS_H
20
#define AVCORE_IMGUTILS_H
21
22
/**
23
 * @file
24
 * misc image utilities
25
 */
26
27 a6ddf8bf Stefano Sabatini
#include "libavutil/pixdesc.h"
28 e7bd48a6 Stefano Sabatini
#include "avcore.h"
29
30
/**
31 a6ddf8bf Stefano Sabatini
 * Compute the max pixel step for each plane of an image with a
32 d1a991f2 Stefano Sabatini
 * format described by pixdesc.
33 a6ddf8bf Stefano Sabatini
 *
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 e3443361 Stefano Sabatini
 * @param max_pixsteps an array which is filled with the max pixel step
40 a6ddf8bf Stefano Sabatini
 * for each plane. Since a plane may contain different pixel
41 e3443361 Stefano Sabatini
 * components, the computed max_pixsteps[plane] is relative to the
42 a6ddf8bf Stefano Sabatini
 * component in the plane with the max pixel step.
43 e3443361 Stefano Sabatini
 * @param max_pixstep_comps an array which is filled with the component
44 a6ddf8bf Stefano Sabatini
 * for each plane which has the max pixel step. May be NULL.
45
 */
46 9b7269e3 Stefano Sabatini
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
47 0f146263 Stefano Sabatini
                                const AVPixFmtDescriptor *pixdesc);
48 a6ddf8bf Stefano Sabatini
49
/**
50 7906e2b9 Stefano Sabatini
 * 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 9b7269e3 Stefano Sabatini
int av_image_get_linesize(enum PixelFormat pix_fmt, int width, int plane);
56 7906e2b9 Stefano Sabatini
57
/**
58 e7bd48a6 Stefano Sabatini
 * 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 9b7269e3 Stefano Sabatini
int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
65 e7bd48a6 Stefano Sabatini
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 d222e9f9 Ramiro Polla
 * plane, should be filled by av_image_fill_linesizes()
74 e7bd48a6 Stefano Sabatini
 * @return the size in bytes required for the image buffer, a negative
75
 * error code in case of failure
76
 */
77 9b7269e3 Stefano Sabatini
int av_image_fill_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
78 e7bd48a6 Stefano Sabatini
                           uint8_t *ptr, const int linesizes[4]);
79
80 bf176f58 Stefano Sabatini
/**
81 9686abb8 Stefano Sabatini
 * Copy image plane from src to dst.
82
 * That is, copy "height" number of lines of "bytewidth" bytes each.
83
 * The first byte of each successive line is separated by *_linesize
84
 * bytes.
85
 *
86
 * @param dst_linesize linesize for the image plane in dst
87
 * @param src_linesize linesize for the image plane in src
88
 */
89
void av_image_copy_plane(uint8_t       *dst, int dst_linesize,
90
                         const uint8_t *src, int src_linesize,
91
                         int bytewidth, int height);
92
93
/**
94 34017fd9 Stefano Sabatini
 * Copy image in src_data to dst_data.
95
 *
96
 * @param dst_linesize linesizes for the image in dst_data
97
 * @param src_linesize linesizes for the image in src_data
98
 */
99 2b3cd04d Stefano Sabatini
void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
100
                   const uint8_t *src_data[4], const int src_linesizes[4],
101 34017fd9 Stefano Sabatini
                   enum PixelFormat pix_fmt, int width, int height);
102
103
/**
104 bf176f58 Stefano Sabatini
 * Check if the given dimension of an image is valid, meaning that all
105
 * bytes of the image can be addressed with a signed int.
106
 *
107
 * @param w the width of the picture
108
 * @param h the height of the picture
109
 * @param log_offset the offset to sum to the log level for logging with log_ctx
110
 * @param log_ctx the parent logging context, it may be NULL
111
 * @return >= 0 if valid, a negative error code otherwise
112
 */
113 9b7269e3 Stefano Sabatini
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
114
115
#if FF_API_OLD_IMAGE_NAMES
116
attribute_deprecated
117
void av_fill_image_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
118
                                const AVPixFmtDescriptor *pixdesc);
119
120
attribute_deprecated
121
int av_get_image_linesize(enum PixelFormat pix_fmt, int width, int plane);
122
123
attribute_deprecated
124
int av_fill_image_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
125
126
attribute_deprecated
127
int av_fill_image_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
128
                           uint8_t *ptr, const int linesizes[4]);
129
130
attribute_deprecated
131 bf176f58 Stefano Sabatini
int av_check_image_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
132 9b7269e3 Stefano Sabatini
#endif
133 bf176f58 Stefano Sabatini
134 e7bd48a6 Stefano Sabatini
#endif /* AVCORE_IMGUTILS_H */