1 |
< |
/* Copyright (c) 1997 Regents of the University of California */ |
2 |
< |
|
3 |
< |
/* SCCSid "$SunId$ LBL" */ |
4 |
< |
|
1 |
> |
/* RCSid $Id$ */ |
2 |
|
/* |
3 |
|
* Header file for tone mapping functions. |
4 |
+ |
* |
5 |
+ |
* Include after "color.h" |
6 |
|
*/ |
7 |
< |
/* required non-system header files */ |
8 |
< |
#include "color.h" |
7 |
> |
#ifndef _RAD_TONEMAP_H_ |
8 |
> |
#define _RAD_TONEMAP_H_ |
9 |
> |
#ifdef __cplusplus |
10 |
> |
extern "C" { |
11 |
> |
#endif |
12 |
|
|
13 |
+ |
|
14 |
+ |
#include "copyright.h" |
15 |
+ |
|
16 |
|
/**** Argument Macros ****/ |
17 |
|
/* Flags of what to do */ |
18 |
|
#define TM_F_HCONTR 01 /* human contrast sensitivity */ |
23 |
|
#define TM_F_CWEIGHT 040 /* center weighting */ |
24 |
|
#define TM_F_FOVEAL 0100 /* use foveal sample size */ |
25 |
|
#define TM_F_BW 0200 /* luminance only */ |
26 |
< |
#define TM_F_NOERRS 0400 /* don't report errors to stderr */ |
26 |
> |
#define TM_F_NOSTDERR 0400 /* don't report errors to stderr */ |
27 |
|
/* combined modes */ |
28 |
|
#define TM_F_CAMERA 0 |
29 |
|
#define TM_F_HUMAN (TM_F_HCONTR|TM_F_MESOPIC|TM_F_VEIL|\ |
36 |
|
#define TM_NOCHROMP (BYTE **)NULL /* indicate no chrominances */ |
37 |
|
#define TM_GETFILE (FILE *)NULL /* indicate file must be opened */ |
38 |
|
|
39 |
+ |
|
40 |
|
/**** Error Return Values ****/ |
41 |
|
|
42 |
|
#define TM_E_OK 0 /* normal return status */ |
45 |
|
#define TM_E_TMINVAL 3 /* no valid tone mapping */ |
46 |
|
#define TM_E_TMFAIL 4 /* cannot compute tone mapping */ |
47 |
|
#define TM_E_BADFILE 5 /* cannot open or understand file */ |
48 |
+ |
#define TM_E_CODERR1 6 /* code consistency error 1 */ |
49 |
+ |
#define TM_E_CODERR2 7 /* code consistency error 2 */ |
50 |
|
|
51 |
+ |
|
52 |
|
/**** Conversion Constants and Table Sizes ****/ |
53 |
|
|
54 |
|
#define TM_BRTSCALE 128 /* brightness scale factor (integer) */ |
55 |
|
|
56 |
< |
#define TM_GAMTSZ 1024 /* gamma lookup table size */ |
56 |
> |
#define TM_NOBRT (-1<<15) /* bogus brightness value */ |
57 |
> |
#define TM_NOLUM (1e-17) /* ridiculously small luminance */ |
58 |
|
|
59 |
< |
/**** Global Data Structures ****/ |
59 |
> |
#define TM_MAXPKG 8 /* maximum number of color formats */ |
60 |
|
|
61 |
+ |
|
62 |
+ |
/**** Global Data Types and Structures ****/ |
63 |
+ |
|
64 |
+ |
#ifndef MEM_PTR |
65 |
+ |
#define MEM_PTR void * |
66 |
+ |
#endif |
67 |
+ |
|
68 |
|
extern char *tmErrorMessage[]; /* error messages */ |
69 |
+ |
extern int tmLastError; /* last error incurred by library */ |
70 |
+ |
extern char *tmLastFunction; /* error-generating function name */ |
71 |
|
|
72 |
|
typedef short TMbright; /* encoded luminance type */ |
73 |
|
|
76 |
|
int flags; /* flags of what to do */ |
77 |
|
RGBPRIMP monpri; /* monitor RGB primaries */ |
78 |
|
double mongam; /* monitor gamma value (approx.) */ |
60 |
– |
BYTE gamb[TM_GAMTSZ];/* gamma lookup table from mongam */ |
79 |
|
COLOR clf; /* computed luminance coefficients */ |
80 |
< |
COLR clfb; /* normalized version of clf */ |
80 |
> |
int cdiv[3]; /* computed color divisors */ |
81 |
|
RGBPRIMP inppri; /* current input primaries */ |
82 |
|
double inpsf; /* current input scalefactor */ |
65 |
– |
TMbright inpsfb; /* encoded version of inpsf */ |
83 |
|
COLORMAT cmat; /* color conversion matrix */ |
84 |
< |
TMbright brmin, brmax; /* input brightness limits */ |
84 |
> |
TMbright hbrmin, hbrmax; /* histogram brightness limits */ |
85 |
|
int *histo; /* input histogram */ |
86 |
+ |
TMbright mbrmin, mbrmax; /* mapped brightness limits */ |
87 |
|
unsigned short *lumap; /* computed luminance map */ |
88 |
|
struct tmStruct *tmprev; /* previous tone mapping */ |
89 |
+ |
MEM_PTR pd[TM_MAXPKG]; /* pointers to private data */ |
90 |
|
} *tmTop; /* current tone mapping stack */ |
91 |
< |
|
91 |
> |
|
92 |
> |
/* conversion package functions */ |
93 |
> |
struct tmPackage { |
94 |
> |
MEM_PTR (*Init)(struct tmStruct *tms); |
95 |
> |
void (*NewSpace)(struct tmStruct *tms); |
96 |
> |
void (*Free)(MEM_PTR pp); |
97 |
> |
}; |
98 |
> |
/* our list of conversion packages */ |
99 |
> |
extern struct tmPackage *tmPkg[TM_MAXPKG]; |
100 |
> |
extern int tmNumPkgs; /* number of registered packages */ |
101 |
> |
|
102 |
> |
|
103 |
|
/**** Useful Macros ****/ |
104 |
|
|
105 |
< |
#define tmLuminance(li) exp((li)/(double)TM_BRTSCALE) |
105 |
> |
/* compute luminance from encoded value */ |
106 |
> |
#define tmLuminance(li) exp((li)*(1./TM_BRTSCALE)) |
107 |
|
|
108 |
< |
/**** Library Function Calls ****/ |
108 |
> |
/* does tone mapping need color matrix? */ |
109 |
> |
#define tmNeedMatrix(t) ((t)->monpri != (t)->inppri) |
110 |
|
|
111 |
< |
#ifdef NOPROTO |
111 |
> |
/* register a conversion package */ |
112 |
> |
#define tmRegPkg(pf) ( tmNumPkgs >= TM_MAXPKG ? -1 : \ |
113 |
> |
(tmPkg[tmNumPkgs] = (pf), tmNumPkgs++) ) |
114 |
|
|
115 |
< |
extern struct tmStruct *tmInit(), *tmPop(); |
116 |
< |
extern void tmClearHisto(), tmDone(); |
83 |
< |
extern int tmSetSpace(), tmCvColors(), tmCvColrs(); |
84 |
< |
extern int tmAddHisto(), tmComputeMapping(), tmMapPixels(); |
85 |
< |
extern int tmLoadPicture(), tmMapPicture(), tmPull(), tmPush(); |
115 |
> |
/* get the specific package's data */ |
116 |
> |
#define tmPkgData(t,i) ((t)->pd[i]!=NULL ? (t)->pd[i] : (*tmPkg[i]->Init)(t)) |
117 |
|
|
87 |
– |
#else |
118 |
|
|
119 |
+ |
/**** Library Function Calls ****/ |
120 |
+ |
|
121 |
+ |
|
122 |
|
extern struct tmStruct * |
123 |
|
tmInit(int flags, RGBPRIMP monpri, double gamval); |
124 |
|
/* |
149 |
|
*/ |
150 |
|
|
151 |
|
extern int |
119 |
– |
tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len); |
120 |
– |
/* |
121 |
– |
Convert RGB/XYZ float scanline to encoded luminance and chrominance. |
122 |
– |
|
123 |
– |
ls - returned encoded luminance values. |
124 |
– |
cs - returned encoded chrominance values (Note 2). |
125 |
– |
scan - input scanline. |
126 |
– |
len - scanline length. |
127 |
– |
|
128 |
– |
returns - 0 on success, TM_E_* on error. |
129 |
– |
*/ |
130 |
– |
|
131 |
– |
extern int |
132 |
– |
tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len); |
133 |
– |
/* |
134 |
– |
Convert RGBE/XYZE scanline to encoded luminance and chrominance. |
135 |
– |
|
136 |
– |
ls - returned encoded luminance values. |
137 |
– |
cs - returned encoded chrominance values (Note 2). |
138 |
– |
scan - input scanline. |
139 |
– |
len - scanline length. |
140 |
– |
|
141 |
– |
returns - 0 on success, TM_E_* on error. |
142 |
– |
*/ |
143 |
– |
|
144 |
– |
extern int |
152 |
|
tmAddHisto(TMbright *ls, int len, int wt); |
153 |
|
/* |
154 |
|
Add brightness values to current histogram. |
161 |
|
*/ |
162 |
|
|
163 |
|
extern int |
164 |
+ |
tmFixedMapping(double expmult, double gamval); |
165 |
+ |
/* |
166 |
+ |
Assign a fixed, linear tone-mapping using the given multiplier, |
167 |
+ |
which is the ratio of maximum output to uncalibrated input. |
168 |
+ |
This mapping will be used in subsequent calls to tmMapPixels() |
169 |
+ |
until a new tone mapping is computed. |
170 |
+ |
Only the min. and max. values are used from the histogram. |
171 |
+ |
|
172 |
+ |
expmult - the fixed exposure multiplier to use. |
173 |
+ |
gamval - display gamma response (0. for default). |
174 |
+ |
returns - 0 on success, TM_E_* on error. |
175 |
+ |
*/ |
176 |
+ |
|
177 |
+ |
extern int |
178 |
|
tmComputeMapping(double gamval, double Lddyn, double Ldmax); |
179 |
|
/* |
180 |
< |
Compute tone mapping function. |
180 |
> |
Compute tone mapping function from the current histogram. |
181 |
> |
This mapping will be used in subsequent calls to tmMapPixels() |
182 |
> |
until a new tone mapping is computed. |
183 |
> |
I.e., calls to tmAddHisto() have no immediate effect. |
184 |
|
|
185 |
|
gamval - display gamma response (0. for default). |
186 |
|
Lddyn - the display's dynamic range (0. for default). |
202 |
|
returns - 0 on success, TM_E_* on failure. |
203 |
|
*/ |
204 |
|
|
181 |
– |
extern int |
182 |
– |
tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp, |
183 |
– |
char *fname, FILE *fp); |
184 |
– |
/* |
185 |
– |
Load Radiance picture and convert to tone mapping representation. |
186 |
– |
|
187 |
– |
lpp - returned array of encoded luminances, English ordering. |
188 |
– |
cpp - returned array of encoded chrominances (Note 2). |
189 |
– |
xp, yp - returned picture dimensions. |
190 |
– |
fname - picture file name. |
191 |
– |
fp - pointer to open file (Note 3). |
192 |
– |
|
193 |
– |
returns - 0 on success, TM_E_* on failure. |
194 |
– |
*/ |
195 |
– |
|
196 |
– |
extern int |
197 |
– |
tmMapPicture(BYTE **psp, int *xp, int *yp, int flags, |
198 |
– |
RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax, |
199 |
– |
char *fname, FILE *fp); |
200 |
– |
/* |
201 |
– |
Load and apply tone mapping to Radiance picture. |
202 |
– |
Stack is restored to its original state upon return. |
203 |
– |
If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture() |
204 |
– |
calls pcond to perform the actual conversion, which takes |
205 |
– |
longer but gives access to all the TM_F_* features. |
206 |
– |
|
207 |
– |
psp - returned array of tone mapped pixels, English ordering. |
208 |
– |
xp, yp - returned picture dimensions. |
209 |
– |
flags - TM_F_* flags indicating what is to be done. |
210 |
– |
monpri - display monitor primaries (Note 1). |
211 |
– |
gamval - display gamma response. |
212 |
– |
Lddyn - the display's dynamic range (0. for default). |
213 |
– |
Ldmax - maximum display luminance in cd/m^2 (0. for default). |
214 |
– |
fname - picture file name. |
215 |
– |
fp - pointer to open file (Note 3). |
216 |
– |
|
217 |
– |
returns - 0 on success, TM_E_* on failure. |
218 |
– |
*/ |
219 |
– |
|
205 |
|
extern struct tmStruct * |
206 |
|
tmPop(void); |
207 |
|
/* |
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 |
+ |
|
241 |
|
extern void |
242 |
|
tmDone(struct tmStruct *tms); |
243 |
|
/* |
250 |
|
tms - tone mapping structure to free. |
251 |
|
*/ |
252 |
|
|
253 |
< |
#endif |
254 |
< |
|
253 |
> |
extern int |
254 |
> |
tmCvColors(TMbright *ls, BYTE *cs, COLOR *scan, int len); |
255 |
> |
/* |
256 |
> |
Convert RGB/XYZ float scanline to encoded luminance and chrominance. |
257 |
> |
|
258 |
> |
ls - returned encoded luminance values. |
259 |
> |
cs - returned encoded chrominance values (Note 2). |
260 |
> |
scan - input scanline. |
261 |
> |
len - scanline length. |
262 |
> |
|
263 |
> |
returns - 0 on success, TM_E_* on error. |
264 |
> |
*/ |
265 |
> |
|
266 |
> |
extern int |
267 |
> |
tmCvGrays(TMbright *ls, float *scan, int len); |
268 |
> |
/* |
269 |
> |
Convert gray float scanline to encoded luminance. |
270 |
> |
|
271 |
> |
ls - returned encoded luminance values. |
272 |
> |
scan - input scanline. |
273 |
> |
len - scanline length. |
274 |
> |
|
275 |
> |
returns - 0 on success, TM_E_* on error. |
276 |
> |
*/ |
277 |
> |
|
278 |
> |
extern int |
279 |
> |
tmCvColrs(TMbright *ls, BYTE *cs, COLR *scan, int len); |
280 |
> |
/* |
281 |
> |
Convert RGBE/XYZE scanline to encoded luminance and chrominance. |
282 |
> |
|
283 |
> |
ls - returned encoded luminance values. |
284 |
> |
cs - returned encoded chrominance values (Note 2). |
285 |
> |
scan - input scanline. |
286 |
> |
len - scanline length. |
287 |
> |
|
288 |
> |
returns - 0 on success, TM_E_* on error. |
289 |
> |
*/ |
290 |
> |
|
291 |
> |
extern int |
292 |
> |
tmLoadPicture(TMbright **lpp, BYTE **cpp, int *xp, int *yp, |
293 |
> |
char *fname, FILE *fp); |
294 |
> |
/* |
295 |
> |
Load Radiance picture and convert to tone mapping representation. |
296 |
> |
Memory for the luminance and chroma arrays is allocated using |
297 |
> |
malloc(3), and should be freed with free(3) when no longer needed. |
298 |
> |
Calls tmSetSpace() to calibrate input color space. |
299 |
> |
|
300 |
> |
lpp - returned array of encoded luminances, picture ordering. |
301 |
> |
cpp - returned array of encoded chrominances (Note 2). |
302 |
> |
xp, yp - returned picture dimensions. |
303 |
> |
fname - picture file name. |
304 |
> |
fp - pointer to open file (Note 3). |
305 |
> |
|
306 |
> |
returns - 0 on success, TM_E_* on failure. |
307 |
> |
*/ |
308 |
> |
|
309 |
> |
extern int |
310 |
> |
tmMapPicture(BYTE **psp, int *xp, int *yp, int flags, |
311 |
> |
RGBPRIMP monpri, double gamval, double Lddyn, double Ldmax, |
312 |
> |
char *fname, FILE *fp); |
313 |
> |
/* |
314 |
> |
Load and apply tone mapping to Radiance picture. |
315 |
> |
Stack is restored to its original state upon return. |
316 |
> |
If fp is TM_GETFILE and (flags&TM_F_UNIMPL)!=0, tmMapPicture() |
317 |
> |
calls pcond to perform the actual conversion, which takes |
318 |
> |
longer but gives access to all the TM_F_* features. |
319 |
> |
Memory for the final pixel array is allocated using malloc(3), |
320 |
> |
and should be freed with free(3) when it is no longer needed. |
321 |
> |
|
322 |
> |
psp - returned array of tone mapped pixels, picture ordering. |
323 |
> |
xp, yp - returned picture dimensions. |
324 |
> |
flags - TM_F_* flags indicating what is to be done. |
325 |
> |
monpri - display monitor primaries (Note 1). |
326 |
> |
gamval - display gamma response. |
327 |
> |
Lddyn - the display's dynamic range (0. for default). |
328 |
> |
Ldmax - maximum display luminance in cd/m^2 (0. for default). |
329 |
> |
fname - picture file name. |
330 |
> |
fp - pointer to open file (Note 3). |
331 |
> |
|
332 |
> |
returns - 0 on success, TM_E_* on failure. |
333 |
> |
*/ |
334 |
> |
|
335 |
> |
|
336 |
> |
|
337 |
|
/**** Notes ****/ |
338 |
|
/* |
339 |
|
General: |
342 |
|
pixel values to chroma and luminance encodings, which can |
343 |
|
be passed to tmAddHisto() to put into the tone mapping histogram. |
344 |
|
This histogram is then used along with the display parameters |
345 |
< |
by tmComputMapping() to compute the luminance mapping function. |
345 |
> |
by tmComputeMapping() to compute the luminance mapping function. |
346 |
|
(Colors are tone-mapped as they are converted if TM_F_MESOPIC |
347 |
|
is set.) The encoded chroma and luminance values may then be |
348 |
|
passed to tmMapPixels() to apply the computed tone mapping in |
355 |
|
used during final mapping, setting the cs parameter to TM_NOCHROM |
356 |
|
on the first pass will save time.) Another memory saving option |
357 |
|
if third and subsequent passes are not needed is to use the |
358 |
< |
same array to store the mapped pixels as is used to store |
358 |
> |
same array to store the mapped pixels as used to store |
359 |
|
the encoded chroma values. This way, only two extra bytes |
360 |
|
for storing encoded luminances are required per pixel. This |
361 |
|
is the method employed by tmMapPicture(), for example. |
404 |
|
function will open the file, read its contents and close it |
405 |
|
before returning, whether or not an error was encountered. |
406 |
|
*/ |
407 |
+ |
|
408 |
+ |
#ifdef __cplusplus |
409 |
+ |
} |
410 |
+ |
#endif |
411 |
+ |
#endif /* _RAD_TONEMAP_H_ */ |
412 |
+ |
|