1 /**************************************************************************
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
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 TUNGSTEN GRAPHICS 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 **************************************************************************/
30 * glReadPixels interface to pipe
36 #include "main/imports.h"
37 #include "main/bufferobj.h"
38 #include "main/context.h"
39 #include "main/image.h"
41 #include "pipe/p_context.h"
42 #include "pipe/p_defines.h"
43 #include "util/u_inlines.h"
44 #include "util/u_tile.h"
47 #include "st_context.h"
49 #include "st_cb_readpixels.h"
50 #include "st_cb_fbo.h"
51 #include "st_public.h"
52 #include "st_texture.h"
53 #include "st_inlines.h"
56 * Special case for reading stencil buffer.
57 * For color/depth we use get_tile(). For stencil, map the stencil buffer.
60 st_read_stencil_pixels(GLcontext
*ctx
, GLint x
, GLint y
,
61 GLsizei width
, GLsizei height
,
62 GLenum format
, GLenum type
,
63 const struct gl_pixelstore_attrib
*packing
,
66 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
67 struct pipe_screen
*screen
= ctx
->st
->pipe
->screen
;
68 struct st_renderbuffer
*strb
= st_renderbuffer(fb
->_StencilBuffer
);
69 struct pipe_transfer
*pt
;
73 if (st_fb_orientation(ctx
->DrawBuffer
) == Y_0_TOP
) {
74 y
= ctx
->DrawBuffer
->Height
- y
- height
;
77 /* Create a read transfer from the renderbuffer's texture */
79 pt
= st_cond_flush_get_tex_transfer(st_context(ctx
), strb
->texture
,
81 PIPE_TRANSFER_READ
, x
, y
,
84 /* map the stencil buffer */
85 stmap
= screen
->transfer_map(screen
, pt
);
87 /* width should never be > MAX_WIDTH since we did clipping earlier */
88 ASSERT(width
<= MAX_WIDTH
);
90 /* process image row by row */
91 for (j
= 0; j
< height
; j
++) {
93 GLstencil sValues
[MAX_WIDTH
];
94 GLfloat zValues
[MAX_WIDTH
];
97 if (st_fb_orientation(ctx
->DrawBuffer
) == Y_0_TOP
) {
98 srcY
= height
- j
- 1;
104 /* get stencil (and Z) values */
105 switch (pt
->texture
->format
) {
106 case PIPE_FORMAT_S8_UNORM
:
108 const ubyte
*src
= stmap
+ srcY
* pt
->stride
;
109 memcpy(sValues
, src
, width
);
112 case PIPE_FORMAT_Z24S8_UNORM
:
113 if (format
== GL_DEPTH_STENCIL
) {
114 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
115 const GLfloat scale
= 1.0f
/ (0xffffff);
117 for (k
= 0; k
< width
; k
++) {
118 sValues
[k
] = src
[k
] >> 24;
119 zValues
[k
] = (src
[k
] & 0xffffff) * scale
;
123 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
125 for (k
= 0; k
< width
; k
++) {
126 sValues
[k
] = src
[k
] >> 24;
130 case PIPE_FORMAT_S8Z24_UNORM
:
131 if (format
== GL_DEPTH_STENCIL
) {
132 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
133 const GLfloat scale
= 1.0f
/ (0xffffff);
135 for (k
= 0; k
< width
; k
++) {
136 sValues
[k
] = src
[k
] & 0xff;
137 zValues
[k
] = (src
[k
] >> 8) * scale
;
141 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
143 for (k
= 0; k
< width
; k
++) {
144 sValues
[k
] = src
[k
] & 0xff;
153 dest
= _mesa_image_address2d(packing
, pixels
, width
, height
,
155 if (format
== GL_DEPTH_STENCIL
) {
156 _mesa_pack_depth_stencil_span(ctx
, width
, dest
,
157 zValues
, sValues
, packing
);
160 _mesa_pack_stencil_span(ctx
, width
, type
, dest
, sValues
, packing
);
164 /* unmap the stencil buffer */
165 screen
->transfer_unmap(screen
, pt
);
166 screen
->tex_transfer_destroy(pt
);
171 * Return renderbuffer to use for reading color pixels for glRead/CopyPixel
173 * Special care is needed for the front buffer.
175 struct st_renderbuffer
*
176 st_get_color_read_renderbuffer(GLcontext
*ctx
)
178 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
179 struct st_renderbuffer
*strb
=
180 st_renderbuffer(fb
->_ColorReadBuffer
);
181 struct st_renderbuffer
*front
=
182 st_renderbuffer(fb
->Attachment
[BUFFER_FRONT_LEFT
].Renderbuffer
);
185 && ctx
->st
->frontbuffer_status
== FRONT_STATUS_COPY_OF_BACK
) {
186 /* reading from front color buffer, which is a logical copy of the
189 struct st_renderbuffer
*back
=
190 st_renderbuffer(fb
->Attachment
[BUFFER_BACK_LEFT
].Renderbuffer
);
199 * Try to do glReadPixels in a fast manner for common cases.
200 * \return GL_TRUE for success, GL_FALSE for failure
203 st_fast_readpixels(GLcontext
*ctx
, struct st_renderbuffer
*strb
,
204 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
205 GLenum format
, GLenum type
,
206 const struct gl_pixelstore_attrib
*pack
,
210 A8R8G8B8_UNORM_TO_RGBA_UBYTE
,
211 A8R8G8B8_UNORM_TO_RGB_UBYTE
,
212 A8R8G8B8_UNORM_TO_BGRA_UINT
215 if (ctx
->_ImageTransferState
)
218 if (strb
->format
== PIPE_FORMAT_B8G8R8A8_UNORM
&&
219 format
== GL_RGBA
&& type
== GL_UNSIGNED_BYTE
) {
220 combo
= A8R8G8B8_UNORM_TO_RGBA_UBYTE
;
222 else if (strb
->format
== PIPE_FORMAT_B8G8R8A8_UNORM
&&
223 format
== GL_RGB
&& type
== GL_UNSIGNED_BYTE
) {
224 combo
= A8R8G8B8_UNORM_TO_RGB_UBYTE
;
226 else if (strb
->format
== PIPE_FORMAT_B8G8R8A8_UNORM
&&
227 format
== GL_BGRA
&& type
== GL_UNSIGNED_INT_8_8_8_8_REV
) {
228 combo
= A8R8G8B8_UNORM_TO_BGRA_UINT
;
234 /*printf("st_fast_readpixels combo %d\n", (GLint) combo);*/
237 struct pipe_context
*pipe
= ctx
->st
->pipe
;
238 struct pipe_screen
*screen
= pipe
->screen
;
239 struct pipe_transfer
*trans
;
242 GLint row
, col
, dy
, dstStride
;
244 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
245 /* convert GL Y to Gallium Y */
246 y
= strb
->texture
->height0
- y
- height
;
249 trans
= st_cond_flush_get_tex_transfer(st_context(ctx
), strb
->texture
,
251 PIPE_TRANSFER_READ
, x
, y
,
257 map
= screen
->transfer_map(screen
, trans
);
259 screen
->tex_transfer_destroy(trans
);
263 /* We always write to the user/dest buffer from low addr to high addr
264 * but the read order depends on renderbuffer orientation
266 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
267 /* read source rows from bottom to top */
272 /* read source rows from top to bottom */
277 dst
= _mesa_image_address2d(pack
, dest
, width
, height
,
279 dstStride
= _mesa_image_row_stride(pack
, width
, format
, type
);
282 case A8R8G8B8_UNORM_TO_RGBA_UBYTE
:
283 for (row
= 0; row
< height
; row
++) {
284 const GLubyte
*src
= map
+ y
* trans
->stride
;
285 for (col
= 0; col
< width
; col
++) {
286 GLuint pixel
= ((GLuint
*) src
)[col
];
287 dst
[col
*4+0] = (pixel
>> 16) & 0xff;
288 dst
[col
*4+1] = (pixel
>> 8) & 0xff;
289 dst
[col
*4+2] = (pixel
>> 0) & 0xff;
290 dst
[col
*4+3] = (pixel
>> 24) & 0xff;
296 case A8R8G8B8_UNORM_TO_RGB_UBYTE
:
297 for (row
= 0; row
< height
; row
++) {
298 const GLubyte
*src
= map
+ y
* trans
->stride
;
299 for (col
= 0; col
< width
; col
++) {
300 GLuint pixel
= ((GLuint
*) src
)[col
];
301 dst
[col
*3+0] = (pixel
>> 16) & 0xff;
302 dst
[col
*3+1] = (pixel
>> 8) & 0xff;
303 dst
[col
*3+2] = (pixel
>> 0) & 0xff;
309 case A8R8G8B8_UNORM_TO_BGRA_UINT
:
310 for (row
= 0; row
< height
; row
++) {
311 const GLubyte
*src
= map
+ y
* trans
->stride
;
312 memcpy(dst
, src
, 4 * width
);
321 screen
->transfer_unmap(screen
, trans
);
322 screen
->tex_transfer_destroy(trans
);
330 * Do glReadPixels by getting rows from the framebuffer transfer with
331 * get_tile(). Convert to requested format/type with Mesa image routines.
332 * Image transfer ops are done in software too.
335 st_readpixels(GLcontext
*ctx
, GLint x
, GLint y
, GLsizei width
, GLsizei height
,
336 GLenum format
, GLenum type
,
337 const struct gl_pixelstore_attrib
*pack
,
340 struct pipe_context
*pipe
= ctx
->st
->pipe
;
341 struct pipe_screen
*screen
= pipe
->screen
;
342 GLfloat temp
[MAX_WIDTH
][4];
343 const GLbitfield transferOps
= ctx
->_ImageTransferState
;
345 GLint yStep
, dfStride
;
347 struct st_renderbuffer
*strb
;
348 struct gl_pixelstore_attrib clippedPacking
= *pack
;
349 struct pipe_transfer
*trans
;
351 assert(ctx
->ReadBuffer
->Width
> 0);
353 /* XXX convolution not done yet */
354 assert((transferOps
& IMAGE_CONVOLUTION_BIT
) == 0);
356 st_validate_state(ctx
->st
);
358 /* Do all needed clipping here, so that we can forget about it later */
359 if (!_mesa_clip_readpixels(ctx
, &x
, &y
, &width
, &height
, &clippedPacking
)) {
360 /* The ReadPixels transfer is totally outside the window bounds */
364 dest
= _mesa_map_pbo_dest(ctx
, &clippedPacking
, dest
);
368 st_flush(ctx
->st
, PIPE_FLUSH_RENDER_CACHE
, NULL
);
370 if (format
== GL_STENCIL_INDEX
||
371 format
== GL_DEPTH_STENCIL
) {
372 st_read_stencil_pixels(ctx
, x
, y
, width
, height
,
373 format
, type
, pack
, dest
);
376 else if (format
== GL_DEPTH_COMPONENT
) {
377 strb
= st_renderbuffer(ctx
->ReadBuffer
->_DepthBuffer
);
380 /* Read color buffer */
381 strb
= st_get_color_read_renderbuffer(ctx
);
387 /* try a fast-path readpixels before anything else */
388 if (st_fast_readpixels(ctx
, strb
, x
, y
, width
, height
,
389 format
, type
, pack
, dest
)) {
391 _mesa_unmap_pbo_dest(ctx
, &clippedPacking
);
395 if (format
== GL_RGBA
&& type
== GL_FLOAT
) {
396 /* write tile(row) directly into user's buffer */
397 df
= (GLfloat
*) _mesa_image_address2d(&clippedPacking
, dest
, width
,
398 height
, format
, type
, 0, 0);
399 dfStride
= width
* 4;
402 /* write tile(row) into temp row buffer */
403 df
= (GLfloat
*) temp
;
407 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
408 /* convert GL Y to Gallium Y */
409 y
= strb
->Base
.Height
- y
- height
;
412 /* Create a read transfer from the renderbuffer's texture */
413 trans
= st_cond_flush_get_tex_transfer(st_context(ctx
), strb
->texture
,
415 PIPE_TRANSFER_READ
, x
, y
,
418 /* determine bottom-to-top vs. top-to-bottom order */
419 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
428 if (ST_DEBUG
& DEBUG_FALLBACK
)
429 debug_printf("%s: fallback processing\n", __FUNCTION__
);
432 * Copy pixels from pipe_transfer to user memory
435 /* dest of first pixel in client memory */
436 GLubyte
*dst
= _mesa_image_address2d(&clippedPacking
, dest
, width
,
437 height
, format
, type
, 0, 0);
438 /* dest row stride */
439 const GLint dstStride
= _mesa_image_row_stride(&clippedPacking
, width
,
442 if (trans
->texture
->format
== PIPE_FORMAT_Z24S8_UNORM
||
443 trans
->texture
->format
== PIPE_FORMAT_Z24X8_UNORM
) {
444 if (format
== GL_DEPTH_COMPONENT
) {
445 for (i
= 0; i
< height
; i
++) {
446 GLuint ztemp
[MAX_WIDTH
];
447 GLfloat zfloat
[MAX_WIDTH
];
448 const double scale
= 1.0 / ((1 << 24) - 1);
449 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
451 for (j
= 0; j
< width
; j
++) {
452 zfloat
[j
] = (float) (scale
* (ztemp
[j
] & 0xffffff));
454 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
455 zfloat
, &clippedPacking
);
460 /* XXX: unreachable code -- should be before st_read_stencil_pixels */
461 assert(format
== GL_DEPTH_STENCIL_EXT
);
462 for (i
= 0; i
< height
; i
++) {
463 GLuint
*zshort
= (GLuint
*)dst
;
464 pipe_get_tile_raw(trans
, 0, y
, width
, 1, dst
, 0);
466 /* Reverse into 24/8 */
467 for (j
= 0; j
< width
; j
++) {
468 zshort
[j
] = (zshort
[j
] << 8) | (zshort
[j
] >> 24);
474 else if (trans
->texture
->format
== PIPE_FORMAT_S8Z24_UNORM
||
475 trans
->texture
->format
== PIPE_FORMAT_X8Z24_UNORM
) {
476 if (format
== GL_DEPTH_COMPONENT
) {
477 for (i
= 0; i
< height
; i
++) {
478 GLuint ztemp
[MAX_WIDTH
];
479 GLfloat zfloat
[MAX_WIDTH
];
480 const double scale
= 1.0 / ((1 << 24) - 1);
481 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
483 for (j
= 0; j
< width
; j
++) {
484 zfloat
[j
] = (float) (scale
* ((ztemp
[j
] >> 8) & 0xffffff));
486 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
487 zfloat
, &clippedPacking
);
492 /* XXX: unreachable code -- should be before st_read_stencil_pixels */
493 assert(format
== GL_DEPTH_STENCIL_EXT
);
494 for (i
= 0; i
< height
; i
++) {
495 pipe_get_tile_raw(trans
, 0, y
, width
, 1, dst
, 0);
501 else if (trans
->texture
->format
== PIPE_FORMAT_Z16_UNORM
) {
502 for (i
= 0; i
< height
; i
++) {
503 GLushort ztemp
[MAX_WIDTH
];
504 GLfloat zfloat
[MAX_WIDTH
];
505 const double scale
= 1.0 / 0xffff;
506 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
508 for (j
= 0; j
< width
; j
++) {
509 zfloat
[j
] = (float) (scale
* ztemp
[j
]);
511 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
512 zfloat
, &clippedPacking
);
516 else if (trans
->texture
->format
== PIPE_FORMAT_Z32_UNORM
) {
517 for (i
= 0; i
< height
; i
++) {
518 GLuint ztemp
[MAX_WIDTH
];
519 GLfloat zfloat
[MAX_WIDTH
];
520 const double scale
= 1.0 / 0xffffffff;
521 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
523 for (j
= 0; j
< width
; j
++) {
524 zfloat
[j
] = (float) (scale
* ztemp
[j
]);
526 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
527 zfloat
, &clippedPacking
);
533 /* Do a row at a time to flip image data vertically */
534 for (i
= 0; i
< height
; i
++) {
535 pipe_get_tile_rgba(trans
, 0, y
, width
, 1, df
);
539 _mesa_pack_rgba_span_float(ctx
, width
, temp
, format
, type
, dst
,
540 &clippedPacking
, transferOps
);
547 screen
->tex_transfer_destroy(trans
);
549 _mesa_unmap_pbo_dest(ctx
, &clippedPacking
);
553 void st_init_readpixels_functions(struct dd_function_table
*functions
)
555 functions
->ReadPixels
= st_readpixels
;