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

Diff Legend

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