src/gallium/auxiliary/gallivm/lp_bld_sample.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 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  * Texture sampling.
  31  *
  32  * @author Jose Fonseca <jfonseca@vmware.com>
  33  */
  34
  35 #ifndef LP_BLD_SAMPLE_H
  36 #define LP_BLD_SAMPLE_H
  37
  38
  39 #include "pipe/p_format.h"
  40 #include "util/u_debug.h"
  41 #include "gallivm/lp_bld.h"
  42 #include "gallivm/lp_bld_type.h"
  43 #include "gallivm/lp_bld_swizzle.h"
  44
  45
  46 struct pipe_resource;
  47 struct pipe_sampler_view;
  48 struct pipe_sampler_state;
  49 struct util_format_description;
  50 struct lp_type;
  51 struct lp_build_context;
  52
  53
  54 /**
  55  * Sampler static state.
  56  *
  57  * These are the bits of state from pipe_resource and pipe_sampler_state that
  58  * are embedded in the generated code.
  59  */
  60 struct lp_sampler_static_state
  61 {
  62    /* pipe_sampler_view's state */
  63    enum pipe_format format;
  64    unsigned swizzle_r:3;     /**< PIPE_SWIZZLE_* */
  65    unsigned swizzle_g:3;
  66    unsigned swizzle_b:3;
  67    unsigned swizzle_a:3;
  68
  69    /* pipe_texture's state */
  70    unsigned target:3;        /**< PIPE_TEXTURE_* */
  71    unsigned pot_width:1;     /**< is the width a power of two? */
  72    unsigned pot_height:1;
  73    unsigned pot_depth:1;
  74
  75    /* pipe_sampler_state's state */
  76    unsigned wrap_s:3;
  77    unsigned wrap_t:3;
  78    unsigned wrap_r:3;
  79    unsigned min_img_filter:2;
  80    unsigned min_mip_filter:2;
  81    unsigned mag_img_filter:2;
  82    unsigned compare_mode:1;
  83    unsigned compare_func:3;
  84    unsigned normalized_coords:1;
  85    unsigned min_max_lod_equal:1;  /**< min_lod == max_lod ? */
  86 };
  87
  88
  89 /**
  90  * Sampler dynamic state.
  91  *
  92  * These are the bits of state from pipe_resource and pipe_sampler_state that
  93  * are computed in runtime.
  94  *
  95  * There are obtained through callbacks, as we don't want to tie the texture
  96  * sampling code generation logic to any particular texture layout or pipe
  97  * driver.
  98  */
  99 struct lp_sampler_dynamic_state
 100 {
 101
 102    /** Obtain the base texture width. */
 103    LLVMValueRef
 104    (*width)( const struct lp_sampler_dynamic_state *state,
 105              LLVMBuilderRef builder,
 106              unsigned unit);
 107
 108    /** Obtain the base texture height. */
 109    LLVMValueRef
 110    (*height)( const struct lp_sampler_dynamic_state *state,
 111               LLVMBuilderRef builder,
 112               unsigned unit);
 113
 114    /** Obtain the base texture depth. */
 115    LLVMValueRef
 116    (*depth)( const struct lp_sampler_dynamic_state *state,
 117              LLVMBuilderRef builder,
 118              unsigned unit);
 119
 120    /** Obtain the number of mipmap levels (minus one). */
 121    LLVMValueRef
 122    (*last_level)( const struct lp_sampler_dynamic_state *state,
 123                   LLVMBuilderRef builder,
 124                   unsigned unit);
 125
 126    LLVMValueRef
 127    (*row_stride)( const struct lp_sampler_dynamic_state *state,
 128                   LLVMBuilderRef builder,
 129                   unsigned unit);
 130
 131    LLVMValueRef
 132    (*img_stride)( const struct lp_sampler_dynamic_state *state,
 133                   LLVMBuilderRef builder,
 134                   unsigned unit);
 135
 136    LLVMValueRef
 137    (*data_ptr)( const struct lp_sampler_dynamic_state *state,
 138                 LLVMBuilderRef builder,
 139                 unsigned unit);
 140
 141    /** Obtain texture min lod */
 142    LLVMValueRef
 143    (*min_lod)(const struct lp_sampler_dynamic_state *state,
 144               LLVMBuilderRef builder, unsigned unit);
 145
 146    /** Obtain texture max lod */
 147    LLVMValueRef
 148    (*max_lod)(const struct lp_sampler_dynamic_state *state,
 149               LLVMBuilderRef builder, unsigned unit);
 150
 151    /** Obtain texture lod bias */
 152    LLVMValueRef
 153    (*lod_bias)(const struct lp_sampler_dynamic_state *state,
 154                LLVMBuilderRef builder, unsigned unit);
 155
 156    /** Obtain texture border color */
 157    LLVMValueRef
 158    (*border_color)(const struct lp_sampler_dynamic_state *state,
 159                    LLVMBuilderRef builder, unsigned unit);
 160 };
 161
 162
 163 /**
 164  * Keep all information for sampling code generation in a single place.
 165  */
 166 struct lp_build_sample_context
 167 {
 168    LLVMBuilderRef builder;
 169
 170    const struct lp_sampler_static_state *static_state;
 171
 172    struct lp_sampler_dynamic_state *dynamic_state;
 173
 174    const struct util_format_description *format_desc;
 175
 176    /** regular scalar float type */
 177    struct lp_type float_type;
 178    struct lp_build_context float_bld;
 179
 180    /** float vector type */
 181    struct lp_build_context float_vec_bld;
 182
 183    /** regular scalar float type */
 184    struct lp_type int_type;
 185    struct lp_build_context int_bld;
 186
 187    /** Incoming coordinates type and build context */
 188    struct lp_type coord_type;
 189    struct lp_build_context coord_bld;
 190
 191    /** Unsigned integer coordinates */
 192    struct lp_type uint_coord_type;
 193    struct lp_build_context uint_coord_bld;
 194
 195    /** Signed integer coordinates */
 196    struct lp_type int_coord_type;
 197    struct lp_build_context int_coord_bld;
 198
 199    /** Output texels type and build context */
 200    struct lp_type texel_type;
 201    struct lp_build_context texel_bld;
 202 };
 203
 204
 205
 206 /**
 207  * We only support a few wrap modes in lp_build_sample_wrap_linear_int() at
 208  * this time.  Return whether the given mode is supported by that function.
 209  */
 210 static INLINE boolean
 211 lp_is_simple_wrap_mode(unsigned mode)
 212 {
 213    switch (mode) {
 214    case PIPE_TEX_WRAP_REPEAT:
 215    case PIPE_TEX_WRAP_CLAMP_TO_EDGE:
 216       return TRUE;
 217    default:
 218       return FALSE;
 219    }
 220 }
 221
 222
 223 static INLINE void
 224 apply_sampler_swizzle(struct lp_build_sample_context *bld,
 225                       LLVMValueRef *texel)
 226 {
 227    unsigned char swizzles[4];
 228
 229    swizzles[0] = bld->static_state->swizzle_r;
 230    swizzles[1] = bld->static_state->swizzle_g;
 231    swizzles[2] = bld->static_state->swizzle_b;
 232    swizzles[3] = bld->static_state->swizzle_a;
 233
 234    lp_build_swizzle_soa_inplace(&bld->texel_bld, texel, swizzles);
 235 }
 236
 237
 238 static INLINE int
 239 texture_dims(enum pipe_texture_target tex)
 240 {
 241    switch (tex) {
 242    case PIPE_TEXTURE_1D:
 243       return 1;
 244    case PIPE_TEXTURE_2D:
 245    case PIPE_TEXTURE_RECT:
 246    case PIPE_TEXTURE_CUBE:
 247       return 2;
 248    case PIPE_TEXTURE_3D:
 249       return 3;
 250    default:
 251       assert(0 && "bad texture target in texture_dims()");
 252       return 2;
 253    }
 254 }
 255
 256
 257 /**
 258  * Derive the sampler static state.
 259  */
 260 void
 261 lp_sampler_static_state(struct lp_sampler_static_state *state,
 262                         const struct pipe_sampler_view *view,
 263                         const struct pipe_sampler_state *sampler);
 264
 265
 266 LLVMValueRef
 267 lp_build_lod_selector(struct lp_build_sample_context *bld,
 268                       unsigned unit,
 269                       const LLVMValueRef ddx[4],
 270                       const LLVMValueRef ddy[4],
 271                       LLVMValueRef lod_bias, /* optional */
 272                       LLVMValueRef explicit_lod, /* optional */
 273                       LLVMValueRef width,
 274                       LLVMValueRef height,
 275                       LLVMValueRef depth);
 276
 277 void
 278 lp_build_nearest_mip_level(struct lp_build_sample_context *bld,
 279                            unsigned unit,
 280                            LLVMValueRef lod,
 281                            LLVMValueRef *level_out);
 282
 283 void
 284 lp_build_linear_mip_levels(struct lp_build_sample_context *bld,
 285                            unsigned unit,
 286                            LLVMValueRef lod,
 287                            LLVMValueRef *level0_out,
 288                            LLVMValueRef *level1_out,
 289                            LLVMValueRef *weight_out);
 290
 291 LLVMValueRef
 292 lp_build_get_mipmap_level(struct lp_build_sample_context *bld,
 293                           LLVMValueRef data_array, LLVMValueRef level);
 294
 295 LLVMValueRef
 296 lp_build_get_const_mipmap_level(struct lp_build_sample_context *bld,
 297                                 LLVMValueRef data_array, int level);
 298
 299
 300 void
 301 lp_build_mipmap_level_sizes(struct lp_build_sample_context *bld,
 302                             unsigned dims,
 303                             LLVMValueRef width_vec,
 304                             LLVMValueRef height_vec,
 305                             LLVMValueRef depth_vec,
 306                             LLVMValueRef ilevel0,
 307                             LLVMValueRef ilevel1,
 308                             LLVMValueRef row_stride_array,
 309                             LLVMValueRef img_stride_array,
 310                             LLVMValueRef *width0_vec,
 311                             LLVMValueRef *width1_vec,
 312                             LLVMValueRef *height0_vec,
 313                             LLVMValueRef *height1_vec,
 314                             LLVMValueRef *depth0_vec,
 315                             LLVMValueRef *depth1_vec,
 316                             LLVMValueRef *row_stride0_vec,
 317                             LLVMValueRef *row_stride1_vec,
 318                             LLVMValueRef *img_stride0_vec,
 319                             LLVMValueRef *img_stride1_vec);
 320
 321
 322 void
 323 lp_build_cube_lookup(struct lp_build_sample_context *bld,
 324                      LLVMValueRef s,
 325                      LLVMValueRef t,
 326                      LLVMValueRef r,
 327                      LLVMValueRef *face,
 328                      LLVMValueRef *face_s,
 329                      LLVMValueRef *face_t);
 330
 331
 332 void
 333 lp_build_sample_partial_offset(struct lp_build_context *bld,
 334                                unsigned block_length,
 335                                LLVMValueRef coord,
 336                                LLVMValueRef stride,
 337                                LLVMValueRef *out_offset,
 338                                LLVMValueRef *out_i);
 339
 340
 341 void
 342 lp_build_sample_offset(struct lp_build_context *bld,
 343                        const struct util_format_description *format_desc,
 344                        LLVMValueRef x,
 345                        LLVMValueRef y,
 346                        LLVMValueRef z,
 347                        LLVMValueRef y_stride,
 348                        LLVMValueRef z_stride,
 349                        LLVMValueRef *out_offset,
 350                        LLVMValueRef *out_i,
 351                        LLVMValueRef *out_j);
 352
 353
 354 void
 355 lp_build_sample_soa(LLVMBuilderRef builder,
 356                     const struct lp_sampler_static_state *static_state,
 357                     struct lp_sampler_dynamic_state *dynamic_state,
 358                     struct lp_type fp_type,
 359                     unsigned unit,
 360                     unsigned num_coords,
 361                     const LLVMValueRef *coords,
 362                     const LLVMValueRef *ddx,
 363                     const LLVMValueRef *ddy,
 364                     LLVMValueRef lod_bias,
 365                     LLVMValueRef explicit_lod,
 366                     LLVMValueRef texel_out[4]);
 367
 368 void
 369 lp_build_sample_nop(struct lp_type type,
 370                     LLVMValueRef texel_out[4]);
 371
 372
 373 #endif /* LP_BLD_SAMPLE_H */