d85755cd8b1a3221dfd0ebd18d11a2c8e50e2ef6
[ffmpeg.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 AVUTIL_H
22 #define AVUTIL_H
23
24 /**
25  * @file avutil.h
26  * external api header.
27  */
28
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
35 #define AV_TOSTRING(s) #s
36
37 #define LIBAVUTIL_VERSION_INT   ((49<<16)+(3<<8)+0)
38 #define LIBAVUTIL_VERSION       49.3.0
39 #define LIBAVUTIL_BUILD         LIBAVUTIL_VERSION_INT
40
41 #define LIBAVUTIL_IDENT         "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
42
43
44 #include "common.h"
45 #include "mathematics.h"
46 #include "rational.h"
47 #include "integer.h"
48 #include "intfloat_readwrite.h"
49 #include "log.h"
50
51 /**
52  * Pixel format. Notes:
53  *
54  * PIX_FMT_RGB32 is handled in an endian-specific manner. A RGBA
55  * color is put together as:
56  *  (A << 24) | (R << 16) | (G << 8) | B
57  * This is stored as BGRA on little endian CPU architectures and ARGB on
58  * big endian CPUs.
59  *
60  * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
61  * image data is stored in AVFrame.data[0]. The palette is transported in
62  * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
63  * formatted the same as in PIX_FMT_RGB32 described above (i.e., it is
64  * also endian-specific). Note also that the individual RGB palette
65  * components stored in AVFrame.data[1] should be in the range 0..255.
66  * This is important as many custom PAL8 video codecs that were designed
67  * to run on the IBM VGA graphics adapter use 6-bit palette components.
68  */
69 enum PixelFormat {
70     PIX_FMT_NONE= -1,
71     PIX_FMT_YUV420P,   ///< Planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
72     PIX_FMT_YUYV422,   ///< Packed YUV 4:2:2, 16bpp, Y0 Cb Y1 Cr
73     PIX_FMT_RGB24,     ///< Packed RGB 8:8:8, 24bpp, RGBRGB...
74     PIX_FMT_BGR24,     ///< Packed RGB 8:8:8, 24bpp, BGRBGR...
75     PIX_FMT_YUV422P,   ///< Planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
76     PIX_FMT_YUV444P,   ///< Planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
77     PIX_FMT_RGB32,     ///< Packed RGB 8:8:8, 32bpp, (msb)8A 8R 8G 8B(lsb), in cpu endianness
78     PIX_FMT_YUV410P,   ///< Planar YUV 4:1:0,  9bpp, (1 Cr & Cb sample per 4x4 Y samples)
79     PIX_FMT_YUV411P,   ///< Planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
80     PIX_FMT_RGB565,    ///< Packed RGB 5:6:5, 16bpp, (msb)   5R 6G 5B(lsb), in cpu endianness
81     PIX_FMT_RGB555,    ///< Packed RGB 5:5:5, 16bpp, (msb)1A 5R 5G 5B(lsb), in cpu endianness most significant bit to 0
82     PIX_FMT_GRAY8,     ///<        Y        ,  8bpp
83     PIX_FMT_MONOWHITE, ///<        Y        ,  1bpp, 1 is white
84     PIX_FMT_MONOBLACK, ///<        Y        ,  1bpp, 0 is black
85     PIX_FMT_PAL8,      ///< 8 bit with PIX_FMT_RGB32 palette
86     PIX_FMT_YUVJ420P,  ///< Planar YUV 4:2:0, 12bpp, full scale (jpeg)
87     PIX_FMT_YUVJ422P,  ///< Planar YUV 4:2:2, 16bpp, full scale (jpeg)
88     PIX_FMT_YUVJ444P,  ///< Planar YUV 4:4:4, 24bpp, full scale (jpeg)
89     PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
90     PIX_FMT_XVMC_MPEG2_IDCT,
91     PIX_FMT_UYVY422,   ///< Packed YUV 4:2:2, 16bpp, Cb Y0 Cr Y1
92     PIX_FMT_UYYVYY411, ///< Packed YUV 4:1:1, 12bpp, Cb Y0 Y1 Cr Y2 Y3
93     PIX_FMT_BGR32,     ///< Packed RGB 8:8:8, 32bpp, (msb)8A 8B 8G 8R(lsb), in cpu endianness
94     PIX_FMT_BGR565,    ///< Packed RGB 5:6:5, 16bpp, (msb)   5B 6G 5R(lsb), in cpu endianness
95     PIX_FMT_BGR555,    ///< Packed RGB 5:5:5, 16bpp, (msb)1A 5B 5G 5R(lsb), in cpu endianness most significant bit to 1
96     PIX_FMT_BGR8,      ///< Packed RGB 3:3:2,  8bpp, (msb)2B 3G 3R(lsb)
97     PIX_FMT_BGR4,      ///< Packed RGB 1:2:1,  4bpp, (msb)1B 2G 1R(lsb)
98     PIX_FMT_BGR4_BYTE, ///< Packed RGB 1:2:1,  8bpp, (msb)1B 2G 1R(lsb)
99     PIX_FMT_RGB8,      ///< Packed RGB 3:3:2,  8bpp, (msb)2R 3G 3B(lsb)
100     PIX_FMT_RGB4,      ///< Packed RGB 1:2:1,  4bpp, (msb)2R 3G 3B(lsb)
101     PIX_FMT_RGB4_BYTE, ///< Packed RGB 1:2:1,  8bpp, (msb)2R 3G 3B(lsb)
102     PIX_FMT_NV12,      ///< Planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 for UV
103     PIX_FMT_NV21,      ///< as above, but U and V bytes are swapped
104
105     PIX_FMT_RGB32_1,   ///< Packed RGB 8:8:8, 32bpp, (msb)8R 8G 8B 8A(lsb), in cpu endianness
106     PIX_FMT_BGR32_1,   ///< Packed RGB 8:8:8, 32bpp, (msb)8B 8G 8R 8A(lsb), in cpu endianness
107
108     PIX_FMT_GRAY16BE,  ///<        Y        , 16bpp, big-endian
109     PIX_FMT_GRAY16LE,  ///<        Y        , 16bpp, little-endian
110     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
111 };
112
113 #ifdef WORDS_BIGENDIAN
114 #define PIX_FMT_RGBA PIX_FMT_RGB32_1
115 #define PIX_FMT_BGRA PIX_FMT_BGR32_1
116 #define PIX_FMT_ARGB PIX_FMT_RGB32
117 #define PIX_FMT_ABGR PIX_FMT_BGR32
118 #define PIX_FMT_GRAY16 PIX_FMT_GRAY16BE
119 #else
120 #define PIX_FMT_RGBA PIX_FMT_BGR32
121 #define PIX_FMT_BGRA PIX_FMT_RGB32
122 #define PIX_FMT_ARGB PIX_FMT_BGR32_1
123 #define PIX_FMT_ABGR PIX_FMT_RGB32_1
124 #define PIX_FMT_GRAY16 PIX_FMT_GRAY16LE
125 #endif
126
127 #if LIBAVUTIL_VERSION_INT < (50<<16)
128 #define PIX_FMT_UYVY411 PIX_FMT_UYYVYY411
129 #define PIX_FMT_RGBA32  PIX_FMT_RGB32
130 #define PIX_FMT_YUV422  PIX_FMT_YUYV422
131 #endif
132
133 #ifdef __cplusplus
134 }
135 #endif
136
137 #endif /* AVUTIL_H */