1/************************************************************************** 2 * 3 * Copyright 2008 VMware, Inc. 4 * All Rights Reserved. 5 * 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: 13 * 14 * The above copyright notice and this permission notice (including the 15 * next paragraph) shall be included in all copies or substantial portions 16 * of the Software. 17 * 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. 25 * 26 **************************************************************************/ 27 28/** 29 * @file 30 * Copy/blit pixel rect between surfaces 31 * 32 * @author Brian Paul 33 */ 34 35 36#include "pipe/p_context.h" 37#include "util/u_debug.h" 38#include "pipe/p_defines.h" 39#include "util/u_inlines.h" 40#include "pipe/p_shader_tokens.h" 41#include "pipe/p_state.h" 42 43#include "util/u_blit.h" 44#include "util/u_draw_quad.h" 45#include "util/u_format.h" 46#include "util/u_math.h" 47#include "util/u_memory.h" 48#include "util/u_sampler.h" 49#include "util/u_texture.h" 50#include "util/u_simple_shaders.h" 51 52#include "cso_cache/cso_context.h" 53 54 55struct blit_state 56{ 57 struct pipe_context *pipe; 58 struct cso_context *cso; 59 60 struct pipe_blend_state blend_write_color; 61 struct pipe_depth_stencil_alpha_state dsa_keep_depthstencil; 62 struct pipe_rasterizer_state rasterizer; 63 struct pipe_sampler_state sampler; 64 struct pipe_viewport_state viewport; 65 struct pipe_vertex_element velem[2]; 66 67 void *vs; 68 void *fs[PIPE_MAX_TEXTURE_TYPES][4]; 69 70 struct pipe_resource *vbuf; /**< quad vertices */ 71 unsigned vbuf_slot; 72 73 float vertices[4][2][4]; /**< vertex/texcoords for quad */ 74}; 75 76 77/** 78 * Create state object for blit. 79 * Intended to be created once and re-used for many blit() calls. 80 */ 81struct blit_state * 82util_create_blit(struct pipe_context *pipe, struct cso_context *cso) 83{ 84 struct blit_state *ctx; 85 uint i; 86 87 ctx = CALLOC_STRUCT(blit_state); 88 if (!ctx) 89 return NULL; 90 91 ctx->pipe = pipe; 92 ctx->cso = cso; 93 94 /* disabled blending/masking */ 95 ctx->blend_write_color.rt[0].colormask = PIPE_MASK_RGBA; 96 97 /* rasterizer */ 98 ctx->rasterizer.cull_face = PIPE_FACE_NONE; 99 ctx->rasterizer.half_pixel_center = 1; 100 ctx->rasterizer.bottom_edge_rule = 1; 101 ctx->rasterizer.depth_clip_near = 1; 102 ctx->rasterizer.depth_clip_far = 1; 103 104 /* samplers */ 105 ctx->sampler.wrap_s = PIPE_TEX_WRAP_CLAMP_TO_EDGE; 106 ctx->sampler.wrap_t = PIPE_TEX_WRAP_CLAMP_TO_EDGE; 107 ctx->sampler.wrap_r = PIPE_TEX_WRAP_CLAMP_TO_EDGE; 108 ctx->sampler.min_mip_filter = PIPE_TEX_MIPFILTER_NONE; 109 ctx->sampler.min_img_filter = 0; /* set later */ 110 ctx->sampler.mag_img_filter = 0; /* set later */ 111 112 /* vertex elements state */ 113 for (i = 0; i < 2; i++) { 114 ctx->velem[i].src_offset = i * 4 * sizeof(float); 115 ctx->velem[i].instance_divisor = 0; 116 ctx->velem[i].vertex_buffer_index = 0; 117 ctx->velem[i].src_format = PIPE_FORMAT_R32G32B32A32_FLOAT; 118 } 119 120 ctx->vbuf = NULL; 121 122 /* init vertex data that doesn't change */ 123 for (i = 0; i < 4; i++) { 124 ctx->vertices[i][0][3] = 1.0f; /* w */ 125 ctx->vertices[i][1][3] = 1.0f; /* q */ 126 } 127 128 return ctx; 129} 130 131 132/** 133 * Destroy a blit context 134 */ 135void 136util_destroy_blit(struct blit_state *ctx) 137{ 138 struct pipe_context *pipe = ctx->pipe; 139 unsigned i, j; 140 141 if (ctx->vs) 142 pipe->delete_vs_state(pipe, ctx->vs); 143 144 for (i = 0; i < ARRAY_SIZE(ctx->fs); i++) { 145 for (j = 0; j < ARRAY_SIZE(ctx->fs[i]); j++) { 146 if (ctx->fs[i][j]) 147 pipe->delete_fs_state(pipe, ctx->fs[i][j]); 148 } 149 } 150 151 pipe_resource_reference(&ctx->vbuf, NULL); 152 153 FREE(ctx); 154} 155 156 157/** 158 * Helper function to set the fragment shaders. 159 */ 160static inline void 161set_fragment_shader(struct blit_state *ctx, 162 enum pipe_format format, 163 boolean src_xrbias, 164 enum pipe_texture_target pipe_tex) 165{ 166 enum tgsi_return_type stype; 167 unsigned idx; 168 169 if (util_format_is_pure_uint(format)) { 170 stype = TGSI_RETURN_TYPE_UINT; 171 idx = 0; 172 } else if (util_format_is_pure_sint(format)) { 173 stype = TGSI_RETURN_TYPE_SINT; 174 idx = 1; 175 } else { 176 stype = TGSI_RETURN_TYPE_FLOAT; 177 idx = 2; 178 } 179 180 if (src_xrbias) { 181 assert(stype == TGSI_RETURN_TYPE_FLOAT); 182 idx = 3; 183 if (!ctx->fs[pipe_tex][idx]) { 184 enum tgsi_texture_type tgsi_tex = 185 util_pipe_tex_to_tgsi_tex(pipe_tex, 0); 186 ctx->fs[pipe_tex][idx] = 187 util_make_fragment_tex_shader_xrbias(ctx->pipe, tgsi_tex); 188 } 189 } 190 else if (!ctx->fs[pipe_tex][idx]) { 191 enum tgsi_texture_type tgsi_tex = util_pipe_tex_to_tgsi_tex(pipe_tex, 0); 192 193 /* OpenGL does not allow blits from signed to unsigned integer 194 * or vice versa. */ 195 ctx->fs[pipe_tex][idx] = 196 util_make_fragment_tex_shader_writemask(ctx->pipe, tgsi_tex, 197 TGSI_INTERPOLATE_LINEAR, 198 TGSI_WRITEMASK_XYZW, 199 stype, stype, false, false); 200 } 201 202 cso_set_fragment_shader_handle(ctx->cso, ctx->fs[pipe_tex][idx]); 203} 204 205 206/** 207 * Helper function to set the vertex shader. 208 */ 209static inline void 210set_vertex_shader(struct blit_state *ctx) 211{ 212 /* vertex shader - still required to provide the linkage between 213 * fragment shader input semantics and vertex_element/buffers. 214 */ 215 if (!ctx->vs) { 216 const enum tgsi_semantic semantic_names[] = { 217 TGSI_SEMANTIC_POSITION, 218 TGSI_SEMANTIC_GENERIC 219 }; 220 const uint semantic_indexes[] = { 0, 0 }; 221 ctx->vs = util_make_vertex_passthrough_shader(ctx->pipe, 2, 222 semantic_names, 223 semantic_indexes, FALSE); 224 } 225 226 cso_set_vertex_shader_handle(ctx->cso, ctx->vs); 227} 228 229 230/** 231 * Get offset of next free slot in vertex buffer for quad vertices. 232 */ 233static unsigned 234get_next_slot(struct blit_state *ctx) 235{ 236 const unsigned max_slots = 4096 / sizeof ctx->vertices; 237 238 if (ctx->vbuf_slot >= max_slots) { 239 pipe_resource_reference(&ctx->vbuf, NULL); 240 ctx->vbuf_slot = 0; 241 } 242 243 if (!ctx->vbuf) { 244 ctx->vbuf = pipe_buffer_create(ctx->pipe->screen, 245 PIPE_BIND_VERTEX_BUFFER, 246 PIPE_USAGE_STREAM, 247 max_slots * sizeof ctx->vertices); 248 } 249 250 return ctx->vbuf_slot++ * sizeof ctx->vertices; 251} 252 253 254 255 256/** 257 * Setup vertex data for the textured quad we'll draw. 258 * Note: y=0=top 259 * 260 * FIXME: We should call util_map_texcoords2d_onto_cubemap 261 * for cubemaps. 262 */ 263static unsigned 264setup_vertex_data_tex(struct blit_state *ctx, 265 enum pipe_texture_target src_target, 266 unsigned src_face, 267 float x0, float y0, float x1, float y1, 268 float s0, float t0, float s1, float t1, 269 float z) 270{ 271 unsigned offset; 272 273 ctx->vertices[0][0][0] = x0; 274 ctx->vertices[0][0][1] = y0; 275 ctx->vertices[0][0][2] = z; 276 ctx->vertices[0][1][0] = s0; /*s*/ 277 ctx->vertices[0][1][1] = t0; /*t*/ 278 ctx->vertices[0][1][2] = 0; /*r*/ 279 280 ctx->vertices[1][0][0] = x1; 281 ctx->vertices[1][0][1] = y0; 282 ctx->vertices[1][0][2] = z; 283 ctx->vertices[1][1][0] = s1; /*s*/ 284 ctx->vertices[1][1][1] = t0; /*t*/ 285 ctx->vertices[1][1][2] = 0; /*r*/ 286 287 ctx->vertices[2][0][0] = x1; 288 ctx->vertices[2][0][1] = y1; 289 ctx->vertices[2][0][2] = z; 290 ctx->vertices[2][1][0] = s1; 291 ctx->vertices[2][1][1] = t1; 292 ctx->vertices[3][1][2] = 0; 293 294 ctx->vertices[3][0][0] = x0; 295 ctx->vertices[3][0][1] = y1; 296 ctx->vertices[3][0][2] = z; 297 ctx->vertices[3][1][0] = s0; 298 ctx->vertices[3][1][1] = t1; 299 ctx->vertices[3][1][2] = 0; 300 301 if (src_target == PIPE_TEXTURE_CUBE || 302 src_target == PIPE_TEXTURE_CUBE_ARRAY) { 303 /* Map cubemap texture coordinates inplace. */ 304 const unsigned stride = 305 sizeof ctx->vertices[0] / sizeof ctx->vertices[0][0][0]; 306 util_map_texcoords2d_onto_cubemap(src_face, 307 &ctx->vertices[0][1][0], stride, 308 &ctx->vertices[0][1][0], stride, 309 TRUE); 310 } 311 312 offset = get_next_slot(ctx); 313 314 if (ctx->vbuf) { 315 pipe_buffer_write_nooverlap(ctx->pipe, ctx->vbuf, 316 offset, sizeof(ctx->vertices), ctx->vertices); 317 } 318 319 return offset; 320} 321 322 323/** 324 * \return TRUE if two regions overlap, FALSE otherwise 325 */ 326static boolean 327regions_overlap(int srcX0, int srcY0, 328 int srcX1, int srcY1, 329 int dstX0, int dstY0, 330 int dstX1, int dstY1) 331{ 332 if (MAX2(srcX0, srcX1) <= MIN2(dstX0, dstX1)) 333 return FALSE; /* src completely left of dst */ 334 335 if (MAX2(dstX0, dstX1) <= MIN2(srcX0, srcX1)) 336 return FALSE; /* dst completely left of src */ 337 338 if (MAX2(srcY0, srcY1) <= MIN2(dstY0, dstY1)) 339 return FALSE; /* src completely above dst */ 340 341 if (MAX2(dstY0, dstY1) <= MIN2(srcY0, srcY1)) 342 return FALSE; /* dst completely above src */ 343 344 return TRUE; /* some overlap */ 345} 346 347 348/** 349 * Can we blit from src format to dest format with a simple copy? 350 */ 351static boolean 352formats_compatible(enum pipe_format src_format, 353 enum pipe_format dst_format) 354{ 355 if (src_format == dst_format) { 356 return TRUE; 357 } 358 else { 359 const struct util_format_description *src_desc = 360 util_format_description(src_format); 361 const struct util_format_description *dst_desc = 362 util_format_description(dst_format); 363 return util_is_format_compatible(src_desc, dst_desc); 364 } 365} 366 367 368/** 369 * Copy pixel block from src surface to dst surface. 370 * Overlapping regions are acceptable. 371 * Flipping and stretching are supported. 372 * \param filter one of PIPE_TEX_FILTER_NEAREST/LINEAR 373 * \param writemask bitmask of PIPE_MASK_[RGBAZS]. Controls which channels 374 * in the dest surface are sourced from the src surface. 375 * Disabled color channels are sourced from (0,0,0,1). 376 */ 377void 378util_blit_pixels(struct blit_state *ctx, 379 struct pipe_resource *src_tex, 380 unsigned src_level, 381 int srcX0, int srcY0, 382 int srcX1, int srcY1, 383 int srcZ0, 384 struct pipe_surface *dst, 385 int dstX0, int dstY0, 386 int dstX1, int dstY1, 387 MAYBE_UNUSED float z, 388 enum pipe_tex_filter filter, 389 uint writemask) 390{ 391 struct pipe_context *pipe = ctx->pipe; 392 enum pipe_format src_format, dst_format; 393 const int srcW = abs(srcX1 - srcX0); 394 const int srcH = abs(srcY1 - srcY0); 395 boolean overlap; 396 boolean is_stencil, is_depth, blit_depth, blit_stencil; 397 const struct util_format_description *src_desc = 398 util_format_description(src_tex->format); 399 struct pipe_blit_info info; 400 401 assert(filter == PIPE_TEX_FILTER_NEAREST || 402 filter == PIPE_TEX_FILTER_LINEAR); 403 404 assert(src_level <= src_tex->last_level); 405 406 /* do the regions overlap? */ 407 overlap = src_tex == dst->texture && 408 dst->u.tex.level == src_level && 409 dst->u.tex.first_layer == srcZ0 && 410 regions_overlap(srcX0, srcY0, srcX1, srcY1, 411 dstX0, dstY0, dstX1, dstY1); 412 413 src_format = util_format_linear(src_tex->format); 414 dst_format = util_format_linear(dst->texture->format); 415 416 /* See whether we will blit depth or stencil. */ 417 is_depth = util_format_has_depth(src_desc); 418 is_stencil = util_format_has_stencil(src_desc); 419 420 blit_depth = is_depth && (writemask & PIPE_MASK_Z); 421 blit_stencil = is_stencil && (writemask & PIPE_MASK_S); 422 423 if (is_depth || is_stencil) { 424 assert((writemask & PIPE_MASK_RGBA) == 0); 425 assert(blit_depth || blit_stencil); 426 } 427 else { 428 assert((writemask & PIPE_MASK_ZS) == 0); 429 assert(!blit_depth); 430 assert(!blit_stencil); 431 } 432 433 /* 434 * XXX: z parameter is deprecated. dst->u.tex.first_layer 435 * specificies the destination layer. 436 */ 437 assert(z == 0.0f); 438 439 /* 440 * Check for simple case: no format conversion, no flipping, no stretching, 441 * no overlapping, same number of samples. 442 * Filter mode should not matter since there's no stretching. 443 */ 444 if (formats_compatible(src_format, dst_format) && 445 src_tex->nr_samples == dst->texture->nr_samples && 446 is_stencil == blit_stencil && 447 is_depth == blit_depth && 448 srcX0 < srcX1 && 449 dstX0 < dstX1 && 450 srcY0 < srcY1 && 451 dstY0 < dstY1 && 452 (dstX1 - dstX0) == (srcX1 - srcX0) && 453 (dstY1 - dstY0) == (srcY1 - srcY0) && 454 !overlap) { 455 struct pipe_box src_box; 456 src_box.x = srcX0; 457 src_box.y = srcY0; 458 src_box.z = srcZ0; 459 src_box.width = srcW; 460 src_box.height = srcH; 461 src_box.depth = 1; 462 pipe->resource_copy_region(pipe, 463 dst->texture, dst->u.tex.level, 464 dstX0, dstY0, dst->u.tex.first_layer,/* dest */ 465 src_tex, src_level, 466 &src_box); 467 return; 468 } 469 470 memset(&info, 0, sizeof info); 471 info.dst.resource = dst->texture; 472 info.dst.level = dst->u.tex.level; 473 info.dst.box.x = dstX0; 474 info.dst.box.y = dstY0; 475 info.dst.box.z = dst->u.tex.first_layer; 476 info.dst.box.width = dstX1 - dstX0; 477 info.dst.box.height = dstY1 - dstY0; 478 assert(info.dst.box.width >= 0); 479 assert(info.dst.box.height >= 0); 480 info.dst.box.depth = 1; 481 info.dst.format = dst_format; 482 info.src.resource = src_tex; 483 info.src.level = src_level; 484 info.src.box.x = srcX0; 485 info.src.box.y = srcY0; 486 info.src.box.z = srcZ0; 487 info.src.box.width = srcX1 - srcX0; 488 info.src.box.height = srcY1 - srcY0; 489 info.src.box.depth = 1; 490 info.src.format = src_format; 491 info.mask = writemask; 492 info.filter = filter; 493 info.scissor_enable = 0; 494 495 pipe->blit(pipe, &info); 496} 497 498 499/** 500 * Copy pixel block from src sampler view to dst surface. 501 * 502 * The sampler view's first_level field indicates the source 503 * mipmap level to use. 504 * 505 * The sampler view's first_layer indicate the layer to use, but for 506 * cube maps it must point to the first face. Face is passed in src_face. 507 * 508 * The main advantage over util_blit_pixels is that it allows to specify 509 * swizzles in pipe_sampler_view::swizzle_?. 510 * 511 * But there is no control over blitting Z and/or stencil. 512 */ 513void 514util_blit_pixels_tex(struct blit_state *ctx, 515 struct pipe_sampler_view *src_sampler_view, 516 int srcX0, int srcY0, 517 int srcX1, int srcY1, 518 unsigned src_face, 519 struct pipe_surface *dst, 520 int dstX0, int dstY0, 521 int dstX1, int dstY1, 522 float z, enum pipe_tex_filter filter, 523 boolean src_xrbias) 524{ 525 boolean normalized = src_sampler_view->texture->target != PIPE_TEXTURE_RECT; 526 struct pipe_framebuffer_state fb; 527 float s0, t0, s1, t1; 528 unsigned offset; 529 struct pipe_resource *tex = src_sampler_view->texture; 530 531 assert(filter == PIPE_TEX_FILTER_NEAREST || 532 filter == PIPE_TEX_FILTER_LINEAR); 533 534 assert(tex); 535 assert(tex->width0 != 0); 536 assert(tex->height0 != 0); 537 538 s0 = (float) srcX0; 539 s1 = (float) srcX1; 540 t0 = (float) srcY0; 541 t1 = (float) srcY1; 542 543 if (normalized) { 544 /* normalize according to the mipmap level's size */ 545 int level = src_sampler_view->u.tex.first_level; 546 float w = (float) u_minify(tex->width0, level); 547 float h = (float) u_minify(tex->height0, level); 548 s0 /= w; 549 s1 /= w; 550 t0 /= h; 551 t1 /= h; 552 } 553 554 assert(ctx->pipe->screen->is_format_supported(ctx->pipe->screen, dst->format, 555 PIPE_TEXTURE_2D, 556 dst->texture->nr_samples, 557 dst->texture->nr_storage_samples, 558 PIPE_BIND_RENDER_TARGET)); 559 560 /* save state (restored below) */ 561 cso_save_state(ctx->cso, (CSO_BIT_BLEND | 562 CSO_BIT_DEPTH_STENCIL_ALPHA | 563 CSO_BIT_RASTERIZER | 564 CSO_BIT_SAMPLE_MASK | 565 CSO_BIT_MIN_SAMPLES | 566 CSO_BIT_FRAGMENT_SAMPLERS | 567 CSO_BIT_FRAGMENT_SAMPLER_VIEWS | 568 CSO_BIT_STREAM_OUTPUTS | 569 CSO_BIT_VIEWPORT | 570 CSO_BIT_FRAMEBUFFER | 571 CSO_BIT_PAUSE_QUERIES | 572 CSO_BIT_FRAGMENT_SHADER | 573 CSO_BIT_VERTEX_SHADER | 574 CSO_BIT_TESSCTRL_SHADER | 575 CSO_BIT_TESSEVAL_SHADER | 576 CSO_BIT_GEOMETRY_SHADER | 577 CSO_BIT_VERTEX_ELEMENTS | 578 CSO_BIT_AUX_VERTEX_BUFFER_SLOT)); 579 580 /* set misc state we care about */ 581 cso_set_blend(ctx->cso, &ctx->blend_write_color); 582 cso_set_depth_stencil_alpha(ctx->cso, &ctx->dsa_keep_depthstencil); 583 cso_set_sample_mask(ctx->cso, ~0); 584 cso_set_min_samples(ctx->cso, 1); 585 cso_set_rasterizer(ctx->cso, &ctx->rasterizer); 586 cso_set_vertex_elements(ctx->cso, 2, ctx->velem); 587 cso_set_stream_outputs(ctx->cso, 0, NULL, NULL); 588 589 /* sampler */ 590 ctx->sampler.normalized_coords = normalized; 591 ctx->sampler.min_img_filter = filter; 592 ctx->sampler.mag_img_filter = filter; 593 { 594 const struct pipe_sampler_state *samplers[] = {&ctx->sampler}; 595 cso_set_samplers(ctx->cso, PIPE_SHADER_FRAGMENT, 1, samplers); 596 } 597 598 /* viewport */ 599 ctx->viewport.scale[0] = 0.5f * dst->width; 600 ctx->viewport.scale[1] = 0.5f * dst->height; 601 ctx->viewport.scale[2] = 0.5f; 602 ctx->viewport.translate[0] = 0.5f * dst->width; 603 ctx->viewport.translate[1] = 0.5f * dst->height; 604 ctx->viewport.translate[2] = 0.5f; 605 cso_set_viewport(ctx->cso, &ctx->viewport); 606 607 /* texture */ 608 cso_set_sampler_views(ctx->cso, PIPE_SHADER_FRAGMENT, 1, &src_sampler_view); 609 610 /* shaders */ 611 set_fragment_shader(ctx, src_sampler_view->format, 612 src_xrbias, 613 src_sampler_view->texture->target); 614 set_vertex_shader(ctx); 615 cso_set_tessctrl_shader_handle(ctx->cso, NULL); 616 cso_set_tesseval_shader_handle(ctx->cso, NULL); 617 cso_set_geometry_shader_handle(ctx->cso, NULL); 618 619 /* drawing dest */ 620 memset(&fb, 0, sizeof(fb)); 621 fb.width = dst->width; 622 fb.height = dst->height; 623 fb.nr_cbufs = 1; 624 fb.cbufs[0] = dst; 625 cso_set_framebuffer(ctx->cso, &fb); 626 627 /* draw quad */ 628 offset = setup_vertex_data_tex(ctx, 629 src_sampler_view->texture->target, 630 src_face, 631 (float) dstX0 / dst->width * 2.0f - 1.0f, 632 (float) dstY0 / dst->height * 2.0f - 1.0f, 633 (float) dstX1 / dst->width * 2.0f - 1.0f, 634 (float) dstY1 / dst->height * 2.0f - 1.0f, 635 s0, t0, s1, t1, 636 z); 637 638 util_draw_vertex_buffer(ctx->pipe, ctx->cso, ctx->vbuf, 0, 639 offset, 640 PIPE_PRIM_TRIANGLE_FAN, 641 4, /* verts */ 642 2); /* attribs/vert */ 643 644 /* restore state we changed */ 645 cso_restore_state(ctx->cso); 646} 647