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