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.7 by gregl, Mon Nov 17 13:54:35 1997 UTC vs.
Revision 3.27 by greg, Wed Jan 6 19:25:00 2021 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 28 | Line 32
32  
33                                  /* special pointer values */
34   #define TM_XYZPRIM      (RGBPRIMP)NULL  /* indicate XYZ primaries (Note 1) */
35 < #define TM_NOCHROM      (BYTE *)NULL    /* indicate no chrominance */
36 < #define TM_NOCHROMP     (BYTE **)NULL   /* indicate no chrominances */
35 > #define TM_NOCHROM      (uby8 *)NULL    /* indicate no chrominance */
36 > #define TM_NOCHROMP     (uby8 **)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        (~0x7fff)       /* 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 56 | Line 64
64   #ifndef MEM_PTR
65   #define MEM_PTR         void *
66   #endif
67 + #ifndef HIST_TYP
68 + #define HIST_TYP        unsigned long
69 + #endif
70 + #define TMAP_TYP        unsigned short
71  
72   extern char     *tmErrorMessage[];      /* error messages */
61 – extern int      tmLastError;            /* last error incurred by library */
62 – extern char     *tmLastFunction;        /* error-generating function name */
73  
74   typedef short   TMbright;               /* encoded luminance type */
75  
76                                  /* basic tone mapping data structure */
77 < extern struct tmStruct {
77 > typedef struct {
78          int             flags;          /* flags of what to do */
79          RGBPRIMP        monpri;         /* monitor RGB primaries */
80          double          mongam;         /* monitor gamma value (approx.) */
# Line 72 | Line 82 | extern struct tmStruct {
82          int             cdiv[3];        /* computed color divisors */
83          RGBPRIMP        inppri;         /* current input primaries */
84          double          inpsf;          /* current input scalefactor */
85 +        MEM_PTR         inpdat;         /* current input client data */
86          COLORMAT        cmat;           /* color conversion matrix */
87          TMbright        hbrmin, hbrmax; /* histogram brightness limits */      
88 <        int             *histo;         /* input histogram */
88 >        HIST_TYP        *histo;         /* input histogram */
89          TMbright        mbrmin, mbrmax; /* mapped brightness limits */
90 <        unsigned short  *lumap;         /* computed luminance map */
80 <        struct tmStruct *tmprev;        /* previous tone mapping */
90 >        TMAP_TYP        *lumap;         /* computed luminance map */
91          MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
92 < }       *tmTop;                 /* current tone mapping stack */
92 >        int             lastError;      /* last error incurred */
93 >        const char      *lastFunc;      /* error-generating function name */
94 > } TMstruct;
95  
96                                  /* conversion package functions */
85 – #ifdef  NOPROTO
97   struct tmPackage {
98 <        MEM_PTR         (*Init)();      /* initialize private data */
99 <        void            (*NewSpace)();  /* new input color space (optional) */
89 <        void            (*Free)();      /* free private data */
90 < };
91 < #else
92 < struct tmPackage {
93 <        MEM_PTR         (*Init)(struct tmStruct *tms);
94 <        int             (*NewSpace)(struct tmStruct *tms);
98 >        MEM_PTR         (*Init)(TMstruct *tms);
99 >        void            (*NewSpace)(TMstruct *tms);
100          void            (*Free)(MEM_PTR pp);
101   };
97 – #endif
102                                  /* our list of conversion packages */
103   extern struct tmPackage *tmPkg[TM_MAXPKG];
104   extern int      tmNumPkgs;      /* number of registered packages */
# Line 103 | Line 107 | extern int     tmNumPkgs;      /* number of registered packages
107   /****    Useful Macros    ****/
108  
109                                  /* compute luminance from encoded value */
110 < #define tmLuminance(li) exp((li)/(double)TM_BRTSCALE)
110 > #define tmLuminance(li) exp((li)*(1./TM_BRTSCALE))
111  
112                                  /* does tone mapping need color matrix? */
113   #define tmNeedMatrix(t) ((t)->monpri != (t)->inppri)
# Line 118 | Line 122 | extern int     tmNumPkgs;      /* number of registered packages
122  
123   /****    Library Function Calls    ****/
124  
125 < #ifdef  NOPROTO
125 > extern TMbright
126 > tmCvLuminance(double lum);
127 > /*
128 >        Convert a single luminance value to an encoded brightness value.
129 > */
130  
131 < extern struct tmStruct  *tmInit(), *tmPop(), *tmDup();
132 < extern void     tmClearHisto(), tmDone();
133 < extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
134 < extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
127 < extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
131 > extern int
132 > tmCvLums(TMbright *ls, float *scan, int len);
133 > /*
134 >        Convert luminance values to encoded brightness values using lookup.
135  
136 < #else
136 >        ls      -       returned encoded luminance values.
137 >        scan    -       input scanline.
138 >        len     -       scanline length.
139  
140 < extern struct tmStruct *
140 >        returns -       0 on success, TM_E_* on error.
141 > */
142 >
143 > extern TMstruct *
144   tmInit(int flags, RGBPRIMP monpri, double gamval);
145   /*
146 <        Initialize new tone mapping and push it onto stack.
146 >        Allocate and initialize new tone mapping.
147  
148          flags   -       TM_F_* flags indicating what is to be done.
149          monpri  -       display monitor primaries (Note 1).
150          gamval  -       display gamma response (can be approximate).
151  
152 <        returns -       new tmTop, or NULL if insufficient memory.
152 >        returns -       new tone-mapping pointer, or NULL if no memory.
153   */
154  
155   extern int
156 < tmSetSpace(RGBPRIMP pri, double sf);
156 > tmSetSpace(TMstruct *tms, RGBPRIMP pri, double sf, MEM_PTR dat);
157   /*
158          Set color primaries and scale factor for incoming scanlines.
159  
160 +        tms     -       tone mapping structure pointer.
161          pri     -       RGB color input primaries (Note 1).
162          sf      -       scale factor to get to luminance in cd/m^2.
163 +        dat     -       application-specific data (NULL if not needed)
164  
165          returns -       0 on success, TM_E_* code on failure.
166   */
167  
168   extern void
169 < tmClearHisto(void);
169 > tmClearHisto(TMstruct *tms);
170   /*
171          Clear histogram for current tone mapping.
158 – */
172  
173 < extern int
161 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
162 < /*
163 <        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
164 <
165 <        ls      -       returned encoded luminance values.
166 <        cs      -       returned encoded chrominance values (Note 2).
167 <        scan    -       input scanline.
168 <        len     -       scanline length.
169 <
170 <        returns -       0 on success, TM_E_* on error.
173 >        tms     -       tone mapping structure pointer.
174   */
175  
176   extern int
177 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
177 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
178   /*
179 <        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
179 >        Add brightness values to current histogram.
180  
181 <        ls      -       returned encoded luminance values.
182 <        cs      -       returned encoded chrominance values (Note 2).
183 <        scan    -       input scanline.
184 <        len     -       scanline length.
181 >        tms     -       tone mapping structure pointer.
182 >        ls      -       encoded luminance values.
183 >        len     -       number of luminance values.
184 >        wt      -       integer weight to use for each value (usually 1 or -1).
185  
186          returns -       0 on success, TM_E_* on error.
187   */
188  
189   extern int
190 < tmAddHisto(TMbright *ls, int len, int wt);
190 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
191   /*
192 <        Add brightness values to current histogram.
192 >        Assign a fixed, linear tone-mapping using the given multiplier,
193 >        which is the ratio of maximum output to uncalibrated input.
194 >        This mapping will be used in subsequent calls to tmMapPixels()
195 >        until a new tone mapping is computed.
196 >        Only the min. and max. values are used from the histogram.
197 >        
198 >        tms     -       tone mapping structure pointer.
199 >        expmult -       the fixed exposure multiplier to use.
200 >        gamval  -       display gamma response (0. for default).
201  
202 <        ls      -       encoded luminance values.
192 <        len     -       number of luminance values.
193 <        wt      -       integer weight to use for each value (usually 1 or -1).
194 <
195 <        returns -       0 on success, TM_E_* on error.
202 >        returns -       0 on success, TM_E_* on error.
203   */
204  
205   extern int
206 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
206 > tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
207   /*
208 <        Compute tone mapping function.  This mapping will be used
209 <        in subsequent calls to tmMapPixels() until a new tone mapping
210 <        is computed.  I.e., calls to tmAddHisto() have no immediate effect.
208 >        Compute tone mapping function from the current histogram.
209 >        This mapping will be used in subsequent calls to tmMapPixels()
210 >        until a new tone mapping is computed.
211 >        I.e., calls to tmAddHisto() have no immediate effect.
212  
213 +        tms     -       tone mapping structure pointer.
214          gamval  -       display gamma response (0. for default).
215          Lddyn   -       the display's dynamic range (0. for default).
216          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 210 | Line 219 | tmComputeMapping(double gamval, double Lddyn, double L
219   */
220  
221   extern int
222 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
222 > tmMapPixels(TMstruct *tms, uby8 *ps, TMbright *ls, uby8 *cs, int len);
223   /*
224          Apply tone mapping function to pixel values.
225  
226 +        tms     -       tone mapping structure pointer.
227          ps      -       returned pixel values (Note 2).
228          ls      -       encoded luminance values.
229          cs      -       encoded chrominance values (Note 2).
# Line 222 | Line 232 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
232          returns -       0 on success, TM_E_* on failure.
233   */
234  
235 + extern TMstruct *
236 + tmDup(TMstruct *orig);
237 + /*
238 +        Duplicate the given tone mapping into a new struct.
239 +
240 +        orig    -       tone mapping structure to duplicate.
241 +
242 +        returns -       pointer to new struct, or NULL on error.
243 + */
244 +
245 + extern void
246 + tmDone(TMstruct *tms);
247 + /*
248 +        Free data associated with the given tone mapping structure.
249 +
250 +        tms     -       tone mapping structure to free.
251 + */
252 +
253   extern int
254 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
254 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
255 > /*
256 >        Convert gray float scanline to encoded luminance.
257 >
258 >        tms     -       tone mapping structure pointer.
259 >        ls      -       returned encoded luminance values.
260 >        scan    -       input scanline.
261 >        len     -       scanline length.
262 >
263 >        returns -       0 on success, TM_E_* on error.
264 > */
265 >
266 > extern int
267 > tmCvColors(TMstruct *tms, TMbright *ls, uby8 *cs, COLOR *scan, int len);
268 > /*
269 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
270 >
271 >        tms     -       tone mapping structure pointer.
272 >        ls      -       returned encoded luminance values.
273 >        cs      -       returned encoded chrominance values (Note 2).
274 >        scan    -       input scanline.
275 >        len     -       scanline length.
276 >
277 >        returns -       0 on success, TM_E_* on error.
278 > */
279 >
280 > extern int
281 > tmCvColrs(TMstruct *tms, TMbright *ls, uby8 *cs, COLR *scan, int len);
282 > /*
283 >        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
284 >
285 >        tms     -       tone mapping structure pointer.
286 >        ls      -       returned encoded luminance values.
287 >        cs      -       returned encoded chrominance values (Note 2).
288 >        scan    -       input scanline.
289 >        len     -       scanline length.
290 >
291 >        returns -       0 on success, TM_E_* on error.
292 > */
293 >
294 > extern int
295 > tmLoadPicture(TMstruct *tms, TMbright **lpp, uby8 **cpp, int *xp, int *yp,
296                  char *fname, FILE *fp);
297   /*
298          Load Radiance picture and convert to tone mapping representation.
# Line 231 | Line 300 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
300          malloc(3), and should be freed with free(3) when no longer needed.
301          Calls tmSetSpace() to calibrate input color space.
302  
303 <        lpp     -       returned array of encoded luminances, English ordering.
303 >        tms     -       tone mapping structure pointer.
304 >        lpp     -       returned array of encoded luminances, picture ordering.
305          cpp     -       returned array of encoded chrominances (Note 2).
306          xp, yp  -       returned picture dimensions.
307          fname   -       picture file name.
# Line 241 | Line 311 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
311   */
312  
313   extern int
314 < tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
314 > tmMapPicture(uby8 **psp, int *xp, int *yp, int flags,
315                  RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax,
316                  char *fname, FILE *fp);
317   /*
318          Load and apply tone mapping to Radiance picture.
249 –        Stack is restored to its original state upon return.
319          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
320          calls pcond to perform the actual conversion, which takes
321          longer but gives access to all the TM_F_* features.
322          Memory for the final pixel array is allocated using malloc(3),
323          and should be freed with free(3) when it is no longer needed.
324  
325 <        psp     -       returned array of tone mapped pixels, English ordering.
325 >        psp     -       returned array of tone mapped pixels, picture ordering.
326          xp, yp  -       returned picture dimensions.
327          flags   -       TM_F_* flags indicating what is to be done.
328          monpri  -       display monitor primaries (Note 1).
# Line 266 | Line 335 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
335          returns -       0 on success, TM_E_* on failure.
336   */
337  
269 – extern struct tmStruct *
270 – tmPop(void);
271 – /*
272 –        Pops current tone mapping from stack.
273 –
274 –        returns -       pointer to tone mapping structure, or NULL if none.
275 – */
276 –
338   extern int
339 < tmPull(struct tmStruct *tms);
339 > tmCvRGB48(TMstruct *tms, TMbright *ls, uby8 *cs, uint16 (*scan)[3],
340 >                int len, double gv);
341   /*
342 <        Pull tone mapping from anywhere in stack.
342 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
343  
344 <        tms     -       tone mapping structure to find.
344 >        tms     -       tone mapping structure pointer.
345 >        ls      -       returned encoded luminance values.
346 >        cs      -       returned encoded chrominance values (Note 2).
347 >        scan    -       input scanline.
348 >        len     -       scanline length.
349 >        gv      -       input gamma value.
350  
351 <        returns -       1 if found in stack, 0 otherwise.
351 >        returns -       0 on success, TM_E_* on error.
352   */
353  
354   extern int
355 < tmPush(struct tmStruct *tms);
355 > tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
356   /*
357 <        Make tone mapping active by (pulling it and) pushing it to the top.
357 >        Convert 16-bit gray scanline to encoded luminance.
358  
359 <        tms     -       initialized tone mapping structure.
359 >        tms     -       tone mapping structure pointer.
360 >        ls      -       returned encoded luminance values.
361 >        scan    -       input scanline.
362 >        len     -       scanline length.
363 >        gv      -       input gamma value.
364  
365 <        returns -       0 on success, TM_E_* if tms is invalid.
365 >        returns -       0 on success, TM_E_* on error.
366   */
367  
297 – extern struct tmStruct *
298 – tmDup(void);
299 – /*
300 –        Duplicate the current tone mapping into a new structure on the stack.
301 –
302 –        returns -       pointer to new top, or NULL on error.
303 – */
304 –
305 – extern void
306 – tmDone(struct tmStruct *tms);
307 – /*
308 –        Free data associated with the given tone mapping structure.
309 –        Calls tmPull() first to remove it from the stack if present.
310 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
311 –        all have the same effect, which is to remove and free
312 –        the current tone mapping.
313 –
314 –        tms     -       tone mapping structure to free.
315 – */
316 –
317 – #endif
318 –
319 –
368   /****    Notes    ****/
369   /*
370          General:
# Line 387 | Line 435 | tmDone(struct tmStruct *tms);
435          function will open the file, read its contents and close it
436          before returning, whether or not an error was encountered.
437   */
438 +
439 + #ifdef __cplusplus
440 + }
441 + #endif
442 + #endif /* _RAD_TONEMAP_H_ */
443 +

Diff Legend

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