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