ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/common/tonemap.h
(Generate patch)

Comparing ray/src/common/tonemap.h (file contents):
Revision 3.9 by gwlarson, Mon Oct 5 16:49:52 1998 UTC vs.
Revision 3.19 by greg, Fri Jan 7 22:05:30 2005 UTC

# Line 1 | Line 1
1 < /* Copyright (c) 1998 Silicon Graphics, Inc. */
2 <
3 < /* SCCSid "$SunId$ SGI" */
4 <
1 > /* RCSid $Id$ */
2   /*
3   * Header file for tone mapping functions.
4   *
5   * Include after "color.h"
6   */
7 + #ifndef _RAD_TONEMAP_H_
8 + #define _RAD_TONEMAP_H_
9  
10 + #include        "tifftypes.h"
11  
12 + #ifdef __cplusplus
13 + extern "C" {
14 + #endif
15 +
16   /****    Argument Macros    ****/
17                                  /* Flags of what to do */
18   #define TM_F_HCONTR     01              /* human contrast sensitivity */
# Line 49 | Line 53
53  
54   #define TM_BRTSCALE     128             /* brightness scale factor (integer) */
55  
56 + #define TM_NOBRT        (-1<<15)        /* bogus brightness value */
57 + #define TM_NOLUM        (1e-17)         /* ridiculously small luminance */
58 +
59   #define TM_MAXPKG       8               /* maximum number of color formats */
60  
61  
# Line 59 | Line 66
66   #endif
67  
68   extern char     *tmErrorMessage[];      /* error messages */
62 – extern int      tmLastError;            /* last error incurred by library */
63 – extern char     *tmLastFunction;        /* error-generating function name */
69  
70   typedef short   TMbright;               /* encoded luminance type */
71  
72                                  /* basic tone mapping data structure */
73 < extern struct tmStruct {
73 > typedef struct tmStruct {
74          int             flags;          /* flags of what to do */
75          RGBPRIMP        monpri;         /* monitor RGB primaries */
76          double          mongam;         /* monitor gamma value (approx.) */
# Line 73 | Line 78 | extern struct tmStruct {
78          int             cdiv[3];        /* computed color divisors */
79          RGBPRIMP        inppri;         /* current input primaries */
80          double          inpsf;          /* current input scalefactor */
81 +        MEM_PTR         inpdat;         /* current input client data */
82          COLORMAT        cmat;           /* color conversion matrix */
83          TMbright        hbrmin, hbrmax; /* histogram brightness limits */      
84          int             *histo;         /* input histogram */
85          TMbright        mbrmin, mbrmax; /* mapped brightness limits */
86          unsigned short  *lumap;         /* computed luminance map */
81 –        struct tmStruct *tmprev;        /* previous tone mapping */
87          MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
88 < }       *tmTop;                 /* current tone mapping stack */
88 >        int             lastError;      /* last error incurred */
89 >        const char      *lastFunc;      /* error-generating function name */
90 > } TMstruct;
91  
92                                  /* conversion package functions */
86 – #ifdef  NOPROTO
93   struct tmPackage {
94 <        MEM_PTR         (*Init)();      /* initialize private data */
95 <        void            (*NewSpace)();  /* new input color space (optional) */
90 <        void            (*Free)();      /* free private data */
91 < };
92 < #else
93 < struct tmPackage {
94 <        MEM_PTR         (*Init)(struct tmStruct *tms);
95 <        int             (*NewSpace)(struct tmStruct *tms);
94 >        MEM_PTR         (*Init)(TMstruct *tms);
95 >        void            (*NewSpace)(TMstruct *tms);
96          void            (*Free)(MEM_PTR pp);
97   };
98 – #endif
98                                  /* our list of conversion packages */
99   extern struct tmPackage *tmPkg[TM_MAXPKG];
100   extern int      tmNumPkgs;      /* number of registered packages */
# Line 104 | Line 103 | extern int     tmNumPkgs;      /* number of registered packages
103   /****    Useful Macros    ****/
104  
105                                  /* compute luminance from encoded value */
106 < #define tmLuminance(li) exp((li)/(double)TM_BRTSCALE)
106 > #define tmLuminance(li) exp((li)*(1./TM_BRTSCALE))
107  
108                                  /* does tone mapping need color matrix? */
109   #define tmNeedMatrix(t) ((t)->monpri != (t)->inppri)
# Line 119 | Line 118 | extern int     tmNumPkgs;      /* number of registered packages
118  
119   /****    Library Function Calls    ****/
120  
122 – #ifdef  NOPROTO
121  
122 < extern struct tmStruct  *tmInit(), *tmPop(), *tmDup();
125 < extern void     tmClearHisto(), tmDone();
126 < extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
127 < extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
128 < extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
129 <
130 < #else
131 <
132 < extern struct tmStruct *
122 > extern TMstruct *
123   tmInit(int flags, RGBPRIMP monpri, double gamval);
124   /*
125 <        Initialize new tone mapping and push it onto stack.
125 >        Allocate and initialize new tone mapping.
126  
127          flags   -       TM_F_* flags indicating what is to be done.
128          monpri  -       display monitor primaries (Note 1).
129          gamval  -       display gamma response (can be approximate).
130  
131 <        returns -       new tmTop, or NULL if insufficient memory.
131 >        returns -       new tone-mapping pointer, or NULL if no memory.
132   */
133  
134   extern int
135 < tmSetSpace(RGBPRIMP pri, double sf);
135 > tmSetSpace(TMstruct *tms, RGBPRIMP pri, double sf, MEM_PTR dat);
136   /*
137          Set color primaries and scale factor for incoming scanlines.
138  
139 +        tms     -       tone mapping structure pointer.
140          pri     -       RGB color input primaries (Note 1).
141          sf      -       scale factor to get to luminance in cd/m^2.
142 +        dat     -       application-specific data (NULL if not needed)
143  
144          returns -       0 on success, TM_E_* code on failure.
145   */
146  
147   extern void
148 < tmClearHisto(void);
148 > tmClearHisto(TMstruct *tms);
149   /*
150          Clear histogram for current tone mapping.
159 – */
151  
152 < extern int
162 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
163 < /*
164 <        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
165 <
166 <        ls      -       returned encoded luminance values.
167 <        cs      -       returned encoded chrominance values (Note 2).
168 <        scan    -       input scanline.
169 <        len     -       scanline length.
170 <
171 <        returns -       0 on success, TM_E_* on error.
152 >        tms     -       tone mapping structure pointer.
153   */
154  
155   extern int
156 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
156 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
157   /*
158 <        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
158 >        Add brightness values to current histogram.
159  
160 <        ls      -       returned encoded luminance values.
161 <        cs      -       returned encoded chrominance values (Note 2).
162 <        scan    -       input scanline.
163 <        len     -       scanline length.
160 >        tms     -       tone mapping structure pointer.
161 >        ls      -       encoded luminance values.
162 >        len     -       number of luminance values.
163 >        wt      -       integer weight to use for each value (usually 1 or -1).
164  
165          returns -       0 on success, TM_E_* on error.
166   */
167  
168   extern int
169 < tmAddHisto(TMbright *ls, int len, int wt);
169 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
170   /*
171 <        Add brightness values to current histogram.
171 >        Assign a fixed, linear tone-mapping using the given multiplier,
172 >        which is the ratio of maximum output to uncalibrated input.
173 >        This mapping will be used in subsequent calls to tmMapPixels()
174 >        until a new tone mapping is computed.
175 >        Only the min. and max. values are used from the histogram.
176 >        
177 >        tms     -       tone mapping structure pointer.
178 >        expmult -       the fixed exposure multiplier to use.
179 >        gamval  -       display gamma response (0. for default).
180  
181 <        ls      -       encoded luminance values.
193 <        len     -       number of luminance values.
194 <        wt      -       integer weight to use for each value (usually 1 or -1).
195 <
196 <        returns -       0 on success, TM_E_* on error.
181 >        returns -       0 on success, TM_E_* on error.
182   */
183  
184   extern int
185 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
185 > tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
186   /*
187 <        Compute tone mapping function.  This mapping will be used
188 <        in subsequent calls to tmMapPixels() until a new tone mapping
189 <        is computed.  I.e., calls to tmAddHisto() have no immediate effect.
187 >        Compute tone mapping function from the current histogram.
188 >        This mapping will be used in subsequent calls to tmMapPixels()
189 >        until a new tone mapping is computed.
190 >        I.e., calls to tmAddHisto() have no immediate effect.
191  
192 +        tms     -       tone mapping structure pointer.
193          gamval  -       display gamma response (0. for default).
194          Lddyn   -       the display's dynamic range (0. for default).
195          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 211 | Line 198 | tmComputeMapping(double gamval, double Lddyn, double L
198   */
199  
200   extern int
201 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
201 > tmMapPixels(TMstruct *tms, BYTE *ps, TMbright *ls, BYTE *cs, int len);
202   /*
203          Apply tone mapping function to pixel values.
204  
205 +        tms     -       tone mapping structure pointer.
206          ps      -       returned pixel values (Note 2).
207          ls      -       encoded luminance values.
208          cs      -       encoded chrominance values (Note 2).
# Line 223 | Line 211 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
211          returns -       0 on success, TM_E_* on failure.
212   */
213  
214 + extern TMstruct *
215 + tmDup(TMstruct *orig);
216 + /*
217 +        Duplicate the given tone mapping into a new struct.
218 +
219 +        orig    -       tone mapping structure to duplicate.
220 +
221 +        returns -       pointer to new struct, or NULL on error.
222 + */
223 +
224 + extern void
225 + tmDone(TMstruct *tms);
226 + /*
227 +        Free data associated with the given tone mapping structure.
228 +
229 +        tms     -       tone mapping structure to free.
230 + */
231 +
232   extern int
233 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
233 > tmCvColors(TMstruct *tms, TMbright *ls, BYTE *cs, COLOR *scan, int len);
234 > /*
235 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
236 >
237 >        tms     -       tone mapping structure pointer.
238 >        ls      -       returned encoded luminance values.
239 >        cs      -       returned encoded chrominance values (Note 2).
240 >        scan    -       input scanline.
241 >        len     -       scanline length.
242 >
243 >        returns -       0 on success, TM_E_* on error.
244 > */
245 >
246 > extern int
247 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
248 > /*
249 >        Convert gray float scanline to encoded luminance.
250 >
251 >        tms     -       tone mapping structure pointer.
252 >        ls      -       returned encoded luminance values.
253 >        scan    -       input scanline.
254 >        len     -       scanline length.
255 >
256 >        returns -       0 on success, TM_E_* on error.
257 > */
258 >
259 > extern int
260 > tmCvColrs(TMstruct *tms, TMbright *ls, BYTE *cs, COLR *scan, int len);
261 > /*
262 >        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
263 >
264 >        tms     -       tone mapping structure pointer.
265 >        ls      -       returned encoded luminance values.
266 >        cs      -       returned encoded chrominance values (Note 2).
267 >        scan    -       input scanline.
268 >        len     -       scanline length.
269 >
270 >        returns -       0 on success, TM_E_* on error.
271 > */
272 >
273 > extern int
274 > tmLoadPicture(TMstruct *tms, TMbright **lpp, BYTE **cpp, int *xp, int *yp,
275                  char *fname, FILE *fp);
276   /*
277          Load Radiance picture and convert to tone mapping representation.
# Line 232 | Line 279 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
279          malloc(3), and should be freed with free(3) when no longer needed.
280          Calls tmSetSpace() to calibrate input color space.
281  
282 +        tms     -       tone mapping structure pointer.
283          lpp     -       returned array of encoded luminances, picture ordering.
284          cpp     -       returned array of encoded chrominances (Note 2).
285          xp, yp  -       returned picture dimensions.
# Line 247 | Line 295 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
295                  char *fname, FILE *fp);
296   /*
297          Load and apply tone mapping to Radiance picture.
250 –        Stack is restored to its original state upon return.
298          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
299          calls pcond to perform the actual conversion, which takes
300          longer but gives access to all the TM_F_* features.
# Line 267 | Line 314 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
314          returns -       0 on success, TM_E_* on failure.
315   */
316  
270 – extern struct tmStruct *
271 – tmPop(void);
272 – /*
273 –        Pops current tone mapping from stack.
274 –
275 –        returns -       pointer to tone mapping structure, or NULL if none.
276 – */
277 –
317   extern int
318 < tmPull(struct tmStruct *tms);
318 > tmCvRGB48(TMstruct *tms, TMbright *ls, BYTE *cs, uint16 (*scan)[3],
319 >                int len, double gv);
320   /*
321 <        Pull tone mapping from anywhere in stack.
321 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
322  
323 <        tms     -       tone mapping structure to find.
323 >        tms     -       tone mapping structure pointer.
324 >        ls      -       returned encoded luminance values.
325 >        cs      -       returned encoded chrominance values (Note 2).
326 >        scan    -       input scanline.
327 >        len     -       scanline length.
328 >        gv      -       input gamma value.
329  
330 <        returns -       1 if found in stack, 0 otherwise.
330 >        returns -       0 on success, TM_E_* on error.
331   */
332  
333   extern int
334 < tmPush(struct tmStruct *tms);
334 > tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
335   /*
336 <        Make tone mapping active by (pulling it and) pushing it to the top.
336 >        Convert 16-bit gray scanline to encoded luminance.
337  
338 <        tms     -       initialized tone mapping structure.
338 >        tms     -       tone mapping structure pointer.
339 >        ls      -       returned encoded luminance values.
340 >        scan    -       input scanline.
341 >        len     -       scanline length.
342 >        gv      -       input gamma value.
343  
344 <        returns -       0 on success, TM_E_* if tms is invalid.
344 >        returns -       0 on success, TM_E_* on error.
345   */
346  
298 – extern struct tmStruct *
299 – tmDup(void);
300 – /*
301 –        Duplicate the current tone mapping into a new structure on the stack.
302 –
303 –        returns -       pointer to new top, or NULL on error.
304 – */
305 –
306 – extern void
307 – tmDone(struct tmStruct *tms);
308 – /*
309 –        Free data associated with the given tone mapping structure.
310 –        Calls tmPull() first to remove it from the stack if present.
311 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
312 –        all have the same effect, which is to remove and free
313 –        the current tone mapping.
314 –
315 –        tms     -       tone mapping structure to free.
316 – */
317 –
318 – #endif
319 –
320 –
347   /****    Notes    ****/
348   /*
349          General:
# Line 388 | Line 414 | tmDone(struct tmStruct *tms);
414          function will open the file, read its contents and close it
415          before returning, whether or not an error was encountered.
416   */
417 +
418 + #ifdef __cplusplus
419 + }
420 + #endif
421 + #endif /* _RAD_TONEMAP_H_ */
422 +

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines