src/rt/source.h

/* RCSid $Id: source.h,v 2.24 2023/11/15 18:02:53 greg Exp $ */
/*
 *  source.h - header file for ray tracing sources.
 *
 *  Include after ray.h
 */
#ifndef _RAD_SOURCE_H_
#define _RAD_SOURCE_H_

#include <string.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef  AIMREQT
#define  AIMREQT        100             /* required aim success/failure */
#endif
#ifndef  SHADCACHE
#define  SHADCACHE      20              /* shadow cache resolution */
#endif
#ifndef  MINSHADCNT
#define  MINSHADCNT     2               /* test at least this many shadows */
#endif

#define  SDISTANT       01              /* source distant flag */
#define  SSKIP          02              /* source skip flag */
#define  SPROX          04              /* source proximity flag */
#define  SSPOT          010             /* source spotlight flag */
#define  SVIRTUAL       020             /* source virtual flag */
#define  SFLAT          040             /* source flat flag */
#define  SCIR           0100            /* source circular flag */
#define  SCYL           0200            /* source cylindrical flag */
#define  SFOLLOW        0400            /* source follow path flag */

typedef struct {
        FVECT  aim;             /* aim direction or center */
        float  siz;             /* output solid angle or area */
        float  flen;            /* focal length (negative if distant source) */
} SPOT;                 /* spotlight */

typedef struct {
        union {
                struct {
                        FVECT   u, v;           /* unit vectors */
                }  f;                   /* flat source indexing */
                struct {
                        FVECT   o;              /* origin position */
                        RREAL   e1, e2;         /* 1/extent */
                        int     ax;             /* major direction */
                }  d;                   /* distant source indexing */
        }  p;                   /* indexing parameters */
        OBJECT  obs[1];         /* cache obstructors (extends struct) */
}  OBSCACHE;            /* obstructor cache */

typedef struct {
        FVECT  sloc;            /* direction or position of source */
        FVECT  ss[3];           /* source dimension vectors, U, V, and W */
        float  srad;            /* maximum source radius */
        float  ss2;             /* solid angle or projected area */
        OBJREC  *so;            /* source destination object */
        struct {
                float  prox;            /* proximity */
                SPOT  *s;               /* spot */
        } sl;                   /* localized source information */
        union {
                long  success;          /* successes - AIMREQT*failures */
                struct {
                        short  pn;              /* projection number */
                        int  sn;                /* next source to aim for */
                }  sv;                  /* virtual source */
        } sa;                   /* source aiming information */
        unsigned long
                ntests, nhits;  /* shadow tests and hits */
#if  SHADCACHE
        OBSCACHE  *obscache;    /* obstructor cache */
#endif
        int  sflags;            /* source flags */
}  SRCREC;              /* light source */

#define MAXSPART        64              /* maximum partitions per source */

#define SU              0               /* U vector or partition */
#define SV              1               /* V vector or partition */
#define SW              2               /* W vector or partition */
#define S0              3               /* leaf partition */

#define snorm           ss[SW]          /* normal vector for flat source */

typedef struct {
        double  dom;                            /* solid angle of partition */
        int  sn;                                /* source number */
        short  np;                              /* number of partitions */
        short  sp;                              /* this partition number */
        unsigned char  spt[MAXSPART/2];         /* source partitioning */
}  SRCINDEX;            /* source index structure */

#define initsrcindex(s) ((s)->sn = (s)->sp = -1, (s)->np = 0)

#define clrpart(pt)     memset((char *)(pt), '\0', MAXSPART/2)
#define setpart(pt,i,v) ((pt)[(i)>>2] |= (v)<<(((i)&3)<<1))
#define spart(pt,pi)    ((pt)[(pi)>>2] >> (((pi)&3)<<1) & 3)

/*
 * Special support functions for sources
 */

