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    /** for OpenGL 1.0 on modern hardware */
 130    GLuint lower_two_sided_color:1;
 131
 132    /** needed for ATI_fragment_shader */
 133    char texture_targets[MAX_NUM_FRAGMENT_REGISTERS_ATI];
 134
 135    struct st_external_sampler_key external;
 136
 137    GLuint lower_flatshade:1;
 138    enum compare_func lower_alpha_func:3;
 139 };
 140
 141
 142 /**
 143  * Variant of a fragment program.
 144  */
 145 struct st_fp_variant
 146 {
 147    /** Parameters which generated this version of fragment program */
 148    struct st_fp_variant_key key;
 149
 150    /** Driver's compiled shader */
 151    void *driver_shader;
 152
 153    /** For glBitmap variants */
 154    uint bitmap_sampler;
 155
 156    /** For glDrawPixels variants */
 157    unsigned drawpix_sampler;
 158    unsigned pixelmap_sampler;
 159
 160    /** next in linked list */
 161    struct st_fp_variant *next;
 162 };
 163
 164
 165 /**
 166  * Derived from Mesa gl_program:
 167  */
 168 struct st_fragment_program
 169 {
 170    struct gl_program Base;
 171    struct pipe_shader_state state;
 172    struct glsl_to_tgsi_visitor* glsl_to_tgsi;
 173    struct ati_fragment_shader *ati_fs;
 174    uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
 175
 176    /* used when bypassing glsl_to_tgsi: */
 177    struct gl_shader_program *shader_program;
 178
 179    struct st_fp_variant *variants;
 180
 181    /* Used by the shader cache and ARB_get_program_binary */
 182    unsigned num_tgsi_tokens;
 183 };
 184
 185
 186
 187 /** Vertex program variant key */
 188 struct st_vp_variant_key
 189 {
 190    struct st_context *st;          /**< variants are per-context */
 191    bool passthrough_edgeflags;
 192
 193    /** for ARB_color_buffer_float */
 194    bool clamp_color;
 195
 196    /** both for ARB_depth_clamp */
 197    bool lower_depth_clamp;
 198    bool clip_negative_one_to_one;
 199
 200    /** lower glPointSize to gl_PointSize */
 201    boolean lower_point_size;
 202
 203    /* for user-defined clip-planes */
 204    uint8_t lower_ucp;
 205 };
 206
 207
 208 /**
 209  * This represents a vertex program, especially translated to match
 210  * the inputs of a particular fragment shader.
 211  */
 212 struct st_vp_variant
 213 {
 214    /* Parameters which generated this translated version of a vertex
 215     * shader:
 216     */
 217    struct st_vp_variant_key key;
 218
 219    /**
 220     * The shader variant saved for the draw module to later emulate
 221     * selection/feedback/rasterpos.
 222     */
 223    struct pipe_shader_state state;
 224
 225    /** Driver's compiled shader */
 226    void *driver_shader;
 227
 228    /** For using our private draw module (glRasterPos) */
 229    struct draw_vertex_shader *draw_shader;
 230
 231    /** Next in linked list */
 232    struct st_vp_variant *next;
 233
 234    /** similar to that in st_vertex_program, but with edgeflags info too */
 235    GLuint num_inputs;
 236
 237    /** Bitfield of VERT_BIT_* bits of mesa vertex processing inputs */
 238    GLbitfield vert_attrib_mask;
 239 };
 240
 241
 242 /**
 243  * Derived from Mesa gl_program:
 244  */
 245 struct st_vertex_program
 246 {
 247    struct gl_program Base;  /**< The Mesa vertex program */
 248    struct pipe_shader_state state;
 249    struct glsl_to_tgsi_visitor* glsl_to_tgsi;
 250    uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
 251
 252    /* used when bypassing glsl_to_tgsi: */
 253    struct gl_shader_program *shader_program;
 254
 255    /** maps a TGSI input index back to a Mesa VERT_ATTRIB_x */
 256    ubyte index_to_input[PIPE_MAX_ATTRIBS];
 257    ubyte num_inputs;
 258    /** Reverse mapping of the above */
 259    ubyte input_to_index[VERT_ATTRIB_MAX];
 260
 261    /** Maps VARYING_SLOT_x to slot */
 262    ubyte result_to_output[VARYING_SLOT_MAX];
 263
 264    /** List of translated variants of this vertex program.
 265     */
 266    struct st_vp_variant *variants;
 267
 268    /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
 269    unsigned char sha1[20];
 270
 271    /* Used by the shader cache and ARB_get_program_binary */
 272    unsigned num_tgsi_tokens;
 273 };
 274
 275
 276
 277 /** Shader key shared by other shaders */
 278 struct st_common_variant_key
 279 {
 280    struct st_context *st;          /**< variants are per-context */
 281
 282    /** For compat profile */
 283    bool clamp_color;
 284
 285    /** both for ARB_depth_clamp */
 286    bool lower_depth_clamp;
 287    bool clip_negative_one_to_one;
 288
 289 };
 290
 291
 292 /**
 293  * Geometry program variant.
 294  */
 295 struct st_common_variant
 296 {
 297    /* Parameters which generated this variant. */
 298    struct st_common_variant_key key;
 299
 300    void *driver_shader;
 301
 302    struct st_common_variant *next;
 303 };
 304
 305
 306 /**
 307  * Derived from Mesa gl_program:
 308  */
 309 struct st_common_program
 310 {
 311    struct gl_program Base;
 312    struct pipe_shader_state state;
 313    struct glsl_to_tgsi_visitor* glsl_to_tgsi;
 314    uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
 315
 316   /* used when bypassing glsl_to_tgsi: */
 317    struct gl_shader_program *shader_program;
 318
 319    struct st_common_variant *variants;
 320
 321    /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
 322    unsigned char sha1[20];
 323
 324    /* Used by the shader cache and ARB_get_program_binary */
 325    unsigned num_tgsi_tokens;
 326 };
 327
 328
 329 static inline struct st_fragment_program *
 330 st_fragment_program( struct gl_program *fp )
 331 {
 332    return (struct st_fragment_program *)fp;
 333 }
 334
 335
 336 static inline struct st_vertex_program *
 337 st_vertex_program( struct gl_program *vp )
 338 {
 339    return (struct st_vertex_program *)vp;
 340 }
 341
 342 static inline struct st_common_program *
 343 st_common_program( struct gl_program *cp )
 344 {
 345    return (struct st_common_program *)cp;
 346 }
 347
 348 static inline void
 349 st_reference_vertprog(struct st_context *st,
 350                       struct st_vertex_program **ptr,
 351                       struct st_vertex_program *prog)
 352 {
 353    _mesa_reference_program(st->ctx,
 354                            (struct gl_program **) ptr,
 355                            (struct gl_program *) prog);
 356 }
 357
 358 static inline void
 359 st_reference_fragprog(struct st_context *st,
 360                       struct st_fragment_program **ptr,
 361                       struct st_fragment_program *prog)
 362 {
 363    _mesa_reference_program(st->ctx,
 364                            (struct gl_program **) ptr,
 365                            (struct gl_program *) prog);
 366 }
 367
 368 static inline void
 369 st_reference_prog(struct st_context *st,
 370                   struct st_common_program **ptr,
 371                   struct st_common_program *prog)
 372 {
 373    _mesa_reference_program(st->ctx,
 374                            (struct gl_program **) ptr,
 375                            (struct gl_program *) prog);
 376 }
 377
 378 static inline void
 379 st_reference_compprog(struct st_context *st,
 380                       struct st_common_program **ptr,
 381                       struct st_common_program *prog)
 382 {
 383    _mesa_reference_program(st->ctx,
 384                            (struct gl_program **) ptr,
 385                            (struct gl_program *) prog);
 386 }
 387
 388 /**
 389  * This defines mapping from Mesa VARYING_SLOTs to TGSI GENERIC slots.
 390  */
 391 static inline unsigned
 392 st_get_generic_varying_index(struct st_context *st, GLuint attr)
 393 {
 394    return tgsi_get_generic_gl_varying_index((gl_varying_slot)attr,
 395                                             st->needs_texcoord_semantic);
 396 }
 397
 398 extern void
 399 st_set_prog_affected_state_flags(struct gl_program *prog);
 400
 401 extern struct st_vp_variant *
 402 st_get_vp_variant(struct st_context *st,
 403                   struct st_vertex_program *stvp,
 404                   const struct st_vp_variant_key *key);
 405
 406
 407 extern struct st_fp_variant *
 408 st_get_fp_variant(struct st_context *st,
 409                   struct st_fragment_program *stfp,
 410                   const struct st_fp_variant_key *key);
 411
 412 extern struct st_common_variant *
 413 st_get_common_variant(struct st_context *st,
 414                       struct st_common_program *p,
 415                       const struct st_common_variant_key *key);
 416
 417 extern void
 418 st_release_vp_variants( struct st_context *st,
 419                         struct st_vertex_program *stvp );
 420
 421 extern void
 422 st_release_fp_variants( struct st_context *st,
 423                         struct st_fragment_program *stfp );
 424
 425 extern void
 426 st_release_common_variants(struct st_context *st, struct st_common_program *p);
 427
 428 extern void
 429 st_destroy_program_variants(struct st_context *st);
 430
 431 extern void
 432 st_prepare_vertex_program(struct st_vertex_program *stvp);
 433
 434 extern void
 435 st_translate_stream_output_info(struct gl_program *prog);
 436
 437 extern bool
 438 st_translate_vertex_program(struct st_context *st,
 439                             struct st_vertex_program *stvp);
 440
 441 extern bool
 442 st_translate_fragment_program(struct st_context *st,
 443                               struct st_fragment_program *stfp);
 444
 445 extern bool
 446 st_translate_common_program(struct st_context *st,
 447                             struct st_common_program *stcp);
 448
 449 extern void
 450 st_print_current_vertex_program(void);
 451
 452 extern void
 453 st_precompile_shader_variant(struct st_context *st,
 454                              struct gl_program *prog);
 455
 456 #ifdef __cplusplus
 457 }
 458 #endif
 459
 460 #endif