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.6 by gregl, Tue Jul 29 11:54:45 1997 UTC vs.
Revision 3.13 by schorsch, Fri Jun 6 16:38:47 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  
13  
14 + #include "copyright.h"
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 73 | 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 */
84 #ifdef  NOPROTO
93   struct tmPackage {
86        MEM_PTR         (*Init)();      /* initialize private data */
87        void            (*NewSpace)();  /* new input color space (optional) */
88        void            (*Free)();      /* free private data */
89 };
90 #else
91 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   };
96 #endif
98                                  /* our list of conversion packages */
99   extern struct tmPackage *tmPkg[TM_MAXPKG];
100   extern int      tmNumPkgs;      /* number of registered packages */
# Line 102 | 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 117 | Line 118 | extern int     tmNumPkgs;      /* number of registered packages
118  
119   /****    Library Function Calls    ****/
120  
120 #ifdef  NOPROTO
121  
122 extern struct tmStruct  *tmInit(), *tmPop(), *tmDup();
123 extern void     tmClearHisto(), tmDone();
124 extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
125 extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
126 extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
127
128 #else
129
122   extern struct tmStruct *
123   tmInit(int flags, RGBPRIMP monpri, double gamval);
124   /*
# Line 157 | Line 149 | tmClearHisto(void);
149   */
150  
151   extern int
160 tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
161 /*
162        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
163
164        ls      -       returned encoded luminance values.
165        cs      -       returned encoded chrominance values (Note 2).
166        scan    -       input scanline.
167        len     -       scanline length.
168
169        returns -       0 on success, TM_E_* on error.
170 */
171
172 extern int
173 tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
174 /*
175        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
176
177        ls      -       returned encoded luminance values.
178        cs      -       returned encoded chrominance values (Note 2).
179        scan    -       input scanline.
180        len     -       scanline length.
181
182        returns -       0 on success, TM_E_* on error.
183 */
184
185 extern int
152   tmAddHisto(TMbright *ls, int len, int wt);
153   /*
154          Add brightness values to current histogram.
# Line 195 | 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 219 | Line 202 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
202          returns -       0 on success, TM_E_* on failure.
203   */
204  
222 extern int
223 tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
224                char *fname, FILE *fp);
225 /*
226        Load Radiance picture and convert to tone mapping representation.
227        Memory for the luminance and chroma arrays is allocated using
228        malloc(3), and should be freed with free(3) when no longer needed.
229        Calls tmSetSpace() to calibrate input color space.
230
231        lpp     -       returned array of encoded luminances, English ordering.
232        cpp     -       returned array of encoded chrominances (Note 2).
233        xp, yp  -       returned picture dimensions.
234        fname   -       picture file name.
235        fp      -       pointer to open file (Note 3).
236
237        returns -       0 on success, TM_E_* on failure.
238 */
239
240 extern int
241 tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
242                RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax,
243                char *fname, FILE *fp);
244 /*
245        Load and apply tone mapping to Radiance picture.
246        Stack is restored to its original state upon return.
247        If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
248        calls pcond to perform the actual conversion, which takes
249        longer but gives access to all the TM_F_* features.
250        Memory for the final pixel array is allocated using malloc(3),
251        and should be freed with free(3) when it is no longer needed.
252
253        psp     -       returned array of tone mapped pixels, English ordering.
254        xp, yp  -       returned picture dimensions.
255        flags   -       TM_F_* flags indicating what is to be done.
256        monpri  -       display monitor primaries (Note 1).
257        gamval  -       display gamma response.
258        Lddyn   -       the display's dynamic range (0. for default).
259        Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
260        fname   -       picture file name.
261        fp      -       pointer to open file (Note 3).
262
263        returns -       0 on success, TM_E_* on failure.
264 */
265
205   extern struct tmStruct *
206   tmPop(void);
207   /*
# Line 311 | 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 +
336 +
337   /****    Notes    ****/
338   /*
339          General:
# Line 384 | Line 404 | tmDone(struct tmStruct *tms);
404          function will open the file, read its contents and close it
405          before returning, whether or not an error was encountered.
406   */
407 +
408 + #ifdef __cplusplus
409 + }
410 + #endif
411 + #endif /* _RAD_TONEMAP_H_ */
412 +

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines