/* RCSid: $Id: rhd_sample.h,v 3.10 2003/07/14 22:24:00 schorsch 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_ */