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

Diff Legend

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