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.17 by greg, Fri Jan 7 20:33:02 2005 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  
74                                  /* basic tone mapping data structure */
75 < extern struct tmStruct {
75 > typedef struct tmStruct {
76          int             flags;          /* flags of what to do */
77          RGBPRIMP        monpri;         /* monitor RGB primaries */
78          double          mongam;         /* monitor gamma value (approx.) */
# 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 */
77 –        struct tmStruct *tmprev;        /* previous tone mapping */
88          MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
89 < }       *tmTop;                 /* current tone mapping stack */
89 > } TMstruct;
90  
91                                  /* conversion package functions */
82 – #ifdef  NOPROTO
92   struct tmPackage {
93 <        MEM_PTR         (*Init)();      /* initialize private data */
94 <        void            (*NewSpace)();  /* new input color space (optional) */
86 <        void            (*Free)();      /* free private data */
87 < };
88 < #else
89 < struct tmPackage {
90 <        MEM_PTR         (*Init)(struct tmStruct *tms);
91 <        int             (*NewSpace)(struct tmStruct *tms);
93 >        MEM_PTR         (*Init)(TMstruct *tms);
94 >        void            (*NewSpace)(TMstruct *tms);
95          void            (*Free)(MEM_PTR pp);
96   };
94 – #endif
97                                  /* our list of conversion packages */
98   extern struct tmPackage *tmPkg[TM_MAXPKG];
99   extern int      tmNumPkgs;      /* number of registered packages */
# Line 100 | 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 115 | Line 117 | extern int     tmNumPkgs;      /* number of registered packages
117  
118   /****    Library Function Calls    ****/
119  
118 – #ifdef  NOPROTO
120  
121 < 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 <
128 < 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 149 | 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.
155 – */
149  
150 < 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.
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   /*
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
184 – tmAddHisto(TMbright *ls, int len, int wt);
185 – /*
156          Add brightness values to current histogram.
157  
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).
# Line 193 | Line 164 | tmAddHisto(TMbright *ls, int len, int wt);
164   */
165  
166   extern int
167 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
167 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
168   /*
169 <        Compute tone mapping function.
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 >        returns -       0 on success, TM_E_* on error.
179 > */
180  
181 + extern int
182 + tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
183 + /*
184 +        Compute tone mapping function from the current histogram.
185 +        This mapping will be used in subsequent calls to tmMapPixels()
186 +        until a new tone mapping is computed.
187 +        I.e., calls to tmAddHisto() have no immediate effect.
188 +
189 +        tms     -       tone mapping structure pointer.
190          gamval  -       display gamma response (0. for default).
191          Lddyn   -       the display's dynamic range (0. for default).
192          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 205 | Line 195 | tmComputeMapping(double gamval, double Lddyn, double L
195   */
196  
197   extern int
198 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
198 > tmMapPixels(TMstruct *tms, BYTE *ps, TMbright *ls, BYTE *cs, int len);
199   /*
200          Apply tone mapping function to pixel values.
201  
202 +        tms     -       tone mapping structure pointer.
203          ps      -       returned pixel values (Note 2).
204          ls      -       encoded luminance values.
205          cs      -       encoded chrominance values (Note 2).
# Line 217 | Line 208 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
208          returns -       0 on success, TM_E_* on failure.
209   */
210  
211 + extern TMstruct *
212 + tmDup(TMstruct *orig);
213 + /*
214 +        Duplicate the given tone mapping into a new struct.
215 +
216 +        orig    -       tone mapping structure to duplicate.
217 +        returns -       pointer to new struct, or NULL on error.
218 + */
219 +
220 + extern void
221 + tmDone(TMstruct *tms);
222 + /*
223 +        Free data associated with the given tone mapping structure.
224 +
225 +        tms     -       tone mapping structure to free.
226 + */
227 +
228   extern int
229 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
229 > tmCvColors(TMstruct *tms, TMbright *ls, BYTE *cs, COLOR *scan, int len);
230 > /*
231 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
232 >
233 >        tms     -       tone mapping structure pointer.
234 >        ls      -       returned encoded luminance values.
235 >        cs      -       returned encoded chrominance values (Note 2).
236 >        scan    -       input scanline.
237 >        len     -       scanline length.
238 >
239 >        returns -       0 on success, TM_E_* on error.
240 > */
241 >
242 > extern int
243 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
244 > /*
245 >        Convert gray float scanline to encoded luminance.
246 >
247 >        tms     -       tone mapping structure pointer.
248 >        ls      -       returned encoded luminance values.
249 >        scan    -       input scanline.
250 >        len     -       scanline length.
251 >
252 >        returns -       0 on success, TM_E_* on error.
253 > */
254 >
255 > extern int
256 > tmCvColrs(TMstruct *tms, TMbright *ls, BYTE *cs, COLR *scan, int len);
257 > /*
258 >        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
259 >
260 >        tms     -       tone mapping structure pointer.
261 >        ls      -       returned encoded luminance values.
262 >        cs      -       returned encoded chrominance values (Note 2).
263 >        scan    -       input scanline.
264 >        len     -       scanline length.
265 >
266 >        returns -       0 on success, TM_E_* on error.
267 > */
268 >
269 > extern int
270 > tmLoadPicture(TMstruct *tms, TMbright **lpp, BYTE **cpp, int *xp, int *yp,
271                  char *fname, FILE *fp);
272   /*
273          Load Radiance picture and convert to tone mapping representation.
# Line 226 | Line 275 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
275          malloc(3), and should be freed with free(3) when no longer needed.
276          Calls tmSetSpace() to calibrate input color space.
277  
278 <        lpp     -       returned array of encoded luminances, English ordering.
278 >        tms     -       tone mapping structure pointer.
279 >        lpp     -       returned array of encoded luminances, picture ordering.
280          cpp     -       returned array of encoded chrominances (Note 2).
281          xp, yp  -       returned picture dimensions.
282          fname   -       picture file name.
# Line 241 | Line 291 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
291                  char *fname, FILE *fp);
292   /*
293          Load and apply tone mapping to Radiance picture.
244 –        Stack is restored to its original state upon return.
294          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
295          calls pcond to perform the actual conversion, which takes
296          longer but gives access to all the TM_F_* features.
297          Memory for the final pixel array is allocated using malloc(3),
298          and should be freed with free(3) when it is no longer needed.
299  
300 <        psp     -       returned array of tone mapped pixels, English ordering.
300 >        psp     -       returned array of tone mapped pixels, picture ordering.
301          xp, yp  -       returned picture dimensions.
302          flags   -       TM_F_* flags indicating what is to be done.
303          monpri  -       display monitor primaries (Note 1).
# Line 261 | Line 310 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
310          returns -       0 on success, TM_E_* on failure.
311   */
312  
264 – extern struct tmStruct *
265 – tmPop(void);
266 – /*
267 –        Pops current tone mapping from stack.
268 –
269 –        returns -       pointer to tone mapping structure, or NULL if none.
270 – */
271 –
313   extern int
314 < tmPull(struct tmStruct *tms);
314 > tmCvRGB48(TMstruct *tms, TMbright *ls, BYTE *cs, uint16 (*scan)[3],
315 >                int len, double gv);
316   /*
317 <        Pull tone mapping from anywhere in stack.
317 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
318  
319 <        tms     -       tone mapping structure to find.
319 >        tms     -       tone mapping structure pointer.
320 >        ls      -       returned encoded luminance values.
321 >        cs      -       returned encoded chrominance values (Note 2).
322 >        scan    -       input scanline.
323 >        len     -       scanline length.
324 >        gv      -       input gamma value.
325  
326 <        returns -       1 if found in stack, 0 otherwise.
326 >        returns -       0 on success, TM_E_* on error.
327   */
328  
329   extern int
330 < tmPush(struct tmStruct *tms);
330 > tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
331   /*
332 <        Make tone mapping active by (pulling it and) pushing it to the top.
332 >        Convert 16-bit gray scanline to encoded luminance.
333  
334 <        tms     -       initialized tone mapping structure.
334 >        tms     -       tone mapping structure pointer.
335 >        ls      -       returned encoded luminance values.
336 >        scan    -       input scanline.
337 >        len     -       scanline length.
338 >        gv      -       input gamma value.
339  
340 <        returns -       0 on success, TM_E_* if tms is invalid.
340 >        returns -       0 on success, TM_E_* on error.
341   */
342  
292 – extern struct tmStruct *
293 – tmDup(void);
294 – /*
295 –        Duplicate the current tone mapping into a new structure on the stack.
296 –
297 –        returns -       pointer to new top, or NULL on error.
298 – */
299 –
300 – extern void
301 – tmDone(struct tmStruct *tms);
302 – /*
303 –        Free data associated with the given tone mapping structure.
304 –        Calls tmPull() first to remove it from the stack if present.
305 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
306 –        all have the same effect, which is to remove and free
307 –        the current tone mapping.
308 –
309 –        tms     -       tone mapping structure to free.
310 – */
311 –
312 – #endif
313 –
314 –
343   /****    Notes    ****/
344   /*
345          General:
# Line 382 | Line 410 | tmDone(struct tmStruct *tms);
410          function will open the file, read its contents and close it
411          before returning, whether or not an error was encountered.
412   */
413 +
414 + #ifdef __cplusplus
415 + }
416 + #endif
417 + #endif /* _RAD_TONEMAP_H_ */
418 +

Diff Legend

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