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 "pipe/p_inlines.h"
44 #include "util/u_tile.h"
47 #include "st_context.h"
48 #include "st_cb_bitmap.h"
49 #include "st_cb_readpixels.h"
50 #include "st_cb_fbo.h"
51 #include "st_format.h"
52 #include "st_public.h"
53 #include "st_texture.h"
54 #include "st_inlines.h"
57 * Special case for reading stencil buffer.
58 * For color/depth we use get_tile(). For stencil, map the stencil buffer.
61 st_read_stencil_pixels(GLcontext
*ctx
, GLint x
, GLint y
,
62 GLsizei width
, GLsizei height
,
63 GLenum format
, GLenum type
,
64 const struct gl_pixelstore_attrib
*packing
,
67 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
68 struct pipe_screen
*screen
= ctx
->st
->pipe
->screen
;
69 struct st_renderbuffer
*strb
= st_renderbuffer(fb
->_StencilBuffer
);
70 struct pipe_transfer
*pt
;
74 if (st_fb_orientation(ctx
->DrawBuffer
) == Y_0_TOP
) {
75 y
= ctx
->DrawBuffer
->Height
- y
- height
;
78 /* Create a read transfer from the renderbuffer's texture */
80 pt
= st_cond_flush_get_tex_transfer(st_context(ctx
), strb
->texture
,
82 PIPE_TRANSFER_READ
, x
, y
,
85 /* map the stencil buffer */
86 stmap
= screen
->transfer_map(screen
, pt
);
88 /* width should never be > MAX_WIDTH since we did clipping earlier */
89 ASSERT(width
<= MAX_WIDTH
);
91 /* process image row by row */
92 for (j
= 0; j
< height
; j
++) {
94 GLstencil sValues
[MAX_WIDTH
];
95 GLfloat zValues
[MAX_WIDTH
];
98 if (st_fb_orientation(ctx
->DrawBuffer
) == Y_0_TOP
) {
99 srcY
= height
- j
- 1;
105 /* get stencil (and Z) values */
106 switch (pt
->format
) {
107 case PIPE_FORMAT_S8_UNORM
:
109 const ubyte
*src
= stmap
+ srcY
* pt
->stride
;
110 memcpy(sValues
, src
, width
);
113 case PIPE_FORMAT_S8Z24_UNORM
:
114 if (format
== GL_DEPTH_STENCIL
) {
115 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
116 const GLfloat scale
= 1.0f
/ (0xffffff);
118 for (k
= 0; k
< width
; k
++) {
119 sValues
[k
] = src
[k
] >> 24;
120 zValues
[k
] = (src
[k
] & 0xffffff) * scale
;
124 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
126 for (k
= 0; k
< width
; k
++) {
127 sValues
[k
] = src
[k
] >> 24;
131 case PIPE_FORMAT_Z24S8_UNORM
:
132 if (format
== GL_DEPTH_STENCIL
) {
133 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
134 const GLfloat scale
= 1.0f
/ (0xffffff);
136 for (k
= 0; k
< width
; k
++) {
137 sValues
[k
] = src
[k
] & 0xff;
138 zValues
[k
] = (src
[k
] >> 8) * scale
;
142 const uint
*src
= (uint
*) (stmap
+ srcY
* pt
->stride
);
144 for (k
= 0; k
< width
; k
++) {
145 sValues
[k
] = src
[k
] & 0xff;
154 dest
= _mesa_image_address2d(packing
, pixels
, width
, height
,
156 if (format
== GL_DEPTH_STENCIL
) {
157 _mesa_pack_depth_stencil_span(ctx
, width
, dest
,
158 zValues
, sValues
, packing
);
161 _mesa_pack_stencil_span(ctx
, width
, type
, dest
, sValues
, packing
);
165 /* unmap the stencil buffer */
166 screen
->transfer_unmap(screen
, pt
);
167 screen
->tex_transfer_destroy(pt
);
172 * Return renderbuffer to use for reading color pixels for glRead/CopyPixel
174 * Special care is needed for the front buffer.
176 struct st_renderbuffer
*
177 st_get_color_read_renderbuffer(GLcontext
*ctx
)
179 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
180 struct st_renderbuffer
*strb
=
181 st_renderbuffer(fb
->_ColorReadBuffer
);
182 struct st_renderbuffer
*front
=
183 st_renderbuffer(fb
->Attachment
[BUFFER_FRONT_LEFT
].Renderbuffer
);
186 && ctx
->st
->frontbuffer_status
== FRONT_STATUS_COPY_OF_BACK
) {
187 /* reading from front color buffer, which is a logical copy of the
190 struct st_renderbuffer
*back
=
191 st_renderbuffer(fb
->Attachment
[BUFFER_BACK_LEFT
].Renderbuffer
);
200 * Try to do glReadPixels in a fast manner for common cases.
201 * \return GL_TRUE for success, GL_FALSE for failure
204 st_fast_readpixels(GLcontext
*ctx
, struct st_renderbuffer
*strb
,
205 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
206 GLenum format
, GLenum type
,
207 const struct gl_pixelstore_attrib
*pack
,
211 A8R8G8B8_UNORM_TO_RGBA_UBYTE
,
212 A8R8G8B8_UNORM_TO_RGB_UBYTE
,
213 A8R8G8B8_UNORM_TO_BGRA_UINT
216 if (ctx
->_ImageTransferState
)
219 if (strb
->format
== PIPE_FORMAT_A8R8G8B8_UNORM
&&
220 format
== GL_RGBA
&& type
== GL_UNSIGNED_BYTE
) {
221 combo
= A8R8G8B8_UNORM_TO_RGBA_UBYTE
;
223 else if (strb
->format
== PIPE_FORMAT_A8R8G8B8_UNORM
&&
224 format
== GL_RGB
&& type
== GL_UNSIGNED_BYTE
) {
225 combo
= A8R8G8B8_UNORM_TO_RGB_UBYTE
;
227 else if (strb
->format
== PIPE_FORMAT_A8R8G8B8_UNORM
&&
228 format
== GL_BGRA
&& type
== GL_UNSIGNED_INT_8_8_8_8_REV
) {
229 combo
= A8R8G8B8_UNORM_TO_BGRA_UINT
;
235 /*printf("st_fast_readpixels combo %d\n", (GLint) combo);*/
238 struct pipe_context
*pipe
= ctx
->st
->pipe
;
239 struct pipe_screen
*screen
= pipe
->screen
;
240 struct pipe_transfer
*trans
;
243 GLint row
, col
, dy
, dstStride
;
245 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
246 y
= strb
->texture
->height
[0] - 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 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
272 dst
= _mesa_image_address2d(pack
, dest
, width
, height
,
274 dstStride
= _mesa_image_row_stride(pack
, width
, format
, type
);
277 case A8R8G8B8_UNORM_TO_RGBA_UBYTE
:
278 for (row
= 0; row
< height
; row
++) {
279 const GLubyte
*src
= map
+ y
* trans
->stride
;
280 for (col
= 0; col
< width
; col
++) {
281 GLuint pixel
= ((GLuint
*) src
)[col
];
282 dst
[col
*4+0] = (pixel
>> 16) & 0xff;
283 dst
[col
*4+1] = (pixel
>> 8) & 0xff;
284 dst
[col
*4+2] = (pixel
>> 0) & 0xff;
285 dst
[col
*4+3] = (pixel
>> 24) & 0xff;
291 case A8R8G8B8_UNORM_TO_RGB_UBYTE
:
292 for (row
= 0; row
< height
; row
++) {
293 const GLubyte
*src
= map
+ y
* trans
->stride
;
294 for (col
= 0; col
< width
; col
++) {
295 GLuint pixel
= ((GLuint
*) src
)[col
];
296 dst
[col
*3+0] = (pixel
>> 16) & 0xff;
297 dst
[col
*3+1] = (pixel
>> 8) & 0xff;
298 dst
[col
*3+2] = (pixel
>> 0) & 0xff;
304 case A8R8G8B8_UNORM_TO_BGRA_UINT
:
305 for (row
= 0; row
< height
; row
++) {
306 const GLubyte
*src
= map
+ y
* trans
->stride
;
307 memcpy(dst
, src
, 4 * width
);
316 screen
->transfer_unmap(screen
, trans
);
317 screen
->tex_transfer_destroy(trans
);
325 * Do glReadPixels by getting rows from the framebuffer transfer with
326 * get_tile(). Convert to requested format/type with Mesa image routines.
327 * Image transfer ops are done in software too.
330 st_readpixels(GLcontext
*ctx
, GLint x
, GLint y
, GLsizei width
, GLsizei height
,
331 GLenum format
, GLenum type
,
332 const struct gl_pixelstore_attrib
*pack
,
335 struct pipe_context
*pipe
= ctx
->st
->pipe
;
336 struct pipe_screen
*screen
= pipe
->screen
;
337 GLfloat temp
[MAX_WIDTH
][4];
338 const GLbitfield transferOps
= ctx
->_ImageTransferState
;
340 GLint yStep
, dfStride
;
342 struct st_renderbuffer
*strb
;
343 struct gl_pixelstore_attrib clippedPacking
= *pack
;
344 struct pipe_transfer
*trans
;
346 assert(ctx
->ReadBuffer
->Width
> 0);
348 /* XXX convolution not done yet */
349 assert((transferOps
& IMAGE_CONVOLUTION_BIT
) == 0);
351 /* Do all needed clipping here, so that we can forget about it later */
352 if (!_mesa_clip_readpixels(ctx
, &x
, &y
, &width
, &height
, &clippedPacking
)) {
353 /* The ReadPixels transfer is totally outside the window bounds */
357 dest
= _mesa_map_pbo_dest(ctx
, &clippedPacking
, dest
);
361 st_flush(ctx
->st
, PIPE_FLUSH_RENDER_CACHE
, NULL
);
363 if (format
== GL_STENCIL_INDEX
||
364 format
== GL_DEPTH_STENCIL
) {
365 st_read_stencil_pixels(ctx
, x
, y
, width
, height
,
366 format
, type
, pack
, dest
);
369 else if (format
== GL_DEPTH_COMPONENT
) {
370 strb
= st_renderbuffer(ctx
->ReadBuffer
->_DepthBuffer
);
373 /* Read color buffer */
374 strb
= st_get_color_read_renderbuffer(ctx
);
380 /* try a fast-path readpixels before anything else */
381 if (st_fast_readpixels(ctx
, strb
, x
, y
, width
, height
,
382 format
, type
, pack
, dest
)) {
384 _mesa_unmap_pbo_dest(ctx
, &clippedPacking
);
388 if (format
== GL_RGBA
&& type
== GL_FLOAT
) {
389 /* write tile(row) directly into user's buffer */
390 df
= (GLfloat
*) _mesa_image_address2d(&clippedPacking
, dest
, width
,
391 height
, format
, type
, 0, 0);
392 dfStride
= width
* 4;
395 /* write tile(row) into temp row buffer */
396 df
= (GLfloat
*) temp
;
400 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
401 y
= strb
->Base
.Height
- y
- height
;
404 /* Create a read transfer from the renderbuffer's texture */
405 trans
= st_cond_flush_get_tex_transfer(st_context(ctx
), strb
->texture
,
407 PIPE_TRANSFER_READ
, x
, y
,
410 /* determine bottom-to-top vs. top-to-bottom order */
411 if (st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
) {
420 if (ST_DEBUG
& DEBUG_FALLBACK
)
421 debug_printf("%s: fallback processing\n", __FUNCTION__
);
424 * Copy pixels from pipe_transfer to user memory
427 /* dest of first pixel in client memory */
428 GLubyte
*dst
= _mesa_image_address2d(&clippedPacking
, dest
, width
,
429 height
, format
, type
, 0, 0);
430 /* dest row stride */
431 const GLint dstStride
= _mesa_image_row_stride(&clippedPacking
, width
,
434 if (trans
->format
== PIPE_FORMAT_S8Z24_UNORM
||
435 trans
->format
== PIPE_FORMAT_X8Z24_UNORM
) {
436 if (format
== GL_DEPTH_COMPONENT
) {
437 for (i
= 0; i
< height
; i
++) {
438 GLuint ztemp
[MAX_WIDTH
];
439 GLfloat zfloat
[MAX_WIDTH
];
440 const double scale
= 1.0 / ((1 << 24) - 1);
441 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
443 for (j
= 0; j
< width
; j
++) {
444 zfloat
[j
] = (float) (scale
* (ztemp
[j
] & 0xffffff));
446 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
447 zfloat
, &clippedPacking
);
452 /* XXX: unreachable code -- should be before st_read_stencil_pixels */
453 assert(format
== GL_DEPTH_STENCIL_EXT
);
454 for (i
= 0; i
< height
; i
++) {
455 GLuint
*zshort
= (GLuint
*)dst
;
456 pipe_get_tile_raw(trans
, 0, y
, width
, 1, dst
, 0);
458 /* Reverse into 24/8 */
459 for (j
= 0; j
< width
; j
++) {
460 zshort
[j
] = (zshort
[j
] << 8) | (zshort
[j
] >> 24);
466 else if (trans
->format
== PIPE_FORMAT_Z24S8_UNORM
||
467 trans
->format
== PIPE_FORMAT_Z24X8_UNORM
) {
468 if (format
== GL_DEPTH_COMPONENT
) {
469 for (i
= 0; i
< height
; i
++) {
470 GLuint ztemp
[MAX_WIDTH
];
471 GLfloat zfloat
[MAX_WIDTH
];
472 const double scale
= 1.0 / ((1 << 24) - 1);
473 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
475 for (j
= 0; j
< width
; j
++) {
476 zfloat
[j
] = (float) (scale
* ((ztemp
[j
] >> 8) & 0xffffff));
478 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
479 zfloat
, &clippedPacking
);
484 /* XXX: unreachable code -- should be before st_read_stencil_pixels */
485 assert(format
== GL_DEPTH_STENCIL_EXT
);
486 for (i
= 0; i
< height
; i
++) {
487 pipe_get_tile_raw(trans
, 0, y
, width
, 1, dst
, 0);
493 else if (trans
->format
== PIPE_FORMAT_Z16_UNORM
) {
494 for (i
= 0; i
< height
; i
++) {
495 GLushort ztemp
[MAX_WIDTH
];
496 GLfloat zfloat
[MAX_WIDTH
];
497 const double scale
= 1.0 / 0xffff;
498 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
500 for (j
= 0; j
< width
; j
++) {
501 zfloat
[j
] = (float) (scale
* ztemp
[j
]);
503 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
504 zfloat
, &clippedPacking
);
508 else if (trans
->format
== PIPE_FORMAT_Z32_UNORM
) {
509 for (i
= 0; i
< height
; i
++) {
510 GLuint ztemp
[MAX_WIDTH
];
511 GLfloat zfloat
[MAX_WIDTH
];
512 const double scale
= 1.0 / 0xffffffff;
513 pipe_get_tile_raw(trans
, 0, y
, width
, 1, ztemp
, 0);
515 for (j
= 0; j
< width
; j
++) {
516 zfloat
[j
] = (float) (scale
* ztemp
[j
]);
518 _mesa_pack_depth_span(ctx
, width
, dst
, type
,
519 zfloat
, &clippedPacking
);
525 /* Do a row at a time to flip image data vertically */
526 for (i
= 0; i
< height
; i
++) {
527 pipe_get_tile_rgba(trans
, 0, y
, width
, 1, df
);
531 _mesa_pack_rgba_span_float(ctx
, width
, temp
, format
, type
, dst
,
532 &clippedPacking
, transferOps
);
539 screen
->tex_transfer_destroy(trans
);
541 _mesa_unmap_pbo_dest(ctx
, &clippedPacking
);
545 void st_init_readpixels_functions(struct dd_function_table
*functions
)
547 functions
->ReadPixels
= st_readpixels
;