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.20 by greg, Mon Nov 14 22:18:18 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" {
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  
182 – #ifdef  NOPROTO
121  
122 < 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 *
122 > extern TMstruct *
123   tmInit(int flags, RGBPRIMP monpri, double gamval);
124   /*
125 <        Initialize new tone mapping and push it onto stack.
125 >        Allocate and initialize new tone mapping.
126  
127          flags   -       TM_F_* flags indicating what is to be done.
128          monpri  -       display monitor primaries (Note 1).
129          gamval  -       display gamma response (can be approximate).
130  
131 <        returns -       new tmTop, or NULL if insufficient memory.
131 >        returns -       new tone-mapping pointer, or NULL if no memory.
132   */
133  
134   extern int
135 < tmSetSpace(RGBPRIMP pri, double sf);
135 > tmSetSpace(TMstruct *tms, RGBPRIMP pri, double sf, MEM_PTR dat);
136   /*
137          Set color primaries and scale factor for incoming scanlines.
138  
139 +        tms     -       tone mapping structure pointer.
140          pri     -       RGB color input primaries (Note 1).
141          sf      -       scale factor to get to luminance in cd/m^2.
142 +        dat     -       application-specific data (NULL if not needed)
143  
144          returns -       0 on success, TM_E_* code on failure.
145   */
146  
147   extern void
148 < tmClearHisto(void);
148 > tmClearHisto(TMstruct *tms);
149   /*
150          Clear histogram for current tone mapping.
151 +
152 +        tms     -       tone mapping structure pointer.
153   */
154  
155   extern int
156 < tmAddHisto(TMbright *ls, int len, int wt);
156 > tmAddHisto(TMstruct *tms, TMbright *ls, int len, int wt);
157   /*
158          Add brightness values to current histogram.
159  
160 +        tms     -       tone mapping structure pointer.
161          ls      -       encoded luminance values.
162          len     -       number of luminance values.
163          wt      -       integer weight to use for each value (usually 1 or -1).
# Line 233 | Line 166 | tmAddHisto(TMbright *ls, int len, int wt);
166   */
167  
168   extern int
169 < tmFixedMapping(double expmult, double gamval);
169 > tmFixedMapping(TMstruct *tms, double expmult, double gamval);
170   /*
171          Assign a fixed, linear tone-mapping using the given multiplier,
172          which is the ratio of maximum output to uncalibrated input.
# Line 241 | Line 174 | tmFixedMapping(double expmult, double gamval);
174          until a new tone mapping is computed.
175          Only the min. and max. values are used from the histogram.
176          
177 +        tms     -       tone mapping structure pointer.
178          expmult -       the fixed exposure multiplier to use.
179          gamval  -       display gamma response (0. for default).
180 +
181          returns -       0 on success, TM_E_* on error.
182   */
183  
184   extern int
185 < tmComputeMapping(double gamval, double Lddyn, double Ldmax);
185 > tmComputeMapping(TMstruct *tms, double gamval, double Lddyn, double Ldmax);
186   /*
187          Compute tone mapping function from the current histogram.
188          This mapping will be used in subsequent calls to tmMapPixels()
189          until a new tone mapping is computed.
190          I.e., calls to tmAddHisto() have no immediate effect.
191  
192 +        tms     -       tone mapping structure pointer.
193          gamval  -       display gamma response (0. for default).
194          Lddyn   -       the display's dynamic range (0. for default).
195          Ldmax   -       maximum display luminance in cd/m^2 (0. for default).
# Line 262 | Line 198 | tmComputeMapping(double gamval, double Lddyn, double L
198   */
199  
200   extern int
201 < tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len);
201 > tmMapPixels(TMstruct *tms, BYTE *ps, TMbright *ls, BYTE *cs, int len);
202   /*
203          Apply tone mapping function to pixel values.
204  
205 +        tms     -       tone mapping structure pointer.
206          ps      -       returned pixel values (Note 2).
207          ls      -       encoded luminance values.
208          cs      -       encoded chrominance values (Note 2).
# Line 274 | Line 211 | tmMapPixels(BYTE *ps, TMbright *ls, BYTE *cs, int len)
211          returns -       0 on success, TM_E_* on failure.
212   */
213  
214 < extern struct tmStruct *
215 < tmPop(void);
214 > extern TMstruct *
215 > tmDup(TMstruct *orig);
216   /*
217 <        Pops current tone mapping from stack.
217 >        Duplicate the given tone mapping into a new struct.
218  
219 <        returns -       pointer to tone mapping structure, or NULL if none.
283 < */
219 >        orig    -       tone mapping structure to duplicate.
220  
221 < 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.
221 >        returns -       pointer to new struct, or NULL on error.
222   */
223  
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 –
224   extern void
225 < tmDone(struct tmStruct *tms);
225 > tmDone(TMstruct *tms);
226   /*
227          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.
228  
229          tms     -       tone mapping structure to free.
230   */
231  
232   extern int
233 < tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len);
233 > tmCvColors(TMstruct *tms, TMbright *ls, BYTE *cs, COLOR *scan, int len);
234   /*
235          Convert RGB/XYZ float scanline to encoded luminance and chrominance.
236  
237 +        tms     -       tone mapping structure pointer.
238          ls      -       returned encoded luminance values.
239          cs      -       returned encoded chrominance values (Note 2).
240          scan    -       input scanline.
# Line 336 | Line 244 | tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int le
244   */
245  
246   extern int
247 < tmCvGrays(TMbright *ls, float *scan, int len);
247 > tmCvGrays(TMstruct *tms, TMbright *ls, float *scan, int len);
248   /*
249          Convert gray float scanline to encoded luminance.
250  
251 +        tms     -       tone mapping structure pointer.
252          ls      -       returned encoded luminance values.
253          scan    -       input scanline.
254          len     -       scanline length.
# Line 348 | Line 257 | tmCvGrays(TMbright *ls, float *scan, int len);
257   */
258  
259   extern int
260 < tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len);
260 > tmCvColrs(TMstruct *tms, TMbright *ls, BYTE *cs, COLR *scan, int len);
261   /*
262          Convert RGBE/XYZE scanline to encoded luminance and chrominance.
263  
264 +        tms     -       tone mapping structure pointer.
265          ls      -       returned encoded luminance values.
266          cs      -       returned encoded chrominance values (Note 2).
267          scan    -       input scanline.
# Line 361 | Line 271 | tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len)
271   */
272  
273   extern int
274 < tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp,
274 > tmLoadPicture(TMstruct *tms, TMbright **lpp, BYTE **cpp, int *xp, int *yp,
275                  char *fname, FILE *fp);
276   /*
277          Load Radiance picture and convert to tone mapping representation.
# Line 369 | Line 279 | tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int
279          malloc(3), and should be freed with free(3) when no longer needed.
280          Calls tmSetSpace() to calibrate input color space.
281  
282 +        tms     -       tone mapping structure pointer.
283          lpp     -       returned array of encoded luminances, picture ordering.
284          cpp     -       returned array of encoded chrominances (Note 2).
285          xp, yp  -       returned picture dimensions.
# Line 384 | Line 295 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
295                  char *fname, FILE *fp);
296   /*
297          Load and apply tone mapping to Radiance picture.
387 –        Stack is restored to its original state upon return.
298          If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture()
299          calls pcond to perform the actual conversion, which takes
300          longer but gives access to all the TM_F_* features.
# Line 404 | Line 314 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
314          returns -       0 on success, TM_E_* on failure.
315   */
316  
317 < #endif
317 > extern int
318 > tmCvRGB48(TMstruct *tms, TMbright *ls, BYTE *cs, uint16 (*scan)[3],
319 >                int len, double gv);
320 > /*
321 >        Convert 48-bit RGB scanline to encoded luminance and chrominance.
322  
323 +        tms     -       tone mapping structure pointer.
324 +        ls      -       returned encoded luminance values.
325 +        cs      -       returned encoded chrominance values (Note 2).
326 +        scan    -       input scanline.
327 +        len     -       scanline length.
328 +        gv      -       input gamma value.
329  
330 +        returns -       0 on success, TM_E_* on error.
331 + */
332 +
333 + extern int
334 + tmCvGray16(TMstruct *tms, TMbright *ls, uint16 *scan, int len, double gv);
335 + /*
336 +        Convert 16-bit gray scanline to encoded luminance.
337 +
338 +        tms     -       tone mapping structure pointer.
339 +        ls      -       returned encoded luminance values.
340 +        scan    -       input scanline.
341 +        len     -       scanline length.
342 +        gv      -       input gamma value.
343 +
344 +        returns -       0 on success, TM_E_* on error.
345 + */
346 +
347   /****    Notes    ****/
348   /*
349          General:
# Line 481 | Line 418 | tmMapPicture(BYTE **psp, int *xp, int *yp, int flags,
418   #ifdef __cplusplus
419   }
420   #endif
421 + #endif /* _RAD_TONEMAP_H_ */
422 +

Diff Legend

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