/*
 * Virtual source materials must define the following.
 *
 *      vproj(pm, op, sp, i)    Compute i'th virtual projection
 *                              of source sp in object op and assign
 *                              the 4x4 transformation matrix pm.
 *                              Return 1 on success, 0 if no i'th projection.
 *
 *      nproj                   The number of projections.  The value of
 *                              i passed to vproj runs from 0 to nproj-1.
 */

typedef struct {
        int  (*vproj)();        /* project virtual sources */
        int  nproj;             /* number of possible projections */
} VSMATERIAL;           /* virtual source material functions */

typedef struct {
        void    (*setsrc)();    /* set light source for object */
        void    (*partit)();    /* partition light source object */
        double  (*getpleq)();   /* plane equation for surface */
        double  (*getdisk)();   /* maximum disk for surface */
} SOBJECT;              /* source object functions */

typedef union {
        VSMATERIAL  *mf;        /* material functions */
        SOBJECT  *of;           /* object functions */
} SRCFUNC;              /* source functions */

extern SRCFUNC  sfun[];                 /* source dispatch table */

extern SRCREC  *source;                 /* our source list */
extern int  nsources;                   /* the number of sources */

#define  sflatform(sn,dir)      -DOT(source[sn].snorm, dir)

#define  getplaneq(c,o)         (*sfun[(o)->otype].of->getpleq)(c,o)
#define  getmaxdisk(c,o)        (*sfun[(o)->otype].of->getdisk)(c,o)
#define  setsource(s,o)         (*sfun[(o)->otype].of->setsrc)(s,o)

                                        /* defined in source.c */
extern void     marksources(void);
extern void     distantsources(void);
extern void     freesources(void);
extern int      srcray(RAY *sr, RAY *r, SRCINDEX *si);
extern void     srcvalue(RAY *r);
extern int      sourcehit(RAY *r);
typedef void srcdirf_t(SCOLOR cv, void *np, FVECT ldir, double omega);
extern void     direct(RAY *r, srcdirf_t *f, void *p);
extern void     srcscatter(RAY *r);
extern int      m_light(OBJREC *m, RAY *r);
                                        /* defined in srcobstr.c */
extern void     initobscache(int sn);
extern int      srcblocker(RAY *r);
extern int      srcblocked(RAY *r);
extern void     freeobscache(SRCREC *s);
extern void     markclip(OBJREC *m);
                                        /* defined in srcsamp.c */
extern int      srcskip(int sn, RAY *r);
extern double   nextssamp(RAY *r, SRCINDEX *si);
extern int      skipparts(int ct[3], int sz[3], int pp[2], unsigned char *pt);
extern void     nopart(SRCINDEX *si, RAY *r);
extern void     cylpart(SRCINDEX *si, RAY *r);
extern void     flatpart(SRCINDEX *si, RAY *r);
extern double   scylform(int sn, FVECT dir);
                                        /* defined in srcsupp.c */
extern void     initstypes(void);
extern int      newsource(void);
extern void     setflatss(SRCREC *src);
extern void     fsetsrc(SRCREC *src, OBJREC *so);
extern void     ssetsrc(SRCREC *src, OBJREC *so);
extern void     sphsetsrc(SRCREC *src, OBJREC *so);
extern void     rsetsrc(SRCREC *src, OBJREC *so);
extern void     cylsetsrc(SRCREC *src, OBJREC *so);
extern SPOT     *makespot(OBJREC *m);
extern int      spotout(RAY *r, SPOT *s);
extern double   fgetmaxdisk(FVECT ocent, OBJREC *op);
extern double   rgetmaxdisk(FVECT ocent, OBJREC *op);
extern double   fgetplaneq(FVECT nvec, OBJREC *op);
extern double   rgetplaneq(FVECT nvec, OBJREC *op);
extern int      commonspot(SPOT *sp1, SPOT *sp2, FVECT org);
extern int      commonbeam(SPOT *sp1, SPOT *sp2, FVECT org);
extern int      checkspot(SPOT *sp, FVECT nrm);
extern double   spotdisk(FVECT oc, OBJREC *op, SPOT *sp, FVECT pos);
extern double   beamdisk(FVECT oc, OBJREC *op, SPOT *sp, FVECT dir);
extern double   intercircle(FVECT cc, FVECT c1, FVECT c2,
                        double r1s, double r2s);
                                        /* defined in virtuals.c */
