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

Diff Legend

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