ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/rtmain.c
Revision: 2.57
Committed: Wed Mar 5 18:56:28 2025 UTC (2 months, 2 weeks ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.56: +4 -2 lines
Log Message:
feat(rtrace,rxtrace): Improved header output

File Contents

# Content
1 #ifndef lint
2 static const char RCSid[] = "$Id: rtmain.c,v 2.56 2024/10/30 16:47:03 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 /* persistent processes define */
25 #ifdef F_SETLKW
26 #define PERSIST 1 /* normal persist */
27 #define PARALLEL 2 /* parallel persist */
28 #define PCHILD 3 /* child of normal persist */
29 #endif
30
31 char *sigerr[NSIG]; /* signal error messages */
32 char *errfile = NULL; /* error output file */
33
34 int nproc = 1; /* number of processes */
35
36 extern int setrtoutput(void); /* set output values */
37
38 int inform = 'a'; /* input format */
39 int outform = 'a'; /* output format */
40 char *outvals = "v"; /* output specification */
41
42 int hresolu = 0; /* horizontal (scan) size */
43 int vresolu = 0; /* vertical resolution */
44
45 extern int castonly; /* only doing ray-casting? */
46
47 int imm_irrad = 0; /* compute immediate irradiance? */
48 int lim_dist = 0; /* limit distance? */
49
50 #ifndef MAXMODLIST
51 #define MAXMODLIST 1024 /* maximum modifiers we'll track */
52 #endif
53
54 extern void (*addobjnotify[])(); /* object notification calls */
55 extern void tranotify(OBJECT obj);
56
57 char *tralist[MAXMODLIST]; /* list of modifers to trace (or no) */
58 int traincl = -1; /* include == 1, exclude == 0 */
59
60 double (*sens_curve)(const SCOLOR scol) = NULL; /* spectral conversion for 1-channel */
61 double out_scalefactor = 1; /* output calibration scale factor */
62 RGBPRIMP out_prims = stdprims; /* output color primitives (NULL if spectral) */
63 static RGBPRIMS our_prims; /* private output color primitives */
64
65 static int loadflags = ~IO_FILES; /* what to load from octree */
66
67 static void onsig(int signo);
68 static void sigdie(int signo, char *msg);
69 static void printdefaults(void);
70
71 #ifdef PERSIST
72 #define RTRACE_FEATURES "Persist\nParallelPersist\nMultiprocessing\n" \
73 "IrradianceCalc\nImmediateIrradiance\nDistanceLimiting\n" \
74 "ParticipatingMedia=Mist\n" \
75 "HessianAmbientCache\nAmbientAveraging\n" \
76 "AmbientValueSharing\nAdaptiveShadowTesting\n" \
77 "InputFormats=a,f,d\nOutputFormats=a,f,d,c\n" \
78 "Outputs=o,d,v,V,w,W,l,L,c,p,n,N,s,m,M,r,x,R,X,~\n" \
79 "OutputCS=RGB,XYZ,Y,S,M,prims,spec\n"
80 #else
81 #define RTRACE_FEATURES "IrradianceCalc\nIrradianceCalc\nDistanceLimiting\n" \
82 "ParticipatingMedia=Mist\n" \
83 "HessianAmbientCache\nAmbientAveraging\n" \
84 "AmbientValueSharing\nAdaptiveShadowTesting\n" \
85 "InputFormats=a,f,d\nOutputFormats=a,f,d,c\n" \
86 "Outputs=o,d,v,V,w,W,l,L,c,p,n,N,s,m,M,r,x,R,X,~\n" \
87 "OutputCS=RGB,XYZ,Y,S,M,prims,spec\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 if (argv[i][3])
298 goto badopt;
299 sens_curve = scolor_photopic;
300 out_scalefactor = WHTEFFICACY;
301 break;
302 case 'S': /* scotopic response */
303 if (argv[i][3])
304 goto badopt;
305 sens_curve = scolor_scotopic;
306 out_scalefactor = WHTSCOTOPIC;
307 break;
308 case 'M': /* melanopic response */
309 if (argv[i][3])
310 goto badopt;
311 sens_curve = scolor_melanopic;
312 out_scalefactor = WHTMELANOPIC;
313 break;
314 default:
315 goto badopt;
316 }
317 break;
318 #if MAXCSAMP>3
319 case 'c': /* output spectral results */
320 if (argv[i][2] != 'o')
321 goto badopt;
322 rval = (out_prims == NULL) & (sens_curve == NULL);
323 check_bool(3,rval);
324 if (rval) {
325 out_prims = NULL;
326 sens_curve = NULL;
327 } else if (out_prims == NULL)
328 out_prims = stdprims;
329 break;
330 #endif
331 #ifdef PERSIST
332 case 'P': /* persist file */
333 if (argv[i][2] == 'P') {
334 check(3,"s");
335 persist = PARALLEL;
336 } else {
337 check(2,"s");
338 persist = PERSIST;
339 }
340 persistfile(argv[++i]);
341 break;
342 #endif
343 default:
344 goto badopt;
345 }
346 }
347 /* set/check spectral sampling */
348 rval = setspectrsamp(CNDX, WLPART);
349 if (rval < 0)
350 error(USER, "unsupported spectral sampling");
351 if (sens_curve != NULL)
352 out_prims = NULL;
353 else if (out_prims != NULL) {
354 if (!rval)
355 error(WARNING, "spectral range incompatible with color output");
356 } else if (NCSAMP == 3)
357 out_prims = stdprims; /* 3 samples do not a spectrum make */
358 if (nproc > 1 && persist)
359 error(USER, "multiprocessing incompatible with persist file");
360 /* initialize object types */
361 initotypes();
362 /* initialize urand */
363 if (rand_samp) {
364 srandom((long)time(0));
365 initurand(0);
366 } else {
367 srandom(0L);
368 initurand(2048);
369 }
370 /* set up signal handling */
371 sigdie(SIGINT, "Interrupt");
372 #ifdef SIGHUP
373 sigdie(SIGHUP, "Hangup");
374 #endif
375 sigdie(SIGTERM, "Terminate");
376 #ifdef SIGPIPE
377 sigdie(SIGPIPE, "Broken pipe");
378 #endif
379 #ifdef SIGALRM
380 sigdie(SIGALRM, "Alarm clock");
381 #endif
382 #ifdef SIGXCPU
383 sigdie(SIGXCPU, "CPU limit exceeded");
384 sigdie(SIGXFSZ, "File size exceeded");
385 #endif
386 /* open error file */
387 if (errfile != NULL) {
388 if (freopen(errfile, "a", stderr) == NULL)
389 quit(2);
390 fprintf(stderr, "**************\n*** PID %5d: ",
391 getpid());
392 printargs(argc, argv, stderr);
393 putc('\n', stderr);
394 fflush(stderr);
395 }
396 #ifdef NICE
397 nice(NICE); /* lower priority */
398 #endif
399 /* get octree */
400 if (i == argc)
401 octnm = NULL;
402 else if (i == argc-1)
403 octnm = argv[i];
404 else
405 goto badopt;
406 if (octnm == NULL)
407 error(USER, "missing octree argument");
408 /* set up output */
409 #ifdef PERSIST
410 if (persist) {
411 duped1 = dup(fileno(stdout)); /* don't lose our output */
412 openheader();
413 }
414 #endif
415 if (outform != 'a')
416 SET_FILE_BINARY(stdout);
417 rval = setrtoutput();
418 octname = savqstr(octnm);
419 readoct(octname, loadflags, &thescene, NULL);
420 nsceneobjs = nobjects;
421
422 if (loadflags & IO_INFO) { /* print header */
423 printargs(i, argv, stdout);
424 printf("SOFTWARE= %s\n", VersionID);
425 fputnow(stdout);
426 if (rval > 0) /* saved from setrtoutput() call */
427 fputncomp(rval, stdout);
428 if (NCSAMP > 3)
429 fputwlsplit(WLPART, stdout);
430 if ((out_prims != stdprims) & (out_prims != NULL))
431 fputprims(out_prims, stdout);
432 if ((outform == 'f') | (outform == 'd'))
433 fputendian(stdout);
434 fputformat(formstr(outform), stdout);
435 fputc('\n', stdout); /* end of header */
436 }
437
438 if (!castonly) { /* any actual ray traversal to do? */
439
440 ray_init_pmap(); /* PMAP: set up & load photon maps */
441
442 marksources(); /* find and mark sources */
443
444 setambient(); /* initialize ambient calculation */
445 } else
446 distantsources(); /* else mark only distant sources */
447
448 fflush(stdout); /* in case we're duplicating header */
449
450 #ifdef PERSIST
451 if (persist) {
452 /* reconnect stdout */
453 dup2(duped1, fileno(stdout));
454 close(duped1);
455 if (persist == PARALLEL) { /* multiprocessing */
456 cow_memshare(); /* preloads scene */
457 while ((rval=fork()) == 0) { /* keep on forkin' */
458 pflock(1);
459 pfhold();
460 ambsync(); /* load new values */
461 }
462 if (rval < 0)
463 error(SYSTEM, "cannot fork child for persist function");
464 pfdetach(); /* parent will run then exit */
465 }
466 }
467 runagain:
468 if (persist)
469 dupheader(); /* send header to stdout */
470 #endif
471 /* trace rays */
472 rtrace(NULL, nproc);
473 /* flush ambient file */
474 ambsync();
475 #ifdef PERSIST
476 if (persist == PERSIST) { /* first run-through */
477 if ((rval=fork()) == 0) { /* child loops until killed */
478 pflock(1);
479 persist = PCHILD;
480 } else { /* original process exits */
481 if (rval < 0)
482 error(SYSTEM, "cannot fork child for persist function");
483 pfdetach(); /* parent exits */
484 }
485 }
486 if (persist == PCHILD) { /* wait for a signal then go again */
487 pfhold();
488 raynum = nrays = 0; /* reinitialize */
489 goto runagain;
490 }
491 #endif
492
493 ray_done_pmap(); /* PMAP: free photon maps */
494
495 quit(0);
496
497 badopt:
498 sprintf(errmsg, "command line error at '%s'", argv[i]);
499 error(USER, errmsg);
500 return 1; /* pro forma return */
501
502 #undef check
503 #undef check_bool
504 }
505
506
507 void
508 wputs( /* warning output function */
509 const char *s
510 )
511 {
512 int lasterrno = errno;
513 if (erract[WARNING].pf == NULL)
514 return; /* called by calcomp or someone */
515 eputs(s);
516 errno = lasterrno;
517 }
518
519
520 void
521 eputs( /* put string to stderr */
522 const char *s
523 )
524 {
525 static int midline = 0;
526
527 if (!*s)
528 return;
529 if (!midline++) {
530 fputs(progname, stderr);
531 fputs(": ", stderr);
532 }
533 fputs(s, stderr);
534 if (s[strlen(s)-1] == '\n') {
535 fflush(stderr);
536 midline = 0;
537 }
538 }
539
540
541 static void
542 onsig( /* fatal signal */
543 int signo
544 )
545 {
546 static int gotsig = 0;
547
548 if (gotsig++) /* two signals and we're gone! */
549 _exit(signo);
550
551 #ifdef SIGALRM
552 alarm(15); /* allow 15 seconds to clean up */
553 signal(SIGALRM, SIG_DFL); /* make certain we do die */
554 #endif
555 eputs("signal - ");
556 eputs(sigerr[signo]);
557 eputs("\n");
558 quit(3);
559 }
560
561
562 static void
563 sigdie( /* set fatal signal */
564 int signo,
565 char *msg
566 )
567 {
568 if (signal(signo, onsig) == SIG_IGN)
569 signal(signo, SIG_IGN);
570 sigerr[signo] = msg;
571 }
572
573
574 static void
575 printdefaults(void) /* print default values to stdout */
576 {
577 char *cp;
578
579 printf(erract[WARNING].pf != NULL ?
580 "-w+\t\t\t\t# warning messages on\n" :
581 "-w-\t\t\t\t# warning messages off\n");
582 if (imm_irrad)
583 printf("-I+\t\t\t\t# immediate irradiance on\n");
584 printf("-n %-2d\t\t\t\t# number of rendering processes\n", nproc);
585 printf("-x %-9d\t\t\t# %s\n", hresolu,
586 vresolu && hresolu ? "x resolution" : "flush interval");
587 printf("-y %-9d\t\t\t# y resolution\n", vresolu);
588 printf(lim_dist ? "-ld+\t\t\t\t# limit distance on\n" :
589 "-ld-\t\t\t\t# limit distance off\n");
590 printf(loadflags & IO_INFO ? "-h+\t\t\t\t# output header\n" :
591 "-h-\t\t\t\t# no header\n");
592 printf("-f%c%c\t\t\t\t# format input/output = %s/%s\n",
593 inform, outform, formstr(inform), formstr(outform));
594 printf("-o%-9s\t\t\t# output", outvals);
595 for (cp = outvals; *cp; cp++)
596 switch (*cp) {
597 case 't': case 'T': printf(" trace"); break;
598 case 'o': printf(" origin"); break;
599 case 'd': printf(" direction"); break;
600 case 'r': printf(" reflect_contrib"); break;
601 case 'R': printf(" reflect_length"); break;
602 case 'x': printf(" unreflect_contrib"); break;
603 case 'X': printf(" unreflect_length"); break;
604 case 'v': printf(" value"); break;
605 case 'V': printf(" contribution"); break;
606 case 'l': printf(" length"); break;
607 case 'L': printf(" first_length"); break;
608 case 'p': printf(" point"); break;
609 case 'n': printf(" normal"); break;
610 case 'N': printf(" unperturbed_normal"); break;
611 case 's': printf(" surface"); break;
612 case 'w': printf(" weight"); break;
613 case 'W': printf(" coefficient"); break;
614 case 'm': printf(" modifier"); break;
615 case 'M': printf(" material"); break;
616 case '~': printf(" tilde"); break;
617 }
618 fputc('\n', stdout);
619 if (sens_curve == scolor_photopic)
620 printf("-pY\t\t\t\t# photopic output\n");
621 else if (sens_curve == scolor_scotopic)
622 printf("-pS\t\t\t\t# scotopic output\n");
623 else if (sens_curve == scolor_melanopic)
624 printf("-pM\t\t\t\t# melanopic output\n");
625 else if (out_prims == stdprims)
626 printf("-pRGB\t\t\t\t# standard RGB color output\n");
627 else if (out_prims == xyzprims)
628 printf("-pXYZ\t\t\t\t# CIE XYZ color output\n");
629 else if (out_prims != NULL)
630 printf("-pc %.4f %.4f %.4f %.4f %.4f %.4f %.4f %.4f\t# output color primaries and white point\n",
631 out_prims[RED][0], out_prims[RED][1],
632 out_prims[GRN][0], out_prims[GRN][1],
633 out_prims[BLU][0], out_prims[BLU][1],
634 out_prims[WHT][0], out_prims[WHT][1]);
635 if ((sens_curve == NULL) & (NCSAMP > 3))
636 printf(out_prims != NULL ? "-co-\t\t\t\t# output tristimulus colors\n" :
637 "-co+\t\t\t\t# output spectral values\n");
638 print_rdefaults();
639 }