git.sesse.net Git - ffmpeg/blob - libavutil/avutil.h

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