Rearrange spec file
[platform/upstream/libjpeg-turbo.git] / jquant2.c
1 /*
2  * jquant2.c
3  *
4  * This file was part of the Independent JPEG Group's software:
5  * Copyright (C) 1991-1996, Thomas G. Lane.
6  * libjpeg-turbo Modifications:
7  * Copyright (C) 2009, 2014-2015, D. R. Commander.
8  * For conditions of distribution and use, see the accompanying README.ijg
9  * file.
10  *
11  * This file contains 2-pass color quantization (color mapping) routines.
12  * These routines provide selection of a custom color map for an image,
13  * followed by mapping of the image to that color map, with optional
14  * Floyd-Steinberg dithering.
15  * It is also possible to use just the second pass to map to an arbitrary
16  * externally-given color map.
17  *
18  * Note: ordered dithering is not supported, since there isn't any fast
19  * way to compute intercolor distances; it's unclear that ordered dither's
20  * fundamental assumptions even hold with an irregularly spaced color map.
21  */
22
23 #define JPEG_INTERNALS
24 #include "jinclude.h"
25 #include "jpeglib.h"
26
27 #ifdef QUANT_2PASS_SUPPORTED
28
29
30 /*
31  * This module implements the well-known Heckbert paradigm for color
32  * quantization.  Most of the ideas used here can be traced back to
33  * Heckbert's seminal paper
34  *   Heckbert, Paul.  "Color Image Quantization for Frame Buffer Display",
35  *   Proc. SIGGRAPH '82, Computer Graphics v.16 #3 (July 1982), pp 297-304.
36  *
37  * In the first pass over the image, we accumulate a histogram showing the
38  * usage count of each possible color.  To keep the histogram to a reasonable
39  * size, we reduce the precision of the input; typical practice is to retain
40  * 5 or 6 bits per color, so that 8 or 4 different input values are counted
41  * in the same histogram cell.
42  *
43  * Next, the color-selection step begins with a box representing the whole
44  * color space, and repeatedly splits the "largest" remaining box until we
45  * have as many boxes as desired colors.  Then the mean color in each
46  * remaining box becomes one of the possible output colors.
47  *
48  * The second pass over the image maps each input pixel to the closest output
49  * color (optionally after applying a Floyd-Steinberg dithering correction).
50  * This mapping is logically trivial, but making it go fast enough requires
51  * considerable care.
52  *
53  * Heckbert-style quantizers vary a good deal in their policies for choosing
54  * the "largest" box and deciding where to cut it.  The particular policies
55  * used here have proved out well in experimental comparisons, but better ones
56  * may yet be found.
57  *
58  * In earlier versions of the IJG code, this module quantized in YCbCr color
59  * space, processing the raw upsampled data without a color conversion step.
60  * This allowed the color conversion math to be done only once per colormap
61  * entry, not once per pixel.  However, that optimization precluded other
62  * useful optimizations (such as merging color conversion with upsampling)
63  * and it also interfered with desired capabilities such as quantizing to an
64  * externally-supplied colormap.  We have therefore abandoned that approach.
65  * The present code works in the post-conversion color space, typically RGB.
66  *
67  * To improve the visual quality of the results, we actually work in scaled
68  * RGB space, giving G distances more weight than R, and R in turn more than
69  * B.  To do everything in integer math, we must use integer scale factors.
70  * The 2/3/1 scale factors used here correspond loosely to the relative
71  * weights of the colors in the NTSC grayscale equation.
72  * If you want to use this code to quantize a non-RGB color space, you'll
73  * probably need to change these scale factors.
74  */
75
76 #define R_SCALE 2               /* scale R distances by this much */
77 #define G_SCALE 3               /* scale G distances by this much */
78 #define B_SCALE 1               /* and B by this much */
79
80 static const int c_scales[3]={R_SCALE, G_SCALE, B_SCALE};
81 #define C0_SCALE c_scales[rgb_red[cinfo->out_color_space]]
82 #define C1_SCALE c_scales[rgb_green[cinfo->out_color_space]]
83 #define C2_SCALE c_scales[rgb_blue[cinfo->out_color_space]]
84
85 /*
86  * First we have the histogram data structure and routines for creating it.
87  *
88  * The number of bits of precision can be adjusted by changing these symbols.
89  * We recommend keeping 6 bits for G and 5 each for R and B.
90  * If you have plenty of memory and cycles, 6 bits all around gives marginally
91  * better results; if you are short of memory, 5 bits all around will save
92  * some space but degrade the results.
93  * To maintain a fully accurate histogram, we'd need to allocate a "long"
94  * (preferably unsigned long) for each cell.  In practice this is overkill;
95  * we can get by with 16 bits per cell.  Few of the cell counts will overflow,
96  * and clamping those that do overflow to the maximum value will give close-
97  * enough results.  This reduces the recommended histogram size from 256Kb
98  * to 128Kb, which is a useful savings on PC-class machines.
99  * (In the second pass the histogram space is re-used for pixel mapping data;
100  * in that capacity, each cell must be able to store zero to the number of
101  * desired colors.  16 bits/cell is plenty for that too.)
102  * Since the JPEG code is intended to run in small memory model on 80x86
103  * machines, we can't just allocate the histogram in one chunk.  Instead
104  * of a true 3-D array, we use a row of pointers to 2-D arrays.  Each
105  * pointer corresponds to a C0 value (typically 2^5 = 32 pointers) and
106  * each 2-D array has 2^6*2^5 = 2048 or 2^6*2^6 = 4096 entries.
107  */
108
109 #define MAXNUMCOLORS  (MAXJSAMPLE+1) /* maximum size of colormap */
110
111 /* These will do the right thing for either R,G,B or B,G,R color order,
112  * but you may not like the results for other color orders.
113  */
114 #define HIST_C0_BITS  5         /* bits of precision in R/B histogram */
115 #define HIST_C1_BITS  6         /* bits of precision in G histogram */
116 #define HIST_C2_BITS  5         /* bits of precision in B/R histogram */
117
118 /* Number of elements along histogram axes. */
119 #define HIST_C0_ELEMS  (1<<HIST_C0_BITS)
120 #define HIST_C1_ELEMS  (1<<HIST_C1_BITS)
121 #define HIST_C2_ELEMS  (1<<HIST_C2_BITS)
122
123 /* These are the amounts to shift an input value to get a histogram index. */
124 #define C0_SHIFT  (BITS_IN_JSAMPLE-HIST_C0_BITS)
125 #define C1_SHIFT  (BITS_IN_JSAMPLE-HIST_C1_BITS)
126 #define C2_SHIFT  (BITS_IN_JSAMPLE-HIST_C2_BITS)
127
128
129 typedef UINT16 histcell;        /* histogram cell; prefer an unsigned type */
130
131 typedef histcell *histptr; /* for pointers to histogram cells */
132
133 typedef histcell hist1d[HIST_C2_ELEMS]; /* typedefs for the array */
134 typedef hist1d *hist2d;         /* type for the 2nd-level pointers */
135 typedef hist2d *hist3d;         /* type for top-level pointer */
136
137
138 /* Declarations for Floyd-Steinberg dithering.
139  *
140  * Errors are accumulated into the array fserrors[], at a resolution of
141  * 1/16th of a pixel count.  The error at a given pixel is propagated
142  * to its not-yet-processed neighbors using the standard F-S fractions,
143  *              ...     (here)  7/16
144  *              3/16    5/16    1/16
145  * We work left-to-right on even rows, right-to-left on odd rows.
146  *
147  * We can get away with a single array (holding one row's worth of errors)
148  * by using it to store the current row's errors at pixel columns not yet
149  * processed, but the next row's errors at columns already processed.  We
150  * need only a few extra variables to hold the errors immediately around the
151  * current column.  (If we are lucky, those variables are in registers, but
152  * even if not, they're probably cheaper to access than array elements are.)
153  *
154  * The fserrors[] array has (#columns + 2) entries; the extra entry at
155  * each end saves us from special-casing the first and last pixels.
156  * Each entry is three values long, one value for each color component.
157  */
158
159 #if BITS_IN_JSAMPLE == 8
160 typedef INT16 FSERROR;          /* 16 bits should be enough */
161 typedef int LOCFSERROR;         /* use 'int' for calculation temps */
162 #else
163 typedef JLONG FSERROR;          /* may need more than 16 bits */
164 typedef JLONG LOCFSERROR;       /* be sure calculation temps are big enough */
165 #endif
166
167 typedef FSERROR *FSERRPTR;      /* pointer to error array */
168
169
170 /* Private subobject */
171
172 typedef struct {
173   struct jpeg_color_quantizer pub; /* public fields */
174
175   /* Space for the eventually created colormap is stashed here */
176   JSAMPARRAY sv_colormap;       /* colormap allocated at init time */
177   int desired;                  /* desired # of colors = size of colormap */
178
179   /* Variables for accumulating image statistics */
180   hist3d histogram;             /* pointer to the histogram */
181
182   boolean needs_zeroed;         /* TRUE if next pass must zero histogram */
183
184   /* Variables for Floyd-Steinberg dithering */
185   FSERRPTR fserrors;            /* accumulated errors */
186   boolean on_odd_row;           /* flag to remember which row we are on */
187   int *error_limiter;           /* table for clamping the applied error */
188 } my_cquantizer;
189
190 typedef my_cquantizer *my_cquantize_ptr;
191
192
193 /*
194  * Prescan some rows of pixels.
195  * In this module the prescan simply updates the histogram, which has been
196  * initialized to zeroes by start_pass.
197  * An output_buf parameter is required by the method signature, but no data
198  * is actually output (in fact the buffer controller is probably passing a
199  * NULL pointer).
200  */
201
202 METHODDEF(void)
203 prescan_quantize (j_decompress_ptr cinfo, JSAMPARRAY input_buf,
204                   JSAMPARRAY output_buf, int num_rows)
205 {
206   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
207   register JSAMPROW ptr;
208   register histptr histp;
209   register hist3d histogram = cquantize->histogram;
210   int row;
211   JDIMENSION col;
212   JDIMENSION width = cinfo->output_width;
213
214   for (row = 0; row < num_rows; row++) {
215     ptr = input_buf[row];
216     for (col = width; col > 0; col--) {
217       /* get pixel value and index into the histogram */
218       histp = & histogram[GETJSAMPLE(ptr[0]) >> C0_SHIFT]
219                          [GETJSAMPLE(ptr[1]) >> C1_SHIFT]
220                          [GETJSAMPLE(ptr[2]) >> C2_SHIFT];
221       /* increment, check for overflow and undo increment if so. */
222       if (++(*histp) <= 0)
223         (*histp)--;
224       ptr += 3;
225     }
226   }
227 }
228
229
230 /*
231  * Next we have the really interesting routines: selection of a colormap
232  * given the completed histogram.
233  * These routines work with a list of "boxes", each representing a rectangular
234  * subset of the input color space (to histogram precision).
235  */
236
237 typedef struct {
238   /* The bounds of the box (inclusive); expressed as histogram indexes */
239   int c0min, c0max;
240   int c1min, c1max;
241   int c2min, c2max;
242   /* The volume (actually 2-norm) of the box */
243   JLONG volume;
244   /* The number of nonzero histogram cells within this box */
245   long colorcount;
246 } box;
247
248 typedef box *boxptr;
249
250
251 LOCAL(boxptr)
252 find_biggest_color_pop (boxptr boxlist, int numboxes)
253 /* Find the splittable box with the largest color population */
254 /* Returns NULL if no splittable boxes remain */
255 {
256   register boxptr boxp;
257   register int i;
258   register long maxc = 0;
259   boxptr which = NULL;
260
261   for (i = 0, boxp = boxlist; i < numboxes; i++, boxp++) {
262     if (boxp->colorcount > maxc && boxp->volume > 0) {
263       which = boxp;
264       maxc = boxp->colorcount;
265     }
266   }
267   return which;
268 }
269
270
271 LOCAL(boxptr)
272 find_biggest_volume (boxptr boxlist, int numboxes)
273 /* Find the splittable box with the largest (scaled) volume */
274 /* Returns NULL if no splittable boxes remain */
275 {
276   register boxptr boxp;
277   register int i;
278   register JLONG maxv = 0;
279   boxptr which = NULL;
280
281   for (i = 0, boxp = boxlist; i < numboxes; i++, boxp++) {
282     if (boxp->volume > maxv) {
283       which = boxp;
284       maxv = boxp->volume;
285     }
286   }
287   return which;
288 }
289
290
291 LOCAL(void)
292 update_box (j_decompress_ptr cinfo, boxptr boxp)
293 /* Shrink the min/max bounds of a box to enclose only nonzero elements, */
294 /* and recompute its volume and population */
295 {
296   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
297   hist3d histogram = cquantize->histogram;
298   histptr histp;
299   int c0,c1,c2;
300   int c0min,c0max,c1min,c1max,c2min,c2max;
301   JLONG dist0,dist1,dist2;
302   long ccount;
303
304   c0min = boxp->c0min;  c0max = boxp->c0max;
305   c1min = boxp->c1min;  c1max = boxp->c1max;
306   c2min = boxp->c2min;  c2max = boxp->c2max;
307
308   if (c0max > c0min)
309     for (c0 = c0min; c0 <= c0max; c0++)
310       for (c1 = c1min; c1 <= c1max; c1++) {
311         histp = & histogram[c0][c1][c2min];
312         for (c2 = c2min; c2 <= c2max; c2++)
313           if (*histp++ != 0) {
314             boxp->c0min = c0min = c0;
315             goto have_c0min;
316           }
317       }
318  have_c0min:
319   if (c0max > c0min)
320     for (c0 = c0max; c0 >= c0min; c0--)
321       for (c1 = c1min; c1 <= c1max; c1++) {
322         histp = & histogram[c0][c1][c2min];
323         for (c2 = c2min; c2 <= c2max; c2++)
324           if (*histp++ != 0) {
325             boxp->c0max = c0max = c0;
326             goto have_c0max;
327           }
328       }
329  have_c0max:
330   if (c1max > c1min)
331     for (c1 = c1min; c1 <= c1max; c1++)
332       for (c0 = c0min; c0 <= c0max; c0++) {
333         histp = & histogram[c0][c1][c2min];
334         for (c2 = c2min; c2 <= c2max; c2++)
335           if (*histp++ != 0) {
336             boxp->c1min = c1min = c1;
337             goto have_c1min;
338           }
339       }
340  have_c1min:
341   if (c1max > c1min)
342     for (c1 = c1max; c1 >= c1min; c1--)
343       for (c0 = c0min; c0 <= c0max; c0++) {
344         histp = & histogram[c0][c1][c2min];
345         for (c2 = c2min; c2 <= c2max; c2++)
346           if (*histp++ != 0) {
347             boxp->c1max = c1max = c1;
348             goto have_c1max;
349           }
350       }
351  have_c1max:
352   if (c2max > c2min)
353     for (c2 = c2min; c2 <= c2max; c2++)
354       for (c0 = c0min; c0 <= c0max; c0++) {
355         histp = & histogram[c0][c1min][c2];
356         for (c1 = c1min; c1 <= c1max; c1++, histp += HIST_C2_ELEMS)
357           if (*histp != 0) {
358             boxp->c2min = c2min = c2;
359             goto have_c2min;
360           }
361       }
362  have_c2min:
363   if (c2max > c2min)
364     for (c2 = c2max; c2 >= c2min; c2--)
365       for (c0 = c0min; c0 <= c0max; c0++) {
366         histp = & histogram[c0][c1min][c2];
367         for (c1 = c1min; c1 <= c1max; c1++, histp += HIST_C2_ELEMS)
368           if (*histp != 0) {
369             boxp->c2max = c2max = c2;
370             goto have_c2max;
371           }
372       }
373  have_c2max:
374
375   /* Update box volume.
376    * We use 2-norm rather than real volume here; this biases the method
377    * against making long narrow boxes, and it has the side benefit that
378    * a box is splittable iff norm > 0.
379    * Since the differences are expressed in histogram-cell units,
380    * we have to shift back to JSAMPLE units to get consistent distances;
381    * after which, we scale according to the selected distance scale factors.
382    */
383   dist0 = ((c0max - c0min) << C0_SHIFT) * C0_SCALE;
384   dist1 = ((c1max - c1min) << C1_SHIFT) * C1_SCALE;
385   dist2 = ((c2max - c2min) << C2_SHIFT) * C2_SCALE;
386   boxp->volume = dist0*dist0 + dist1*dist1 + dist2*dist2;
387
388   /* Now scan remaining volume of box and compute population */
389   ccount = 0;
390   for (c0 = c0min; c0 <= c0max; c0++)
391     for (c1 = c1min; c1 <= c1max; c1++) {
392       histp = & histogram[c0][c1][c2min];
393       for (c2 = c2min; c2 <= c2max; c2++, histp++)
394         if (*histp != 0) {
395           ccount++;
396         }
397     }
398   boxp->colorcount = ccount;
399 }
400
401
402 LOCAL(int)
403 median_cut (j_decompress_ptr cinfo, boxptr boxlist, int numboxes,
404             int desired_colors)
405 /* Repeatedly select and split the largest box until we have enough boxes */
406 {
407   int n,lb;
408   int c0,c1,c2,cmax;
409   register boxptr b1,b2;
410
411   while (numboxes < desired_colors) {
412     /* Select box to split.
413      * Current algorithm: by population for first half, then by volume.
414      */
415     if (numboxes*2 <= desired_colors) {
416       b1 = find_biggest_color_pop(boxlist, numboxes);
417     } else {
418       b1 = find_biggest_volume(boxlist, numboxes);
419     }
420     if (b1 == NULL)             /* no splittable boxes left! */
421       break;
422     b2 = &boxlist[numboxes];    /* where new box will go */
423     /* Copy the color bounds to the new box. */
424     b2->c0max = b1->c0max; b2->c1max = b1->c1max; b2->c2max = b1->c2max;
425     b2->c0min = b1->c0min; b2->c1min = b1->c1min; b2->c2min = b1->c2min;
426     /* Choose which axis to split the box on.
427      * Current algorithm: longest scaled axis.
428      * See notes in update_box about scaling distances.
429      */
430     c0 = ((b1->c0max - b1->c0min) << C0_SHIFT) * C0_SCALE;
431     c1 = ((b1->c1max - b1->c1min) << C1_SHIFT) * C1_SCALE;
432     c2 = ((b1->c2max - b1->c2min) << C2_SHIFT) * C2_SCALE;
433     /* We want to break any ties in favor of green, then red, blue last.
434      * This code does the right thing for R,G,B or B,G,R color orders only.
435      */
436     if (rgb_red[cinfo->out_color_space] == 0) {
437       cmax = c1; n = 1;
438       if (c0 > cmax) { cmax = c0; n = 0; }
439       if (c2 > cmax) { n = 2; }
440     }
441     else {
442       cmax = c1; n = 1;
443       if (c2 > cmax) { cmax = c2; n = 2; }
444       if (c0 > cmax) { n = 0; }
445     }
446     /* Choose split point along selected axis, and update box bounds.
447      * Current algorithm: split at halfway point.
448      * (Since the box has been shrunk to minimum volume,
449      * any split will produce two nonempty subboxes.)
450      * Note that lb value is max for lower box, so must be < old max.
451      */
452     switch (n) {
453     case 0:
454       lb = (b1->c0max + b1->c0min) / 2;
455       b1->c0max = lb;
456       b2->c0min = lb+1;
457       break;
458     case 1:
459       lb = (b1->c1max + b1->c1min) / 2;
460       b1->c1max = lb;
461       b2->c1min = lb+1;
462       break;
463     case 2:
464       lb = (b1->c2max + b1->c2min) / 2;
465       b1->c2max = lb;
466       b2->c2min = lb+1;
467       break;
468     }
469     /* Update stats for boxes */
470     update_box(cinfo, b1);
471     update_box(cinfo, b2);
472     numboxes++;
473   }
474   return numboxes;
475 }
476
477
478 LOCAL(void)
479 compute_color (j_decompress_ptr cinfo, boxptr boxp, int icolor)
480 /* Compute representative color for a box, put it in colormap[icolor] */
481 {
482   /* Current algorithm: mean weighted by pixels (not colors) */
483   /* Note it is important to get the rounding correct! */
484   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
485   hist3d histogram = cquantize->histogram;
486   histptr histp;
487   int c0,c1,c2;
488   int c0min,c0max,c1min,c1max,c2min,c2max;
489   long count;
490   long total = 0;
491   long c0total = 0;
492   long c1total = 0;
493   long c2total = 0;
494
495   c0min = boxp->c0min;  c0max = boxp->c0max;
496   c1min = boxp->c1min;  c1max = boxp->c1max;
497   c2min = boxp->c2min;  c2max = boxp->c2max;
498
499   for (c0 = c0min; c0 <= c0max; c0++)
500     for (c1 = c1min; c1 <= c1max; c1++) {
501       histp = & histogram[c0][c1][c2min];
502       for (c2 = c2min; c2 <= c2max; c2++) {
503         if ((count = *histp++) != 0) {
504           total += count;
505           c0total += ((c0 << C0_SHIFT) + ((1<<C0_SHIFT)>>1)) * count;
506           c1total += ((c1 << C1_SHIFT) + ((1<<C1_SHIFT)>>1)) * count;
507           c2total += ((c2 << C2_SHIFT) + ((1<<C2_SHIFT)>>1)) * count;
508         }
509       }
510     }
511
512 #if _USE_PRODUCT_TV
513          if(total != 0) {
514                  cinfo->colormap[0][icolor] = (JSAMPLE) ((c0total + (total>>1)) / total);
515                  cinfo->colormap[1][icolor] = (JSAMPLE) ((c1total + (total>>1)) / total);
516                  cinfo->colormap[2][icolor] = (JSAMPLE) ((c2total + (total>>1)) / total);
517          }
518 #else
519   cinfo->colormap[0][icolor] = (JSAMPLE) ((c0total + (total>>1)) / total);
520   cinfo->colormap[1][icolor] = (JSAMPLE) ((c1total + (total>>1)) / total);
521   cinfo->colormap[2][icolor] = (JSAMPLE) ((c2total + (total>>1)) / total);
522 #endif
523 }
524
525
526 LOCAL(void)
527 select_colors (j_decompress_ptr cinfo, int desired_colors)
528 /* Master routine for color selection */
529 {
530   boxptr boxlist;
531   int numboxes;
532   int i;
533
534   /* Allocate workspace for box list */
535   boxlist = (boxptr) (*cinfo->mem->alloc_small)
536     ((j_common_ptr) cinfo, JPOOL_IMAGE, desired_colors * sizeof(box));
537   /* Initialize one box containing whole space */
538   numboxes = 1;
539   boxlist[0].c0min = 0;
540   boxlist[0].c0max = MAXJSAMPLE >> C0_SHIFT;
541   boxlist[0].c1min = 0;
542   boxlist[0].c1max = MAXJSAMPLE >> C1_SHIFT;
543   boxlist[0].c2min = 0;
544   boxlist[0].c2max = MAXJSAMPLE >> C2_SHIFT;
545   /* Shrink it to actually-used volume and set its statistics */
546   update_box(cinfo, & boxlist[0]);
547   /* Perform median-cut to produce final box list */
548   numboxes = median_cut(cinfo, boxlist, numboxes, desired_colors);
549   /* Compute the representative color for each box, fill colormap */
550   for (i = 0; i < numboxes; i++)
551     compute_color(cinfo, & boxlist[i], i);
552   cinfo->actual_number_of_colors = numboxes;
553   TRACEMS1(cinfo, 1, JTRC_QUANT_SELECTED, numboxes);
554 }
555
556
557 /*
558  * These routines are concerned with the time-critical task of mapping input
559  * colors to the nearest color in the selected colormap.
560  *
561  * We re-use the histogram space as an "inverse color map", essentially a
562  * cache for the results of nearest-color searches.  All colors within a
563  * histogram cell will be mapped to the same colormap entry, namely the one
564  * closest to the cell's center.  This may not be quite the closest entry to
565  * the actual input color, but it's almost as good.  A zero in the cache
566  * indicates we haven't found the nearest color for that cell yet; the array
567  * is cleared to zeroes before starting the mapping pass.  When we find the
568  * nearest color for a cell, its colormap index plus one is recorded in the
569  * cache for future use.  The pass2 scanning routines call fill_inverse_cmap
570  * when they need to use an unfilled entry in the cache.
571  *
572  * Our method of efficiently finding nearest colors is based on the "locally
573  * sorted search" idea described by Heckbert and on the incremental distance
574  * calculation described by Spencer W. Thomas in chapter III.1 of Graphics
575  * Gems II (James Arvo, ed.  Academic Press, 1991).  Thomas points out that
576  * the distances from a given colormap entry to each cell of the histogram can
577  * be computed quickly using an incremental method: the differences between
578  * distances to adjacent cells themselves differ by a constant.  This allows a
579  * fairly fast implementation of the "brute force" approach of computing the
580  * distance from every colormap entry to every histogram cell.  Unfortunately,
581  * it needs a work array to hold the best-distance-so-far for each histogram
582  * cell (because the inner loop has to be over cells, not colormap entries).
583  * The work array elements have to be JLONGs, so the work array would need
584  * 256Kb at our recommended precision.  This is not feasible in DOS machines.
585  *
586  * To get around these problems, we apply Thomas' method to compute the
587  * nearest colors for only the cells within a small subbox of the histogram.
588  * The work array need be only as big as the subbox, so the memory usage
589  * problem is solved.  Furthermore, we need not fill subboxes that are never
590  * referenced in pass2; many images use only part of the color gamut, so a
591  * fair amount of work is saved.  An additional advantage of this
592  * approach is that we can apply Heckbert's locality criterion to quickly
593  * eliminate colormap entries that are far away from the subbox; typically
594  * three-fourths of the colormap entries are rejected by Heckbert's criterion,
595  * and we need not compute their distances to individual cells in the subbox.
596  * The speed of this approach is heavily influenced by the subbox size: too
597  * small means too much overhead, too big loses because Heckbert's criterion
598  * can't eliminate as many colormap entries.  Empirically the best subbox
599  * size seems to be about 1/512th of the histogram (1/8th in each direction).
600  *
601  * Thomas' article also describes a refined method which is asymptotically
602  * faster than the brute-force method, but it is also far more complex and
603  * cannot efficiently be applied to small subboxes.  It is therefore not
604  * useful for programs intended to be portable to DOS machines.  On machines
605  * with plenty of memory, filling the whole histogram in one shot with Thomas'
606  * refined method might be faster than the present code --- but then again,
607  * it might not be any faster, and it's certainly more complicated.
608  */
609
610
611 /* log2(histogram cells in update box) for each axis; this can be adjusted */
612 #define BOX_C0_LOG  (HIST_C0_BITS-3)
613 #define BOX_C1_LOG  (HIST_C1_BITS-3)
614 #define BOX_C2_LOG  (HIST_C2_BITS-3)
615
616 #define BOX_C0_ELEMS  (1<<BOX_C0_LOG) /* # of hist cells in update box */
617 #define BOX_C1_ELEMS  (1<<BOX_C1_LOG)
618 #define BOX_C2_ELEMS  (1<<BOX_C2_LOG)
619
620 #define BOX_C0_SHIFT  (C0_SHIFT + BOX_C0_LOG)
621 #define BOX_C1_SHIFT  (C1_SHIFT + BOX_C1_LOG)
622 #define BOX_C2_SHIFT  (C2_SHIFT + BOX_C2_LOG)
623
624
625 /*
626  * The next three routines implement inverse colormap filling.  They could
627  * all be folded into one big routine, but splitting them up this way saves
628  * some stack space (the mindist[] and bestdist[] arrays need not coexist)
629  * and may allow some compilers to produce better code by registerizing more
630  * inner-loop variables.
631  */
632
633 LOCAL(int)
634 find_nearby_colors (j_decompress_ptr cinfo, int minc0, int minc1, int minc2,
635                     JSAMPLE colorlist[])
636 /* Locate the colormap entries close enough to an update box to be candidates
637  * for the nearest entry to some cell(s) in the update box.  The update box
638  * is specified by the center coordinates of its first cell.  The number of
639  * candidate colormap entries is returned, and their colormap indexes are
640  * placed in colorlist[].
641  * This routine uses Heckbert's "locally sorted search" criterion to select
642  * the colors that need further consideration.
643  */
644 {
645   int numcolors = cinfo->actual_number_of_colors;
646   int maxc0, maxc1, maxc2;
647   int centerc0, centerc1, centerc2;
648   int i, x, ncolors;
649   JLONG minmaxdist, min_dist, max_dist, tdist;
650   JLONG mindist[MAXNUMCOLORS];  /* min distance to colormap entry i */
651
652   /* Compute true coordinates of update box's upper corner and center.
653    * Actually we compute the coordinates of the center of the upper-corner
654    * histogram cell, which are the upper bounds of the volume we care about.
655    * Note that since ">>" rounds down, the "center" values may be closer to
656    * min than to max; hence comparisons to them must be "<=", not "<".
657    */
658   maxc0 = minc0 + ((1 << BOX_C0_SHIFT) - (1 << C0_SHIFT));
659   centerc0 = (minc0 + maxc0) >> 1;
660   maxc1 = minc1 + ((1 << BOX_C1_SHIFT) - (1 << C1_SHIFT));
661   centerc1 = (minc1 + maxc1) >> 1;
662   maxc2 = minc2 + ((1 << BOX_C2_SHIFT) - (1 << C2_SHIFT));
663   centerc2 = (minc2 + maxc2) >> 1;
664
665   /* For each color in colormap, find:
666    *  1. its minimum squared-distance to any point in the update box
667    *     (zero if color is within update box);
668    *  2. its maximum squared-distance to any point in the update box.
669    * Both of these can be found by considering only the corners of the box.
670    * We save the minimum distance for each color in mindist[];
671    * only the smallest maximum distance is of interest.
672    */
673   minmaxdist = 0x7FFFFFFFL;
674
675   for (i = 0; i < numcolors; i++) {
676     /* We compute the squared-c0-distance term, then add in the other two. */
677     x = GETJSAMPLE(cinfo->colormap[0][i]);
678     if (x < minc0) {
679       tdist = (x - minc0) * C0_SCALE;
680       min_dist = tdist*tdist;
681       tdist = (x - maxc0) * C0_SCALE;
682       max_dist = tdist*tdist;
683     } else if (x > maxc0) {
684       tdist = (x - maxc0) * C0_SCALE;
685       min_dist = tdist*tdist;
686       tdist = (x - minc0) * C0_SCALE;
687       max_dist = tdist*tdist;
688     } else {
689       /* within cell range so no contribution to min_dist */
690       min_dist = 0;
691       if (x <= centerc0) {
692         tdist = (x - maxc0) * C0_SCALE;
693         max_dist = tdist*tdist;
694       } else {
695         tdist = (x - minc0) * C0_SCALE;
696         max_dist = tdist*tdist;
697       }
698     }
699
700     x = GETJSAMPLE(cinfo->colormap[1][i]);
701     if (x < minc1) {
702       tdist = (x - minc1) * C1_SCALE;
703       min_dist += tdist*tdist;
704       tdist = (x - maxc1) * C1_SCALE;
705       max_dist += tdist*tdist;
706     } else if (x > maxc1) {
707       tdist = (x - maxc1) * C1_SCALE;
708       min_dist += tdist*tdist;
709       tdist = (x - minc1) * C1_SCALE;
710       max_dist += tdist*tdist;
711     } else {
712       /* within cell range so no contribution to min_dist */
713       if (x <= centerc1) {
714         tdist = (x - maxc1) * C1_SCALE;
715         max_dist += tdist*tdist;
716       } else {
717         tdist = (x - minc1) * C1_SCALE;
718         max_dist += tdist*tdist;
719       }
720     }
721
722     x = GETJSAMPLE(cinfo->colormap[2][i]);
723     if (x < minc2) {
724       tdist = (x - minc2) * C2_SCALE;
725       min_dist += tdist*tdist;
726       tdist = (x - maxc2) * C2_SCALE;
727       max_dist += tdist*tdist;
728     } else if (x > maxc2) {
729       tdist = (x - maxc2) * C2_SCALE;
730       min_dist += tdist*tdist;
731       tdist = (x - minc2) * C2_SCALE;
732       max_dist += tdist*tdist;
733     } else {
734       /* within cell range so no contribution to min_dist */
735       if (x <= centerc2) {
736         tdist = (x - maxc2) * C2_SCALE;
737         max_dist += tdist*tdist;
738       } else {
739         tdist = (x - minc2) * C2_SCALE;
740         max_dist += tdist*tdist;
741       }
742     }
743
744     mindist[i] = min_dist;      /* save away the results */
745     if (max_dist < minmaxdist)
746       minmaxdist = max_dist;
747   }
748
749   /* Now we know that no cell in the update box is more than minmaxdist
750    * away from some colormap entry.  Therefore, only colors that are
751    * within minmaxdist of some part of the box need be considered.
752    */
753   ncolors = 0;
754   for (i = 0; i < numcolors; i++) {
755     if (mindist[i] <= minmaxdist)
756       colorlist[ncolors++] = (JSAMPLE) i;
757   }
758   return ncolors;
759 }
760
761
762 LOCAL(void)
763 find_best_colors (j_decompress_ptr cinfo, int minc0, int minc1, int minc2,
764                   int numcolors, JSAMPLE colorlist[], JSAMPLE bestcolor[])
765 /* Find the closest colormap entry for each cell in the update box,
766  * given the list of candidate colors prepared by find_nearby_colors.
767  * Return the indexes of the closest entries in the bestcolor[] array.
768  * This routine uses Thomas' incremental distance calculation method to
769  * find the distance from a colormap entry to successive cells in the box.
770  */
771 {
772   int ic0, ic1, ic2;
773   int i, icolor;
774   register JLONG *bptr;         /* pointer into bestdist[] array */
775   JSAMPLE *cptr;                /* pointer into bestcolor[] array */
776   JLONG dist0, dist1;           /* initial distance values */
777   register JLONG dist2;         /* current distance in inner loop */
778   JLONG xx0, xx1;               /* distance increments */
779   register JLONG xx2;
780   JLONG inc0, inc1, inc2;       /* initial values for increments */
781   /* This array holds the distance to the nearest-so-far color for each cell */
782   JLONG bestdist[BOX_C0_ELEMS * BOX_C1_ELEMS * BOX_C2_ELEMS];
783
784   /* Initialize best-distance for each cell of the update box */
785   bptr = bestdist;
786   for (i = BOX_C0_ELEMS*BOX_C1_ELEMS*BOX_C2_ELEMS-1; i >= 0; i--)
787     *bptr++ = 0x7FFFFFFFL;
788
789   /* For each color selected by find_nearby_colors,
790    * compute its distance to the center of each cell in the box.
791    * If that's less than best-so-far, update best distance and color number.
792    */
793
794   /* Nominal steps between cell centers ("x" in Thomas article) */
795 #define STEP_C0  ((1 << C0_SHIFT) * C0_SCALE)
796 #define STEP_C1  ((1 << C1_SHIFT) * C1_SCALE)
797 #define STEP_C2  ((1 << C2_SHIFT) * C2_SCALE)
798
799   for (i = 0; i < numcolors; i++) {
800     icolor = GETJSAMPLE(colorlist[i]);
801     /* Compute (square of) distance from minc0/c1/c2 to this color */
802     inc0 = (minc0 - GETJSAMPLE(cinfo->colormap[0][icolor])) * C0_SCALE;
803     dist0 = inc0*inc0;
804     inc1 = (minc1 - GETJSAMPLE(cinfo->colormap[1][icolor])) * C1_SCALE;
805     dist0 += inc1*inc1;
806     inc2 = (minc2 - GETJSAMPLE(cinfo->colormap[2][icolor])) * C2_SCALE;
807     dist0 += inc2*inc2;
808     /* Form the initial difference increments */
809     inc0 = inc0 * (2 * STEP_C0) + STEP_C0 * STEP_C0;
810     inc1 = inc1 * (2 * STEP_C1) + STEP_C1 * STEP_C1;
811     inc2 = inc2 * (2 * STEP_C2) + STEP_C2 * STEP_C2;
812     /* Now loop over all cells in box, updating distance per Thomas method */
813     bptr = bestdist;
814     cptr = bestcolor;
815     xx0 = inc0;
816     for (ic0 = BOX_C0_ELEMS-1; ic0 >= 0; ic0--) {
817       dist1 = dist0;
818       xx1 = inc1;
819       for (ic1 = BOX_C1_ELEMS-1; ic1 >= 0; ic1--) {
820         dist2 = dist1;
821         xx2 = inc2;
822         for (ic2 = BOX_C2_ELEMS-1; ic2 >= 0; ic2--) {
823           if (dist2 < *bptr) {
824             *bptr = dist2;
825             *cptr = (JSAMPLE) icolor;
826           }
827           dist2 += xx2;
828           xx2 += 2 * STEP_C2 * STEP_C2;
829           bptr++;
830           cptr++;
831         }
832         dist1 += xx1;
833         xx1 += 2 * STEP_C1 * STEP_C1;
834       }
835       dist0 += xx0;
836       xx0 += 2 * STEP_C0 * STEP_C0;
837     }
838   }
839 }
840
841
842 LOCAL(void)
843 fill_inverse_cmap (j_decompress_ptr cinfo, int c0, int c1, int c2)
844 /* Fill the inverse-colormap entries in the update box that contains */
845 /* histogram cell c0/c1/c2.  (Only that one cell MUST be filled, but */
846 /* we can fill as many others as we wish.) */
847 {
848   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
849   hist3d histogram = cquantize->histogram;
850   int minc0, minc1, minc2;      /* lower left corner of update box */
851   int ic0, ic1, ic2;
852   register JSAMPLE *cptr;       /* pointer into bestcolor[] array */
853   register histptr cachep;      /* pointer into main cache array */
854   /* This array lists the candidate colormap indexes. */
855   JSAMPLE colorlist[MAXNUMCOLORS];
856   int numcolors;                /* number of candidate colors */
857   /* This array holds the actually closest colormap index for each cell. */
858   JSAMPLE bestcolor[BOX_C0_ELEMS * BOX_C1_ELEMS * BOX_C2_ELEMS];
859
860   /* Convert cell coordinates to update box ID */
861   c0 >>= BOX_C0_LOG;
862   c1 >>= BOX_C1_LOG;
863   c2 >>= BOX_C2_LOG;
864
865   /* Compute true coordinates of update box's origin corner.
866    * Actually we compute the coordinates of the center of the corner
867    * histogram cell, which are the lower bounds of the volume we care about.
868    */
869   minc0 = (c0 << BOX_C0_SHIFT) + ((1 << C0_SHIFT) >> 1);
870   minc1 = (c1 << BOX_C1_SHIFT) + ((1 << C1_SHIFT) >> 1);
871   minc2 = (c2 << BOX_C2_SHIFT) + ((1 << C2_SHIFT) >> 1);
872
873   /* Determine which colormap entries are close enough to be candidates
874    * for the nearest entry to some cell in the update box.
875    */
876   numcolors = find_nearby_colors(cinfo, minc0, minc1, minc2, colorlist);
877
878   /* Determine the actually nearest colors. */
879   find_best_colors(cinfo, minc0, minc1, minc2, numcolors, colorlist,
880                    bestcolor);
881
882   /* Save the best color numbers (plus 1) in the main cache array */
883   c0 <<= BOX_C0_LOG;            /* convert ID back to base cell indexes */
884   c1 <<= BOX_C1_LOG;
885   c2 <<= BOX_C2_LOG;
886   cptr = bestcolor;
887   for (ic0 = 0; ic0 < BOX_C0_ELEMS; ic0++) {
888     for (ic1 = 0; ic1 < BOX_C1_ELEMS; ic1++) {
889       cachep = & histogram[c0+ic0][c1+ic1][c2];
890       for (ic2 = 0; ic2 < BOX_C2_ELEMS; ic2++) {
891         *cachep++ = (histcell) (GETJSAMPLE(*cptr++) + 1);
892       }
893     }
894   }
895 }
896
897
898 /*
899  * Map some rows of pixels to the output colormapped representation.
900  */
901
902 METHODDEF(void)
903 pass2_no_dither (j_decompress_ptr cinfo,
904                  JSAMPARRAY input_buf, JSAMPARRAY output_buf, int num_rows)
905 /* This version performs no dithering */
906 {
907   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
908   hist3d histogram = cquantize->histogram;
909   register JSAMPROW inptr, outptr;
910   register histptr cachep;
911   register int c0, c1, c2;
912   int row;
913   JDIMENSION col;
914   JDIMENSION width = cinfo->output_width;
915
916   for (row = 0; row < num_rows; row++) {
917     inptr = input_buf[row];
918     outptr = output_buf[row];
919     for (col = width; col > 0; col--) {
920       /* get pixel value and index into the cache */
921       c0 = GETJSAMPLE(*inptr++) >> C0_SHIFT;
922       c1 = GETJSAMPLE(*inptr++) >> C1_SHIFT;
923       c2 = GETJSAMPLE(*inptr++) >> C2_SHIFT;
924       cachep = & histogram[c0][c1][c2];
925       /* If we have not seen this color before, find nearest colormap entry */
926       /* and update the cache */
927       if (*cachep == 0)
928         fill_inverse_cmap(cinfo, c0,c1,c2);
929       /* Now emit the colormap index for this cell */
930       *outptr++ = (JSAMPLE) (*cachep - 1);
931     }
932   }
933 }
934
935
936 METHODDEF(void)
937 pass2_fs_dither (j_decompress_ptr cinfo,
938                  JSAMPARRAY input_buf, JSAMPARRAY output_buf, int num_rows)
939 /* This version performs Floyd-Steinberg dithering */
940 {
941   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
942   hist3d histogram = cquantize->histogram;
943   register LOCFSERROR cur0, cur1, cur2; /* current error or pixel value */
944   LOCFSERROR belowerr0, belowerr1, belowerr2; /* error for pixel below cur */
945   LOCFSERROR bpreverr0, bpreverr1, bpreverr2; /* error for below/prev col */
946   register FSERRPTR errorptr;   /* => fserrors[] at column before current */
947   JSAMPROW inptr;               /* => current input pixel */
948   JSAMPROW outptr;              /* => current output pixel */
949   histptr cachep;
950   int dir;                      /* +1 or -1 depending on direction */
951   int dir3;                     /* 3*dir, for advancing inptr & errorptr */
952   int row;
953   JDIMENSION col;
954   JDIMENSION width = cinfo->output_width;
955   JSAMPLE *range_limit = cinfo->sample_range_limit;
956   int *error_limit = cquantize->error_limiter;
957   JSAMPROW colormap0 = cinfo->colormap[0];
958   JSAMPROW colormap1 = cinfo->colormap[1];
959   JSAMPROW colormap2 = cinfo->colormap[2];
960   SHIFT_TEMPS
961
962   for (row = 0; row < num_rows; row++) {
963     inptr = input_buf[row];
964     outptr = output_buf[row];
965     if (cquantize->on_odd_row) {
966       /* work right to left in this row */
967       inptr += (width-1) * 3;   /* so point to rightmost pixel */
968       outptr += width-1;
969       dir = -1;
970       dir3 = -3;
971       errorptr = cquantize->fserrors + (width+1)*3; /* => entry after last column */
972       cquantize->on_odd_row = FALSE; /* flip for next time */
973     } else {
974       /* work left to right in this row */
975       dir = 1;
976       dir3 = 3;
977       errorptr = cquantize->fserrors; /* => entry before first real column */
978       cquantize->on_odd_row = TRUE; /* flip for next time */
979     }
980     /* Preset error values: no error propagated to first pixel from left */
981     cur0 = cur1 = cur2 = 0;
982     /* and no error propagated to row below yet */
983     belowerr0 = belowerr1 = belowerr2 = 0;
984     bpreverr0 = bpreverr1 = bpreverr2 = 0;
985
986     for (col = width; col > 0; col--) {
987       /* curN holds the error propagated from the previous pixel on the
988        * current line.  Add the error propagated from the previous line
989        * to form the complete error correction term for this pixel, and
990        * round the error term (which is expressed * 16) to an integer.
991        * RIGHT_SHIFT rounds towards minus infinity, so adding 8 is correct
992        * for either sign of the error value.
993        * Note: errorptr points to *previous* column's array entry.
994        */
995       cur0 = RIGHT_SHIFT(cur0 + errorptr[dir3+0] + 8, 4);
996       cur1 = RIGHT_SHIFT(cur1 + errorptr[dir3+1] + 8, 4);
997       cur2 = RIGHT_SHIFT(cur2 + errorptr[dir3+2] + 8, 4);
998       /* Limit the error using transfer function set by init_error_limit.
999        * See comments with init_error_limit for rationale.
1000        */
1001       cur0 = error_limit[cur0];
1002       cur1 = error_limit[cur1];
1003       cur2 = error_limit[cur2];
1004       /* Form pixel value + error, and range-limit to 0..MAXJSAMPLE.
1005        * The maximum error is +- MAXJSAMPLE (or less with error limiting);
1006        * this sets the required size of the range_limit array.
1007        */
1008       cur0 += GETJSAMPLE(inptr[0]);
1009       cur1 += GETJSAMPLE(inptr[1]);
1010       cur2 += GETJSAMPLE(inptr[2]);
1011       cur0 = GETJSAMPLE(range_limit[cur0]);
1012       cur1 = GETJSAMPLE(range_limit[cur1]);
1013       cur2 = GETJSAMPLE(range_limit[cur2]);
1014       /* Index into the cache with adjusted pixel value */
1015       cachep = & histogram[cur0>>C0_SHIFT][cur1>>C1_SHIFT][cur2>>C2_SHIFT];
1016       /* If we have not seen this color before, find nearest colormap */
1017       /* entry and update the cache */
1018       if (*cachep == 0)
1019         fill_inverse_cmap(cinfo, cur0>>C0_SHIFT,cur1>>C1_SHIFT,cur2>>C2_SHIFT);
1020       /* Now emit the colormap index for this cell */
1021       { register int pixcode = *cachep - 1;
1022         *outptr = (JSAMPLE) pixcode;
1023         /* Compute representation error for this pixel */
1024         cur0 -= GETJSAMPLE(colormap0[pixcode]);
1025         cur1 -= GETJSAMPLE(colormap1[pixcode]);
1026         cur2 -= GETJSAMPLE(colormap2[pixcode]);
1027       }
1028       /* Compute error fractions to be propagated to adjacent pixels.
1029        * Add these into the running sums, and simultaneously shift the
1030        * next-line error sums left by 1 column.
1031        */
1032       { register LOCFSERROR bnexterr;
1033
1034         bnexterr = cur0;        /* Process component 0 */
1035         errorptr[0] = (FSERROR) (bpreverr0 + cur0 * 3);
1036         bpreverr0 = belowerr0 + cur0 * 5;
1037         belowerr0 = bnexterr;
1038         cur0 *= 7;
1039         bnexterr = cur1;        /* Process component 1 */
1040         errorptr[1] = (FSERROR) (bpreverr1 + cur1 * 3);
1041         bpreverr1 = belowerr1 + cur1 * 5;
1042         belowerr1 = bnexterr;
1043         cur1 *= 7;
1044         bnexterr = cur2;        /* Process component 2 */
1045         errorptr[2] = (FSERROR) (bpreverr2 + cur2 * 3);
1046         bpreverr2 = belowerr2 + cur2 * 5;
1047         belowerr2 = bnexterr;
1048         cur2 *= 7;
1049       }
1050       /* At this point curN contains the 7/16 error value to be propagated
1051        * to the next pixel on the current line, and all the errors for the
1052        * next line have been shifted over.  We are therefore ready to move on.
1053        */
1054       inptr += dir3;            /* Advance pixel pointers to next column */
1055       outptr += dir;
1056       errorptr += dir3;         /* advance errorptr to current column */
1057     }
1058     /* Post-loop cleanup: we must unload the final error values into the
1059      * final fserrors[] entry.  Note we need not unload belowerrN because
1060      * it is for the dummy column before or after the actual array.
1061      */
1062     errorptr[0] = (FSERROR) bpreverr0; /* unload prev errs into array */
1063     errorptr[1] = (FSERROR) bpreverr1;
1064     errorptr[2] = (FSERROR) bpreverr2;
1065   }
1066 }
1067
1068
1069 /*
1070  * Initialize the error-limiting transfer function (lookup table).
1071  * The raw F-S error computation can potentially compute error values of up to
1072  * +- MAXJSAMPLE.  But we want the maximum correction applied to a pixel to be
1073  * much less, otherwise obviously wrong pixels will be created.  (Typical
1074  * effects include weird fringes at color-area boundaries, isolated bright
1075  * pixels in a dark area, etc.)  The standard advice for avoiding this problem
1076  * is to ensure that the "corners" of the color cube are allocated as output
1077  * colors; then repeated errors in the same direction cannot cause cascading
1078  * error buildup.  However, that only prevents the error from getting
1079  * completely out of hand; Aaron Giles reports that error limiting improves
1080  * the results even with corner colors allocated.
1081  * A simple clamping of the error values to about +- MAXJSAMPLE/8 works pretty
1082  * well, but the smoother transfer function used below is even better.  Thanks
1083  * to Aaron Giles for this idea.
1084  */
1085
1086 LOCAL(void)
1087 init_error_limit (j_decompress_ptr cinfo)
1088 /* Allocate and fill in the error_limiter table */
1089 {
1090   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
1091   int *table;
1092   int in, out;
1093
1094   table = (int *) (*cinfo->mem->alloc_small)
1095     ((j_common_ptr) cinfo, JPOOL_IMAGE, (MAXJSAMPLE*2+1) * sizeof(int));
1096   table += MAXJSAMPLE;          /* so can index -MAXJSAMPLE .. +MAXJSAMPLE */
1097   cquantize->error_limiter = table;
1098
1099 #define STEPSIZE ((MAXJSAMPLE+1)/16)
1100   /* Map errors 1:1 up to +- MAXJSAMPLE/16 */
1101   out = 0;
1102   for (in = 0; in < STEPSIZE; in++, out++) {
1103     table[in] = out; table[-in] = -out;
1104   }
1105   /* Map errors 1:2 up to +- 3*MAXJSAMPLE/16 */
1106   for (; in < STEPSIZE*3; in++, out += (in&1) ? 0 : 1) {
1107     table[in] = out; table[-in] = -out;
1108   }
1109   /* Clamp the rest to final out value (which is (MAXJSAMPLE+1)/8) */
1110   for (; in <= MAXJSAMPLE; in++) {
1111     table[in] = out; table[-in] = -out;
1112   }
1113 #undef STEPSIZE
1114 }
1115
1116
1117 /*
1118  * Finish up at the end of each pass.
1119  */
1120
1121 METHODDEF(void)
1122 finish_pass1 (j_decompress_ptr cinfo)
1123 {
1124   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
1125
1126   /* Select the representative colors and fill in cinfo->colormap */
1127   cinfo->colormap = cquantize->sv_colormap;
1128   select_colors(cinfo, cquantize->desired);
1129   /* Force next pass to zero the color index table */
1130   cquantize->needs_zeroed = TRUE;
1131 }
1132
1133
1134 METHODDEF(void)
1135 finish_pass2 (j_decompress_ptr cinfo)
1136 {
1137   /* no work */
1138 }
1139
1140
1141 /*
1142  * Initialize for each processing pass.
1143  */
1144
1145 METHODDEF(void)
1146 start_pass_2_quant (j_decompress_ptr cinfo, boolean is_pre_scan)
1147 {
1148   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
1149   hist3d histogram = cquantize->histogram;
1150   int i;
1151
1152   /* Only F-S dithering or no dithering is supported. */
1153   /* If user asks for ordered dither, give him F-S. */
1154   if (cinfo->dither_mode != JDITHER_NONE)
1155     cinfo->dither_mode = JDITHER_FS;
1156
1157   if (is_pre_scan) {
1158     /* Set up method pointers */
1159     cquantize->pub.color_quantize = prescan_quantize;
1160     cquantize->pub.finish_pass = finish_pass1;
1161     cquantize->needs_zeroed = TRUE; /* Always zero histogram */
1162   } else {
1163     /* Set up method pointers */
1164     if (cinfo->dither_mode == JDITHER_FS)
1165       cquantize->pub.color_quantize = pass2_fs_dither;
1166     else
1167       cquantize->pub.color_quantize = pass2_no_dither;
1168     cquantize->pub.finish_pass = finish_pass2;
1169
1170     /* Make sure color count is acceptable */
1171     i = cinfo->actual_number_of_colors;
1172     if (i < 1)
1173       ERREXIT1(cinfo, JERR_QUANT_FEW_COLORS, 1);
1174     if (i > MAXNUMCOLORS)
1175       ERREXIT1(cinfo, JERR_QUANT_MANY_COLORS, MAXNUMCOLORS);
1176
1177     if (cinfo->dither_mode == JDITHER_FS) {
1178       size_t arraysize = (size_t) ((cinfo->output_width + 2) *
1179                                    (3 * sizeof(FSERROR)));
1180       /* Allocate Floyd-Steinberg workspace if we didn't already. */
1181       if (cquantize->fserrors == NULL)
1182         cquantize->fserrors = (FSERRPTR) (*cinfo->mem->alloc_large)
1183           ((j_common_ptr) cinfo, JPOOL_IMAGE, arraysize);
1184       /* Initialize the propagated errors to zero. */
1185       jzero_far((void *) cquantize->fserrors, arraysize);
1186       /* Make the error-limit table if we didn't already. */
1187       if (cquantize->error_limiter == NULL)
1188         init_error_limit(cinfo);
1189       cquantize->on_odd_row = FALSE;
1190     }
1191
1192   }
1193   /* Zero the histogram or inverse color map, if necessary */
1194   if (cquantize->needs_zeroed) {
1195     for (i = 0; i < HIST_C0_ELEMS; i++) {
1196       jzero_far((void *) histogram[i],
1197                 HIST_C1_ELEMS*HIST_C2_ELEMS * sizeof(histcell));
1198     }
1199     cquantize->needs_zeroed = FALSE;
1200   }
1201 }
1202
1203
1204 /*
1205  * Switch to a new external colormap between output passes.
1206  */
1207
1208 METHODDEF(void)
1209 new_color_map_2_quant (j_decompress_ptr cinfo)
1210 {
1211   my_cquantize_ptr cquantize = (my_cquantize_ptr) cinfo->cquantize;
1212
1213   /* Reset the inverse color map */
1214   cquantize->needs_zeroed = TRUE;
1215 }
1216
1217
1218 /*
1219  * Module initialization routine for 2-pass color quantization.
1220  */
1221
1222 GLOBAL(void)
1223 jinit_2pass_quantizer (j_decompress_ptr cinfo)
1224 {
1225   my_cquantize_ptr cquantize;
1226   int i;
1227
1228   cquantize = (my_cquantize_ptr)
1229     (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
1230                                 sizeof(my_cquantizer));
1231   cinfo->cquantize = (struct jpeg_color_quantizer *) cquantize;
1232   cquantize->pub.start_pass = start_pass_2_quant;
1233   cquantize->pub.new_color_map = new_color_map_2_quant;
1234   cquantize->fserrors = NULL;   /* flag optional arrays not allocated */
1235   cquantize->error_limiter = NULL;
1236
1237   /* Make sure jdmaster didn't give me a case I can't handle */
1238   if (cinfo->out_color_components != 3)
1239     ERREXIT(cinfo, JERR_NOTIMPL);
1240
1241   /* Allocate the histogram/inverse colormap storage */
1242   cquantize->histogram = (hist3d) (*cinfo->mem->alloc_small)
1243     ((j_common_ptr) cinfo, JPOOL_IMAGE, HIST_C0_ELEMS * sizeof(hist2d));
1244   for (i = 0; i < HIST_C0_ELEMS; i++) {
1245     cquantize->histogram[i] = (hist2d) (*cinfo->mem->alloc_large)
1246       ((j_common_ptr) cinfo, JPOOL_IMAGE,
1247        HIST_C1_ELEMS*HIST_C2_ELEMS * sizeof(histcell));
1248   }
1249   cquantize->needs_zeroed = TRUE; /* histogram is garbage now */
1250
1251   /* Allocate storage for the completed colormap, if required.
1252    * We do this now since it may affect the memory manager's space
1253    * calculations.
1254    */
1255   if (cinfo->enable_2pass_quant) {
1256     /* Make sure color count is acceptable */
1257     int desired = cinfo->desired_number_of_colors;
1258     /* Lower bound on # of colors ... somewhat arbitrary as long as > 0 */
1259     if (desired < 8)
1260       ERREXIT1(cinfo, JERR_QUANT_FEW_COLORS, 8);
1261     /* Make sure colormap indexes can be represented by JSAMPLEs */
1262     if (desired > MAXNUMCOLORS)
1263       ERREXIT1(cinfo, JERR_QUANT_MANY_COLORS, MAXNUMCOLORS);
1264     cquantize->sv_colormap = (*cinfo->mem->alloc_sarray)
1265       ((j_common_ptr) cinfo,JPOOL_IMAGE, (JDIMENSION) desired, (JDIMENSION) 3);
1266     cquantize->desired = desired;
1267   } else
1268     cquantize->sv_colormap = NULL;
1269
1270   /* Only F-S dithering or no dithering is supported. */
1271   /* If user asks for ordered dither, give him F-S. */
1272   if (cinfo->dither_mode != JDITHER_NONE)
1273     cinfo->dither_mode = JDITHER_FS;
1274
1275   /* Allocate Floyd-Steinberg workspace if necessary.
1276    * This isn't really needed until pass 2, but again it may affect the memory
1277    * manager's space calculations.  Although we will cope with a later change
1278    * in dither_mode, we do not promise to honor max_memory_to_use if
1279    * dither_mode changes.
1280    */
1281   if (cinfo->dither_mode == JDITHER_FS) {
1282     cquantize->fserrors = (FSERRPTR) (*cinfo->mem->alloc_large)
1283       ((j_common_ptr) cinfo, JPOOL_IMAGE,
1284        (size_t) ((cinfo->output_width + 2) * (3 * sizeof(FSERROR))));
1285     /* Might as well create the error-limiting table too. */
1286     init_error_limit(cinfo);
1287   }
1288 }
1289
1290 #endif /* QUANT_2PASS_SUPPORTED */