libavutil/pixfmt.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_PIXFMT_H
  22 #define AVUTIL_PIXFMT_H
  23
  24 /**
  25  * @file libavutil/pixfmt.h
  26  * pixel format definitions
  27  *
  28  * @warning This file has to be considered an internal but installed
  29  * header, so it should not be directly included in your projects.
  30  */
  31
  32 /**
  33  * Pixel format. Notes:
  34  *
  35  * PIX_FMT_RGB32 is handled in an endian-specific manner. An RGBA
  36  * color is put together as:
  37  *  (A << 24) | (R << 16) | (G << 8) | B
  38  * This is stored as BGRA on little-endian CPU architectures and ARGB on
  39  * big-endian CPUs.
  40  *
  41  * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
  42  * image data is stored in AVFrame.data[0]. The palette is transported in
  43  * AVFrame.data[1], is 1024 bytes long (256 4-byte entries) and is
  44  * formatted the same as in PIX_FMT_RGB32 described above (i.e., it is
  45  * also endian-specific). Note also that the individual RGB palette
  46  * components stored in AVFrame.data[1] should be in the range 0..255.
  47  * This is important as many custom PAL8 video codecs that were designed
  48  * to run on the IBM VGA graphics adapter use 6-bit palette components.
  49  *
  50  * For all the 8bit per pixel formats, an RGB32 palette is in data[1] like
  51  * for pal8. This palette is filled in automatically by the function
  52  * allocating the picture.
  53  *
  54  * Note, make sure that all newly added big endian formats have pix_fmt&1==1
  55  *       and that all newly added little endian formats have pix_fmt&1==0
  56  *       this allows simpler detection of big vs little endian.
  57  */
  58 enum PixelFormat {
  59     PIX_FMT_NONE= -1,
  60     PIX_FMT_YUV420P,   ///< planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
  61     PIX_FMT_YUYV422,   ///< packed YUV 4:2:2, 16bpp, Y0 Cb Y1 Cr
  62     PIX_FMT_RGB24,     ///< packed RGB 8:8:8, 24bpp, RGBRGB...
  63     PIX_FMT_BGR24,     ///< packed RGB 8:8:8, 24bpp, BGRBGR...
  64     PIX_FMT_YUV422P,   ///< planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
  65     PIX_FMT_YUV444P,   ///< planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
  66     PIX_FMT_RGB32,     ///< packed RGB 8:8:8, 32bpp, (msb)8A 8R 8G 8B(lsb), in CPU endianness
  67     PIX_FMT_YUV410P,   ///< planar YUV 4:1:0,  9bpp, (1 Cr & Cb sample per 4x4 Y samples)
  68     PIX_FMT_YUV411P,   ///< planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
  69     PIX_FMT_GRAY8,     ///<        Y        ,  8bpp
  70     PIX_FMT_MONOWHITE, ///<        Y        ,  1bpp, 0 is white, 1 is black
  71     PIX_FMT_MONOBLACK, ///<        Y        ,  1bpp, 0 is black, 1 is white
  72     PIX_FMT_PAL8,      ///< 8 bit with PIX_FMT_RGB32 palette
  73     PIX_FMT_YUVJ420P,  ///< planar YUV 4:2:0, 12bpp, full scale (JPEG)
  74     PIX_FMT_YUVJ422P,  ///< planar YUV 4:2:2, 16bpp, full scale (JPEG)
  75     PIX_FMT_YUVJ444P,  ///< planar YUV 4:4:4, 24bpp, full scale (JPEG)
  76     PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing
  77     PIX_FMT_XVMC_MPEG2_IDCT,
  78     PIX_FMT_UYVY422,   ///< packed YUV 4:2:2, 16bpp, Cb Y0 Cr Y1
  79     PIX_FMT_UYYVYY411, ///< packed YUV 4:1:1, 12bpp, Cb Y0 Y1 Cr Y2 Y3
  80     PIX_FMT_BGR32,     ///< packed RGB 8:8:8, 32bpp, (msb)8A 8B 8G 8R(lsb), in CPU endianness
  81     PIX_FMT_BGR8,      ///< packed RGB 3:3:2,  8bpp, (msb)2B 3G 3R(lsb)
  82     PIX_FMT_BGR4,      ///< packed RGB 1:2:1,  4bpp, (msb)1B 2G 1R(lsb)
  83     PIX_FMT_BGR4_BYTE, ///< packed RGB 1:2:1,  8bpp, (msb)1B 2G 1R(lsb)
  84     PIX_FMT_RGB8,      ///< packed RGB 3:3:2,  8bpp, (msb)2R 3G 3B(lsb)
  85     PIX_FMT_RGB4,      ///< packed RGB 1:2:1,  4bpp, (msb)1R 2G 1B(lsb)
  86     PIX_FMT_RGB4_BYTE, ///< packed RGB 1:2:1,  8bpp, (msb)1R 2G 1B(lsb)
  87     PIX_FMT_NV12,      ///< planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 for UV
  88     PIX_FMT_NV21,      ///< as above, but U and V bytes are swapped
  89
  90     PIX_FMT_RGB32_1,   ///< packed RGB 8:8:8, 32bpp, (msb)8R 8G 8B 8A(lsb), in CPU endianness
  91     PIX_FMT_BGR32_1,   ///< packed RGB 8:8:8, 32bpp, (msb)8B 8G 8R 8A(lsb), in CPU endianness
  92
  93     PIX_FMT_GRAY16BE,  ///<        Y        , 16bpp, big-endian
  94     PIX_FMT_GRAY16LE,  ///<        Y        , 16bpp, little-endian
  95     PIX_FMT_YUV440P,   ///< planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
  96     PIX_FMT_YUVJ440P,  ///< planar YUV 4:4:0 full scale (JPEG)
  97     PIX_FMT_YUVA420P,  ///< planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
  98     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
  99     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
 100     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
 101     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
 102     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
 103     PIX_FMT_RGB48BE,   ///< packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, big-endian
 104     PIX_FMT_RGB48LE,   ///< packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, little-endian
 105
 106     PIX_FMT_RGB565BE,  ///< packed RGB 5:6:5, 16bpp, (msb)   5R 6G 5B(lsb), big-endian
 107     PIX_FMT_RGB565LE,  ///< packed RGB 5:6:5, 16bpp, (msb)   5R 6G 5B(lsb), little-endian
 108     PIX_FMT_RGB555BE,  ///< packed RGB 5:5:5, 16bpp, (msb)1A 5R 5G 5B(lsb), big-endian, most significant bit to 0
 109     PIX_FMT_RGB555LE,  ///< packed RGB 5:5:5, 16bpp, (msb)1A 5R 5G 5B(lsb), little-endian, most significant bit to 0
 110
 111     PIX_FMT_BGR565BE,  ///< packed BGR 5:6:5, 16bpp, (msb)   5B 6G 5R(lsb), big-endian
 112     PIX_FMT_BGR565LE,  ///< packed BGR 5:6:5, 16bpp, (msb)   5B 6G 5R(lsb), little-endian
 113     PIX_FMT_BGR555BE,  ///< packed BGR 5:5:5, 16bpp, (msb)1A 5B 5G 5R(lsb), big-endian, most significant bit to 1
 114     PIX_FMT_BGR555LE,  ///< packed BGR 5:5:5, 16bpp, (msb)1A 5B 5G 5R(lsb), little-endian, most significant bit to 1
 115
 116     PIX_FMT_VAAPI_MOCO, ///< HW acceleration through VA API at motion compensation entry-point, Picture.data[3] contains a vaapi_render_state struct which contains macroblocks as well as various fields extracted from headers
 117     PIX_FMT_VAAPI_IDCT, ///< HW acceleration through VA API at IDCT entry-point, Picture.data[3] contains a vaapi_render_state struct which contains fields extracted from headers
 118     PIX_FMT_VAAPI_VLD,  ///< HW decoding through VA API, Picture.data[3] contains a vaapi_render_state struct which contains the bitstream of the slices as well as various fields extracted from headers
 119     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
 120 };
 121
 122 #ifdef WORDS_BIGENDIAN
 123 #   define PIX_FMT_NE(name) PIX_FMT_##name##BE
 124 #else
 125 #   define PIX_FMT_NE(name) PIX_FMT_##name##LE
 126 #endif
 127
 128 #ifdef WORDS_BIGENDIAN
 129 #define PIX_FMT_RGBA PIX_FMT_RGB32_1
 130 #define PIX_FMT_BGRA PIX_FMT_BGR32_1
 131 #define PIX_FMT_ARGB PIX_FMT_RGB32
 132 #define PIX_FMT_ABGR PIX_FMT_BGR32
 133 #else
 134 #define PIX_FMT_RGBA PIX_FMT_BGR32
 135 #define PIX_FMT_BGRA PIX_FMT_RGB32
 136 #define PIX_FMT_ARGB PIX_FMT_BGR32_1
 137 #define PIX_FMT_ABGR PIX_FMT_RGB32_1
 138 #endif
 139
 140 #define PIX_FMT_GRAY16 PIX_FMT_NE(GRAY16)
 141 #define PIX_FMT_RGB48  PIX_FMT_NE(RGB48)
 142 #define PIX_FMT_RGB565 PIX_FMT_NE(RGB565)
 143 #define PIX_FMT_RGB555 PIX_FMT_NE(RGB555)
 144 #define PIX_FMT_BGR565 PIX_FMT_NE(BGR565)
 145 #define PIX_FMT_BGR555 PIX_FMT_NE(BGR555)
 146
 147 #endif /* AVUTIL_PIXFMT_H */