dxva2_h264: fix reference field marking in long slice struct
[ffmpeg.git] / libavutil / pixdesc.h
1 /*
2  * pixel format descriptor
3  * Copyright (c) 2009 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #ifndef AVUTIL_PIXDESC_H
23 #define AVUTIL_PIXDESC_H
24
25 #include <inttypes.h>
26
27 #include "attributes.h"
28 #include "pixfmt.h"
29 #include "version.h"
30
31 typedef struct AVComponentDescriptor {
32     /**
33      * Which of the 4 planes contains the component.
34      */
35     int plane;
36
37     /**
38      * Number of elements between 2 horizontally consecutive pixels.
39      * Elements are bits for bitstream formats, bytes otherwise.
40      */
41     int step;
42
43     /**
44      * Number of elements before the component of the first pixel.
45      * Elements are bits for bitstream formats, bytes otherwise.
46      */
47     int offset;
48
49     /**
50      * Number of least significant bits that must be shifted away
51      * to get the value.
52      */
53     int shift;
54
55     /**
56      * Number of bits in the component.
57      */
58     int depth;
59
60 #if FF_API_PLUS1_MINUS1
61     /** deprecated, use step instead */
62     attribute_deprecated int step_minus1;
63
64     /** deprecated, use depth instead */
65     attribute_deprecated int depth_minus1;
66
67     /** deprecated, use offset instead */
68     attribute_deprecated int offset_plus1;
69 #endif
70 } AVComponentDescriptor;
71
72 /**
73  * Descriptor that unambiguously describes how the bits of a pixel are
74  * stored in the up to 4 data planes of an image. It also stores the
75  * subsampling factors and number of components.
76  *
77  * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
78  *       and all the YUV variants) AVPixFmtDescriptor just stores how values
79  *       are stored not what these values represent.
80  */
81 typedef struct AVPixFmtDescriptor {
82     const char *name;
83     uint8_t nb_components;  ///< The number of components each pixel has, (1-4)
84
85     /**
86      * Amount to shift the luma width right to find the chroma width.
87      * For YV12 this is 1 for example.
88      * chroma_width = -((-luma_width) >> log2_chroma_w)
89      * The note above is needed to ensure rounding up.
90      * This value only refers to the chroma components.
91      */
92     uint8_t log2_chroma_w;  ///< chroma_width = -((-luma_width )>>log2_chroma_w)
93
94     /**
95      * Amount to shift the luma height right to find the chroma height.
96      * For YV12 this is 1 for example.
97      * chroma_height= -((-luma_height) >> log2_chroma_h)
98      * The note above is needed to ensure rounding up.
99      * This value only refers to the chroma components.
100      */
101     uint8_t log2_chroma_h;
102
103     /**
104      * Combination of AV_PIX_FMT_FLAG_... flags.
105      */
106     uint64_t flags;
107
108     /**
109      * Parameters that describe how pixels are packed.
110      * If the format has 1 or 2 components, then luma is 0.
111      * If the format has 3 or 4 components:
112      *   if the RGB flag is set then 0 is red, 1 is green and 2 is blue;
113      *   otherwise 0 is luma, 1 is chroma-U and 2 is chroma-V.
114      *
115      * If present, the Alpha channel is always the last component.
116      */
117     AVComponentDescriptor comp[4];
118
119     /**
120      * Alternative comma-separated names.
121      */
122     const char *alias;
123 } AVPixFmtDescriptor;
124
125 /**
126  * Pixel format is big-endian.
127  */
128 #define AV_PIX_FMT_FLAG_BE           (1 << 0)
129 /**
130  * Pixel format has a palette in data[1], values are indexes in this palette.
131  */
132 #define AV_PIX_FMT_FLAG_PAL          (1 << 1)
133 /**
134  * All values of a component are bit-wise packed end to end.
135  */
136 #define AV_PIX_FMT_FLAG_BITSTREAM    (1 << 2)
137 /**
138  * Pixel format is an HW accelerated format.
139  */
140 #define AV_PIX_FMT_FLAG_HWACCEL      (1 << 3)
141 /**
142  * At least one pixel component is not in the first data plane.
143  */
144 #define AV_PIX_FMT_FLAG_PLANAR       (1 << 4)
145 /**
146  * The pixel format contains RGB-like data (as opposed to YUV/grayscale).
147  */
148 #define AV_PIX_FMT_FLAG_RGB          (1 << 5)
149
150 /**
151  * The pixel format is "pseudo-paletted". This means that it contains a
152  * fixed palette in the 2nd plane but the palette is fixed/constant for each
153  * PIX_FMT. This allows interpreting the data as if it was PAL8, which can
154  * in some cases be simpler. Or the data can be interpreted purely based on
155  * the pixel format without using the palette.
156  * An example of a pseudo-paletted format is AV_PIX_FMT_GRAY8
157  */
158 #define AV_PIX_FMT_FLAG_PSEUDOPAL    (1 << 6)
159
160 /**
161  * The pixel format has an alpha channel. This is set on all formats that
162  * support alpha in some way. The exception is AV_PIX_FMT_PAL8, which can
163  * carry alpha as part of the palette. Details are explained in the
164  * AVPixelFormat enum, and are also encoded in the corresponding
165  * AVPixFmtDescriptor.
166  *
167  * The alpha is always straight, never pre-multiplied.
168  *
169  * If a codec or a filter does not support alpha, it should set all alpha to
170  * opaque, or use the equivalent pixel formats without alpha component, e.g.
171  * AV_PIX_FMT_RGB0 (or AV_PIX_FMT_RGB24 etc.) instead of AV_PIX_FMT_RGBA.
172  */
173 #define AV_PIX_FMT_FLAG_ALPHA        (1 << 7)
174
175 /**
176  * Read a line from an image, and write the values of the
177  * pixel format component c to dst.
178  *
179  * @param data the array containing the pointers to the planes of the image
180  * @param linesize the array containing the linesizes of the image
181  * @param desc the pixel format descriptor for the image
182  * @param x the horizontal coordinate of the first pixel to read
183  * @param y the vertical coordinate of the first pixel to read
184  * @param w the width of the line to read, that is the number of
185  * values to write to dst
186  * @param read_pal_component if not zero and the format is a paletted
187  * format writes the values corresponding to the palette
188  * component c in data[1] to dst, rather than the palette indexes in
189  * data[0]. The behavior is undefined if the format is not paletted.
190  */
191 void av_read_image_line(uint16_t *dst, const uint8_t *data[4],
192                         const int linesize[4], const AVPixFmtDescriptor *desc,
193                         int x, int y, int c, int w, int read_pal_component);
194
195 /**
196  * Write the values from src to the pixel format component c of an
197  * image line.
198  *
199  * @param src array containing the values to write
200  * @param data the array containing the pointers to the planes of the
201  * image to write into. It is supposed to be zeroed.
202  * @param linesize the array containing the linesizes of the image
203  * @param desc the pixel format descriptor for the image
204  * @param x the horizontal coordinate of the first pixel to write
205  * @param y the vertical coordinate of the first pixel to write
206  * @param w the width of the line to write, that is the number of
207  * values to write to the image line
208  */
209 void av_write_image_line(const uint16_t *src, uint8_t *data[4],
210                          const int linesize[4], const AVPixFmtDescriptor *desc,
211                          int x, int y, int c, int w);
212
213 /**
214  * Return the pixel format corresponding to name.
215  *
216  * If there is no pixel format with name name, then looks for a
217  * pixel format with the name corresponding to the native endian
218  * format of name.
219  * For example in a little-endian system, first looks for "gray16",
220  * then for "gray16le".
221  *
222  * Finally if no pixel format has been found, returns AV_PIX_FMT_NONE.
223  */
224 enum AVPixelFormat av_get_pix_fmt(const char *name);
225
226 /**
227  * Return the short name for a pixel format, NULL in case pix_fmt is
228  * unknown.
229  *
230  * @see av_get_pix_fmt(), av_get_pix_fmt_string()
231  */
232 const char *av_get_pix_fmt_name(enum AVPixelFormat pix_fmt);
233
234 /**
235  * Print in buf the string corresponding to the pixel format with
236  * number pix_fmt, or a header if pix_fmt is negative.
237  *
238  * @param buf the buffer where to write the string
239  * @param buf_size the size of buf
240  * @param pix_fmt the number of the pixel format to print the
241  * corresponding info string, or a negative value to print the
242  * corresponding header.
243  */
244 char *av_get_pix_fmt_string(char *buf, int buf_size,
245                             enum AVPixelFormat pix_fmt);
246
247 /**
248  * Return the number of bits per pixel used by the pixel format
249  * described by pixdesc. Note that this is not the same as the number
250  * of bits per sample.
251  *
252  * The returned number of bits refers to the number of bits actually
253  * used for storing the pixel information, that is padding bits are
254  * not counted.
255  */
256 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
257
258 /**
259  * Return the number of bits per pixel for the pixel format
260  * described by pixdesc, including any padding or unused bits.
261  */
262 int av_get_padded_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
263
264 /**
265  * @return a pixel format descriptor for provided pixel format or NULL if
266  * this pixel format is unknown.
267  */
268 const AVPixFmtDescriptor *av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt);
269
270 /**
271  * Iterate over all pixel format descriptors known to libavutil.
272  *
273  * @param prev previous descriptor. NULL to get the first descriptor.
274  *
275  * @return next descriptor or NULL after the last descriptor
276  */
277 const AVPixFmtDescriptor *av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev);
278
279 /**
280  * @return an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc
281  * is not a valid pointer to a pixel format descriptor.
282  */
283 enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
284
285 /**
286  * Utility function to access log2_chroma_w log2_chroma_h from
287  * the pixel format AVPixFmtDescriptor.
288  *
289  * See av_get_chroma_sub_sample() for a function that asserts a
290  * valid pixel format instead of returning an error code.
291  * Its recommended that you use avcodec_get_chroma_sub_sample unless
292  * you do check the return code!
293  *
294  * @param[in]  pix_fmt the pixel format
295  * @param[out] h_shift store log2_chroma_w
296  * @param[out] v_shift store log2_chroma_h
297  *
298  * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format
299  */
300 int av_pix_fmt_get_chroma_sub_sample(enum AVPixelFormat pix_fmt,
301                                      int *h_shift, int *v_shift);
302
303 /**
304  * @return number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a
305  * valid pixel format.
306  */
307 int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt);
308
309 /**
310  * Utility function to swap the endianness of a pixel format.
311  *
312  * @param[in]  pix_fmt the pixel format
313  *
314  * @return pixel format with swapped endianness if it exists,
315  * otherwise AV_PIX_FMT_NONE
316  */
317 enum AVPixelFormat av_pix_fmt_swap_endianness(enum AVPixelFormat pix_fmt);
318
319 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
320 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
321 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
322 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
323 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
324 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
325
326 /**
327  * Compute what kind of losses will occur when converting from one specific
328  * pixel format to another.
329  * When converting from one pixel format to another, information loss may occur.
330  * For example, when converting from RGB24 to GRAY, the color information will
331  * be lost. Similarly, other losses occur when converting from some formats to
332  * other formats. These losses can involve loss of chroma, but also loss of
333  * resolution, loss of color depth, loss due to the color space conversion, loss
334  * of the alpha bits or loss due to color quantization.
335  * av_get_fix_fmt_loss() informs you about the various types of losses
336  * which will occur when converting from one pixel format to another.
337  *
338  * @param[in] dst_pix_fmt destination pixel format
339  * @param[in] src_pix_fmt source pixel format
340  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
341  * @return Combination of flags informing you what kind of losses will occur
342  * (maximum loss for an invalid dst_pix_fmt).
343  */
344 int av_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt,
345                         enum AVPixelFormat src_pix_fmt,
346                         int has_alpha);
347
348 /**
349  * Compute what kind of losses will occur when converting from one specific
350  * pixel format to another.
351  * When converting from one pixel format to another, information loss may occur.
352  * For example, when converting from RGB24 to GRAY, the color information will
353  * be lost. Similarly, other losses occur when converting from some formats to
354  * other formats. These losses can involve loss of chroma, but also loss of
355  * resolution, loss of color depth, loss due to the color space conversion, loss
356  * of the alpha bits or loss due to color quantization.
357  * av_get_fix_fmt_loss() informs you about the various types of losses
358  * which will occur when converting from one pixel format to another.
359  *
360  * @param[in] dst_pix_fmt destination pixel format
361  * @param[in] src_pix_fmt source pixel format
362  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
363  * @return Combination of flags informing you what kind of losses will occur
364  * (maximum loss for an invalid dst_pix_fmt).
365  */
366 enum AVPixelFormat av_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
367                                              enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
368
369 /**
370  * @return the name for provided color range or NULL if unknown.
371  */
372 const char *av_color_range_name(enum AVColorRange range);
373
374 /**
375  * @return the name for provided color primaries or NULL if unknown.
376  */
377 const char *av_color_primaries_name(enum AVColorPrimaries primaries);
378
379 /**
380  * @return the name for provided color transfer or NULL if unknown.
381  */
382 const char *av_color_transfer_name(enum AVColorTransferCharacteristic transfer);
383
384 /**
385  * @return the name for provided color space or NULL if unknown.
386  */
387 const char *av_color_space_name(enum AVColorSpace space);
388
389 /**
390  * @return the name for provided chroma location or NULL if unknown.
391  */
392 const char *av_chroma_location_name(enum AVChromaLocation location);
393
394 #endif /* AVUTIL_PIXDESC_H */