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.4 by greg, Fri Apr 18 13:59:48 1997 UTC vs.
Revision 3.16 by schorsch, Mon Jul 14 22:23:59 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  
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 32 | Line 36
36   #define TM_NOCHROMP     (BYTE **)NULL   /* indicate no chrominances */
37   #define TM_GETFILE      (FILE *)NULL    /* indicate file must be opened */
38  
39 +
40   /****    Error Return Values    ****/
41  
42   #define TM_E_OK         0               /* normal return status */
# Line 48 | 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 58 | Line 66
66   #endif
67  
68   extern char     *tmErrorMessage[];      /* error messages */
69 + extern int      tmLastError;            /* last error incurred by library */
70 + extern char     *tmLastFunction;        /* error-generating function name */
71  
72   typedef short   TMbright;               /* encoded luminance type */
73  
# Line 71 | Line 81 | extern struct tmStruct {
81          RGBPRIMP        inppri;         /* current input primaries */
82          double          inpsf;          /* current input scalefactor */
83          COLORMAT        cmat;           /* color conversion matrix */
84 <        TMbright        brmin, brmax;   /* input brightness limits */  
84 >        TMbright        hbrmin, hbrmax; /* histogram brightness limits */      
85          int             *histo;         /* input histogram */
86 +        TMbright        mbrmin, mbrmax; /* mapped brightness limits */
87          unsigned short  *lumap;         /* computed luminance map */
88          struct tmStruct *tmprev;        /* previous tone mapping */
89          MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
90   }       *tmTop;                 /* current tone mapping stack */
91  
92                                  /* conversion package functions */
82 #ifdef  NOPROTO
93   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 {
94          MEM_PTR         (*Init)(struct tmStruct *tms);
95 <        int             (*NewSpace)(struct tmStruct *tms);
95 >        void            (*NewSpace)(struct tmStruct *tms);
96          void            (*Free)(MEM_PTR pp);
97   };
94 #endif
98                                  /* our list of conversion packages */
99   extern struct tmPackage *tmPkg[TM_MAXPKG];
100   extern int      tmNumPkgs;      /* number of registered packages */
# Line 100 | 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 115 | Line 118 | extern int     tmNumPkgs;      /* number of registered packages
118  
119   /****    Library Function Calls    ****/
120  
118 #ifdef  NOPROTO
121  
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
122   extern struct tmStruct *
123   tmInit(int flags, RGBPRIMP monpri, double gamval);
124   /*
# Line 155 | Line 149 | tmClearHisto(void);
149   */
150  
151   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
152   tmAddHisto(TMbright *ls, int len, int wt);
153   /*
154          Add brightness values to current histogram.
# Line 193 | Line 161 | tmAddHisto(TMbright *ls, int len, int wt);
161   */
162  
163   extern int
164 + tmFixedMapping(double expmult, double gamval);
165 + /*
166 +        Assign a fixed, linear tone-mapping using the given multiplier,
167 +        which is the ratio of maximum output to uncalibrated input.
168 +        This mapping will be used in subsequent calls to tmMapPixels()
169 +        until a new tone mapping is computed.
170 +        Only the min. and max. values are used from the histogram.
171 +        
172 +        expmult -       the fixed exposure multiplier to use.
173 +        gamval  -       display gamma response (0. for default).
174 +        returns -       0 on success, TM_E_* on error.
175 + */
176 +
177 + extern int
178   tmComputeMapping(double gamval, double Lddyn, double Ldmax);
179   /*
180 <        Compute tone mapping function.
180 >        Compute tone mapping function from the current histogram.
181 >        This mapping will be used in subsequent calls to tmMapPixels()
182 >        until a new tone mapping is computed.
183 >        I.e., calls to tmAddHisto() have no immediate effect.
184  
185          gamval  -       display gamma response (0. for default).
186          Lddyn   -       the display's dynamic range (0. for default).
# Line 217 | Line 202 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
202          returns -       0 on success, TM_E_* on failure.
203   */
204  
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        Calls tmSetSpace() to calibrate input color space.
226
227        lpp     -       returned array of encoded luminances, English ordering.
228        cpp     -       returned array of encoded chrominances (Note 2).
229        xp, yp  -       returned picture dimensions.
230        fname   -       picture file name.
231        fp      -       pointer to open file (Note 3).
232
233        returns -       0 on success, TM_E_* on failure.
234 */
235
236 extern int
237 tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
238                RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax,
239                char *fname, FILE *fp);
240 /*
241        Load and apply tone mapping to Radiance picture.
242        Stack is restored to its original state upon return.
243        If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
244        calls pcond to perform the actual conversion, which takes
245        longer but gives access to all the TM_F_* features.
246
247        psp     -       returned array of tone mapped pixels, English ordering.
248        xp, yp  -       returned picture dimensions.
249        flags   -       TM_F_* flags indicating what is to be done.
250        monpri  -       display monitor primaries (Note 1).
251        gamval  -       display gamma response.
252        Lddyn   -       the display's dynamic range (0. for default).
253        Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
254        fname   -       picture file name.
255        fp      -       pointer to open file (Note 3).
256
257        returns -       0 on success, TM_E_* on failure.
258 */
259
205   extern struct tmStruct *
206   tmPop(void);
207   /*
# Line 305 | Line 250 | tmDone(struct tmStruct *tms);
250          tms     -       tone mapping structure to free.
251   */
252  
253 < #endif
253 > extern int
254 > tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
255 > /*
256 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
257  
258 +        ls      -       returned encoded luminance values.
259 +        cs      -       returned encoded chrominance values (Note 2).
260 +        scan    -       input scanline.
261 +        len     -       scanline length.
262  
263 +        returns -       0 on success, TM_E_* on error.
264 + */
265 +
266 + extern int
267 + tmCvGrays(TMbright *ls, float *scan, int len);
268 + /*
269 +        Convert gray float scanline to encoded luminance.
270 +
271 +        ls      -       returned encoded luminance values.
272 +        scan    -       input scanline.
273 +        len     -       scanline length.
274 +
275 +        returns -       0 on success, TM_E_* on error.
276 + */
277 +
278 + extern int
279 + tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
280 + /*
281 +        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
282 +
283 +        ls      -       returned encoded luminance values.
284 +        cs      -       returned encoded chrominance values (Note 2).
285 +        scan    -       input scanline.
286 +        len     -       scanline length.
287 +
288 +        returns -       0 on success, TM_E_* on error.
289 + */
290 +
291 + extern int
292 + tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
293 +                char *fname, FILE *fp);
294 + /*
295 +        Load Radiance picture and convert to tone mapping representation.
296 +        Memory for the luminance and chroma arrays is allocated using
297 +        malloc(3), and should be freed with free(3) when no longer needed.
298 +        Calls tmSetSpace() to calibrate input color space.
299 +
300 +        lpp     -       returned array of encoded luminances, picture ordering.
301 +        cpp     -       returned array of encoded chrominances (Note 2).
302 +        xp, yp  -       returned picture dimensions.
303 +        fname   -       picture file name.
304 +        fp      -       pointer to open file (Note 3).
305 +
306 +        returns -       0 on success, TM_E_* on failure.
307 + */
308 +
309 + extern int
310 + tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
311 +                RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax,
312 +                char *fname, FILE *fp);
313 + /*
314 +        Load and apply tone mapping to Radiance picture.
315 +        Stack is restored to its original state upon return.
316 +        If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
317 +        calls pcond to perform the actual conversion, which takes
318 +        longer but gives access to all the TM_F_* features.
319 +        Memory for the final pixel array is allocated using malloc(3),
320 +        and should be freed with free(3) when it is no longer needed.
321 +
322 +        psp     -       returned array of tone mapped pixels, picture ordering.
323 +        xp, yp  -       returned picture dimensions.
324 +        flags   -       TM_F_* flags indicating what is to be done.
325 +        monpri  -       display monitor primaries (Note 1).
326 +        gamval  -       display gamma response.
327 +        Lddyn   -       the display's dynamic range (0. for default).
328 +        Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
329 +        fname   -       picture file name.
330 +        fp      -       pointer to open file (Note 3).
331 +
332 +        returns -       0 on success, TM_E_* on failure.
333 + */
334 +
335 + extern int
336 + tmCvRGB48(TMbright *ls, BYTE *cs, uint16 (*scan)[3], int len, double gv);
337 + /*
338 +        Convert 48-bit RGB scanline to encoded luminance and chrominance.
339 +
340 +        ls      -       returned encoded luminance values.
341 +        cs      -       returned encoded chrominance values (Note 2).
342 +        scan    -       input scanline.
343 +        len     -       scanline length.
344 +        gv      -       input gamma value.
345 +
346 +        returns -       0 on success, TM_E_* on error.
347 + */
348 +
349 + extern int
350 + tmCvGray16(TMbright *ls, uint16 *scan, int len, double gv);
351 + /*
352 +        Convert 16-bit gray scanline to encoded luminance.
353 +
354 +        ls      -       returned encoded luminance values.
355 +        scan    -       input scanline.
356 +        len     -       scanline length.
357 +        gv      -       input gamma value.
358 +
359 +        returns -       0 on success, TM_E_* on error.
360 + */
361 +
362   /****    Notes    ****/
363   /*
364          General:
# Line 316 | Line 367 | tmDone(struct tmStruct *tms);
367          pixel values to chroma and luminance encodings, which can
368          be passed to tmAddHisto() to put into the tone mapping histogram.
369          This histogram is then used along with the display parameters
370 <        by tmComputMapping() to compute the luminance mapping function.
370 >        by tmComputeMapping() to compute the luminance mapping function.
371          (Colors are tone-mapped as they are converted if TM_F_MESOPIC
372          is set.)  The encoded chroma and luminance values may then be
373          passed to tmMapPixels() to apply the computed tone mapping in
# Line 378 | Line 429 | tmDone(struct tmStruct *tms);
429          function will open the file, read its contents and close it
430          before returning, whether or not an error was encountered.
431   */
432 +
433 + #ifdef __cplusplus
434 + }
435 + #endif
436 + #endif /* _RAD_TONEMAP_H_ */
437 +

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines