document clip functions
[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
30 /**
31  * Pixel format. Notes:
32  *
33  * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
34  * color is put together as:
35  *  (A << 24) | (R << 16) | (G << 8) | B
36  * This is stored as BGRA on little endian CPU architectures and ARGB on
37  * big endian CPUs.
38  *
39  * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
40  * image data is stored in AVFrame.data[0]. The palette is transported in
41  * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
42  * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
43  * also endian-specific). Note also that the individual RGB palette
44  * components stored in AVFrame.data[1] should be in the range 0..255.
45  * This is important as many custom PAL8 video codecs that were designed
46  * to run on the IBM VGA graphics adapter use 6-bit palette components.
47  */
48 enum PixelFormat {
49     PIX_FMT_NONE= -1,
50     PIX_FMT_YUV420P,   ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
51     PIX_FMT_YUV422,    ///< Packed pixel, Y0 Cb Y1 Cr
52     PIX_FMT_RGB24,     ///< Packed pixel, 3 bytes per pixel, RGBRGB...
53     PIX_FMT_BGR24,     ///< Packed pixel, 3 bytes per pixel, BGRBGR...
54     PIX_FMT_YUV422P,   ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
55     PIX_FMT_YUV444P,   ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
56     PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
57     PIX_FMT_YUV410P,   ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
58     PIX_FMT_YUV411P,   ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
59     PIX_FMT_RGB565,    ///< always stored in cpu endianness
60     PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1
61     PIX_FMT_GRAY8,
62     PIX_FMT_MONOWHITE, ///< 0 is white
63     PIX_FMT_MONOBLACK, ///< 0 is black
64     PIX_FMT_PAL8,      ///< 8 bit with RGBA palette
65     PIX_FMT_YUVJ420P,  ///< Planar YUV 4:2:0 full scale (jpeg)
66     PIX_FMT_YUVJ422P,  ///< Planar YUV 4:2:2 full scale (jpeg)
67     PIX_FMT_YUVJ444P,  ///< Planar YUV 4:4:4 full scale (jpeg)
68     PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
69     PIX_FMT_XVMC_MPEG2_IDCT,
70     PIX_FMT_UYVY422,   ///< Packed pixel, Cb Y0 Cr Y1
71     PIX_FMT_UYVY411,   ///< Packed pixel, Cb Y0 Y1 Cr Y2 Y3
72     PIX_FMT_NB,
73 };
74
75 #ifdef __cplusplus
76 }
77 #endif
78
79 #endif /* AVUTIL_H */