ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/src/common/tonemap.h
(Generate patch)

Comparing src/common/tonemap.h (file contents):
Revision 3.5 by greg, Mon Apr 21 15:23:42 1997 UTC vs.
Revision 3.25 by greg, Wed Aug 18 15:25:03 2010 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        "tiff.h"        /* needed for int32, etc. */
11  
12 + #ifdef __cplusplus
13 + extern "C" {
14 + #endif
15 +
16   /****    Argument Macros    ****/
17 <                                /* Flags of what to do */
17 >                                /* flags of what to do */
18   #define TM_F_HCONTR     01              /* human contrast sensitivity */
19   #define TM_F_MESOPIC    02              /* mesopic color sensitivity */
20   #define TM_F_LINEAR     04              /* linear brightness mapping */
# 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 46 | Line 51
51  
52   /****    Conversion Constants and Table Sizes    ****/
53  
54 < #define TM_BRTSCALE     128             /* brightness scale factor (integer) */
54 > #define TM_BRTSCALE     256             /* 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 62 | Line 70 | extern char    *tmErrorMessage[];      /* error messages */
70   typedef short   TMbright;               /* encoded luminance type */
71  
72                                  /* basic tone mapping data structure */
73 < extern struct tmStruct {
73 > typedef struct {
74          int             flags;          /* flags of what to do */
75          RGBPRIMP        monpri;         /* monitor RGB primaries */
76          double          mongam;         /* monitor gamma value (approx.) */
# Line 70 | Line 78 | extern struct tmStruct {
78          int             cdiv[3];        /* computed color divisors */
79          RGBPRIMP        inppri;         /* current input primaries */
80          double          inpsf;          /* current input scalefactor */
81 +        MEM_PTR         inpdat;         /* current input client data */
82          COLORMAT        cmat;           /* color conversion matrix */
83 <        TMbright        brmin, brmax;   /* input brightness limits */  
83 >        TMbright        hbrmin, hbrmax; /* histogram brightness limits */      
84          int             *histo;         /* input histogram */
85 +        TMbright        mbrmin, mbrmax; /* mapped brightness limits */
86          unsigned short  *lumap;         /* computed luminance map */
77 –        struct tmStruct *tmprev;        /* previous tone mapping */
87          MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
88 < }       *tmTop;                 /* current tone mapping stack */
88 >        int             lastError;      /* last error incurred */
89 >        const char      *lastFunc;      /* error-generating function name */
90 > } TMstruct;
91  
92                                  /* conversion package functions */
82 – #ifdef  NOPROTO
93   struct tmPackage {
94 <        MEM_PTR         (*Init)();      /* initialize private data */
95 <        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);
94 >        MEM_PTR         (*Init)(TMstruct *tms);
95 >        void            (*NewSpace)(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  
121 < #ifdef  NOPROTO
121 > extern TMbright
122 > tmCvLuminance(double lum);
123 > /*
124 >        Convert a single luminance value to an encoded brightness value.
125 > */
126  
127 < extern struct tmStruct  *tmInit(), *tmPop(), *tmDup();
128 < extern void     tmClearHisto(), tmDone();
129 < extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
130 < extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
124 < extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
127 > extern int
128 > tmCvLums(TMbright *ls, float *scan, int len);
129 > /*
130 >        Convert luminance values to encoded brightness values using lookup.
131  
132 < #else
132 >        ls      -       returned encoded luminance values.
133 >        scan    -       input scanline.
134 >        len     -       scanline length.
135  
136 < extern struct tmStruct *
136 >        returns -       0 on success, TM_E_* on error.
137 > */
138 >
139 > extern TMstruct *
140   tmInit(int flags, RGBPRIMP monpri, double gamval);
141   /*
142 <        Initialize new tone mapping and push it onto stack.
142 >        Allocate and initialize new tone mapping.
143  
144          flags   -       TM_F_* flags indicating what is to be done.
145          monpri  -       display monitor primaries (Note 1).
146          gamval  -       display gamma response (can be approximate).
147  
148 <        returns -       new tmTop, or NULL if insufficient memory.
148 >        returns -       new tone-mapping pointer, or NULL if no memory.
149   */
150  
151   extern int
152 < tmSetSpace(RGBPRIMP pri, double sf);
152 > tmSetSpace(TMstruct *tms, RGBPRIMP pri, double sf, MEM_PTR dat);
153   /*
154          Set color primaries and scale factor for incoming scanlines.
155  
156 +        tms     -       tone mapping structure pointer.
157          pri     -       RGB color input primaries (Note 1).
158          sf      -       scale factor to get to luminance in cd/m^2.
159 +        dat     -       application-specific data (NULL if not needed)
160  
161          returns -       0 on success, TM_E_* code on failure.
162   */
163  
164   extern void
165 < tmClearHisto(void);
165 > tmClearHisto(TMstruct *tms);
166   /*
167          Clear histogram for current tone mapping.
155 – */
168  
169 < 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.
169 >        tms     -       tone mapping structure pointer.
170   */
171  
172   extern int
173 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
173 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
174   /*
175 <        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
175 >        Add brightness values to current histogram.
176  
177 <        ls      -       returned encoded luminance values.
178 <        cs      -       returned encoded chrominance values (Note 2).
179 <        scan    -       input scanline.
180 <        len     -       scanline length.
177 >        tms     -       tone mapping structure pointer.
178 >        ls      -       encoded luminance values.
179 >        len     -       number of luminance values.
180 >        wt      -       integer weight to use for each value (usually 1 or -1).
181  
182          returns -       0 on success, TM_E_* on error.
183   */
184  
185   extern int
186 < tmAddHisto(TMbright *ls, int len, int wt);
186 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
187   /*
188 <        Add brightness values to current histogram.
188 >        Assign a fixed, linear tone-mapping using the given multiplier,
189 >        which is the ratio of maximum output to uncalibrated input.
190 >        This mapping will be used in subsequent calls to tmMapPixels()
191 >        until a new tone mapping is computed.
192 >        Only the min. and max. values are used from the histogram.
193 >        
194 >        tms     -       tone mapping structure pointer.
195 >        expmult -       the fixed exposure multiplier to use.
196 >        gamval  -       display gamma response (0. for default).
197  
198 <        ls      -       encoded luminance values.
189 <        len     -       number of luminance values.
190 <        wt      -       integer weight to use for each value (usually 1 or -1).
191 <
192 <        returns -       0 on success, TM_E_* on error.
198 >        returns -       0 on success, TM_E_* on error.
199   */
200  
201   extern int
202 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
202 > tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
203   /*
204 <        Compute tone mapping function.
204 >        Compute tone mapping function from the current histogram.
205 >        This mapping will be used in subsequent calls to tmMapPixels()
206 >        until a new tone mapping is computed.
207 >        I.e., calls to tmAddHisto() have no immediate effect.
208  
209 +        tms     -       tone mapping structure pointer.
210          gamval  -       display gamma response (0. for default).
211          Lddyn   -       the display's dynamic range (0. for default).
212          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 205 | Line 215 | tmComputeMapping(double gamval, double Lddyn, double L
215   */
216  
217   extern int
218 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
218 > tmMapPixels(TMstruct *tms, BYTE *ps, TMbright *ls, BYTE *cs, int len);
219   /*
220          Apply tone mapping function to pixel values.
221  
222 +        tms     -       tone mapping structure pointer.
223          ps      -       returned pixel values (Note 2).
224          ls      -       encoded luminance values.
225          cs      -       encoded chrominance values (Note 2).
# Line 217 | Line 228 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
228          returns -       0 on success, TM_E_* on failure.
229   */
230  
231 + extern TMstruct *
232 + tmDup(TMstruct *orig);
233 + /*
234 +        Duplicate the given tone mapping into a new struct.
235 +
236 +        orig    -       tone mapping structure to duplicate.
237 +
238 +        returns -       pointer to new struct, or NULL on error.
239 + */
240 +
241 + extern void
242 + tmDone(TMstruct *tms);
243 + /*
244 +        Free data associated with the given tone mapping structure.
245 +
246 +        tms     -       tone mapping structure to free.
247 + */
248 +
249   extern int
250 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
250 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
251 > /*
252 >        Convert gray float scanline to encoded luminance.
253 >
254 >        tms     -       tone mapping structure pointer.
255 >        ls      -       returned encoded luminance values.
256 >        scan    -       input scanline.
257 >        len     -       scanline length.
258 >
259 >        returns -       0 on success, TM_E_* on error.
260 > */
261 >
262 > extern int
263 > tmCvColors(TMstruct *tms, TMbright *ls, BYTE *cs, COLOR *scan, int len);
264 > /*
265 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
266 >
267 >        tms     -       tone mapping structure pointer.
268 >        ls      -       returned encoded luminance values.
269 >        cs      -       returned encoded chrominance values (Note 2).
270 >        scan    -       input scanline.
271 >        len     -       scanline length.
272 >
273 >        returns -       0 on success, TM_E_* on error.
274 > */
275 >
276 > extern int
277 > tmCvColrs(TMstruct *tms, TMbright *ls, BYTE *cs, COLR *scan, int len);
278 > /*
279 >        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
280 >
281 >        tms     -       tone mapping structure pointer.
282 >        ls      -       returned encoded luminance values.
283 >        cs      -       returned encoded chrominance values (Note 2).
284 >        scan    -       input scanline.
285 >        len     -       scanline length.
286 >
287 >        returns -       0 on success, TM_E_* on error.
288 > */
289 >
290 > extern int
291 > tmLoadPicture(TMstruct *tms, TMbright **lpp, BYTE **cpp, int *xp, int *yp,
292                  char *fname, FILE *fp);
293   /*
294          Load Radiance picture and convert to tone mapping representation.
# Line 226 | Line 296 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
296          malloc(3), and should be freed with free(3) when no longer needed.
297          Calls tmSetSpace() to calibrate input color space.
298  
299 <        lpp     -       returned array of encoded luminances, English ordering.
299 >        tms     -       tone mapping structure pointer.
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 241 | Line 312 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
312                  char *fname, FILE *fp);
313   /*
314          Load and apply tone mapping to Radiance picture.
244 –        Stack is restored to its original state upon return.
315          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
316          calls pcond to perform the actual conversion, which takes
317          longer but gives access to all the TM_F_* features.
318          Memory for the final pixel array is allocated using malloc(3),
319          and should be freed with free(3) when it is no longer needed.
320  
321 <        psp     -       returned array of tone mapped pixels, English ordering.
321 >        psp     -       returned array of tone mapped pixels, picture ordering.
322          xp, yp  -       returned picture dimensions.
323          flags   -       TM_F_* flags indicating what is to be done.
324          monpri  -       display monitor primaries (Note 1).
# Line 261 | Line 331 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
331          returns -       0 on success, TM_E_* on failure.
332   */
333  
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 –
334   extern int
335 < tmPull(struct tmStruct *tms);
335 > tmCvRGB48(TMstruct *tms, TMbright *ls, BYTE *cs, uint16 (*scan)[3],
336 >                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 >        tms     -       tone mapping structure pointer.
341 >        ls      -       returned encoded luminance values.
342 >        cs      -       returned encoded chrominance values (Note 2).
343 >        scan    -       input scanline.
344 >        len     -       scanline length.
345 >        gv      -       input gamma value.
346  
347 <        returns -       1 if found in stack, 0 otherwise.
347 >        returns -       0 on success, TM_E_* on error.
348   */
349  
350   extern int
351 < tmPush(struct tmStruct *tms);
351 > tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
352   /*
353 <        Make tone mapping active by (pulling it and) pushing it to the top.
353 >        Convert 16-bit gray scanline to encoded luminance.
354  
355 <        tms     -       initialized tone mapping structure.
355 >        tms     -       tone mapping structure pointer.
356 >        ls      -       returned encoded luminance values.
357 >        scan    -       input scanline.
358 >        len     -       scanline length.
359 >        gv      -       input gamma value.
360  
361 <        returns -       0 on success, TM_E_* if tms is invalid.
361 >        returns -       0 on success, TM_E_* on error.
362   */
363  
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 –
364   /****    Notes    ****/
365   /*
366          General:
# Line 382 | Line 431 | tmDone(struct tmStruct *tms);
431          function will open the file, read its contents and close it
432          before returning, whether or not an error was encountered.
433   */
434 +
435 + #ifdef __cplusplus
436 + }
437 + #endif
438 + #endif /* _RAD_TONEMAP_H_ */
439 +

Diff Legend

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