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.2 by greg, Tue Apr 15 20:04:41 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 31 | 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 39 | Line 45
45   #define TM_E_TMINVAL    3               /* no valid tone mapping */
46   #define TM_E_TMFAIL     4               /* cannot compute tone mapping */
47   #define TM_E_BADFILE    5               /* cannot open or understand file */
48 + #define TM_E_CODERR1    6               /* code consistency error 1 */
49 + #define TM_E_CODERR2    7               /* code consistency error 2 */
50  
51 +
52   /****    Conversion Constants and Table Sizes    ****/
53  
54   #define TM_BRTSCALE     128             /* brightness scale factor (integer) */
55  
56 < #define TM_GAMTSZ       1024            /* gamma lookup table size */
56 > #define TM_NOBRT        (-1<<15)        /* bogus brightness value */
57 > #define TM_NOLUM        (1e-17)         /* ridiculously small luminance */
58  
59 < /****    Global Data Structures    ****/
59 > #define TM_MAXPKG       8               /* maximum number of color formats */
60  
61 +
62 + /****    Global Data Types and Structures    ****/
63 +
64 + #ifndef MEM_PTR
65 + #define MEM_PTR         void *
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 57 | Line 76 | extern struct tmStruct {
76          int             flags;          /* flags of what to do */
77          RGBPRIMP        monpri;         /* monitor RGB primaries */
78          double          mongam;         /* monitor gamma value (approx.) */
60 –        BYTE            gamb[TM_GAMTSZ];/* gamma lookup table from mongam */
79          COLOR           clf;            /* computed luminance coefficients */
80 <        COLR            clfb;           /* normalized version of clf */
80 >        int             cdiv[3];        /* computed color divisors */
81          RGBPRIMP        inppri;         /* current input primaries */
82          double          inpsf;          /* current input scalefactor */
65 –        TMbright        inpsfb;         /* encoded version of inpsf */
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 <
91 >
92 >                                /* conversion package functions */
93 > struct tmPackage {
94 >        MEM_PTR         (*Init)(struct tmStruct *tms);
95 >        void            (*NewSpace)(struct tmStruct *tms);
96 >        void            (*Free)(MEM_PTR pp);
97 > };
98 >                                /* our list of conversion packages */
99 > extern struct tmPackage *tmPkg[TM_MAXPKG];
100 > extern int      tmNumPkgs;      /* number of registered packages */
101 >
102 >
103   /****    Useful Macros    ****/
104  
105 < #define tmLuminance(li) exp((li)/(double)TM_BRTSCALE)
105 >                                /* compute luminance from encoded value */
106 > #define tmLuminance(li) exp((li)*(1./TM_BRTSCALE))
107  
108 < /****    Library Function Calls    ****/
108 >                                /* does tone mapping need color matrix? */
109 > #define tmNeedMatrix(t) ((t)->monpri != (t)->inppri)
110  
111 < #ifdef NOPROTO
111 >                                /* register a conversion package */
112 > #define tmRegPkg(pf)    ( tmNumPkgs >= TM_MAXPKG ? -1 : \
113 >                                (tmPkg[tmNumPkgs] = (pf), tmNumPkgs++) )
114  
115 < extern struct tmStruct  *tmInit(), *tmPop();
116 < extern void     tmClearHisto(), tmDone();
83 < extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
84 < extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
85 < extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
115 >                                /* get the specific package's data */
116 > #define tmPkgData(t,i)  ((t)->pd[i]!=NULL ? (t)->pd[i] : (*tmPkg[i]->Init)(t))
117  
87 – #else
118  
119 + /****    Library Function Calls    ****/
120 +
121 +
122   extern struct tmStruct *
123   tmInit(int flags, RGBPRIMP monpri, double gamval);
124   /*
# Line 116 | Line 149 | tmClearHisto(void);
149   */
150  
151   extern int
119 – tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
120 – /*
121 –        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
122 –
123 –        ls      -       returned encoded luminance values.
124 –        cs      -       returned encoded chrominance values (Note 2).
125 –        scan    -       input scanline.
126 –        len     -       scanline length.
127 –
128 –        returns -       0 on success, TM_E_* on error.
129 – */
130 –
131 – extern int
132 – tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
133 – /*
134 –        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
135 –
136 –        ls      -       returned encoded luminance values.
137 –        cs      -       returned encoded chrominance values (Note 2).
138 –        scan    -       input scanline.
139 –        len     -       scanline length.
140 –
141 –        returns -       0 on success, TM_E_* on error.
142 – */
143 –
144 – extern int
152   tmAddHisto(TMbright *ls, int len, int wt);
153   /*
154          Add brightness values to current histogram.
# Line 154 | 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 178 | Line 202 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
202          returns -       0 on success, TM_E_* on failure.
203   */
204  
205 + extern struct tmStruct *
206 + tmPop(void);
207 + /*
208 +        Pops current tone mapping from stack.
209 +
210 +        returns -       pointer to tone mapping structure, or NULL if none.
211 + */
212 +
213   extern int
214 + tmPull(struct tmStruct *tms);
215 + /*
216 +        Pull tone mapping from anywhere in stack.
217 +
218 +        tms     -       tone mapping structure to find.
219 +
220 +        returns -       1 if found in stack, 0 otherwise.
221 + */
222 +
223 + extern int
224 + tmPush(struct tmStruct *tms);
225 + /*
226 +        Make tone mapping active by (pulling it and) pushing it to the top.
227 +
228 +        tms     -       initialized tone mapping structure.
229 +
230 +        returns -       0 on success, TM_E_* if tms is invalid.
231 + */
232 +
233 + extern struct tmStruct *
234 + tmDup(void);
235 + /*
236 +        Duplicate the current tone mapping into a new structure on the stack.
237 +
238 +        returns -       pointer to new top, or NULL on error.
239 + */
240 +
241 + extern void
242 + tmDone(struct tmStruct *tms);
243 + /*
244 +        Free data associated with the given tone mapping structure.
245 +        Calls tmPull() first to remove it from the stack if present.
246 +        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
247 +        all have the same effect, which is to remove and free
248 +        the current tone mapping.
249 +
250 +        tms     -       tone mapping structure to free.
251 + */
252 +
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, English ordering.
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.
# Line 203 | Line 316 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
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, English ordering.
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).
# Line 217 | Line 332 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
332          returns -       0 on success, TM_E_* on failure.
333   */
334  
220 – extern struct tmStruct *
221 – tmPop(void);
222 – /*
223 –        Pops current tone mapping from stack.
224 –
225 –        returns -       pointer to tone mapping structure, or NULL if none.
226 – */
227 –
335   extern int
336 < tmPull(struct tmStruct *tms);
336 > tmCvRGB48(TMbright *ls, BYTE *cs, uint16 (*scan)[3], int len, double gv);
337   /*
338 <        Pull tone mapping from anywhere in stack.
338 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
339  
340 <        tms     -       tone mapping structure to find.
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 -       1 if found in stack, 0 otherwise.
346 >        returns -       0 on success, TM_E_* on error.
347   */
348  
349   extern int
350 < tmPush(struct tmStruct *tms);
350 > tmCvGray16(TMbright *ls, uint16 *scan, int len, double gv);
351   /*
352 <        Make tone mapping active by (pulling it and) pushing it to the top.
352 >        Convert 16-bit gray scanline to encoded luminance.
353  
354 <        tms     -       initialized tone mapping structure.
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_* if tms is invalid.
359 >        returns -       0 on success, TM_E_* on error.
360   */
361  
248 – extern void
249 – tmDone(struct tmStruct *tms);
250 – /*
251 –        Free data associated with the given tone mapping structure.
252 –        Calls tmPull() first to remove it from the stack if present.
253 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
254 –        all have the same effect, which is to remove and free
255 –        the current tone mapping.
256 –
257 –        tms     -       tone mapping structure to free.
258 – */
259 –
260 – #endif
261 –
362   /****    Notes    ****/
363   /*
364          General:
# Line 267 | 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 280 | Line 380 | tmDone(struct tmStruct *tms);
380          used during final mapping, setting the cs parameter to TM_NOCHROM
381          on the first pass will save time.)  Another memory saving option
382          if third and subsequent passes are not needed is to use the
383 <        same array to store the mapped pixels as is used to store
383 >        same array to store the mapped pixels as used to store
384          the encoded chroma values.  This way, only two extra bytes
385          for storing encoded luminances are required per pixel.  This
386          is the method employed by tmMapPicture(), for example.
# Line 329 | 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