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.28 by greg, Thu Jan 7 02:13:49 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 + #define TMAP_TYP        unsigned short
73 +
74   extern char     *tmErrorMessage[];      /* error messages */
75  
76   typedef short   TMbright;               /* encoded luminance type */
77  
78                                  /* basic tone mapping data structure */
79 < extern struct tmStruct {
79 > typedef struct {
80          int             flags;          /* flags of what to do */
81          RGBPRIMP        monpri;         /* monitor RGB primaries */
82          double          mongam;         /* monitor gamma value (approx.) */
60 –        BYTE            gamb[TM_GAMTSZ];/* gamma lookup table from mongam */
83          COLOR           clf;            /* computed luminance coefficients */
84 <        COLR            clfb;           /* normalized version of clf */
84 >        int             cdiv[3];        /* computed color divisors */
85          RGBPRIMP        inppri;         /* current input primaries */
86          double          inpsf;          /* current input scalefactor */
87 <        TMbright        inpsfb;         /* encoded version of inpsf */
87 >        MEM_PTR         inpdat;         /* current input client data */
88          COLORMAT        cmat;           /* color conversion matrix */
89 <        TMbright        brmin, brmax;   /* input brightness limits */  
90 <        int             *histo;         /* input histogram */
91 <        unsigned short  *lumap;         /* computed luminance map */
92 <        struct tmStruct *tmprev;        /* previous tone mapping */
93 < }       *tmTop;                 /* current tone mapping stack */
94 <
89 >        TMbright        hbrmin, hbrmax; /* histogram brightness limits */      
90 >        HIST_TYP        *histo;         /* input histogram */
91 >        TMbright        mbrmin, mbrmax; /* mapped brightness limits */
92 >        TMAP_TYP        *lumap;         /* computed luminance map */
93 >        MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
94 >        int             lastError;      /* last error incurred */
95 >        const char      *lastFunc;      /* error-generating function name */
96 > } TMstruct;
97 >
98 >                                /* conversion package functions */
99 > struct tmPackage {
100 >        MEM_PTR         (*Init)(TMstruct *tms);
101 >        void            (*NewSpace)(TMstruct *tms);
102 >        void            (*Free)(MEM_PTR pp);
103 > };
104 >                                /* our list of conversion packages */
105 > extern struct tmPackage *tmPkg[TM_MAXPKG];
106 > extern int      tmNumPkgs;      /* number of registered packages */
107 >
108 >
109   /****    Useful Macros    ****/
110  
111 < #define tmLuminance(li) exp((li)/(double)TM_BRTSCALE)
111 >                                /* compute luminance from encoded value */
112 > #define tmLuminance(li) exp((li)*(1./TM_BRTSCALE))
113  
114 +                                /* does tone mapping need color matrix? */
115 + #define tmNeedMatrix(t) ((t)->monpri != (t)->inppri)
116 +
117 +                                /* register a conversion package */
118 + #define tmRegPkg(pf)    ( tmNumPkgs >= TM_MAXPKG ? -1 : \
119 +                                (tmPkg[tmNumPkgs] = (pf), tmNumPkgs++) )
120 +
121 +                                /* get the specific package's data */
122 + #define tmPkgData(t,i)  ((t)->pd[i]!=NULL ? (t)->pd[i] : (*tmPkg[i]->Init)(t))
123 +
124 +
125   /****    Library Function Calls    ****/
126  
127 < #ifdef NOPROTO
127 > extern TMbright
128 > tmCvLuminance(double lum);
129 > /*
130 >        Convert a single luminance value to an encoded brightness value.
131 > */
132  
133 < extern struct tmStruct  *tmInit(), *tmPop();
134 < extern void     tmClearHisto(), tmDone();
135 < extern int      tmSetSpace(), tmCvColors(), tmCvColrs();
136 < extern int      tmAddHisto(), tmComputeMapping(), tmMapPixels();
85 < extern int      tmLoadPicture(), tmMapPicture(), tmPull(), tmPush();
133 > extern int
134 > tmCvLums(TMbright *ls, float *scan, int len);
135 > /*
136 >        Convert luminance values to encoded brightness values using lookup.
137  
138 < #else
138 >        ls      -       returned encoded luminance values.
139 >        scan    -       input scanline.
140 >        len     -       scanline length.
141  
142 < extern struct tmStruct *
142 >        returns -       0 on success, TM_E_* on error.
143 > */
144 >
145 > extern TMstruct *
146   tmInit(int flags, RGBPRIMP monpri, double gamval);
147   /*
148 <        Initialize new tone mapping and push it onto stack.
148 >        Allocate and initialize new tone mapping.
149  
150          flags   -       TM_F_* flags indicating what is to be done.
151          monpri  -       display monitor primaries (Note 1).
152          gamval  -       display gamma response (can be approximate).
153  
154 <        returns -       new tmTop, or NULL if insufficient memory.
154 >        returns -       new tone-mapping pointer, or NULL if no memory.
155   */
156  
157   extern int
158 < tmSetSpace(RGBPRIMP pri, double sf);
158 > tmSetSpace(TMstruct *tms, RGBPRIMP pri, double sf, MEM_PTR dat);
159   /*
160          Set color primaries and scale factor for incoming scanlines.
161  
162 +        tms     -       tone mapping structure pointer.
163          pri     -       RGB color input primaries (Note 1).
164          sf      -       scale factor to get to luminance in cd/m^2.
165 +        dat     -       application-specific data (NULL if not needed)
166  
167          returns -       0 on success, TM_E_* code on failure.
168   */
169  
170   extern void
171 < tmClearHisto(void);
171 > tmClearHisto(TMstruct *tms);
172   /*
173          Clear histogram for current tone mapping.
116 – */
174  
175 < 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.
175 >        tms     -       tone mapping structure pointer.
176   */
177  
178   extern int
179 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
179 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
180   /*
181 <        Convert RGBE/XYZE scanline to encoded luminance and chrominance.
181 >        Add brightness values to current histogram.
182  
183 <        ls      -       returned encoded luminance values.
184 <        cs      -       returned encoded chrominance values (Note 2).
185 <        scan    -       input scanline.
186 <        len     -       scanline length.
183 >        tms     -       tone mapping structure pointer.
184 >        ls      -       encoded luminance values.
185 >        len     -       number of luminance values.
186 >        wt      -       integer weight to use for each value (usually 1 or -1).
187  
188          returns -       0 on success, TM_E_* on error.
189   */
190  
191   extern int
192 < tmAddHisto(TMbright *ls, int len, int wt);
192 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
193   /*
194 <        Add brightness values to current histogram.
194 >        Assign a fixed, linear tone-mapping using the given multiplier,
195 >        which is the ratio of maximum output to uncalibrated input.
196 >        This mapping will be used in subsequent calls to tmMapPixels()
197 >        until a new tone mapping is computed.
198 >        Only the min. and max. values are used from the histogram.
199 >        
200 >        tms     -       tone mapping structure pointer.
201 >        expmult -       the fixed exposure multiplier to use.
202 >        gamval  -       display gamma response (0. for default).
203  
204 <        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.
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 166 | 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 178 | 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.
301 +        Memory for the luminance and chroma arrays is allocated using
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 194 | 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.
202 –        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 217 | Line 337 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
337          returns -       0 on success, TM_E_* on failure.
338   */
339  
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 –
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  
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 –
370   /****    Notes    ****/
371   /*
372          General:
# Line 267 | Line 375 | tmDone(struct tmStruct *tms);
375          pixel values to chroma and luminance encodings, which can
376          be passed to tmAddHisto() to put into the tone mapping histogram.
377          This histogram is then used along with the display parameters
378 <        by tmComputMapping() to compute the luminance mapping function.
378 >        by tmComputeMapping() to compute the luminance mapping function.
379          (Colors are tone-mapped as they are converted if TM_F_MESOPIC
380          is set.)  The encoded chroma and luminance values may then be
381          passed to tmMapPixels() to apply the computed tone mapping in
# Line 280 | Line 388 | tmDone(struct tmStruct *tms);
388          used during final mapping, setting the cs parameter to TM_NOCHROM
389          on the first pass will save time.)  Another memory saving option
390          if third and subsequent passes are not needed is to use the
391 <        same array to store the mapped pixels as is used to store
391 >        same array to store the mapped pixels as used to store
392          the encoded chroma values.  This way, only two extra bytes
393          for storing encoded luminances are required per pixel.  This
394          is the method employed by tmMapPicture(), for example.
# Line 329 | 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