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.18 by greg, Fri Jan 7 21:41:06 2005 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        "tifftypes.h"
11  
12   #ifdef __cplusplus
13   extern "C" {
# 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 tmStruct {
74          int             flags;          /* flags of what to do */
75          RGBPRIMP        monpri;         /* monitor RGB primaries */
76          double          mongam;         /* monitor gamma value (approx.) */
# Line 138 | Line 83 | extern struct tmStruct {
83          int             *histo;         /* input histogram */
84          TMbright        mbrmin, mbrmax; /* mapped brightness limits */
85          unsigned short  *lumap;         /* computed luminance map */
141 –        struct tmStruct *tmprev;        /* previous tone mapping */
86          MEM_PTR         pd[TM_MAXPKG];  /* pointers to private data */
87 < }       *tmTop;                 /* current tone mapping stack */
87 >        int             lastError;      /* last error incurred */
88 >        const char      *lastFunc;      /* error-generating function name */
89 > } TMstruct;
90  
91                                  /* conversion package functions */
146 – #ifdef  NOPROTO
92   struct tmPackage {
93 <        MEM_PTR         (*Init)();      /* initialize private data */
94 <        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);
93 >        MEM_PTR         (*Init)(TMstruct *tms);
94 >        void            (*NewSpace)(TMstruct *tms);
95          void            (*Free)(MEM_PTR pp);
96   };
158 – #endif
97                                  /* our list of conversion packages */
98   extern struct tmPackage *tmPkg[TM_MAXPKG];
99   extern int      tmNumPkgs;      /* number of registered packages */
# Line 179 | Line 117 | extern int     tmNumPkgs;      /* number of registered packages
117  
118   /****    Library Function Calls    ****/
119  
182 – #ifdef  NOPROTO
120  
121 < extern struct tmStruct  *tmInit(), *tmPop(), *tmDup();
185 < extern int      tmSetSpace(), tmPull(), tmPush();
186 < extern void     tmClearHisto(), tmDone();
187 < extern int      tmAddHisto();
188 < extern int      tmFixedMapping(), tmComputeMapping(), tmMapPixels();
189 < extern int      tmCvColors(), tmCvGrays(), tmCvColrs();
190 < extern int      tmLoadPicture(), tmMapPicture();
191 <
192 < #else
193 <
194 < extern struct tmStruct *
121 > extern TMstruct *
122   tmInit(int flags, RGBPRIMP monpri, double gamval);
123   /*
124 <        Initialize new tone mapping and push it onto stack.
124 >        Allocate and initialize new tone mapping.
125  
126          flags   -       TM_F_* flags indicating what is to be done.
127          monpri  -       display monitor primaries (Note 1).
128          gamval  -       display gamma response (can be approximate).
129  
130 <        returns -       new tmTop, or NULL if insufficient memory.
130 >        returns -       new tone-mapping pointer, or NULL if no memory.
131   */
132  
133   extern int
134 < tmSetSpace(RGBPRIMP pri, double sf);
134 > tmSetSpace(TMstruct *tms, RGBPRIMP pri, double sf);
135   /*
136          Set color primaries and scale factor for incoming scanlines.
137  
138 +        tms     -       tone mapping structure pointer.
139          pri     -       RGB color input primaries (Note 1).
140          sf      -       scale factor to get to luminance in cd/m^2.
141  
# Line 215 | Line 143 | tmSetSpace(RGBPRIMP pri, double sf);
143   */
144  
145   extern void
146 < tmClearHisto(void);
146 > tmClearHisto(TMstruct *tms);
147   /*
148          Clear histogram for current tone mapping.
149 +
150 +        tms     -       tone mapping structure pointer.
151   */
152  
153   extern int
154 < tmAddHisto(TMbright *ls, int len, int wt);
154 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
155   /*
156          Add brightness values to current histogram.
157  
158 +        tms     -       tone mapping structure pointer.
159          ls      -       encoded luminance values.
160          len     -       number of luminance values.
161          wt      -       integer weight to use for each value (usually 1 or -1).
# Line 233 | Line 164 | tmAddHisto(TMbright *ls, int len, int wt);
164   */
165  
166   extern int
167 < tmFixedMapping(double expmult, double gamval);
167 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
168   /*
169          Assign a fixed, linear tone-mapping using the given multiplier,
170          which is the ratio of maximum output to uncalibrated input.
# Line 241 | Line 172 | tmFixedMapping(double expmult, double gamval);
172          until a new tone mapping is computed.
173          Only the min. and max. values are used from the histogram.
174          
175 +        tms     -       tone mapping structure pointer.
176          expmult -       the fixed exposure multiplier to use.
177          gamval  -       display gamma response (0. for default).
178 +
179          returns -       0 on success, TM_E_* on error.
180   */
181  
182   extern int
183 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
183 > tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
184   /*
185          Compute tone mapping function from the current histogram.
186          This mapping will be used in subsequent calls to tmMapPixels()
187          until a new tone mapping is computed.
188          I.e., calls to tmAddHisto() have no immediate effect.
189  
190 +        tms     -       tone mapping structure pointer.
191          gamval  -       display gamma response (0. for default).
192          Lddyn   -       the display's dynamic range (0. for default).
193          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 262 | Line 196 | tmComputeMapping(double gamval, double Lddyn, double L
196   */
197  
198   extern int
199 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
199 > tmMapPixels(TMstruct *tms, BYTE *ps, TMbright *ls, BYTE *cs, int len);
200   /*
201          Apply tone mapping function to pixel values.
202  
203 +        tms     -       tone mapping structure pointer.
204          ps      -       returned pixel values (Note 2).
205          ls      -       encoded luminance values.
206          cs      -       encoded chrominance values (Note 2).
# Line 274 | Line 209 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
209          returns -       0 on success, TM_E_* on failure.
210   */
211  
212 < extern struct tmStruct *
213 < tmPop(void);
212 > extern TMstruct *
213 > tmDup(TMstruct *orig);
214   /*
215 <        Pops current tone mapping from stack.
215 >        Duplicate the given tone mapping into a new struct.
216  
217 <        returns -       pointer to tone mapping structure, or NULL if none.
283 < */
217 >        orig    -       tone mapping structure to duplicate.
218  
219 < 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.
219 >        returns -       pointer to new struct, or NULL on error.
220   */
221  
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 –
222   extern void
223 < tmDone(struct tmStruct *tms);
223 > tmDone(TMstruct *tms);
224   /*
225          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.
226  
227          tms     -       tone mapping structure to free.
228   */
229  
230   extern int
231 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
231 > tmCvColors(TMstruct *tms, TMbright *ls, BYTE *cs, COLOR *scan, int len);
232   /*
233          Convert RGB/XYZ float scanline to encoded luminance and chrominance.
234  
235 +        tms     -       tone mapping structure pointer.
236          ls      -       returned encoded luminance values.
237          cs      -       returned encoded chrominance values (Note 2).
238          scan    -       input scanline.
# Line 336 | Line 242 | tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int le
242   */
243  
244   extern int
245 < tmCvGrays(TMbright *ls, float *scan, int len);
245 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
246   /*
247          Convert gray float scanline to encoded luminance.
248  
249 +        tms     -       tone mapping structure pointer.
250          ls      -       returned encoded luminance values.
251          scan    -       input scanline.
252          len     -       scanline length.
# Line 348 | Line 255 | tmCvGrays(TMbright *ls, float *scan, int len);
255   */
256  
257   extern int
258 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
258 > tmCvColrs(TMstruct *tms, TMbright *ls, BYTE *cs, COLR *scan, int len);
259   /*
260          Convert RGBE/XYZE scanline to encoded luminance and chrominance.
261  
262 +        tms     -       tone mapping structure pointer.
263          ls      -       returned encoded luminance values.
264          cs      -       returned encoded chrominance values (Note 2).
265          scan    -       input scanline.
# Line 361 | Line 269 | tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len)
269   */
270  
271   extern int
272 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
272 > tmLoadPicture(TMstruct *tms, TMbright **lpp, BYTE **cpp, int *xp, int *yp,
273                  char *fname, FILE *fp);
274   /*
275          Load Radiance picture and convert to tone mapping representation.
# Line 369 | Line 277 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
277          malloc(3), and should be freed with free(3) when no longer needed.
278          Calls tmSetSpace() to calibrate input color space.
279  
280 +        tms     -       tone mapping structure pointer.
281          lpp     -       returned array of encoded luminances, picture ordering.
282          cpp     -       returned array of encoded chrominances (Note 2).
283          xp, yp  -       returned picture dimensions.
# Line 384 | Line 293 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
293                  char *fname, FILE *fp);
294   /*
295          Load and apply tone mapping to Radiance picture.
387 –        Stack is restored to its original state upon return.
296          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
297          calls pcond to perform the actual conversion, which takes
298          longer but gives access to all the TM_F_* features.
# Line 404 | Line 312 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
312          returns -       0 on success, TM_E_* on failure.
313   */
314  
315 < #endif
315 > extern int
316 > tmCvRGB48(TMstruct *tms, TMbright *ls, BYTE *cs, uint16 (*scan)[3],
317 >                int len, double gv);
318 > /*
319 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
320  
321 +        tms     -       tone mapping structure pointer.
322 +        ls      -       returned encoded luminance values.
323 +        cs      -       returned encoded chrominance values (Note 2).
324 +        scan    -       input scanline.
325 +        len     -       scanline length.
326 +        gv      -       input gamma value.
327  
328 +        returns -       0 on success, TM_E_* on error.
329 + */
330 +
331 + extern int
332 + tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
333 + /*
334 +        Convert 16-bit gray scanline to encoded luminance.
335 +
336 +        tms     -       tone mapping structure pointer.
337 +        ls      -       returned encoded luminance values.
338 +        scan    -       input scanline.
339 +        len     -       scanline length.
340 +        gv      -       input gamma value.
341 +
342 +        returns -       0 on success, TM_E_* on error.
343 + */
344 +
345   /****    Notes    ****/
346   /*
347          General:
# Line 481 | Line 416 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
416   #ifdef __cplusplus
417   }
418   #endif
419 + #endif /* _RAD_TONEMAP_H_ */
420 +

Diff Legend

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