src/hd/rhd_sample.h

/* RCSid: $Id: rhd_sample.h,v 3.9 2003/06/20 00:25:49 greg Exp $ */
/*
 * Sample data structures for holodeck display drivers.
 *
 * Include after "standard.h"
 */
#ifndef _RAD_RHD_SAMPLE_H_
#define _RAD_RHD_SAMPLE_H_

#include "color.h"
#include "tonemap.h"
#include "rhdriver.h"
#include "object.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifndef INVALID
#define INVALID  -1
#endif

#define SFLOAT float

typedef OBJECT S_ID;

#define S_ID_MAX  ((1 << ((sizeof(S_ID)<<3)-1))-1)

typedef struct samp {
        SFLOAT          (*wp)[3];       /* world intersection point array */
        int32           *wd;            /* world direction array */
        TMbright        *brt;           /* encoded brightness array */
        BYTE            (*chr)[3];      /* encoded chrominance array */
        BYTE            (*rgb)[3];      /* tone-mapped color array */
        int             *info;          /* Extra sample info */
        int             *info1;         /* Extra sample info */
        int             max_samp;       /* maximum number of samples */
        int             max_base_pt;    /* maximum number of aux points */
        S_ID            next_base_pt;   /* next auxilliary point to add */
        S_ID            replace_samp;   /* next sample to free  */
        int             num_samp;       /* current number of samples */
        S_ID             tone_map;      /* pointer to next value(s)t tonemap*/
        S_ID             free_samp;     /* next free sample */
        char            *base;          /* base of allocated memory */
} SAMP;

/* Sample field access macros */
#define S_W_PT(s)               ((s)->wp)
#define S_W_DIR(s)              ((s)->wd)
#define S_BRT(s)                ((s)->brt)
#define S_CHR(s)                ((s)->chr)
#define S_RGB(s)                ((s)->rgb)
#define S_INFO(s)               ((s)->info)
#define S_INFO1(s)              ((s)->info1)
#define S_MAX_SAMP(s)           ((s)->max_samp)
#define S_MAX_BASE_PT(s)        ((s)->max_base_pt)
#define S_NEXT_BASE_PT(s)       ((s)->next_base_pt)
#define S_REPLACE_SAMP(s)       ((s)->replace_samp)
#define S_NUM_SAMP(s)           ((s)->num_samp)
#define S_TONE_MAP(s)           ((s)->tone_map)
#define S_FREE_SAMP(s)          ((s)->free_samp)
#define S_BASE(s)               ((s)->base)

#define S_MAX_POINTS(s)         ((s)->max_base_pt)
#define S_NTH_W_PT(s,n)         (S_W_PT(s)[(n)])
#define S_NTH_W_DIR(s,n)        (S_W_DIR(s)[(n)])
#define S_NTH_RGB(s,n)          (S_RGB(s)[(n)])
#define S_NTH_CHR(s,n)          (S_CHR(s)[(n)])
#define S_NTH_INFO(s,n)         (S_INFO(s)[(n)])
#define S_NTH_INFO1(s,n)        (S_INFO1(s)[(n)])
#define S_NTH_BRT(s,n)          (S_BRT(s)[(n)])

/* Sample Flag macros */
#define S_IS_FLAG(s)            IS_FLAG(samp_flag,s)
#define S_SET_FLAG(s)           SET_FLAG(samp_flag,s)
#define S_CLR_FLAG(s)           CLR_FLAG(samp_flag,s)

#define S_NTH_NEXT(s,n)         S_NTH_W_DIR(s,n)
#define sUnalloc_samp(s,n) (S_NTH_NEXT(s,n)=S_FREE_SAMP(s),S_FREE_SAMP(s)=n)
#define sClear_base_points(s)  (S_NEXT_BASE_PT(s) = S_MAX_SAMP(s))
#define sClear(s)      sInit(s)
/* MAXDIFF2 Max allowed cos angle squared of sample dir from current view */
/* In terms of cos: if angle is 30: MAXDIFF2 = cos(30)^2, if difference
  is greater than this point not accepted on rebuild
  */
#define MAXDIFF2        0.75
/* Max difference in direction for points at infinity: if over 45degrees
  not accepted on rebuild cos(45)
  */
#define MAXDIR           0.70710678        
#define MAXQUALITY      10000   /* Maximum quality for rendering rep */

extern  SAMP rsL;                       
extern double   sDepthEps;      /* epsilon to compare depths (z fraction) */
extern int32    encodedir();    /* Encodes FVECT direction */
extern void     decodedir();    /* Decodes dir-> FVECT */
extern double   fdir2diff(), dir2diff(); /* Compare dir and FVECT */
extern int32    *samp_flag;     /* Per/sample flags s */

