/************************************************************************** * * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas. * Copyright (c) 2008 VMware, Inc. * All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sub license, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice (including the * next paragraph) shall be included in all copies or substantial portions * of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * **************************************************************************/ #ifndef PIPE_FORMAT_H #define PIPE_FORMAT_H #include "p_compiler.h" /* FIXME: remove these header dependencies */ #include "util/u_debug.h" #include "util/u_string.h" #ifdef __cplusplus extern "C" { #endif /** * Texture/surface image formats (preliminary) */ /* KW: Added lots of surface formats to support vertex element layout * definitions, and eventually render-to-vertex-buffer. */ enum pipe_format { PIPE_FORMAT_NONE = 0, PIPE_FORMAT_A8R8G8B8_UNORM = 1, PIPE_FORMAT_X8R8G8B8_UNORM = 2, PIPE_FORMAT_B8G8R8A8_UNORM = 3, PIPE_FORMAT_B8G8R8X8_UNORM = 4, PIPE_FORMAT_A1R5G5B5_UNORM = 5, PIPE_FORMAT_A4R4G4B4_UNORM = 6, PIPE_FORMAT_R5G6B5_UNORM = 7, PIPE_FORMAT_A2B10G10R10_UNORM = 8, PIPE_FORMAT_L8_UNORM = 9, /**< ubyte luminance */ PIPE_FORMAT_A8_UNORM = 10, /**< ubyte alpha */ PIPE_FORMAT_I8_UNORM = 11, /**< ubyte intensity */ PIPE_FORMAT_A8L8_UNORM = 12, /**< ubyte alpha, luminance */ PIPE_FORMAT_L16_UNORM = 13, /**< ushort luminance */ PIPE_FORMAT_YCBCR = 14, PIPE_FORMAT_YCBCR_REV = 15, PIPE_FORMAT_Z16_UNORM = 16, PIPE_FORMAT_Z32_UNORM = 17, PIPE_FORMAT_Z32_FLOAT = 18, PIPE_FORMAT_S8Z24_UNORM = 19, PIPE_FORMAT_Z24S8_UNORM = 20, PIPE_FORMAT_X8Z24_UNORM = 21, PIPE_FORMAT_Z24X8_UNORM = 22, PIPE_FORMAT_S8_UNORM = 23, /**< ubyte stencil */ PIPE_FORMAT_R64_FLOAT = 24, PIPE_FORMAT_R64G64_FLOAT = 25, PIPE_FORMAT_R64G64B64_FLOAT = 26, PIPE_FORMAT_R64G64B64A64_FLOAT = 27, PIPE_FORMAT_R32_FLOAT = 28, PIPE_FORMAT_R32G32_FLOAT = 29, PIPE_FORMAT_R32G32B32_FLOAT = 30, PIPE_FORMAT_R32G32B32A32_FLOAT = 31, PIPE_FORMAT_R32_UNORM = 32, PIPE_FORMAT_R32G32_UNORM = 33, PIPE_FORMAT_R32G32B32_UNORM = 34, PIPE_FORMAT_R32G32B32A32_UNORM = 35, PIPE_FORMAT_R32_USCALED = 36, PIPE_FORMAT_R32G32_USCALED = 37, PIPE_FORMAT_R32G32B32_USCALED = 38, PIPE_FORMAT_R32G32B32A32_USCALED = 39, PIPE_FORMAT_R32_SNORM = 40, PIPE_FORMAT_R32G32_SNORM = 41, PIPE_FORMAT_R32G32B32_SNORM = 42, PIPE_FORMAT_R32G32B32A32_SNORM = 43, PIPE_FORMAT_R32_SSCALED = 44, PIPE_FORMAT_R32G32_SSCALED = 45, PIPE_FORMAT_R32G32B32_SSCALED = 46, PIPE_FORMAT_R32G32B32A32_SSCALED = 47, PIPE_FORMAT_R16_UNORM = 48, PIPE_FORMAT_R16G16_UNORM = 49, PIPE_FORMAT_R16G16B16_UNORM = 50, PIPE_FORMAT_R16G16B16A16_UNORM = 51, PIPE_FORMAT_R16_USCALED = 52, PIPE_FORMAT_R16G16_USCALED = 53, PIPE_FORMAT_R16G16B16_USCALED = 54, PIPE_FORMAT_R16G16B16A16_USCALED = 55, PIPE_FORMAT_R16_SNORM = 56, PIPE_FORMAT_R16G16_SNORM = 57, PIPE_FORMAT_R16G16B16_SNORM = 58, PIPE_FORMAT_R16G16B16A16_SNORM = 59, PIPE_FORMAT_R16_SSCALED = 60, PIPE_FORMAT_R16G16_SSCALED = 61, PIPE_FORMAT_R16G16B16_SSCALED = 62, PIPE_FORMAT_R16G16B16A16_SSCALED = 63, PIPE_FORMAT_R8_UNORM = 64, PIPE_FORMAT_R8G8_UNORM = 65, PIPE_FORMAT_R8G8B8_UNORM = 66, PIPE_FORMAT_R8G8B8A8_UNORM = 67, PIPE_FORMAT_R8G8B8X8_UNORM = 68, PIPE_FORMAT_R8_USCALED = 69, PIPE_FORMAT_R8G8_USCALED = 70, PIPE_FORMAT_R8G8B8_USCALED = 71, PIPE_FORMAT_R8G8B8A8_USCALED = 72, PIPE_FORMAT_R8G8B8X8_USCALED = 73, PIPE_FORMAT_R8_SNORM = 74, PIPE_FORMAT_R8G8_SNORM = 75, PIPE_FORMAT_R8G8B8_SNORM = 76, PIPE_FORMAT_R8G8B8A8_SNORM = 77, PIPE_FORMAT_R8G8B8X8_SNORM = 78, PIPE_FORMAT_B6G5R5_SNORM = 79, PIPE_FORMAT_A8B8G8R8_SNORM = 80, PIPE_FORMAT_X8B8G8R8_SNORM = 81, PIPE_FORMAT_R8_SSCALED = 82, PIPE_FORMAT_R8G8_SSCALED = 83, PIPE_FORMAT_R8G8B8_SSCALED = 84, PIPE_FORMAT_R8G8B8A8_SSCALED = 85, PIPE_FORMAT_R8G8B8X8_SSCALED = 86, PIPE_FORMAT_R32_FIXED = 87, PIPE_FORMAT_R32G32_FIXED = 88, PIPE_FORMAT_R32G32B32_FIXED = 89, PIPE_FORMAT_R32G32B32A32_FIXED = 90, /* sRGB formats */ PIPE_FORMAT_L8_SRGB = 91, PIPE_FORMAT_A8L8_SRGB = 92, PIPE_FORMAT_R8G8B8_SRGB = 93, PIPE_FORMAT_R8G8B8A8_SRGB = 94, PIPE_FORMAT_R8G8B8X8_SRGB = 95, PIPE_FORMAT_A8R8G8B8_SRGB = 96, PIPE_FORMAT_X8R8G8B8_SRGB = 97, PIPE_FORMAT_B8G8R8A8_SRGB = 98, PIPE_FORMAT_B8G8R8X8_SRGB = 99, /* mixed formats */ PIPE_FORMAT_X8UB8UG8SR8S_NORM = 100, PIPE_FORMAT_B6UG5SR5S_NORM = 101, /* compressed formats */ PIPE_FORMAT_DXT1_RGB = 102, PIPE_FORMAT_DXT1_RGBA = 103, PIPE_FORMAT_DXT3_RGBA = 104, PIPE_FORMAT_DXT5_RGBA = 105, /* sRGB, compressed */ PIPE_FORMAT_DXT1_SRGB = 106, PIPE_FORMAT_DXT1_SRGBA = 107, PIPE_FORMAT_DXT3_SRGBA = 108, PIPE_FORMAT_DXT5_SRGBA = 109, PIPE_FORMAT_COUNT }; /** * Builds pipe format name from format token. */ extern const char *pf_name( enum pipe_format format ); /** * Return bits for a particular component. * \param comp component index, starting at 0 */ static INLINE uint pf_get_component_bits( enum pipe_format format, uint comp ) { uint size; if (pf_swizzle_x(format) == comp) { size = pf_size_x(format); } else if (pf_swizzle_y(format) == comp) { size = pf_size_y(format); } else if (pf_swizzle_z(format) == comp) { size = pf_size_z(format); } else if (pf_swizzle_w(format) == comp) { size = pf_size_w(format); } else { size = 0; } if (pf_layout( format ) == PIPE_FORMAT_LAYOUT_RGBAZS) return size << pf_exp2( format ); return size << (pf_mixed_scale8( format ) * 3); } /** * Return total bits needed for the pixel format per block. */ static INLINE uint pf_get_blocksizebits( enum pipe_format format ) { switch (pf_layout(format)) { case PIPE_FORMAT_LAYOUT_RGBAZS: case PIPE_FORMAT_LAYOUT_MIXED: return pf_get_component_bits( format, PIPE_FORMAT_COMP_0 ) + pf_get_component_bits( format, PIPE_FORMAT_COMP_1 ) + pf_get_component_bits( format, PIPE_FORMAT_COMP_R ) + pf_get_component_bits( format, PIPE_FORMAT_COMP_G ) + pf_get_component_bits( format, PIPE_FORMAT_COMP_B ) + pf_get_component_bits( format, PIPE_FORMAT_COMP_A ) + pf_get_component_bits( format, PIPE_FORMAT_COMP_Z ) + pf_get_component_bits( format, PIPE_FORMAT_COMP_S ); case PIPE_FORMAT_LAYOUT_YCBCR: assert( format == PIPE_FORMAT_YCBCR || format == PIPE_FORMAT_YCBCR_REV ); return 32; case PIPE_FORMAT_LAYOUT_DXT: switch(format) { case PIPE_FORMAT_DXT1_RGBA: case PIPE_FORMAT_DXT1_RGB: case PIPE_FORMAT_DXT1_SRGBA: case PIPE_FORMAT_DXT1_SRGB: return 64; case PIPE_FORMAT_DXT3_RGBA: case PIPE_FORMAT_DXT5_RGBA: case PIPE_FORMAT_DXT3_SRGBA: case PIPE_FORMAT_DXT5_SRGBA: return 128; default: assert( 0 ); return 0; } default: assert( 0 ); return 0; } } /** * Return bytes per element for the given format. */ static INLINE uint pf_get_blocksize( enum pipe_format format ) { assert(pf_get_blocksizebits(format) % 8 == 0); return pf_get_blocksizebits(format) / 8; } static INLINE uint pf_get_blockwidth( enum pipe_format format ) { switch (pf_layout(format)) { case PIPE_FORMAT_LAYOUT_YCBCR: return 2; case PIPE_FORMAT_LAYOUT_DXT: return 4; default: return 1; } } static INLINE uint pf_get_blockheight( enum pipe_format format ) { switch (pf_layout(format)) { case PIPE_FORMAT_LAYOUT_DXT: return 4; default: return 1; } } static INLINE unsigned pf_get_nblocksx(enum pipe_format format, unsigned x) { unsigned blockwidth = pf_get_blockwidth(format); return (x + blockwidth - 1) / blockwidth; } static INLINE unsigned pf_get_nblocksy(enum pipe_format format, unsigned y) { unsigned blockheight = pf_get_blockheight(format); return (y + blockheight - 1) / blockheight; } static INLINE unsigned pf_get_nblocks(enum pipe_format format, unsigned width, unsigned height) { return pf_get_nblocksx(format, width) * pf_get_nblocksy(format, height); } static INLINE size_t pf_get_stride(enum pipe_format format, unsigned width) { return pf_get_nblocksx(format, width) * pf_get_blocksize(format); } static INLINE size_t pf_get_2d_size(enum pipe_format format, size_t stride, unsigned height) { return pf_get_nblocksy(format, height) * stride; } enum pipe_video_chroma_format { PIPE_VIDEO_CHROMA_FORMAT_420, PIPE_VIDEO_CHROMA_FORMAT_422, PIPE_VIDEO_CHROMA_FORMAT_444 }; #if 0 enum pipe_video_surface_format { PIPE_VIDEO_SURFACE_FORMAT_NV12, /**< Planar; Y plane, UV plane */ PIPE_VIDEO_SURFACE_FORMAT_YV12, /**< Planar; Y plane, U plane, V plane */ PIPE_VIDEO_SURFACE_FORMAT_YUYV, /**< Interleaved; Y,U,Y,V,Y,U,Y,V */ PIPE_VIDEO_SURFACE_FORMAT_UYVY, /**< Interleaved; U,Y,V,Y,U,Y,V,Y */ PIPE_VIDEO_SURFACE_FORMAT_VUYA /**< Packed; A31-24|Y23-16|U15-8|V7-0 */ }; #endif #ifdef __cplusplus } #endif #endif