| 1 | /* Copyright (c) 1992 Regents of the University of California */ | 
| 2 |  | 
| 3 | #ifndef lint | 
| 4 | static char SCCSid[] = "$SunId$ LBL"; | 
| 5 | #endif | 
| 6 |  | 
| 7 | /* | 
| 8 | *  source.c - routines dealing with illumination sources. | 
| 9 | * | 
| 10 | *     8/20/85 | 
| 11 | */ | 
| 12 |  | 
| 13 | #include  "ray.h" | 
| 14 |  | 
| 15 | #include  "octree.h" | 
| 16 |  | 
| 17 | #include  "otypes.h" | 
| 18 |  | 
| 19 | #include  "source.h" | 
| 20 |  | 
| 21 | /* | 
| 22 | * Structures used by direct() | 
| 23 | */ | 
| 24 |  | 
| 25 | typedef struct { | 
| 26 | int  sno;               /* source number */ | 
| 27 | FVECT  dir;             /* source direction */ | 
| 28 | COLOR  coef;            /* material coefficient */ | 
| 29 | COLOR  val;             /* contribution */ | 
| 30 | }  CONTRIB;             /* direct contribution */ | 
| 31 |  | 
| 32 | typedef struct { | 
| 33 | int  sndx;              /* source index (to CONTRIB array) */ | 
| 34 | float  brt;             /* brightness (for comparison) */ | 
| 35 | }  CNTPTR;              /* contribution pointer */ | 
| 36 |  | 
| 37 | static CONTRIB  *srccnt;                /* source contributions in direct() */ | 
| 38 | static CNTPTR  *cntord;                 /* source ordering in direct() */ | 
| 39 | static int  maxcntr = 0;                /* size of contribution arrays */ | 
| 40 |  | 
| 41 |  | 
| 42 | marksources()                   /* find and mark source objects */ | 
| 43 | { | 
| 44 | int  foundsource = 0; | 
| 45 | int  i; | 
| 46 | register OBJREC  *o, *m; | 
| 47 | register int  ns; | 
| 48 | /* initialize dispatch table */ | 
| 49 | initstypes(); | 
| 50 | /* find direct sources */ | 
| 51 | for (i = 0; i < nobjects; i++) { | 
| 52 |  | 
| 53 | o = objptr(i); | 
| 54 |  | 
| 55 | if (!issurface(o->otype) || o->omod == OVOID) | 
| 56 | continue; | 
| 57 |  | 
| 58 | m = objptr(o->omod); | 
| 59 |  | 
| 60 | if (!islight(m->otype)) | 
| 61 | continue; | 
| 62 |  | 
| 63 | if (m->oargs.nfargs != (m->otype == MAT_GLOW ? 4 : | 
| 64 | m->otype == MAT_SPOT ? 7 : 3)) | 
| 65 | objerror(m, USER, "bad # arguments"); | 
| 66 |  | 
| 67 | if (m->otype == MAT_GLOW && | 
| 68 | o->otype != OBJ_SOURCE && | 
| 69 | m->oargs.farg[3] <= FTINY) | 
| 70 | continue;                       /* don't bother */ | 
| 71 |  | 
| 72 | if (sfun[o->otype].of == NULL || | 
| 73 | sfun[o->otype].of->setsrc == NULL) | 
| 74 | objerror(o, USER, "illegal material"); | 
| 75 |  | 
| 76 | if ((ns = newsource()) < 0) | 
| 77 | goto memerr; | 
| 78 |  | 
| 79 | setsource(&source[ns], o); | 
| 80 |  | 
| 81 | if (m->otype == MAT_GLOW) { | 
| 82 | source[ns].sflags |= SPROX; | 
| 83 | source[ns].sl.prox = m->oargs.farg[3]; | 
| 84 | if (o->otype == OBJ_SOURCE) | 
| 85 | source[ns].sflags |= SSKIP; | 
| 86 | } else if (m->otype == MAT_SPOT) { | 
| 87 | source[ns].sflags |= SSPOT; | 
| 88 | if ((source[ns].sl.s = makespot(m)) == NULL) | 
| 89 | goto memerr; | 
| 90 | if (source[ns].sflags & SFLAT && | 
| 91 | !checkspot(source[ns].sl.s,source[ns].snorm)) { | 
| 92 | objerror(o, WARNING, | 
| 93 | "invalid spotlight direction"); | 
| 94 | source[ns].sflags |= SSKIP; | 
| 95 | } | 
| 96 | } | 
| 97 | if (!(source[ns].sflags & SSKIP)) | 
| 98 | foundsource++; | 
| 99 | } | 
| 100 | if (!foundsource) { | 
| 101 | error(WARNING, "no light sources found"); | 
| 102 | return; | 
| 103 | } | 
| 104 | markvirtuals();                 /* find and add virtual sources */ | 
| 105 | /* allocate our contribution arrays */ | 
| 106 | maxcntr = nsources + MAXSPART;  /* start with this many */ | 
| 107 | srccnt = (CONTRIB *)malloc(maxcntr*sizeof(CONTRIB)); | 
| 108 | cntord = (CNTPTR *)malloc(maxcntr*sizeof(CNTPTR)); | 
| 109 | if (srccnt == NULL | cntord == NULL) | 
| 110 | goto memerr; | 
| 111 | return; | 
| 112 | memerr: | 
| 113 | error(SYSTEM, "out of memory in marksources"); | 
| 114 | } | 
| 115 |  | 
| 116 |  | 
| 117 | srcray(sr, r, si)               /* send a ray to a source, return domega */ | 
| 118 | register RAY  *sr;              /* returned source ray */ | 
| 119 | RAY  *r;                        /* ray which hit object */ | 
| 120 | SRCINDEX  *si;                  /* source sample index */ | 
| 121 | { | 
| 122 | double  d;                          /* distance to source */ | 
| 123 | register SRCREC  *srcp; | 
| 124 |  | 
| 125 | rayorigin(sr, r, SHADOW, 1.0);              /* ignore limits */ | 
| 126 |  | 
| 127 | while ((d = nextssamp(sr, si)) != 0.0) { | 
| 128 | sr->rsrc = si->sn;                      /* remember source */ | 
| 129 | srcp = source + si->sn; | 
| 130 | if (srcp->sflags & SDISTANT) { | 
| 131 | if (srcp->sflags & SSPOT && spotout(sr, srcp->sl.s, 1)) | 
| 132 | continue; | 
| 133 | return(1);              /* sample OK */ | 
| 134 | } | 
| 135 | /* local source */ | 
| 136 | /* check proximity */ | 
| 137 | if (srcp->sflags & SPROX && d > srcp->sl.prox) | 
| 138 | continue; | 
| 139 | /* check angle */ | 
| 140 | if (srcp->sflags & SSPOT) { | 
| 141 | if (spotout(sr, srcp->sl.s, 0)) | 
| 142 | continue; | 
| 143 | /* adjust solid angle */ | 
| 144 | si->dom *= d*d; | 
| 145 | d += srcp->sl.s->flen; | 
| 146 | si->dom /= d*d; | 
| 147 | } | 
| 148 | return(1);                      /* sample OK */ | 
| 149 | } | 
| 150 | return(0);                  /* no more samples */ | 
| 151 | } | 
| 152 |  | 
| 153 |  | 
| 154 | srcvalue(r)                     /* punch ray to source and compute value */ | 
| 155 | RAY  *r; | 
| 156 | { | 
| 157 | register SRCREC  *sp; | 
| 158 |  | 
| 159 | sp = &source[r->rsrc]; | 
| 160 | if (sp->sflags & SVIRTUAL) {    /* virtual source */ | 
| 161 | /* check intersection */ | 
| 162 | if (!(*ofun[sp->so->otype].funp)(sp->so, r)) | 
| 163 | return; | 
| 164 | raycont(r);             /* compute contribution */ | 
| 165 | return; | 
| 166 | } | 
| 167 | /* compute intersection */ | 
| 168 | if (sp->sflags & SDISTANT ? sourcehit(r) : | 
| 169 | (*ofun[sp->so->otype].funp)(sp->so, r)) { | 
| 170 | if (sp->sa.success >= 0) | 
| 171 | sp->sa.success++; | 
| 172 | raycont(r);             /* compute contribution */ | 
| 173 | return; | 
| 174 | } | 
| 175 | if (sp->sa.success < 0) | 
| 176 | return;                 /* bitched already */ | 
| 177 | sp->sa.success -= AIMREQT; | 
| 178 | if (sp->sa.success >= 0) | 
| 179 | return;                 /* leniency */ | 
| 180 | sprintf(errmsg, "aiming failure for light source \"%s\"", | 
| 181 | sp->so->oname); | 
| 182 | error(WARNING, errmsg);         /* issue warning */ | 
| 183 | } | 
| 184 |  | 
| 185 |  | 
| 186 | sourcehit(r)                    /* check to see if ray hit distant source */ | 
| 187 | register RAY  *r; | 
| 188 | { | 
| 189 | int  first, last; | 
| 190 | register int  i; | 
| 191 |  | 
| 192 | if (r->rsrc >= 0) {             /* check only one if aimed */ | 
| 193 | first = last = r->rsrc; | 
| 194 | } else {                        /* otherwise check all */ | 
| 195 | first = 0; last = nsources-1; | 
| 196 | } | 
| 197 | for (i = first; i <= last; i++) | 
| 198 | if ((source[i].sflags & (SDISTANT|SVIRTUAL)) == SDISTANT) | 
| 199 | /* | 
| 200 | * Check to see if ray is within | 
| 201 | * solid angle of source. | 
| 202 | */ | 
| 203 | if (2.0*PI * (1.0 - DOT(source[i].sloc,r->rdir)) | 
| 204 | <= source[i].ss2) { | 
| 205 | r->ro = source[i].so; | 
| 206 | if (!(source[i].sflags & SSKIP)) | 
| 207 | break; | 
| 208 | } | 
| 209 |  | 
| 210 | if (r->ro != NULL) { | 
| 211 | for (i = 0; i < 3; i++) | 
| 212 | r->ron[i] = -r->rdir[i]; | 
| 213 | r->rod = 1.0; | 
| 214 | r->rox = NULL; | 
| 215 | return(1); | 
| 216 | } | 
| 217 | return(0); | 
| 218 | } | 
| 219 |  | 
| 220 |  | 
| 221 | static int | 
| 222 | cntcmp(sc1, sc2)                        /* contribution compare (descending) */ | 
| 223 | register CNTPTR  *sc1, *sc2; | 
| 224 | { | 
| 225 | if (sc1->brt > sc2->brt) | 
| 226 | return(-1); | 
| 227 | if (sc1->brt < sc2->brt) | 
| 228 | return(1); | 
| 229 | return(0); | 
| 230 | } | 
| 231 |  | 
| 232 |  | 
| 233 | direct(r, f, p)                         /* add direct component */ | 
| 234 | RAY  *r;                        /* ray that hit surface */ | 
| 235 | int  (*f)();                    /* direct component coefficient function */ | 
| 236 | char  *p;                       /* data for f */ | 
| 237 | { | 
| 238 | extern int  (*trace)(); | 
| 239 | extern double  pow(); | 
| 240 | register int  sn; | 
| 241 | SRCINDEX  si; | 
| 242 | int  nshadcheck, ncnts; | 
| 243 | int  nhits; | 
| 244 | double  prob, ourthresh, hwt; | 
| 245 | RAY  sr; | 
| 246 | /* NOTE: srccnt and cntord global so no recursion */ | 
| 247 | if (nsources <= 0) | 
| 248 | return;         /* no sources?! */ | 
| 249 | /* potential contributions */ | 
| 250 | initsrcindex(&si); | 
| 251 | for (sn = 0; srcray(&sr, r, &si); sn++) { | 
| 252 | if (sn >= maxcntr) { | 
| 253 | maxcntr = sn + MAXSPART; | 
| 254 | srccnt = (CONTRIB *)realloc((char *)srccnt, | 
| 255 | maxcntr*sizeof(CONTRIB)); | 
| 256 | cntord = (CNTPTR *)realloc((char *)cntord, | 
| 257 | maxcntr*sizeof(CNTPTR)); | 
| 258 | if (srccnt == NULL | cntord == NULL) | 
| 259 | error(SYSTEM, "out of memory in direct"); | 
| 260 | } | 
| 261 | cntord[sn].sndx = sn; | 
| 262 | srccnt[sn].sno = sr.rsrc; | 
| 263 | /* compute coefficient */ | 
| 264 | (*f)(srccnt[sn].coef, p, sr.rdir, si.dom); | 
| 265 | cntord[sn].brt = bright(srccnt[sn].coef); | 
| 266 | if (cntord[sn].brt <= 0.0) | 
| 267 | continue; | 
| 268 | VCOPY(srccnt[sn].dir, sr.rdir); | 
| 269 | /* compute potential */ | 
| 270 | sr.revf = srcvalue; | 
| 271 | rayvalue(&sr); | 
| 272 | copycolor(srccnt[sn].val, sr.rcol); | 
| 273 | multcolor(srccnt[sn].val, srccnt[sn].coef); | 
| 274 | cntord[sn].brt = bright(srccnt[sn].val); | 
| 275 | } | 
| 276 | /* sort contributions */ | 
| 277 | qsort(cntord, sn, sizeof(CNTPTR), cntcmp); | 
| 278 | {                                       /* find last */ | 
| 279 | register int  l, m; | 
| 280 |  | 
| 281 | ncnts = l = sn; | 
| 282 | sn = 0; | 
| 283 | while ((m = (sn + ncnts) >> 1) != l) { | 
| 284 | if (cntord[m].brt > 0.0) | 
| 285 | sn = m; | 
| 286 | else | 
| 287 | ncnts = m; | 
| 288 | l = m; | 
| 289 | } | 
| 290 | } | 
| 291 | if (ncnts == 0) | 
| 292 | return;         /* no contributions! */ | 
| 293 | /* accumulate tail */ | 
| 294 | for (sn = ncnts-1; sn > 0; sn--) | 
| 295 | cntord[sn-1].brt += cntord[sn].brt; | 
| 296 | /* compute number to check */ | 
| 297 | nshadcheck = pow((double)ncnts, shadcert) + .5; | 
| 298 | /* modify threshold */ | 
| 299 | ourthresh = shadthresh / r->rweight; | 
| 300 | /* test for shadows */ | 
| 301 | nhits = 0; | 
| 302 | for (sn = 0; sn < ncnts; sn++) { | 
| 303 | /* check threshold */ | 
| 304 | if ((sn+nshadcheck>=ncnts ? cntord[sn].brt : | 
| 305 | cntord[sn].brt-cntord[sn+nshadcheck].brt) | 
| 306 | < ourthresh*bright(r->rcol)) | 
| 307 | break; | 
| 308 | /* test for hit */ | 
| 309 | rayorigin(&sr, r, SHADOW, 1.0); | 
| 310 | VCOPY(sr.rdir, srccnt[cntord[sn].sndx].dir); | 
| 311 | sr.rsrc = srccnt[cntord[sn].sndx].sno; | 
| 312 | source[sr.rsrc].ntests++;       /* keep statistics */ | 
| 313 | if (localhit(&sr, &thescene) && | 
| 314 | ( sr.ro != source[sr.rsrc].so || | 
| 315 | source[sr.rsrc].sflags & SFOLLOW )) { | 
| 316 | /* follow entire path */ | 
| 317 | raycont(&sr); | 
| 318 | if (trace != NULL) | 
| 319 | (*trace)(&sr);  /* trace execution */ | 
| 320 | if (bright(sr.rcol) <= FTINY) | 
| 321 | continue;       /* missed! */ | 
| 322 | copycolor(srccnt[cntord[sn].sndx].val, sr.rcol); | 
| 323 | multcolor(srccnt[cntord[sn].sndx].val, | 
| 324 | srccnt[cntord[sn].sndx].coef); | 
| 325 | } | 
| 326 | /* add contribution if hit */ | 
| 327 | addcolor(r->rcol, srccnt[cntord[sn].sndx].val); | 
| 328 | nhits++; | 
| 329 | source[sr.rsrc].nhits++; | 
| 330 | } | 
| 331 | /* surface hit rate */ | 
| 332 | if (sn > 0) | 
| 333 | hwt = (double)nhits / (double)sn; | 
| 334 | else | 
| 335 | hwt = 0.5; | 
| 336 | #ifdef DEBUG | 
| 337 | sprintf(errmsg, "%d tested, %d untested, %f hit rate\n", | 
| 338 | sn, ncnts-sn, hwt); | 
| 339 | eputs(errmsg); | 
| 340 | #endif | 
| 341 | /* add in untested sources */ | 
| 342 | for ( ; sn < ncnts; sn++) { | 
| 343 | sr.rsrc = srccnt[cntord[sn].sndx].sno; | 
| 344 | prob = hwt * (double)source[sr.rsrc].nhits / | 
| 345 | (double)source[sr.rsrc].ntests; | 
| 346 | scalecolor(srccnt[cntord[sn].sndx].val, prob); | 
| 347 | addcolor(r->rcol, srccnt[cntord[sn].sndx].val); | 
| 348 | } | 
| 349 | } | 
| 350 |  | 
| 351 |  | 
| 352 | /**************************************************************** | 
| 353 | * The following macros were separated from the m_light() routine | 
| 354 | * because they are very nasty and difficult to understand. | 
| 355 | */ | 
| 356 |  | 
| 357 | /* wrongillum * | 
| 358 | * | 
| 359 | * We cannot allow an illum to pass to another illum, because that | 
| 360 | * would almost certainly constitute overcounting. | 
| 361 | * However, we do allow an illum to pass to another illum | 
| 362 | * that is actually going to relay to a virtual light source. | 
| 363 | */ | 
| 364 |  | 
| 365 | #define  wrongillum(m, r)       (!(source[r->rsrc].sflags&SVIRTUAL) && \ | 
| 366 | objptr(source[r->rsrc].so->omod)->otype==MAT_ILLUM) | 
| 367 |  | 
| 368 | /* wrongsource * | 
| 369 | * | 
| 370 | * This source is the wrong source (ie. overcounted) if we are | 
| 371 | * aimed to a different source than the one we hit and the one | 
| 372 | * we hit is not an illum which should be passed. | 
| 373 | */ | 
| 374 |  | 
| 375 | #define  wrongsource(m, r)      (r->rsrc>=0 && source[r->rsrc].so!=r->ro && \ | 
| 376 | (m->otype!=MAT_ILLUM || wrongillum(m,r))) | 
| 377 |  | 
| 378 | /* distglow * | 
| 379 | * | 
| 380 | * A distant glow is an object that sometimes acts as a light source, | 
| 381 | * but is too far away from the test point to be one in this case. | 
| 382 | */ | 
| 383 |  | 
| 384 | #define  distglow(m, r)         (m->otype==MAT_GLOW && \ | 
| 385 | r->rot > m->oargs.farg[3]) | 
| 386 |  | 
| 387 | /* badcomponent * | 
| 388 | * | 
| 389 | * We must avoid counting light sources in the ambient calculation, | 
| 390 | * since the direct component is handled separately.  Therefore, any | 
| 391 | * ambient ray which hits an active light source must be discarded. | 
| 392 | * The same is true for stray specular samples, since the specular | 
| 393 | * contribution from light sources is calculated separately. | 
| 394 | */ | 
| 395 |  | 
| 396 | #define  badcomponent(m, r)     (r->crtype&(AMBIENT|SPECULAR) && \ | 
| 397 | !(r->crtype&SHADOW || r->rod < 0.0 || \ | 
| 398 | distglow(m, r))) | 
| 399 |  | 
| 400 | /* overcount * | 
| 401 | * | 
| 402 | * All overcounting possibilities are contained here. | 
| 403 | */ | 
| 404 |  | 
| 405 | #define  overcount(m, r)        (badcomponent(m,r) || wrongsource(m,r)) | 
| 406 |  | 
| 407 | /* passillum * | 
| 408 | * | 
| 409 | * An illum passes to another material type when we didn't hit it | 
| 410 | * on purpose (as part of a direct calculation), or it is relaying | 
| 411 | * a virtual light source. | 
| 412 | */ | 
| 413 |  | 
| 414 | #define  passillum(m, r)        (m->otype==MAT_ILLUM && \ | 
| 415 | (r->rsrc<0 || source[r->rsrc].so!=r->ro || \ | 
| 416 | source[r->rsrc].sflags&SVIRTUAL)) | 
| 417 |  | 
| 418 | /* srcignore * | 
| 419 | * | 
| 420 | * The -di flag renders light sources invisible, and here is the test. | 
| 421 | */ | 
| 422 |  | 
| 423 | #define  srcignore(m, r)        (directinvis && !(r->crtype&SHADOW) && \ | 
| 424 | !distglow(m, r)) | 
| 425 |  | 
| 426 |  | 
| 427 | m_light(m, r)                   /* ray hit a light source */ | 
| 428 | register OBJREC  *m; | 
| 429 | register RAY  *r; | 
| 430 | { | 
| 431 | /* check for over-counting */ | 
| 432 | if (overcount(m, r)) | 
| 433 | return; | 
| 434 | /* check for passed illum */ | 
| 435 | if (passillum(m, r)) { | 
| 436 | if (m->oargs.nsargs < 1 || !strcmp(m->oargs.sarg[0], VOIDID)) | 
| 437 | raytrans(r); | 
| 438 | else | 
| 439 | rayshade(r, modifier(m->oargs.sarg[0])); | 
| 440 | return; | 
| 441 | } | 
| 442 | /* otherwise treat as source */ | 
| 443 | /* check for behind */ | 
| 444 | if (r->rod < 0.0) | 
| 445 | return; | 
| 446 | /* check for invisibility */ | 
| 447 | if (srcignore(m, r)) | 
| 448 | return; | 
| 449 | /* check for outside spot */ | 
| 450 | if (m->otype==MAT_SPOT && spotout(r, (SPOT *)m->os, r->rot>=FHUGE)) | 
| 451 | return; | 
| 452 | /* get distribution pattern */ | 
| 453 | raytexture(r, m->omod); | 
| 454 | /* get source color */ | 
| 455 | setcolor(r->rcol, m->oargs.farg[0], | 
| 456 | m->oargs.farg[1], | 
| 457 | m->oargs.farg[2]); | 
| 458 | /* modify value */ | 
| 459 | multcolor(r->rcol, r->pcol); | 
| 460 | } |