2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 * \file prog_parameter.c
27 * Program parameter lists and functions.
35 #include "prog_instruction.h"
36 #include "prog_parameter.h"
37 #include "prog_statevars.h"
40 struct gl_program_parameter_list
*
41 _mesa_new_parameter_list(void)
43 return CALLOC_STRUCT(gl_program_parameter_list
);
48 * Free a parameter list and all its parameters
51 _mesa_free_parameter_list(struct gl_program_parameter_list
*paramList
)
54 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
55 if (paramList
->Parameters
[i
].Name
)
56 _mesa_free((void *) paramList
->Parameters
[i
].Name
);
58 _mesa_free(paramList
->Parameters
);
59 if (paramList
->ParameterValues
)
60 _mesa_align_free(paramList
->ParameterValues
);
61 _mesa_free(paramList
);
66 _mesa_fit_type_in_vec4(GLenum type
)
89 * Add a new parameter to a parameter list.
90 * Note that parameter values are usually 4-element GLfloat vectors.
91 * When size > 4 we'll allocate a sequential block of parameters to
92 * store all the values (in blocks of 4).
94 * \param paramList the list to add the parameter to
95 * \param type type of parameter, such as
96 * \param name the parameter name, will be duplicated/copied!
97 * \param size number of elements in 'values' vector (1..4, or more)
98 * \param values initial parameter value, up to 4 GLfloats, or NULL
99 * \param state state indexes, or NULL
100 * \return index of new parameter in the list, or -1 if error (out of mem)
103 _mesa_add_parameter(struct gl_program_parameter_list
*paramList
,
104 enum register_file type
, const char *name
,
105 GLuint size
, GLenum datatype
, const GLfloat
*values
,
106 const gl_state_index state
[STATE_LENGTH
])
108 const GLuint oldNum
= paramList
->NumParameters
;
109 const GLuint sz4
= (size
+ 3) / 4; /* no. of new param slots needed */
113 if (oldNum
+ sz4
> paramList
->Size
) {
114 /* Need to grow the parameter list array (alloc some extra) */
115 paramList
->Size
= paramList
->Size
+ 4 * sz4
;
118 paramList
->Parameters
= (struct gl_program_parameter
*)
119 _mesa_realloc(paramList
->Parameters
,
120 oldNum
* sizeof(struct gl_program_parameter
),
121 paramList
->Size
* sizeof(struct gl_program_parameter
));
123 paramList
->ParameterValues
= (GLfloat (*)[4])
124 _mesa_align_realloc(paramList
->ParameterValues
, /* old buf */
125 oldNum
* 4 * sizeof(GLfloat
), /* old size */
126 paramList
->Size
* 4 *sizeof(GLfloat
), /* new sz */
130 if (!paramList
->Parameters
||
131 !paramList
->ParameterValues
) {
133 paramList
->NumParameters
= 0;
140 paramList
->NumParameters
= oldNum
+ sz4
;
142 _mesa_memset(¶mList
->Parameters
[oldNum
], 0,
143 sz4
* sizeof(struct gl_program_parameter
));
145 for (i
= 0; i
< sz4
; i
++) {
146 struct gl_program_parameter
*p
= paramList
->Parameters
+ oldNum
+ i
;
147 p
->Name
= name
? _mesa_strdup(name
) : NULL
;
150 p
->DataType
= datatype
;
152 COPY_4V(paramList
->ParameterValues
[oldNum
+ i
], values
);
156 /* silence valgrind */
157 ASSIGN_4V(paramList
->ParameterValues
[oldNum
+ i
], 0, 0, 0, 0);
163 for (i
= 0; i
< STATE_LENGTH
; i
++)
164 paramList
->Parameters
[oldNum
].StateIndexes
[i
] = state
[i
];
167 return (GLint
) oldNum
;
173 * Add a new named program parameter (Ex: NV_fragment_program DEFINE statement)
174 * \return index of the new entry in the parameter list
177 _mesa_add_named_parameter(struct gl_program_parameter_list
*paramList
,
178 const char *name
, const GLfloat values
[4])
180 return _mesa_add_parameter(paramList
, PROGRAM_NAMED_PARAM
, name
,
181 4, GL_NONE
, values
, NULL
);
187 * Add a new named constant to the parameter list.
188 * This will be used when the program contains something like this:
189 * PARAM myVals = { 0, 1, 2, 3 };
191 * \param paramList the parameter list
192 * \param name the name for the constant
193 * \param values four float values
194 * \return index/position of the new parameter in the parameter list
197 _mesa_add_named_constant(struct gl_program_parameter_list
*paramList
,
198 const char *name
, const GLfloat values
[4],
201 #if 0 /* disable this for now -- we need to save the name! */
204 ASSERT(size
== 4); /* XXX future feature */
205 /* check if we already have this constant */
206 if (_mesa_lookup_parameter_constant(paramList
, values
, 4, &pos
, &swizzle
)) {
210 size
= 4; /** XXX fix */
211 return _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, name
,
212 size
, GL_NONE
, values
, NULL
);
217 * Add a new unnamed constant to the parameter list. This will be used
218 * when a fragment/vertex program contains something like this:
219 * MOV r, { 0, 1, 2, 3 };
220 * We'll search the parameter list for an existing instance of the
221 * constant. If swizzleOut is non-null, we'll try swizzling when
222 * looking for a match.
224 * \param paramList the parameter list
225 * \param values four float values
226 * \param swizzleOut returns swizzle mask for accessing the constant
227 * \return index/position of the new parameter in the parameter list.
230 _mesa_add_unnamed_constant(struct gl_program_parameter_list
*paramList
,
231 const GLfloat values
[4], GLuint size
,
238 if (_mesa_lookup_parameter_constant(paramList
, values
,
239 size
, &pos
, swizzleOut
)) {
243 /* Look for empty space in an already unnamed constant parameter
244 * to add this constant. This will only work for single-element
245 * constants because we rely on smearing (i.e. .yyyy or .zzzz).
247 if (size
== 1 && swizzleOut
) {
248 for (pos
= 0; pos
< (GLint
) paramList
->NumParameters
; pos
++) {
249 struct gl_program_parameter
*p
= paramList
->Parameters
+ pos
;
250 if (p
->Type
== PROGRAM_CONSTANT
&& p
->Size
+ size
<= 4) {
252 GLfloat
*pVal
= paramList
->ParameterValues
[pos
];
253 GLuint swz
= p
->Size
; /* 1, 2 or 3 for Y, Z, W */
254 pVal
[p
->Size
] = values
[0];
256 *swizzleOut
= MAKE_SWIZZLE4(swz
, swz
, swz
, swz
);
262 /* add a new parameter to store this constant */
263 pos
= _mesa_add_parameter(paramList
, PROGRAM_CONSTANT
, NULL
,
264 size
, GL_NONE
, values
, NULL
);
265 if (pos
>= 0 && swizzleOut
) {
267 *swizzleOut
= SWIZZLE_XXXX
;
269 *swizzleOut
= SWIZZLE_NOOP
;
276 * Add a uniform to the parameter list.
277 * Note that if the uniform is an array, size may be greater than
278 * what's implied by the datatype.
279 * \param name uniform's name
280 * \param size number of floats to allocate
281 * \param datatype GL_FLOAT_VEC3, GL_FLOAT_MAT4, etc.
284 _mesa_add_uniform(struct gl_program_parameter_list
*paramList
,
285 const char *name
, GLuint size
, GLenum datatype
)
287 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
288 ASSERT(datatype
!= GL_NONE
);
289 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_UNIFORM
) {
290 ASSERT(paramList
->Parameters
[i
].Size
== size
);
291 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
292 /* already in list */
296 i
= _mesa_add_parameter(paramList
, PROGRAM_UNIFORM
, name
,
297 size
* _mesa_fit_type_in_vec4(datatype
), datatype
, NULL
, NULL
);
304 * Add a sampler to the parameter list.
305 * \param name uniform's name
306 * \param datatype GL_SAMPLER_2D, GL_SAMPLER_2D_RECT_ARB, etc.
307 * \param index the sampler number (as seen in TEX instructions)
308 * \return sampler index (starting at zero) or -1 if error
311 _mesa_add_sampler(struct gl_program_parameter_list
*paramList
,
312 const char *name
, GLenum datatype
)
314 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
315 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
) {
316 ASSERT(paramList
->Parameters
[i
].Size
== 1);
317 ASSERT(paramList
->Parameters
[i
].DataType
== datatype
);
318 /* already in list */
319 return (GLint
) paramList
->ParameterValues
[i
][0];
322 const GLint size
= 1; /* a sampler is basically a texture unit number */
324 GLint numSamplers
= 0;
325 for (i
= 0; i
< paramList
->NumParameters
; i
++) {
326 if (paramList
->Parameters
[i
].Type
== PROGRAM_SAMPLER
)
329 value
= (GLfloat
) numSamplers
;
330 (void) _mesa_add_parameter(paramList
, PROGRAM_SAMPLER
, name
,
331 size
, datatype
, &value
, NULL
);
338 * Add parameter representing a varying variable.
341 _mesa_add_varying(struct gl_program_parameter_list
*paramList
,
342 const char *name
, GLuint size
)
344 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
345 if (i
>= 0 && paramList
->Parameters
[i
].Type
== PROGRAM_VARYING
) {
346 /* already in list */
351 i
= _mesa_add_parameter(paramList
, PROGRAM_VARYING
, name
,
352 size
, GL_NONE
, NULL
, NULL
);
359 * Add parameter representing a vertex program attribute.
360 * \param size size of attribute (in floats), may be -1 if unknown
361 * \param attrib the attribute index, or -1 if unknown
364 _mesa_add_attribute(struct gl_program_parameter_list
*paramList
,
365 const char *name
, GLint size
, GLint attrib
)
367 GLint i
= _mesa_lookup_parameter_index(paramList
, -1, name
);
372 paramList
->Parameters
[i
].StateIndexes
[0] = attrib
;
376 gl_state_index state
[STATE_LENGTH
];
377 state
[0] = (gl_state_index
) attrib
;
380 i
= _mesa_add_parameter(paramList
, PROGRAM_INPUT
, name
,
381 size
, GL_NONE
, NULL
, state
);
388 #if 0 /* not used yet */
390 * Returns the number of 4-component registers needed to store a piece
391 * of GL state. For matrices this may be as many as 4 registers,
392 * everything else needs
396 sizeof_state_reference(const GLint
*stateTokens
)
398 if (stateTokens
[0] == STATE_MATRIX
) {
399 GLuint rows
= stateTokens
[4] - stateTokens
[3] + 1;
412 * Add a new state reference to the parameter list.
413 * This will be used when the program contains something like this:
414 * PARAM ambient = state.material.front.ambient;
416 * \param paramList the parameter list
417 * \param stateTokens an array of 5 (STATE_LENGTH) state tokens
418 * \return index of the new parameter.
421 _mesa_add_state_reference(struct gl_program_parameter_list
*paramList
,
422 const gl_state_index stateTokens
[STATE_LENGTH
])
424 const GLuint size
= 4; /* XXX fix */
428 /* Check if the state reference is already in the list */
429 for (index
= 0; index
< (GLint
) paramList
->NumParameters
; index
++) {
431 for (i
= 0; i
< STATE_LENGTH
; i
++) {
432 if (paramList
->Parameters
[index
].StateIndexes
[i
] == stateTokens
[i
]) {
439 if (match
== STATE_LENGTH
) {
440 /* this state reference is already in the parameter list */
445 name
= _mesa_program_state_string(stateTokens
);
446 index
= _mesa_add_parameter(paramList
, PROGRAM_STATE_VAR
, name
,
448 NULL
, (gl_state_index
*) stateTokens
);
449 paramList
->StateFlags
|= _mesa_program_state_flags(stateTokens
);
451 /* free name string here since we duplicated it in add_parameter() */
452 _mesa_free((void *) name
);
459 * Lookup a parameter value by name in the given parameter list.
460 * \return pointer to the float[4] values.
463 _mesa_lookup_parameter_value(const struct gl_program_parameter_list
*paramList
,
464 GLsizei nameLen
, const char *name
)
466 GLuint i
= _mesa_lookup_parameter_index(paramList
, nameLen
, name
);
470 return paramList
->ParameterValues
[i
];
475 * Given a program parameter name, find its position in the list of parameters.
476 * \param paramList the parameter list to search
477 * \param nameLen length of name (in chars).
478 * If length is negative, assume that name is null-terminated.
479 * \param name the name to search for
480 * \return index of parameter in the list.
483 _mesa_lookup_parameter_index(const struct gl_program_parameter_list
*paramList
,
484 GLsizei nameLen
, const char *name
)
492 /* name is null-terminated */
493 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
494 if (paramList
->Parameters
[i
].Name
&&
495 _mesa_strcmp(paramList
->Parameters
[i
].Name
, name
) == 0)
500 /* name is not null-terminated, use nameLen */
501 for (i
= 0; i
< (GLint
) paramList
->NumParameters
; i
++) {
502 if (paramList
->Parameters
[i
].Name
&&
503 _mesa_strncmp(paramList
->Parameters
[i
].Name
, name
, nameLen
) == 0
504 && _mesa_strlen(paramList
->Parameters
[i
].Name
) == (size_t)nameLen
)
513 * Look for a float vector in the given parameter list. The float vector
514 * may be of length 1, 2, 3 or 4. If swizzleOut is non-null, we'll try
515 * swizzling to find a match.
516 * \param list the parameter list to search
517 * \param v the float vector to search for
518 * \param size number of element in v
519 * \param posOut returns the position of the constant, if found
520 * \param swizzleOut returns a swizzle mask describing location of the
521 * vector elements if found.
522 * \return GL_TRUE if found, GL_FALSE if not found
525 _mesa_lookup_parameter_constant(const struct gl_program_parameter_list
*list
,
526 const GLfloat v
[], GLuint vSize
,
527 GLint
*posOut
, GLuint
*swizzleOut
)
537 for (i
= 0; i
< list
->NumParameters
; i
++) {
538 if (list
->Parameters
[i
].Type
== PROGRAM_CONSTANT
) {
540 /* swizzle not allowed */
542 for (j
= 0; j
< vSize
; j
++) {
543 if (v
[j
] == list
->ParameterValues
[i
][j
])
546 if (match
== vSize
) {
552 /* try matching w/ swizzle */
554 /* look for v[0] anywhere within float[4] value */
556 for (j
= 0; j
< 4; j
++) {
557 if (list
->ParameterValues
[i
][j
] == v
[0]) {
560 *swizzleOut
= MAKE_SWIZZLE4(j
, j
, j
, j
);
565 else if (vSize
<= list
->Parameters
[i
].Size
) {
566 /* see if we can match this constant (with a swizzle) */
568 GLuint match
= 0, j
, k
;
569 for (j
= 0; j
< vSize
; j
++) {
570 if (v
[j
] == list
->ParameterValues
[i
][j
]) {
575 for (k
= 0; k
< list
->Parameters
[i
].Size
; k
++) {
576 if (v
[j
] == list
->ParameterValues
[i
][k
]) {
584 /* smear last value to remaining positions */
588 if (match
== vSize
) {
590 *swizzleOut
= MAKE_SWIZZLE4(swz
[0], swz
[1], swz
[2], swz
[3]);
603 struct gl_program_parameter_list
*
604 _mesa_clone_parameter_list(const struct gl_program_parameter_list
*list
)
606 struct gl_program_parameter_list
*clone
;
609 clone
= _mesa_new_parameter_list();
613 /** Not too efficient, but correct */
614 for (i
= 0; i
< list
->NumParameters
; i
++) {
615 struct gl_program_parameter
*p
= list
->Parameters
+ i
;
616 GLuint size
= MIN2(p
->Size
, 4);
617 GLint j
= _mesa_add_parameter(clone
, p
->Type
, p
->Name
, size
, p
->DataType
,
618 list
->ParameterValues
[i
], NULL
);
620 /* copy state indexes */
621 if (p
->Type
== PROGRAM_STATE_VAR
) {
623 struct gl_program_parameter
*q
= clone
->Parameters
+ j
;
624 for (k
= 0; k
< STATE_LENGTH
; k
++) {
625 q
->StateIndexes
[k
] = p
->StateIndexes
[k
];
629 clone
->Parameters
[j
].Size
= p
->Size
;
633 clone
->StateFlags
= list
->StateFlags
;
640 * Return a new parameter list which is listA + listB.
642 struct gl_program_parameter_list
*
643 _mesa_combine_parameter_lists(const struct gl_program_parameter_list
*listA
,
644 const struct gl_program_parameter_list
*listB
)
646 struct gl_program_parameter_list
*list
;
649 list
= _mesa_clone_parameter_list(listA
);
652 for (i
= 0; i
< listB
->NumParameters
; i
++) {
653 struct gl_program_parameter
*param
= listB
->Parameters
+ i
;
654 _mesa_add_parameter(list
, param
->Type
, param
->Name
, param
->Size
,
656 listB
->ParameterValues
[i
],
657 param
->StateIndexes
);
662 list
= _mesa_clone_parameter_list(listB
);
673 * Find longest name of all uniform parameters in list.
676 _mesa_longest_parameter_name(const struct gl_program_parameter_list
*list
,
677 enum register_file type
)
679 GLuint i
, maxLen
= 0;
682 for (i
= 0; i
< list
->NumParameters
; i
++) {
683 if (list
->Parameters
[i
].Type
== type
) {
684 GLuint len
= _mesa_strlen(list
->Parameters
[i
].Name
);
694 * Count the number of parameters in the last that match the given type.
697 _mesa_num_parameters_of_type(const struct gl_program_parameter_list
*list
,
698 enum register_file type
)
702 for (i
= 0; i
< list
->NumParameters
; i
++) {
703 if (list
->Parameters
[i
].Type
== type
)