ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/ray.h
Revision: 2.43
Committed: Mon Jun 15 15:44:03 2020 UTC (3 years, 10 months ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.42: +2 -1 lines
Log Message:
Optimize rtrace for throughput, especially with ambient cache

File Contents

# User Rev Content
1 greg 2.43 /* RCSid $Id: ray.h,v 2.42 2020/02/26 17:58:06 greg Exp $ */
2 greg 1.1 /*
3     * ray.h - header file for routines using rays.
4 greg 2.12 */
5 schorsch 2.17 #ifndef _RAD_RAY_H_
6     #define _RAD_RAY_H_
7 greg 1.1
8     #include "standard.h"
9 greg 2.12 #include "octree.h"
10 greg 1.1 #include "object.h"
11 schorsch 2.20 #include "color.h"
12 greg 2.38 #include "pmapparm.h"
13 greg 1.1
14 schorsch 2.20 #ifdef __cplusplus
15     extern "C" {
16     #endif
17 greg 1.1
18 greg 2.30 #ifndef RNUMBER
19     #define RNUMBER unsigned long /* ray counter (>= sizeof pointer) */
20     #endif
21    
22 greg 2.6 #define MAXDIM 32 /* maximum number of dimensions */
23    
24 greg 1.1 /* ray type flags */
25     #define PRIMARY 01 /* original ray */
26     #define SHADOW 02 /* ray to light source */
27     #define REFLECTED 04 /* reflected ray */
28     #define REFRACTED 010 /* refracted (bent) ray */
29     #define TRANS 020 /* transmitted/transferred ray */
30     #define AMBIENT 040 /* ray scattered for interreflection */
31 greg 2.2 #define SPECULAR 0100 /* ray scattered for specular */
32 greg 1.1
33     /* reflected ray types */
34 greg 2.2 #define RAYREFL (SHADOW|REFLECTED|AMBIENT|SPECULAR)
35 greg 1.1
36 greg 2.29 /* Arrange so double's come first for optimal alignment */
37     /* Pointers and long's come second for 64-bit mode */
38     /* Int's next (unknown length), then floats, followed by short's & char's */
39 greg 1.1 typedef struct ray {
40 greg 2.12 FVECT rorg; /* origin of ray */
41     FVECT rdir; /* normalized direction of ray */
42 greg 2.29 RREAL rmax; /* maximum distance (aft clipping plane) */
43     RREAL rot; /* distance to object */
44     FVECT rop; /* intersection point */
45     FVECT ron; /* intersection surface normal */
46     RREAL rod; /* -DOT(rdir, ron) */
47     RREAL uv[2]; /* local coordinates */
48     FVECT pert; /* surface normal perturbation */
49 greg 2.39 RREAL rmt; /* returned mirrored ray length */
50     RREAL rxt; /* returned unmirrored ray length */
51 greg 2.29 const struct ray *parent; /* ray this originated from */
52 greg 2.12 OBJECT *clipset; /* set of objects currently clipped */
53     OBJECT *newcset; /* next clipset, used for transmission */
54 greg 2.26 void (*revf)(struct ray *); /* ray evaluation function */
55 greg 2.21 void (*hitf)(OBJECT *, struct ray *); /* custom hit test */
56 greg 2.12 OBJREC *ro; /* intersected object (one with material) */
57     FULLXF *rox; /* object transformation */
58 greg 2.29 int *slights; /* list of lights to test for scattering */
59 greg 2.30 RNUMBER rno; /* unique ray number */
60 greg 2.42 OBJECT robj; /* intersected object number */
61 greg 2.29 int rsrc; /* source we're aiming for */
62     float rweight; /* cumulative weight (for termination) */
63 greg 2.42 float gecc; /* scattering eccentricity coefficient */
64 greg 2.29 COLOR rcoef; /* contribution coefficient w.r.t. parent */
65 greg 2.12 COLOR pcol; /* pattern color */
66 greg 2.39 COLOR mcol; /* mirrored color contribution */
67 greg 2.24 COLOR rcol; /* returned radiance value */
68 greg 2.12 COLOR cext; /* medium extinction coefficient */
69     COLOR albedo; /* medium scattering albedo */
70 greg 2.42 short rflips; /* surface orientation has been reversed */
71     short rlvl; /* number of reflections for this ray */
72 greg 2.29 short rtype; /* ray type */
73     short crtype; /* cumulative ray type */
74 greg 1.1 } RAY;
75    
76 greg 2.26 #define rayvalue(r) (*(r)->revf)(r)
77    
78 greg 2.39 #define raydistance(r) (bright((r)->mcol) > 0.5*bright((r)->rcol) ? \
79     (r)->rmt : (r)->rxt)
80    
81 greg 2.41 #define rayreorient(r) if ((r)->rflips & 1) flipsurface(r); else
82    
83 greg 2.12 extern char VersionID[]; /* Radiance version ID string */
84 greg 1.6
85 greg 2.12 extern CUBE thescene; /* our scene */
86     extern OBJECT nsceneobjs; /* number of objects in our scene */
87 greg 2.5
88 greg 2.35 extern RNUMBER raynum; /* next ray ID */
89     extern RNUMBER nrays; /* total rays traced so far */
90 greg 1.5
91 greg 2.12 extern OBJREC Lamb; /* a Lambertian surface */
92     extern OBJREC Aftplane; /* aft clipping object */
93    
94     extern void (*trace)(); /* global trace reporting callback */
95    
96     extern int dimlist[]; /* dimension list for distribution */
97     extern int ndims; /* number of dimensions so far */
98     extern int samplendx; /* index for this sample */
99    
100     extern int ray_savesiz; /* size of parameter save buffer */
101    
102     extern int do_irrad; /* compute irradiance? */
103    
104 greg 2.27 extern int rand_samp; /* pure Monte Carlo sampling? */
105    
106 greg 2.12 extern double dstrsrc; /* square source distribution */
107     extern double shadthresh; /* shadow threshold */
108     extern double shadcert; /* shadow testing certainty */
109     extern int directrelay; /* number of source relays */
110     extern int vspretest; /* virtual source pretest density */
111     extern int directvis; /* light sources visible to eye? */
112     extern double srcsizerat; /* maximum source size/dist. ratio */
113    
114     extern double specthresh; /* specular sampling threshold */
115     extern double specjitter; /* specular sampling jitter */
116    
117     extern COLOR cextinction; /* global extinction coefficient */
118     extern COLOR salbedo; /* global scattering albedo */
119     extern double seccg; /* global scattering eccentricity */
120     extern double ssampdist; /* scatter sampling distance */
121    
122     extern int backvis; /* back face visibility */
123    
124     extern int maxdepth; /* maximum recursion depth */
125     extern double minweight; /* minimum ray weight */
126    
127     extern char *ambfile; /* ambient file name */
128     extern COLOR ambval; /* ambient value */
129     extern int ambvwt; /* initial weight for ambient value */
130     extern double ambacc; /* ambient accuracy */
131     extern int ambres; /* ambient resolution */
132     extern int ambdiv; /* ambient divisions */
133     extern int ambssamp; /* ambient super-samples */
134     extern int ambounce; /* ambient bounces */
135     extern char *amblist[]; /* ambient include/exclude list */
136     extern int ambincl; /* include == 1, exclude == 0 */
137    
138     extern int ray_pnprocs; /* number of child processes */
139     extern int ray_pnidle; /* number of idle processes */
140 greg 2.43 extern int ray_pnbatch; /* throughput over responsiveness? */
141 greg 2.12
142 greg 2.23 #ifndef AMBLLEN
143     #define AMBLLEN 512 /* max. ambient list length */
144     #endif
145     #define AMBWORD 12 /* average word length */
146 greg 2.12
147     typedef struct { /* rendering parameter holder */
148     int do_irrad;
149 greg 2.27 int rand_samp;
150 greg 2.12 double dstrsrc;
151     double shadthresh;
152     double shadcert;
153     int directrelay;
154     int vspretest;
155     int directvis;
156     double srcsizerat;
157     COLOR cextinction;
158     COLOR salbedo;
159     double seccg;
160     double ssampdist;
161     double specthresh;
162     double specjitter;
163     int backvis;
164     int maxdepth;
165     double minweight;
166     char ambfile[512];
167     COLOR ambval;
168     int ambvwt;
169     double ambacc;
170     int ambres;
171     int ambdiv;
172     int ambssamp;
173     int ambounce;
174     int ambincl;
175     short amblndx[AMBLLEN+1];
176     char amblval[AMBLLEN*AMBWORD];
177 greg 2.38
178     /* PMAP: photon mapping parameters */
179     PhotonMapParams pmapParams [NUM_PMAP_TYPES];
180 greg 2.12 } RAYPARAMS;
181    
182     #define rpambmod(p,i) ( (i)>=AMBLLEN||(p)->amblndx[i]<0 ? \
183     (char *)NULL : (p)->amblval+(p)->amblndx[i] )
184    
185     /* defined in duphead.c */
186     extern void headclean(void);
187     extern void openheader(void);
188     extern void dupheader(void);
189 schorsch 2.22 /* defined in persist.c */
190     extern void persistfile(char *pfn);
191 greg 2.12 extern void pfdetach(void);
192     extern void pfclean(void);
193     extern void pflock(int lf);
194     extern void pfhold(void);
195     extern void io_process(void);
196     /* defined in freeobjmem.c */
197     extern int free_objs(OBJECT on, OBJECT no);
198     extern void free_objmem(void);
199     /* defined in preload.c */
200     extern int load_os(OBJREC *op);
201     extern void preload_objs(void);
202     /* defined in raycalls.c */
203     extern void ray_init(char *otnm);
204     extern void ray_trace(RAY *r);
205     extern void ray_done(int freall);
206     extern void ray_save(RAYPARAMS *rp);
207     extern void ray_restore(RAYPARAMS *rp);
208     extern void ray_defaults(RAYPARAMS *rp);
209     /* defined in raypcalls.c */
210     extern void ray_pinit(char *otnm, int nproc);
211 greg 2.33 extern int ray_psend(RAY *r);
212 greg 2.12 extern int ray_pqueue(RAY *r);
213     extern int ray_presult(RAY *r, int poll);
214     extern void ray_pdone(int freall);
215     extern void ray_popen(int nadd);
216     extern void ray_pclose(int nsub);
217 greg 2.31 /* defined in ray_fifo.c */
218     extern int (*ray_fifo_out)(RAY *r);
219     extern int ray_fifo_in(RAY *r);
220     extern int ray_fifo_flush(void);
221 greg 2.12 /* defined in raytrace.c */
222 greg 2.25 extern int rayorigin(RAY *r, int rt, const RAY *ro, const COLOR rc);
223 greg 2.12 extern void rayclear(RAY *r);
224 greg 2.26 extern void raytrace(RAY *r);
225 greg 2.14 extern void rayhit(OBJECT *oset, RAY *r);
226 greg 2.12 extern void raycont(RAY *r);
227     extern void raytrans(RAY *r);
228 greg 2.40 extern int raytirrad(OBJREC *m, RAY *r);
229 greg 2.12 extern int rayshade(RAY *r, int mod);
230     extern void rayparticipate(RAY *r);
231 greg 2.16 extern void raytexture(RAY *r, OBJECT mod);
232 greg 2.12 extern int raymixture(RAY *r, OBJECT fore, OBJECT back, double coef);
233 greg 2.36 extern void raycontrib(RREAL rc[3], const RAY *r, int flags);
234 greg 2.25 extern double raydist(const RAY *r, int flags);
235 greg 2.12 extern double raynormal(FVECT norm, RAY *r);
236     extern void newrayxf(RAY *r);
237     extern void flipsurface(RAY *r);
238     extern int localhit(RAY *r, CUBE *scene);
239     /* defined in renderopts.c */
240     extern int getrenderopt(int ac, char *av[]);
241     extern void print_rdefaults(void);
242     /* defined in srcdraw.c */
243     extern void drawsources(COLOR *pic[], float *zbf[],
244     int x0, int xsiz, int y0, int ysiz);
245 schorsch 2.22 extern void init_drawsources(int rad);
246     /* defined in rt/initotypes.c */
247     extern void initotypes(void);
248 greg 2.12 /* module main procedures */
249 greg 2.32 extern void rtrace(char *fname, int nproc);
250     extern char *formstr(int f);
251 greg 2.12 extern void rview(void);
252     extern void rpict(int seq, char *pout, char *zout, char *prvr);
253 greg 1.6
254 greg 2.34 #ifdef __FAST_MATH__
255 greg 2.37 #define checknorm(vn) (void)normalize(vn)
256 greg 2.34 #else
257 greg 2.37 #define checknorm(vn)
258 greg 2.34 #endif
259 schorsch 2.17
260     #ifdef __cplusplus
261     }
262 greg 2.12 #endif
263 schorsch 2.17 #endif /* _RAD_RAY_H_ */
264