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