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.8 by gwlarson, Mon Aug 17 17:58:47 1998 UTC vs.
Revision 3.21 by greg, Tue Nov 15 06:53:00 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 */
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 49 | 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 59 | Line 66
66   #endif
67  
68   extern char     *tmErrorMessage[];      /* error messages */
62 – extern int      tmLastError;            /* last error incurred by library */
63 – 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 {
74          int             flags;          /* flags of what to do */
75          RGBPRIMP        monpri;         /* monitor RGB primaries */
76          double          mongam;         /* monitor gamma value (approx.) */
# Line 73 | 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        hbrmin, hbrmax; /* histogram brightness limits */      
84          int             *histo;         /* input histogram */
85          TMbright        mbrmin, mbrmax; /* mapped brightness limits */
86          unsigned short  *lumap;         /* computed luminance map */
81 –        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 */
86 – #ifdef  NOPROTO
93   struct tmPackage {
94 <        MEM_PTR         (*Init)();      /* initialize private data */
95 <        void            (*NewSpace)();  /* new input color space (optional) */
90 <        void            (*Free)();      /* free private data */
91 < };
92 < #else
93 < struct tmPackage {
94 <        MEM_PTR         (*Init)(struct tmStruct *tms);
95 <        int             (*NewSpace)(struct tmStruct *tms);
94 >        MEM_PTR         (*Init)(TMstruct *tms);
95 >        void            (*NewSpace)(TMstruct *tms);
96          void            (*Free)(MEM_PTR pp);
97   };
98 – #endif
98                                  /* our list of conversion packages */
99   extern struct tmPackage *tmPkg[TM_MAXPKG];
100   extern int      tmNumPkgs;      /* number of registered packages */
# Line 104 | 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 119 | 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();
125 < extern void     tmClearHisto(), tmDone();
126 < extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
127 < extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
128 < extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
129 <
130 < #else
131 <
132 < extern struct tmStruct *
127 > extern TMstruct *
128   tmInit(int flags, RGBPRIMP monpri, double gamval);
129   /*
130 <        Initialize new tone mapping and push it onto stack.
130 >        Allocate and initialize new tone mapping.
131  
132          flags   -       TM_F_* flags indicating what is to be done.
133          monpri  -       display monitor primaries (Note 1).
134          gamval  -       display gamma response (can be approximate).
135  
136 <        returns -       new tmTop, or NULL if insufficient memory.
136 >        returns -       new tone-mapping pointer, or NULL if no memory.
137   */
138  
139   extern int
140 < tmSetSpace(RGBPRIMP pri, double sf);
140 > tmSetSpace(TMstruct *tms, RGBPRIMP pri, double sf, MEM_PTR dat);
141   /*
142          Set color primaries and scale factor for incoming scanlines.
143  
144 +        tms     -       tone mapping structure pointer.
145          pri     -       RGB color input primaries (Note 1).
146          sf      -       scale factor to get to luminance in cd/m^2.
147 +        dat     -       application-specific data (NULL if not needed)
148  
149          returns -       0 on success, TM_E_* code on failure.
150   */
151  
152   extern void
153 < tmClearHisto(void);
153 > tmClearHisto(TMstruct *tms);
154   /*
155          Clear histogram for current tone mapping.
159 – */
156  
157 < extern int
162 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
163 < /*
164 <        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
165 <
166 <        ls      -       returned encoded luminance values.
167 <        cs      -       returned encoded chrominance values (Note 2).
168 <        scan    -       input scanline.
169 <        len     -       scanline length.
170 <
171 <        returns -       0 on success, TM_E_* on error.
157 >        tms     -       tone mapping structure pointer.
158   */
159  
160   extern int
161 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
161 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
162   /*
163 <        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
163 >        Add brightness values to current histogram.
164  
165 <        ls      -       returned encoded luminance values.
166 <        cs      -       returned encoded chrominance values (Note 2).
167 <        scan    -       input scanline.
168 <        len     -       scanline length.
165 >        tms     -       tone mapping structure pointer.
166 >        ls      -       encoded luminance values.
167 >        len     -       number of luminance values.
168 >        wt      -       integer weight to use for each value (usually 1 or -1).
169  
170          returns -       0 on success, TM_E_* on error.
171   */
172  
173   extern int
174 < tmAddHisto(TMbright *ls, int len, int wt);
174 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
175   /*
176 <        Add brightness values to current histogram.
176 >        Assign a fixed, linear tone-mapping using the given multiplier,
177 >        which is the ratio of maximum output to uncalibrated input.
178 >        This mapping will be used in subsequent calls to tmMapPixels()
179 >        until a new tone mapping is computed.
180 >        Only the min. and max. values are used from the histogram.
181 >        
182 >        tms     -       tone mapping structure pointer.
183 >        expmult -       the fixed exposure multiplier to use.
184 >        gamval  -       display gamma response (0. for default).
185  
186 <        ls      -       encoded luminance values.
193 <        len     -       number of luminance values.
194 <        wt      -       integer weight to use for each value (usually 1 or -1).
195 <
196 <        returns -       0 on success, TM_E_* on error.
186 >        returns -       0 on success, TM_E_* on error.
187   */
188  
189   extern int
190 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
190 > tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
191   /*
192 <        Compute tone mapping function.  This mapping will be used
193 <        in subsequent calls to tmMapPixels() until a new tone mapping
194 <        is computed.  I.e., calls to tmAddHisto() have no immediate effect.
192 >        Compute tone mapping function from the current histogram.
193 >        This mapping will be used in subsequent calls to tmMapPixels()
194 >        until a new tone mapping is computed.
195 >        I.e., calls to tmAddHisto() have no immediate effect.
196  
197 +        tms     -       tone mapping structure pointer.
198          gamval  -       display gamma response (0. for default).
199          Lddyn   -       the display's dynamic range (0. for default).
200          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 211 | Line 203 | tmComputeMapping(double gamval, double Lddyn, double L
203   */
204  
205   extern int
206 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
206 > tmMapPixels(TMstruct *tms, BYTE *ps, TMbright *ls, BYTE *cs, int len);
207   /*
208          Apply tone mapping function to pixel values.
209  
210 +        tms     -       tone mapping structure pointer.
211          ps      -       returned pixel values (Note 2).
212          ls      -       encoded luminance values.
213          cs      -       encoded chrominance values (Note 2).
# Line 223 | Line 216 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
216          returns -       0 on success, TM_E_* on failure.
217   */
218  
219 + extern TMstruct *
220 + tmDup(TMstruct *orig);
221 + /*
222 +        Duplicate the given tone mapping into a new struct.
223 +
224 +        orig    -       tone mapping structure to duplicate.
225 +
226 +        returns -       pointer to new struct, or NULL on error.
227 + */
228 +
229 + extern void
230 + tmDone(TMstruct *tms);
231 + /*
232 +        Free data associated with the given tone mapping structure.
233 +
234 +        tms     -       tone mapping structure to free.
235 + */
236 +
237   extern int
238 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
238 > tmCvColors(TMstruct *tms, TMbright *ls, BYTE *cs, COLOR *scan, int len);
239 > /*
240 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
241 >
242 >        tms     -       tone mapping structure pointer.
243 >        ls      -       returned encoded luminance values.
244 >        cs      -       returned encoded chrominance values (Note 2).
245 >        scan    -       input scanline.
246 >        len     -       scanline length.
247 >
248 >        returns -       0 on success, TM_E_* on error.
249 > */
250 >
251 > extern int
252 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
253 > /*
254 >        Convert gray float scanline to encoded luminance.
255 >
256 >        tms     -       tone mapping structure pointer.
257 >        ls      -       returned encoded luminance values.
258 >        scan    -       input scanline.
259 >        len     -       scanline length.
260 >
261 >        returns -       0 on success, TM_E_* on error.
262 > */
263 >
264 > extern int
265 > tmCvColrs(TMstruct *tms, TMbright *ls, BYTE *cs, COLR *scan, int len);
266 > /*
267 >        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
268 >
269 >        tms     -       tone mapping structure pointer.
270 >        ls      -       returned encoded luminance values.
271 >        cs      -       returned encoded chrominance values (Note 2).
272 >        scan    -       input scanline.
273 >        len     -       scanline length.
274 >
275 >        returns -       0 on success, TM_E_* on error.
276 > */
277 >
278 > extern int
279 > tmLoadPicture(TMstruct *tms, TMbright **lpp, BYTE **cpp, int *xp, int *yp,
280                  char *fname, FILE *fp);
281   /*
282          Load Radiance picture and convert to tone mapping representation.
# Line 232 | Line 284 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
284          malloc(3), and should be freed with free(3) when no longer needed.
285          Calls tmSetSpace() to calibrate input color space.
286  
287 <        lpp     -       returned array of encoded luminances, English ordering.
287 >        tms     -       tone mapping structure pointer.
288 >        lpp     -       returned array of encoded luminances, picture ordering.
289          cpp     -       returned array of encoded chrominances (Note 2).
290          xp, yp  -       returned picture dimensions.
291          fname   -       picture file name.
# Line 247 | Line 300 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
300                  char *fname, FILE *fp);
301   /*
302          Load and apply tone mapping to Radiance picture.
250 –        Stack is restored to its original state upon return.
303          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
304          calls pcond to perform the actual conversion, which takes
305          longer but gives access to all the TM_F_* features.
306          Memory for the final pixel array is allocated using malloc(3),
307          and should be freed with free(3) when it is no longer needed.
308  
309 <        psp     -       returned array of tone mapped pixels, English ordering.
309 >        psp     -       returned array of tone mapped pixels, picture ordering.
310          xp, yp  -       returned picture dimensions.
311          flags   -       TM_F_* flags indicating what is to be done.
312          monpri  -       display monitor primaries (Note 1).
# Line 267 | Line 319 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
319          returns -       0 on success, TM_E_* on failure.
320   */
321  
270 – extern struct tmStruct *
271 – tmPop(void);
272 – /*
273 –        Pops current tone mapping from stack.
274 –
275 –        returns -       pointer to tone mapping structure, or NULL if none.
276 – */
277 –
322   extern int
323 < tmPull(struct tmStruct *tms);
323 > tmCvRGB48(TMstruct *tms, TMbright *ls, BYTE *cs, uint16 (*scan)[3],
324 >                int len, double gv);
325   /*
326 <        Pull tone mapping from anywhere in stack.
326 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
327  
328 <        tms     -       tone mapping structure to find.
328 >        tms     -       tone mapping structure pointer.
329 >        ls      -       returned encoded luminance values.
330 >        cs      -       returned encoded chrominance values (Note 2).
331 >        scan    -       input scanline.
332 >        len     -       scanline length.
333 >        gv      -       input gamma value.
334  
335 <        returns -       1 if found in stack, 0 otherwise.
335 >        returns -       0 on success, TM_E_* on error.
336   */
337  
338   extern int
339 < tmPush(struct tmStruct *tms);
339 > tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
340   /*
341 <        Make tone mapping active by (pulling it and) pushing it to the top.
341 >        Convert 16-bit gray scanline to encoded luminance.
342  
343 <        tms     -       initialized tone mapping structure.
343 >        tms     -       tone mapping structure pointer.
344 >        ls      -       returned encoded luminance values.
345 >        scan    -       input scanline.
346 >        len     -       scanline length.
347 >        gv      -       input gamma value.
348  
349 <        returns -       0 on success, TM_E_* if tms is invalid.
349 >        returns -       0 on success, TM_E_* on error.
350   */
351  
298 – extern struct tmStruct *
299 – tmDup(void);
300 – /*
301 –        Duplicate the current tone mapping into a new structure on the stack.
302 –
303 –        returns -       pointer to new top, or NULL on error.
304 – */
305 –
306 – extern void
307 – tmDone(struct tmStruct *tms);
308 – /*
309 –        Free data associated with the given tone mapping structure.
310 –        Calls tmPull() first to remove it from the stack if present.
311 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
312 –        all have the same effect, which is to remove and free
313 –        the current tone mapping.
314 –
315 –        tms     -       tone mapping structure to free.
316 – */
317 –
318 – #endif
319 –
320 –
352   /****    Notes    ****/
353   /*
354          General:
# Line 388 | Line 419 | tmDone(struct tmStruct *tms);
419          function will open the file, read its contents and close it
420          before returning, whether or not an error was encountered.
421   */
422 +
423 + #ifdef __cplusplus
424 + }
425 + #endif
426 + #endif /* _RAD_TONEMAP_H_ */
427 +

Diff Legend

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