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.
27 * Vertex and fragment program support functions.
36 #include "prog_parameter.h"
37 #include "prog_instruction.h"
41 * A pointer to this dummy program is put into the hash table when
42 * glGenPrograms is called.
44 struct gl_program _mesa_DummyProgram
;
48 * Init context's vertex/fragment program state
51 _mesa_init_program(GLcontext
*ctx
)
55 ctx
->Program
.ErrorPos
= -1;
56 ctx
->Program
.ErrorString
= _mesa_strdup("");
58 #if FEATURE_NV_vertex_program || FEATURE_ARB_vertex_program
59 ctx
->VertexProgram
.Enabled
= GL_FALSE
;
60 ctx
->VertexProgram
.PointSizeEnabled
= GL_FALSE
;
61 ctx
->VertexProgram
.TwoSideEnabled
= GL_FALSE
;
62 ctx
->VertexProgram
.Current
= (struct gl_vertex_program
*) ctx
->Shared
->DefaultVertexProgram
;
63 assert(ctx
->VertexProgram
.Current
);
64 ctx
->VertexProgram
.Current
->Base
.RefCount
++;
65 for (i
= 0; i
< MAX_NV_VERTEX_PROGRAM_PARAMS
/ 4; i
++) {
66 ctx
->VertexProgram
.TrackMatrix
[i
] = GL_NONE
;
67 ctx
->VertexProgram
.TrackMatrixTransform
[i
] = GL_IDENTITY_NV
;
71 #if FEATURE_NV_fragment_program || FEATURE_ARB_fragment_program
72 ctx
->FragmentProgram
.Enabled
= GL_FALSE
;
73 ctx
->FragmentProgram
.Current
= (struct gl_fragment_program
*) ctx
->Shared
->DefaultFragmentProgram
;
74 assert(ctx
->FragmentProgram
.Current
);
75 ctx
->FragmentProgram
.Current
->Base
.RefCount
++;
78 /* XXX probably move this stuff */
79 #if FEATURE_ATI_fragment_shader
80 ctx
->ATIFragmentShader
.Enabled
= GL_FALSE
;
81 ctx
->ATIFragmentShader
.Current
= (struct ati_fragment_shader
*) ctx
->Shared
->DefaultFragmentShader
;
82 assert(ctx
->ATIFragmentShader
.Current
);
83 ctx
->ATIFragmentShader
.Current
->RefCount
++;
89 * Free a context's vertex/fragment program state
92 _mesa_free_program_data(GLcontext
*ctx
)
94 #if FEATURE_NV_vertex_program || FEATURE_ARB_vertex_program
95 if (ctx
->VertexProgram
.Current
) {
96 ctx
->VertexProgram
.Current
->Base
.RefCount
--;
97 if (ctx
->VertexProgram
.Current
->Base
.RefCount
<= 0)
98 ctx
->Driver
.DeleteProgram(ctx
, &(ctx
->VertexProgram
.Current
->Base
));
101 #if FEATURE_NV_fragment_program || FEATURE_ARB_fragment_program
102 if (ctx
->FragmentProgram
.Current
) {
103 ctx
->FragmentProgram
.Current
->Base
.RefCount
--;
104 if (ctx
->FragmentProgram
.Current
->Base
.RefCount
<= 0)
105 ctx
->Driver
.DeleteProgram(ctx
, &(ctx
->FragmentProgram
.Current
->Base
));
108 /* XXX probably move this stuff */
109 #if FEATURE_ATI_fragment_shader
110 if (ctx
->ATIFragmentShader
.Current
) {
111 ctx
->ATIFragmentShader
.Current
->RefCount
--;
112 if (ctx
->ATIFragmentShader
.Current
->RefCount
<= 0) {
113 _mesa_free(ctx
->ATIFragmentShader
.Current
);
117 _mesa_free((void *) ctx
->Program
.ErrorString
);
124 * Set the vertex/fragment program error state (position and error string).
125 * This is generally called from within the parsers.
128 _mesa_set_program_error(GLcontext
*ctx
, GLint pos
, const char *string
)
130 ctx
->Program
.ErrorPos
= pos
;
131 _mesa_free((void *) ctx
->Program
.ErrorString
);
134 ctx
->Program
.ErrorString
= _mesa_strdup(string
);
139 * Find the line number and column for 'pos' within 'string'.
140 * Return a copy of the line which contains 'pos'. Free the line with
142 * \param string the program string
143 * \param pos the position within the string
144 * \param line returns the line number corresponding to 'pos'.
145 * \param col returns the column number corresponding to 'pos'.
146 * \return copy of the line containing 'pos'.
149 _mesa_find_line_column(const GLubyte
*string
, const GLubyte
*pos
,
150 GLint
*line
, GLint
*col
)
152 const GLubyte
*lineStart
= string
;
153 const GLubyte
*p
= string
;
160 if (*p
== (GLubyte
) '\n') {
167 *col
= (pos
- lineStart
) + 1;
169 /* return copy of this line */
170 while (*p
!= 0 && *p
!= '\n')
173 s
= (GLubyte
*) _mesa_malloc(len
+ 1);
174 _mesa_memcpy(s
, lineStart
, len
);
182 * Initialize a new vertex/fragment program object.
184 static struct gl_program
*
185 _mesa_init_program_struct( GLcontext
*ctx
, struct gl_program
*prog
,
186 GLenum target
, GLuint id
)
190 _mesa_bzero(prog
, sizeof(*prog
));
192 prog
->Target
= target
;
193 prog
->Resident
= GL_TRUE
;
195 prog
->Format
= GL_PROGRAM_FORMAT_ASCII_ARB
;
203 * Initialize a new fragment program object.
206 _mesa_init_fragment_program( GLcontext
*ctx
, struct gl_fragment_program
*prog
,
207 GLenum target
, GLuint id
)
210 return _mesa_init_program_struct( ctx
, &prog
->Base
, target
, id
);
217 * Initialize a new vertex program object.
220 _mesa_init_vertex_program( GLcontext
*ctx
, struct gl_vertex_program
*prog
,
221 GLenum target
, GLuint id
)
224 return _mesa_init_program_struct( ctx
, &prog
->Base
, target
, id
);
231 * Allocate and initialize a new fragment/vertex program object but
232 * don't put it into the program hash table. Called via
233 * ctx->Driver.NewProgram. May be overridden (ie. replaced) by a
234 * device driver function to implement OO deriviation with additional
235 * types not understood by this function.
238 * \param id program id/number
239 * \param target program target/type
240 * \return pointer to new program object
243 _mesa_new_program(GLcontext
*ctx
, GLenum target
, GLuint id
)
246 case GL_VERTEX_PROGRAM_ARB
: /* == GL_VERTEX_PROGRAM_NV */
247 return _mesa_init_vertex_program(ctx
, CALLOC_STRUCT(gl_vertex_program
),
249 case GL_FRAGMENT_PROGRAM_NV
:
250 case GL_FRAGMENT_PROGRAM_ARB
:
251 return _mesa_init_fragment_program(ctx
,
252 CALLOC_STRUCT(gl_fragment_program
),
255 _mesa_problem(ctx
, "bad target in _mesa_new_program");
262 * Delete a program and remove it from the hash table, ignoring the
264 * Called via ctx->Driver.DeleteProgram. May be wrapped (OO deriviation)
265 * by a device driver function.
268 _mesa_delete_program(GLcontext
*ctx
, struct gl_program
*prog
)
273 if (prog
== &_mesa_DummyProgram
)
277 _mesa_free(prog
->String
);
279 if (prog
->Instructions
) {
281 for (i
= 0; i
< prog
->NumInstructions
; i
++) {
282 if (prog
->Instructions
[i
].Data
)
283 _mesa_free(prog
->Instructions
[i
].Data
);
284 if (prog
->Instructions
[i
].Comment
)
285 _mesa_free((char *) prog
->Instructions
[i
].Comment
);
287 _mesa_free(prog
->Instructions
);
290 if (prog
->Parameters
) {
291 _mesa_free_parameter_list(prog
->Parameters
);
294 _mesa_free_parameter_list(prog
->Varying
);
296 if (prog
->Attributes
) {
297 _mesa_free_parameter_list(prog
->Attributes
);
300 /* XXX this is a little ugly */
301 if (prog
->Target
== GL_VERTEX_PROGRAM_ARB
) {
302 struct gl_vertex_program
*vprog
= (struct gl_vertex_program
*) prog
;
304 _mesa_free(vprog
->TnlData
);
312 * Return the gl_program object for a given ID.
313 * Basically just a wrapper for _mesa_HashLookup() to avoid a lot of
317 _mesa_lookup_program(GLcontext
*ctx
, GLuint id
)
320 return (struct gl_program
*) _mesa_HashLookup(ctx
->Shared
->Programs
, id
);
327 * Return a copy of a program.
328 * XXX Problem here if the program object is actually OO-derivation
329 * made by a device driver.
332 _mesa_clone_program(GLcontext
*ctx
, const struct gl_program
*prog
)
334 struct gl_program
*clone
;
336 clone
= ctx
->Driver
.NewProgram(ctx
, prog
->Target
, prog
->Id
);
340 assert(clone
->Target
== prog
->Target
);
341 clone
->String
= (GLubyte
*) _mesa_strdup((char *) prog
->String
);
343 clone
->Format
= prog
->Format
;
344 clone
->Instructions
= _mesa_alloc_instructions(prog
->NumInstructions
);
345 if (!clone
->Instructions
) {
346 _mesa_delete_program(ctx
, clone
);
349 _mesa_copy_instructions(clone
->Instructions
, prog
->Instructions
,
350 prog
->NumInstructions
);
351 clone
->InputsRead
= prog
->InputsRead
;
352 clone
->OutputsWritten
= prog
->OutputsWritten
;
353 memcpy(clone
->TexturesUsed
, prog
->TexturesUsed
, sizeof(prog
->TexturesUsed
));
355 if (prog
->Parameters
)
356 clone
->Parameters
= _mesa_clone_parameter_list(prog
->Parameters
);
357 memcpy(clone
->LocalParams
, prog
->LocalParams
, sizeof(clone
->LocalParams
));
359 clone
->Varying
= _mesa_clone_parameter_list(prog
->Varying
);
360 if (prog
->Attributes
)
361 clone
->Attributes
= _mesa_clone_parameter_list(prog
->Attributes
);
362 memcpy(clone
->LocalParams
, prog
->LocalParams
, sizeof(clone
->LocalParams
));
363 clone
->NumInstructions
= prog
->NumInstructions
;
364 clone
->NumTemporaries
= prog
->NumTemporaries
;
365 clone
->NumParameters
= prog
->NumParameters
;
366 clone
->NumAttributes
= prog
->NumAttributes
;
367 clone
->NumAddressRegs
= prog
->NumAddressRegs
;
368 clone
->NumNativeInstructions
= prog
->NumNativeInstructions
;
369 clone
->NumNativeTemporaries
= prog
->NumNativeTemporaries
;
370 clone
->NumNativeParameters
= prog
->NumNativeParameters
;
371 clone
->NumNativeAttributes
= prog
->NumNativeAttributes
;
372 clone
->NumNativeAddressRegs
= prog
->NumNativeAddressRegs
;
373 clone
->NumAluInstructions
= prog
->NumAluInstructions
;
374 clone
->NumTexInstructions
= prog
->NumTexInstructions
;
375 clone
->NumTexIndirections
= prog
->NumTexIndirections
;
376 clone
->NumNativeAluInstructions
= prog
->NumNativeAluInstructions
;
377 clone
->NumNativeTexInstructions
= prog
->NumNativeTexInstructions
;
378 clone
->NumNativeTexIndirections
= prog
->NumNativeTexIndirections
;
380 switch (prog
->Target
) {
381 case GL_VERTEX_PROGRAM_ARB
:
383 const struct gl_vertex_program
*vp
384 = (const struct gl_vertex_program
*) prog
;
385 struct gl_vertex_program
*vpc
= (struct gl_vertex_program
*) clone
;
386 vpc
->IsPositionInvariant
= vp
->IsPositionInvariant
;
389 case GL_FRAGMENT_PROGRAM_ARB
:
391 const struct gl_fragment_program
*fp
392 = (const struct gl_fragment_program
*) prog
;
393 struct gl_fragment_program
*fpc
= (struct gl_fragment_program
*) clone
;
394 fpc
->FogOption
= fp
->FogOption
;
395 fpc
->UsesKill
= fp
->UsesKill
;
399 _mesa_problem(NULL
, "Unexpected target in _mesa_clone_program");
408 * Mixing ARB and NV vertex/fragment programs can be tricky.
409 * Note: GL_VERTEX_PROGRAM_ARB == GL_VERTEX_PROGRAM_NV
410 * but, GL_FRAGMENT_PROGRAM_ARB != GL_FRAGMENT_PROGRAM_NV
411 * The two different fragment program targets are supposed to be compatible
412 * to some extent (see GL_ARB_fragment_program spec).
413 * This function does the compatibility check.
416 compatible_program_targets(GLenum t1
, GLenum t2
)
420 if (t1
== GL_FRAGMENT_PROGRAM_ARB
&& t2
== GL_FRAGMENT_PROGRAM_NV
)
422 if (t1
== GL_FRAGMENT_PROGRAM_NV
&& t2
== GL_FRAGMENT_PROGRAM_ARB
)
429 /**********************************************************************/
431 /**********************************************************************/
435 * Bind a program (make it current)
436 * \note Called from the GL API dispatcher by both glBindProgramNV
437 * and glBindProgramARB.
440 _mesa_BindProgram(GLenum target
, GLuint id
)
442 struct gl_program
*curProg
, *newProg
;
443 GET_CURRENT_CONTEXT(ctx
);
444 ASSERT_OUTSIDE_BEGIN_END(ctx
);
446 FLUSH_VERTICES(ctx
, _NEW_PROGRAM
);
448 /* Error-check target and get curProg */
449 if ((target
== GL_VERTEX_PROGRAM_ARB
) && /* == GL_VERTEX_PROGRAM_NV */
450 (ctx
->Extensions
.NV_vertex_program
||
451 ctx
->Extensions
.ARB_vertex_program
)) {
452 curProg
= &ctx
->VertexProgram
.Current
->Base
;
454 else if ((target
== GL_FRAGMENT_PROGRAM_NV
455 && ctx
->Extensions
.NV_fragment_program
) ||
456 (target
== GL_FRAGMENT_PROGRAM_ARB
457 && ctx
->Extensions
.ARB_fragment_program
)) {
458 curProg
= &ctx
->FragmentProgram
.Current
->Base
;
461 _mesa_error(ctx
, GL_INVALID_ENUM
, "glBindProgramNV/ARB(target)");
466 * Get pointer to new program to bind.
467 * NOTE: binding to a non-existant program is not an error.
468 * That's supposed to be caught in glBegin.
471 /* Bind a default program */
473 if (target
== GL_VERTEX_PROGRAM_ARB
) /* == GL_VERTEX_PROGRAM_NV */
474 newProg
= ctx
->Shared
->DefaultVertexProgram
;
476 newProg
= ctx
->Shared
->DefaultFragmentProgram
;
479 /* Bind a user program */
480 newProg
= _mesa_lookup_program(ctx
, id
);
481 if (!newProg
|| newProg
== &_mesa_DummyProgram
) {
482 /* allocate a new program now */
483 newProg
= ctx
->Driver
.NewProgram(ctx
, target
, id
);
485 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBindProgramNV/ARB");
488 _mesa_HashInsert(ctx
->Shared
->Programs
, id
, newProg
);
490 else if (!compatible_program_targets(newProg
->Target
, target
)) {
491 _mesa_error(ctx
, GL_INVALID_OPERATION
,
492 "glBindProgramNV/ARB(target mismatch)");
497 /** All error checking is complete now **/
499 if (curProg
->Id
== id
) {
500 /* binding same program - no change */
504 /* unbind/delete oldProg */
505 if (curProg
->Id
!= 0) {
506 /* decrement refcount on previously bound fragment program */
508 /* and delete if refcount goes below one */
509 if (curProg
->RefCount
<= 0) {
510 /* the program ID was already removed from the hash table */
511 ctx
->Driver
.DeleteProgram(ctx
, curProg
);
516 if (target
== GL_VERTEX_PROGRAM_ARB
) { /* == GL_VERTEX_PROGRAM_NV */
517 ctx
->VertexProgram
.Current
= (struct gl_vertex_program
*) newProg
;
519 else if (target
== GL_FRAGMENT_PROGRAM_NV
||
520 target
== GL_FRAGMENT_PROGRAM_ARB
) {
521 ctx
->FragmentProgram
.Current
= (struct gl_fragment_program
*) newProg
;
525 /* Never null pointers */
526 ASSERT(ctx
->VertexProgram
.Current
);
527 ASSERT(ctx
->FragmentProgram
.Current
);
529 if (ctx
->Driver
.BindProgram
)
530 ctx
->Driver
.BindProgram(ctx
, target
, newProg
);
535 * Delete a list of programs.
536 * \note Not compiled into display lists.
537 * \note Called by both glDeleteProgramsNV and glDeleteProgramsARB.
540 _mesa_DeletePrograms(GLsizei n
, const GLuint
*ids
)
543 GET_CURRENT_CONTEXT(ctx
);
544 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
547 _mesa_error( ctx
, GL_INVALID_VALUE
, "glDeleteProgramsNV" );
551 for (i
= 0; i
< n
; i
++) {
553 struct gl_program
*prog
= _mesa_lookup_program(ctx
, ids
[i
]);
554 if (prog
== &_mesa_DummyProgram
) {
555 _mesa_HashRemove(ctx
->Shared
->Programs
, ids
[i
]);
558 /* Unbind program if necessary */
559 if (prog
->Target
== GL_VERTEX_PROGRAM_ARB
|| /* == GL_VERTEX_PROGRAM_NV */
560 prog
->Target
== GL_VERTEX_STATE_PROGRAM_NV
) {
561 if (ctx
->VertexProgram
.Current
&&
562 ctx
->VertexProgram
.Current
->Base
.Id
== ids
[i
]) {
563 /* unbind this currently bound program */
564 _mesa_BindProgram(prog
->Target
, 0);
567 else if (prog
->Target
== GL_FRAGMENT_PROGRAM_NV
||
568 prog
->Target
== GL_FRAGMENT_PROGRAM_ARB
) {
569 if (ctx
->FragmentProgram
.Current
&&
570 ctx
->FragmentProgram
.Current
->Base
.Id
== ids
[i
]) {
571 /* unbind this currently bound program */
572 _mesa_BindProgram(prog
->Target
, 0);
576 _mesa_problem(ctx
, "bad target in glDeleteProgramsNV");
579 /* The ID is immediately available for re-use now */
580 _mesa_HashRemove(ctx
->Shared
->Programs
, ids
[i
]);
582 if (prog
->RefCount
<= 0) {
583 ctx
->Driver
.DeleteProgram(ctx
, prog
);
592 * Generate a list of new program identifiers.
593 * \note Not compiled into display lists.
594 * \note Called by both glGenProgramsNV and glGenProgramsARB.
597 _mesa_GenPrograms(GLsizei n
, GLuint
*ids
)
601 GET_CURRENT_CONTEXT(ctx
);
602 ASSERT_OUTSIDE_BEGIN_END(ctx
);
605 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGenPrograms");
612 first
= _mesa_HashFindFreeKeyBlock(ctx
->Shared
->Programs
, n
);
614 /* Insert pointer to dummy program as placeholder */
615 for (i
= 0; i
< (GLuint
) n
; i
++) {
616 _mesa_HashInsert(ctx
->Shared
->Programs
, first
+ i
, &_mesa_DummyProgram
);
619 /* Return the program names */
620 for (i
= 0; i
< (GLuint
) n
; i
++) {