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