t_vb_program.c revision fff3b2f318a1d05228d0128f59fe556652c70dda 
1/*
2 * Mesa 3-D graphics library
3 * Version:  6.1
4 *
5 * Copyright (C) 1999-2004  Brian Paul   All Rights Reserved.
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
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.
23 */
24
25
26/**
27 * \file tnl/t_vb_program.c
28 * \brief Pipeline stage for executing NVIDIA vertex programs.
29 * \author Brian Paul,  Keith Whitwell
30 */
31
32
33#include "glheader.h"
34#include "api_noop.h"
35#include "colormac.h"
36#include "context.h"
37#include "dlist.h"
38#include "hash.h"
39#include "light.h"
40#include "macros.h"
41#include "imports.h"
42#include "simple_list.h"
43#include "mtypes.h"
44#include "nvvertprog.h"
45#include "nvvertexec.h"
46#include "nvprogram.h"
47
48#include "math/m_translate.h"
49
50#include "t_context.h"
51#include "t_pipeline.h"
52
53
54/**
55 * \warning These values _MUST_ match the values in the OutputRegisters[]
56 * array in vpparse.c!!!
57 */
58#define VERT_RESULT_HPOS 0
59#define VERT_RESULT_COL0 1
60#define VERT_RESULT_COL1 2
61#define VERT_RESULT_BFC0 3
62#define VERT_RESULT_BFC1 4
63#define VERT_RESULT_FOGC 5
64#define VERT_RESULT_PSIZ 6
65#define VERT_RESULT_TEX0 7
66#define VERT_RESULT_TEX1 8
67#define VERT_RESULT_TEX2 9
68#define VERT_RESULT_TEX3 10
69#define VERT_RESULT_TEX4 11
70#define VERT_RESULT_TEX5 12
71#define VERT_RESULT_TEX6 13
72#define VERT_RESULT_TEX7 14
73
74
75/*!
76 * Private storage for the vertex program pipeline stage.
77 */
78struct vp_stage_data {
79   /** The results of running the vertex program go into these arrays. */
80   GLvector4f attribs[15];
81
82   GLvector4f ndcCoords;              /**< normalized device coords */
83   GLubyte *clipmask;                 /**< clip flags */
84   GLubyte ormask, andmask;           /**< for clipping */
85};
86
87
88#define VP_STAGE_DATA(stage) ((struct vp_stage_data *)(stage->privatePtr))
89
90
91/**
92 * This function executes vertex programs
93 */
94static GLboolean
95run_vp( GLcontext *ctx, struct tnl_pipeline_stage *stage )
96{
97   TNLcontext *tnl = TNL_CONTEXT(ctx);
98   struct vp_stage_data *store = VP_STAGE_DATA(stage);
99   struct vertex_buffer *VB = &tnl->vb;
100   struct vertex_program *program = ctx->VertexProgram.Current;
101   GLuint i;
102
103   /* load program parameter registers (they're read-only) */
104   _mesa_init_vp_per_primitive_registers(ctx);
105
106   for (i = 0; i < VB->Count; i++) {
107      GLuint attr;
108
109      _mesa_init_vp_per_vertex_registers(ctx);
110
111#if 0
112      printf("Input  %d: %f, %f, %f, %f\n", i,
113             VB->AttribPtr[0]->data[i][0],
114             VB->AttribPtr[0]->data[i][1],
115             VB->AttribPtr[0]->data[i][2],
116             VB->AttribPtr[0]->data[i][3]);
117      printf("   color: %f, %f, %f, %f\n",
118             VB->AttribPtr[3]->data[i][0],
119             VB->AttribPtr[3]->data[i][1],
120             VB->AttribPtr[3]->data[i][2],
121             VB->AttribPtr[3]->data[i][3]);
122      printf("  normal: %f, %f, %f, %f\n",
123             VB->AttribPtr[2]->data[i][0],
124             VB->AttribPtr[2]->data[i][1],
125             VB->AttribPtr[2]->data[i][2],
126             VB->AttribPtr[2]->data[i][3]);
127#endif
128
129      /* the vertex array case */
130      for (attr = 0; attr < VERT_ATTRIB_MAX; attr++) {
131	 if (program->InputsRead & (1 << attr)) {
132	    const GLubyte *ptr = (const GLubyte*) VB->AttribPtr[attr]->data;
133	    const GLuint size = VB->AttribPtr[attr]->size;
134	    const GLuint stride = VB->AttribPtr[attr]->stride;
135	    const GLfloat *data = (GLfloat *) (ptr + stride * i);
136	    COPY_CLEAN_4V(ctx->VertexProgram.Inputs[attr], size, data);
137	 }
138      }
139
140      /* execute the program */
141      ASSERT(program);
142      _mesa_exec_vertex_program(ctx, program);
143
144      /* Fixup fog an point size results if needed */
145      if (ctx->Fog.Enabled &&
146          (program->OutputsWritten & (1 << VERT_RESULT_FOGC)) == 0) {
147         ctx->VertexProgram.Outputs[VERT_RESULT_FOGC][0] = 1.0;
148      }
149
150      if (ctx->VertexProgram.PointSizeEnabled &&
151          (program->OutputsWritten & (1 << VERT_RESULT_PSIZ)) == 0) {
152         ctx->VertexProgram.Outputs[VERT_RESULT_PSIZ][0] = ctx->Point.Size;
153      }
154
155      /* copy the output registers into the VB->attribs arrays */
156      /* XXX (optimize) could use a conditional and smaller loop limit here */
157      for (attr = 0; attr < 15; attr++) {
158         COPY_4V(store->attribs[attr].data[i],
159                 ctx->VertexProgram.Outputs[attr]);
160      }
161   }
162
163   /* Setup the VB pointers so that the next pipeline stages get
164    * their data from the right place (the program output arrays).
165    */
166   VB->ClipPtr = &store->attribs[VERT_RESULT_HPOS];
167   VB->ClipPtr->size = 4;
168   VB->ClipPtr->count = VB->Count;
169   VB->ColorPtr[0] = &store->attribs[VERT_RESULT_COL0];
170   VB->ColorPtr[1] = &store->attribs[VERT_RESULT_BFC0];
171   VB->SecondaryColorPtr[0] = &store->attribs[VERT_RESULT_COL1];
172   VB->SecondaryColorPtr[1] = &store->attribs[VERT_RESULT_BFC1];
173   VB->FogCoordPtr = &store->attribs[VERT_RESULT_FOGC];
174   VB->PointSizePtr = &store->attribs[VERT_RESULT_PSIZ];
175
176   VB->AttribPtr[VERT_ATTRIB_COLOR0] = VB->ColorPtr[0];
177   VB->AttribPtr[VERT_ATTRIB_COLOR1] = VB->SecondaryColorPtr[0];
178   VB->AttribPtr[VERT_ATTRIB_FOG] = VB->FogCoordPtr;
179   VB->AttribPtr[_TNL_ATTRIB_POINTSIZE] = &store->attribs[VERT_RESULT_PSIZ];
180
181   for (i = 0; i < ctx->Const.MaxTextureUnits; i++) {
182      VB->AttribPtr[VERT_ATTRIB_TEX0+i] = VB->TexCoordPtr[i] =
183	 &store->attribs[VERT_RESULT_TEX0 + i];
184   }
185
186
187
188   /* Cliptest and perspective divide.  Clip functions must clear
189    * the clipmask.
190    */
191   store->ormask = 0;
192   store->andmask = CLIP_ALL_BITS;
193
194   if (tnl->NeedNdcCoords) {
195      VB->NdcPtr =
196         _mesa_clip_tab[VB->ClipPtr->size]( VB->ClipPtr,
197                                            &store->ndcCoords,
198                                            store->clipmask,
199                                            &store->ormask,
200                                            &store->andmask );
201   }
202   else {
203      VB->NdcPtr = NULL;
204      _mesa_clip_np_tab[VB->ClipPtr->size]( VB->ClipPtr,
205                                            NULL,
206                                            store->clipmask,
207                                            &store->ormask,
208                                            &store->andmask );
209   }
210
211   if (store->andmask)  /* All vertices are outside the frustum */
212      return GL_FALSE;
213
214
215   /* This is where we'd do clip testing against the user-defined
216    * clipping planes, but they're not supported by vertex programs.
217    */
218
219   VB->ClipOrMask = store->ormask;
220   VB->ClipMask = store->clipmask;
221
222   return GL_TRUE;
223}
224
225
226/**
227 * This function validates stuff.
228 */
229static GLboolean run_validate_program( GLcontext *ctx,
230					struct tnl_pipeline_stage *stage )
231{
232#if 000
233   /* XXX do we need any validation for vertex programs? */
234   GLuint ind = 0;
235   light_func *tab;
236
237   if (ctx->Visual.rgbMode) {
238      if (ctx->Light._NeedVertices) {
239	 if (ctx->Light.Model.ColorControl == GL_SEPARATE_SPECULAR_COLOR)
240	    tab = _tnl_light_spec_tab;
241	 else
242	    tab = _tnl_light_tab;
243      }
244      else {
245	 if (ctx->Light.EnabledList.next == ctx->Light.EnabledList.prev)
246	    tab = _tnl_light_fast_single_tab;
247	 else
248	    tab = _tnl_light_fast_tab;
249      }
250   }
251   else
252      tab = _tnl_light_ci_tab;
253
254   if (ctx->Light.ColorMaterialEnabled)
255      ind |= LIGHT_COLORMATERIAL;
256
257   if (ctx->Light.Model.TwoSide)
258      ind |= LIGHT_TWOSIDE;
259
260   VP_STAGE_DATA(stage)->light_func_tab = &tab[ind];
261
262   /* This and the above should only be done on _NEW_LIGHT:
263    */
264   _mesa_validate_all_lighting_tables( ctx );
265#endif
266
267   /* Now run the stage...
268    */
269   stage->run = run_vp;
270   return stage->run( ctx, stage );
271}
272
273
274
275/**
276 * Called the first time stage->run is called.  In effect, don't
277 * allocate data until the first time the stage is run.
278 */
279static GLboolean run_init_vp( GLcontext *ctx,
280                              struct tnl_pipeline_stage *stage )
281{
282   TNLcontext *tnl = TNL_CONTEXT(ctx);
283   struct vertex_buffer *VB = &(tnl->vb);
284   struct vp_stage_data *store;
285   const GLuint size = VB->Size;
286   GLuint i;
287
288   stage->privatePtr = MALLOC(sizeof(*store));
289   store = VP_STAGE_DATA(stage);
290   if (!store)
291      return GL_FALSE;
292
293   /* Allocate arrays of vertex output values */
294   for (i = 0; i < 15; i++) {
295      _mesa_vector4f_alloc( &store->attribs[i], 0, size, 32 );
296      store->attribs[i].size = 4;
297   }
298
299   /* a few other misc allocations */
300   _mesa_vector4f_alloc( &store->ndcCoords, 0, size, 32 );
301   store->clipmask = (GLubyte *) ALIGN_MALLOC(sizeof(GLubyte)*size, 32 );
302
303   /* Now validate the stage derived data...
304    */
305   stage->run = run_validate_program;
306   return stage->run( ctx, stage );
307}
308
309
310
311/**
312 * Check if vertex program mode is enabled.
313 * If so, configure the pipeline stage's type, inputs, and outputs.
314 */
315static void check_vp( GLcontext *ctx, struct tnl_pipeline_stage *stage )
316{
317   stage->active = ctx->VertexProgram._Enabled;
318
319   if (stage->active) {
320      /* Set stage->inputs equal to the bitmask of vertex attributes
321       * which the program needs for inputs.
322       */
323      stage->inputs = ctx->VertexProgram.Current->InputsRead;
324   }
325}
326
327
328/**
329 * Destructor for this pipeline stage.
330 */
331static void dtr( struct tnl_pipeline_stage *stage )
332{
333   struct vp_stage_data *store = VP_STAGE_DATA(stage);
334
335   if (store) {
336      GLuint i;
337
338      /* free the vertex program result arrays */
339      for (i = 0; i < 15; i++)
340         _mesa_vector4f_free( &store->attribs[i] );
341
342      /* free misc arrays */
343      _mesa_vector4f_free( &store->ndcCoords );
344      ALIGN_FREE( store->clipmask );
345
346      FREE( store );
347      stage->privatePtr = NULL;
348   }
349}
350
351/**
352 * Public description of this pipeline stage.
353 */
354const struct tnl_pipeline_stage _tnl_vertex_program_stage =
355{
356   "vertex-program",
357   _NEW_ALL,	/*XXX FIX */	/* recheck */
358   _NEW_ALL,	/*XXX FIX */    /* recalc */
359   GL_FALSE,			/* active */
360   0,				/* inputs - calculated on the fly */
361   _TNL_BITS_PROG_ANY,		/* outputs -- could calculate */
362   0,				/* changed_inputs */
363   NULL,			/* private_data */
364   dtr,				/* destroy */
365   check_vp,			/* check */
366   run_init_vp			/* run -- initially set to ctr */
367};
368