st/mesa: remove st_vp_variant_key in favor of st_common_variant_key
[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 /** 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
182
183 /** Shader key shared by other shaders */
184 struct st_common_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 /** lower glPointSize to gl_PointSize */
197 boolean lower_point_size;
198
199 /* for user-defined clip-planes */
200 uint8_t lower_ucp;
201 };
202
203
204 /**
205 * This represents a vertex program, especially translated to match
206 * the inputs of a particular fragment shader.
207 */
208 struct st_vp_variant
209 {
210 /* Parameters which generated this translated version of a vertex
211 * shader:
212 */
213 struct st_common_variant_key key;
214
215 /**
216 * The shader variant saved for the draw module to later emulate
217 * selection/feedback/rasterpos.
218 */
219 struct pipe_shader_state state;
220
221 /** Driver's compiled shader */
222 void *driver_shader;
223
224 /** For using our private draw module (glRasterPos) */
225 struct draw_vertex_shader *draw_shader;
226
227 /** Next in linked list */
228 struct st_vp_variant *next;
229
230 /** similar to that in st_vertex_program, but with edgeflags info too */
231 GLuint num_inputs;
232
233 /** Bitfield of VERT_BIT_* bits of mesa vertex processing inputs */
234 GLbitfield vert_attrib_mask;
235 };
236
237
238 /**
239 * Derived from Mesa gl_program:
240 */
241 struct st_vertex_program
242 {
243 struct gl_program Base; /**< The Mesa vertex program */
244 struct pipe_shader_state state;
245 struct glsl_to_tgsi_visitor* glsl_to_tgsi;
246 uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
247
248 /* used when bypassing glsl_to_tgsi: */
249 struct gl_shader_program *shader_program;
250
251 /** maps a TGSI input index back to a Mesa VERT_ATTRIB_x */
252 ubyte index_to_input[PIPE_MAX_ATTRIBS];
253 ubyte num_inputs;
254 /** Reverse mapping of the above */
255 ubyte input_to_index[VERT_ATTRIB_MAX];
256
257 /** Maps VARYING_SLOT_x to slot */
258 ubyte result_to_output[VARYING_SLOT_MAX];
259
260 /** List of translated variants of this vertex program.
261 */
262 struct st_vp_variant *variants;
263
264 /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
265 unsigned char sha1[20];
266 };
267
268
269 /**
270 * Geometry program variant.
271 */
272 struct st_common_variant
273 {
274 /* Parameters which generated this variant. */
275 struct st_common_variant_key key;
276
277 void *driver_shader;
278
279 struct st_common_variant *next;
280 };
281
282
283 /**
284 * Derived from Mesa gl_program:
285 */
286 struct st_common_program
287 {
288 struct gl_program Base;
289 struct pipe_shader_state state;
290 struct glsl_to_tgsi_visitor* glsl_to_tgsi;
291 uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
292
293 /* used when bypassing glsl_to_tgsi: */
294 struct gl_shader_program *shader_program;
295
296 struct st_common_variant *variants;
297
298 /** SHA1 hash of linked tgsi shader program, used for on-disk cache */
299 unsigned char sha1[20];
300 };
301
302
303 static inline struct st_fragment_program *
304 st_fragment_program( struct gl_program *fp )
305 {
306 return (struct st_fragment_program *)fp;
307 }
308
309
310 static inline struct st_vertex_program *
311 st_vertex_program( struct gl_program *vp )
312 {
313 return (struct st_vertex_program *)vp;
314 }
315
316 static inline struct st_common_program *
317 st_common_program( struct gl_program *cp )
318 {
319 return (struct st_common_program *)cp;
320 }
321
322 static inline void
323 st_reference_vertprog(struct st_context *st,
324 struct st_vertex_program **ptr,
325 struct st_vertex_program *prog)
326 {
327 _mesa_reference_program(st->ctx,
328 (struct gl_program **) ptr,
329 (struct gl_program *) prog);
330 }
331
332 static inline void
333 st_reference_fragprog(struct st_context *st,
334 struct st_fragment_program **ptr,
335 struct st_fragment_program *prog)
336 {
337 _mesa_reference_program(st->ctx,
338 (struct gl_program **) ptr,
339 (struct gl_program *) prog);
340 }
341
342 static inline void
343 st_reference_prog(struct st_context *st,
344 struct st_common_program **ptr,
345 struct st_common_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_compprog(struct st_context *st,
354 struct st_common_program **ptr,
355 struct st_common_program *prog)
356 {
357 _mesa_reference_program(st->ctx,
358 (struct gl_program **) ptr,
359 (struct gl_program *) prog);
360 }
361
362 /**
363 * This defines mapping from Mesa VARYING_SLOTs to TGSI GENERIC slots.
364 */
365 static inline unsigned
366 st_get_generic_varying_index(struct st_context *st, GLuint attr)
367 {
368 return tgsi_get_generic_gl_varying_index((gl_varying_slot)attr,
369 st->needs_texcoord_semantic);
370 }
371
372 extern void
373 st_set_prog_affected_state_flags(struct gl_program *prog);
374
375 extern struct st_vp_variant *
376 st_get_vp_variant(struct st_context *st,
377 struct st_vertex_program *stvp,
378 const struct st_common_variant_key *key);
379
380
381 extern struct st_fp_variant *
382 st_get_fp_variant(struct st_context *st,
383 struct st_fragment_program *stfp,
384 const struct st_fp_variant_key *key);
385
386 extern struct st_common_variant *
387 st_get_common_variant(struct st_context *st,
388 struct st_common_program *p,
389 const struct st_common_variant_key *key);
390
391 extern void
392 st_release_vp_variants( struct st_context *st,
393 struct st_vertex_program *stvp );
394
395 extern void
396 st_release_fp_variants( struct st_context *st,
397 struct st_fragment_program *stfp );
398
399 extern void
400 st_release_common_variants(struct st_context *st, struct st_common_program *p);
401
402 extern void
403 st_destroy_program_variants(struct st_context *st);
404
405 extern void
406 st_prepare_vertex_program(struct st_vertex_program *stvp);
407
408 extern void
409 st_translate_stream_output_info(struct gl_program *prog);
410
411 extern bool
412 st_translate_vertex_program(struct st_context *st,
413 struct st_vertex_program *stvp);
414
415 extern bool
416 st_translate_fragment_program(struct st_context *st,
417 struct st_fragment_program *stfp);
418
419 extern bool
420 st_translate_common_program(struct st_context *st,
421 struct st_common_program *stcp);
422
423 extern void
424 st_print_current_vertex_program(void);
425
426 extern void
427 st_precompile_shader_variant(struct st_context *st,
428 struct gl_program *prog);
429
430 #ifdef __cplusplus
431 }
432 #endif
433
434 #endif