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