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.14 by greg, Fri Jun 27 06:53:22 2003 UTC vs.
Revision 3.32 by greg, Sat Jan 15 16:57:46 2022 UTC

# Line 6 | Line 6
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 29 | Line 32 | extern "C" {
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 48 | Line 51 | extern "C" {
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        (-1<<15)        /* bogus brightness value */
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 */
66 – extern int      tmLastError;            /* last error incurred by library */
67 – 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 77 | 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        hbrmin, hbrmax; /* histogram brightness limits */      
89 <        int             *histo;         /* input histogram */
89 >        HIST_TYP        *histo;         /* input histogram */
90          TMbright        mbrmin, mbrmax; /* mapped brightness limits */
91 <        unsigned short  *lumap;         /* computed luminance map */
92 <        struct tmStruct *tmprev;        /* previous tone mapping */
93 <        MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
94 < }       *tmTop;                 /* current tone mapping stack */
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 */
98   struct tmPackage {
99 <        MEM_PTR         (*Init)(struct tmStruct *tms);
100 <        void            (*NewSpace)(struct tmStruct *tms);
101 <        void            (*Free)(MEM_PTR pp);
99 >        void *          (*Init)(TMstruct *tms);
100 >        void            (*NewSpace)(TMstruct *tms);
101 >        void            (*Free)(void *pp);
102   };
103                                  /* our list of conversion packages */
104   extern struct tmPackage *tmPkg[TM_MAXPKG];
# Line 115 | Line 123 | extern int     tmNumPkgs;      /* number of registered packages
123  
124   /****    Library Function Calls    ****/
125  
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 *
132 > extern int
133 > tmCvLums(TMbright *ls, float *scan, int len);
134 > /*
135 >        Convert luminance values to encoded brightness values using lookup.
136 >
137 >        ls      -       returned encoded luminance values.
138 >        scan    -       input scanline.
139 >        len     -       scanline length.
140 >
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.
173 +
174 +        tms     -       tone mapping structure pointer.
175   */
176  
177   extern int
178 < tmAddHisto(TMbright *ls, int len, int wt);
178 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
179   /*
180          Add brightness values to current histogram.
181  
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).
# Line 158 | Line 188 | tmAddHisto(TMbright *ls, int len, int wt);
188   */
189  
190   extern int
191 < tmFixedMapping(double expmult, double gamval);
191 > tmFixedMapping(TMstruct *tms, double expmult, double gamval, double Lddyn);
192   /*
193          Assign a fixed, linear tone-mapping using the given multiplier,
194          which is the ratio of maximum output to uncalibrated input.
# Line 166 | Line 196 | tmFixedMapping(double expmult, double gamval);
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          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 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 187 | 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 199 | Line 234 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
234          returns -       0 on success, TM_E_* on failure.
235   */
236  
237 < extern struct tmStruct *
238 < tmPop(void);
237 > extern TMstruct *
238 > tmDup(TMstruct *orig);
239   /*
240 <        Pops current tone mapping from stack.
240 >        Duplicate the given tone mapping into a new struct.
241  
242 <        returns -       pointer to tone mapping structure, or NULL if none.
208 < */
242 >        orig    -       tone mapping structure to duplicate.
243  
244 < extern int
211 < tmPull(struct tmStruct *tms);
212 < /*
213 <        Pull tone mapping from anywhere in stack.
214 <
215 <        tms     -       tone mapping structure to find.
216 <
217 <        returns -       1 if found in stack, 0 otherwise.
244 >        returns -       pointer to new struct, or NULL on error.
245   */
246  
220 – extern int
221 – tmPush(struct tmStruct *tms);
222 – /*
223 –        Make tone mapping active by (pulling it and) pushing it to the top.
224 –
225 –        tms     -       initialized tone mapping structure.
226 –
227 –        returns -       0 on success, TM_E_* if tms is invalid.
228 – */
229 –
230 – extern struct tmStruct *
231 – tmDup(void);
232 – /*
233 –        Duplicate the current tone mapping into a new structure on the stack.
234 –
235 –        returns -       pointer to new top, or NULL on error.
236 – */
237 –
247   extern void
248 < tmDone(struct tmStruct *tms);
248 > tmDone(TMstruct *tms);
249   /*
250          Free data associated with the given tone mapping structure.
242 –        Calls tmPull() first to remove it from the stack if present.
243 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
244 –        all have the same effect, which is to remove and free
245 –        the current tone mapping.
251  
252          tms     -       tone mapping structure to free.
253   */
254  
255   extern int
256 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
256 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
257   /*
258 <        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
258 >        Convert gray float scanline to encoded luminance.
259  
260 +        tms     -       tone mapping structure pointer.
261          ls      -       returned encoded luminance values.
256 –        cs      -       returned encoded chrominance values (Note 2).
262          scan    -       input scanline.
263          len     -       scanline length.
264  
# Line 261 | Line 266 | tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int le
266   */
267  
268   extern int
269 < tmCvGrays(TMbright *ls, float *scan, int len);
269 > tmCvColors(TMstruct *tms, TMbright *ls, uby8 *cs, COLOR *scan, int len);
270   /*
271 <        Convert gray float scanline to encoded luminance.
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  
# Line 273 | Line 280 | tmCvGrays(TMbright *ls, float *scan, int len);
280   */
281  
282   extern int
283 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
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.
# Line 286 | Line 294 | tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len)
294   */
295  
296   extern int
297 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
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 294 | 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 +        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.
# Line 304 | 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.
312 –        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.
# Line 329 | Line 337 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
337          returns -       0 on success, TM_E_* on failure.
338   */
339  
340 + extern int
341 + tmCvRGB48(TMstruct *tms, TMbright *ls, uby8 *cs, uint16 (*scan)[3],
342 +                int len, double gv);
343 + /*
344 +        Convert 48-bit RGB scanline to encoded luminance and chrominance.
345  
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 -       0 on success, TM_E_* on error.
354 + */
355 +
356 + extern int
357 + tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
358 + /*
359 +        Convert 16-bit gray scanline to encoded luminance.
360 +
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_* on error.
368 + */
369  
370   /****    Notes    ****/
371   /*

Diff Legend

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