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

Diff Legend

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