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