/* These values are set by the driver, and used in the OGL call for glFrustum*/
extern double dev_zmin,dev_zmax;
extern S_ID sAdd_base_point();
extern SAMP *sAlloc();
extern S_ID sAlloc_samp();
/*
 * int
 * smInit(n)            : Initialize/clear data structures for n entries
 * int  n;
 *
 * Initialize sampL and other data structures for at least n samples.
 * If n is 0, then free data structures.  Return number actually allocated.
 *
 *
 * int
 * smNewSamp(c, p, v)   : register new sample point and return index
 * COLR c;              : pixel color (RGBE)
 * FVECT        p;      : world intersection point
 * FVECT        v;      : ray direction vector
 *
 * Add new sample point to data structures, removing old values as necessary.
 * New sample representation will be output in next call to smUpdate().
 *
 *
 * int
 * smFindSamp(orig, dir): intersect ray with 3D rep. and find closest sample
 * FVECT        orig, dir;
 *
 * Find the closest sample to the given ray.  Return -1 on failure.
 *
 *
 * smClean()            : display has been wiped clean
 *
 * Called after display has been effectively cleared, meaning that all
 * geometry must be resent down the pipeline in the next call to smUpdate().
 *
 *
 * smUpdate(vp, qua)    : update OpenGL output geometry for view vp
 * VIEW *vp;            : desired view
 * int  qua;            : quality level (percentage on linear time scale)
 *
 * Draw new geometric representation using OpenGL calls.  Assume that the
 * view has already been set up and the correct frame buffer has been
 * selected for drawing.  The quality level is on a linear scale, where 100%
 * is full (final) quality.  It is not necessary to redraw geometry that has
 * been output since the last call to smClean().  (The last view drawn will
 * be vp==&odev.v each time.)
 */


#ifdef __cplusplus
}
#endif
#endif /* _RAD_RHD_SAMPLE_H_ */


