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
);
285 _mesa_free(prog
->Instructions
);
288 if (prog
->Parameters
) {
289 _mesa_free_parameter_list(prog
->Parameters
);
293 _mesa_free_parameter_list(prog
->Varying
);
296 /* XXX this is a little ugly */
297 if (prog
->Target
== GL_VERTEX_PROGRAM_ARB
) {
298 struct gl_vertex_program
*vprog
= (struct gl_vertex_program
*) prog
;
300 _mesa_free(vprog
->TnlData
);
308 * Return the gl_program object for a given ID.
309 * Basically just a wrapper for _mesa_HashLookup() to avoid a lot of
313 _mesa_lookup_program(GLcontext
*ctx
, GLuint id
)
316 return (struct gl_program
*) _mesa_HashLookup(ctx
->Shared
->Programs
, id
);
323 * Return a copy of a program.
324 * XXX Problem here if the program object is actually OO-derivation
325 * made by a device driver.
328 _mesa_clone_program(GLcontext
*ctx
, const struct gl_program
*prog
)
330 struct gl_program
*clone
;
332 clone
= _mesa_new_program(ctx
, prog
->Target
, prog
->Id
);
336 assert(clone
->Target
== prog
->Target
);
337 clone
->String
= (GLubyte
*) _mesa_strdup((char *) prog
->String
);
339 clone
->Format
= prog
->Format
;
340 clone
->Instructions
= _mesa_alloc_instructions(prog
->NumInstructions
);
341 if (!clone
->Instructions
) {
342 _mesa_delete_program(ctx
, clone
);
345 _mesa_copy_instructions(clone
->Instructions
, prog
->Instructions
,
346 prog
->NumInstructions
);
347 clone
->InputsRead
= prog
->InputsRead
;
348 clone
->OutputsWritten
= prog
->OutputsWritten
;
349 memcpy(clone
->TexturesUsed
, prog
->TexturesUsed
, sizeof(prog
->TexturesUsed
));
351 if (prog
->Parameters
)
352 clone
->Parameters
= _mesa_clone_parameter_list(prog
->Parameters
);
353 memcpy(clone
->LocalParams
, prog
->LocalParams
, sizeof(clone
->LocalParams
));
355 clone
->Varying
= _mesa_clone_parameter_list(prog
->Varying
);
356 if (prog
->Attributes
)
357 clone
->Attributes
= _mesa_clone_parameter_list(prog
->Attributes
);
358 memcpy(clone
->LocalParams
, prog
->LocalParams
, sizeof(clone
->LocalParams
));
359 clone
->NumInstructions
= prog
->NumInstructions
;
360 clone
->NumTemporaries
= prog
->NumTemporaries
;
361 clone
->NumParameters
= prog
->NumParameters
;
362 clone
->NumAttributes
= prog
->NumAttributes
;
363 clone
->NumAddressRegs
= prog
->NumAddressRegs
;
364 clone
->NumNativeInstructions
= prog
->NumNativeInstructions
;
365 clone
->NumNativeTemporaries
= prog
->NumNativeTemporaries
;
366 clone
->NumNativeParameters
= prog
->NumNativeParameters
;
367 clone
->NumNativeAttributes
= prog
->NumNativeAttributes
;
368 clone
->NumNativeAddressRegs
= prog
->NumNativeAddressRegs
;
369 clone
->NumAluInstructions
= prog
->NumAluInstructions
;
370 clone
->NumTexInstructions
= prog
->NumTexInstructions
;
371 clone
->NumTexIndirections
= prog
->NumTexIndirections
;
372 clone
->NumNativeAluInstructions
= prog
->NumNativeAluInstructions
;
373 clone
->NumNativeTexInstructions
= prog
->NumNativeTexInstructions
;
374 clone
->NumNativeTexIndirections
= prog
->NumNativeTexIndirections
;
376 switch (prog
->Target
) {
377 case GL_VERTEX_PROGRAM_ARB
:
379 const struct gl_vertex_program
*vp
380 = (const struct gl_vertex_program
*) prog
;
381 struct gl_vertex_program
*vpc
= (struct gl_vertex_program
*) clone
;
382 vpc
->IsPositionInvariant
= vp
->IsPositionInvariant
;
385 case GL_FRAGMENT_PROGRAM_ARB
:
387 const struct gl_fragment_program
*fp
388 = (const struct gl_fragment_program
*) prog
;
389 struct gl_fragment_program
*fpc
= (struct gl_fragment_program
*) clone
;
390 fpc
->FogOption
= fp
->FogOption
;
391 fpc
->UsesKill
= fp
->UsesKill
;
395 _mesa_problem(NULL
, "Unexpected target in _mesa_clone_program");
404 * Mixing ARB and NV vertex/fragment programs can be tricky.
405 * Note: GL_VERTEX_PROGRAM_ARB == GL_VERTEX_PROGRAM_NV
406 * but, GL_FRAGMENT_PROGRAM_ARB != GL_FRAGMENT_PROGRAM_NV
407 * The two different fragment program targets are supposed to be compatible
408 * to some extent (see GL_ARB_fragment_program spec).
409 * This function does the compatibility check.
412 compatible_program_targets(GLenum t1
, GLenum t2
)
416 if (t1
== GL_FRAGMENT_PROGRAM_ARB
&& t2
== GL_FRAGMENT_PROGRAM_NV
)
418 if (t1
== GL_FRAGMENT_PROGRAM_NV
&& t2
== GL_FRAGMENT_PROGRAM_ARB
)
425 /**********************************************************************/
427 /**********************************************************************/
431 * Bind a program (make it current)
432 * \note Called from the GL API dispatcher by both glBindProgramNV
433 * and glBindProgramARB.
436 _mesa_BindProgram(GLenum target
, GLuint id
)
438 struct gl_program
*curProg
, *newProg
;
439 GET_CURRENT_CONTEXT(ctx
);
440 ASSERT_OUTSIDE_BEGIN_END(ctx
);
442 FLUSH_VERTICES(ctx
, _NEW_PROGRAM
);
444 /* Error-check target and get curProg */
445 if ((target
== GL_VERTEX_PROGRAM_ARB
) && /* == GL_VERTEX_PROGRAM_NV */
446 (ctx
->Extensions
.NV_vertex_program
||
447 ctx
->Extensions
.ARB_vertex_program
)) {
448 curProg
= &ctx
->VertexProgram
.Current
->Base
;
450 else if ((target
== GL_FRAGMENT_PROGRAM_NV
451 && ctx
->Extensions
.NV_fragment_program
) ||
452 (target
== GL_FRAGMENT_PROGRAM_ARB
453 && ctx
->Extensions
.ARB_fragment_program
)) {
454 curProg
= &ctx
->FragmentProgram
.Current
->Base
;
457 _mesa_error(ctx
, GL_INVALID_ENUM
, "glBindProgramNV/ARB(target)");
462 * Get pointer to new program to bind.
463 * NOTE: binding to a non-existant program is not an error.
464 * That's supposed to be caught in glBegin.
467 /* Bind a default program */
469 if (target
== GL_VERTEX_PROGRAM_ARB
) /* == GL_VERTEX_PROGRAM_NV */
470 newProg
= ctx
->Shared
->DefaultVertexProgram
;
472 newProg
= ctx
->Shared
->DefaultFragmentProgram
;
475 /* Bind a user program */
476 newProg
= _mesa_lookup_program(ctx
, id
);
477 if (!newProg
|| newProg
== &_mesa_DummyProgram
) {
478 /* allocate a new program now */
479 newProg
= ctx
->Driver
.NewProgram(ctx
, target
, id
);
481 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBindProgramNV/ARB");
484 _mesa_HashInsert(ctx
->Shared
->Programs
, id
, newProg
);
486 else if (!compatible_program_targets(newProg
->Target
, target
)) {
487 _mesa_error(ctx
, GL_INVALID_OPERATION
,
488 "glBindProgramNV/ARB(target mismatch)");
493 /** All error checking is complete now **/
495 if (curProg
->Id
== id
) {
496 /* binding same program - no change */
500 /* unbind/delete oldProg */
501 if (curProg
->Id
!= 0) {
502 /* decrement refcount on previously bound fragment program */
504 /* and delete if refcount goes below one */
505 if (curProg
->RefCount
<= 0) {
506 /* the program ID was already removed from the hash table */
507 ctx
->Driver
.DeleteProgram(ctx
, curProg
);
512 if (target
== GL_VERTEX_PROGRAM_ARB
) { /* == GL_VERTEX_PROGRAM_NV */
513 ctx
->VertexProgram
.Current
= (struct gl_vertex_program
*) newProg
;
515 else if (target
== GL_FRAGMENT_PROGRAM_NV
||
516 target
== GL_FRAGMENT_PROGRAM_ARB
) {
517 ctx
->FragmentProgram
.Current
= (struct gl_fragment_program
*) newProg
;
521 /* Never null pointers */
522 ASSERT(ctx
->VertexProgram
.Current
);
523 ASSERT(ctx
->FragmentProgram
.Current
);
525 if (ctx
->Driver
.BindProgram
)
526 ctx
->Driver
.BindProgram(ctx
, target
, newProg
);
531 * Delete a list of programs.
532 * \note Not compiled into display lists.
533 * \note Called by both glDeleteProgramsNV and glDeleteProgramsARB.
536 _mesa_DeletePrograms(GLsizei n
, const GLuint
*ids
)
539 GET_CURRENT_CONTEXT(ctx
);
540 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
543 _mesa_error( ctx
, GL_INVALID_VALUE
, "glDeleteProgramsNV" );
547 for (i
= 0; i
< n
; i
++) {
549 struct gl_program
*prog
= _mesa_lookup_program(ctx
, ids
[i
]);
550 if (prog
== &_mesa_DummyProgram
) {
551 _mesa_HashRemove(ctx
->Shared
->Programs
, ids
[i
]);
554 /* Unbind program if necessary */
555 if (prog
->Target
== GL_VERTEX_PROGRAM_ARB
|| /* == GL_VERTEX_PROGRAM_NV */
556 prog
->Target
== GL_VERTEX_STATE_PROGRAM_NV
) {
557 if (ctx
->VertexProgram
.Current
&&
558 ctx
->VertexProgram
.Current
->Base
.Id
== ids
[i
]) {
559 /* unbind this currently bound program */
560 _mesa_BindProgram(prog
->Target
, 0);
563 else if (prog
->Target
== GL_FRAGMENT_PROGRAM_NV
||
564 prog
->Target
== GL_FRAGMENT_PROGRAM_ARB
) {
565 if (ctx
->FragmentProgram
.Current
&&
566 ctx
->FragmentProgram
.Current
->Base
.Id
== ids
[i
]) {
567 /* unbind this currently bound program */
568 _mesa_BindProgram(prog
->Target
, 0);
572 _mesa_problem(ctx
, "bad target in glDeleteProgramsNV");
575 /* The ID is immediately available for re-use now */
576 _mesa_HashRemove(ctx
->Shared
->Programs
, ids
[i
]);
578 if (prog
->RefCount
<= 0) {
579 ctx
->Driver
.DeleteProgram(ctx
, prog
);
588 * Generate a list of new program identifiers.
589 * \note Not compiled into display lists.
590 * \note Called by both glGenProgramsNV and glGenProgramsARB.
593 _mesa_GenPrograms(GLsizei n
, GLuint
*ids
)
597 GET_CURRENT_CONTEXT(ctx
);
598 ASSERT_OUTSIDE_BEGIN_END(ctx
);
601 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGenPrograms");
608 first
= _mesa_HashFindFreeKeyBlock(ctx
->Shared
->Programs
, n
);
610 /* Insert pointer to dummy program as placeholder */
611 for (i
= 0; i
< (GLuint
) n
; i
++) {
612 _mesa_HashInsert(ctx
->Shared
->Programs
, first
+ i
, &_mesa_DummyProgram
);
615 /* Return the program names */
616 for (i
= 0; i
< (GLuint
) n
; i
++) {