extern void     markvirtuals(void);
extern void     addvirtuals(int sn, int nr);
extern void     vproject(OBJREC *o, int sn, int n);
extern OBJREC   *vsmaterial(OBJREC *o);
extern int      makevsrc(OBJREC *op, int sn, MAT4 pm);
extern double   getdisk(FVECT oc, OBJREC *op, int sn);
extern int      vstestvis(int f, OBJREC *o, FVECT oc, double or2, int sn);
extern void     virtverb(int sn, FILE *fp);


#ifdef __cplusplus
}
#endif
#endif /* _RAD_SOURCE_H_ */

Revision:	2.25
Committed:	Sat Nov 9 15:21:32 2024 UTC (5 months, 3 weeks ago) by greg
Content type:	text/plain
Branch:	MAIN
Changes since 2.24:	+2 -1 lines
Log Message:	perf: Improved source scatter sampling
#	User	Rev	Content
1	greg	2.25	/* RCSid $Id: source.h,v 2.24 2023/11/15 18:02:53 greg Exp $ */
2	greg	1.1	/*
3			* source.h - header file for ray tracing sources.
4			*
5	greg	2.5	* Include after ray.h
6			*/
7	schorsch	2.7	#ifndef _RAD_SOURCE_H_
8			#define _RAD_SOURCE_H_
9	schorsch	2.11
10			#include <string.h>
11
12	schorsch	2.7	#ifdef __cplusplus
13			extern "C" {
14			#endif
15	schorsch	2.10
16	greg	2.12	#ifndef AIMREQT
17	greg	1.6	#define AIMREQT 100 /* required aim success/failure */
18	greg	2.12	#endif
19			#ifndef SHADCACHE
20			#define SHADCACHE 20 /* shadow cache resolution */
21			#endif
22	greg	2.19	#ifndef MINSHADCNT
23	greg	2.22	#define MINSHADCNT 2 /* test at least this many shadows */
24	greg	2.19	#endif
25	greg	1.6
26	greg	1.1	#define SDISTANT 01 /* source distant flag */
27			#define SSKIP 02 /* source skip flag */
28	greg	1.3	#define SPROX 04 /* source proximity flag */
29			#define SSPOT 010 /* source spotlight flag */
30	greg	1.6	#define SVIRTUAL 020 /* source virtual flag */
31			#define SFLAT 040 /* source flat flag */
32	greg	2.18	#define SCIR 0100 /* source circular flag */
33			#define SCYL 0200 /* source cylindrical flag */
34			#define SFOLLOW 0400 /* source follow path flag */
35	greg	1.1
36			typedef struct {
37	greg	1.6	FVECT aim; /* aim direction or center */
38			float siz; /* output solid angle or area */
39	greg	2.4	float flen; /* focal length (negative if distant source) */
40	greg	1.3	} SPOT; /* spotlight */
41
42			typedef struct {
43	greg	2.12	union {
44			struct {
45			FVECT u, v; /* unit vectors */
46			} f; /* flat source indexing */
47			struct {
48			FVECT o; /* origin position */
49			RREAL e1, e2; /* 1/extent */
50			int ax; /* major direction */
51			} d; /* distant source indexing */
52			} p; /* indexing parameters */
53			OBJECT obs[1]; /* cache obstructors (extends struct) */
54			} OBSCACHE; /* obstructor cache */
55
56			typedef struct {
57	greg	1.1	FVECT sloc; /* direction or position of source */
58	greg	1.14	FVECT ss[3]; /* source dimension vectors, U, V, and W */
59			float srad; /* maximum source radius */
60			float ss2; /* solid angle or projected area */
61	greg	2.12	OBJREC so; / source destination object */
62	greg	1.6	struct {
63	greg	1.3	float prox; /* proximity */
64			SPOT s; / spot */
65			} sl; /* localized source information */
66	greg	1.6	union {
67	greg	2.3	long success; /* successes - AIMREQTfailures /
68	greg	1.12	struct {
69			short pn; /* projection number */
70	greg	2.3	int sn; /* next source to aim for */
71	greg	1.12	} sv; /* virtual source */
72	greg	1.6	} sa; /* source aiming information */
73	greg	2.8	unsigned long
74			ntests, nhits; /* shadow tests and hits */
75	greg	2.23	#if SHADCACHE
76	greg	2.12	OBSCACHE obscache; / obstructor cache */
77			#endif
78	greg	2.16	int sflags; /* source flags */
79	greg	1.2	} SRCREC; /* light source */
80	greg	1.1
81	greg	1.15	#define MAXSPART 64 /* maximum partitions per source */
82	greg	1.14
83			#define SU 0 /* U vector or partition */
84			#define SV 1 /* V vector or partition */
85			#define SW 2 /* W vector or partition */
86			#define S0 3 /* leaf partition */
87
88			#define snorm ss[SW] /* normal vector for flat source */
89
90			typedef struct {
91	greg	2.16	double dom; /* solid angle of partition */
92	greg	1.14	int sn; /* source number */
93			short np; /* number of partitions */
94			short sp; /* this partition number */
95			unsigned char spt[MAXSPART/2]; /* source partitioning */
96			} SRCINDEX; /* source index structure */
97
98			#define initsrcindex(s) ((s)->sn = (s)->sp = -1, (s)->np = 0)
99
100	schorsch	2.10	#define clrpart(pt) memset((char *)(pt), '\0', MAXSPART/2)
101	greg	1.14	#define setpart(pt,i,v) ((pt)[(i)>>2] \|= (v)<<(((i)&3)<<1))
102			#define spart(pt,pi) ((pt)[(pi)>>2] >> (((pi)&3)<<1) & 3)
103
104	greg	1.8	/*
105			* Special support functions for sources
106			*/
107
108			/*
109	greg	1.10	* Virtual source materials must define the following.
110	greg	1.8	*
111			* vproj(pm, op, sp, i) Compute i'th virtual projection
112			* of source sp in object op and assign
113			* the 4x4 transformation matrix pm.
114			* Return 1 on success, 0 if no i'th projection.
115			*
116			* nproj The number of projections. The value of
117			* i passed to vproj runs from 0 to nproj-1.
118			*/
119
120	greg	1.2	typedef struct {
121	greg	1.8	int (vproj)(); / project virtual sources */
122			int nproj; /* number of possible projections */
123			} VSMATERIAL; /* virtual source material functions */
124	greg	1.4
125			typedef struct {
126	greg	2.5	void (setsrc)(); / set light source for object */
127			void (partit)(); / partition light source object */
128	greg	1.8	double (getpleq)(); / plane equation for surface */
129			double (getdisk)(); / maximum disk for surface */
130			} SOBJECT; /* source object functions */
131	greg	1.1
132	greg	1.8	typedef union {
133			VSMATERIAL mf; / material functions */
134			SOBJECT of; / object functions */
135			} SRCFUNC; /* source functions */
136
137			extern SRCFUNC sfun[]; /* source dispatch table */
138
139	greg	1.2	extern SRCREC source; / our source list */
140	greg	1.1	extern int nsources; /* the number of sources */
141
142	greg	1.14	#define sflatform(sn,dir) -DOT(source[sn].snorm, dir)
143
144	greg	1.11	#define getplaneq(c,o) (*sfun[(o)->otype].of->getpleq)(c,o)
145			#define getmaxdisk(c,o) (*sfun[(o)->otype].of->getdisk)(c,o)
146			#define setsource(s,o) (*sfun[(o)->otype].of->setsrc)(s,o)
147	greg	2.5
148			/* defined in source.c */
149			extern void marksources(void);
150	greg	2.21	extern void distantsources(void);
151	greg	2.5	extern void freesources(void);
152			extern int srcray(RAY sr, RAY r, SRCINDEX *si);
153			extern void srcvalue(RAY *r);
154			extern int sourcehit(RAY *r);
155	greg	2.24	typedef void srcdirf_t(SCOLOR cv, void *np, FVECT ldir, double omega);
156	schorsch	2.13	extern void direct(RAY r, srcdirf_t f, void *p);
157	greg	2.5	extern void srcscatter(RAY *r);
158			extern int m_light(OBJREC m, RAY r);
159	greg	2.17	/* defined in srcobstr.c */
160	greg	2.15	extern void initobscache(int sn);
161	greg	2.14	extern int srcblocker(RAY *r);
162	greg	2.12	extern int srcblocked(RAY *r);
163			extern void freeobscache(SRCREC *s);
164	greg	2.17	extern void markclip(OBJREC *m);
165	greg	2.5	/* defined in srcsamp.c */
166	greg	2.25	extern int srcskip(int sn, RAY *r);
167	greg	2.5	extern double nextssamp(RAY r, SRCINDEX si);
168			extern int skipparts(int ct[3], int sz[3], int pp[2], unsigned char *pt);
169			extern void nopart(SRCINDEX si, RAY r);
170			extern void cylpart(SRCINDEX si, RAY r);
171			extern void flatpart(SRCINDEX si, RAY r);
172			extern double scylform(int sn, FVECT dir);
173			/* defined in srcsupp.c */
174			extern void initstypes(void);
175			extern int newsource(void);
176			extern void setflatss(SRCREC *src);
177			extern void fsetsrc(SRCREC src, OBJREC so);
178			extern void ssetsrc(SRCREC src, OBJREC so);
179			extern void sphsetsrc(SRCREC src, OBJREC so);
180			extern void rsetsrc(SRCREC src, OBJREC so);
181			extern void cylsetsrc(SRCREC src, OBJREC so);
182			extern SPOT makespot(OBJREC m);
183			extern int spotout(RAY r, SPOT s);
184			extern double fgetmaxdisk(FVECT ocent, OBJREC *op);
185			extern double rgetmaxdisk(FVECT ocent, OBJREC *op);
186			extern double fgetplaneq(FVECT nvec, OBJREC *op);
187			extern double rgetplaneq(FVECT nvec, OBJREC *op);
188			extern int commonspot(SPOT sp1, SPOT sp2, FVECT org);
189			extern int commonbeam(SPOT sp1, SPOT sp2, FVECT org);
190			extern int checkspot(SPOT *sp, FVECT nrm);
191			extern double spotdisk(FVECT oc, OBJREC op, SPOT sp, FVECT pos);
192			extern double beamdisk(FVECT oc, OBJREC op, SPOT sp, FVECT dir);
193			extern double intercircle(FVECT cc, FVECT c1, FVECT c2,
194			double r1s, double r2s);
195			/* defined in virtuals.c */
196			extern void markvirtuals(void);
197			extern void addvirtuals(int sn, int nr);
198			extern void vproject(OBJREC *o, int sn, int n);
199			extern OBJREC vsmaterial(OBJREC o);
200			extern int makevsrc(OBJREC *op, int sn, MAT4 pm);
201			extern double getdisk(FVECT oc, OBJREC *op, int sn);
202			extern int vstestvis(int f, OBJREC *o, FVECT oc, double or2, int sn);
203			extern void virtverb(int sn, FILE *fp);
204
205	schorsch	2.7
206			#ifdef __cplusplus
207			}
208	greg	2.5	#endif
209	schorsch	2.7	#endif /* _RAD_SOURCE_H_ */
210