ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/raycalls.c
Revision: 2.30
Committed: Thu May 2 15:02:08 2024 UTC (2 weeks, 4 days ago) by greg
Content type: text/plain
Branch: MAIN
CVS Tags: HEAD
Changes since 2.29: +4 -1 lines
Log Message:
fix: Added call to set up spectral sampling for calling program

File Contents

# User Rev Content
1 greg 2.1 #ifndef lint
2 greg 2.30 static const char RCSid[] = "$Id: raycalls.c,v 2.29 2023/02/02 19:13:13 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 greg 2.21 #include "pmapray.h"
104 greg 2.1
105     char *progname = "unknown_app"; /* caller sets to argv[0] */
106    
107     char *octname; /* octree name we are given */
108    
109     char *shm_boundary = NULL; /* boundary of shared memory */
110    
111     CUBE thescene; /* our scene */
112     OBJECT nsceneobjs; /* number of objects in our scene */
113    
114     int dimlist[MAXDIM]; /* sampling dimensions */
115     int ndims = 0; /* number of sampling dimensions */
116     int samplendx = 0; /* index for this sample */
117    
118     void (*trace)() = NULL; /* trace call */
119    
120 greg 2.6 void (*addobjnotify[8])() = {ambnotify, NULL};
121 greg 2.1
122 greg 2.27 int castonly = 0; /* only doing ray-casting? */
123    
124 greg 2.1 int do_irrad = 0; /* compute irradiance? */
125    
126 greg 2.24 int rand_samp = 1; /* pure Monte Carlo sampling? */
127 greg 2.13
128 greg 2.1 double dstrsrc = 0.0; /* square source distribution */
129 greg 2.8 double shadthresh = .03; /* shadow threshold */
130     double shadcert = .75; /* shadow certainty */
131 greg 2.1 int directrelay = 2; /* number of source relays */
132     int vspretest = 512; /* virtual source pretest density */
133     int directvis = 1; /* sources visible? */
134     double srcsizerat = .2; /* maximum ratio source size/dist. */
135    
136     COLOR cextinction = BLKCOLOR; /* global extinction coefficient */
137     COLOR salbedo = BLKCOLOR; /* global scattering albedo */
138     double seccg = 0.; /* global scattering eccentricity */
139     double ssampdist = 0.; /* scatter sampling distance */
140    
141     double specthresh = .15; /* specular sampling threshold */
142     double specjitter = 1.; /* specular sampling jitter */
143    
144     int backvis = 1; /* back face visibility */
145    
146 greg 2.24 int maxdepth = -10; /* maximum recursion depth */
147 greg 2.26 double minweight = 1e-4; /* minimum ray weight */
148 greg 2.1
149     char *ambfile = NULL; /* ambient file name */
150     COLOR ambval = BLKCOLOR; /* ambient value */
151     int ambvwt = 0; /* initial weight for ambient value */
152 greg 2.8 double ambacc = 0.1; /* ambient accuracy */
153     int ambres = 256; /* ambient resolution */
154     int ambdiv = 1024; /* ambient divisions */
155     int ambssamp = 512; /* ambient super-samples */
156 greg 2.1 int ambounce = 0; /* ambient bounces */
157     char *amblist[AMBLLEN+1]; /* ambient include/exclude list */
158     int ambincl = -1; /* include == 1, exclude == 0 */
159    
160    
161 greg 2.25 static void
162     reset_random(void) /* re-initialize random number generator */
163     {
164     if (rand_samp) {
165     srandom((long)time(0));
166     initurand(0);
167     } else {
168     srandom(0L);
169     initurand(2048);
170     }
171     }
172    
173    
174 greg 2.17 void
175 schorsch 2.9 ray_init( /* initialize ray-tracing calculation */
176     char *otnm
177     )
178 greg 2.1 {
179     if (nobjects > 0) /* free old scene data */
180     ray_done(0);
181     /* initialize object types */
182     if (ofun[OBJ_SPHERE].funp == o_default)
183     initotypes();
184     /* initialize urand */
185 greg 2.25 reset_random();
186 greg 2.30 /* initialize spectral sampling */
187     if (setspectrsamp(CNDX, WLPART) < 0)
188     error(USER, "unsupported spectral sampling");
189 greg 2.27
190     octname = savqstr(otnm); /* read scene octree */
191     readoct(octname, ~(IO_FILES|IO_INFO), &thescene, NULL);
192 greg 2.1 nsceneobjs = nobjects;
193 greg 2.27
194     if (!castonly) { /* any actual ray traversal to do? */
195    
196     ray_init_pmap(); /* PMAP: set up & load photon maps */
197    
198     marksources(); /* find and mark sources */
199    
200     setambient(); /* initialize ambient calculation */
201     } else
202     distantsources(); /* else mark only distant sources */
203 greg 2.1 }
204    
205 greg 2.25
206 greg 2.17 void
207 schorsch 2.9 ray_trace( /* trace a primary ray */
208     RAY *r
209     )
210 greg 2.1 {
211 greg 2.11 rayorigin(r, PRIMARY, NULL, NULL);
212 greg 2.16 samplendx++;
213 greg 2.1 rayvalue(r); /* assumes origin and direction are set */
214     }
215    
216    
217 greg 2.17 void
218 schorsch 2.9 ray_done( /* free ray-tracing data */
219     int freall
220     )
221 greg 2.1 {
222     retainfonts = 1;
223     ambdone();
224     ambnotify(OVOID);
225     freesources();
226     freeobjects(0, nobjects);
227     donesets();
228     octdone();
229     thescene.cutree = EMPTY;
230 greg 2.28 freeqstr(octname); octname = NULL;
231 greg 2.19 retainfonts = 0;
232 greg 2.1 if (freall) {
233     freefont(NULL);
234     freedata(NULL);
235 greg 2.19 SDfreeCache(NULL);
236 greg 2.1 initurand(0);
237     }
238     if (nobjects > 0) {
239 schorsch 2.9 sprintf(errmsg, "%ld objects left after call to ray_done()",
240 greg 2.18 (long)nobjects);
241 greg 2.1 error(WARNING, errmsg);
242     }
243 greg 2.21
244     ray_done_pmap();
245 greg 2.1 }
246    
247    
248 greg 2.17 void
249 schorsch 2.9 ray_save( /* save current parameter settings */
250     RAYPARAMS *rp
251     )
252 greg 2.1 {
253     int i, ndx;
254    
255     if (rp == NULL)
256     return;
257     rp->do_irrad = do_irrad;
258 greg 2.24 rp->rand_samp = rand_samp;
259 greg 2.1 rp->dstrsrc = dstrsrc;
260     rp->shadthresh = shadthresh;
261     rp->shadcert = shadcert;
262     rp->directrelay = directrelay;
263     rp->vspretest = vspretest;
264     rp->directvis = directvis;
265     rp->srcsizerat = srcsizerat;
266     copycolor(rp->cextinction, cextinction);
267     copycolor(rp->salbedo, salbedo);
268     rp->seccg = seccg;
269     rp->ssampdist = ssampdist;
270     rp->specthresh = specthresh;
271     rp->specjitter = specjitter;
272     rp->backvis = backvis;
273     rp->maxdepth = maxdepth;
274     rp->minweight = minweight;
275     if (ambfile != NULL)
276     strncpy(rp->ambfile, ambfile, sizeof(rp->ambfile)-1);
277 greg 2.24 else
278     memset(rp->ambfile, '\0', sizeof(rp->ambfile));
279     copycolor(rp->ambval, ambval);
280 greg 2.1 rp->ambvwt = ambvwt;
281     rp->ambacc = ambacc;
282     rp->ambres = ambres;
283     rp->ambdiv = ambdiv;
284     rp->ambssamp = ambssamp;
285     rp->ambounce = ambounce;
286     rp->ambincl = ambincl;
287 schorsch 2.4 memset(rp->amblval, '\0', sizeof(rp->amblval));
288 greg 2.1 ndx = 0;
289     for (i = 0; i < AMBLLEN && amblist[i] != NULL; i++) {
290     int len = strlen(amblist[i]);
291     if (ndx+len >= sizeof(rp->amblval))
292     break;
293     strcpy(rp->amblval+ndx, amblist[i]);
294 greg 2.23 rp->amblndx[i] = ndx;
295 greg 2.1 ndx += len+1;
296     }
297     while (i <= AMBLLEN)
298     rp->amblndx[i++] = -1;
299 greg 2.21
300     /* PMAP: save photon mapping params */
301     ray_save_pmap(rp);
302 greg 2.1 }
303    
304    
305 greg 2.17 void
306 schorsch 2.9 ray_restore( /* restore parameter settings */
307     RAYPARAMS *rp
308     )
309 greg 2.1 {
310 greg 2.25 int i;
311 greg 2.1
312     if (rp == NULL) { /* restore defaults */
313     RAYPARAMS dflt;
314     ray_defaults(&dflt);
315     ray_restore(&dflt);
316     return;
317     }
318     /* restore saved settings */
319     do_irrad = rp->do_irrad;
320 greg 2.25 if (!rand_samp != !rp->rand_samp) {
321     rand_samp = rp->rand_samp;
322     reset_random();
323     }
324 greg 2.1 dstrsrc = rp->dstrsrc;
325     shadthresh = rp->shadthresh;
326     shadcert = rp->shadcert;
327     directrelay = rp->directrelay;
328     vspretest = rp->vspretest;
329     directvis = rp->directvis;
330     srcsizerat = rp->srcsizerat;
331     copycolor(cextinction, rp->cextinction);
332     copycolor(salbedo, rp->salbedo);
333     seccg = rp->seccg;
334     ssampdist = rp->ssampdist;
335     specthresh = rp->specthresh;
336     specjitter = rp->specjitter;
337     backvis = rp->backvis;
338     maxdepth = rp->maxdepth;
339     minweight = rp->minweight;
340     copycolor(ambval, rp->ambval);
341     ambvwt = rp->ambvwt;
342     ambdiv = rp->ambdiv;
343     ambssamp = rp->ambssamp;
344     ambounce = rp->ambounce;
345 greg 2.25 /* a bit dangerous if not static */
346 greg 2.1 for (i = 0; rp->amblndx[i] >= 0; i++)
347     amblist[i] = rp->amblval + rp->amblndx[i];
348     while (i <= AMBLLEN)
349     amblist[i++] = NULL;
350     ambincl = rp->ambincl;
351     /* update ambient calculation */
352     ambnotify(OVOID);
353 greg 2.29 if ((thescene.cutree != EMPTY) & !castonly) {
354 greg 2.1 int newamb = (ambfile == NULL) ? rp->ambfile[0] :
355     strcmp(ambfile, rp->ambfile) ;
356    
357     if (amblist[0] != NULL)
358     for (i = 0; i < nobjects; i++)
359     ambnotify(i);
360    
361     ambfile = (rp->ambfile[0]) ? rp->ambfile : (char *)NULL;
362     if (newamb) {
363     ambres = rp->ambres;
364     ambacc = rp->ambacc;
365     setambient();
366     } else {
367     setambres(rp->ambres);
368     setambacc(rp->ambacc);
369     }
370     } else {
371     ambfile = (rp->ambfile[0]) ? rp->ambfile : (char *)NULL;
372     ambres = rp->ambres;
373     ambacc = rp->ambacc;
374     }
375 greg 2.21
376     /* PMAP: restore photon mapping params */
377     ray_restore_pmap(rp);
378 greg 2.1 }
379    
380    
381 greg 2.17 void
382 schorsch 2.9 ray_defaults( /* get default parameter values */
383     RAYPARAMS *rp
384     )
385 greg 2.1 {
386     int i;
387    
388     if (rp == NULL)
389     return;
390    
391     rp->do_irrad = 0;
392 greg 2.24 rp->rand_samp = 1;
393 greg 2.1 rp->dstrsrc = 0.0;
394 greg 2.27 rp->shadthresh = 0.03;
395     rp->shadcert = 0.75;
396 greg 2.1 rp->directrelay = 2;
397     rp->vspretest = 512;
398     rp->directvis = 1;
399     rp->srcsizerat = .2;
400     setcolor(rp->cextinction, 0., 0., 0.);
401     setcolor(rp->salbedo, 0., 0., 0.);
402     rp->seccg = 0.;
403     rp->ssampdist = 0.;
404 greg 2.27 rp->specthresh = 0.15;
405 greg 2.1 rp->specjitter = 1.;
406     rp->backvis = 1;
407 greg 2.24 rp->maxdepth = -10;
408 greg 2.27 rp->minweight = 1e-4;
409 greg 2.24 memset(rp->ambfile, '\0', sizeof(rp->ambfile));
410 greg 2.1 setcolor(rp->ambval, 0., 0., 0.);
411     rp->ambvwt = 0;
412 greg 2.7 rp->ambres = 256;
413 greg 2.27 rp->ambacc = 0.1;
414 greg 2.7 rp->ambdiv = 1024;
415     rp->ambssamp = 512;
416 greg 2.1 rp->ambounce = 0;
417     rp->ambincl = -1;
418 schorsch 2.4 memset(rp->amblval, '\0', sizeof(rp->amblval));
419 greg 2.1 for (i = AMBLLEN+1; i--; )
420     rp->amblndx[i] = -1;
421 greg 2.22
422     /* PMAP: restore photon mapping defaults */
423     ray_defaults_pmap(rp);
424 greg 2.1 }