Revision:	3.10
Committed:	Mon Jul 14 22:24:00 2003 UTC (20 years, 9 months ago) by schorsch
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rad3R6P1, rad3R6
Changes since 3.9:	+12 -2 lines
Log Message:	Instrumented headers against multiple inclusion and for use from C++. Moved includes in headers out of "C" scope.
#	User	Rev	Content
1	schorsch	3.10	/* RCSid: $Id: rhd_sample.h,v 3.9 2003/06/20 00:25:49 greg Exp $ */
2	gwlarson	3.1	/*
3			* Sample data structures for holodeck display drivers.
4	greg	3.9	*
5			* Include after "standard.h"
6	gwlarson	3.1	*/
7	schorsch	3.10	#ifndef _RAD_RHD_SAMPLE_H_
8			#define _RAD_RHD_SAMPLE_H_
9
10	gwlarson	3.1	#include "color.h"
11			#include "tonemap.h"
12			#include "rhdriver.h"
13	greg	3.8	#include "object.h"
14	gwlarson	3.1
15	schorsch	3.10	#ifdef __cplusplus
16			extern "C" {
17			#endif
18
19	gwlarson	3.3	#ifndef INVALID
20			#define INVALID -1
21			#endif
22
23	simmons	3.7	#define SFLOAT float
24	greg	3.8
25			typedef OBJECT S_ID;
26
27			#define S_ID_MAX ((1 << ((sizeof(S_ID)<<3)-1))-1)
28	gwlarson	3.6
29	gwlarson	3.3	typedef struct samp {
30	simmons	3.7	SFLOAT (wp)[3]; / world intersection point array */
31	greg	3.9	int32 wd; / world direction array */
32	gwlarson	3.1	TMbright brt; / encoded brightness array */
33			BYTE (chr)[3]; / encoded chrominance array */
34			BYTE (rgb)[3]; / tone-mapped color array */
35	gwlarson	3.6	int info; / Extra sample info */
36	greg	3.8	int info1; / Extra sample info */
37	gwlarson	3.1	int max_samp; /* maximum number of samples */
38	greg	3.8	int max_base_pt; /* maximum number of aux points */
39			S_ID next_base_pt; /* next auxilliary point to add */
40			S_ID replace_samp; /* next sample to free */
41	gwlarson	3.3	int num_samp; /* current number of samples */
42	greg	3.8	S_ID tone_map; /* pointer to next value(s)t tonemap*/
43			S_ID free_samp; /* next free sample */
44	gwlarson	3.1	char base; / base of allocated memory */
45	gwlarson	3.3	} SAMP;
46	gwlarson	3.1
47	gwlarson	3.3	/* Sample field access macros */
48			#define S_W_PT(s) ((s)->wp)
49			#define S_W_DIR(s) ((s)->wd)
50			#define S_BRT(s) ((s)->brt)
51			#define S_CHR(s) ((s)->chr)
52			#define S_RGB(s) ((s)->rgb)
53	gwlarson	3.6	#define S_INFO(s) ((s)->info)
54	greg	3.8	#define S_INFO1(s) ((s)->info1)
55	gwlarson	3.3	#define S_MAX_SAMP(s) ((s)->max_samp)
56			#define S_MAX_BASE_PT(s) ((s)->max_base_pt)
57			#define S_NEXT_BASE_PT(s) ((s)->next_base_pt)
58			#define S_REPLACE_SAMP(s) ((s)->replace_samp)
59			#define S_NUM_SAMP(s) ((s)->num_samp)
60			#define S_TONE_MAP(s) ((s)->tone_map)
61	gwlarson	3.6	#define S_FREE_SAMP(s) ((s)->free_samp)
62	gwlarson	3.3	#define S_BASE(s) ((s)->base)
63	gwlarson	3.1
64	gwlarson	3.3	#define S_MAX_POINTS(s) ((s)->max_base_pt)
65			#define S_NTH_W_PT(s,n) (S_W_PT(s)[(n)])
66			#define S_NTH_W_DIR(s,n) (S_W_DIR(s)[(n)])
67			#define S_NTH_RGB(s,n) (S_RGB(s)[(n)])
68			#define S_NTH_CHR(s,n) (S_CHR(s)[(n)])
69	gwlarson	3.6	#define S_NTH_INFO(s,n) (S_INFO(s)[(n)])
70	greg	3.8	#define S_NTH_INFO1(s,n) (S_INFO1(s)[(n)])
71	gwlarson	3.3	#define S_NTH_BRT(s,n) (S_BRT(s)[(n)])
72	gwlarson	3.6
73	gwlarson	3.3	/* Sample Flag macros */
74			#define S_IS_FLAG(s) IS_FLAG(samp_flag,s)
75			#define S_SET_FLAG(s) SET_FLAG(samp_flag,s)
76			#define S_CLR_FLAG(s) CLR_FLAG(samp_flag,s)
77	gwlarson	3.1
78	gwlarson	3.4	#define S_NTH_NEXT(s,n) S_NTH_W_DIR(s,n)
79	gwlarson	3.6	#define sUnalloc_samp(s,n) (S_NTH_NEXT(s,n)=S_FREE_SAMP(s),S_FREE_SAMP(s)=n)
80	gwlarson	3.3	#define sClear_base_points(s) (S_NEXT_BASE_PT(s) = S_MAX_SAMP(s))
81			#define sClear(s) sInit(s)
82	gwlarson	3.6	/* MAXDIFF2 Max allowed cos angle squared of sample dir from current view */
83			/* In terms of cos: if angle is 30: MAXDIFF2 = cos(30)^2, if difference
84			is greater than this point not accepted on rebuild
85			*/
86			#define MAXDIFF2 0.75
87			/* Max difference in direction for points at infinity: if over 45degrees
88			not accepted on rebuild cos(45)
89			*/
90			#define MAXDIR 0.70710678
91	gwlarson	3.5	#define MAXQUALITY 10000 /* Maximum quality for rendering rep */
92	gwlarson	3.1
93	gwlarson	3.3	extern SAMP rsL;
94			extern double sDepthEps; /* epsilon to compare depths (z fraction) */
95	greg	3.9	extern int32 encodedir(); /* Encodes FVECT direction */
96	gwlarson	3.3	extern void decodedir(); /* Decodes dir-> FVECT */
97			extern double fdir2diff(), dir2diff(); /* Compare dir and FVECT */
98	greg	3.9	extern int32 samp_flag; / Per/sample flags s */
99	gwlarson	3.3
100	gwlarson	3.1	/* These values are set by the driver, and used in the OGL call for glFrustum*/
101			extern double dev_zmin,dev_zmax;
102	greg	3.8	extern S_ID sAdd_base_point();
103	gwlarson	3.3	extern SAMP *sAlloc();
104	greg	3.8	extern S_ID sAlloc_samp();
105			/*
106			* int
107			* smInit(n) : Initialize/clear data structures for n entries
108			* int n;
109			*
110			* Initialize sampL and other data structures for at least n samples.
111			* If n is 0, then free data structures. Return number actually allocated.
112			*
113			*
114			* int
115			* smNewSamp(c, p, v) : register new sample point and return index
116			* COLR c; : pixel color (RGBE)
117			* FVECT p; : world intersection point
118			* FVECT v; : ray direction vector
119			*
120			* Add new sample point to data structures, removing old values as necessary.
121			* New sample representation will be output in next call to smUpdate().
122			*
123			*
124			* int
125			* smFindSamp(orig, dir): intersect ray with 3D rep. and find closest sample
126			* FVECT orig, dir;
127			*
128			* Find the closest sample to the given ray. Return -1 on failure.
129			*
130			*
131			* smClean() : display has been wiped clean
132			*
133			* Called after display has been effectively cleared, meaning that all
134			* geometry must be resent down the pipeline in the next call to smUpdate().
135			*
136			*
137			* smUpdate(vp, qua) : update OpenGL output geometry for view vp
138			* VIEW *vp; : desired view
139			* int qua; : quality level (percentage on linear time scale)
140			*
141			* Draw new geometric representation using OpenGL calls. Assume that the
142			* view has already been set up and the correct frame buffer has been
143			* selected for drawing. The quality level is on a linear scale, where 100%
144			* is full (final) quality. It is not necessary to redraw geometry that has
145			* been output since the last call to smClean(). (The last view drawn will
146			* be vp==&odev.v each time.)
147			*/
148	gwlarson	3.1
149
150	schorsch	3.10	#ifdef __cplusplus
151			}
152			#endif
153			#endif /* _RAD_RHD_SAMPLE_H_ */
154	gwlarson	3.1
155
156