6b5096e58bc6fb4db7b0aa01a6b817c57b48b872
[libav.git] / libavutil / avutil.h
1 /*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #ifndef FFMPEG_AVUTIL_H
22 #define FFMPEG_AVUTIL_H
23
24 /**
25 * @file avutil.h
26 * external API header
27 */
28
29
30 #define AV_STRINGIFY(s) AV_TOSTRING(s)
31 #define AV_TOSTRING(s) #s
32
33 #define AV_VERSION_INT(a, b, c) (a<<16 | b<<8 | c)
34 #define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c
35 #define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c)
36
37 #define LIBAVUTIL_VERSION_MAJOR 49
38 #define LIBAVUTIL_VERSION_MINOR 8
39 #define LIBAVUTIL_VERSION_MICRO 0
40
41 #define LIBAVUTIL_VERSION_INT AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \
42 LIBAVUTIL_VERSION_MINOR, \
43 LIBAVUTIL_VERSION_MICRO)
44 #define LIBAVUTIL_VERSION AV_VERSION(LIBAVUTIL_VERSION_MAJOR, \
45 LIBAVUTIL_VERSION_MINOR, \
46 LIBAVUTIL_VERSION_MICRO)
47 #define LIBAVUTIL_BUILD LIBAVUTIL_VERSION_INT
48
49 #define LIBAVUTIL_IDENT "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
50
51 /**
52 * Returns the LIBAVUTIL_VERSION_INT constant.
53 */
54 unsigned avutil_version(void);
55
56 #include "common.h"
57 #include "mathematics.h"
58 #include "rational.h"
59 #include "intfloat_readwrite.h"
60 #include "log.h"
61
62 /**
63 * Pixel format. Notes:
64 *
65 * PIX_FMT_RGB32 is handled in an endian-specific manner. A RGBA
66 * color is put together as:
67 * (A << 24) | (R << 16) | (G << 8) | B
68 * This is stored as BGRA on little endian CPU architectures and ARGB on
69 * big endian CPUs.
70 *
71 * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
72 * image data is stored in AVFrame.data[0]. The palette is transported in
73 * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
74 * formatted the same as in PIX_FMT_RGB32 described above (i.e., it is
75 * also endian-specific). Note also that the individual RGB palette
76 * components stored in AVFrame.data[1] should be in the range 0..255.
77 * This is important as many custom PAL8 video codecs that were designed
78 * to run on the IBM VGA graphics adapter use 6-bit palette components.
79 */
80 enum PixelFormat {
81 PIX_FMT_NONE= -1,
82 PIX_FMT_YUV420P, ///< Planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
83 PIX_FMT_YUYV422, ///< Packed YUV 4:2:2, 16bpp, Y0 Cb Y1 Cr
84 PIX_FMT_RGB24, ///< Packed RGB 8:8:8, 24bpp, RGBRGB...
85 PIX_FMT_BGR24, ///< Packed RGB 8:8:8, 24bpp, BGRBGR...
86 PIX_FMT_YUV422P, ///< Planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
87 PIX_FMT_YUV444P, ///< Planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
88 PIX_FMT_RGB32, ///< Packed RGB 8:8:8, 32bpp, (msb)8A 8R 8G 8B(lsb), in cpu endianness
89 PIX_FMT_YUV410P, ///< Planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
90 PIX_FMT_YUV411P, ///< Planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
91 PIX_FMT_RGB565, ///< Packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), in cpu endianness
92 PIX_FMT_RGB555, ///< Packed RGB 5:5:5, 16bpp, (msb)1A 5R 5G 5B(lsb), in cpu endianness most significant bit to 0
93 PIX_FMT_GRAY8, ///< Y , 8bpp
94 PIX_FMT_MONOWHITE, ///< Y , 1bpp, 0 is white, 1 is black
95 PIX_FMT_MONOBLACK, ///< Y , 1bpp, 0 is black, 1 is white
96 PIX_FMT_PAL8, ///< 8 bit with PIX_FMT_RGB32 palette
97 PIX_FMT_YUVJ420P, ///< Planar YUV 4:2:0, 12bpp, full scale (jpeg)
98 PIX_FMT_YUVJ422P, ///< Planar YUV 4:2:2, 16bpp, full scale (jpeg)
99 PIX_FMT_YUVJ444P, ///< Planar YUV 4:4:4, 24bpp, full scale (jpeg)
100 PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
101 PIX_FMT_XVMC_MPEG2_IDCT,
102 PIX_FMT_UYVY422, ///< Packed YUV 4:2:2, 16bpp, Cb Y0 Cr Y1
103 PIX_FMT_UYYVYY411, ///< Packed YUV 4:1:1, 12bpp, Cb Y0 Y1 Cr Y2 Y3
104 PIX_FMT_BGR32, ///< Packed RGB 8:8:8, 32bpp, (msb)8A 8B 8G 8R(lsb), in cpu endianness
105 PIX_FMT_BGR565, ///< Packed RGB 5:6:5, 16bpp, (msb) 5B 6G 5R(lsb), in cpu endianness
106 PIX_FMT_BGR555, ///< Packed RGB 5:5:5, 16bpp, (msb)1A 5B 5G 5R(lsb), in cpu endianness most significant bit to 1
107 PIX_FMT_BGR8, ///< Packed RGB 3:3:2, 8bpp, (msb)2B 3G 3R(lsb)
108 PIX_FMT_BGR4, ///< Packed RGB 1:2:1, 4bpp, (msb)1B 2G 1R(lsb)
109 PIX_FMT_BGR4_BYTE, ///< Packed RGB 1:2:1, 8bpp, (msb)1B 2G 1R(lsb)
110 PIX_FMT_RGB8, ///< Packed RGB 3:3:2, 8bpp, (msb)2R 3G 3B(lsb)
111 PIX_FMT_RGB4, ///< Packed RGB 1:2:1, 4bpp, (msb)2R 3G 3B(lsb)
112 PIX_FMT_RGB4_BYTE, ///< Packed RGB 1:2:1, 8bpp, (msb)2R 3G 3B(lsb)
113 PIX_FMT_NV12, ///< Planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 for UV
114 PIX_FMT_NV21, ///< as above, but U and V bytes are swapped
115
116 PIX_FMT_RGB32_1, ///< Packed RGB 8:8:8, 32bpp, (msb)8R 8G 8B 8A(lsb), in cpu endianness
117 PIX_FMT_BGR32_1, ///< Packed RGB 8:8:8, 32bpp, (msb)8B 8G 8R 8A(lsb), in cpu endianness
118
119 PIX_FMT_GRAY16BE, ///< Y , 16bpp, big-endian
120 PIX_FMT_GRAY16LE, ///< Y , 16bpp, little-endian
121 PIX_FMT_YUV440P, ///< Planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
122 PIX_FMT_YUVJ440P, ///< Planar YUV 4:4:0 full scale (jpeg)
123 PIX_FMT_YUVA420P, ///< Planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
124 PIX_FMT_NB, ///< number of pixel formats, DO NOT USE THIS if you want to link with shared libav* because the number of formats might differ between versions
125 };
126
127 #ifdef WORDS_BIGENDIAN
128 #define PIX_FMT_RGBA PIX_FMT_RGB32_1
129 #define PIX_FMT_BGRA PIX_FMT_BGR32_1
130 #define PIX_FMT_ARGB PIX_FMT_RGB32
131 #define PIX_FMT_ABGR PIX_FMT_BGR32
132 #define PIX_FMT_GRAY16 PIX_FMT_GRAY16BE
133 #else
134 #define PIX_FMT_RGBA PIX_FMT_BGR32
135 #define PIX_FMT_BGRA PIX_FMT_RGB32
136 #define PIX_FMT_ARGB PIX_FMT_BGR32_1
137 #define PIX_FMT_ABGR PIX_FMT_RGB32_1
138 #define PIX_FMT_GRAY16 PIX_FMT_GRAY16LE
139 #endif
140
141 #if LIBAVUTIL_VERSION_INT < (50<<16)
142 #define PIX_FMT_UYVY411 PIX_FMT_UYYVYY411
143 #define PIX_FMT_RGBA32 PIX_FMT_RGB32
144 #define PIX_FMT_YUV422 PIX_FMT_YUYV422
145 #endif
146
147 #endif /* FFMPEG_AVUTIL_H */