1 /**************************************************************************
3 * Copyright 2007 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 **************************************************************************/
28 #include "main/bufferobj.h"
29 #include "main/image.h"
31 #include "main/imports.h"
32 #include "main/readpix.h"
33 #include "main/enums.h"
34 #include "main/framebuffer.h"
35 #include "util/u_inlines.h"
36 #include "util/u_format.h"
37 #include "cso_cache/cso_context.h"
39 #include "st_cb_fbo.h"
41 #include "st_context.h"
42 #include "st_cb_bitmap.h"
43 #include "st_cb_readpixels.h"
45 #include "state_tracker/st_cb_texture.h"
46 #include "state_tracker/st_format.h"
47 #include "state_tracker/st_pbo.h"
48 #include "state_tracker/st_texture.h"
50 /* The readpixels cache caches a blitted staging texture so that back-to-back
51 * calls to glReadPixels with user pointers require less CPU-GPU synchronization.
55 * (1) Blits have high synchronization overheads, and it is beneficial to
56 * use a single blit of the entire framebuffer instead of many smaller
57 * blits (because the smaller blits cannot be batched, and we have to wait
58 * for the GPU after each one).
60 * (2) transfer_map implicitly involves a blit as well (for de-tiling, copy
61 * from VRAM, etc.), so that it is beneficial to replace the
62 * _mesa_readpixels path as well when possible.
64 * Change this #define to true to fill and use the cache whenever possible
65 * (this is inefficient and only meant for testing / debugging).
67 #define ALWAYS_READPIXELS_CACHE false
70 needs_integer_signed_unsigned_conversion(const struct gl_context
*ctx
,
71 GLenum format
, GLenum type
)
73 struct gl_renderbuffer
*rb
=
74 _mesa_get_read_renderbuffer_for_format(ctx
, format
);
78 GLenum srcType
= _mesa_get_format_datatype(rb
->Format
);
80 if ((srcType
== GL_INT
&&
81 (type
== GL_UNSIGNED_INT
||
82 type
== GL_UNSIGNED_SHORT
||
83 type
== GL_UNSIGNED_BYTE
)) ||
84 (srcType
== GL_UNSIGNED_INT
&&
95 try_pbo_readpixels(struct st_context
*st
, struct st_renderbuffer
*strb
,
97 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
98 enum pipe_format src_format
, enum pipe_format dst_format
,
99 const struct gl_pixelstore_attrib
*pack
, void *pixels
)
101 struct pipe_context
*pipe
= st
->pipe
;
102 struct pipe_screen
*screen
= pipe
->screen
;
103 struct cso_context
*cso
= st
->cso_context
;
104 struct pipe_surface
*surface
= strb
->surface
;
105 struct pipe_resource
*texture
= strb
->texture
;
106 const struct util_format_description
*desc
;
107 struct st_pbo_addresses addr
;
108 struct pipe_framebuffer_state fb
;
109 enum pipe_texture_target view_target
;
110 bool success
= false;
112 if (texture
->nr_samples
> 1)
115 if (!screen
->is_format_supported(screen
, dst_format
, PIPE_BUFFER
, 0,
116 PIPE_BIND_SHADER_IMAGE
))
119 desc
= util_format_description(dst_format
);
121 /* Compute PBO addresses */
122 addr
.bytes_per_pixel
= desc
->block
.bits
/ 8;
126 addr
.height
= height
;
128 if (!st_pbo_addresses_pixelstore(st
, GL_TEXTURE_2D
, false, pack
, pixels
, &addr
))
131 cso_save_state(cso
, (CSO_BIT_FRAGMENT_SAMPLER_VIEWS
|
132 CSO_BIT_FRAGMENT_SAMPLERS
|
133 CSO_BIT_FRAGMENT_IMAGE0
|
134 CSO_BIT_VERTEX_ELEMENTS
|
135 CSO_BIT_AUX_VERTEX_BUFFER_SLOT
|
136 CSO_BIT_FRAMEBUFFER
|
139 CSO_BIT_DEPTH_STENCIL_ALPHA
|
140 CSO_BIT_STREAM_OUTPUTS
|
141 CSO_BIT_PAUSE_QUERIES
|
142 CSO_BITS_ALL_SHADERS
));
143 cso_save_constant_buffer_slot0(cso
, PIPE_SHADER_FRAGMENT
);
145 /* Set up the sampler_view */
147 struct pipe_sampler_view templ
;
148 struct pipe_sampler_view
*sampler_view
;
149 struct pipe_sampler_state sampler
= {0};
150 const struct pipe_sampler_state
*samplers
[1] = {&sampler
};
152 u_sampler_view_default_template(&templ
, texture
, src_format
);
154 switch (texture
->target
) {
155 case PIPE_TEXTURE_CUBE
:
156 case PIPE_TEXTURE_CUBE_ARRAY
:
157 view_target
= PIPE_TEXTURE_2D_ARRAY
;
160 view_target
= texture
->target
;
164 templ
.target
= view_target
;
165 templ
.u
.tex
.first_level
= surface
->u
.tex
.level
;
166 templ
.u
.tex
.last_level
= templ
.u
.tex
.first_level
;
168 if (view_target
!= PIPE_TEXTURE_3D
) {
169 templ
.u
.tex
.first_layer
= surface
->u
.tex
.first_layer
;
170 templ
.u
.tex
.last_layer
= templ
.u
.tex
.last_layer
;
172 addr
.constants
.layer_offset
= surface
->u
.tex
.first_layer
;
175 sampler_view
= pipe
->create_sampler_view(pipe
, texture
, &templ
);
176 if (sampler_view
== NULL
)
179 cso_set_sampler_views(cso
, PIPE_SHADER_FRAGMENT
, 1, &sampler_view
);
181 pipe_sampler_view_reference(&sampler_view
, NULL
);
183 cso_set_samplers(cso
, PIPE_SHADER_FRAGMENT
, 1, samplers
);
186 /* Set up destination image */
188 struct pipe_image_view image
;
190 memset(&image
, 0, sizeof(image
));
191 image
.resource
= addr
.buffer
;
192 image
.format
= dst_format
;
193 image
.access
= PIPE_IMAGE_ACCESS_WRITE
;
194 image
.u
.buf
.offset
= addr
.first_element
* addr
.bytes_per_pixel
;
195 image
.u
.buf
.size
= (addr
.last_element
- addr
.first_element
+ 1) *
196 addr
.bytes_per_pixel
;
198 cso_set_shader_images(cso
, PIPE_SHADER_FRAGMENT
, 0, 1, &image
);
201 /* Set up no-attachment framebuffer */
202 memset(&fb
, 0, sizeof(fb
));
203 fb
.width
= surface
->width
;
204 fb
.height
= surface
->height
;
207 cso_set_framebuffer(cso
, &fb
);
209 cso_set_viewport_dims(cso
, fb
.width
, fb
.height
, invert_y
);
212 st_pbo_addresses_invert_y(&addr
, fb
.height
);
215 struct pipe_depth_stencil_alpha_state dsa
;
216 memset(&dsa
, 0, sizeof(dsa
));
217 cso_set_depth_stencil_alpha(cso
, &dsa
);
220 /* Set up the fragment shader */
222 void *fs
= st_pbo_get_download_fs(st
, view_target
, src_format
, dst_format
);
226 cso_set_fragment_shader_handle(cso
, fs
);
229 success
= st_pbo_draw(st
, &addr
, fb
.width
, fb
.height
);
231 /* Buffer written via shader images needs explicit synchronization. */
232 pipe
->memory_barrier(pipe
, PIPE_BARRIER_ALL
);
235 cso_restore_state(cso
);
236 cso_restore_constant_buffer_slot0(cso
, PIPE_SHADER_FRAGMENT
);
241 /* Invalidate the readpixels cache to ensure we don't read stale data.
243 void st_invalidate_readpix_cache(struct st_context
*st
)
245 pipe_resource_reference(&st
->readpix_cache
.src
, NULL
);
246 pipe_resource_reference(&st
->readpix_cache
.cache
, NULL
);
250 * Create a staging texture and blit the requested region to it.
252 static struct pipe_resource
*
253 blit_to_staging(struct st_context
*st
, struct st_renderbuffer
*strb
,
255 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
257 enum pipe_format src_format
, enum pipe_format dst_format
)
259 struct pipe_context
*pipe
= st
->pipe
;
260 struct pipe_screen
*screen
= pipe
->screen
;
261 struct pipe_resource dst_templ
;
262 struct pipe_resource
*dst
;
263 struct pipe_blit_info blit
;
265 /* We are creating a texture of the size of the region being read back.
266 * Need to check for NPOT texture support. */
267 if (!screen
->get_param(screen
, PIPE_CAP_NPOT_TEXTURES
) &&
268 (!util_is_power_of_two(width
) ||
269 !util_is_power_of_two(height
)))
272 /* create the destination texture */
273 memset(&dst_templ
, 0, sizeof(dst_templ
));
274 dst_templ
.target
= PIPE_TEXTURE_2D
;
275 dst_templ
.format
= dst_format
;
276 if (util_format_is_depth_or_stencil(dst_format
))
277 dst_templ
.bind
|= PIPE_BIND_DEPTH_STENCIL
;
279 dst_templ
.bind
|= PIPE_BIND_RENDER_TARGET
;
280 dst_templ
.usage
= PIPE_USAGE_STAGING
;
282 st_gl_texture_dims_to_pipe_dims(GL_TEXTURE_2D
, width
, height
, 1,
283 &dst_templ
.width0
, &dst_templ
.height0
,
284 &dst_templ
.depth0
, &dst_templ
.array_size
);
286 dst
= screen
->resource_create(screen
, &dst_templ
);
290 memset(&blit
, 0, sizeof(blit
));
291 blit
.src
.resource
= strb
->texture
;
292 blit
.src
.level
= strb
->surface
->u
.tex
.level
;
293 blit
.src
.format
= src_format
;
294 blit
.dst
.resource
= dst
;
296 blit
.dst
.format
= dst
->format
;
301 blit
.src
.box
.z
= strb
->surface
->u
.tex
.first_layer
;
303 blit
.src
.box
.width
= blit
.dst
.box
.width
= width
;
304 blit
.src
.box
.height
= blit
.dst
.box
.height
= height
;
305 blit
.src
.box
.depth
= blit
.dst
.box
.depth
= 1;
306 blit
.mask
= st_get_blit_mask(strb
->Base
._BaseFormat
, format
);
307 blit
.filter
= PIPE_TEX_FILTER_NEAREST
;
308 blit
.scissor_enable
= FALSE
;
311 blit
.src
.box
.y
= strb
->Base
.Height
- blit
.src
.box
.y
;
312 blit
.src
.box
.height
= -blit
.src
.box
.height
;
316 st
->pipe
->blit(st
->pipe
, &blit
);
321 static struct pipe_resource
*
322 try_cached_readpixels(struct st_context
*st
, struct st_renderbuffer
*strb
,
324 GLsizei width
, GLsizei height
,
326 enum pipe_format src_format
, enum pipe_format dst_format
)
328 struct pipe_resource
*src
= strb
->texture
;
329 struct pipe_resource
*dst
= NULL
;
331 if (ST_DEBUG
& DEBUG_NOREADPIXCACHE
)
334 /* Reset cache after invalidation or switch of parameters. */
335 if (st
->readpix_cache
.src
!= src
||
336 st
->readpix_cache
.dst_format
!= dst_format
||
337 st
->readpix_cache
.level
!= strb
->surface
->u
.tex
.level
||
338 st
->readpix_cache
.layer
!= strb
->surface
->u
.tex
.first_layer
) {
339 pipe_resource_reference(&st
->readpix_cache
.src
, src
);
340 pipe_resource_reference(&st
->readpix_cache
.cache
, NULL
);
341 st
->readpix_cache
.dst_format
= dst_format
;
342 st
->readpix_cache
.level
= strb
->surface
->u
.tex
.level
;
343 st
->readpix_cache
.layer
= strb
->surface
->u
.tex
.first_layer
;
344 st
->readpix_cache
.hits
= 0;
347 /* Decide whether to trigger the cache. */
348 if (!st
->readpix_cache
.cache
) {
349 if (!strb
->use_readpix_cache
&& !ALWAYS_READPIXELS_CACHE
) {
350 /* Heuristic: If previous successive calls read at least a fraction
351 * of the surface _and_ we read again, trigger the cache.
353 unsigned threshold
= MAX2(1, strb
->Base
.Width
* strb
->Base
.Height
/ 8);
355 if (st
->readpix_cache
.hits
< threshold
) {
356 st
->readpix_cache
.hits
+= width
* height
;
360 strb
->use_readpix_cache
= true;
364 st
->readpix_cache
.cache
= blit_to_staging(st
, strb
, invert_y
,
367 strb
->Base
.Height
, format
,
368 src_format
, dst_format
);
371 /* Return an owning reference to stay consistent with the non-cached path */
372 pipe_resource_reference(&dst
, st
->readpix_cache
.cache
);
378 * This uses a blit to copy the read buffer to a texture format which matches
379 * the format and type combo and then a fast read-back is done using memcpy.
380 * We can do arbitrary X/Y/Z/W/0/1 swizzling here as long as there is
381 * a format which matches the swizzling.
383 * If such a format isn't available, we fall back to _mesa_readpixels.
385 * NOTE: Some drivers use a blit to convert between tiled and linear
386 * texture layouts during texture uploads/downloads, so the blit
387 * we do here should be free in such cases.
390 st_ReadPixels(struct gl_context
*ctx
, GLint x
, GLint y
,
391 GLsizei width
, GLsizei height
,
392 GLenum format
, GLenum type
,
393 const struct gl_pixelstore_attrib
*pack
,
396 struct st_context
*st
= st_context(ctx
);
397 struct gl_renderbuffer
*rb
=
398 _mesa_get_read_renderbuffer_for_format(ctx
, format
);
399 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
400 struct pipe_context
*pipe
= st
->pipe
;
401 struct pipe_screen
*screen
= pipe
->screen
;
402 struct pipe_resource
*src
;
403 struct pipe_resource
*dst
= NULL
;
404 enum pipe_format dst_format
, src_format
;
406 struct pipe_transfer
*tex_xfer
;
410 /* Validate state (to be sure we have up-to-date framebuffer surfaces)
411 * and flush the bitmap cache prior to reading. */
412 st_validate_state(st
, ST_PIPELINE_RENDER
);
413 st_flush_bitmap_cache(st
);
415 if (!st
->prefer_blit_based_texture_transfer
) {
419 /* This must be done after state validation. */
422 /* XXX Fallback for depth-stencil formats due to an incomplete
423 * stencil blit implementation in some drivers. */
424 if (format
== GL_DEPTH_STENCIL
) {
428 /* If the base internal format and the texture format don't match, we have
429 * to use the slow path. */
430 if (rb
->_BaseFormat
!=
431 _mesa_get_format_base_format(rb
->Format
)) {
435 if (_mesa_readpixels_needs_slow_path(ctx
, format
, type
, GL_TRUE
)) {
439 /* Convert the source format to what is expected by ReadPixels
440 * and see if it's supported. */
441 src_format
= util_format_linear(src
->format
);
442 src_format
= util_format_luminance_to_red(src_format
);
443 src_format
= util_format_intensity_to_red(src_format
);
446 !screen
->is_format_supported(screen
, src_format
, src
->target
,
448 PIPE_BIND_SAMPLER_VIEW
)) {
452 if (format
== GL_DEPTH_COMPONENT
|| format
== GL_DEPTH_STENCIL
)
453 bind
= PIPE_BIND_DEPTH_STENCIL
;
455 bind
= PIPE_BIND_RENDER_TARGET
;
457 /* Choose the destination format by finding the best match
458 * for the format+type combo. */
459 dst_format
= st_choose_matching_format(st
, bind
, format
, type
,
461 if (dst_format
== PIPE_FORMAT_NONE
) {
465 if (st
->pbo
.download_enabled
&& _mesa_is_bufferobj(pack
->BufferObj
)) {
466 if (try_pbo_readpixels(st
, strb
,
467 st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
,
469 src_format
, dst_format
,
474 if (needs_integer_signed_unsigned_conversion(ctx
, format
, type
)) {
478 /* Cache a staging texture for back-to-back ReadPixels, to avoid CPU-GPU
479 * synchronization overhead.
481 dst
= try_cached_readpixels(st
, strb
,
482 st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
,
483 width
, height
, format
, src_format
, dst_format
);
488 /* See if the texture format already matches the format and type,
489 * in which case the memcpy-based fast path will likely be used and
490 * we don't have to blit. */
491 if (_mesa_format_matches_format_and_type(rb
->Format
, format
,
492 type
, pack
->SwapBytes
, NULL
)) {
496 dst
= blit_to_staging(st
, strb
,
497 st_fb_orientation(ctx
->ReadBuffer
) == Y_0_TOP
,
498 x
, y
, width
, height
, format
,
499 src_format
, dst_format
);
508 pixels
= _mesa_map_pbo_dest(ctx
, pack
, pixels
);
510 map
= pipe_transfer_map_3d(pipe
, dst
, 0, PIPE_TRANSFER_READ
,
511 dst_x
, dst_y
, 0, width
, height
, 1, &tex_xfer
);
513 _mesa_unmap_pbo_dest(ctx
, pack
);
514 pipe_resource_reference(&dst
, NULL
);
518 /* memcpy data into a user buffer */
520 const uint bytesPerRow
= width
* util_format_get_blocksize(dst_format
);
521 const int destStride
= _mesa_image_row_stride(pack
, width
, format
, type
);
522 char *dest
= _mesa_image_address2d(pack
, pixels
,
523 width
, height
, format
,
526 if (tex_xfer
->stride
== bytesPerRow
&& destStride
== bytesPerRow
) {
527 memcpy(dest
, map
, bytesPerRow
* height
);
531 for (row
= 0; row
< (unsigned) height
; row
++) {
532 memcpy(dest
, map
, bytesPerRow
);
533 map
+= tex_xfer
->stride
;
539 pipe_transfer_unmap(pipe
, tex_xfer
);
540 _mesa_unmap_pbo_dest(ctx
, pack
);
541 pipe_resource_reference(&dst
, NULL
);
545 _mesa_readpixels(ctx
, x
, y
, width
, height
, format
, type
, pack
, pixels
);
548 void st_init_readpixels_functions(struct dd_function_table
*functions
)
550 functions
->ReadPixels
= st_ReadPixels
;