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.5 by greg, Mon Apr 21 15:23:42 1997 UTC vs.
Revision 3.14 by greg, Fri Jun 27 06:53:22 2003 UTC

# Line 1 | Line 1
1 < /* Copyright (c) 1997 Regents of the University of California */
2 <
3 < /* SCCSid "$SunId$ LBL" */
4 <
1 > /* RCSid $Id$ */
2   /*
3   * Header file for tone mapping functions.
4 + *
5 + * Include after "color.h"
6   */
7 <                                /* required non-system header files */
8 < #include        "color.h"
7 > #ifndef _RAD_TONEMAP_H_
8 > #define _RAD_TONEMAP_H_
9 > #ifdef __cplusplus
10 > extern "C" {
11 > #endif
12  
11
13   /****    Argument Macros    ****/
14                                  /* Flags of what to do */
15   #define TM_F_HCONTR     01              /* human contrast sensitivity */
# Line 32 | Line 33
33   #define TM_NOCHROMP     (BYTE **)NULL   /* indicate no chrominances */
34   #define TM_GETFILE      (FILE *)NULL    /* indicate file must be opened */
35  
36 +
37   /****    Error Return Values    ****/
38  
39   #define TM_E_OK         0               /* normal return status */
# Line 48 | Line 50
50  
51   #define TM_BRTSCALE     128             /* brightness scale factor (integer) */
52  
53 + #define TM_NOBRT        (-1<<15)        /* bogus brightness value */
54 + #define TM_NOLUM        (1e-17)         /* ridiculously small luminance */
55 +
56   #define TM_MAXPKG       8               /* maximum number of color formats */
57  
58  
# Line 58 | Line 63
63   #endif
64  
65   extern char     *tmErrorMessage[];      /* error messages */
66 + extern int      tmLastError;            /* last error incurred by library */
67 + extern char     *tmLastFunction;        /* error-generating function name */
68  
69   typedef short   TMbright;               /* encoded luminance type */
70  
# Line 71 | Line 78 | extern struct tmStruct {
78          RGBPRIMP        inppri;         /* current input primaries */
79          double          inpsf;          /* current input scalefactor */
80          COLORMAT        cmat;           /* color conversion matrix */
81 <        TMbright        brmin, brmax;   /* input brightness limits */  
81 >        TMbright        hbrmin, hbrmax; /* histogram brightness limits */      
82          int             *histo;         /* input histogram */
83 +        TMbright        mbrmin, mbrmax; /* mapped brightness limits */
84          unsigned short  *lumap;         /* computed luminance map */
85          struct tmStruct *tmprev;        /* previous tone mapping */
86          MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
87   }       *tmTop;                 /* current tone mapping stack */
88  
89                                  /* conversion package functions */
82 #ifdef  NOPROTO
90   struct tmPackage {
84        MEM_PTR         (*Init)();      /* initialize private data */
85        void            (*NewSpace)();  /* new input color space (optional) */
86        void            (*Free)();      /* free private data */
87 };
88 #else
89 struct tmPackage {
91          MEM_PTR         (*Init)(struct tmStruct *tms);
92 <        int             (*NewSpace)(struct tmStruct *tms);
92 >        void            (*NewSpace)(struct tmStruct *tms);
93          void            (*Free)(MEM_PTR pp);
94   };
94 #endif
95                                  /* our list of conversion packages */
96   extern struct tmPackage *tmPkg[TM_MAXPKG];
97   extern int      tmNumPkgs;      /* number of registered packages */
# Line 100 | Line 100 | extern int     tmNumPkgs;      /* number of registered packages
100   /****    Useful Macros    ****/
101  
102                                  /* compute luminance from encoded value */
103 < #define tmLuminance(li) exp((li)/(double)TM_BRTSCALE)
103 > #define tmLuminance(li) exp((li)*(1./TM_BRTSCALE))
104  
105                                  /* does tone mapping need color matrix? */
106   #define tmNeedMatrix(t) ((t)->monpri != (t)->inppri)
# Line 115 | Line 115 | extern int     tmNumPkgs;      /* number of registered packages
115  
116   /****    Library Function Calls    ****/
117  
118 #ifdef  NOPROTO
118  
120 extern struct tmStruct  *tmInit(), *tmPop(), *tmDup();
121 extern void     tmClearHisto(), tmDone();
122 extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
123 extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
124 extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
125
126 #else
127
119   extern struct tmStruct *
120   tmInit(int flags, RGBPRIMP monpri, double gamval);
121   /*
# Line 155 | Line 146 | tmClearHisto(void);
146   */
147  
148   extern int
158 tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
159 /*
160        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
161
162        ls      -       returned encoded luminance values.
163        cs      -       returned encoded chrominance values (Note 2).
164        scan    -       input scanline.
165        len     -       scanline length.
166
167        returns -       0 on success, TM_E_* on error.
168 */
169
170 extern int
171 tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
172 /*
173        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
174
175        ls      -       returned encoded luminance values.
176        cs      -       returned encoded chrominance values (Note 2).
177        scan    -       input scanline.
178        len     -       scanline length.
179
180        returns -       0 on success, TM_E_* on error.
181 */
182
183 extern int
149   tmAddHisto(TMbright *ls, int len, int wt);
150   /*
151          Add brightness values to current histogram.
# Line 193 | Line 158 | tmAddHisto(TMbright *ls, int len, int wt);
158   */
159  
160   extern int
161 + tmFixedMapping(double expmult, double gamval);
162 + /*
163 +        Assign a fixed, linear tone-mapping using the given multiplier,
164 +        which is the ratio of maximum output to uncalibrated input.
165 +        This mapping will be used in subsequent calls to tmMapPixels()
166 +        until a new tone mapping is computed.
167 +        Only the min. and max. values are used from the histogram.
168 +        
169 +        expmult -       the fixed exposure multiplier to use.
170 +        gamval  -       display gamma response (0. for default).
171 +        returns -       0 on success, TM_E_* on error.
172 + */
173 +
174 + extern int
175   tmComputeMapping(double gamval, double Lddyn, double Ldmax);
176   /*
177 <        Compute tone mapping function.
177 >        Compute tone mapping function from the current histogram.
178 >        This mapping will be used in subsequent calls to tmMapPixels()
179 >        until a new tone mapping is computed.
180 >        I.e., calls to tmAddHisto() have no immediate effect.
181  
182          gamval  -       display gamma response (0. for default).
183          Lddyn   -       the display's dynamic range (0. for default).
# Line 217 | Line 199 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
199          returns -       0 on success, TM_E_* on failure.
200   */
201  
220 extern int
221 tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
222                char *fname, FILE *fp);
223 /*
224        Load Radiance picture and convert to tone mapping representation.
225        Memory for the luminance and chroma arrays is allocated using
226        malloc(3), and should be freed with free(3) when no longer needed.
227        Calls tmSetSpace() to calibrate input color space.
228
229        lpp     -       returned array of encoded luminances, English ordering.
230        cpp     -       returned array of encoded chrominances (Note 2).
231        xp, yp  -       returned picture dimensions.
232        fname   -       picture file name.
233        fp      -       pointer to open file (Note 3).
234
235        returns -       0 on success, TM_E_* on failure.
236 */
237
238 extern int
239 tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
240                RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax,
241                char *fname, FILE *fp);
242 /*
243        Load and apply tone mapping to Radiance picture.
244        Stack is restored to its original state upon return.
245        If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
246        calls pcond to perform the actual conversion, which takes
247        longer but gives access to all the TM_F_* features.
248        Memory for the final pixel array is allocated using malloc(3),
249        and should be freed with free(3) when it is no longer needed.
250
251        psp     -       returned array of tone mapped pixels, English ordering.
252        xp, yp  -       returned picture dimensions.
253        flags   -       TM_F_* flags indicating what is to be done.
254        monpri  -       display monitor primaries (Note 1).
255        gamval  -       display gamma response.
256        Lddyn   -       the display's dynamic range (0. for default).
257        Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
258        fname   -       picture file name.
259        fp      -       pointer to open file (Note 3).
260
261        returns -       0 on success, TM_E_* on failure.
262 */
263
202   extern struct tmStruct *
203   tmPop(void);
204   /*
# Line 309 | Line 247 | tmDone(struct tmStruct *tms);
247          tms     -       tone mapping structure to free.
248   */
249  
250 < #endif
250 > extern int
251 > tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
252 > /*
253 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
254  
255 +        ls      -       returned encoded luminance values.
256 +        cs      -       returned encoded chrominance values (Note 2).
257 +        scan    -       input scanline.
258 +        len     -       scanline length.
259  
260 +        returns -       0 on success, TM_E_* on error.
261 + */
262 +
263 + extern int
264 + tmCvGrays(TMbright *ls, float *scan, int len);
265 + /*
266 +        Convert gray float scanline to encoded luminance.
267 +
268 +        ls      -       returned encoded luminance values.
269 +        scan    -       input scanline.
270 +        len     -       scanline length.
271 +
272 +        returns -       0 on success, TM_E_* on error.
273 + */
274 +
275 + extern int
276 + tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
277 + /*
278 +        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
279 +
280 +        ls      -       returned encoded luminance values.
281 +        cs      -       returned encoded chrominance values (Note 2).
282 +        scan    -       input scanline.
283 +        len     -       scanline length.
284 +
285 +        returns -       0 on success, TM_E_* on error.
286 + */
287 +
288 + extern int
289 + tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
290 +                char *fname, FILE *fp);
291 + /*
292 +        Load Radiance picture and convert to tone mapping representation.
293 +        Memory for the luminance and chroma arrays is allocated using
294 +        malloc(3), and should be freed with free(3) when no longer needed.
295 +        Calls tmSetSpace() to calibrate input color space.
296 +
297 +        lpp     -       returned array of encoded luminances, picture ordering.
298 +        cpp     -       returned array of encoded chrominances (Note 2).
299 +        xp, yp  -       returned picture dimensions.
300 +        fname   -       picture file name.
301 +        fp      -       pointer to open file (Note 3).
302 +
303 +        returns -       0 on success, TM_E_* on failure.
304 + */
305 +
306 + extern int
307 + tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
308 +                RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax,
309 +                char *fname, FILE *fp);
310 + /*
311 +        Load and apply tone mapping to Radiance picture.
312 +        Stack is restored to its original state upon return.
313 +        If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
314 +        calls pcond to perform the actual conversion, which takes
315 +        longer but gives access to all the TM_F_* features.
316 +        Memory for the final pixel array is allocated using malloc(3),
317 +        and should be freed with free(3) when it is no longer needed.
318 +
319 +        psp     -       returned array of tone mapped pixels, picture ordering.
320 +        xp, yp  -       returned picture dimensions.
321 +        flags   -       TM_F_* flags indicating what is to be done.
322 +        monpri  -       display monitor primaries (Note 1).
323 +        gamval  -       display gamma response.
324 +        Lddyn   -       the display's dynamic range (0. for default).
325 +        Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
326 +        fname   -       picture file name.
327 +        fp      -       pointer to open file (Note 3).
328 +
329 +        returns -       0 on success, TM_E_* on failure.
330 + */
331 +
332 +
333 +
334   /****    Notes    ****/
335   /*
336          General:
# Line 382 | Line 401 | tmDone(struct tmStruct *tms);
401          function will open the file, read its contents and close it
402          before returning, whether or not an error was encountered.
403   */
404 +
405 + #ifdef __cplusplus
406 + }
407 + #endif
408 + #endif /* _RAD_TONEMAP_H_ */
409 +

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines