ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/rtmain.c
Revision: 2.47
Committed: Wed Nov 15 18:02:53 2023 UTC (6 months ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.46: +122 -9 lines
Log Message:
feat(rpict,rtrace,rcontrib,rtpict): Hyperspectral rendering (except photon map)

File Contents

# Content
1 #ifndef lint
2 static const char RCSid[] = "$Id: rtmain.c,v 2.46 2023/08/15 01:19:37 greg Exp $";
3 #endif
4 /*
5 * rtmain.c - main for rtrace per-ray calculation program
6 */
7
8 #include "copyright.h"
9
10 #include <signal.h>
11
12 #include "platform.h"
13 #include "rtprocess.h" /* getpid() */
14 #include "resolu.h"
15 #include "ray.h"
16 #include "source.h"
17 #include "ambient.h"
18 #include "random.h"
19 #include "paths.h"
20 #include "pmapray.h"
21
22 extern char *progname; /* global argv[0] */
23
24 extern char *shm_boundary; /* boundary of shared memory */
25
26 /* persistent processes define */
27 #ifdef F_SETLKW
28 #define PERSIST 1 /* normal persist */
29 #define PARALLEL 2 /* parallel persist */
30 #define PCHILD 3 /* child of normal persist */
31 #endif
32
33 char *sigerr[NSIG]; /* signal error messages */
34 char *errfile = NULL; /* error output file */
35
36 int nproc = 1; /* number of processes */
37
38 extern int setrtoutput(void); /* set output values */
39
40 int inform = 'a'; /* input format */
41 int outform = 'a'; /* output format */
42 char *outvals = "v"; /* output specification */
43
44 int hresolu = 0; /* horizontal (scan) size */
45 int vresolu = 0; /* vertical resolution */
46
47 extern int castonly; /* only doing ray-casting? */
48
49 int imm_irrad = 0; /* compute immediate irradiance? */
50 int lim_dist = 0; /* limit distance? */
51
52 #ifndef MAXMODLIST
53 #define MAXMODLIST 1024 /* maximum modifiers we'll track */
54 #endif
55
56 extern void (*addobjnotify[])(); /* object notification calls */
57 extern void tranotify(OBJECT obj);
58
59 char *tralist[MAXMODLIST]; /* list of modifers to trace (or no) */
60 int traincl = -1; /* include == 1, exclude == 0 */
61
62 double (*sens_curve)(SCOLOR scol) = NULL; /* spectral conversion for 1-channel */
63 double out_scalefactor = 1; /* output calibration scale factor */
64 RGBPRIMP out_prims = stdprims; /* output color primitives (NULL if spectral) */
65 static RGBPRIMS our_prims; /* private output color primitives */
66
67 static int loadflags = ~IO_FILES; /* what to load from octree */
68
69 static void onsig(int signo);
70 static void sigdie(int signo, char *msg);
71 static void printdefaults(void);
72
73 #ifdef PERSIST
74 #define RTRACE_FEATURES "Persist\nParallelPersist\nMultiprocessing\n" \
75 "IrradianceCalc\nImmediateIrradiance\nDistanceLimiting\n" \
76 "Hyperspectral\nParticipatingMedia=Mist\n" \
77 "HessianAmbientCache\nAmbientAveraging\n" \
78 "AmbientValueSharing\nAdaptiveShadowTesting\n" \
79 "InputFormats=a,f,d\nOutputFormats=a,f,d,c\n" \
80 "Outputs=o,d,v,V,w,W,l,L,c,p,n,N,s,m,M,r,x,R,X,~\n"
81 #else
82 #define RTRACE_FEATURES "IrradianceCalc\nIrradianceCalc\nDistanceLimiting\n" \
83 "Hyperspectral\nParticipatingMedia=Mist\n" \
84 "HessianAmbientCache\nAmbientAveraging\n" \
85 "AmbientValueSharing\nAdaptiveShadowTesting\n" \
86 "InputFormats=a,f,d\nOutputFormats=a,f,d,c\n" \
87 "Outputs=o,d,v,V,w,W,l,L,c,p,n,N,s,m,M,r,x,R,X,~\n"
88 #endif
89
90
91 int
92 main(int argc, char *argv[])
93 {
94 #define check(ol,al) if (argv[i][ol] || \
95 badarg(argc-i-1,argv+i+1,al)) \
96 goto badopt
97 #define check_bool(olen,var) switch (argv[i][olen]) { \
98 case '\0': var = !var; break; \
99 case 'y': case 'Y': case 't': case 'T': \
100 case '+': case '1': var = 1; break; \
101 case 'n': case 'N': case 'f': case 'F': \
102 case '-': case '0': var = 0; break; \
103 default: goto badopt; }
104 extern char *octname;
105 int persist = 0;
106 char *octnm = NULL;
107 char **tralp = NULL;
108 int duped1 = -1;
109 int rval;
110 int i;
111 /* global program name */
112 progname = argv[0] = fixargv0(argv[0]);
113 /* feature check only? */
114 strcat(RFeatureList, RTRACE_FEATURES);
115 if (argc > 1 && !strcmp(argv[1], "-features"))
116 return feature_status(argc-2, argv+2);
117 /* add trace notify function */
118 for (i = 0; addobjnotify[i] != NULL; i++)
119 ;
120 addobjnotify[i] = tranotify;
121 /* option city */
122 for (i = 1; i < argc; i++) {
123 /* expand arguments */
124 while ((rval = expandarg(&argc, &argv, i)) > 0)
125 ;
126 if (rval < 0) {
127 sprintf(errmsg, "cannot expand '%s'", argv[i]);
128 error(SYSTEM, errmsg);
129 }
130 if (argv[i] == NULL || argv[i][0] != '-')
131 break; /* break from options */
132 if (!strcmp(argv[i], "-version")) {
133 puts(VersionID);
134 quit(0);
135 }
136 if (!strcmp(argv[i], "-defaults") ||
137 !strcmp(argv[i], "-help")) {
138 printdefaults();
139 quit(0);
140 }
141 rval = getrenderopt(argc-i, argv+i);
142 if (rval >= 0) {
143 i += rval;
144 continue;
145 }
146 switch (argv[i][1]) {
147 case 'n': /* number of cores */
148 check(2,"i");
149 nproc = atoi(argv[++i]);
150 if (nproc <= 0)
151 error(USER, "bad number of processes");
152 break;
153 case 'x': /* x resolution */
154 check(2,"i");
155 hresolu = atoi(argv[++i]);
156 break;
157 case 'y': /* y resolution */
158 check(2,"i");
159 vresolu = atoi(argv[++i]);
160 break;
161 case 'w': /* warnings & spectral */
162 rval = erract[WARNING].pf != NULL;
163 check_bool(2,rval);
164 if (rval) erract[WARNING].pf = wputs;
165 else erract[WARNING].pf = NULL;
166 break;
167 case 'e': /* error file */
168 check(2,"s");
169 errfile = argv[++i];
170 break;
171 case 'l': /* limit distance */
172 if (argv[i][2] != 'd')
173 goto badopt;
174 check_bool(3,lim_dist);
175 break;
176 case 'I': /* immed. irradiance */
177 check_bool(2,imm_irrad);
178 break;
179 case 'f': /* format i/o */
180 switch (argv[i][2]) {
181 case 'a': /* ascii */
182 case 'f': /* float */
183 case 'd': /* double */
184 inform = argv[i][2];
185 break;
186 default:
187 goto badopt;
188 }
189 switch (argv[i][3]) {
190 case '\0':
191 outform = inform;
192 break;
193 case 'a': /* ascii */
194 case 'f': /* float */
195 case 'd': /* double */
196 case 'c': /* color */
197 check(4,"");
198 outform = argv[i][3];
199 break;
200 default:
201 goto badopt;
202 }
203 break;
204 case 'o': /* output */
205 outvals = argv[i]+2;
206 break;
207 case 'h': /* header output */
208 rval = loadflags & IO_INFO;
209 check_bool(2,rval);
210 loadflags = rval ? loadflags | IO_INFO :
211 loadflags & ~IO_INFO;
212 break;
213 case 't': /* trace */
214 switch (argv[i][2]) {
215 case 'i': /* include */
216 case 'I':
217 check(3,"s");
218 if (traincl != 1) {
219 traincl = 1;
220 tralp = tralist;
221 }
222 if (argv[i][2] == 'I') { /* file */
223 rval = wordfile(tralp, MAXMODLIST-(tralp-tralist),
224 getpath(argv[++i],getrlibpath(),R_OK));
225 if (rval < 0) {
226 sprintf(errmsg,
227 "cannot open trace include file \"%s\"",
228 argv[i]);
229 error(SYSTEM, errmsg);
230 }
231 tralp += rval;
232 } else {
233 *tralp++ = argv[++i];
234 *tralp = NULL;
235 }
236 break;
237 case 'e': /* exclude */
238 case 'E':
239 check(3,"s");
240 if (traincl != 0) {
241 traincl = 0;
242 tralp = tralist;
243 }
244 if (argv[i][2] == 'E') { /* file */
245 rval = wordfile(tralp, MAXMODLIST-(tralp-tralist),
246 getpath(argv[++i],getrlibpath(),R_OK));
247 if (rval < 0) {
248 sprintf(errmsg,
249 "cannot open trace exclude file \"%s\"",
250 argv[i]);
251 error(SYSTEM, errmsg);
252 }
253 tralp += rval;
254 } else {
255 *tralp++ = argv[++i];
256 *tralp = NULL;
257 }
258 break;
259 default:
260 goto badopt;
261 }
262 break;
263 case 'p': /* value output */
264 switch (argv[i][2]) {
265 case 'R': /* standard RGB output */
266 if (strcmp(argv[i]+2, "RGB"))
267 goto badopt;
268 out_prims = stdprims;
269 out_scalefactor = 1;
270 sens_curve = NULL;
271 break;
272 case 'X': /* XYZ output */
273 if (strcmp(argv[i]+2, "XYZ"))
274 goto badopt;
275 out_prims = xyzprims;
276 out_scalefactor = WHTEFFICACY;
277 sens_curve = NULL;
278 break;
279 case 'c': {
280 int j;
281 check(3,"ffffffff");
282 rval = 0;
283 for (j = 0; j < 8; j++) {
284 our_prims[0][j] = atof(argv[++i]);
285 rval |= fabs(our_prims[0][j]-stdprims[0][j]) > .001;
286 }
287 if (rval) {
288 if (!colorprimsOK(our_prims))
289 error(USER, "illegal primary chromaticities");
290 out_prims = our_prims;
291 } else
292 out_prims = stdprims;
293 out_scalefactor = 1;
294 sens_curve = NULL;
295 } break;
296 case 'Y': /* photopic response */
297 sens_curve = scolor_photopic;
298 out_scalefactor = WHTEFFICACY;
299 break;
300 case 'S': /* scotopic response */
301 sens_curve = scolor_scotopic;
302 out_scalefactor = WHTSCOTOPIC;
303 break;
304 case 'M': /* melanopic response */
305 sens_curve = scolor_melanopic;
306 out_scalefactor = WHTMELANOPIC;
307 break;
308 default:
309 goto badopt;
310 }
311 break;
312 #if MAXCSAMP>3
313 case 'c': /* spectral sampling */
314 switch (argv[i][2]) {
315 case 's': /* spectral bin count */
316 check(3,"i");
317 NCSAMP = atoi(argv[++i]);
318 break;
319 case 'w': /* wavelength extrema */
320 check(3,"ff");
321 WLPART[0] = atof(argv[++i]);
322 WLPART[3] = atof(argv[++i]);
323 break;
324 case 'o': /* output spectral results */
325 rval = (out_prims == NULL);
326 check_bool(3,rval);
327 if (rval) out_prims = NULL;
328 else if (out_prims == NULL) out_prims = stdprims;
329 break;
330 default:
331 goto badopt;
332 }
333 break;
334 #endif
335 #ifdef PERSIST
336 case 'P': /* persist file */
337 if (argv[i][2] == 'P') {
338 check(3,"s");
339 persist = PARALLEL;
340 } else {
341 check(2,"s");
342 persist = PERSIST;
343 }
344 persistfile(argv[++i]);
345 break;
346 #endif
347 default:
348 goto badopt;
349 }
350 }
351 /* set/check spectral sampling */
352 rval = setspectrsamp(CNDX, WLPART);
353 if (rval < 0)
354 error(USER, "unsupported spectral sampling");
355 if (out_prims != NULL) {
356 if (!rval)
357 error(WARNING, "spectral range incompatible with color output");
358 } else if (NCSAMP == 3)
359 out_prims = stdprims; /* 3 samples do not a spectrum make */
360 if (nproc > 1 && persist)
361 error(USER, "multiprocessing incompatible with persist file");
362 /* initialize object types */
363 initotypes();
364 /* initialize urand */
365 if (rand_samp) {
366 srandom((long)time(0));
367 initurand(0);
368 } else {
369 srandom(0L);
370 initurand(2048);
371 }
372 /* set up signal handling */
373 sigdie(SIGINT, "Interrupt");
374 #ifdef SIGHUP
375 sigdie(SIGHUP, "Hangup");
376 #endif
377 sigdie(SIGTERM, "Terminate");
378 #ifdef SIGPIPE
379 sigdie(SIGPIPE, "Broken pipe");
380 #endif
381 #ifdef SIGALRM
382 sigdie(SIGALRM, "Alarm clock");
383 #endif
384 #ifdef SIGXCPU
385 sigdie(SIGXCPU, "CPU limit exceeded");
386 sigdie(SIGXFSZ, "File size exceeded");
387 #endif
388 /* open error file */
389 if (errfile != NULL) {
390 if (freopen(errfile, "a", stderr) == NULL)
391 quit(2);
392 fprintf(stderr, "**************\n*** PID %5d: ",
393 getpid());
394 printargs(argc, argv, stderr);
395 putc('\n', stderr);
396 fflush(stderr);
397 }
398 #ifdef NICE
399 nice(NICE); /* lower priority */
400 #endif
401 /* get octree */
402 if (i == argc)
403 octnm = NULL;
404 else if (i == argc-1)
405 octnm = argv[i];
406 else
407 goto badopt;
408 if (octnm == NULL)
409 error(USER, "missing octree argument");
410 /* set up output */
411 #ifdef PERSIST
412 if (persist) {
413 duped1 = dup(fileno(stdout)); /* don't lose our output */
414 openheader();
415 }
416 #endif
417 if (outform != 'a')
418 SET_FILE_BINARY(stdout);
419 rval = setrtoutput();
420 octname = savqstr(octnm);
421 readoct(octname, loadflags, &thescene, NULL);
422 nsceneobjs = nobjects;
423
424 if (loadflags & IO_INFO) { /* print header */
425 printargs(i, argv, stdout);
426 printf("SOFTWARE= %s\n", VersionID);
427 fputnow(stdout);
428 if (rval > 0) /* saved from setrtoutput() call */
429 fputncomp(rval, stdout);
430 if (NCSAMP > 3)
431 fputwlsplit(WLPART, stdout);
432 if ((out_prims != stdprims) & (out_prims != NULL))
433 fputprims(out_prims, stdout);
434 if ((outform == 'f') | (outform == 'd'))
435 fputendian(stdout);
436 fputformat(formstr(outform), stdout);
437 fputc('\n', stdout); /* end of header */
438 }
439
440 if (!castonly) { /* any actual ray traversal to do? */
441
442 ray_init_pmap(); /* PMAP: set up & load photon maps */
443
444 marksources(); /* find and mark sources */
445
446 setambient(); /* initialize ambient calculation */
447 } else
448 distantsources(); /* else mark only distant sources */
449
450 fflush(stdout); /* in case we're duplicating header */
451
452 #ifdef PERSIST
453 if (persist) {
454 /* reconnect stdout */
455 dup2(duped1, fileno(stdout));
456 close(duped1);
457 if (persist == PARALLEL) { /* multiprocessing */
458 preload_objs(); /* preload scene */
459 shm_boundary = (char *)malloc(16);
460 strcpy(shm_boundary, "SHM_BOUNDARY");
461 while ((rval=fork()) == 0) { /* keep on forkin' */
462 pflock(1);
463 pfhold();
464 ambsync(); /* load new values */
465 }
466 if (rval < 0)
467 error(SYSTEM, "cannot fork child for persist function");
468 pfdetach(); /* parent will run then exit */
469 }
470 }
471 runagain:
472 if (persist)
473 dupheader(); /* send header to stdout */
474 #endif
475 /* trace rays */
476 rtrace(NULL, nproc);
477 /* flush ambient file */
478 ambsync();
479 #ifdef PERSIST
480 if (persist == PERSIST) { /* first run-through */
481 if ((rval=fork()) == 0) { /* child loops until killed */
482 pflock(1);
483 persist = PCHILD;
484 } else { /* original process exits */
485 if (rval < 0)
486 error(SYSTEM, "cannot fork child for persist function");
487 pfdetach(); /* parent exits */
488 }
489 }
490 if (persist == PCHILD) { /* wait for a signal then go again */
491 pfhold();
492 raynum = nrays = 0; /* reinitialize */
493 goto runagain;
494 }
495 #endif
496
497 ray_done_pmap(); /* PMAP: free photon maps */
498
499 quit(0);
500
501 badopt:
502 sprintf(errmsg, "command line error at '%s'", argv[i]);
503 error(USER, errmsg);
504 return 1; /* pro forma return */
505
506 #undef check
507 #undef check_bool
508 }
509
510
511 void
512 wputs( /* warning output function */
513 const char *s
514 )
515 {
516 int lasterrno = errno;
517 eputs(s);
518 errno = lasterrno;
519 }
520
521
522 void
523 eputs( /* put string to stderr */
524 const char *s
525 )
526 {
527 static int midline = 0;
528
529 if (!*s)
530 return;
531 if (!midline++) {
532 fputs(progname, stderr);
533 fputs(": ", stderr);
534 }
535 fputs(s, stderr);
536 if (s[strlen(s)-1] == '\n') {
537 fflush(stderr);
538 midline = 0;
539 }
540 }
541
542
543 static void
544 onsig( /* fatal signal */
545 int signo
546 )
547 {
548 static int gotsig = 0;
549
550 if (gotsig++) /* two signals and we're gone! */
551 _exit(signo);
552
553 #ifdef SIGALRM
554 alarm(15); /* allow 15 seconds to clean up */
555 signal(SIGALRM, SIG_DFL); /* make certain we do die */
556 #endif
557 eputs("signal - ");
558 eputs(sigerr[signo]);
559 eputs("\n");
560 quit(3);
561 }
562
563
564 static void
565 sigdie( /* set fatal signal */
566 int signo,
567 char *msg
568 )
569 {
570 if (signal(signo, onsig) == SIG_IGN)
571 signal(signo, SIG_IGN);
572 sigerr[signo] = msg;
573 }
574
575
576 static void
577 printdefaults(void) /* print default values to stdout */
578 {
579 char *cp;
580
581 if (imm_irrad)
582 printf("-I+\t\t\t\t# immediate irradiance on\n");
583 printf("-n %-2d\t\t\t\t# number of rendering processes\n", nproc);
584 printf("-x %-9d\t\t\t# %s\n", hresolu,
585 vresolu && hresolu ? "x resolution" : "flush interval");
586 printf("-y %-9d\t\t\t# y resolution\n", vresolu);
587 printf(lim_dist ? "-ld+\t\t\t\t# limit distance on\n" :
588 "-ld-\t\t\t\t# limit distance off\n");
589 printf(loadflags & IO_INFO ? "-h+\t\t\t\t# output header\n" :
590 "-h-\t\t\t\t# no header\n");
591 printf("-f%c%c\t\t\t\t# format input/output = %s/%s\n",
592 inform, outform, formstr(inform), formstr(outform));
593 printf("-o%-9s\t\t\t# output", outvals);
594 for (cp = outvals; *cp; cp++)
595 switch (*cp) {
596 case 't': case 'T': printf(" trace"); break;
597 case 'o': printf(" origin"); break;
598 case 'd': printf(" direction"); break;
599 case 'r': printf(" reflect_contrib"); break;
600 case 'R': printf(" reflect_length"); break;
601 case 'x': printf(" unreflect_contrib"); break;
602 case 'X': printf(" unreflect_length"); break;
603 case 'v': printf(" value"); break;
604 case 'V': printf(" contribution"); break;
605 case 'l': printf(" length"); break;
606 case 'L': printf(" first_length"); break;
607 case 'p': printf(" point"); break;
608 case 'n': printf(" normal"); break;
609 case 'N': printf(" unperturbed_normal"); break;
610 case 's': printf(" surface"); break;
611 case 'w': printf(" weight"); break;
612 case 'W': printf(" coefficient"); break;
613 case 'm': printf(" modifier"); break;
614 case 'M': printf(" material"); break;
615 case '~': printf(" tilde"); break;
616 }
617 fputc('\n', stdout);
618 if (NCSAMP > 3) {
619 printf("-cs %-2d\t\t\t\t# number of spectral bins\n", NCSAMP);
620 printf("-cw %3.0f %3.0f\t\t\t# wavelength limits (nm)\n",
621 WLPART[3], WLPART[0]);
622 printf(out_prims != NULL ? "-co-\t\t\t\t# output tristimulus colors\n" :
623 "-co+\t\t\t\t# output spectral values\n");
624 }
625 if (sens_curve == scolor_photopic)
626 printf("-pY\t\t\t\t# photopic output\n");
627 else if (sens_curve == scolor_scotopic)
628 printf("-pS\t\t\t\t# scotopic output\n");
629 else if (sens_curve == scolor_melanopic)
630 printf("-pM\t\t\t\t# melanopic output\n");
631 else if (out_prims == stdprims)
632 printf("-pRGB\t\t\t\t# standard RGB color output\n");
633 else if (out_prims == xyzprims)
634 printf("-pXYZ\t\t\t\t# CIE XYZ color output\n");
635 else if (out_prims != NULL)
636 printf("-pc %.4f %.4f %.4f %.4f %.4f %.4f %.4f %.4f\t# output color primaries and white point\n",
637 out_prims[RED][0], out_prims[RED][1],
638 out_prims[GRN][0], out_prims[GRN][1],
639 out_prims[BLU][0], out_prims[BLU][1],
640 out_prims[WHT][0], out_prims[WHT][1]);
641 printf(erract[WARNING].pf != NULL ?
642 "-w+\t\t\t\t# warning messages on\n" :
643 "-w-\t\t\t\t# warning messages off\n");
644 print_rdefaults();
645 }