2 * pixel format descriptor
3 * Copyright (c) 2009 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of Libav.
7 * Libav is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * Libav is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef AVUTIL_PIXDESC_H
23 #define AVUTIL_PIXDESC_H
27 #include "attributes.h"
30 typedef struct AVComponentDescriptor {
32 * Which of the 4 planes contains the component.
37 * Number of elements between 2 horizontally consecutive pixels minus 1.
38 * Elements are bits for bitstream formats, bytes otherwise.
40 uint16_t step_minus1 : 3;
43 * Number of elements before the component of the first pixel plus 1.
44 * Elements are bits for bitstream formats, bytes otherwise.
46 uint16_t offset_plus1 : 3;
49 * Number of least significant bits that must be shifted away
55 * Number of bits in the component minus 1.
57 uint16_t depth_minus1 : 4;
58 } AVComponentDescriptor;
61 * Descriptor that unambiguously describes how the bits of a pixel are
62 * stored in the up to 4 data planes of an image. It also stores the
63 * subsampling factors and number of components.
65 * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
66 * and all the YUV variants) AVPixFmtDescriptor just stores how values
67 * are stored not what these values represent.
69 typedef struct AVPixFmtDescriptor {
71 uint8_t nb_components; ///< The number of components each pixel has, (1-4)
74 * Amount to shift the luma width right to find the chroma width.
75 * For YV12 this is 1 for example.
76 * chroma_width = -((-luma_width) >> log2_chroma_w)
77 * The note above is needed to ensure rounding up.
78 * This value only refers to the chroma components.
80 uint8_t log2_chroma_w; ///< chroma_width = -((-luma_width )>>log2_chroma_w)
83 * Amount to shift the luma height right to find the chroma height.
84 * For YV12 this is 1 for example.
85 * chroma_height= -((-luma_height) >> log2_chroma_h)
86 * The note above is needed to ensure rounding up.
87 * This value only refers to the chroma components.
89 uint8_t log2_chroma_h;
93 * Parameters that describe how pixels are packed. If the format
94 * has chroma components, they must be stored in comp[1] and
97 AVComponentDescriptor comp[4];
101 * Pixel format is big-endian.
103 #define AV_PIX_FMT_FLAG_BE (1 << 0)
105 * Pixel format has a palette in data[1], values are indexes in this palette.
107 #define AV_PIX_FMT_FLAG_PAL (1 << 1)
109 * All values of a component are bit-wise packed end to end.
111 #define AV_PIX_FMT_FLAG_BITSTREAM (1 << 2)
113 * Pixel format is an HW accelerated format.
115 #define AV_PIX_FMT_FLAG_HWACCEL (1 << 3)
117 * At least one pixel component is not in the first data plane.
119 #define AV_PIX_FMT_FLAG_PLANAR (1 << 4)
121 * The pixel format contains RGB-like data (as opposed to YUV/grayscale).
123 #define AV_PIX_FMT_FLAG_RGB (1 << 5)
125 * The pixel format is "pseudo-paletted". This means that Libav treats it as
126 * paletted internally, but the palette is generated by the decoder and is not
127 * stored in the file.
129 #define AV_PIX_FMT_FLAG_PSEUDOPAL (1 << 6)
131 * The pixel format has an alpha channel.
133 #define AV_PIX_FMT_FLAG_ALPHA (1 << 7)
137 * @deprecated use the AV_PIX_FMT_FLAG_* flags
139 #define PIX_FMT_BE AV_PIX_FMT_FLAG_BE
140 #define PIX_FMT_PAL AV_PIX_FMT_FLAG_PAL
141 #define PIX_FMT_BITSTREAM AV_PIX_FMT_FLAG_BITSTREAM
142 #define PIX_FMT_HWACCEL AV_PIX_FMT_FLAG_HWACCEL
143 #define PIX_FMT_PLANAR AV_PIX_FMT_FLAG_PLANAR
144 #define PIX_FMT_RGB AV_PIX_FMT_FLAG_RGB
145 #define PIX_FMT_PSEUDOPAL AV_PIX_FMT_FLAG_PSEUDOPAL
146 #define PIX_FMT_ALPHA AV_PIX_FMT_FLAG_ALPHA
149 #if FF_API_PIX_FMT_DESC
151 * The array of all the pixel format descriptors.
153 extern attribute_deprecated const AVPixFmtDescriptor av_pix_fmt_descriptors[];
157 * Read a line from an image, and write the values of the
158 * pixel format component c to dst.
160 * @param data the array containing the pointers to the planes of the image
161 * @param linesize the array containing the linesizes of the image
162 * @param desc the pixel format descriptor for the image
163 * @param x the horizontal coordinate of the first pixel to read
164 * @param y the vertical coordinate of the first pixel to read
165 * @param w the width of the line to read, that is the number of
166 * values to write to dst
167 * @param read_pal_component if not zero and the format is a paletted
168 * format writes the values corresponding to the palette
169 * component c in data[1] to dst, rather than the palette indexes in
170 * data[0]. The behavior is undefined if the format is not paletted.
172 void av_read_image_line(uint16_t *dst, const uint8_t *data[4],
173 const int linesize[4], const AVPixFmtDescriptor *desc,
174 int x, int y, int c, int w, int read_pal_component);
177 * Write the values from src to the pixel format component c of an
180 * @param src array containing the values to write
181 * @param data the array containing the pointers to the planes of the
182 * image to write into. It is supposed to be zeroed.
183 * @param linesize the array containing the linesizes of the image
184 * @param desc the pixel format descriptor for the image
185 * @param x the horizontal coordinate of the first pixel to write
186 * @param y the vertical coordinate of the first pixel to write
187 * @param w the width of the line to write, that is the number of
188 * values to write to the image line
190 void av_write_image_line(const uint16_t *src, uint8_t *data[4],
191 const int linesize[4], const AVPixFmtDescriptor *desc,
192 int x, int y, int c, int w);
195 * Return the pixel format corresponding to name.
197 * If there is no pixel format with name name, then looks for a
198 * pixel format with the name corresponding to the native endian
200 * For example in a little-endian system, first looks for "gray16",
201 * then for "gray16le".
203 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
205 enum AVPixelFormat av_get_pix_fmt(const char *name);
208 * Return the short name for a pixel format, NULL in case pix_fmt is
211 * @see av_get_pix_fmt(), av_get_pix_fmt_string()
213 const char *av_get_pix_fmt_name(enum AVPixelFormat pix_fmt);
216 * Print in buf the string corresponding to the pixel format with
217 * number pix_fmt, or an header if pix_fmt is negative.
219 * @param buf the buffer where to write the string
220 * @param buf_size the size of buf
221 * @param pix_fmt the number of the pixel format to print the
222 * corresponding info string, or a negative value to print the
223 * corresponding header.
225 char *av_get_pix_fmt_string(char *buf, int buf_size,
226 enum AVPixelFormat pix_fmt);
229 * Return the number of bits per pixel used by the pixel format
230 * described by pixdesc. Note that this is not the same as the number
231 * of bits per sample.
233 * The returned number of bits refers to the number of bits actually
234 * used for storing the pixel information, that is padding bits are
237 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
240 * @return a pixel format descriptor for provided pixel format or NULL if
241 * this pixel format is unknown.
243 const AVPixFmtDescriptor *av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt);
246 * Iterate over all pixel format descriptors known to libavutil.
248 * @param prev previous descriptor. NULL to get the first descriptor.
250 * @return next descriptor or NULL after the last descriptor
252 const AVPixFmtDescriptor *av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev);
255 * @return an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc
256 * is not a valid pointer to a pixel format descriptor.
258 enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
261 * Utility function to access log2_chroma_w log2_chroma_h from
262 * the pixel format AVPixFmtDescriptor.
264 * @param[in] pix_fmt the pixel format
265 * @param[out] h_shift store log2_chroma_h
266 * @param[out] v_shift store log2_chroma_w
268 * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format
270 int av_pix_fmt_get_chroma_sub_sample(enum AVPixelFormat pix_fmt,
271 int *h_shift, int *v_shift);
274 * @return number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a
275 * valid pixel format.
277 int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt);
280 * Utility function to swap the endianness of a pixel format.
282 * @param[in] pix_fmt the pixel format
284 * @return pixel format with swapped endianness if it exists,
285 * otherwise AV_PIX_FMT_NONE
287 enum AVPixelFormat av_pix_fmt_swap_endianness(enum AVPixelFormat pix_fmt);
289 #endif /* AVUTIL_PIXDESC_H */