ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/raycalls.c
Revision: 2.24
Committed: Thu Apr 18 23:58:22 2019 UTC (5 years ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.23: +12 -8 lines
Log Message:
Made settings consistent with claims of matching rtrace and added missing rand_samp

File Contents

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