2 * pixel format descriptor
3 * Copyright (c) 2009 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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"
31 typedef struct AVComponentDescriptor {
33 * Which of the 4 planes contains the component.
38 * Number of elements between 2 horizontally consecutive pixels.
39 * Elements are bits for bitstream formats, bytes otherwise.
44 * Number of elements before the component of the first pixel.
45 * Elements are bits for bitstream formats, bytes otherwise.
50 * Number of least significant bits that must be shifted away
56 * Number of bits in the component.
59 } AVComponentDescriptor;
62 * Descriptor that unambiguously describes how the bits of a pixel are
63 * stored in the up to 4 data planes of an image. It also stores the
64 * subsampling factors and number of components.
66 * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
67 * and all the YUV variants) AVPixFmtDescriptor just stores how values
68 * are stored not what these values represent.
70 typedef struct AVPixFmtDescriptor {
72 uint8_t nb_components; ///< The number of components each pixel has, (1-4)
75 * Amount to shift the luma width right to find the chroma width.
76 * For YV12 this is 1 for example.
77 * chroma_width = AV_CEIL_RSHIFT(luma_width, log2_chroma_w)
78 * The note above is needed to ensure rounding up.
79 * This value only refers to the chroma components.
81 uint8_t log2_chroma_w;
84 * Amount to shift the luma height right to find the chroma height.
85 * For YV12 this is 1 for example.
86 * chroma_height= AV_CEIL_RSHIFT(luma_height, log2_chroma_h)
87 * The note above is needed to ensure rounding up.
88 * This value only refers to the chroma components.
90 uint8_t log2_chroma_h;
93 * Combination of AV_PIX_FMT_FLAG_... flags.
98 * Parameters that describe how pixels are packed.
99 * If the format has 1 or 2 components, then luma is 0.
100 * If the format has 3 or 4 components:
101 * if the RGB flag is set then 0 is red, 1 is green and 2 is blue;
102 * otherwise 0 is luma, 1 is chroma-U and 2 is chroma-V.
104 * If present, the Alpha channel is always the last component.
106 AVComponentDescriptor comp[4];
109 * Alternative comma-separated names.
112 } AVPixFmtDescriptor;
115 * Pixel format is big-endian.
117 #define AV_PIX_FMT_FLAG_BE (1 << 0)
119 * Pixel format has a palette in data[1], values are indexes in this palette.
121 #define AV_PIX_FMT_FLAG_PAL (1 << 1)
123 * All values of a component are bit-wise packed end to end.
125 #define AV_PIX_FMT_FLAG_BITSTREAM (1 << 2)
127 * Pixel format is an HW accelerated format.
129 #define AV_PIX_FMT_FLAG_HWACCEL (1 << 3)
131 * At least one pixel component is not in the first data plane.
133 #define AV_PIX_FMT_FLAG_PLANAR (1 << 4)
135 * The pixel format contains RGB-like data (as opposed to YUV/grayscale).
137 #define AV_PIX_FMT_FLAG_RGB (1 << 5)
141 * The pixel format is "pseudo-paletted". This means that it contains a
142 * fixed palette in the 2nd plane but the palette is fixed/constant for each
143 * PIX_FMT. This allows interpreting the data as if it was PAL8, which can
144 * in some cases be simpler. Or the data can be interpreted purely based on
145 * the pixel format without using the palette.
146 * An example of a pseudo-paletted format is AV_PIX_FMT_GRAY8
148 * @deprecated This flag is deprecated, and will be removed. When it is removed,
149 * the extra palette allocation in AVFrame.data[1] is removed as well. Only
150 * actual paletted formats (as indicated by AV_PIX_FMT_FLAG_PAL) will have a
151 * palette. Starting with FFmpeg versions which have this flag deprecated, the
152 * extra "pseudo" palette is already ignored, and API users are not required to
153 * allocate a palette for AV_PIX_FMT_FLAG_PSEUDOPAL formats (it was required
154 * before the deprecation, though).
156 #define AV_PIX_FMT_FLAG_PSEUDOPAL (1 << 6)
160 * The pixel format has an alpha channel. This is set on all formats that
161 * support alpha in some way, including AV_PIX_FMT_PAL8. The alpha is always
162 * straight, never pre-multiplied.
164 * If a codec or a filter does not support alpha, it should set all alpha to
165 * opaque, or use the equivalent pixel formats without alpha component, e.g.
166 * AV_PIX_FMT_RGB0 (or AV_PIX_FMT_RGB24 etc.) instead of AV_PIX_FMT_RGBA.
168 #define AV_PIX_FMT_FLAG_ALPHA (1 << 7)
171 * The pixel format is following a Bayer pattern
173 #define AV_PIX_FMT_FLAG_BAYER (1 << 8)
176 * The pixel format contains IEEE-754 floating point values. Precision (double,
177 * single, or half) should be determined by the pixel size (64, 32, or 16 bits).
179 #define AV_PIX_FMT_FLAG_FLOAT (1 << 9)
182 * Return the number of bits per pixel used by the pixel format
183 * described by pixdesc. Note that this is not the same as the number
184 * of bits per sample.
186 * The returned number of bits refers to the number of bits actually
187 * used for storing the pixel information, that is padding bits are
190 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
193 * Return the number of bits per pixel for the pixel format
194 * described by pixdesc, including any padding or unused bits.
196 int av_get_padded_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
199 * @return a pixel format descriptor for provided pixel format or NULL if
200 * this pixel format is unknown.
202 const AVPixFmtDescriptor *av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt);
205 * Iterate over all pixel format descriptors known to libavutil.
207 * @param prev previous descriptor. NULL to get the first descriptor.
209 * @return next descriptor or NULL after the last descriptor
211 const AVPixFmtDescriptor *av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev);
214 * @return an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc
215 * is not a valid pointer to a pixel format descriptor.
217 enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
220 * Utility function to access log2_chroma_w log2_chroma_h from
221 * the pixel format AVPixFmtDescriptor.
223 * @param[in] pix_fmt the pixel format
224 * @param[out] h_shift store log2_chroma_w (horizontal/width shift)
225 * @param[out] v_shift store log2_chroma_h (vertical/height shift)
227 * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format
229 int av_pix_fmt_get_chroma_sub_sample(enum AVPixelFormat pix_fmt,
230 int *h_shift, int *v_shift);
233 * @return number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a
234 * valid pixel format.
236 int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt);
239 * @return the name for provided color range or NULL if unknown.
241 const char *av_color_range_name(enum AVColorRange range);
244 * @return the AVColorRange value for name or an AVError if not found.
246 int av_color_range_from_name(const char *name);
249 * @return the name for provided color primaries or NULL if unknown.
251 const char *av_color_primaries_name(enum AVColorPrimaries primaries);
254 * @return the AVColorPrimaries value for name or an AVError if not found.
256 int av_color_primaries_from_name(const char *name);
259 * @return the name for provided color transfer or NULL if unknown.
261 const char *av_color_transfer_name(enum AVColorTransferCharacteristic transfer);
264 * @return the AVColorTransferCharacteristic value for name or an AVError if not found.
266 int av_color_transfer_from_name(const char *name);
269 * @return the name for provided color space or NULL if unknown.
271 const char *av_color_space_name(enum AVColorSpace space);
274 * @return the AVColorSpace value for name or an AVError if not found.
276 int av_color_space_from_name(const char *name);
279 * @return the name for provided chroma location or NULL if unknown.
281 const char *av_chroma_location_name(enum AVChromaLocation location);
284 * @return the AVChromaLocation value for name or an AVError if not found.
286 int av_chroma_location_from_name(const char *name);
289 * Return the pixel format corresponding to name.
291 * If there is no pixel format with name name, then looks for a
292 * pixel format with the name corresponding to the native endian
294 * For example in a little-endian system, first looks for "gray16",
295 * then for "gray16le".
297 * Finally if no pixel format has been found, returns AV_PIX_FMT_NONE.
299 enum AVPixelFormat av_get_pix_fmt(const char *name);
302 * Return the short name for a pixel format, NULL in case pix_fmt is
305 * @see av_get_pix_fmt(), av_get_pix_fmt_string()
307 const char *av_get_pix_fmt_name(enum AVPixelFormat pix_fmt);
310 * Print in buf the string corresponding to the pixel format with
311 * number pix_fmt, or a header if pix_fmt is negative.
313 * @param buf the buffer where to write the string
314 * @param buf_size the size of buf
315 * @param pix_fmt the number of the pixel format to print the
316 * corresponding info string, or a negative value to print the
317 * corresponding header.
319 char *av_get_pix_fmt_string(char *buf, int buf_size,
320 enum AVPixelFormat pix_fmt);
323 * Read a line from an image, and write the values of the
324 * pixel format component c to dst.
326 * @param data the array containing the pointers to the planes of the image
327 * @param linesize the array containing the linesizes of the image
328 * @param desc the pixel format descriptor for the image
329 * @param x the horizontal coordinate of the first pixel to read
330 * @param y the vertical coordinate of the first pixel to read
331 * @param w the width of the line to read, that is the number of
332 * values to write to dst
333 * @param read_pal_component if not zero and the format is a paletted
334 * format writes the values corresponding to the palette
335 * component c in data[1] to dst, rather than the palette indexes in
336 * data[0]. The behavior is undefined if the format is not paletted.
337 * @param dst_element_size size of elements in dst array (2 or 4 byte)
339 void av_read_image_line2(void *dst, const uint8_t *data[4],
340 const int linesize[4], const AVPixFmtDescriptor *desc,
341 int x, int y, int c, int w, int read_pal_component,
342 int dst_element_size);
344 void av_read_image_line(uint16_t *dst, const uint8_t *data[4],
345 const int linesize[4], const AVPixFmtDescriptor *desc,
346 int x, int y, int c, int w, int read_pal_component);
349 * Write the values from src to the pixel format component c of an
352 * @param src array containing the values to write
353 * @param data the array containing the pointers to the planes of the
354 * image to write into. It is supposed to be zeroed.
355 * @param linesize the array containing the linesizes of the image
356 * @param desc the pixel format descriptor for the image
357 * @param x the horizontal coordinate of the first pixel to write
358 * @param y the vertical coordinate of the first pixel to write
359 * @param w the width of the line to write, that is the number of
360 * values to write to the image line
361 * @param src_element_size size of elements in src array (2 or 4 byte)
363 void av_write_image_line2(const void *src, uint8_t *data[4],
364 const int linesize[4], const AVPixFmtDescriptor *desc,
365 int x, int y, int c, int w, int src_element_size);
367 void av_write_image_line(const uint16_t *src, uint8_t *data[4],
368 const int linesize[4], const AVPixFmtDescriptor *desc,
369 int x, int y, int c, int w);
372 * Utility function to swap the endianness of a pixel format.
374 * @param[in] pix_fmt the pixel format
376 * @return pixel format with swapped endianness if it exists,
377 * otherwise AV_PIX_FMT_NONE
379 enum AVPixelFormat av_pix_fmt_swap_endianness(enum AVPixelFormat pix_fmt);
381 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
382 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
383 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
384 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
385 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
386 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
389 * Compute what kind of losses will occur when converting from one specific
390 * pixel format to another.
391 * When converting from one pixel format to another, information loss may occur.
392 * For example, when converting from RGB24 to GRAY, the color information will
393 * be lost. Similarly, other losses occur when converting from some formats to
394 * other formats. These losses can involve loss of chroma, but also loss of
395 * resolution, loss of color depth, loss due to the color space conversion, loss
396 * of the alpha bits or loss due to color quantization.
397 * av_get_fix_fmt_loss() informs you about the various types of losses
398 * which will occur when converting from one pixel format to another.
400 * @param[in] dst_pix_fmt destination pixel format
401 * @param[in] src_pix_fmt source pixel format
402 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
403 * @return Combination of flags informing you what kind of losses will occur
404 * (maximum loss for an invalid dst_pix_fmt).
406 int av_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt,
407 enum AVPixelFormat src_pix_fmt,
411 * Compute what kind of losses will occur when converting from one specific
412 * pixel format to another.
413 * When converting from one pixel format to another, information loss may occur.
414 * For example, when converting from RGB24 to GRAY, the color information will
415 * be lost. Similarly, other losses occur when converting from some formats to
416 * other formats. These losses can involve loss of chroma, but also loss of
417 * resolution, loss of color depth, loss due to the color space conversion, loss
418 * of the alpha bits or loss due to color quantization.
419 * av_get_fix_fmt_loss() informs you about the various types of losses
420 * which will occur when converting from one pixel format to another.
422 * @param[in] dst_pix_fmt destination pixel format
423 * @param[in] src_pix_fmt source pixel format
424 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
425 * @return Combination of flags informing you what kind of losses will occur
426 * (maximum loss for an invalid dst_pix_fmt).
428 enum AVPixelFormat av_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
429 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
431 #endif /* AVUTIL_PIXDESC_H */