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.1 by greg, Tue Apr 15 16:53:03 1997 UTC vs.
Revision 3.29 by greg, Thu Jan 7 19:13:57 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 18 | Line 23
23   #define TM_F_CWEIGHT    040             /* center weighting */
24   #define TM_F_FOVEAL     0100            /* use foveal sample size */
25   #define TM_F_BW         0200            /* luminance only */
26 < #define TM_F_NOERRS     0400            /* don't report errors to stderr */
26 > #define TM_F_NOSTDERR   0400            /* don't report errors to stderr */
27                                  /* combined modes */
28   #define TM_F_CAMERA     0
29   #define TM_F_HUMAN      (TM_F_HCONTR|TM_F_MESOPIC|TM_F_VEIL|\
# Line 27 | 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 39 | Line 45
45   #define TM_E_TMINVAL    3               /* no valid tone mapping */
46   #define TM_E_TMFAIL     4               /* cannot compute tone mapping */
47   #define TM_E_BADFILE    5               /* cannot open or understand file */
48 + #define TM_E_CODERR1    6               /* code consistency error 1 */
49 + #define TM_E_CODERR2    7               /* code consistency error 2 */
50  
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_GAMTSZ       1024            /* gamma lookup table size */
56 > #define TM_NOBRT        (~0x7fff)       /* bogus brightness value */
57 > #define TM_NOLUM        (1e-17)         /* ridiculously small luminance */
58  
59 < /****    Global Data Structures    ****/
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 *
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 */
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.) */
60 –        BYTE            gamb[TM_GAMTSZ];/* gamma lookup table from mongam */
85          COLOR           clf;            /* computed luminance coefficients */
86 <        COLR            clfb;           /* normalized version of clf */
86 >        int             cdiv[3];        /* computed color divisors */
87          RGBPRIMP        inppri;         /* current input primaries */
88          double          inpsf;          /* current input scalefactor */
89 <        TMbright        inpsfb;         /* encoded version of inpsf */
89 >        MEM_PTR         inpdat;         /* current input client data */
90          COLORMAT        cmat;           /* color conversion matrix */
91 <        TMbright        brmin, brmax;   /* input brightness limits */  
92 <        int             *histo;         /* input histogram */
93 <        unsigned short  *lumap;         /* computed luminance map */
94 <        struct tmStruct *tmprev;        /* previous tone mapping */
95 < }       *tmTop;                 /* current tone mapping stack */
96 <
91 >        TMbright        hbrmin, hbrmax; /* histogram brightness limits */      
92 >        HIST_TYP        *histo;         /* input histogram */
93 >        TMbright        mbrmin, mbrmax; /* mapped brightness limits */
94 >        TMAP_TYP        *lumap;         /* computed luminance map */
95 >        MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
96 >        int             lastError;      /* last error incurred */
97 >        const char      *lastFunc;      /* error-generating function name */
98 > } TMstruct;
99 >
100 >                                /* conversion package functions */
101 > struct tmPackage {
102 >        MEM_PTR         (*Init)(TMstruct *tms);
103 >        void            (*NewSpace)(TMstruct *tms);
104 >        void            (*Free)(MEM_PTR pp);
105 > };
106 >                                /* our list of conversion packages */
107 > extern struct tmPackage *tmPkg[TM_MAXPKG];
108 > extern int      tmNumPkgs;      /* number of registered packages */
109 >
110 >
111   /****    Useful Macros    ****/
112  
113 < #define tmLuminance(li) exp((li)/(double)TM_BRTSCALE)
113 >                                /* compute luminance from encoded value */
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)
118 +
119 +                                /* register a conversion package */
120 + #define tmRegPkg(pf)    ( tmNumPkgs >= TM_MAXPKG ? -1 : \
121 +                                (tmPkg[tmNumPkgs] = (pf), tmNumPkgs++) )
122 +
123 +                                /* get the specific package's data */
124 + #define tmPkgData(t,i)  ((t)->pd[i]!=NULL ? (t)->pd[i] : (*tmPkg[i]->Init)(t))
125 +
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();
136 < extern void     tmClearHisto(), tmDone();
137 < extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
138 < extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
85 < 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.
116 – */
176  
177 < extern int
119 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
120 < /*
121 <        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
122 <
123 <        ls      -       returned encoded luminance values.
124 <        cs      -       returned encoded chrominance values (Note 2).
125 <        scan    -       input scanline.
126 <        len     -       scanline length.
127 <
128 <        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);
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  
206 <        ls      -       encoded luminance values.
150 <        len     -       number of luminance values.
151 <        wt      -       integer weight to use for each value (usually 1 or -1).
152 <
153 <        returns -       0 on success, TM_E_* on error.
206 >        returns -       0 on success, TM_E_* on error.
207   */
208  
209   extern int
210 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
210 > tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
211   /*
212 <        Compute tone mapping function.
212 >        Compute tone mapping function from the current histogram.
213 >        This mapping will be used in subsequent calls to tmMapPixels()
214 >        until a new tone mapping is computed.
215 >        I.e., calls to tmAddHisto() have no immediate effect.
216  
217 +        tms     -       tone mapping structure pointer.
218          gamval  -       display gamma response (0. for default).
219          Lddyn   -       the display's dynamic range (0. for default).
220          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 166 | Line 223 | tmComputeMapping(double gamval, double Lddyn, double L
223   */
224  
225   extern int
226 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
226 > tmMapPixels(TMstruct *tms, uby8 *ps, TMbright *ls, uby8 *cs, int len);
227   /*
228          Apply tone mapping function to pixel values.
229  
230 +        tms     -       tone mapping structure pointer.
231          ps      -       returned pixel values (Note 2).
232          ls      -       encoded luminance values.
233          cs      -       encoded chrominance values (Note 2).
# Line 178 | Line 236 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
236          returns -       0 on success, TM_E_* on failure.
237   */
238  
239 + extern TMstruct *
240 + tmDup(TMstruct *orig);
241 + /*
242 +        Duplicate the given tone mapping into a new struct.
243 +
244 +        orig    -       tone mapping structure to duplicate.
245 +
246 +        returns -       pointer to new struct, or NULL on error.
247 + */
248 +
249 + extern void
250 + tmDone(TMstruct *tms);
251 + /*
252 +        Free data associated with the given tone mapping structure.
253 +
254 +        tms     -       tone mapping structure to free.
255 + */
256 +
257   extern int
258 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
258 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
259 > /*
260 >        Convert gray float scanline to encoded luminance.
261 >
262 >        tms     -       tone mapping structure pointer.
263 >        ls      -       returned encoded luminance values.
264 >        scan    -       input scanline.
265 >        len     -       scanline length.
266 >
267 >        returns -       0 on success, TM_E_* on error.
268 > */
269 >
270 > extern int
271 > tmCvColors(TMstruct *tms, TMbright *ls, uby8 *cs, COLOR *scan, int len);
272 > /*
273 >        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
274 >
275 >        tms     -       tone mapping structure pointer.
276 >        ls      -       returned encoded luminance values.
277 >        cs      -       returned encoded chrominance values (Note 2).
278 >        scan    -       input scanline.
279 >        len     -       scanline length.
280 >
281 >        returns -       0 on success, TM_E_* on error.
282 > */
283 >
284 > extern int
285 > tmCvColrs(TMstruct *tms, TMbright *ls, uby8 *cs, COLR *scan, int len);
286 > /*
287 >        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
288 >
289 >        tms     -       tone mapping structure pointer.
290 >        ls      -       returned encoded luminance values.
291 >        cs      -       returned encoded chrominance values (Note 2).
292 >        scan    -       input scanline.
293 >        len     -       scanline length.
294 >
295 >        returns -       0 on success, TM_E_* on error.
296 > */
297 >
298 > extern int
299 > tmLoadPicture(TMstruct *tms, TMbright **lpp, uby8 **cpp, int *xp, int *yp,
300                  char *fname, FILE *fp);
301   /*
302          Load Radiance picture and convert to tone mapping representation.
303 +        Memory for the luminance and chroma arrays is allocated using
304 +        malloc(3), and should be freed with free(3) when no longer needed.
305 +        Calls tmSetSpace() to calibrate input color space.
306  
307 <        lpp     -       returned array of encoded luminances, English ordering.
307 >        tms     -       tone mapping structure pointer.
308 >        lpp     -       returned array of encoded luminances, picture ordering.
309          cpp     -       returned array of encoded chrominances (Note 2).
310          xp, yp  -       returned picture dimensions.
311          fname   -       picture file name.
# Line 194 | Line 315 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
315   */
316  
317   extern int
318 < tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
318 > tmMapPicture(uby8 **psp, int *xp, int *yp, int flags,
319                  RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax,
320                  char *fname, FILE *fp);
321   /*
322          Load and apply tone mapping to Radiance picture.
202 –        Stack is restored to its original state upon return.
323          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
324          calls pcond to perform the actual conversion, which takes
325          longer but gives access to all the TM_F_* features.
326 +        Memory for the final pixel array is allocated using malloc(3),
327 +        and should be freed with free(3) when it is no longer needed.
328  
329 <        psp     -       returned array of tone mapped pixels, English ordering.
329 >        psp     -       returned array of tone mapped pixels, picture ordering.
330          xp, yp  -       returned picture dimensions.
331          flags   -       TM_F_* flags indicating what is to be done.
332          monpri  -       display monitor primaries (Note 1).
# Line 217 | Line 339 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
339          returns -       0 on success, TM_E_* on failure.
340   */
341  
220 – extern struct tmStruct *
221 – tmPop(void);
222 – /*
223 –        Pops current tone mapping from stack.
224 –
225 –        returns -       pointer to tone mapping structure, or NULL if none.
226 – */
227 –
342   extern int
343 < tmPull(struct tmStruct *tms);
343 > tmCvRGB48(TMstruct *tms, TMbright *ls, uby8 *cs, uint16 (*scan)[3],
344 >                int len, double gv);
345   /*
346 <        Pull tone mapping from anywhere in stack.
346 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
347  
348 <        tms     -       tone mapping structure to find.
348 >        tms     -       tone mapping structure pointer.
349 >        ls      -       returned encoded luminance values.
350 >        cs      -       returned encoded chrominance values (Note 2).
351 >        scan    -       input scanline.
352 >        len     -       scanline length.
353 >        gv      -       input gamma value.
354  
355 <        returns -       1 if found in stack, 0 otherwise.
355 >        returns -       0 on success, TM_E_* on error.
356   */
357  
358   extern int
359 < tmPush(struct tmStruct *tms);
359 > tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
360   /*
361 <        Make tone mapping active by (pulling it and) pushing it to the top.
361 >        Convert 16-bit gray scanline to encoded luminance.
362  
363 <        tms     -       initialized tone mapping structure.
363 >        tms     -       tone mapping structure pointer.
364 >        ls      -       returned encoded luminance values.
365 >        scan    -       input scanline.
366 >        len     -       scanline length.
367 >        gv      -       input gamma value.
368  
369 <        returns -       0 on success, TM_E_* if tms is invalid.
369 >        returns -       0 on success, TM_E_* on error.
370   */
371  
248 – extern void
249 – tmDone(struct tmStruct *tms);
250 – /*
251 –        Free data associated with the given tone mapping structure.
252 –        Calls tmPull() first to remove it from the stack if present.
253 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
254 –        all have the same effect, which is to remove and free
255 –        the current tone mapping.
256 –
257 –        tms     -       tone mapping structure to free.
258 – */
259 –
260 – #endif
261 –
372   /****    Notes    ****/
373   /*
374          General:
# Line 267 | Line 377 | tmDone(struct tmStruct *tms);
377          pixel values to chroma and luminance encodings, which can
378          be passed to tmAddHisto() to put into the tone mapping histogram.
379          This histogram is then used along with the display parameters
380 <        by tmComputMapping() to compute the luminance mapping function.
380 >        by tmComputeMapping() to compute the luminance mapping function.
381          (Colors are tone-mapped as they are converted if TM_F_MESOPIC
382          is set.)  The encoded chroma and luminance values may then be
383          passed to tmMapPixels() to apply the computed tone mapping in
# Line 280 | Line 390 | tmDone(struct tmStruct *tms);
390          used during final mapping, setting the cs parameter to TM_NOCHROM
391          on the first pass will save time.)  Another memory saving option
392          if third and subsequent passes are not needed is to use the
393 <        same array to store the mapped pixels as is used to store
393 >        same array to store the mapped pixels as used to store
394          the encoded chroma values.  This way, only two extra bytes
395          for storing encoded luminances are required per pixel.  This
396          is the method employed by tmMapPicture(), for example.
# Line 329 | Line 439 | tmDone(struct tmStruct *tms);
439          function will open the file, read its contents and close it
440          before returning, whether or not an error was encountered.
441   */
442 +
443 + #ifdef __cplusplus
444 + }
445 + #endif
446 + #endif /* _RAD_TONEMAP_H_ */
447 +

Diff Legend

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