Imported Upstream version 2.4
[platform/upstream/lcms2.git] / src / cmsgamma.c
1 //---------------------------------------------------------------------------------
2 //
3 //  Little Color Management System
4 //  Copyright (c) 1998-2012 Marti Maria Saguer
5 //
6 // Permission is hereby granted, free of charge, to any person obtaining
7 // a copy of this software and associated documentation files (the "Software"),
8 // to deal in the Software without restriction, including without limitation
9 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 // and/or sell copies of the Software, and to permit persons to whom the Software
11 // is furnished to do so, subject to the following conditions:
12 //
13 // The above copyright notice and this permission notice shall be included in
14 // all copies or substantial portions of the Software.
15 //
16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
18 // THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 //
24 //---------------------------------------------------------------------------------
25 //
26 #include "lcms2_internal.h"
27
28 // Tone curves are powerful constructs that can contain curves specified in diverse ways.
29 // The curve is stored in segments, where each segment can be sampled or specified by parameters.
30 // a 16.bit simplification of the *whole* curve is kept for optimization purposes. For float operation,
31 // each segment is evaluated separately. Plug-ins may be used to define new parametric schemes,
32 // each plug-in may define up to MAX_TYPES_IN_LCMS_PLUGIN functions types. For defining a function,
33 // the plug-in should provide the type id, how many parameters each type has, and a pointer to
34 // a procedure that evaluates the function. In the case of reverse evaluation, the evaluator will
35 // be called with the type id as a negative value, and a sampled version of the reversed curve
36 // will be built.
37
38 // ----------------------------------------------------------------- Implementation
39 // Maxim number of nodes
40 #define MAX_NODES_IN_CURVE   4097
41 #define MINUS_INF            (-1E22F)
42 #define PLUS_INF             (+1E22F)
43
44 // The list of supported parametric curves
45 typedef struct _cmsParametricCurvesCollection_st {
46
47     int nFunctions;                                     // Number of supported functions in this chunk
48     int FunctionTypes[MAX_TYPES_IN_LCMS_PLUGIN];        // The identification types
49     int ParameterCount[MAX_TYPES_IN_LCMS_PLUGIN];       // Number of parameters for each function
50     cmsParametricCurveEvaluator    Evaluator;           // The evaluator
51
52     struct _cmsParametricCurvesCollection_st* Next; // Next in list
53
54 } _cmsParametricCurvesCollection;
55
56
57 // This is the default (built-in) evaluator
58 static cmsFloat64Number DefaultEvalParametricFn(cmsInt32Number Type, const cmsFloat64Number Params[], cmsFloat64Number R);
59
60 // The built-in list
61 static _cmsParametricCurvesCollection DefaultCurves = {
62     9,                                  // # of curve types
63     { 1, 2, 3, 4, 5, 6, 7, 8, 108 },    // Parametric curve ID
64     { 1, 3, 4, 5, 7, 4, 5, 5, 1 },      // Parameters by type
65     DefaultEvalParametricFn,            // Evaluator
66     NULL                                // Next in chain
67 };
68
69 // The linked list head
70 static _cmsParametricCurvesCollection* ParametricCurves = &DefaultCurves;
71
72 // As a way to install new parametric curves
73 cmsBool _cmsRegisterParametricCurvesPlugin(cmsPluginBase* Data)
74 {
75     cmsPluginParametricCurves* Plugin = (cmsPluginParametricCurves*) Data;
76     _cmsParametricCurvesCollection* fl;
77
78     if (Data == NULL) {
79
80           ParametricCurves =  &DefaultCurves;
81           return TRUE;
82     }
83
84     fl = (_cmsParametricCurvesCollection*) _cmsPluginMalloc(sizeof(_cmsParametricCurvesCollection));
85     if (fl == NULL) return FALSE;
86
87     // Copy the parameters
88     fl ->Evaluator  = Plugin ->Evaluator;
89     fl ->nFunctions = Plugin ->nFunctions;
90
91     // Make sure no mem overwrites
92     if (fl ->nFunctions > MAX_TYPES_IN_LCMS_PLUGIN)
93         fl ->nFunctions = MAX_TYPES_IN_LCMS_PLUGIN;
94
95     // Copy the data
96     memmove(fl->FunctionTypes,  Plugin ->FunctionTypes,   fl->nFunctions * sizeof(cmsUInt32Number));
97     memmove(fl->ParameterCount, Plugin ->ParameterCount,  fl->nFunctions * sizeof(cmsUInt32Number));
98
99     // Keep linked list
100     fl ->Next = ParametricCurves;
101     ParametricCurves = fl;
102
103     // All is ok
104     return TRUE;
105 }
106
107
108 // Search in type list, return position or -1 if not found
109 static
110 int IsInSet(int Type, _cmsParametricCurvesCollection* c)
111 {
112     int i;
113
114     for (i=0; i < c ->nFunctions; i++)
115         if (abs(Type) == c ->FunctionTypes[i]) return i;
116
117     return -1;
118 }
119
120
121 // Search for the collection which contains a specific type
122 static
123 _cmsParametricCurvesCollection *GetParametricCurveByType(int Type, int* index)
124 {
125     _cmsParametricCurvesCollection* c;
126     int Position;
127
128     for (c = ParametricCurves; c != NULL; c = c ->Next) {
129
130         Position = IsInSet(Type, c);
131
132         if (Position != -1) {
133             if (index != NULL)
134                 *index = Position;
135             return c;
136         }
137     }
138
139     return NULL;
140 }
141
142 // Low level allocate, which takes care of memory details. nEntries may be zero, and in this case
143 // no optimation curve is computed. nSegments may also be zero in the inverse case, where only the
144 // optimization curve is given. Both features simultaneously is an error
145 static
146 cmsToneCurve* AllocateToneCurveStruct(cmsContext ContextID, cmsInt32Number nEntries,
147                                       cmsInt32Number nSegments, const cmsCurveSegment* Segments,
148                                       const cmsUInt16Number* Values)
149 {
150     cmsToneCurve* p;
151     int i;
152
153     // We allow huge tables, which are then restricted for smoothing operations
154     if (nEntries > 65530 || nEntries < 0) {
155         cmsSignalError(ContextID, cmsERROR_RANGE, "Couldn't create tone curve of more than 65530 entries");
156         return NULL;
157     }
158
159     if (nEntries <= 0 && nSegments <= 0) {
160         cmsSignalError(ContextID, cmsERROR_RANGE, "Couldn't create tone curve with zero segments and no table");
161         return NULL;
162     }
163
164     // Allocate all required pointers, etc.
165     p = (cmsToneCurve*) _cmsMallocZero(ContextID, sizeof(cmsToneCurve));
166     if (!p) return NULL;
167
168     // In this case, there are no segments
169     if (nSegments <= 0) {
170         p ->Segments = NULL;
171         p ->Evals = NULL;
172     }
173     else {
174         p ->Segments = (cmsCurveSegment*) _cmsCalloc(ContextID, nSegments, sizeof(cmsCurveSegment));
175         if (p ->Segments == NULL) goto Error;
176
177         p ->Evals    = (cmsParametricCurveEvaluator*) _cmsCalloc(ContextID, nSegments, sizeof(cmsParametricCurveEvaluator));
178         if (p ->Evals == NULL) goto Error;
179     }
180
181     p -> nSegments = nSegments;
182
183     // This 16-bit table contains a limited precision representation of the whole curve and is kept for
184     // increasing xput on certain operations.
185     if (nEntries <= 0) {
186         p ->Table16 = NULL;
187     }
188     else {
189        p ->Table16 = (cmsUInt16Number*)  _cmsCalloc(ContextID, nEntries, sizeof(cmsUInt16Number));
190        if (p ->Table16 == NULL) goto Error;
191     }
192
193     p -> nEntries  = nEntries;
194
195     // Initialize members if requested
196     if (Values != NULL && (nEntries > 0)) {
197
198         for (i=0; i < nEntries; i++)
199             p ->Table16[i] = Values[i];
200     }
201
202     // Initialize the segments stuff. The evaluator for each segment is located and a pointer to it
203     // is placed in advance to maximize performance.
204     if (Segments != NULL && (nSegments > 0)) {
205
206         _cmsParametricCurvesCollection *c;
207
208         p ->SegInterp = (cmsInterpParams**) _cmsCalloc(ContextID, nSegments, sizeof(cmsInterpParams*));
209         if (p ->SegInterp == NULL) goto Error;
210
211         for (i=0; i< nSegments; i++) {
212
213             // Type 0 is a special marker for table-based curves
214             if (Segments[i].Type == 0)
215                 p ->SegInterp[i] = _cmsComputeInterpParams(ContextID, Segments[i].nGridPoints, 1, 1, NULL, CMS_LERP_FLAGS_FLOAT);
216
217             memmove(&p ->Segments[i], &Segments[i], sizeof(cmsCurveSegment));
218
219             if (Segments[i].Type == 0 && Segments[i].SampledPoints != NULL)
220                 p ->Segments[i].SampledPoints = (cmsFloat32Number*) _cmsDupMem(ContextID, Segments[i].SampledPoints, sizeof(cmsFloat32Number) * Segments[i].nGridPoints);
221             else
222                 p ->Segments[i].SampledPoints = NULL;
223
224
225             c = GetParametricCurveByType(Segments[i].Type, NULL);
226             if (c != NULL)
227                     p ->Evals[i] = c ->Evaluator;
228         }
229     }
230
231     p ->InterpParams = _cmsComputeInterpParams(ContextID, p ->nEntries, 1, 1, p->Table16, CMS_LERP_FLAGS_16BITS);
232     return p;
233
234 Error:
235     if (p -> Segments) _cmsFree(ContextID, p ->Segments);
236     if (p -> Evals) _cmsFree(ContextID, p -> Evals);
237     if (p ->Table16) _cmsFree(ContextID, p ->Table16);
238     _cmsFree(ContextID, p);
239     return NULL;
240 }
241
242
243 // Parametric Fn using floating point
244 static
245 cmsFloat64Number DefaultEvalParametricFn(cmsInt32Number Type, const cmsFloat64Number Params[], cmsFloat64Number R)
246 {
247     cmsFloat64Number e, Val, disc;
248
249     switch (Type) {
250
251    // X = Y ^ Gamma
252     case 1:
253         if (R < 0) {
254
255             if (fabs(Params[0] - 1.0) < MATRIX_DET_TOLERANCE)
256                 Val = R;
257             else
258                 Val = 0;
259         }
260         else
261             Val = pow(R, Params[0]);
262         break;
263
264     // Type 1 Reversed: X = Y ^1/gamma
265     case -1:
266          if (R < 0) {
267
268             if (fabs(Params[0] - 1.0) < MATRIX_DET_TOLERANCE)
269                 Val = R;
270             else
271                 Val = 0;
272         }
273         else
274             Val = pow(R, 1/Params[0]);
275         break;
276
277     // CIE 122-1966
278     // Y = (aX + b)^Gamma  | X >= -b/a
279     // Y = 0               | else
280     case 2:
281         disc = -Params[2] / Params[1];
282
283         if (R >= disc ) {
284
285             e = Params[1]*R + Params[2];
286
287             if (e > 0)
288                 Val = pow(e, Params[0]);
289             else
290                 Val = 0;
291         }
292         else
293             Val = 0;
294         break;
295
296      // Type 2 Reversed
297      // X = (Y ^1/g  - b) / a
298      case -2:
299          if (R < 0)
300              Val = 0;
301          else
302              Val = (pow(R, 1.0/Params[0]) - Params[2]) / Params[1];
303
304          if (Val < 0)
305               Val = 0;
306          break;
307
308
309     // IEC 61966-3
310     // Y = (aX + b)^Gamma | X <= -b/a
311     // Y = c              | else
312     case 3:
313         disc = -Params[2] / Params[1];
314         if (disc < 0)
315             disc = 0;
316
317         if (R >= disc) {
318
319             e = Params[1]*R + Params[2];
320
321             if (e > 0)
322                 Val = pow(e, Params[0]) + Params[3];
323             else
324                 Val = 0;
325         }
326         else
327             Val = Params[3];
328         break;
329
330
331     // Type 3 reversed
332     // X=((Y-c)^1/g - b)/a      | (Y>=c)
333     // X=-b/a                   | (Y<c)
334     case -3:
335         if (R >= Params[3])  {
336
337             e = R - Params[3];
338
339             if (e > 0)
340                 Val = (pow(e, 1/Params[0]) - Params[2]) / Params[1];
341             else
342                 Val = 0;
343         }
344         else {
345             Val = -Params[2] / Params[1];
346         }
347         break;
348
349
350     // IEC 61966-2.1 (sRGB)
351     // Y = (aX + b)^Gamma | X >= d
352     // Y = cX             | X < d
353     case 4:
354         if (R >= Params[4]) {
355
356             e = Params[1]*R + Params[2];
357
358             if (e > 0)
359                 Val = pow(e, Params[0]);
360             else
361                 Val = 0;
362         }
363         else
364             Val = R * Params[3];
365         break;
366
367     // Type 4 reversed
368     // X=((Y^1/g-b)/a)    | Y >= (ad+b)^g
369     // X=Y/c              | Y< (ad+b)^g
370     case -4:
371         e = Params[1] * Params[4] + Params[2];
372         if (e < 0)
373             disc = 0;
374         else
375             disc = pow(e, Params[0]);
376
377         if (R >= disc) {
378
379             Val = (pow(R, 1.0/Params[0]) - Params[2]) / Params[1];
380         }
381         else {
382             Val = R / Params[3];
383         }
384         break;
385
386
387     // Y = (aX + b)^Gamma + e | X >= d
388     // Y = cX + f             | X < d
389     case 5:
390         if (R >= Params[4]) {
391
392             e = Params[1]*R + Params[2];
393
394             if (e > 0)
395                 Val = pow(e, Params[0]) + Params[5];
396             else
397                 Val = 0;
398         }
399         else
400             Val = R*Params[3] + Params[6];
401         break;
402
403
404     // Reversed type 5
405     // X=((Y-e)1/g-b)/a   | Y >=(ad+b)^g+e), cd+f
406     // X=(Y-f)/c          | else
407     case -5:
408
409         disc = Params[3] * Params[4] + Params[6];
410         if (R >= disc) {
411
412             e = R - Params[5];
413             if (e < 0)
414                 Val = 0;
415             else
416                 Val = (pow(e, 1.0/Params[0]) - Params[2]) / Params[1];
417         }
418         else {
419             Val = (R - Params[6]) / Params[3];
420         }
421         break;
422
423
424     // Types 6,7,8 comes from segmented curves as described in ICCSpecRevision_02_11_06_Float.pdf
425     // Type 6 is basically identical to type 5 without d
426
427     // Y = (a * X + b) ^ Gamma + c
428     case 6:
429         e = Params[1]*R + Params[2];
430
431         if (e < 0)
432             Val = 0;
433         else
434             Val = pow(e, Params[0]) + Params[3];
435         break;
436
437     // ((Y - c) ^1/Gamma - b) / a
438     case -6:
439         e = R - Params[3];
440         if (e < 0)
441             Val = 0;
442         else
443         Val = (pow(e, 1.0/Params[0]) - Params[2]) / Params[1];
444         break;
445
446
447     // Y = a * log (b * X^Gamma + c) + d
448     case 7:
449
450        e = Params[2] * pow(R, Params[0]) + Params[3];
451        if (e <= 0)
452            Val = 0;
453        else
454            Val = Params[1]*log10(e) + Params[4];
455        break;
456
457     // (Y - d) / a = log(b * X ^Gamma + c)
458     // pow(10, (Y-d) / a) = b * X ^Gamma + c
459     // pow((pow(10, (Y-d) / a) - c) / b, 1/g) = X
460     case -7:
461        Val = pow((pow(10.0, (R-Params[4]) / Params[1]) - Params[3]) / Params[2], 1.0 / Params[0]);
462        break;
463
464
465    //Y = a * b^(c*X+d) + e
466    case 8:
467        Val = (Params[0] * pow(Params[1], Params[2] * R + Params[3]) + Params[4]);
468        break;
469
470
471    // Y = (log((y-e) / a) / log(b) - d ) / c
472    // a=0, b=1, c=2, d=3, e=4,
473    case -8:
474
475        disc = R - Params[4];
476        if (disc < 0) Val = 0;
477        else
478            Val = (log(disc / Params[0]) / log(Params[1]) - Params[3]) / Params[2];
479        break;
480
481    // S-Shaped: (1 - (1-x)^1/g)^1/g
482    case 108:
483       Val = pow(1.0 - pow(1 - R, 1/Params[0]), 1/Params[0]);
484       break;
485
486     // y = (1 - (1-x)^1/g)^1/g
487     // y^g = (1 - (1-x)^1/g)
488     // 1 - y^g = (1-x)^1/g
489     // (1 - y^g)^g = 1 - x
490     // 1 - (1 - y^g)^g
491     case -108:
492         Val = 1 - pow(1 - pow(R, Params[0]), Params[0]);
493         break;
494
495     default:
496         // Unsupported parametric curve. Should never reach here
497         return 0;
498     }
499
500     return Val;
501 }
502
503 // Evaluate a segmented funtion for a single value. Return -1 if no valid segment found .
504 // If fn type is 0, perform an interpolation on the table
505 static
506 cmsFloat64Number EvalSegmentedFn(const cmsToneCurve *g, cmsFloat64Number R)
507 {
508     int i;
509
510     for (i = g ->nSegments-1; i >= 0 ; --i) {
511
512         // Check for domain
513         if ((R > g ->Segments[i].x0) && (R <= g ->Segments[i].x1)) {
514
515             // Type == 0 means segment is sampled
516             if (g ->Segments[i].Type == 0) {
517
518                 cmsFloat32Number R1 = (cmsFloat32Number) (R - g ->Segments[i].x0);
519                 cmsFloat32Number Out;
520
521                 // Setup the table (TODO: clean that)
522                 g ->SegInterp[i]-> Table = g ->Segments[i].SampledPoints;
523
524                 g ->SegInterp[i] -> Interpolation.LerpFloat(&R1, &Out, g ->SegInterp[i]);
525
526                 return Out;
527             }
528             else
529                 return g ->Evals[i](g->Segments[i].Type, g ->Segments[i].Params, R);
530         }
531     }
532
533     return MINUS_INF;
534 }
535
536 // Access to estimated low-res table
537 cmsUInt32Number CMSEXPORT cmsGetToneCurveEstimatedTableEntries(const cmsToneCurve* t)
538 {
539     _cmsAssert(t != NULL);
540     return t ->nEntries;
541 }
542
543 const cmsUInt16Number* CMSEXPORT cmsGetToneCurveEstimatedTable(const cmsToneCurve* t)
544 {
545     _cmsAssert(t != NULL);
546     return t ->Table16;
547 }
548
549
550 // Create an empty gamma curve, by using tables. This specifies only the limited-precision part, and leaves the
551 // floating point description empty.
552 cmsToneCurve* CMSEXPORT cmsBuildTabulatedToneCurve16(cmsContext ContextID, cmsInt32Number nEntries, const cmsUInt16Number Values[])
553 {
554     return AllocateToneCurveStruct(ContextID, nEntries, 0, NULL, Values);
555 }
556
557 static
558 int EntriesByGamma(cmsFloat64Number Gamma)
559 {
560     if (fabs(Gamma - 1.0) < 0.001) return 2;
561     return 4096;
562 }
563
564
565 // Create a segmented gamma, fill the table
566 cmsToneCurve* CMSEXPORT cmsBuildSegmentedToneCurve(cmsContext ContextID,
567                                                    cmsInt32Number nSegments, const cmsCurveSegment Segments[])
568 {
569     int i;
570     cmsFloat64Number R, Val;
571     cmsToneCurve* g;
572     int nGridPoints = 4096;
573
574     _cmsAssert(Segments != NULL);
575
576     // Optimizatin for identity curves.
577     if (nSegments == 1 && Segments[0].Type == 1) {
578
579         nGridPoints = EntriesByGamma(Segments[0].Params[0]);
580     }
581
582     g = AllocateToneCurveStruct(ContextID, nGridPoints, nSegments, Segments, NULL);
583     if (g == NULL) return NULL;
584
585     // Once we have the floating point version, we can approximate a 16 bit table of 4096 entries
586     // for performance reasons. This table would normally not be used except on 8/16 bits transforms.
587     for (i=0; i < nGridPoints; i++) {
588
589         R   = (cmsFloat64Number) i / (nGridPoints-1);
590
591         Val = EvalSegmentedFn(g, R);
592
593         // Round and saturate
594         g ->Table16[i] = _cmsQuickSaturateWord(Val * 65535.0);
595     }
596
597     return g;
598 }
599
600 // Use a segmented curve to store the floating point table
601 cmsToneCurve* CMSEXPORT cmsBuildTabulatedToneCurveFloat(cmsContext ContextID, cmsUInt32Number nEntries, const cmsFloat32Number values[])
602 {
603     cmsCurveSegment Seg[2];
604
605     // Initialize segmented curve part up to 0
606     Seg[0].x0 = -1;
607     Seg[0].x1 = 0;
608     Seg[0].Type = 6;
609
610     Seg[0].Params[0] = 1;
611     Seg[0].Params[1] = 0;
612     Seg[0].Params[2] = 0;
613     Seg[0].Params[3] = 0;
614     Seg[0].Params[4] = 0;
615
616     // From zero to any
617     Seg[1].x0 = 0;
618     Seg[1].x1 = 1.0;
619     Seg[1].Type = 0;
620
621     Seg[1].nGridPoints = nEntries;
622     Seg[1].SampledPoints = (cmsFloat32Number*) values;
623
624     return cmsBuildSegmentedToneCurve(ContextID, 2, Seg);
625 }
626
627 // Parametric curves
628 //
629 // Parameters goes as: Curve, a, b, c, d, e, f
630 // Type is the ICC type +1
631 // if type is negative, then the curve is analyticaly inverted
632 cmsToneCurve* CMSEXPORT cmsBuildParametricToneCurve(cmsContext ContextID, cmsInt32Number Type, const cmsFloat64Number Params[])
633 {
634     cmsCurveSegment Seg0;
635     int Pos = 0;
636     cmsUInt32Number size;
637     _cmsParametricCurvesCollection* c = GetParametricCurveByType(Type, &Pos);
638
639     _cmsAssert(Params != NULL);
640
641     if (c == NULL) {
642          cmsSignalError(ContextID, cmsERROR_UNKNOWN_EXTENSION, "Invalid parametric curve type %d", Type);
643         return NULL;
644     }
645
646     memset(&Seg0, 0, sizeof(Seg0));
647
648     Seg0.x0   = MINUS_INF;
649     Seg0.x1   = PLUS_INF;
650     Seg0.Type = Type;
651
652     size = c->ParameterCount[Pos] * sizeof(cmsFloat64Number);
653     memmove(Seg0.Params, Params, size);
654
655     return cmsBuildSegmentedToneCurve(ContextID, 1, &Seg0);
656 }
657
658
659
660 // Build a gamma table based on gamma constant
661 cmsToneCurve* CMSEXPORT cmsBuildGamma(cmsContext ContextID, cmsFloat64Number Gamma)
662 {
663     return cmsBuildParametricToneCurve(ContextID, 1, &Gamma);
664 }
665
666
667 // Free all memory taken by the gamma curve
668 void CMSEXPORT cmsFreeToneCurve(cmsToneCurve* Curve)
669 {
670     cmsContext ContextID;
671
672     if (Curve == NULL) return;
673
674     ContextID = Curve ->InterpParams->ContextID;
675
676     _cmsFreeInterpParams(Curve ->InterpParams);
677
678     if (Curve -> Table16)
679         _cmsFree(ContextID, Curve ->Table16);
680
681     if (Curve ->Segments) {
682
683         cmsUInt32Number i;
684
685         for (i=0; i < Curve ->nSegments; i++) {
686
687             if (Curve ->Segments[i].SampledPoints) {
688                 _cmsFree(ContextID, Curve ->Segments[i].SampledPoints);
689             }
690
691             if (Curve ->SegInterp[i] != 0)
692                 _cmsFreeInterpParams(Curve->SegInterp[i]);
693         }
694
695         _cmsFree(ContextID, Curve ->Segments);
696         _cmsFree(ContextID, Curve ->SegInterp);
697     }
698
699     if (Curve -> Evals)
700         _cmsFree(ContextID, Curve -> Evals);
701
702     if (Curve) _cmsFree(ContextID, Curve);
703 }
704
705 // Utility function, free 3 gamma tables
706 void CMSEXPORT cmsFreeToneCurveTriple(cmsToneCurve* Curve[3])
707 {
708
709     _cmsAssert(Curve != NULL);
710
711     if (Curve[0] != NULL) cmsFreeToneCurve(Curve[0]);
712     if (Curve[1] != NULL) cmsFreeToneCurve(Curve[1]);
713     if (Curve[2] != NULL) cmsFreeToneCurve(Curve[2]);
714
715     Curve[0] = Curve[1] = Curve[2] = NULL;
716 }
717
718
719 // Duplicate a gamma table
720 cmsToneCurve* CMSEXPORT cmsDupToneCurve(const cmsToneCurve* In)
721 {
722     if (In == NULL) return NULL;
723
724     return  AllocateToneCurveStruct(In ->InterpParams ->ContextID, In ->nEntries, In ->nSegments, In ->Segments, In ->Table16);
725 }
726
727 // Joins two curves for X and Y. Curves should be monotonic.
728 // We want to get
729 //
730 //      y = Y^-1(X(t))
731 //
732 cmsToneCurve* CMSEXPORT cmsJoinToneCurve(cmsContext ContextID,
733                                       const cmsToneCurve* X,
734                                       const cmsToneCurve* Y, cmsUInt32Number nResultingPoints)
735 {
736     cmsToneCurve* out = NULL;
737     cmsToneCurve* Yreversed = NULL;
738     cmsFloat32Number t, x;
739     cmsFloat32Number* Res = NULL;
740     cmsUInt32Number i;
741
742
743     _cmsAssert(X != NULL);
744     _cmsAssert(Y != NULL);
745
746     Yreversed = cmsReverseToneCurveEx(nResultingPoints, Y);
747     if (Yreversed == NULL) goto Error;
748
749     Res = (cmsFloat32Number*) _cmsCalloc(ContextID, nResultingPoints, sizeof(cmsFloat32Number));
750     if (Res == NULL) goto Error;
751
752     //Iterate
753     for (i=0; i <  nResultingPoints; i++) {
754
755         t = (cmsFloat32Number) i / (nResultingPoints-1);
756         x = cmsEvalToneCurveFloat(X,  t);
757         Res[i] = cmsEvalToneCurveFloat(Yreversed, x);
758     }
759
760     // Allocate space for output
761     out = cmsBuildTabulatedToneCurveFloat(ContextID, nResultingPoints, Res);
762
763 Error:
764
765     if (Res != NULL) _cmsFree(ContextID, Res);
766     if (Yreversed != NULL) cmsFreeToneCurve(Yreversed);
767
768     return out;
769 }
770
771
772
773 // Get the surrounding nodes. This is tricky on non-monotonic tables
774 static
775 int GetInterval(cmsFloat64Number In, const cmsUInt16Number LutTable[], const struct _cms_interp_struc* p)
776 {
777     int i;
778     int y0, y1;
779
780     // A 1 point table is not allowed
781     if (p -> Domain[0] < 1) return -1;
782
783     // Let's see if ascending or descending.
784     if (LutTable[0] < LutTable[p ->Domain[0]]) {
785
786         // Table is overall ascending
787         for (i=p->Domain[0]-1; i >=0; --i) {
788
789             y0 = LutTable[i];
790             y1 = LutTable[i+1];
791
792             if (y0 <= y1) { // Increasing
793                 if (In >= y0 && In <= y1) return i;
794             }
795             else
796                 if (y1 < y0) { // Decreasing
797                     if (In >= y1 && In <= y0) return i;
798                 }
799         }
800     }
801     else {
802         // Table is overall descending
803         for (i=0; i < (int) p -> Domain[0]; i++) {
804
805             y0 = LutTable[i];
806             y1 = LutTable[i+1];
807
808             if (y0 <= y1) { // Increasing
809                 if (In >= y0 && In <= y1) return i;
810             }
811             else
812                 if (y1 < y0) { // Decreasing
813                     if (In >= y1 && In <= y0) return i;
814                 }
815         }
816     }
817
818     return -1;
819 }
820
821 // Reverse a gamma table
822 cmsToneCurve* CMSEXPORT cmsReverseToneCurveEx(cmsInt32Number nResultSamples, const cmsToneCurve* InCurve)
823 {
824     cmsToneCurve *out;
825     cmsFloat64Number a = 0, b = 0, y, x1, y1, x2, y2;
826     int i, j;
827     int Ascending;
828
829     _cmsAssert(InCurve != NULL);
830
831     // Try to reverse it analytically whatever possible
832     if (InCurve ->nSegments == 1 && InCurve ->Segments[0].Type > 0 && InCurve -> Segments[0].Type <= 5) {
833
834         return cmsBuildParametricToneCurve(InCurve ->InterpParams->ContextID,
835                                        -(InCurve -> Segments[0].Type),
836                                        InCurve -> Segments[0].Params);
837     }
838
839     // Nope, reverse the table.
840     out = cmsBuildTabulatedToneCurve16(InCurve ->InterpParams->ContextID, nResultSamples, NULL);
841     if (out == NULL)
842         return NULL;
843
844     // We want to know if this is an ascending or descending table
845     Ascending = !cmsIsToneCurveDescending(InCurve);
846
847     // Iterate across Y axis
848     for (i=0; i <  nResultSamples; i++) {
849
850         y = (cmsFloat64Number) i * 65535.0 / (nResultSamples - 1);
851
852         // Find interval in which y is within.
853         j = GetInterval(y, InCurve->Table16, InCurve->InterpParams);
854         if (j >= 0) {
855
856
857             // Get limits of interval
858             x1 = InCurve ->Table16[j];
859             x2 = InCurve ->Table16[j+1];
860
861             y1 = (cmsFloat64Number) (j * 65535.0) / (InCurve ->nEntries - 1);
862             y2 = (cmsFloat64Number) ((j+1) * 65535.0 ) / (InCurve ->nEntries - 1);
863
864             // If collapsed, then use any
865             if (x1 == x2) {
866
867                 out ->Table16[i] = _cmsQuickSaturateWord(Ascending ? y2 : y1);
868                 continue;
869
870             } else {
871
872                 // Interpolate
873                 a = (y2 - y1) / (x2 - x1);
874                 b = y2 - a * x2;
875             }
876         }
877
878         out ->Table16[i] = _cmsQuickSaturateWord(a* y + b);
879     }
880
881
882     return out;
883 }
884
885 // Reverse a gamma table
886 cmsToneCurve* CMSEXPORT cmsReverseToneCurve(const cmsToneCurve* InGamma)
887 {
888     _cmsAssert(InGamma != NULL);
889
890     return cmsReverseToneCurveEx(4096, InGamma);
891 }
892
893 // From: Eilers, P.H.C. (1994) Smoothing and interpolation with finite
894 // differences. in: Graphic Gems IV, Heckbert, P.S. (ed.), Academic press.
895 //
896 // Smoothing and interpolation with second differences.
897 //
898 //   Input:  weights (w), data (y): vector from 1 to m.
899 //   Input:  smoothing parameter (lambda), length (m).
900 //   Output: smoothed vector (z): vector from 1 to m.
901
902 static
903 cmsBool smooth2(cmsContext ContextID, cmsFloat32Number w[], cmsFloat32Number y[], cmsFloat32Number z[], cmsFloat32Number lambda, int m)
904 {
905     int i, i1, i2;
906     cmsFloat32Number *c, *d, *e;
907     cmsBool st;
908
909
910     c = (cmsFloat32Number*) _cmsCalloc(ContextID, MAX_NODES_IN_CURVE, sizeof(cmsFloat32Number));
911     d = (cmsFloat32Number*) _cmsCalloc(ContextID, MAX_NODES_IN_CURVE, sizeof(cmsFloat32Number));
912     e = (cmsFloat32Number*) _cmsCalloc(ContextID, MAX_NODES_IN_CURVE, sizeof(cmsFloat32Number));
913
914     if (c != NULL && d != NULL && e != NULL) {
915
916
917     d[1] = w[1] + lambda;
918     c[1] = -2 * lambda / d[1];
919     e[1] = lambda /d[1];
920     z[1] = w[1] * y[1];
921     d[2] = w[2] + 5 * lambda - d[1] * c[1] *  c[1];
922     c[2] = (-4 * lambda - d[1] * c[1] * e[1]) / d[2];
923     e[2] = lambda / d[2];
924     z[2] = w[2] * y[2] - c[1] * z[1];
925
926     for (i = 3; i < m - 1; i++) {
927         i1 = i - 1; i2 = i - 2;
928         d[i]= w[i] + 6 * lambda - c[i1] * c[i1] * d[i1] - e[i2] * e[i2] * d[i2];
929         c[i] = (-4 * lambda -d[i1] * c[i1] * e[i1])/ d[i];
930         e[i] = lambda / d[i];
931         z[i] = w[i] * y[i] - c[i1] * z[i1] - e[i2] * z[i2];
932     }
933
934     i1 = m - 2; i2 = m - 3;
935
936     d[m - 1] = w[m - 1] + 5 * lambda -c[i1] * c[i1] * d[i1] - e[i2] * e[i2] * d[i2];
937     c[m - 1] = (-2 * lambda - d[i1] * c[i1] * e[i1]) / d[m - 1];
938     z[m - 1] = w[m - 1] * y[m - 1] - c[i1] * z[i1] - e[i2] * z[i2];
939     i1 = m - 1; i2 = m - 2;
940
941     d[m] = w[m] + lambda - c[i1] * c[i1] * d[i1] - e[i2] * e[i2] * d[i2];
942     z[m] = (w[m] * y[m] - c[i1] * z[i1] - e[i2] * z[i2]) / d[m];
943     z[m - 1] = z[m - 1] / d[m - 1] - c[m - 1] * z[m];
944
945     for (i = m - 2; 1<= i; i--)
946         z[i] = z[i] / d[i] - c[i] * z[i + 1] - e[i] * z[i + 2];
947
948       st = TRUE;
949     }
950     else st = FALSE;
951
952     if (c != NULL) _cmsFree(ContextID, c);
953     if (d != NULL) _cmsFree(ContextID, d);
954     if (e != NULL) _cmsFree(ContextID, e);
955
956     return st;
957 }
958
959 // Smooths a curve sampled at regular intervals.
960 cmsBool  CMSEXPORT cmsSmoothToneCurve(cmsToneCurve* Tab, cmsFloat64Number lambda)
961 {
962     cmsFloat32Number w[MAX_NODES_IN_CURVE], y[MAX_NODES_IN_CURVE], z[MAX_NODES_IN_CURVE];
963     int i, nItems, Zeros, Poles;
964
965     if (Tab == NULL) return FALSE;
966
967     if (cmsIsToneCurveLinear(Tab)) return FALSE; // Nothing to do
968
969     nItems = Tab -> nEntries;
970
971     if (nItems >= MAX_NODES_IN_CURVE) {
972         cmsSignalError(Tab ->InterpParams->ContextID, cmsERROR_RANGE, "cmsSmoothToneCurve: too many points.");
973         return FALSE;
974     }
975
976     memset(w, 0, nItems * sizeof(cmsFloat32Number));
977     memset(y, 0, nItems * sizeof(cmsFloat32Number));
978     memset(z, 0, nItems * sizeof(cmsFloat32Number));
979
980     for (i=0; i < nItems; i++)
981     {
982         y[i+1] = (cmsFloat32Number) Tab -> Table16[i];
983         w[i+1] = 1.0;
984     }
985
986     if (!smooth2(Tab ->InterpParams->ContextID, w, y, z, (cmsFloat32Number) lambda, nItems)) return FALSE;
987
988     // Do some reality - checking...
989     Zeros = Poles = 0;
990     for (i=nItems; i > 1; --i) {
991
992         if (z[i] == 0.) Zeros++;
993         if (z[i] >= 65535.) Poles++;
994         if (z[i] < z[i-1]) return FALSE; // Non-Monotonic
995     }
996
997     if (Zeros > (nItems / 3)) return FALSE;  // Degenerated, mostly zeros
998     if (Poles > (nItems / 3)) return FALSE;  // Degenerated, mostly poles
999
1000     // Seems ok
1001     for (i=0; i < nItems; i++) {
1002
1003         // Clamp to cmsUInt16Number
1004         Tab -> Table16[i] = _cmsQuickSaturateWord(z[i+1]);
1005     }
1006
1007     return TRUE;
1008 }
1009
1010 // Is a table linear? Do not use parametric since we cannot guarantee some weird parameters resulting
1011 // in a linear table. This way assures it is linear in 12 bits, which should be enought in most cases.
1012 cmsBool CMSEXPORT cmsIsToneCurveLinear(const cmsToneCurve* Curve)
1013 {
1014     cmsUInt32Number i;
1015     int diff;
1016
1017     _cmsAssert(Curve != NULL);
1018
1019     for (i=0; i < Curve ->nEntries; i++) {
1020
1021         diff = abs((int) Curve->Table16[i] - (int) _cmsQuantizeVal(i, Curve ->nEntries));
1022         if (diff > 0x0f)
1023             return FALSE;
1024     }
1025
1026     return TRUE;
1027 }
1028
1029 // Same, but for monotonicity
1030 cmsBool  CMSEXPORT cmsIsToneCurveMonotonic(const cmsToneCurve* t)
1031 {
1032     int n;
1033     int i, last;
1034     cmsBool lDescending;
1035
1036     _cmsAssert(t != NULL);
1037
1038     // Degenerated curves are monotonic? Ok, let's pass them
1039     n = t ->nEntries;
1040     if (n < 2) return TRUE;
1041
1042     // Curve direction
1043     lDescending = cmsIsToneCurveDescending(t);
1044
1045     if (lDescending) {
1046
1047         last = t ->Table16[0];
1048
1049         for (i = 1; i < n; i++) {
1050
1051             if (t ->Table16[i] - last > 2) // We allow some ripple
1052                 return FALSE;
1053             else
1054                 last = t ->Table16[i];
1055
1056         }
1057     }
1058     else {
1059
1060         last = t ->Table16[n-1];
1061
1062         for (i = n-2; i >= 0; --i) {
1063
1064             if (t ->Table16[i] - last > 2)
1065                 return FALSE;
1066             else
1067                 last = t ->Table16[i];
1068
1069         }
1070     }
1071
1072     return TRUE;
1073 }
1074
1075 // Same, but for descending tables
1076 cmsBool  CMSEXPORT cmsIsToneCurveDescending(const cmsToneCurve* t)
1077 {
1078     _cmsAssert(t != NULL);
1079
1080     return t ->Table16[0] > t ->Table16[t ->nEntries-1];
1081 }
1082
1083
1084 // Another info fn: is out gamma table multisegment?
1085 cmsBool  CMSEXPORT cmsIsToneCurveMultisegment(const cmsToneCurve* t)
1086 {
1087     _cmsAssert(t != NULL);
1088
1089     return t -> nSegments > 1;
1090 }
1091
1092 cmsInt32Number  CMSEXPORT cmsGetToneCurveParametricType(const cmsToneCurve* t)
1093 {
1094     _cmsAssert(t != NULL);
1095
1096     if (t -> nSegments != 1) return 0;
1097     return t ->Segments[0].Type;
1098 }
1099
1100 // We need accuracy this time
1101 cmsFloat32Number CMSEXPORT cmsEvalToneCurveFloat(const cmsToneCurve* Curve, cmsFloat32Number v)
1102 {
1103     _cmsAssert(Curve != NULL);
1104
1105     // Check for 16 bits table. If so, this is a limited-precision tone curve
1106     if (Curve ->nSegments == 0) {
1107
1108         cmsUInt16Number In, Out;
1109
1110         In = (cmsUInt16Number) _cmsQuickSaturateWord(v * 65535.0);
1111         Out = cmsEvalToneCurve16(Curve, In);
1112
1113         return (cmsFloat32Number) (Out / 65535.0);
1114     }
1115
1116     return (cmsFloat32Number) EvalSegmentedFn(Curve, v);
1117 }
1118
1119 // We need xput over here
1120 cmsUInt16Number CMSEXPORT cmsEvalToneCurve16(const cmsToneCurve* Curve, cmsUInt16Number v)
1121 {
1122     cmsUInt16Number out;
1123
1124     _cmsAssert(Curve != NULL);
1125
1126     Curve ->InterpParams ->Interpolation.Lerp16(&v, &out, Curve ->InterpParams);
1127     return out;
1128 }
1129
1130
1131 // Least squares fitting.
1132 // A mathematical procedure for finding the best-fitting curve to a given set of points by
1133 // minimizing the sum of the squares of the offsets ("the residuals") of the points from the curve.
1134 // The sum of the squares of the offsets is used instead of the offset absolute values because
1135 // this allows the residuals to be treated as a continuous differentiable quantity.
1136 //
1137 // y = f(x) = x ^ g
1138 //
1139 // R  = (yi - (xi^g))
1140 // R2 = (yi - (xi^g))2
1141 // SUM R2 = SUM (yi - (xi^g))2
1142 //
1143 // dR2/dg = -2 SUM x^g log(x)(y - x^g)
1144 // solving for dR2/dg = 0
1145 //
1146 // g = 1/n * SUM(log(y) / log(x))
1147
1148 cmsFloat64Number CMSEXPORT cmsEstimateGamma(const cmsToneCurve* t, cmsFloat64Number Precision)
1149 {
1150     cmsFloat64Number gamma, sum, sum2;
1151     cmsFloat64Number n, x, y, Std;
1152     cmsUInt32Number i;
1153
1154     _cmsAssert(t != NULL);
1155
1156     sum = sum2 = n = 0;
1157
1158     // Excluding endpoints
1159     for (i=1; i < (MAX_NODES_IN_CURVE-1); i++) {
1160
1161         x = (cmsFloat64Number) i / (MAX_NODES_IN_CURVE-1);
1162         y = (cmsFloat64Number) cmsEvalToneCurveFloat(t, (cmsFloat32Number) x);
1163
1164         // Avoid 7% on lower part to prevent
1165         // artifacts due to linear ramps
1166
1167         if (y > 0. && y < 1. && x > 0.07) {
1168
1169             gamma = log(y) / log(x);
1170             sum  += gamma;
1171             sum2 += gamma * gamma;
1172             n++;
1173         }
1174     }
1175
1176     // Take a look on SD to see if gamma isn't exponential at all
1177     Std = sqrt((n * sum2 - sum * sum) / (n*(n-1)));
1178
1179     if (Std > Precision)
1180         return -1.0;
1181
1182     return (sum / n);   // The mean
1183 }