src/mesa/state_tracker/st_program.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2003 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   * Authors:
  30   *   Keith Whitwell <keithw@vmware.com>
  31   */
  32
  33
  34 #ifndef ST_PROGRAM_H
  35 #define ST_PROGRAM_H
  36
  37 #include "main/mtypes.h"
  38 #include "main/atifragshader.h"
  39 #include "program/program.h"
  40 #include "pipe/p_state.h"
  41 #include "tgsi/tgsi_from_mesa.h"
  42 #include "st_context.h"
  43 #include "st_texture.h"
  44 #include "st_glsl_to_tgsi.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 #define ST_DOUBLE_ATTRIB_PLACEHOLDER 0xff
  51
  52 struct st_external_sampler_key
  53 {
  54    GLuint lower_nv12;             /**< bitmask of 2 plane YUV samplers */
  55    GLuint lower_iyuv;             /**< bitmask of 3 plane YUV samplers */
  56    GLuint lower_xy_uxvx;          /**< bitmask of 2 plane YUV samplers */
  57    GLuint lower_yx_xuxv;          /**< bitmask of 2 plane YUV samplers */
  58    GLuint lower_ayuv;
  59    GLuint lower_xyuv;
  60 };
  61
  62 static inline struct st_external_sampler_key
  63 st_get_external_sampler_key(struct st_context *st, struct gl_program *prog)
  64 {
  65    unsigned mask = prog->ExternalSamplersUsed;
  66    struct st_external_sampler_key key;
  67
  68    memset(&key, 0, sizeof(key));
  69
  70    while (unlikely(mask)) {
  71       unsigned unit = u_bit_scan(&mask);
  72       struct st_texture_object *stObj =
  73             st_get_texture_object(st->ctx, prog, unit);
  74
  75       switch (st_get_view_format(stObj)) {
  76       case PIPE_FORMAT_NV12:
  77       case PIPE_FORMAT_P016:
  78          key.lower_nv12 |= (1 << unit);
  79          break;
  80       case PIPE_FORMAT_IYUV:
  81          key.lower_iyuv |= (1 << unit);
  82          break;
  83       case PIPE_FORMAT_YUYV:
  84          key.lower_yx_xuxv |= (1 << unit);
  85          break;
  86       case PIPE_FORMAT_UYVY:
  87          key.lower_xy_uxvx |= (1 << unit);
  88          break;
  89       case PIPE_FORMAT_AYUV:
  90          key.lower_ayuv |= (1 << unit);
  91          break;
  92       case PIPE_FORMAT_XYUV:
  93          key.lower_xyuv |= (1 << unit);
  94          break;
  95       default:
  96          printf("unhandled %u\n", st_get_view_format(stObj));
  97          break;
  98       }
  99    }
 100
 101    return key;
 102 }
 103
 104 /** Fragment program variant key */
 105 struct st_fp_variant_key
 106 {
 107    struct st_context *st;         /**< variants are per-context */
 108
 109    /** for glBitmap */
 110    GLuint bitmap:1;               /**< glBitmap variant? */
 111
 112    /** for glDrawPixels */
 113    GLuint drawpixels:1;           /**< glDrawPixels variant */
 114    GLuint scaleAndBias:1;         /**< glDrawPixels w/ scale and/or bias? */
 115    GLuint pixelMaps:1;            /**< glDrawPixels w/ pixel lookup map? */
 116
 117    /** for ARB_color_buffer_float */
 118    GLuint clamp_color:1;
 119
 120    /** for ARB_sample_shading */
 121    GLuint persample_shading:1;
 122
 123    /** needed for ATI_fragment_shader */
 124    GLuint fog:2;
 125
 126    /** for ARB_depth_clamp */
 127    GLuint lower_depth_clamp:1;
 128
 129    /** needed for ATI_fragment_shader */
 130    char texture_targets[MAX_NUM_FRAGMENT_REGISTERS_ATI];
 131
 132    struct st_external_sampler_key external;
 133 };
 134
 135
 136 /**
 137  * Variant of a fragment program.
 138  */
 139 struct st_fp_variant
 140 {
 141    /** Parameters which generated this version of fragment program */
 142    struct st_fp_variant_key key;
 143
 144    /** Driver's compiled shader */
 145    void *driver_shader;
 146
 147    /** For glBitmap variants */
 148    uint bitmap_sampler;
 149
 150    /** For glDrawPixels variants */
 151    unsigned drawpix_sampler;
 152    unsigned pixelmap_sampler;
 153
 154    /** next in linked list */
 155    struct st_fp_variant *next;
 156 };
 157
 158
 159 /**
 160  * Derived from Mesa gl_program:
 161  */
 162 struct st_fragment_program
 163 {
 164    struct gl_program Base;
 165    struct pipe_shader_state tgsi;
 166    struct glsl_to_tgsi_visitor* glsl_to_tgsi;
 167    struct ati_fragment_shader *ati_fs;
 168    uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
 169
 170    /* used when bypassing glsl_to_tgsi: */
 171    struct gl_shader_program *shader_program;
 172
 173    struct st_fp_variant *variants;
 174
 175    /* Used by the shader cache and ARB_get_program_binary */
 176    unsigned num_tgsi_tokens;
 177 };
 178
 179
 180
 181 /** Vertex program variant key */
 182 struct st_vp_variant_key
 183 {
 184    struct st_context *st;          /**< variants are per-context */
 185    bool passthrough_edgeflags;
 186
 187    /** for ARB_color_buffer_float */
 188    bool clamp_color;
 189
 190    /** both for ARB_depth_clamp */
 191    bool lower_depth_clamp;
 192    bool clip_negative_one_to_one;
 193 };
 194
 195
 196 /**
 197  * This represents a vertex program, especially translated to match
 198  * the inputs of a particular fragment shader.
 199  */
 200 struct st_vp_variant
 201 {
 202    /* Parameters which generated this translated version of a vertex
 203     * shader:
 204     */
 205    struct st_vp_variant_key key;
 206
 207    /**
 208     * TGSI tokens (to later generate a 'draw' module shader for
 209     * selection/feedback/rasterpos)
 210     */
 211    struct pipe_shader_state tgsi;
 212
 213    /** Driver's compiled shader */
 214    void *driver_shader;
 215
 216    /** For using our private draw module (glRasterPos) */
 217    struct draw_vertex_shader *draw_shader;
 218
 219    /** Next in linked list */
 220    struct st_vp_variant *next;
 221
 222    /** similar to that in st_vertex_program, but with edgeflags info too */
 223    GLuint num_inputs;
 224
 225    /** Bitfield of VERT_BIT_* bits of mesa vertex processing inputs */
 226    GLbitfield vert_attrib_mask;
 227 };
 228
 229
 230 /**
 231  * Derived from Mesa gl_program:
 232  */
 233 struct st_vertex_program
 234 {
 235    struct gl_program Base;  /**< The Mesa vertex program */
 236    struct pipe_shader_state tgsi;
 237    struct glsl_to_tgsi_visitor* glsl_to_tgsi;
 238    uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
 239
 240    /* used when bypassing glsl_to_tgsi: */
 241    struct gl_shader_program *shader_program;
 242
 243    /** maps a TGSI input index back to a Mesa VERT_ATTRIB_x */
 244    ubyte index_to_input[PIPE_MAX_ATTRIBS];
 245    ubyte num_inputs;
 246    /** Reverse mapping of the above */
 247    ubyte input_to_index[VERT_ATTRIB_MAX];
 248
 249    /** Maps VARYING_SLOT_x to slot */
 250    ubyte result_to_output[VARYING_SLOT_MAX];
 251
 252    /** List of translated variants of this vertex program.
 253     */
 254    struct st_vp_variant *variants;
 255
 256    /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
 257    unsigned char sha1[20];
 258
 259    /* Used by the shader cache and ARB_get_program_binary */
 260    unsigned num_tgsi_tokens;
 261 };
 262
 263
 264
 265 /** Key shared by all shaders except VP, FP */
 266 struct st_basic_variant_key
 267 {
 268    struct st_context *st;          /**< variants are per-context */
 269
 270    /** For compat profile */
 271    bool clamp_color;
 272
 273    /** both for ARB_depth_clamp */
 274    bool lower_depth_clamp;
 275    bool clip_negative_one_to_one;
 276
 277 };
 278
 279
 280 /**
 281  * Geometry program variant.
 282  */
 283 struct st_basic_variant
 284 {
 285    /* Parameters which generated this variant. */
 286    struct st_basic_variant_key key;
 287
 288    void *driver_shader;
 289
 290    struct st_basic_variant *next;
 291 };
 292
 293
 294 /**
 295  * Derived from Mesa gl_program:
 296  */
 297 struct st_common_program
 298 {
 299    struct gl_program Base;
 300    struct pipe_shader_state tgsi;
 301    struct glsl_to_tgsi_visitor* glsl_to_tgsi;
 302    uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
 303
 304   /* used when bypassing glsl_to_tgsi: */
 305    struct gl_shader_program *shader_program;
 306
 307    struct st_basic_variant *variants;
 308
 309    /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
 310    unsigned char sha1[20];
 311
 312    /* Used by the shader cache and ARB_get_program_binary */
 313    unsigned num_tgsi_tokens;
 314 };
 315
 316
 317 static inline struct st_fragment_program *
 318 st_fragment_program( struct gl_program *fp )
 319 {
 320    return (struct st_fragment_program *)fp;
 321 }
 322
 323
 324 static inline struct st_vertex_program *
 325 st_vertex_program( struct gl_program *vp )
 326 {
 327    return (struct st_vertex_program *)vp;
 328 }
 329
 330 static inline struct st_common_program *
 331 st_common_program( struct gl_program *cp )
 332 {
 333    return (struct st_common_program *)cp;
 334 }
 335
 336 static inline void
 337 st_reference_vertprog(struct st_context *st,
 338                       struct st_vertex_program **ptr,
 339                       struct st_vertex_program *prog)
 340 {
 341    _mesa_reference_program(st->ctx,
 342                            (struct gl_program **) ptr,
 343                            (struct gl_program *) prog);
 344 }
 345
 346 static inline void
 347 st_reference_fragprog(struct st_context *st,
 348                       struct st_fragment_program **ptr,
 349                       struct st_fragment_program *prog)
 350 {
 351    _mesa_reference_program(st->ctx,
 352                            (struct gl_program **) ptr,
 353                            (struct gl_program *) prog);
 354 }
 355
 356 static inline void
 357 st_reference_prog(struct st_context *st,
 358                   struct st_common_program **ptr,
 359                   struct st_common_program *prog)
 360 {
 361    _mesa_reference_program(st->ctx,
 362                            (struct gl_program **) ptr,
 363                            (struct gl_program *) prog);
 364 }
 365
 366 static inline void
 367 st_reference_compprog(struct st_context *st,
 368                       struct st_common_program **ptr,
 369                       struct st_common_program *prog)
 370 {
 371    _mesa_reference_program(st->ctx,
 372                            (struct gl_program **) ptr,
 373                            (struct gl_program *) prog);
 374 }
 375
 376 /**
 377  * This defines mapping from Mesa VARYING_SLOTs to TGSI GENERIC slots.
 378  */
 379 static inline unsigned
 380 st_get_generic_varying_index(struct st_context *st, GLuint attr)
 381 {
 382    return tgsi_get_generic_gl_varying_index((gl_varying_slot)attr,
 383                                             st->needs_texcoord_semantic);
 384 }
 385
 386 extern void
 387 st_set_prog_affected_state_flags(struct gl_program *prog);
 388
 389 extern struct st_vp_variant *
 390 st_get_vp_variant(struct st_context *st,
 391                   struct st_vertex_program *stvp,
 392                   const struct st_vp_variant_key *key);
 393
 394
 395 extern struct st_fp_variant *
 396 st_get_fp_variant(struct st_context *st,
 397                   struct st_fragment_program *stfp,
 398                   const struct st_fp_variant_key *key);
 399
 400 extern struct st_basic_variant *
 401 st_get_basic_variant(struct st_context *st,
 402                      struct st_common_program *p,
 403                      const struct st_basic_variant_key *key);
 404
 405 extern void
 406 st_release_vp_variants( struct st_context *st,
 407                         struct st_vertex_program *stvp );
 408
 409 extern void
 410 st_release_fp_variants( struct st_context *st,
 411                         struct st_fragment_program *stfp );
 412
 413 extern void
 414 st_release_basic_variants(struct st_context *st, struct st_common_program *p);
 415
 416 extern void
 417 st_destroy_program_variants(struct st_context *st);
 418
 419 extern void
 420 st_prepare_vertex_program(struct st_vertex_program *stvp);
 421
 422 extern bool
 423 st_translate_vertex_program(struct st_context *st,
 424                             struct st_vertex_program *stvp);
 425
 426 extern bool
 427 st_translate_fragment_program(struct st_context *st,
 428                               struct st_fragment_program *stfp);
 429
 430 extern bool
 431 st_translate_common_program(struct st_context *st,
 432                             struct st_common_program *stcp);
 433
 434 extern void
 435 st_print_current_vertex_program(void);
 436
 437 extern void
 438 st_precompile_shader_variant(struct st_context *st,
 439                              struct gl_program *prog);
 440
 441 #ifdef __cplusplus
 442 }
 443 #endif
 444
 445 #endif