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.11 by greg, Sat Feb 22 02:07:22 2003 UTC vs.
Revision 3.30 by greg, Tue Mar 2 20:09:14 2021 UTC

# Line 1 | Line 1
1 < /* RCSid: $Id$ */
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 < /* ====================================================================
9 < * The Radiance Software License, Version 1.0
10 < *
11 < * Copyright (c) 1990 - 2002 The Regents of the University of California,
12 < * through Lawrence Berkeley National Laboratory.   All rights reserved.
13 < *
14 < * Redistribution and use in source and binary forms, with or without
15 < * modification, are permitted provided that the following conditions
16 < * are met:
17 < *
18 < * 1. Redistributions of source code must retain the above copyright
19 < *         notice, this list of conditions and the following disclaimer.
20 < *
21 < * 2. Redistributions in binary form must reproduce the above copyright
22 < *       notice, this list of conditions and the following disclaimer in
23 < *       the documentation and/or other materials provided with the
24 < *       distribution.
25 < *
26 < * 3. The end-user documentation included with the redistribution,
27 < *           if any, must include the following acknowledgment:
28 < *             "This product includes Radiance software
29 < *                 (http://radsite.lbl.gov/)
30 < *                 developed by the Lawrence Berkeley National Laboratory
31 < *               (http://www.lbl.gov/)."
32 < *       Alternately, this acknowledgment may appear in the software itself,
33 < *       if and wherever such third-party acknowledgments normally appear.
34 < *
35 < * 4. The names "Radiance," "Lawrence Berkeley National Laboratory"
36 < *       and "The Regents of the University of California" must
37 < *       not be used to endorse or promote products derived from this
38 < *       software without prior written permission. For written
39 < *       permission, please contact [email protected].
40 < *
41 < * 5. Products derived from this software may not be called "Radiance",
42 < *       nor may "Radiance" appear in their name, without prior written
43 < *       permission of Lawrence Berkeley National Laboratory.
44 < *
45 < * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
46 < * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47 < * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
48 < * DISCLAIMED.   IN NO EVENT SHALL Lawrence Berkeley National Laboratory OR
49 < * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
50 < * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
51 < * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
52 < * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
53 < * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
54 < * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
55 < * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56 < * SUCH DAMAGE.
57 < * ====================================================================
58 < *
59 < * This software consists of voluntary contributions made by many
60 < * individuals on behalf of Lawrence Berkeley National Laboratory.   For more
61 < * information on Lawrence Berkeley National Laboratory, please see
62 < * <http://www.lbl.gov/>.
63 < */
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 85 | 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 104 | 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  
# Line 117 | Line 66 | extern "C" {
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 */
122 – extern int      tmLastError;            /* last error incurred by library */
123 – 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 133 | 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 */
141 <        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 */
146 – #ifdef  NOPROTO
101   struct tmPackage {
102 <        MEM_PTR         (*Init)();      /* initialize private data */
103 <        void            (*NewSpace)();  /* new input color space (optional) */
150 <        void            (*Free)();      /* free private data */
151 < };
152 < #else
153 < struct tmPackage {
154 <        MEM_PTR         (*Init)(struct tmStruct *tms);
155 <        void            (*NewSpace)(struct tmStruct *tms);
102 >        MEM_PTR         (*Init)(TMstruct *tms);
103 >        void            (*NewSpace)(TMstruct *tms);
104          void            (*Free)(MEM_PTR pp);
105   };
158 – #endif
106                                  /* our list of conversion packages */
107   extern struct tmPackage *tmPkg[TM_MAXPKG];
108   extern int      tmNumPkgs;      /* number of registered packages */
# Line 179 | 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 int      tmSetSpace(), tmPull(), tmPush();
137 < extern void     tmClearHisto(), tmDone();
138 < extern int      tmAddHisto();
188 < extern int      tmFixedMapping(), tmComputeMapping(), tmMapPixels();
189 < extern int      tmCvColors(), tmCvGrays(), tmCvColrs();
190 < extern int      tmLoadPicture(), tmMapPicture();
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.
176 +
177 +        tms     -       tone mapping structure pointer.
178   */
179  
180   extern int
181 < tmAddHisto(TMbright *ls, int len, int wt);
181 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
182   /*
183          Add brightness values to current histogram.
184  
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).
# Line 233 | Line 191 | tmAddHisto(TMbright *ls, int len, int wt);
191   */
192  
193   extern int
194 < tmFixedMapping(double expmult, double gamval);
194 > tmFixedMapping(TMstruct *tms, double expmult, double gamval, double Lddyn);
195   /*
196          Assign a fixed, linear tone-mapping using the given multiplier,
197          which is the ratio of maximum output to uncalibrated input.
# Line 241 | Line 199 | tmFixedMapping(double expmult, double gamval);
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          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 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 262 | 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 274 | Line 237 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
237          returns -       0 on success, TM_E_* on failure.
238   */
239  
240 < extern struct tmStruct *
241 < tmPop(void);
240 > extern TMstruct *
241 > tmDup(TMstruct *orig);
242   /*
243 <        Pops current tone mapping from stack.
243 >        Duplicate the given tone mapping into a new struct.
244  
245 <        returns -       pointer to tone mapping structure, or NULL if none.
283 < */
245 >        orig    -       tone mapping structure to duplicate.
246  
247 < extern int
286 < tmPull(struct tmStruct *tms);
287 < /*
288 <        Pull tone mapping from anywhere in stack.
289 <
290 <        tms     -       tone mapping structure to find.
291 <
292 <        returns -       1 if found in stack, 0 otherwise.
247 >        returns -       pointer to new struct, or NULL on error.
248   */
249  
295 – extern int
296 – tmPush(struct tmStruct *tms);
297 – /*
298 –        Make tone mapping active by (pulling it and) pushing it to the top.
299 –
300 –        tms     -       initialized tone mapping structure.
301 –
302 –        returns -       0 on success, TM_E_* if tms is invalid.
303 – */
304 –
305 – extern struct tmStruct *
306 – tmDup(void);
307 – /*
308 –        Duplicate the current tone mapping into a new structure on the stack.
309 –
310 –        returns -       pointer to new top, or NULL on error.
311 – */
312 –
250   extern void
251 < tmDone(struct tmStruct *tms);
251 > tmDone(TMstruct *tms);
252   /*
253          Free data associated with the given tone mapping structure.
317 –        Calls tmPull() first to remove it from the stack if present.
318 –        The calls tmDone(tmPop()), tmDone(tmTop) and tmDone(NULL)
319 –        all have the same effect, which is to remove and free
320 –        the current tone mapping.
254  
255          tms     -       tone mapping structure to free.
256   */
257  
258   extern int
259 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
259 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
260   /*
261 <        Convert RGB/XYZ float scanline to encoded luminance and chrominance.
261 >        Convert gray float scanline to encoded luminance.
262  
263 +        tms     -       tone mapping structure pointer.
264          ls      -       returned encoded luminance values.
331 –        cs      -       returned encoded chrominance values (Note 2).
265          scan    -       input scanline.
266          len     -       scanline length.
267  
# Line 336 | Line 269 | tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int le
269   */
270  
271   extern int
272 < tmCvGrays(TMbright *ls, float *scan, int len);
272 > tmCvColors(TMstruct *tms, TMbright *ls, uby8 *cs, COLOR *scan, int len);
273   /*
274 <        Convert gray float scanline to encoded luminance.
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  
# Line 348 | Line 283 | tmCvGrays(TMbright *ls, float *scan, int len);
283   */
284  
285   extern int
286 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
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.
# Line 361 | Line 297 | tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len)
297   */
298  
299   extern int
300 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
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 369 | 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 +        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.
# Line 379 | 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.
387 –        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.
# Line 404 | Line 340 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
340          returns -       0 on success, TM_E_* on failure.
341   */
342  
343 < #endif
343 > extern int
344 > tmCvRGB48(TMstruct *tms, TMbright *ls, uby8 *cs, uint16 (*scan)[3],
345 >                int len, double gv);
346 > /*
347 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
348  
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 -       0 on success, TM_E_* on error.
357 + */
358 +
359 + extern int
360 + tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
361 + /*
362 +        Convert 16-bit gray scanline to encoded luminance.
363 +
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_* on error.
371 + */
372 +
373   /****    Notes    ****/
374   /*
375          General:
# Line 481 | Line 444 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
444   #ifdef __cplusplus
445   }
446   #endif
447 + #endif /* _RAD_TONEMAP_H_ */
448 +

Diff Legend

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