1 /**************************************************************************
3 * Copyright 2009-2010 Vmware, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
33 #include "pipe/p_format.h"
34 #include "util/u_debug.h"
42 * Describe how to pack/unpack pixels into/from the prescribed format.
44 * XXX: This could be renamed to something like util_format_pack, or broke down
45 * in flags inside util_format_block that said exactly what we want.
47 enum util_format_layout
{
49 * Formats with util_format_block::width == util_format_block::height == 1
50 * that can be described as an ordinary data structure.
52 UTIL_FORMAT_LAYOUT_PLAIN
= 0,
55 * Formats with sub-sampled channels.
57 * This is for formats like YV12 where there is less than one sample per
60 UTIL_FORMAT_LAYOUT_SUBSAMPLED
= 3,
63 * S3 Texture Compression formats.
65 UTIL_FORMAT_LAYOUT_S3TC
= 4,
68 * Red-Green Texture Compression formats.
70 UTIL_FORMAT_LAYOUT_RGTC
= 5,
73 * Everything else that doesn't fit in any of the above layouts.
75 UTIL_FORMAT_LAYOUT_OTHER
= 6
79 struct util_format_block
81 /** Block width in pixels */
84 /** Block height in pixels */
87 /** Block size in bits */
92 enum util_format_type
{
93 UTIL_FORMAT_TYPE_VOID
= 0,
94 UTIL_FORMAT_TYPE_UNSIGNED
= 1,
95 UTIL_FORMAT_TYPE_SIGNED
= 2,
96 UTIL_FORMAT_TYPE_FIXED
= 3,
97 UTIL_FORMAT_TYPE_FLOAT
= 4
101 enum util_format_swizzle
{
102 UTIL_FORMAT_SWIZZLE_X
= 0,
103 UTIL_FORMAT_SWIZZLE_Y
= 1,
104 UTIL_FORMAT_SWIZZLE_Z
= 2,
105 UTIL_FORMAT_SWIZZLE_W
= 3,
106 UTIL_FORMAT_SWIZZLE_0
= 4,
107 UTIL_FORMAT_SWIZZLE_1
= 5,
108 UTIL_FORMAT_SWIZZLE_NONE
= 6
112 enum util_format_colorspace
{
113 UTIL_FORMAT_COLORSPACE_RGB
= 0,
114 UTIL_FORMAT_COLORSPACE_SRGB
= 1,
115 UTIL_FORMAT_COLORSPACE_YUV
= 2,
116 UTIL_FORMAT_COLORSPACE_ZS
= 3
120 struct util_format_channel_description
123 unsigned normalized
:1;
128 struct util_format_description
130 enum pipe_format format
;
135 * Short name, striped of the prefix, lower case.
137 const char *short_name
;
140 * Pixel block dimensions.
142 struct util_format_block block
;
144 enum util_format_layout layout
;
147 * The number of channels.
149 unsigned nr_channels
:3;
152 * Whether all channels have the same number of (whole) bytes.
157 * Whether the pixel format can be described as a bitfield structure.
160 * - pixel depth must be 8, 16, or 32 bits;
161 * - all channels must be unsigned, signed, or void
163 unsigned is_bitmask
:1;
166 * Whether channels have mixed types (ignoring UTIL_FORMAT_TYPE_VOID).
171 * Input channel description.
173 * Only valid for UTIL_FORMAT_LAYOUT_PLAIN formats.
175 struct util_format_channel_description channel
[4];
178 * Output channel swizzle.
180 * The order is either:
184 * depending on the colorspace.
186 unsigned char swizzle
[4];
189 * Colorspace transformation.
191 enum util_format_colorspace colorspace
;
194 * Unpack pixel blocks to R8G8B8A8_UNORM.
197 (*unpack_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
198 const uint8_t *src
, unsigned src_stride
,
199 unsigned width
, unsigned height
);
202 * Pack pixel blocks from R8G8B8A8_UNORM.
205 (*pack_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
206 const uint8_t *src
, unsigned src_stride
,
207 unsigned width
, unsigned height
);
210 * Unpack pixel blocks to R32G32B32A32_FLOAT.
213 (*unpack_float
)(float *dst
, unsigned dst_stride
,
214 const uint8_t *src
, unsigned src_stride
,
215 unsigned width
, unsigned height
);
218 * Pack pixel blocks from R32G32B32A32_FLOAT.
221 (*pack_float
)(uint8_t *dst
, unsigned dst_stride
,
222 const float *src
, unsigned src_stride
,
223 unsigned width
, unsigned height
);
226 * Fetch a single pixel (i, j) from a block.
229 (*fetch_float
)(float *dst
,
231 unsigned i
, unsigned j
);
235 extern const struct util_format_description
236 util_format_description_table
[];
239 const struct util_format_description
*
240 util_format_description(enum pipe_format format
);
244 * Format query functions.
247 static INLINE
const char *
248 util_format_name(enum pipe_format format
)
250 const struct util_format_description
*desc
= util_format_description(format
);
260 static INLINE boolean
261 util_format_is_s3tc(enum pipe_format format
)
263 const struct util_format_description
*desc
= util_format_description(format
);
270 return desc
->layout
== UTIL_FORMAT_LAYOUT_S3TC
? TRUE
: FALSE
;
273 static INLINE boolean
274 util_format_is_depth_or_stencil(enum pipe_format format
)
276 const struct util_format_description
*desc
= util_format_description(format
);
283 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
? TRUE
: FALSE
;
286 static INLINE boolean
287 util_format_is_depth_and_stencil(enum pipe_format format
)
289 const struct util_format_description
*desc
= util_format_description(format
);
296 if (desc
->colorspace
!= UTIL_FORMAT_COLORSPACE_ZS
) {
300 return (desc
->swizzle
[0] != UTIL_FORMAT_SWIZZLE_NONE
&&
301 desc
->swizzle
[1] != UTIL_FORMAT_SWIZZLE_NONE
) ? TRUE
: FALSE
;
305 * Whether this format is a rgab8 variant.
307 * That is, any format that matches the
309 * PIPE_FORMAT_?8?8?8?8_UNORM
311 static INLINE boolean
312 util_format_is_rgba8_variant(const struct util_format_description
*desc
)
316 if(desc
->block
.width
!= 1 ||
317 desc
->block
.height
!= 1 ||
318 desc
->block
.bits
!= 32)
321 for(chan
= 0; chan
< 4; ++chan
) {
322 if(desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_UNSIGNED
&&
323 desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_VOID
)
325 if(desc
->channel
[chan
].size
!= 8)
334 * Return total bits needed for the pixel format per block.
337 util_format_get_blocksizebits(enum pipe_format format
)
339 const struct util_format_description
*desc
= util_format_description(format
);
346 return desc
->block
.bits
;
350 * Return bytes per block (not pixel) for the given format.
353 util_format_get_blocksize(enum pipe_format format
)
355 uint bits
= util_format_get_blocksizebits(format
);
357 assert(bits
% 8 == 0);
363 util_format_get_blockwidth(enum pipe_format format
)
365 const struct util_format_description
*desc
= util_format_description(format
);
372 return desc
->block
.width
;
376 util_format_get_blockheight(enum pipe_format format
)
378 const struct util_format_description
*desc
= util_format_description(format
);
385 return desc
->block
.height
;
388 static INLINE
unsigned
389 util_format_get_nblocksx(enum pipe_format format
,
392 unsigned blockwidth
= util_format_get_blockwidth(format
);
393 return (x
+ blockwidth
- 1) / blockwidth
;
396 static INLINE
unsigned
397 util_format_get_nblocksy(enum pipe_format format
,
400 unsigned blockheight
= util_format_get_blockheight(format
);
401 return (y
+ blockheight
- 1) / blockheight
;
404 static INLINE
unsigned
405 util_format_get_nblocks(enum pipe_format format
,
409 return util_format_get_nblocksx(format
, width
) * util_format_get_nblocksy(format
, height
);
413 util_format_get_stride(enum pipe_format format
,
416 return util_format_get_nblocksx(format
, width
) * util_format_get_blocksize(format
);
420 util_format_get_2d_size(enum pipe_format format
,
424 return util_format_get_nblocksy(format
, height
) * stride
;
428 util_format_get_component_bits(enum pipe_format format
,
429 enum util_format_colorspace colorspace
,
432 const struct util_format_description
*desc
= util_format_description(format
);
433 enum util_format_colorspace desc_colorspace
;
440 assert(component
< 4);
442 /* Treat RGB and SRGB as equivalent. */
443 if (colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
444 colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
446 if (desc
->colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
447 desc_colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
449 desc_colorspace
= desc
->colorspace
;
452 if (desc_colorspace
!= colorspace
) {
456 switch (desc
->swizzle
[component
]) {
457 case UTIL_FORMAT_SWIZZLE_X
:
458 return desc
->channel
[0].size
;
459 case UTIL_FORMAT_SWIZZLE_Y
:
460 return desc
->channel
[1].size
;
461 case UTIL_FORMAT_SWIZZLE_Z
:
462 return desc
->channel
[2].size
;
463 case UTIL_FORMAT_SWIZZLE_W
:
464 return desc
->channel
[3].size
;
470 static INLINE boolean
471 util_format_has_alpha(enum pipe_format format
)
473 const struct util_format_description
*desc
= util_format_description(format
);
480 switch (desc
->colorspace
) {
481 case UTIL_FORMAT_COLORSPACE_RGB
:
482 case UTIL_FORMAT_COLORSPACE_SRGB
:
483 return desc
->swizzle
[3] != UTIL_FORMAT_SWIZZLE_1
;
484 case UTIL_FORMAT_COLORSPACE_YUV
:
486 case UTIL_FORMAT_COLORSPACE_ZS
:
495 * Return the number of components stored.
496 * Formats with block size != 1x1 will always have 1 component (the block).
498 static INLINE
unsigned
499 util_format_get_nr_components(enum pipe_format format
)
501 const struct util_format_description
*desc
= util_format_description(format
);
502 return desc
->nr_channels
;
506 * Format access functions.
510 util_format_read_4f(enum pipe_format format
,
511 float *dst
, unsigned dst_stride
,
512 const void *src
, unsigned src_stride
,
513 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
516 util_format_write_4f(enum pipe_format format
,
517 const float *src
, unsigned src_stride
,
518 void *dst
, unsigned dst_stride
,
519 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
522 util_format_read_4ub(enum pipe_format format
,
523 uint8_t *dst
, unsigned dst_stride
,
524 const void *src
, unsigned src_stride
,
525 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
528 util_format_write_4ub(enum pipe_format format
,
529 const uint8_t *src
, unsigned src_stride
,
530 void *dst
, unsigned dst_stride
,
531 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
537 #endif /* ! U_FORMAT_H */