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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines