ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/raycalls.c
Revision: 2.19
Committed: Fri Feb 18 00:40:25 2011 UTC (13 years, 2 months ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.18: +4 -2 lines
Log Message:
Major code reorg, moving mgflib to common and introducing BSDF material

File Contents

# User Rev Content
1 greg 2.1 #ifndef lint
2 greg 2.19 static const char RCSid[] = "$Id: raycalls.c,v 2.18 2010/09/26 15:51:15 greg Exp $";
3 greg 2.1 #endif
4     /*
5     * raycalls.c - interface for running Radiance rendering as a library
6     *
7     * External symbols declared in ray.h
8     */
9    
10 greg 2.2 #include "copyright.h"
11 greg 2.1
12     /*
13     * These routines are designed to aid the programmer who wishes
14     * to call Radiance as a library. Unfortunately, the system was
15     * not originally intended to be run this way, and there are some
16     * awkward limitations to contend with. The most irritating
17     * perhaps is that the global variables and functions do not have
18     * a prefix, and the symbols are a bit generic. This results in a
19     * serious invasion of the calling application's name-space, and
20     * you may need to rename either some Radiance routines or some
21     * of your routines to avoid conflicts. Another limitation is
22     * that the global variables are not gathered together into any
23     * sort of context, so it is impossible to simultaneously run
24     * this library on multiple scenes or in multiple threads.
25     * You get one scene and one thread, and if you want more, you
26 greg 2.10 * will have to go with the process model defined in raypcalls.c.
27     * Finally, unrecoverable errors result in a call to the application-
28     * defined function quit(). The usual thing to do is to call exit().
29 greg 2.1 * You might want to do something else instead, like
30     * call setjmp()/longjmp() to bring you back to the calling
31     * function for recovery. You may also wish to define your own
32     * wputs(s) and eputs(s) functions to output warning and error
33     * messages, respectively.
34     *
35     * With those caveats, we have attempted to make the interface
36     * as simple as we can. Global variables and their defaults
37     * are defined below, and including "ray.h" declares these
38     * along with all the routines you are likely to need. First,
39     * assign the global variable progname to your argv[0], then
40     * change the rendering parameters as you like. If you have a set
41     * of option arguments you are working from, the getrenderopt(ac,av)
42     * call should be very useful. Before tracing any rays, you
43     * must read in the octree with a call to ray_init(oct).
44     * Passing NULL for the file name causes ray_init() to read
45     * the octree from the standard input -- rarely a good idea.
46     * However, one may read an octree from a program (such as
47     * oconv) by preceding a shell command by a '!' character.
48     *
49     * To trace a ray, define a RAY object myRay and assign:
50     *
51     * myRay.rorg = ( ray origin point )
52     * myRay.rdir = ( normalized ray direction )
53     * myRay.rmax = ( maximum length, or zero for no limit )
54     *
55     * If you are rendering from a VIEW structure, this can be
56     * accomplished with a single call for the ray at (x,y):
57     *
58     * myRay.rmax = viewray(myRay.rorg, myRay.rdir, &myView, x, y);
59     *
60     * Then, trace the primary ray with:
61     *
62     * ray_trace(&myRay);
63     *
64     * The resulting contents of myRay should provide you with
65     * more than enough information about what the ray hit,
66     * the computed value, etc. For further clues of how to
67     * compute irradiance, how to get callbacks on the evaluated
68     * ray tree, etc., see the contents of rtrace.c. See
69     * also the rpmain.c, rtmain.c, and rvmain.c modules
70     * to learn more how rendering options are processed.
71     *
72     * When you are done, you may call ray_done(1) to clean
73     * up memory used by Radiance. It doesn't free everything,
74     * but it makes a valiant effort. If you call ray_done(0),
75     * it leaves data that is likely to be reused, including
76     * loaded data files and fonts. The library may be
77     * restarted at any point by calling ray_init() on a new
78     * octree.
79     *
80 greg 2.3 * The call ray_save(rp) fills a parameter structure
81 greg 2.1 * with the current global parameter settings, which may be
82     * restored at any time with a call to ray_restore(rp).
83     * This buffer contains no linked information, and thus
84     * may be passed between processes using write() and
85     * read() calls, so long as byte order is maintained.
86     * Calling ray_restore(NULL) restores the original
87     * default parameters, which is also retrievable with
88     * the call ray_defaults(rp). (These should be the
89     * same as the defaults for rtrace.)
90     */
91    
92 schorsch 2.4 #include <string.h>
93 greg 2.14 #include <time.h>
94 schorsch 2.4
95 greg 2.1 #include "ray.h"
96     #include "source.h"
97 greg 2.19 #include "bsdf.h"
98 greg 2.1 #include "ambient.h"
99     #include "otypes.h"
100     #include "random.h"
101     #include "data.h"
102     #include "font.h"
103    
104     char *progname = "unknown_app"; /* caller sets to argv[0] */
105    
106     char *octname; /* octree name we are given */
107    
108     char *shm_boundary = NULL; /* boundary of shared memory */
109    
110     CUBE thescene; /* our scene */
111     OBJECT nsceneobjs; /* number of objects in our scene */
112    
113     int dimlist[MAXDIM]; /* sampling dimensions */
114     int ndims = 0; /* number of sampling dimensions */
115     int samplendx = 0; /* index for this sample */
116    
117     void (*trace)() = NULL; /* trace call */
118    
119 greg 2.6 void (*addobjnotify[8])() = {ambnotify, NULL};
120 greg 2.1
121     int do_irrad = 0; /* compute irradiance? */
122    
123 greg 2.13 int rand_samp = 0; /* pure Monte Carlo sampling? */
124    
125 greg 2.1 double dstrsrc = 0.0; /* square source distribution */
126 greg 2.8 double shadthresh = .03; /* shadow threshold */
127     double shadcert = .75; /* shadow certainty */
128 greg 2.1 int directrelay = 2; /* number of source relays */
129     int vspretest = 512; /* virtual source pretest density */
130     int directvis = 1; /* sources visible? */
131     double srcsizerat = .2; /* maximum ratio source size/dist. */
132    
133     COLOR cextinction = BLKCOLOR; /* global extinction coefficient */
134     COLOR salbedo = BLKCOLOR; /* global scattering albedo */
135     double seccg = 0.; /* global scattering eccentricity */
136     double ssampdist = 0.; /* scatter sampling distance */
137    
138     double specthresh = .15; /* specular sampling threshold */
139     double specjitter = 1.; /* specular sampling jitter */
140    
141     int backvis = 1; /* back face visibility */
142    
143 greg 2.8 int maxdepth = 8; /* maximum recursion depth */
144     double minweight = 2e-3; /* minimum ray weight */
145 greg 2.1
146     char *ambfile = NULL; /* ambient file name */
147     COLOR ambval = BLKCOLOR; /* ambient value */
148     int ambvwt = 0; /* initial weight for ambient value */
149 greg 2.8 double ambacc = 0.1; /* ambient accuracy */
150     int ambres = 256; /* ambient resolution */
151     int ambdiv = 1024; /* ambient divisions */
152     int ambssamp = 512; /* ambient super-samples */
153 greg 2.1 int ambounce = 0; /* ambient bounces */
154     char *amblist[AMBLLEN+1]; /* ambient include/exclude list */
155     int ambincl = -1; /* include == 1, exclude == 0 */
156    
157    
158 greg 2.17 void
159 schorsch 2.9 ray_init( /* initialize ray-tracing calculation */
160     char *otnm
161     )
162 greg 2.1 {
163     if (nobjects > 0) /* free old scene data */
164     ray_done(0);
165     /* initialize object types */
166     if (ofun[OBJ_SPHERE].funp == o_default)
167     initotypes();
168     /* initialize urand */
169 greg 2.16 if (rand_samp) {
170     srandom((long)time(0));
171     initurand(0);
172     } else {
173     srandom(0L);
174     initurand(2048);
175     }
176 greg 2.1 /* read scene octree */
177     readoct(octname = otnm, ~(IO_FILES|IO_INFO), &thescene, NULL);
178     nsceneobjs = nobjects;
179     /* find and mark sources */
180     marksources();
181     /* initialize ambient calculation */
182     setambient();
183     /* ready to go... */
184     }
185    
186 greg 2.17 void
187 schorsch 2.9 ray_trace( /* trace a primary ray */
188     RAY *r
189     )
190 greg 2.1 {
191 greg 2.11 rayorigin(r, PRIMARY, NULL, NULL);
192 greg 2.16 samplendx++;
193 greg 2.1 rayvalue(r); /* assumes origin and direction are set */
194     }
195    
196    
197 greg 2.17 void
198 schorsch 2.9 ray_done( /* free ray-tracing data */
199     int freall
200     )
201 greg 2.1 {
202     retainfonts = 1;
203     ambdone();
204     ambnotify(OVOID);
205     freesources();
206     freeobjects(0, nobjects);
207     donesets();
208     octdone();
209     thescene.cutree = EMPTY;
210     octname = NULL;
211 greg 2.19 retainfonts = 0;
212 greg 2.1 if (freall) {
213     freefont(NULL);
214     freedata(NULL);
215 greg 2.19 SDfreeCache(NULL);
216 greg 2.1 initurand(0);
217     }
218     if (nobjects > 0) {
219 schorsch 2.9 sprintf(errmsg, "%ld objects left after call to ray_done()",
220 greg 2.18 (long)nobjects);
221 greg 2.1 error(WARNING, errmsg);
222     }
223     }
224    
225    
226 greg 2.17 void
227 schorsch 2.9 ray_save( /* save current parameter settings */
228     RAYPARAMS *rp
229     )
230 greg 2.1 {
231     int i, ndx;
232    
233     if (rp == NULL)
234     return;
235     rp->do_irrad = do_irrad;
236     rp->dstrsrc = dstrsrc;
237     rp->shadthresh = shadthresh;
238     rp->shadcert = shadcert;
239     rp->directrelay = directrelay;
240     rp->vspretest = vspretest;
241     rp->directvis = directvis;
242     rp->srcsizerat = srcsizerat;
243     copycolor(rp->cextinction, cextinction);
244     copycolor(rp->salbedo, salbedo);
245     rp->seccg = seccg;
246     rp->ssampdist = ssampdist;
247     rp->specthresh = specthresh;
248     rp->specjitter = specjitter;
249     rp->backvis = backvis;
250     rp->maxdepth = maxdepth;
251     rp->minweight = minweight;
252     copycolor(rp->ambval, ambval);
253 schorsch 2.4 memset(rp->ambfile, '\0', sizeof(rp->ambfile));
254 greg 2.1 if (ambfile != NULL)
255     strncpy(rp->ambfile, ambfile, sizeof(rp->ambfile)-1);
256     rp->ambvwt = ambvwt;
257     rp->ambacc = ambacc;
258     rp->ambres = ambres;
259     rp->ambdiv = ambdiv;
260     rp->ambssamp = ambssamp;
261     rp->ambounce = ambounce;
262     rp->ambincl = ambincl;
263 schorsch 2.4 memset(rp->amblval, '\0', sizeof(rp->amblval));
264 greg 2.1 ndx = 0;
265     for (i = 0; i < AMBLLEN && amblist[i] != NULL; i++) {
266     int len = strlen(amblist[i]);
267     if (ndx+len >= sizeof(rp->amblval))
268     break;
269     strcpy(rp->amblval+ndx, amblist[i]);
270     ndx += len+1;
271     }
272     while (i <= AMBLLEN)
273     rp->amblndx[i++] = -1;
274     }
275    
276    
277 greg 2.17 void
278 schorsch 2.9 ray_restore( /* restore parameter settings */
279     RAYPARAMS *rp
280     )
281 greg 2.1 {
282     register int i;
283    
284     if (rp == NULL) { /* restore defaults */
285     RAYPARAMS dflt;
286     ray_defaults(&dflt);
287     ray_restore(&dflt);
288     return;
289     }
290     /* restore saved settings */
291     do_irrad = rp->do_irrad;
292     dstrsrc = rp->dstrsrc;
293     shadthresh = rp->shadthresh;
294     shadcert = rp->shadcert;
295     directrelay = rp->directrelay;
296     vspretest = rp->vspretest;
297     directvis = rp->directvis;
298     srcsizerat = rp->srcsizerat;
299     copycolor(cextinction, rp->cextinction);
300     copycolor(salbedo, rp->salbedo);
301     seccg = rp->seccg;
302     ssampdist = rp->ssampdist;
303     specthresh = rp->specthresh;
304     specjitter = rp->specjitter;
305     backvis = rp->backvis;
306     maxdepth = rp->maxdepth;
307     minweight = rp->minweight;
308     copycolor(ambval, rp->ambval);
309     ambvwt = rp->ambvwt;
310     ambdiv = rp->ambdiv;
311     ambssamp = rp->ambssamp;
312     ambounce = rp->ambounce;
313     for (i = 0; rp->amblndx[i] >= 0; i++)
314     amblist[i] = rp->amblval + rp->amblndx[i];
315     while (i <= AMBLLEN)
316     amblist[i++] = NULL;
317     ambincl = rp->ambincl;
318     /* update ambient calculation */
319     ambnotify(OVOID);
320     if (thescene.cutree != EMPTY) {
321     int newamb = (ambfile == NULL) ? rp->ambfile[0] :
322     strcmp(ambfile, rp->ambfile) ;
323    
324     if (amblist[0] != NULL)
325     for (i = 0; i < nobjects; i++)
326     ambnotify(i);
327    
328     ambfile = (rp->ambfile[0]) ? rp->ambfile : (char *)NULL;
329     if (newamb) {
330     ambres = rp->ambres;
331     ambacc = rp->ambacc;
332     setambient();
333     } else {
334     setambres(rp->ambres);
335     setambacc(rp->ambacc);
336     }
337     } else {
338     ambfile = (rp->ambfile[0]) ? rp->ambfile : (char *)NULL;
339     ambres = rp->ambres;
340     ambacc = rp->ambacc;
341     }
342     }
343    
344    
345 greg 2.17 void
346 schorsch 2.9 ray_defaults( /* get default parameter values */
347     RAYPARAMS *rp
348     )
349 greg 2.1 {
350     int i;
351    
352     if (rp == NULL)
353     return;
354    
355     rp->do_irrad = 0;
356     rp->dstrsrc = 0.0;
357 greg 2.8 rp->shadthresh = .03;
358     rp->shadcert = .75;
359 greg 2.1 rp->directrelay = 2;
360     rp->vspretest = 512;
361     rp->directvis = 1;
362     rp->srcsizerat = .2;
363     setcolor(rp->cextinction, 0., 0., 0.);
364     setcolor(rp->salbedo, 0., 0., 0.);
365     rp->seccg = 0.;
366     rp->ssampdist = 0.;
367     rp->specthresh = .15;
368     rp->specjitter = 1.;
369     rp->backvis = 1;
370 greg 2.7 rp->maxdepth = 8;
371     rp->minweight = 2e-3;
372 greg 2.1 setcolor(rp->ambval, 0., 0., 0.);
373 schorsch 2.4 memset(rp->ambfile, '\0', sizeof(rp->ambfile));
374 greg 2.1 rp->ambvwt = 0;
375 greg 2.7 rp->ambres = 256;
376 greg 2.10 rp->ambacc = 0.15;
377 greg 2.7 rp->ambdiv = 1024;
378     rp->ambssamp = 512;
379 greg 2.1 rp->ambounce = 0;
380     rp->ambincl = -1;
381 schorsch 2.4 memset(rp->amblval, '\0', sizeof(rp->amblval));
382 greg 2.1 for (i = AMBLLEN+1; i--; )
383     rp->amblndx[i] = -1;
384     }