ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/rxcmain.cpp
Revision: 2.16
Committed: Wed Mar 5 17:29:57 2025 UTC (2 months ago) by greg
Branch: MAIN
Changes since 2.15: +6 -1 lines
Log Message:
feat(rxcontrib): Added SOFTWARE= line to header output

File Contents

# Content
1 #ifndef lint
2 static const char RCSid[] = "$Id: rxcmain.cpp,v 2.15 2025/01/02 20:19:48 greg Exp $";
3 #endif
4 /*
5 * rxcmain.c - main for rxcontrib ray contribution tracer
6 */
7
8 #include "copyright.h"
9
10 #include <signal.h>
11 #include <time.h>
12 #include <ctype.h>
13 #include "RcontribSimulManager.h"
14 #include "platform.h"
15 #include "func.h"
16
17 const char *sigerr[NSIG]; /* signal error messages */
18
19 int nproc = 1; /* number of processes requested */
20
21 int inpfmt = 'a'; /* input format */
22 int outfmt = 'f'; /* output format */
23
24 int report_intvl = 0; /* reporting interval (seconds) */
25
26 extern char * progname; // global argv[0]
27
28 RcontribSimulManager myRCmanager; // global rcontrib simulation manager
29
30 #define RCONTRIB_FEATURES "Multiprocessing\n" \
31 "Accumulation\nRecovery\n" \
32 "ImmediateIrradiance\n" \
33 "ProgressReporting\nDistanceLimiting\n" \
34 "InputFormats=a,f,d\nOutputFormats=f,d,c\n" \
35 "Outputs=V,W\n" \
36 "OutputCS=RGB,spec\n"
37
38 static void rxcontrib(const int rstart = 0);
39
40 static void
41 printdefaults(void) /* print default values to stdout */
42 {
43 printf("-c %-5d\t\t\t# accumulated rays per record\n", myRCmanager.accum);
44 printf(myRCmanager.HasFlag(RCcontrib) ?
45 "-V+\t\t\t\t# output contributions\n" :
46 "-V-\t\t\t\t# output coefficients\n");
47 if (myRCmanager.HasFlag(RTimmIrrad))
48 printf("-I+\t\t\t\t# immediate irradiance on\n");
49 printf("-n %-2d\t\t\t\t# number of rendering processes\n", nproc);
50 printf("-x %-9d\t\t\t# x resolution\n", myRCmanager.xres);
51 printf("-y %-9d\t\t\t# y resolution\n", myRCmanager.yres);
52 printf(myRCmanager.HasFlag(RTlimDist) ?
53 "-ld+\t\t\t\t# limit distance on\n" :
54 "-ld-\t\t\t\t# limit distance off\n");
55 printf("-f%c%c\t\t\t\t# format input/output = %s/%s\n",
56 inpfmt, outfmt, formstr(inpfmt), formstr(outfmt));
57 if (report_intvl > 0)
58 printf("-t %-9d\t\t\t# time between reports\n", report_intvl);
59 printf(erract[WARNING].pf != NULL ?
60 "-w+\t\t\t\t# warning messages on\n" :
61 "-w-\t\t\t\t# warning messages off\n");
62 print_rdefaults();
63 }
64
65
66 static void
67 onsig( /* fatal signal */
68 int signo
69 )
70 {
71 static int gotsig = 0;
72
73 if (gotsig++) /* two signals and we're gone! */
74 _exit(signo);
75
76 #ifdef SIGALRM
77 alarm(600); /* allow 10 minutes to clean up */
78 signal(SIGALRM, SIG_DFL); /* make certain we do die */
79 #endif
80 eputs("signal - ");
81 eputs(sigerr[signo]);
82 eputs("\n");
83 quit(3);
84 }
85
86
87 static void
88 sigdie( /* set fatal signal */
89 int signo,
90 const char *msg
91 )
92 {
93 if (signal(signo, onsig) == SIG_IGN)
94 signal(signo, SIG_IGN);
95 sigerr[signo] = msg;
96 }
97
98 /* set input/output format */
99 static void
100 setformat(const char *fmt)
101 {
102 switch (fmt[0]) {
103 case 'f':
104 case 'd':
105 SET_FILE_BINARY(stdin);
106 /* fall through */
107 case 'a':
108 inpfmt = fmt[0];
109 break;
110 default:
111 goto fmterr;
112 }
113 switch (fmt[1]) {
114 case '\0':
115 if (inpfmt == 'a')
116 goto fmterr;
117 outfmt = inpfmt;
118 return;
119 case 'f':
120 case 'd':
121 case 'c':
122 outfmt = fmt[1];
123 break;
124 default:
125 goto fmterr;
126 }
127 if (!fmt[2])
128 return;
129 fmterr:
130 sprintf(errmsg, "Unsupported i/o format: -f%s", fmt);
131 error(USER, errmsg);
132 }
133
134 /* Set default options */
135 static void
136 default_options(void)
137 {
138 rand_samp = 1;
139 dstrsrc = 0.9;
140 directrelay = 3;
141 vspretest = 512;
142 srcsizerat = .2;
143 specthresh = .02;
144 specjitter = 1.;
145 maxdepth = -10;
146 minweight = 2e-3;
147 ambres = 256;
148 ambdiv = 350;
149 ambounce = 1;
150 }
151
152 /* Set overriding options */
153 static void
154 override_options(void)
155 {
156 shadthresh = 0;
157 ambssamp = 0;
158 ambacc = 0;
159 }
160
161 int
162 main(int argc, char *argv[])
163 {
164 #define check(ol,al) if (argv[i][ol] || \
165 badarg(argc-i-1,argv+i+1,al)) \
166 goto badopt
167 #define check_bool(olen,var) switch (argv[i][olen]) { \
168 case '\0': var = !var; break; \
169 case 'y': case 'Y': case 't': case 'T': \
170 case '+': case '1': var = 1; break; \
171 case 'n': case 'N': case 'f': case 'F': \
172 case '-': case '0': var = 0; break; \
173 default: goto badopt; }
174 int force_open = 0;
175 int recover = 0;
176 char *curout = NULL;
177 char *prms = NULL;
178 char *binval = NULL;
179 int bincnt = 0;
180 int rval;
181 int i;
182 /* global program name */
183 progname = argv[0];
184 /* feature check only? */
185 strcat(RFeatureList, RCONTRIB_FEATURES);
186 if (argc > 1 && !strcmp(argv[1], "-features"))
187 return feature_status(argc-2, argv+2);
188 /* initialize calcomp routines early */
189 initfunc();
190 calcontext(RCCONTEXT);
191 /* set rcontrib defaults */
192 default_options();
193 /* option city */
194 for (i = 1; i < argc; i++) {
195 /* expand arguments */
196 while ((rval = expandarg(&argc, &argv, i)) > 0)
197 ;
198 if (rval < 0) {
199 sprintf(errmsg, "cannot expand '%s'", argv[i]);
200 error(SYSTEM, errmsg);
201 }
202 if (argv[i] == NULL || argv[i][0] != '-')
203 break; /* break from options */
204 if (!strcmp(argv[i], "-version")) {
205 puts(VersionID);
206 quit(0);
207 }
208 if (!strcmp(argv[i], "-defaults") ||
209 !strcmp(argv[i], "-help")) {
210 override_options();
211 printdefaults();
212 quit(0);
213 }
214 rval = getrenderopt(argc-i, argv+i);
215 if (rval >= 0) {
216 i += rval;
217 continue;
218 }
219 switch (argv[i][1]) {
220 case 'n': /* number of processes */
221 check(2,"i");
222 nproc = atoi(argv[++i]);
223 if (nproc < 0 && (nproc += RadSimulManager::GetNCores()) <= 0)
224 nproc = 1;
225 break;
226 case 'V': /* output contributions? */
227 rval = myRCmanager.HasFlag(RCcontrib);
228 check_bool(2,rval);
229 myRCmanager.SetFlag(RCcontrib, rval);
230 break;
231 case 'x': /* x resolution */
232 check(2,"i");
233 myRCmanager.xres = atoi(argv[++i]);
234 break;
235 case 'y': /* y resolution */
236 check(2,"i");
237 myRCmanager.yres = atoi(argv[++i]);
238 break;
239 case 'w': /* warnings on/off */
240 rval = (erract[WARNING].pf != NULL);
241 check_bool(2,rval);
242 if (rval) erract[WARNING].pf = wputs;
243 else erract[WARNING].pf = NULL;
244 break;
245 case 'e': /* .cal expression */
246 check(2,"s");
247 scompile(argv[++i], NULL, 0);
248 break;
249 case 'l': /* limit distance */
250 if (argv[i][2] != 'd')
251 goto badopt;
252 rval = myRCmanager.HasFlag(RTlimDist);
253 check_bool(3,rval);
254 myRCmanager.SetFlag(RTlimDist, rval);
255 break;
256 case 'I': /* immed. irradiance */
257 rval = myRCmanager.HasFlag(RTimmIrrad);
258 check_bool(2,rval);
259 myRCmanager.SetFlag(RTimmIrrad, rval);
260 break;
261 case 'f': /* .cal file or force or format */
262 if (!argv[i][2]) {
263 check(2,"s");
264 loadfunc(argv[++i]);
265 break;
266 }
267 if (argv[i][2] == 'o') {
268 check_bool(3,force_open);
269 break;
270 }
271 setformat(argv[i]+2);
272 myRCmanager.SetDataFormat(outfmt);
273 break;
274 case 'o': /* output file */
275 check(2,"s");
276 curout = argv[++i];
277 break;
278 case 'r': /* recover output */
279 check_bool(2,recover);
280 break;
281 case 'p': /* parameter setting(s) */
282 check(2,"s");
283 set_eparams(prms = argv[++i]);
284 break;
285 case 'c': /* sample count */
286 check(2,"i");
287 myRCmanager.accum = atoi(argv[++i]);
288 break;
289 case 'b': /* bin expression/count */
290 if (argv[i][2] == 'n') {
291 check(3,"s");
292 bincnt = (int)(eval(argv[++i]) + .5);
293 break;
294 }
295 check(2,"s");
296 binval = argv[++i];
297 break;
298 case 'm': /* modifier name */
299 check(2,"s");
300 myRCmanager.AddModifier(argv[++i], curout, prms, binval, bincnt);
301 break;
302 case 'M': /* file of modifier names */
303 check(2,"s");
304 myRCmanager.AddModFile(argv[++i], curout, prms, binval, bincnt);
305 break;
306 case 't': /* reporting interval */
307 check(2,"i");
308 report_intvl = atoi(argv[++i]);
309 break;
310 default:
311 goto badopt;
312 }
313 }
314 if (i != argc-1)
315 error(USER, "expected single octree argument");
316
317 override_options(); /* override some option settings */
318
319 if (!myRCmanager.GetOutput()) // check that we have work to do
320 error(USER, "missing required modifier argument");
321 // get ready to rock...
322 if (setspectrsamp(CNDX, WLPART) < 0)
323 error(USER, "unsupported spectral sampling");
324 /* set up signal handling */
325 sigdie(SIGINT, "Interrupt");
326 #ifdef SIGHUP
327 sigdie(SIGHUP, "Hangup");
328 #endif
329 sigdie(SIGTERM, "Terminate");
330 #ifdef SIGPIPE
331 sigdie(SIGPIPE, "Broken pipe");
332 #endif
333 #ifdef SIGALRM
334 sigdie(SIGALRM, "Alarm clock");
335 #endif
336 #ifdef SIGXCPU
337 sigdie(SIGXCPU, "CPU limit exceeded");
338 sigdie(SIGXFSZ, "File size exceeded");
339 #endif
340 #ifdef NICE
341 nice(NICE); /* lower priority */
342 #endif
343 // load octree
344 myRCmanager.LoadOctree(argv[argc-1]);
345 // add to header
346 myRCmanager.AddHeader(argc-1, argv);
347 {
348 char buf[128] = "SOFTWARE= ";
349 strcpy(buf+10, VersionID);
350 myRCmanager.AddHeader(buf);
351 }
352 // prepare output files
353 if (recover)
354 myRCmanager.outOp = RCOrecover;
355 else if (force_open)
356 myRCmanager.outOp = RCOforce;
357 else
358 myRCmanager.outOp = RCOnew;
359 // rval = # rows recovered
360 rval = myRCmanager.PrepOutput();
361 // check if recovered everything
362 if (rval >= myRCmanager.GetRowMax()) {
363 error(WARNING, "nothing left to compute");
364 quit(0);
365 }
366 rxcontrib(rval); /* trace ray contributions (loop) */
367
368 quit(0); /* exit clean */
369
370 badopt:
371 fprintf(stderr,
372 "Usage: %s [-V][-c count][-r][-e expr][-f source][-o ospec][-p p1=V1,p2=V2][-b binv][-bn N] {-m mod | -M file} [rtrace options] octree\n",
373 progname);
374 sprintf(errmsg, "command line error at '%s'", argv[i]);
375 error(USER, errmsg);
376 return(1); /* pro forma return */
377
378 #undef check
379 #undef check_bool
380 }
381
382
383 // skip specified number of bytes, return false if EOF
384 static bool
385 skipBytes(int n2skip)
386 {
387 while (n2skip-- > 0)
388 if (getchar() == EOF)
389 return false;
390 return true;
391 }
392
393
394 // skip specified number of whitespace-separated words, return false if EOF
395 static bool
396 skipWords(int n2skip)
397 {
398 int c;
399
400 while (n2skip-- > 0) {
401 do {
402 c = getchar();
403 } while (isspace(c));
404 do {
405 if (c == EOF) return false;
406 c = getchar();
407 } while (!isspace(c));
408 }
409 return true;
410 }
411
412
413 // read a bundle of myRCmanager.accum ray origins and directions
414 static bool
415 getRayBundle(FVECT *orig_dir = NULL)
416 {
417 int n2go = myRCmanager.accum;
418
419 switch (inpfmt) {
420 case 'a': // ASCII input
421 if (!orig_dir)
422 return skipWords(6*n2go);
423 while (n2go-- > 0) {
424 if (scanf(FVFORMAT, &orig_dir[0][0],
425 &orig_dir[0][1], &orig_dir[0][2]) != 3)
426 return false;
427 if (scanf(FVFORMAT, &orig_dir[1][0],
428 &orig_dir[1][1], &orig_dir[1][2]) != 3)
429 return false;
430 orig_dir += 2;
431 }
432 break;
433 case 'f': // float input
434 if (!orig_dir)
435 return skipBytes(6*sizeof(float)*n2go);
436 #ifdef SMLFLT
437 if (getbinary(orig_dir, sizeof(FVECT), 2*n2go, stdin) != 2*n2go)
438 return false;
439 orig_dir += 2*n2go;
440 #else
441 while (n2go-- > 0) {
442 float fvecs[6];
443 if (getbinary(fvecs, sizeof(fvecs), 1, stdin) != 1)
444 return false;
445 for (int i = 6; i--; )
446 orig_dir[0][i] = fvecs[i];
447 orig_dir += 2;
448 }
449 #endif
450 break;
451 case 'd': // double input
452 if (!orig_dir)
453 return skipBytes(6*sizeof(double)*n2go);
454 #ifndef SMLFLT
455 if (getbinary(orig_dir, sizeof(FVECT), 2*n2go, stdin) != 2*n2go)
456 return false;
457 orig_dir += 2*n2go;
458 #else
459 while (n2go-- > 0) {
460 double dvecs[6];
461 if (getbinary(dvecs, sizeof(dvecs), 1, stdin) != 1)
462 return false;
463 for (int i = 6; i--; )
464 orig_dir[0][i] = dvecs[i];
465 orig_dir += 2;
466 }
467 #endif
468 break;
469 default:
470 error(INTERNAL, "unsupported format in getRayBundle()");
471 return false;
472 }
473 n2go = myRCmanager.accum; // normalize directions
474 while (n2go-- > 0) {
475 orig_dir -= 2;
476 normalize(orig_dir[1]);
477 }
478 return true;
479 }
480
481
482 // Run loop to load data, report progress, etc.
483 void
484 rxcontrib(const int rstart)
485 {
486 const int totRows = myRCmanager.GetRowMax();
487 FVECT * odarr = (FVECT *)emalloc(sizeof(FVECT)*2*myRCmanager.accum);
488 time_t tstart, last_report;
489 int r = 0;
490
491 while (r < rstart) { // skip input rays already done
492 if (!getRayBundle())
493 goto readerr;
494 r++;
495 }
496 if (report_intvl > 0) { // set up reporting
497 if (r > 0) {
498 sprintf(errmsg, "recovered %.2f%% of total\n",
499 100.*r/totRows);
500 eputs(errmsg);
501 }
502 last_report = tstart = time(0);
503 }
504 // start children as requested
505 myRCmanager.SetThreadCount(nproc);
506
507 while (r < totRows) { // loop until done
508 time_t tnow;
509 if (!getRayBundle(odarr))
510 goto readerr;
511 if (myRCmanager.ComputeRecord(odarr) <= 0)
512 return; // error reported, hopefully...
513 r++;
514 if (report_intvl <= 0)
515 continue;
516 if (r == totRows) // need to finish up?
517 myRCmanager.SetThreadCount(1);
518 tnow = time(0);
519 if ((r < totRows) & (tnow < last_report+report_intvl))
520 continue;
521 sprintf(errmsg, "%.2f%% done after %.3f hours\n",
522 100.*myRCmanager.GetRowFinished()/totRows,
523 (1./3600.)*(tnow - tstart));
524 eputs(errmsg);
525 last_report = tnow;
526 }
527 efree(odarr);
528 return;
529 readerr:
530 sprintf(errmsg, "unexpected EOF on standard input (record %d of %d)",
531 r, totRows);
532 error(USER, errmsg);
533 }
534
535
536 void
537 wputs( /* warning output function */
538 const char *s
539 )
540 {
541 if (!erract[WARNING].pf) return;
542 int lasterrno = errno;
543 eputs(s);
544 errno = lasterrno;
545 }
546
547
548 void
549 eputs( /* put string to stderr */
550 const char *s
551 )
552 {
553 static int midline = 0;
554
555 if (!*s)
556 return;
557 if (!midline++) {
558 fputs(progname, stderr);
559 fputs(": ", stderr);
560 }
561 fputs(s, stderr);
562 if (s[strlen(s)-1] == '\n') {
563 fflush(stderr);
564 midline = 0;
565 }
566 }
567
568
569 /* Exit program */
570 void
571 quit(
572 int code
573 )
574 {
575 myRCmanager.FlushQueue(); // leave nothing in queue
576
577 exit(code);
578 }