* UINTX -> uintx_t INTX -> intx_t
[ffmpeg.git] / libavcodec / jfdctint.c
1 /*
2  * jfdctint.c
3  *
4  * Copyright (C) 1991-1996, Thomas G. Lane.
5  * This file is part of the Independent JPEG Group's software.
6  * For conditions of distribution and use, see the accompanying README file.
7  *
8  * This file contains a slow-but-accurate integer implementation of the
9  * forward DCT (Discrete Cosine Transform).
10  *
11  * A 2-D DCT can be done by 1-D DCT on each row followed by 1-D DCT
12  * on each column.  Direct algorithms are also available, but they are
13  * much more complex and seem not to be any faster when reduced to code.
14  *
15  * This implementation is based on an algorithm described in
16  *   C. Loeffler, A. Ligtenberg and G. Moschytz, "Practical Fast 1-D DCT
17  *   Algorithms with 11 Multiplications", Proc. Int'l. Conf. on Acoustics,
18  *   Speech, and Signal Processing 1989 (ICASSP '89), pp. 988-991.
19  * The primary algorithm described there uses 11 multiplies and 29 adds.
20  * We use their alternate method with 12 multiplies and 32 adds.
21  * The advantage of this method is that no data path contains more than one
22  * multiplication; this allows a very simple and accurate implementation in
23  * scaled fixed-point arithmetic, with a minimal number of shifts.
24  */
25
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include "common.h"
29 #include "dsputil.h"
30
31 #define SHIFT_TEMPS
32 #define DCTSIZE 8
33 #define BITS_IN_JSAMPLE 8
34 #define GLOBAL(x) x
35 #define RIGHT_SHIFT(x, n) ((x) >> (n))
36 #define MULTIPLY16C16(var,const) ((var)*(const))
37
38 #if 1 //def USE_ACCURATE_ROUNDING
39 #define DESCALE(x,n)  RIGHT_SHIFT((x) + (1 << ((n) - 1)), n)
40 #else
41 #define DESCALE(x,n)  RIGHT_SHIFT(x, n)
42 #endif
43
44
45 /*
46  * This module is specialized to the case DCTSIZE = 8.
47  */
48
49 #if DCTSIZE != 8
50   Sorry, this code only copes with 8x8 DCTs. /* deliberate syntax err */
51 #endif
52
53
54 /*
55  * The poop on this scaling stuff is as follows:
56  *
57  * Each 1-D DCT step produces outputs which are a factor of sqrt(N)
58  * larger than the true DCT outputs.  The final outputs are therefore
59  * a factor of N larger than desired; since N=8 this can be cured by
60  * a simple right shift at the end of the algorithm.  The advantage of
61  * this arrangement is that we save two multiplications per 1-D DCT,
62  * because the y0 and y4 outputs need not be divided by sqrt(N).
63  * In the IJG code, this factor of 8 is removed by the quantization step
64  * (in jcdctmgr.c), NOT in this module.
65  *
66  * We have to do addition and subtraction of the integer inputs, which
67  * is no problem, and multiplication by fractional constants, which is
68  * a problem to do in integer arithmetic.  We multiply all the constants
69  * by CONST_SCALE and convert them to integer constants (thus retaining
70  * CONST_BITS bits of precision in the constants).  After doing a
71  * multiplication we have to divide the product by CONST_SCALE, with proper
72  * rounding, to produce the correct output.  This division can be done
73  * cheaply as a right shift of CONST_BITS bits.  We postpone shifting
74  * as long as possible so that partial sums can be added together with
75  * full fractional precision.
76  *
77  * The outputs of the first pass are scaled up by PASS1_BITS bits so that
78  * they are represented to better-than-integral precision.  These outputs
79  * require BITS_IN_JSAMPLE + PASS1_BITS + 3 bits; this fits in a 16-bit word
80  * with the recommended scaling.  (For 12-bit sample data, the intermediate
81  * array is int32_t anyway.)
82  *
83  * To avoid overflow of the 32-bit intermediate results in pass 2, we must
84  * have BITS_IN_JSAMPLE + CONST_BITS + PASS1_BITS <= 26.  Error analysis
85  * shows that the values given below are the most effective.
86  */
87
88 #if BITS_IN_JSAMPLE == 8
89 #define CONST_BITS  13
90 #define PASS1_BITS  4           /* set this to 2 if 16x16 multiplies are faster */
91 #else
92 #define CONST_BITS  13
93 #define PASS1_BITS  1           /* lose a little precision to avoid overflow */
94 #endif
95
96 /* Some C compilers fail to reduce "FIX(constant)" at compile time, thus
97  * causing a lot of useless floating-point operations at run time.
98  * To get around this we use the following pre-calculated constants.
99  * If you change CONST_BITS you may want to add appropriate values.
100  * (With a reasonable C compiler, you can just rely on the FIX() macro...)
101  */
102
103 #if CONST_BITS == 13
104 #define FIX_0_298631336  ((int32_t)  2446)      /* FIX(0.298631336) */
105 #define FIX_0_390180644  ((int32_t)  3196)      /* FIX(0.390180644) */
106 #define FIX_0_541196100  ((int32_t)  4433)      /* FIX(0.541196100) */
107 #define FIX_0_765366865  ((int32_t)  6270)      /* FIX(0.765366865) */
108 #define FIX_0_899976223  ((int32_t)  7373)      /* FIX(0.899976223) */
109 #define FIX_1_175875602  ((int32_t)  9633)      /* FIX(1.175875602) */
110 #define FIX_1_501321110  ((int32_t)  12299)     /* FIX(1.501321110) */
111 #define FIX_1_847759065  ((int32_t)  15137)     /* FIX(1.847759065) */
112 #define FIX_1_961570560  ((int32_t)  16069)     /* FIX(1.961570560) */
113 #define FIX_2_053119869  ((int32_t)  16819)     /* FIX(2.053119869) */
114 #define FIX_2_562915447  ((int32_t)  20995)     /* FIX(2.562915447) */
115 #define FIX_3_072711026  ((int32_t)  25172)     /* FIX(3.072711026) */
116 #else
117 #define FIX_0_298631336  FIX(0.298631336)
118 #define FIX_0_390180644  FIX(0.390180644)
119 #define FIX_0_541196100  FIX(0.541196100)
120 #define FIX_0_765366865  FIX(0.765366865)
121 #define FIX_0_899976223  FIX(0.899976223)
122 #define FIX_1_175875602  FIX(1.175875602)
123 #define FIX_1_501321110  FIX(1.501321110)
124 #define FIX_1_847759065  FIX(1.847759065)
125 #define FIX_1_961570560  FIX(1.961570560)
126 #define FIX_2_053119869  FIX(2.053119869)
127 #define FIX_2_562915447  FIX(2.562915447)
128 #define FIX_3_072711026  FIX(3.072711026)
129 #endif
130
131
132 /* Multiply an int32_t variable by an int32_t constant to yield an int32_t result.
133  * For 8-bit samples with the recommended scaling, all the variable
134  * and constant values involved are no more than 16 bits wide, so a
135  * 16x16->32 bit multiply can be used instead of a full 32x32 multiply.
136  * For 12-bit samples, a full 32-bit multiplication will be needed.
137  */
138
139 #if BITS_IN_JSAMPLE == 8 && CONST_BITS<=13 && PASS1_BITS<=2
140 #define MULTIPLY(var,const)  MULTIPLY16C16(var,const)
141 #else
142 #define MULTIPLY(var,const)  ((var) * (const))
143 #endif
144
145
146 /*
147  * Perform the forward DCT on one block of samples.
148  */
149
150 GLOBAL(void)
151 ff_jpeg_fdct_islow (DCTELEM * data)
152 {
153   int32_t tmp0, tmp1, tmp2, tmp3, tmp4, tmp5, tmp6, tmp7;
154   int32_t tmp10, tmp11, tmp12, tmp13;
155   int32_t z1, z2, z3, z4, z5;
156   DCTELEM *dataptr;
157   int ctr;
158   SHIFT_TEMPS
159
160   /* Pass 1: process rows. */
161   /* Note results are scaled up by sqrt(8) compared to a true DCT; */
162   /* furthermore, we scale the results by 2**PASS1_BITS. */
163
164   dataptr = data;
165   for (ctr = DCTSIZE-1; ctr >= 0; ctr--) {
166     tmp0 = dataptr[0] + dataptr[7];
167     tmp7 = dataptr[0] - dataptr[7];
168     tmp1 = dataptr[1] + dataptr[6];
169     tmp6 = dataptr[1] - dataptr[6];
170     tmp2 = dataptr[2] + dataptr[5];
171     tmp5 = dataptr[2] - dataptr[5];
172     tmp3 = dataptr[3] + dataptr[4];
173     tmp4 = dataptr[3] - dataptr[4];
174     
175     /* Even part per LL&M figure 1 --- note that published figure is faulty;
176      * rotator "sqrt(2)*c1" should be "sqrt(2)*c6".
177      */
178     
179     tmp10 = tmp0 + tmp3;
180     tmp13 = tmp0 - tmp3;
181     tmp11 = tmp1 + tmp2;
182     tmp12 = tmp1 - tmp2;
183     
184     dataptr[0] = (DCTELEM) ((tmp10 + tmp11) << PASS1_BITS);
185     dataptr[4] = (DCTELEM) ((tmp10 - tmp11) << PASS1_BITS);
186     
187     z1 = MULTIPLY(tmp12 + tmp13, FIX_0_541196100);
188     dataptr[2] = (DCTELEM) DESCALE(z1 + MULTIPLY(tmp13, FIX_0_765366865),
189                                    CONST_BITS-PASS1_BITS);
190     dataptr[6] = (DCTELEM) DESCALE(z1 + MULTIPLY(tmp12, - FIX_1_847759065),
191                                    CONST_BITS-PASS1_BITS);
192     
193     /* Odd part per figure 8 --- note paper omits factor of sqrt(2).
194      * cK represents cos(K*pi/16).
195      * i0..i3 in the paper are tmp4..tmp7 here.
196      */
197     
198     z1 = tmp4 + tmp7;
199     z2 = tmp5 + tmp6;
200     z3 = tmp4 + tmp6;
201     z4 = tmp5 + tmp7;
202     z5 = MULTIPLY(z3 + z4, FIX_1_175875602); /* sqrt(2) * c3 */
203     
204     tmp4 = MULTIPLY(tmp4, FIX_0_298631336); /* sqrt(2) * (-c1+c3+c5-c7) */
205     tmp5 = MULTIPLY(tmp5, FIX_2_053119869); /* sqrt(2) * ( c1+c3-c5+c7) */
206     tmp6 = MULTIPLY(tmp6, FIX_3_072711026); /* sqrt(2) * ( c1+c3+c5-c7) */
207     tmp7 = MULTIPLY(tmp7, FIX_1_501321110); /* sqrt(2) * ( c1+c3-c5-c7) */
208     z1 = MULTIPLY(z1, - FIX_0_899976223); /* sqrt(2) * (c7-c3) */
209     z2 = MULTIPLY(z2, - FIX_2_562915447); /* sqrt(2) * (-c1-c3) */
210     z3 = MULTIPLY(z3, - FIX_1_961570560); /* sqrt(2) * (-c3-c5) */
211     z4 = MULTIPLY(z4, - FIX_0_390180644); /* sqrt(2) * (c5-c3) */
212     
213     z3 += z5;
214     z4 += z5;
215     
216     dataptr[7] = (DCTELEM) DESCALE(tmp4 + z1 + z3, CONST_BITS-PASS1_BITS);
217     dataptr[5] = (DCTELEM) DESCALE(tmp5 + z2 + z4, CONST_BITS-PASS1_BITS);
218     dataptr[3] = (DCTELEM) DESCALE(tmp6 + z2 + z3, CONST_BITS-PASS1_BITS);
219     dataptr[1] = (DCTELEM) DESCALE(tmp7 + z1 + z4, CONST_BITS-PASS1_BITS);
220     
221     dataptr += DCTSIZE;         /* advance pointer to next row */
222   }
223
224   /* Pass 2: process columns.
225    * We remove the PASS1_BITS scaling, but leave the results scaled up
226    * by an overall factor of 8.
227    */
228
229   dataptr = data;
230   for (ctr = DCTSIZE-1; ctr >= 0; ctr--) {
231     tmp0 = dataptr[DCTSIZE*0] + dataptr[DCTSIZE*7];
232     tmp7 = dataptr[DCTSIZE*0] - dataptr[DCTSIZE*7];
233     tmp1 = dataptr[DCTSIZE*1] + dataptr[DCTSIZE*6];
234     tmp6 = dataptr[DCTSIZE*1] - dataptr[DCTSIZE*6];
235     tmp2 = dataptr[DCTSIZE*2] + dataptr[DCTSIZE*5];
236     tmp5 = dataptr[DCTSIZE*2] - dataptr[DCTSIZE*5];
237     tmp3 = dataptr[DCTSIZE*3] + dataptr[DCTSIZE*4];
238     tmp4 = dataptr[DCTSIZE*3] - dataptr[DCTSIZE*4];
239     
240     /* Even part per LL&M figure 1 --- note that published figure is faulty;
241      * rotator "sqrt(2)*c1" should be "sqrt(2)*c6".
242      */
243     
244     tmp10 = tmp0 + tmp3;
245     tmp13 = tmp0 - tmp3;
246     tmp11 = tmp1 + tmp2;
247     tmp12 = tmp1 - tmp2;
248     
249     dataptr[DCTSIZE*0] = (DCTELEM) DESCALE(tmp10 + tmp11, PASS1_BITS);
250     dataptr[DCTSIZE*4] = (DCTELEM) DESCALE(tmp10 - tmp11, PASS1_BITS);
251     
252     z1 = MULTIPLY(tmp12 + tmp13, FIX_0_541196100);
253     dataptr[DCTSIZE*2] = (DCTELEM) DESCALE(z1 + MULTIPLY(tmp13, FIX_0_765366865),
254                                            CONST_BITS+PASS1_BITS);
255     dataptr[DCTSIZE*6] = (DCTELEM) DESCALE(z1 + MULTIPLY(tmp12, - FIX_1_847759065),
256                                            CONST_BITS+PASS1_BITS);
257     
258     /* Odd part per figure 8 --- note paper omits factor of sqrt(2).
259      * cK represents cos(K*pi/16).
260      * i0..i3 in the paper are tmp4..tmp7 here.
261      */
262     
263     z1 = tmp4 + tmp7;
264     z2 = tmp5 + tmp6;
265     z3 = tmp4 + tmp6;
266     z4 = tmp5 + tmp7;
267     z5 = MULTIPLY(z3 + z4, FIX_1_175875602); /* sqrt(2) * c3 */
268     
269     tmp4 = MULTIPLY(tmp4, FIX_0_298631336); /* sqrt(2) * (-c1+c3+c5-c7) */
270     tmp5 = MULTIPLY(tmp5, FIX_2_053119869); /* sqrt(2) * ( c1+c3-c5+c7) */
271     tmp6 = MULTIPLY(tmp6, FIX_3_072711026); /* sqrt(2) * ( c1+c3+c5-c7) */
272     tmp7 = MULTIPLY(tmp7, FIX_1_501321110); /* sqrt(2) * ( c1+c3-c5-c7) */
273     z1 = MULTIPLY(z1, - FIX_0_899976223); /* sqrt(2) * (c7-c3) */
274     z2 = MULTIPLY(z2, - FIX_2_562915447); /* sqrt(2) * (-c1-c3) */
275     z3 = MULTIPLY(z3, - FIX_1_961570560); /* sqrt(2) * (-c3-c5) */
276     z4 = MULTIPLY(z4, - FIX_0_390180644); /* sqrt(2) * (c5-c3) */
277     
278     z3 += z5;
279     z4 += z5;
280     
281     dataptr[DCTSIZE*7] = (DCTELEM) DESCALE(tmp4 + z1 + z3,
282                                            CONST_BITS+PASS1_BITS);
283     dataptr[DCTSIZE*5] = (DCTELEM) DESCALE(tmp5 + z2 + z4,
284                                            CONST_BITS+PASS1_BITS);
285     dataptr[DCTSIZE*3] = (DCTELEM) DESCALE(tmp6 + z2 + z3,
286                                            CONST_BITS+PASS1_BITS);
287     dataptr[DCTSIZE*1] = (DCTELEM) DESCALE(tmp7 + z1 + z4,
288                                            CONST_BITS+PASS1_BITS);
289     
290     dataptr++;                  /* advance pointer to next column */
291   }
292 }