ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/source.c
Revision: 2.51
Committed: Thu May 26 06:55:22 2005 UTC (18 years, 11 months ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.50: +13 -7 lines
Log Message:
Got rtcontrib working and wrote basic man page

File Contents

# Content
1 #ifndef lint
2 static const char RCSid[] = "$Id: source.c,v 2.50 2005/04/19 01:15:07 greg Exp $";
3 #endif
4 /*
5 * source.c - routines dealing with illumination sources.
6 *
7 * External symbols declared in source.h
8 */
9
10 #include "ray.h"
11 #include "otypes.h"
12 #include "rtotypes.h"
13 #include "source.h"
14 #include "random.h"
15
16 extern double ssampdist; /* scatter sampling distance */
17
18 #ifndef MAXSSAMP
19 #define MAXSSAMP 16 /* maximum samples per ray */
20 #endif
21
22 /*
23 * Structures used by direct()
24 */
25
26 typedef struct {
27 int sno; /* source number */
28 FVECT dir; /* source direction */
29 COLOR coef; /* material coefficient */
30 COLOR val; /* contribution */
31 } CONTRIB; /* direct contribution */
32
33 typedef struct {
34 int sndx; /* source index (to CONTRIB array) */
35 float brt; /* brightness (for comparison) */
36 } CNTPTR; /* contribution pointer */
37
38 static CONTRIB *srccnt; /* source contributions in direct() */
39 static CNTPTR *cntord; /* source ordering in direct() */
40 static int maxcntr = 0; /* size of contribution arrays */
41
42 static int cntcmp(const void *p1, const void *p2);
43
44
45 extern OBJREC * /* find an object's actual material */
46 findmaterial(register OBJREC *o)
47 {
48 while (!ismaterial(o->otype)) {
49 if (o->otype == MOD_ALIAS && o->oargs.nsargs) {
50 OBJECT aobj;
51 OBJREC *ao;
52 aobj = lastmod(objndx(o), o->oargs.sarg[0]);
53 if (aobj < 0)
54 objerror(o, USER, "bad reference");
55 ao = objptr(aobj);
56 if (ismaterial(ao->otype))
57 return(ao);
58 }
59 if (o->omod == OVOID)
60 return(NULL);
61 o = objptr(o->omod);
62 }
63 return(o); /* mixtures will return NULL */
64 }
65
66
67 extern void
68 marksources(void) /* find and mark source objects */
69 {
70 int foundsource = 0;
71 int i;
72 register OBJREC *o, *m;
73 register int ns;
74 /* initialize dispatch table */
75 initstypes();
76 /* find direct sources */
77 for (i = 0; i < nsceneobjs; i++) {
78
79 o = objptr(i);
80
81 if (!issurface(o->otype) || o->omod == OVOID)
82 continue;
83 /* find material */
84 m = findmaterial(objptr(o->omod));
85 if (m == NULL || !islight(m->otype))
86 continue; /* not source modifier */
87
88 if (m->oargs.nfargs != (m->otype == MAT_GLOW ? 4 :
89 m->otype == MAT_SPOT ? 7 : 3))
90 objerror(m, USER, "bad # arguments");
91
92 if (m->otype == MAT_GLOW &&
93 o->otype != OBJ_SOURCE &&
94 m->oargs.farg[3] <= FTINY)
95 continue; /* don't bother */
96 if (m->oargs.farg[0] <= FTINY && m->oargs.farg[1] <= FTINY &&
97 m->oargs.farg[2] <= FTINY)
98 continue; /* don't bother */
99
100 if (sfun[o->otype].of == NULL ||
101 sfun[o->otype].of->setsrc == NULL)
102 objerror(o, USER, "illegal material");
103
104 if ((ns = newsource()) < 0)
105 goto memerr;
106
107 setsource(&source[ns], o);
108
109 if (m->otype == MAT_GLOW) {
110 source[ns].sflags |= SPROX;
111 source[ns].sl.prox = m->oargs.farg[3];
112 if (source[ns].sflags & SDISTANT)
113 source[ns].sflags |= SSKIP;
114 } else if (m->otype == MAT_SPOT) {
115 source[ns].sflags |= SSPOT;
116 if ((source[ns].sl.s = makespot(m)) == NULL)
117 goto memerr;
118 if (source[ns].sflags & SFLAT &&
119 !checkspot(source[ns].sl.s,source[ns].snorm)) {
120 objerror(o, WARNING,
121 "invalid spotlight direction");
122 source[ns].sflags |= SSKIP;
123 }
124 }
125 #if SHADCACHE
126 initobscache(ns);
127 #endif
128 if (!(source[ns].sflags & SSKIP))
129 foundsource++;
130 }
131 if (!foundsource) {
132 error(WARNING, "no light sources found");
133 return;
134 }
135 markvirtuals(); /* find and add virtual sources */
136 /* allocate our contribution arrays */
137 maxcntr = nsources + MAXSPART; /* start with this many */
138 srccnt = (CONTRIB *)malloc(maxcntr*sizeof(CONTRIB));
139 cntord = (CNTPTR *)malloc(maxcntr*sizeof(CNTPTR));
140 if ((srccnt == NULL) | (cntord == NULL))
141 goto memerr;
142 return;
143 memerr:
144 error(SYSTEM, "out of memory in marksources");
145 }
146
147
148 extern void
149 freesources(void) /* free all source structures */
150 {
151 if (nsources > 0) {
152 #if SHADCACHE
153 while (nsources--)
154 freeobscache(&source[nsources]);
155 #endif
156 free((void *)source);
157 source = NULL;
158 nsources = 0;
159 }
160 if (maxcntr <= 0)
161 return;
162 free((void *)srccnt);
163 srccnt = NULL;
164 free((void *)cntord);
165 cntord = NULL;
166 maxcntr = 0;
167 }
168
169
170 extern int
171 srcray( /* send a ray to a source, return domega */
172 register RAY *sr, /* returned source ray */
173 RAY *r, /* ray which hit object */
174 SRCINDEX *si /* source sample index */
175 )
176 {
177 double d; /* distance to source */
178 register SRCREC *srcp;
179
180 rayorigin(sr, SHADOW, r, NULL); /* ignore limits */
181
182 while ((d = nextssamp(sr, si)) != 0.0) {
183 sr->rsrc = si->sn; /* remember source */
184 srcp = source + si->sn;
185 if (srcp->sflags & SDISTANT) {
186 if (srcp->sflags & SSPOT && spotout(sr, srcp->sl.s))
187 continue;
188 return(1); /* sample OK */
189 }
190 /* local source */
191 /* check proximity */
192 if (srcp->sflags & SPROX && d > srcp->sl.prox)
193 continue;
194 /* check angle */
195 if (srcp->sflags & SSPOT) {
196 if (spotout(sr, srcp->sl.s))
197 continue;
198 /* adjust solid angle */
199 si->dom *= d*d;
200 d += srcp->sl.s->flen;
201 si->dom /= d*d;
202 }
203 return(1); /* sample OK */
204 }
205 return(0); /* no more samples */
206 }
207
208
209 extern void
210 srcvalue( /* punch ray to source and compute value */
211 register RAY *r
212 )
213 {
214 register SRCREC *sp;
215
216 sp = &source[r->rsrc];
217 if (sp->sflags & SVIRTUAL) { /* virtual source */
218 /* check intersection */
219 if (!(*ofun[sp->so->otype].funp)(sp->so, r))
220 return;
221 if (!rayshade(r, r->ro->omod)) /* compute contribution */
222 goto nomat;
223 rayparticipate(r);
224 return;
225 }
226 /* compute intersection */
227 if (sp->sflags & SDISTANT ? sourcehit(r) :
228 (*ofun[sp->so->otype].funp)(sp->so, r)) {
229 if (sp->sa.success >= 0)
230 sp->sa.success++;
231 if (!rayshade(r, r->ro->omod)) /* compute contribution */
232 goto nomat;
233 rayparticipate(r);
234 return;
235 }
236 /* we missed our mark! */
237 if (sp->sa.success < 0)
238 return; /* bitched already */
239 sp->sa.success -= AIMREQT;
240 if (sp->sa.success >= 0)
241 return; /* leniency */
242 sprintf(errmsg, "aiming failure for light source \"%s\"",
243 sp->so->oname);
244 error(WARNING, errmsg); /* issue warning */
245 return;
246 nomat:
247 objerror(r->ro, USER, "material not found");
248 }
249
250
251 static int
252 transillum( /* check if material is transparent illum */
253 OBJECT obj
254 )
255 {
256 OBJREC *m = findmaterial(objptr(obj));
257
258 if (m == NULL)
259 return(1);
260 if (m->otype != MAT_ILLUM)
261 return(0);
262 return(!m->oargs.nsargs || !strcmp(m->oargs.sarg[0], VOIDID));
263 }
264
265
266 extern int
267 sourcehit( /* check to see if ray hit distant source */
268 register RAY *r
269 )
270 {
271 int glowsrc = -1;
272 int transrc = -1;
273 int first, last;
274 register int i;
275
276 if (r->rsrc >= 0) { /* check only one if aimed */
277 first = last = r->rsrc;
278 } else { /* otherwise check all */
279 first = 0; last = nsources-1;
280 }
281 for (i = first; i <= last; i++) {
282 if ((source[i].sflags & (SDISTANT|SVIRTUAL)) != SDISTANT)
283 continue;
284 /*
285 * Check to see if ray is within
286 * solid angle of source.
287 */
288 if (2.*PI*(1. - DOT(source[i].sloc,r->rdir)) > source[i].ss2)
289 continue;
290 /* is it the only possibility? */
291 if (first == last) {
292 r->ro = source[i].so;
293 break;
294 }
295 /*
296 * If it's a glow or transparent illum, just remember it.
297 */
298 if (source[i].sflags & SSKIP) {
299 glowsrc = i;
300 continue;
301 }
302 if (transillum(source[i].so->omod)) {
303 transrc = i;
304 continue;
305 }
306 r->ro = source[i].so; /* otherwise, use first hit */
307 break;
308 }
309 /*
310 * Do we need fallback?
311 */
312 if (r->ro == NULL) {
313 if (transrc >= 0 && r->crtype & (AMBIENT|SPECULAR))
314 return(0); /* avoid overcounting */
315 if (glowsrc >= 0)
316 r->ro = source[glowsrc].so;
317 else
318 return(0); /* nothing usable */
319 }
320 /*
321 * Make assignments.
322 */
323 r->robj = objndx(r->ro);
324 for (i = 0; i < 3; i++)
325 r->ron[i] = -r->rdir[i];
326 r->rod = 1.0;
327 r->pert[0] = r->pert[1] = r->pert[2] = 0.0;
328 r->uv[0] = r->uv[1] = 0.0;
329 r->rox = NULL;
330 return(1);
331 }
332
333
334 static int
335 cntcmp( /* contribution compare (descending) */
336 const void *p1,
337 const void *p2
338 )
339 {
340 register const CNTPTR *sc1 = (const CNTPTR *)p1;
341 register const CNTPTR *sc2 = (const CNTPTR *)p2;
342
343 if (sc1->brt > sc2->brt)
344 return(-1);
345 if (sc1->brt < sc2->brt)
346 return(1);
347 return(0);
348 }
349
350
351 extern void
352 direct( /* add direct component */
353 RAY *r, /* ray that hit surface */
354 srcdirf_t *f, /* direct component coefficient function */
355 void *p /* data for f */
356 )
357 {
358 register int sn;
359 register CONTRIB *scp;
360 SRCINDEX si;
361 int nshadcheck, ncnts;
362 int nhits;
363 double prob, ourthresh, hwt;
364 RAY sr;
365 /* NOTE: srccnt and cntord global so no recursion */
366 if (nsources <= 0)
367 return; /* no sources?! */
368 /* potential contributions */
369 initsrcindex(&si);
370 for (sn = 0; srcray(&sr, r, &si); sn++) {
371 if (sn >= maxcntr) {
372 maxcntr = sn + MAXSPART;
373 srccnt = (CONTRIB *)realloc((void *)srccnt,
374 maxcntr*sizeof(CONTRIB));
375 cntord = (CNTPTR *)realloc((void *)cntord,
376 maxcntr*sizeof(CNTPTR));
377 if ((srccnt == NULL) | (cntord == NULL))
378 error(SYSTEM, "out of memory in direct");
379 }
380 cntord[sn].sndx = sn;
381 scp = srccnt + sn;
382 scp->sno = sr.rsrc;
383 /* compute coefficient */
384 (*f)(scp->coef, p, sr.rdir, si.dom);
385 cntord[sn].brt = bright(scp->coef);
386 if (cntord[sn].brt <= 0.0)
387 continue;
388 #if SHADCACHE
389 /* check shadow cache */
390 if (si.np == 1 && srcblocked(&sr)) {
391 cntord[sn].brt = 0.0;
392 continue;
393 }
394 #endif
395 VCOPY(scp->dir, sr.rdir);
396 copycolor(sr.rcoef, scp->coef);
397 /* compute potential */
398 sr.revf = srcvalue;
399 rayvalue(&sr);
400 multcolor(sr.rcol, sr.rcoef);
401 copycolor(scp->val, sr.rcol);
402 cntord[sn].brt = bright(scp->val);
403 }
404 /* sort contributions */
405 qsort(cntord, sn, sizeof(CNTPTR), cntcmp);
406 { /* find last */
407 register int l, m;
408
409 ncnts = l = sn;
410 sn = 0;
411 while ((m = (sn + ncnts) >> 1) != l) {
412 if (cntord[m].brt > 0.0)
413 sn = m;
414 else
415 ncnts = m;
416 l = m;
417 }
418 }
419 if (ncnts == 0)
420 return; /* no contributions! */
421 /* accumulate tail */
422 for (sn = ncnts-1; sn > 0; sn--)
423 cntord[sn-1].brt += cntord[sn].brt;
424 /* compute number to check */
425 nshadcheck = pow((double)ncnts, shadcert) + .5;
426 /* modify threshold */
427 ourthresh = shadthresh / r->rweight;
428 /* test for shadows */
429 for (nhits = 0, hwt = 0.0, sn = 0; sn < ncnts;
430 hwt += (double)source[scp->sno].nhits /
431 (double)source[scp->sno].ntests,
432 sn++) {
433 /* check threshold */
434 if ((sn+nshadcheck>=ncnts ? cntord[sn].brt :
435 cntord[sn].brt-cntord[sn+nshadcheck].brt)
436 < ourthresh*bright(r->rcol))
437 break;
438 scp = srccnt + cntord[sn].sndx;
439 /* test for hit */
440 rayorigin(&sr, SHADOW, r, scp->coef);
441 VCOPY(sr.rdir, scp->dir);
442 sr.rsrc = scp->sno;
443 /* keep statistics */
444 if (source[scp->sno].ntests++ > 0xfffffff0) {
445 source[scp->sno].ntests >>= 1;
446 source[scp->sno].nhits >>= 1;
447 }
448 if (localhit(&sr, &thescene) &&
449 ( sr.ro != source[scp->sno].so ||
450 source[scp->sno].sflags & SFOLLOW )) {
451 /* follow entire path */
452 raycont(&sr);
453 if (trace != NULL)
454 (*trace)(&sr); /* trace execution */
455 rayparticipate(&sr);
456 if (bright(sr.rcol) <= FTINY) {
457 #if SHADCACHE
458 if ((scp <= srccnt || scp[-1].sno != scp->sno)
459 && (scp >= srccnt+ncnts-1 ||
460 scp[1].sno != scp->sno))
461 srcblocker(&sr);
462 #endif
463 continue; /* missed! */
464 }
465 multcolor(sr.rcol, sr.rcoef);
466 copycolor(scp->val, sr.rcol);
467 } else if (trace != NULL &&
468 (source[scp->sno].sflags & (SDISTANT|SVIRTUAL|SFOLLOW))
469 == (SDISTANT|SFOLLOW) &&
470 sourcehit(&sr) && rayshade(&sr, sr.ro->omod)) {
471 (*trace)(&sr); /* trace execution */
472 /* skip call to rayparticipate() & scp->val update */
473 }
474 /* add contribution if hit */
475 addcolor(r->rcol, scp->val);
476 nhits++;
477 source[scp->sno].nhits++;
478 }
479 /* source hit rate */
480 if (hwt > FTINY)
481 hwt = (double)nhits / hwt;
482 else
483 hwt = 0.5;
484 #ifdef DEBUG
485 sprintf(errmsg, "%d tested, %d untested, %f conditional hit rate\n",
486 sn, ncnts-sn, hwt);
487 eputs(errmsg);
488 #endif
489 /* add in untested sources */
490 for ( ; sn < ncnts; sn++) {
491 scp = srccnt + cntord[sn].sndx;
492 prob = hwt * (double)source[scp->sno].nhits /
493 (double)source[scp->sno].ntests;
494 if (prob < 1.0)
495 scalecolor(scp->val, prob);
496 addcolor(r->rcol, scp->val);
497 }
498 }
499
500
501 extern void
502 srcscatter( /* compute source scattering into ray */
503 register RAY *r
504 )
505 {
506 int oldsampndx;
507 int nsamps;
508 RAY sr;
509 SRCINDEX si;
510 double t, d;
511 double re, ge, be;
512 COLOR cvext;
513 int i, j;
514
515 if (r->slights == NULL || r->slights[0] == 0
516 || r->gecc >= 1.-FTINY || r->rot >= FHUGE)
517 return;
518 if (ssampdist <= FTINY || (nsamps = r->rot/ssampdist + .5) < 1)
519 nsamps = 1;
520 #if MAXSSAMP
521 else if (nsamps > MAXSSAMP)
522 nsamps = MAXSSAMP;
523 #endif
524 oldsampndx = samplendx;
525 samplendx = random()&0x7fff; /* randomize */
526 for (i = r->slights[0]; i > 0; i--) { /* for each source */
527 for (j = 0; j < nsamps; j++) { /* for each sample position */
528 samplendx++;
529 t = r->rot * (j+frandom())/nsamps;
530 /* extinction */
531 re = t*colval(r->cext,RED);
532 ge = t*colval(r->cext,GRN);
533 be = t*colval(r->cext,BLU);
534 setcolor(cvext, re > 92. ? 0. : exp(-re),
535 ge > 92. ? 0. : exp(-ge),
536 be > 92. ? 0. : exp(-be));
537 if (intens(cvext) <= FTINY)
538 break; /* too far away */
539 sr.rorg[0] = r->rorg[0] + r->rdir[0]*t;
540 sr.rorg[1] = r->rorg[1] + r->rdir[1]*t;
541 sr.rorg[2] = r->rorg[2] + r->rdir[2]*t;
542 sr.rmax = 0.;
543 initsrcindex(&si); /* sample ray to this source */
544 si.sn = r->slights[i];
545 nopart(&si, &sr);
546 if (!srcray(&sr, NULL, &si) ||
547 sr.rsrc != r->slights[i])
548 continue; /* no path */
549 #if SHADCACHE
550 if (srcblocked(&sr)) /* check shadow cache */
551 continue;
552 #endif
553 copycolor(sr.cext, r->cext);
554 copycolor(sr.albedo, r->albedo);
555 sr.gecc = r->gecc;
556 sr.slights = r->slights;
557 rayvalue(&sr); /* eval. source ray */
558 if (bright(sr.rcol) <= FTINY) {
559 #if SHADCACHE
560 srcblocker(&sr); /* add blocker to cache */
561 #endif
562 continue;
563 }
564 if (r->gecc <= FTINY) /* compute P(theta) */
565 d = 1.;
566 else {
567 d = DOT(r->rdir, sr.rdir);
568 d = 1. + r->gecc*r->gecc - 2.*r->gecc*d;
569 d = (1. - r->gecc*r->gecc) / (d*sqrt(d));
570 }
571 /* other factors */
572 d *= si.dom * r->rot / (4.*PI*nsamps);
573 multcolor(sr.rcol, r->cext);
574 multcolor(sr.rcol, r->albedo);
575 scalecolor(sr.rcol, d);
576 multcolor(sr.rcol, cvext);
577 addcolor(r->rcol, sr.rcol); /* add it in */
578 }
579 }
580 samplendx = oldsampndx;
581 }
582
583
584 /****************************************************************
585 * The following macros were separated from the m_light() routine
586 * because they are very nasty and difficult to understand.
587 */
588
589 /* illumblock *
590 *
591 * We cannot allow an illum to pass to another illum, because that
592 * would almost certainly constitute overcounting.
593 * However, we do allow an illum to pass to another illum
594 * that is actually going to relay to a virtual light source.
595 * We also prevent an illum from passing to a glow; this provides a
596 * convenient mechanism for defining detailed light source
597 * geometry behind (or inside) an effective radiator.
598 */
599
600 static int
601 weaksrcmat(OBJECT obj) /* identify material */
602 {
603 OBJREC *m = findmaterial(objptr(obj));
604
605 if (m == NULL) return(0);
606 return((m->otype==MAT_ILLUM) | (m->otype==MAT_GLOW));
607 }
608
609 #define illumblock(m, r) (!(source[r->rsrc].sflags&SVIRTUAL) && \
610 r->rod > 0.0 && \
611 weaksrcmat(source[r->rsrc].so->omod))
612
613 /* wrongsource *
614 *
615 * This source is the wrong source (ie. overcounted) if we are
616 * aimed to a different source than the one we hit and the one
617 * we hit is not an illum that should be passed.
618 */
619
620 #define wrongsource(m, r) (r->rsrc>=0 && source[r->rsrc].so!=r->ro && \
621 (m->otype!=MAT_ILLUM || illumblock(m,r)))
622
623 /* distglow *
624 *
625 * A distant glow is an object that sometimes acts as a light source,
626 * but is too far away from the test point to be one in this case.
627 * (Glows with negative radii should NEVER participate in illumination.)
628 */
629
630 #define distglow(m, r, d) (m->otype==MAT_GLOW && \
631 m->oargs.farg[3] >= -FTINY && \
632 d > m->oargs.farg[3])
633
634 /* badcomponent *
635 *
636 * We must avoid counting light sources in the ambient calculation,
637 * since the direct component is handled separately. Therefore, any
638 * ambient ray which hits an active light source must be discarded.
639 * The same is true for stray specular samples, since the specular
640 * contribution from light sources is calculated separately.
641 */
642
643 #define badcomponent(m, r) (r->crtype&(AMBIENT|SPECULAR) && \
644 !(r->crtype&SHADOW || r->rod < 0.0 || \
645 /* not 100% correct */ distglow(m, r, r->rot)))
646
647 /* passillum *
648 *
649 * An illum passes to another material type when we didn't hit it
650 * on purpose (as part of a direct calculation), or it is relaying
651 * a virtual light source.
652 */
653
654 #define passillum(m, r) (m->otype==MAT_ILLUM && \
655 (r->rsrc<0 || source[r->rsrc].so!=r->ro || \
656 source[r->rsrc].sflags&SVIRTUAL))
657
658 /* srcignore *
659 *
660 * The -dv flag is normally on for sources to be visible.
661 */
662
663 #define srcignore(m, r) !(directvis || r->crtype&SHADOW || \
664 distglow(m, r, raydist(r,PRIMARY)))
665
666
667 extern int
668 m_light( /* ray hit a light source */
669 register OBJREC *m,
670 register RAY *r
671 )
672 {
673 /* check for over-counting */
674 if (badcomponent(m, r)) {
675 setcolor(r->rcoef, 0.0, 0.0, 0.0);
676 return(1);
677 }
678 if (wrongsource(m, r)) {
679 setcolor(r->rcoef, 0.0, 0.0, 0.0);
680 return(1);
681 }
682 /* check for passed illum */
683 if (passillum(m, r)) {
684 if (m->oargs.nsargs && strcmp(m->oargs.sarg[0], VOIDID))
685 return(rayshade(r,lastmod(objndx(m),m->oargs.sarg[0])));
686 raytrans(r);
687 return(1);
688 }
689 /* check for invisibility */
690 if (srcignore(m, r)) {
691 setcolor(r->rcoef, 0.0, 0.0, 0.0);
692 return(1);
693 }
694 /* otherwise treat as source */
695 /* check for behind */
696 if (r->rod < 0.0)
697 return(1);
698 /* check for outside spot */
699 if (m->otype==MAT_SPOT && spotout(r, makespot(m)))
700 return(1);
701 /* get distribution pattern */
702 raytexture(r, m->omod);
703 /* get source color */
704 setcolor(r->rcol, m->oargs.farg[0],
705 m->oargs.farg[1],
706 m->oargs.farg[2]);
707 /* modify value */
708 multcolor(r->rcol, r->pcol);
709 return(1);
710 }