23dc009a12e3f1bfdf8b9f7c1dde71e63e8237ea
[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 Libav.
6  *
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.
11  *
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.
16  *
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
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
30 typedef struct AVComponentDescriptor {
31     /**
32      * Which of the 4 planes contains the component.
33      */
34     uint16_t plane        : 2;
35
36     /**
37      * Number of elements between 2 horizontally consecutive pixels minus 1.
38      * Elements are bits for bitstream formats, bytes otherwise.
39      */
40     uint16_t step_minus1  : 3;
41
42     /**
43      * Number of elements before the component of the first pixel plus 1.
44      * Elements are bits for bitstream formats, bytes otherwise.
45      */
46     uint16_t offset_plus1 : 3;
47
48     /**
49      * Number of least significant bits that must be shifted away
50      * to get the value.
51      */
52     uint16_t shift        : 3;
53
54     /**
55      * Number of bits in the component minus 1.
56      */
57     uint16_t depth_minus1 : 4;
58 } AVComponentDescriptor;
59
60 /**
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.
64  *
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.
68  */
69 typedef struct AVPixFmtDescriptor {
70     const char *name;
71     uint8_t nb_components;  ///< The number of components each pixel has, (1-4)
72
73     /**
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.
79      */
80     uint8_t log2_chroma_w;  ///< chroma_width = -((-luma_width )>>log2_chroma_w)
81
82     /**
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.
88      */
89     uint8_t log2_chroma_h;
90     uint8_t flags;
91
92     /**
93      * Parameters that describe how pixels are packed. If the format
94      * has chroma components, they must be stored in comp[1] and
95      * comp[2].
96      */
97     AVComponentDescriptor comp[4];
98
99     /**
100      * Alternative comma-separated names.
101      */
102     const char *alias;
103 } AVPixFmtDescriptor;
104
105 /**
106  * Pixel format is big-endian.
107  */
108 #define AV_PIX_FMT_FLAG_BE           (1 << 0)
109 /**
110  * Pixel format has a palette in data[1], values are indexes in this palette.
111  */
112 #define AV_PIX_FMT_FLAG_PAL          (1 << 1)
113 /**
114  * All values of a component are bit-wise packed end to end.
115  */
116 #define AV_PIX_FMT_FLAG_BITSTREAM    (1 << 2)
117 /**
118  * Pixel format is an HW accelerated format.
119  */
120 #define AV_PIX_FMT_FLAG_HWACCEL      (1 << 3)
121 /**
122  * At least one pixel component is not in the first data plane.
123  */
124 #define AV_PIX_FMT_FLAG_PLANAR       (1 << 4)
125 /**
126  * The pixel format contains RGB-like data (as opposed to YUV/grayscale).
127  */
128 #define AV_PIX_FMT_FLAG_RGB          (1 << 5)
129 /**
130  * The pixel format is "pseudo-paletted". This means that Libav treats it as
131  * paletted internally, but the palette is generated by the decoder and is not
132  * stored in the file.
133  */
134 #define AV_PIX_FMT_FLAG_PSEUDOPAL    (1 << 6)
135 /**
136  * The pixel format has an alpha channel.
137  */
138 #define AV_PIX_FMT_FLAG_ALPHA        (1 << 7)
139
140 #if FF_API_PIX_FMT
141 /**
142  * @deprecated use the AV_PIX_FMT_FLAG_* flags
143  */
144 #define PIX_FMT_BE        AV_PIX_FMT_FLAG_BE
145 #define PIX_FMT_PAL       AV_PIX_FMT_FLAG_PAL
146 #define PIX_FMT_BITSTREAM AV_PIX_FMT_FLAG_BITSTREAM
147 #define PIX_FMT_HWACCEL   AV_PIX_FMT_FLAG_HWACCEL
148 #define PIX_FMT_PLANAR    AV_PIX_FMT_FLAG_PLANAR
149 #define PIX_FMT_RGB       AV_PIX_FMT_FLAG_RGB
150 #define PIX_FMT_PSEUDOPAL AV_PIX_FMT_FLAG_PSEUDOPAL
151 #define PIX_FMT_ALPHA     AV_PIX_FMT_FLAG_ALPHA
152 #endif
153
154 #if FF_API_PIX_FMT_DESC
155 /**
156  * The array of all the pixel format descriptors.
157  */
158 extern attribute_deprecated const AVPixFmtDescriptor av_pix_fmt_descriptors[];
159 #endif
160
161 /**
162  * Read a line from an image, and write the values of the
163  * pixel format component c to dst.
164  *
165  * @param data the array containing the pointers to the planes of the image
166  * @param linesize the array containing the linesizes of the image
167  * @param desc the pixel format descriptor for the image
168  * @param x the horizontal coordinate of the first pixel to read
169  * @param y the vertical coordinate of the first pixel to read
170  * @param w the width of the line to read, that is the number of
171  * values to write to dst
172  * @param read_pal_component if not zero and the format is a paletted
173  * format writes the values corresponding to the palette
174  * component c in data[1] to dst, rather than the palette indexes in
175  * data[0]. The behavior is undefined if the format is not paletted.
176  */
177 void av_read_image_line(uint16_t *dst, const uint8_t *data[4],
178                         const int linesize[4], const AVPixFmtDescriptor *desc,
179                         int x, int y, int c, int w, int read_pal_component);
180
181 /**
182  * Write the values from src to the pixel format component c of an
183  * image line.
184  *
185  * @param src array containing the values to write
186  * @param data the array containing the pointers to the planes of the
187  * image to write into. It is supposed to be zeroed.
188  * @param linesize the array containing the linesizes of the image
189  * @param desc the pixel format descriptor for the image
190  * @param x the horizontal coordinate of the first pixel to write
191  * @param y the vertical coordinate of the first pixel to write
192  * @param w the width of the line to write, that is the number of
193  * values to write to the image line
194  */
195 void av_write_image_line(const uint16_t *src, uint8_t *data[4],
196                          const int linesize[4], const AVPixFmtDescriptor *desc,
197                          int x, int y, int c, int w);
198
199 /**
200  * Return the pixel format corresponding to name.
201  *
202  * If there is no pixel format with name name, then looks for a
203  * pixel format with the name corresponding to the native endian
204  * format of name.
205  * For example in a little-endian system, first looks for "gray16",
206  * then for "gray16le".
207  *
208  * Finally if no pixel format has been found, returns PIX_FMT_NONE.
209  */
210 enum AVPixelFormat av_get_pix_fmt(const char *name);
211
212 /**
213  * Return the short name for a pixel format, NULL in case pix_fmt is
214  * unknown.
215  *
216  * @see av_get_pix_fmt(), av_get_pix_fmt_string()
217  */
218 const char *av_get_pix_fmt_name(enum AVPixelFormat pix_fmt);
219
220 /**
221  * Print in buf the string corresponding to the pixel format with
222  * number pix_fmt, or an header if pix_fmt is negative.
223  *
224  * @param buf the buffer where to write the string
225  * @param buf_size the size of buf
226  * @param pix_fmt the number of the pixel format to print the
227  * corresponding info string, or a negative value to print the
228  * corresponding header.
229  */
230 char *av_get_pix_fmt_string(char *buf, int buf_size,
231                             enum AVPixelFormat pix_fmt);
232
233 /**
234  * Return the number of bits per pixel used by the pixel format
235  * described by pixdesc. Note that this is not the same as the number
236  * of bits per sample.
237  *
238  * The returned number of bits refers to the number of bits actually
239  * used for storing the pixel information, that is padding bits are
240  * not counted.
241  */
242 int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc);
243
244 /**
245  * @return a pixel format descriptor for provided pixel format or NULL if
246  * this pixel format is unknown.
247  */
248 const AVPixFmtDescriptor *av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt);
249
250 /**
251  * Iterate over all pixel format descriptors known to libavutil.
252  *
253  * @param prev previous descriptor. NULL to get the first descriptor.
254  *
255  * @return next descriptor or NULL after the last descriptor
256  */
257 const AVPixFmtDescriptor *av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev);
258
259 /**
260  * @return an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc
261  * is not a valid pointer to a pixel format descriptor.
262  */
263 enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
264
265 /**
266  * Utility function to access log2_chroma_w log2_chroma_h from
267  * the pixel format AVPixFmtDescriptor.
268  *
269  * @param[in]  pix_fmt the pixel format
270  * @param[out] h_shift store log2_chroma_h
271  * @param[out] v_shift store log2_chroma_w
272  *
273  * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format
274  */
275 int av_pix_fmt_get_chroma_sub_sample(enum AVPixelFormat pix_fmt,
276                                      int *h_shift, int *v_shift);
277
278 /**
279  * @return number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a
280  * valid pixel format.
281  */
282 int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt);
283
284 /**
285  * Utility function to swap the endianness of a pixel format.
286  *
287  * @param[in]  pix_fmt the pixel format
288  *
289  * @return pixel format with swapped endianness if it exists,
290  * otherwise AV_PIX_FMT_NONE
291  */
292 enum AVPixelFormat av_pix_fmt_swap_endianness(enum AVPixelFormat pix_fmt);
293
294 /**
295  * @return the name for provided color range or NULL if unknown.
296  */
297 const char *av_color_range_name(enum AVColorRange range);
298
299 /**
300  * @return the name for provided color primaries or NULL if unknown.
301  */
302 const char *av_color_primaries_name(enum AVColorPrimaries primaries);
303
304 /**
305  * @return the name for provided color transfer or NULL if unknown.
306  */
307 const char *av_color_transfer_name(enum AVColorTransferCharacteristic transfer);
308
309 /**
310  * @return the name for provided color space or NULL if unknown.
311  */
312 const char *av_color_space_name(enum AVColorSpace space);
313
314 /**
315  * @return the name for provided chroma location or NULL if unknown.
316  */
317 const char *av_chroma_location_name(enum AVChromaLocation location);
318
319 #endif /* AVUTIL_PIXDESC_H */