st/mesa: add st_variant base class to simplify code for shader variants
[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("mesa: st_get_external_sampler_key: unhandled pipe format %u\n",
97 st_get_view_format(stObj));
98 break;
99 }
100 }
101
102 return key;
103 }
104
105 /** Fragment program variant key */
106 struct st_fp_variant_key
107 {
108 struct st_context *st; /**< variants are per-context */
109
110 /** for glBitmap */
111 GLuint bitmap:1; /**< glBitmap variant? */
112
113 /** for glDrawPixels */
114 GLuint drawpixels:1; /**< glDrawPixels variant */
115 GLuint scaleAndBias:1; /**< glDrawPixels w/ scale and/or bias? */
116 GLuint pixelMaps:1; /**< glDrawPixels w/ pixel lookup map? */
117
118 /** for ARB_color_buffer_float */
119 GLuint clamp_color:1;
120
121 /** for ARB_sample_shading */
122 GLuint persample_shading:1;
123
124 /** needed for ATI_fragment_shader */
125 GLuint fog:2;
126
127 /** for ARB_depth_clamp */
128 GLuint lower_depth_clamp:1;
129
130 /** for OpenGL 1.0 on modern hardware */
131 GLuint lower_two_sided_color:1;
132
133 GLuint lower_flatshade:1;
134 enum compare_func lower_alpha_func:3;
135
136 /** needed for ATI_fragment_shader */
137 char texture_targets[MAX_NUM_FRAGMENT_REGISTERS_ATI];
138
139 struct st_external_sampler_key external;
140 };
141
142 /**
143 * Base class for shader variants.
144 */
145 struct st_variant
146 {
147 /** next in linked list */
148 struct st_variant *next;
149
150 /** st_context from the shader key */
151 struct st_context *st;
152
153 void *driver_shader;
154 };
155
156 /**
157 * Variant of a fragment program.
158 */
159 struct st_fp_variant
160 {
161 struct st_variant base;
162
163 /** Parameters which generated this version of fragment program */
164 struct st_fp_variant_key key;
165
166 /** For glBitmap variants */
167 uint bitmap_sampler;
168
169 /** For glDrawPixels variants */
170 unsigned drawpix_sampler;
171 unsigned pixelmap_sampler;
172 };
173
174
175 /** Shader key shared by other shaders */
176 struct st_common_variant_key
177 {
178 struct st_context *st; /**< variants are per-context */
179 bool passthrough_edgeflags;
180
181 /** for ARB_color_buffer_float */
182 bool clamp_color;
183
184 /** both for ARB_depth_clamp */
185 bool lower_depth_clamp;
186 bool clip_negative_one_to_one;
187
188 /** lower glPointSize to gl_PointSize */
189 boolean lower_point_size;
190
191 /* for user-defined clip-planes */
192 uint8_t lower_ucp;
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 struct st_variant base;
203
204 /* Parameters which generated this translated version of a vertex
205 * shader:
206 */
207 struct st_common_variant_key key;
208
209 /**
210 * The shader variant saved for the draw module to later emulate
211 * selection/feedback/rasterpos.
212 */
213 const struct tgsi_token *tokens;
214
215 /** For using our private draw module (glRasterPos) */
216 struct draw_vertex_shader *draw_shader;
217
218 /** similar to that in st_vertex_program, but with edgeflags info too */
219 GLuint num_inputs;
220
221 /** Bitfield of VERT_BIT_* bits of mesa vertex processing inputs */
222 GLbitfield vert_attrib_mask;
223 };
224
225
226 /**
227 * Common shader variant.
228 */
229 struct st_common_variant
230 {
231 struct st_variant base;
232
233 /* Parameters which generated this variant. */
234 struct st_common_variant_key key;
235 };
236
237
238 /**
239 * Derived from Mesa gl_program:
240 */
241 struct st_program
242 {
243 struct gl_program Base;
244 struct pipe_shader_state state;
245 struct glsl_to_tgsi_visitor* glsl_to_tgsi;
246 struct ati_fragment_shader *ati_fs;
247 uint64_t affected_states; /**< ST_NEW_* flags to mark dirty when binding */
248
249 /* used when bypassing glsl_to_tgsi: */
250 struct gl_shader_program *shader_program;
251
252 struct st_variant *variants;
253 };
254
255
256 struct st_vertex_program
257 {
258 struct st_program Base;
259
260 /** maps a TGSI input index back to a Mesa VERT_ATTRIB_x */
261 ubyte index_to_input[PIPE_MAX_ATTRIBS];
262 ubyte num_inputs;
263 /** Reverse mapping of the above */
264 ubyte input_to_index[VERT_ATTRIB_MAX];
265
266 /** Maps VARYING_SLOT_x to slot */
267 ubyte result_to_output[VARYING_SLOT_MAX];
268 };
269
270
271 static inline struct st_program *
272 st_program( struct gl_program *cp )
273 {
274 return (struct st_program *)cp;
275 }
276
277 static inline void
278 st_reference_prog(struct st_context *st,
279 struct st_program **ptr,
280 struct st_program *prog)
281 {
282 _mesa_reference_program(st->ctx,
283 (struct gl_program **) ptr,
284 (struct gl_program *) prog);
285 }
286
287 static inline struct st_common_variant *
288 st_common_variant(struct st_variant *v)
289 {
290 return (struct st_common_variant*)v;
291 }
292
293 static inline struct st_vp_variant *
294 st_vp_variant(struct st_variant *v)
295 {
296 return (struct st_vp_variant*)v;
297 }
298
299 static inline struct st_fp_variant *
300 st_fp_variant(struct st_variant *v)
301 {
302 return (struct st_fp_variant*)v;
303 }
304
305 /**
306 * This defines mapping from Mesa VARYING_SLOTs to TGSI GENERIC slots.
307 */
308 static inline unsigned
309 st_get_generic_varying_index(struct st_context *st, GLuint attr)
310 {
311 return tgsi_get_generic_gl_varying_index((gl_varying_slot)attr,
312 st->needs_texcoord_semantic);
313 }
314
315 extern void
316 st_set_prog_affected_state_flags(struct gl_program *prog);
317
318 extern struct st_vp_variant *
319 st_get_vp_variant(struct st_context *st,
320 struct st_program *stvp,
321 const struct st_common_variant_key *key);
322
323
324 extern struct st_fp_variant *
325 st_get_fp_variant(struct st_context *st,
326 struct st_program *stfp,
327 const struct st_fp_variant_key *key);
328
329 extern struct st_variant *
330 st_get_common_variant(struct st_context *st,
331 struct st_program *p,
332 const struct st_common_variant_key *key);
333
334 extern void
335 st_release_variants(struct st_context *st, struct st_program *p);
336
337 extern void
338 st_destroy_program_variants(struct st_context *st);
339
340 extern void
341 st_finalize_nir_before_variants(struct nir_shader *nir);
342
343 extern void
344 st_prepare_vertex_program(struct st_program *stvp);
345
346 extern void
347 st_translate_stream_output_info(struct gl_program *prog);
348
349 extern bool
350 st_translate_vertex_program(struct st_context *st,
351 struct st_program *stvp);
352
353 extern bool
354 st_translate_fragment_program(struct st_context *st,
355 struct st_program *stfp);
356
357 extern bool
358 st_translate_common_program(struct st_context *st,
359 struct st_program *stp);
360
361 extern void
362 st_finalize_program(struct st_context *st, struct gl_program *prog);
363
364 #ifdef __cplusplus
365 }
366 #endif
367
368 #endif