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_AVUTIL_H
  22 #define AVUTIL_AVUTIL_H
  23
  24 /**
  25  * @file libavutil/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 15
  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. An 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], 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  * For all the 8bit per pixel formats, an RGB32 palette is in data[1] like
  81  * for pal8. This palette is filled in automatically by the function
  82  * allocating the picture.
  83  *
  84  * Note, make sure that all newly added big endian formats have pix_fmt&1==1
  85  *       and that all newly added little endian formats have pix_fmt&1==0
  86  *       this allows simpler detection of big vs little endian.
  87  */
  88 enum PixelFormat {
  89     PIX_FMT_NONE= -1,
  90     PIX_FMT_YUV420P,   ///< planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
  91     PIX_FMT_YUYV422,   ///< packed YUV 4:2:2, 16bpp, Y0 Cb Y1 Cr
  92     PIX_FMT_RGB24,     ///< packed RGB 8:8:8, 24bpp, RGBRGB...
  93     PIX_FMT_BGR24,     ///< packed RGB 8:8:8, 24bpp, BGRBGR...
  94     PIX_FMT_YUV422P,   ///< planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
  95     PIX_FMT_YUV444P,   ///< planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
  96     PIX_FMT_RGB32,     ///< packed RGB 8:8:8, 32bpp, (msb)8A 8R 8G 8B(lsb), in CPU endianness
  97     PIX_FMT_YUV410P,   ///< planar YUV 4:1:0,  9bpp, (1 Cr & Cb sample per 4x4 Y samples)
  98     PIX_FMT_YUV411P,   ///< planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
  99     PIX_FMT_RGB565,    ///< packed RGB 5:6:5, 16bpp, (msb)   5R 6G 5B(lsb), in CPU endianness
 100     PIX_FMT_RGB555,    ///< packed RGB 5:5:5, 16bpp, (msb)1A 5R 5G 5B(lsb), in CPU endianness, most significant bit to 0
 101     PIX_FMT_GRAY8,     ///<        Y        ,  8bpp
 102     PIX_FMT_MONOWHITE, ///<        Y        ,  1bpp, 0 is white, 1 is black
 103     PIX_FMT_MONOBLACK, ///<        Y        ,  1bpp, 0 is black, 1 is white
 104     PIX_FMT_PAL8,      ///< 8 bit with PIX_FMT_RGB32 palette
 105     PIX_FMT_YUVJ420P,  ///< planar YUV 4:2:0, 12bpp, full scale (JPEG)
 106     PIX_FMT_YUVJ422P,  ///< planar YUV 4:2:2, 16bpp, full scale (JPEG)
 107     PIX_FMT_YUVJ444P,  ///< planar YUV 4:4:4, 24bpp, full scale (JPEG)
 108     PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing
 109     PIX_FMT_XVMC_MPEG2_IDCT,
 110     PIX_FMT_UYVY422,   ///< packed YUV 4:2:2, 16bpp, Cb Y0 Cr Y1
 111     PIX_FMT_UYYVYY411, ///< packed YUV 4:1:1, 12bpp, Cb Y0 Y1 Cr Y2 Y3
 112     PIX_FMT_BGR32,     ///< packed RGB 8:8:8, 32bpp, (msb)8A 8B 8G 8R(lsb), in CPU endianness
 113     PIX_FMT_BGR565,    ///< packed RGB 5:6:5, 16bpp, (msb)   5B 6G 5R(lsb), in CPU endianness
 114     PIX_FMT_BGR555,    ///< packed RGB 5:5:5, 16bpp, (msb)1A 5B 5G 5R(lsb), in CPU endianness, most significant bit to 1
 115     PIX_FMT_BGR8,      ///< packed RGB 3:3:2,  8bpp, (msb)2B 3G 3R(lsb)
 116     PIX_FMT_BGR4,      ///< packed RGB 1:2:1,  4bpp, (msb)1B 2G 1R(lsb)
 117     PIX_FMT_BGR4_BYTE, ///< packed RGB 1:2:1,  8bpp, (msb)1B 2G 1R(lsb)
 118     PIX_FMT_RGB8,      ///< packed RGB 3:3:2,  8bpp, (msb)2R 3G 3B(lsb)
 119     PIX_FMT_RGB4,      ///< packed RGB 1:2:1,  4bpp, (msb)1R 2G 1B(lsb)
 120     PIX_FMT_RGB4_BYTE, ///< packed RGB 1:2:1,  8bpp, (msb)1R 2G 1B(lsb)
 121     PIX_FMT_NV12,      ///< planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 for UV
 122     PIX_FMT_NV21,      ///< as above, but U and V bytes are swapped
 123
 124     PIX_FMT_RGB32_1,   ///< packed RGB 8:8:8, 32bpp, (msb)8R 8G 8B 8A(lsb), in CPU endianness
 125     PIX_FMT_BGR32_1,   ///< packed RGB 8:8:8, 32bpp, (msb)8B 8G 8R 8A(lsb), in CPU endianness
 126
 127     PIX_FMT_GRAY16BE,  ///<        Y        , 16bpp, big-endian
 128     PIX_FMT_GRAY16LE,  ///<        Y        , 16bpp, little-endian
 129     PIX_FMT_YUV440P,   ///< planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
 130     PIX_FMT_YUVJ440P,  ///< planar YUV 4:4:0 full scale (JPEG)
 131     PIX_FMT_YUVA420P,  ///< planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
 132     PIX_FMT_VDPAU_H264,///< H.264 HW decoding with VDPAU, data[0] contains a vdpau_render_state struct which contains the bitstream of the slices as well as various fields extracted from headers
 133     PIX_FMT_VDPAU_MPEG1,///< MPEG-1 HW decoding with VDPAU, data[0] contains a vdpau_render_state struct which contains the bitstream of the slices as well as various fields extracted from headers
 134     PIX_FMT_VDPAU_MPEG2,///< MPEG-2 HW decoding with VDPAU, data[0] contains a vdpau_render_state struct which contains the bitstream of the slices as well as various fields extracted from headers
 135     PIX_FMT_VDPAU_WMV3,///< WMV3 HW decoding with VDPAU, data[0] contains a vdpau_render_state struct which contains the bitstream of the slices as well as various fields extracted from headers
 136     PIX_FMT_VDPAU_VC1, ///< VC-1 HW decoding with VDPAU, data[0] contains a vdpau_render_state struct which contains the bitstream of the slices as well as various fields extracted from headers
 137     PIX_FMT_RGB48BE,   ///< packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, big-endian
 138     PIX_FMT_RGB48LE,   ///< packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, little-endian
 139     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
 140 };
 141
 142 #ifdef WORDS_BIGENDIAN
 143 #define PIX_FMT_RGBA PIX_FMT_RGB32_1
 144 #define PIX_FMT_BGRA PIX_FMT_BGR32_1
 145 #define PIX_FMT_ARGB PIX_FMT_RGB32
 146 #define PIX_FMT_ABGR PIX_FMT_BGR32
 147 #define PIX_FMT_GRAY16 PIX_FMT_GRAY16BE
 148 #define PIX_FMT_RGB48 PIX_FMT_RGB48BE
 149 #else
 150 #define PIX_FMT_RGBA PIX_FMT_BGR32
 151 #define PIX_FMT_BGRA PIX_FMT_RGB32
 152 #define PIX_FMT_ARGB PIX_FMT_BGR32_1
 153 #define PIX_FMT_ABGR PIX_FMT_RGB32_1
 154 #define PIX_FMT_GRAY16 PIX_FMT_GRAY16LE
 155 #define PIX_FMT_RGB48 PIX_FMT_RGB48LE
 156 #endif
 157
 158 #if LIBAVUTIL_VERSION_INT < (50<<16)
 159 #define PIX_FMT_UYVY411 PIX_FMT_UYYVYY411
 160 #define PIX_FMT_RGBA32  PIX_FMT_RGB32
 161 #define PIX_FMT_YUV422  PIX_FMT_YUYV422
 162 #endif
 163
 164 #endif /* AVUTIL_AVUTIL_H */