* modules/*: sanitization of the modules description strings.
[vlc.git] / modules / codec / mpeg_video / idct / idctclassic.c
1 /*****************************************************************************
2  * idctclassic.c : Classic IDCT module
3  *****************************************************************************
4  * Copyright (C) 1999-2001 VideoLAN
5  * $Id: idctclassic.c,v 1.2 2003/03/30 18:14:36 gbazin Exp $
6  *
7  * Authors: GaĆ«l Hendryckx <jimmy@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  * 
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31
32 #include "idct.h"
33 #include "block_c.h"
34
35 static int Open( vlc_object_t *p_this );
36
37 /*****************************************************************************
38  * Module descriptor
39  *****************************************************************************/
40 vlc_module_begin();
41     set_description( _("classic IDCT") );
42     set_capability( "idct", 100 );
43     add_shortcut( "classic" );
44     set_callbacks( Open, NULL );
45 vlc_module_end();
46
47 /*****************************************************************************
48  * NormScan : Unused in this IDCT
49  *****************************************************************************/
50 static void NormScan( u8 ppi_scan[2][64] )
51 {
52 }
53
54 /*****************************************************************************
55  * IDCT : IDCT function for normal matrices
56  *****************************************************************************/
57 static inline void IDCT( dctelem_t * p_block )
58 {
59     s32 tmp0, tmp1, tmp2, tmp3;
60     s32 tmp10, tmp11, tmp12, tmp13;
61     s32 z1, z2, z3, z4, z5;
62     dctelem_t * dataptr;
63     int rowctr;
64     SHIFT_TEMPS
65
66   /* Pass 1: process rows. */
67   /* Note results are scaled up by sqrt(8) compared to a true IDCT; */
68   /* furthermore, we scale the results by 2**PASS1_BITS. */
69
70     dataptr = p_block;
71     for (rowctr = DCTSIZE-1; rowctr >= 0; rowctr--)
72     {
73     /* Due to quantization, we will usually find that many of the input
74      * coefficients are zero, especially the AC terms.  We can exploit this
75      * by short-circuiting the IDCT calculation for any row in which all
76      * the AC terms are zero.  In that case each output is equal to the
77      * DC coefficient (with scale factor as needed).
78      * With typical images and quantization tables, half or more of the
79      * row DCT calculations can be simplified this way.
80      */
81
82         if ((dataptr[1] | dataptr[2] | dataptr[3] | dataptr[4] |
83                 dataptr[5] | dataptr[6] | dataptr[7]) == 0)
84         {
85       /* AC terms all zero */
86             dctelem_t dcval = (dctelem_t) (dataptr[0] << PASS1_BITS);
87
88             dataptr[0] = dcval;
89             dataptr[1] = dcval;
90             dataptr[2] = dcval;
91             dataptr[3] = dcval;
92             dataptr[4] = dcval;
93             dataptr[5] = dcval;
94             dataptr[6] = dcval;
95             dataptr[7] = dcval;
96
97             dataptr += DCTSIZE; /* advance pointer to next row */
98             continue;
99         }
100
101     /* Even part: reverse the even part of the forward DCT. */
102     /* The rotator is sqrt(2)*c(-6). */
103
104         z2 = (s32) dataptr[2];
105         z3 = (s32) dataptr[6];
106
107         z1 = MULTIPLY(z2 + z3, FIX(0.541196100));
108         tmp2 = z1 + MULTIPLY(z3, - FIX(1.847759065));
109         tmp3 = z1 + MULTIPLY(z2, FIX(0.765366865));
110
111         tmp0 = ((s32) dataptr[0] + (s32) dataptr[4]) << CONST_BITS;
112         tmp1 = ((s32) dataptr[0] - (s32) dataptr[4]) << CONST_BITS;
113
114         tmp10 = tmp0 + tmp3;
115         tmp13 = tmp0 - tmp3;
116         tmp11 = tmp1 + tmp2;
117         tmp12 = tmp1 - tmp2;
118
119     /* Odd part per figure 8; the matrix is unitary and hence its
120      * transpose is its inverse.  i0..i3 are y7,y5,y3,y1 respectively.
121      */
122
123         tmp0 = (s32) dataptr[7];
124         tmp1 = (s32) dataptr[5];
125         tmp2 = (s32) dataptr[3];
126         tmp3 = (s32) dataptr[1];
127
128         z1 = tmp0 + tmp3;
129         z2 = tmp1 + tmp2;
130         z3 = tmp0 + tmp2;
131         z4 = tmp1 + tmp3;
132         z5 = MULTIPLY(z3 + z4, FIX(1.175875602)); /* sqrt(2) * c3 */
133
134         tmp0 = MULTIPLY(tmp0, FIX(0.298631336)); /* sqrt(2) * (-c1+c3+c5-c7) */
135         tmp1 = MULTIPLY(tmp1, FIX(2.053119869)); /* sqrt(2) * ( c1+c3-c5+c7) */
136         tmp2 = MULTIPLY(tmp2, FIX(3.072711026)); /* sqrt(2) * ( c1+c3+c5-c7) */
137         tmp3 = MULTIPLY(tmp3, FIX(1.501321110)); /* sqrt(2) * ( c1+c3-c5-c7) */
138         z1 = MULTIPLY(z1, - FIX(0.899976223)); /* sqrt(2) * (c7-c3) */
139         z2 = MULTIPLY(z2, - FIX(2.562915447)); /* sqrt(2) * (-c1-c3) */
140         z3 = MULTIPLY(z3, - FIX(1.961570560)); /* sqrt(2) * (-c3-c5) */
141         z4 = MULTIPLY(z4, - FIX(0.390180644)); /* sqrt(2) * (c5-c3) */
142
143         z3 += z5;
144         z4 += z5;
145
146         tmp0 += z1 + z3;
147         tmp1 += z2 + z4;
148         tmp2 += z2 + z3;
149         tmp3 += z1 + z4;
150
151     /* Final output stage: inputs are tmp10..tmp13, tmp0..tmp3 */
152
153         dataptr[0] = (dctelem_t) DESCALE(tmp10 + tmp3, CONST_BITS-PASS1_BITS);
154         dataptr[7] = (dctelem_t) DESCALE(tmp10 - tmp3, CONST_BITS-PASS1_BITS);
155         dataptr[1] = (dctelem_t) DESCALE(tmp11 + tmp2, CONST_BITS-PASS1_BITS);
156         dataptr[6] = (dctelem_t) DESCALE(tmp11 - tmp2, CONST_BITS-PASS1_BITS);
157         dataptr[2] = (dctelem_t) DESCALE(tmp12 + tmp1, CONST_BITS-PASS1_BITS);
158         dataptr[5] = (dctelem_t) DESCALE(tmp12 - tmp1, CONST_BITS-PASS1_BITS);
159         dataptr[3] = (dctelem_t) DESCALE(tmp13 + tmp0, CONST_BITS-PASS1_BITS);
160         dataptr[4] = (dctelem_t) DESCALE(tmp13 - tmp0, CONST_BITS-PASS1_BITS);
161
162         dataptr += DCTSIZE;             /* advance pointer to next row */
163     }
164
165   /* Pass 2: process columns. */
166   /* Note that we must descale the results by a factor of 8 == 2**3, */
167   /* and also undo the PASS1_BITS scaling. */
168
169     dataptr = p_block;
170     for (rowctr = DCTSIZE-1; rowctr >= 0; rowctr--)
171     {
172     /* Columns of zeroes can be exploited in the same way as we did with rows.
173      * However, the row calculation has created many nonzero AC terms, so the
174      * simplification applies less often (typically 5% to 10% of the time).
175      * On machines with very fast multiplication, it's possible that the
176      * test takes more time than it's worth.  In that case this section
177      * may be commented out.
178      */
179
180 #ifndef NO_ZERO_COLUMN_TEST /* Adds a test but avoids calculus */
181         if ((dataptr[DCTSIZE*1] | dataptr[DCTSIZE*2] | dataptr[DCTSIZE*3] |
182             dataptr[DCTSIZE*4] | dataptr[DCTSIZE*5] | dataptr[DCTSIZE*6] |
183             dataptr[DCTSIZE*7]) == 0)
184         {
185       /* AC terms all zero */
186             dctelem_t dcval = (dctelem_t) DESCALE((s32) dataptr[0], PASS1_BITS+3);
187
188             dataptr[DCTSIZE*0] = dcval;
189             dataptr[DCTSIZE*1] = dcval;
190             dataptr[DCTSIZE*2] = dcval;
191             dataptr[DCTSIZE*3] = dcval;
192             dataptr[DCTSIZE*4] = dcval;
193             dataptr[DCTSIZE*5] = dcval;
194             dataptr[DCTSIZE*6] = dcval;
195             dataptr[DCTSIZE*7] = dcval;
196
197             dataptr++;          /* advance pointer to next column */
198             continue;
199         }
200 #endif
201
202     /* Even part: reverse the even part of the forward DCT. */
203     /* The rotator is sqrt(2)*c(-6). */
204
205         z2 = (s32) dataptr[DCTSIZE*2];
206         z3 = (s32) dataptr[DCTSIZE*6];
207
208         z1 = MULTIPLY(z2 + z3, FIX(0.541196100));
209         tmp2 = z1 + MULTIPLY(z3, - FIX(1.847759065));
210         tmp3 = z1 + MULTIPLY(z2, FIX(0.765366865));
211
212         tmp0 = ((s32) dataptr[DCTSIZE*0] + (s32) dataptr[DCTSIZE*4]) << CONST_BITS;
213         tmp1 = ((s32) dataptr[DCTSIZE*0] - (s32) dataptr[DCTSIZE*4]) << CONST_BITS;
214
215         tmp10 = tmp0 + tmp3;
216         tmp13 = tmp0 - tmp3;
217         tmp11 = tmp1 + tmp2;
218         tmp12 = tmp1 - tmp2;
219
220     /* Odd part per figure 8; the matrix is unitary and hence its
221      * transpose is its inverse.  i0..i3 are y7,y5,y3,y1 respectively.
222      */
223
224         tmp0 = (s32) dataptr[DCTSIZE*7];
225         tmp1 = (s32) dataptr[DCTSIZE*5];
226         tmp2 = (s32) dataptr[DCTSIZE*3];
227         tmp3 = (s32) dataptr[DCTSIZE*1];
228
229         z1 = tmp0 + tmp3;
230         z2 = tmp1 + tmp2;
231         z3 = tmp0 + tmp2;
232         z4 = tmp1 + tmp3;
233         z5 = MULTIPLY(z3 + z4, FIX(1.175875602)); /* sqrt(2) * c3 */
234
235         tmp0 = MULTIPLY(tmp0, FIX(0.298631336)); /* sqrt(2) * (-c1+c3+c5-c7) */
236         tmp1 = MULTIPLY(tmp1, FIX(2.053119869)); /* sqrt(2) * ( c1+c3-c5+c7) */
237         tmp2 = MULTIPLY(tmp2, FIX(3.072711026)); /* sqrt(2) * ( c1+c3+c5-c7) */
238         tmp3 = MULTIPLY(tmp3, FIX(1.501321110)); /* sqrt(2) * ( c1+c3-c5-c7) */
239         z1 = MULTIPLY(z1, - FIX(0.899976223)); /* sqrt(2) * (c7-c3) */
240         z2 = MULTIPLY(z2, - FIX(2.562915447)); /* sqrt(2) * (-c1-c3) */
241         z3 = MULTIPLY(z3, - FIX(1.961570560)); /* sqrt(2) * (-c3-c5) */
242         z4 = MULTIPLY(z4, - FIX(0.390180644)); /* sqrt(2) * (c5-c3) */
243
244         z3 += z5;
245         z4 += z5;
246
247         tmp0 += z1 + z3;
248         tmp1 += z2 + z4;
249         tmp2 += z2 + z3;
250         tmp3 += z1 + z4;
251
252     /* Final output stage: inputs are tmp10..tmp13, tmp0..tmp3 */
253
254         dataptr[DCTSIZE*0] = (dctelem_t) DESCALE(tmp10 + tmp3,
255                                            CONST_BITS+PASS1_BITS+3);
256         dataptr[DCTSIZE*7] = (dctelem_t) DESCALE(tmp10 - tmp3,
257                                            CONST_BITS+PASS1_BITS+3);
258         dataptr[DCTSIZE*1] = (dctelem_t) DESCALE(tmp11 + tmp2,
259                                            CONST_BITS+PASS1_BITS+3);
260         dataptr[DCTSIZE*6] = (dctelem_t) DESCALE(tmp11 - tmp2,
261                                            CONST_BITS+PASS1_BITS+3);
262         dataptr[DCTSIZE*2] = (dctelem_t) DESCALE(tmp12 + tmp1,
263                                            CONST_BITS+PASS1_BITS+3);
264         dataptr[DCTSIZE*5] = (dctelem_t) DESCALE(tmp12 - tmp1,
265                                            CONST_BITS+PASS1_BITS+3);
266         dataptr[DCTSIZE*3] = (dctelem_t) DESCALE(tmp13 + tmp0,
267                                            CONST_BITS+PASS1_BITS+3);
268         dataptr[DCTSIZE*4] = (dctelem_t) DESCALE(tmp13 - tmp0,
269                                            CONST_BITS+PASS1_BITS+3);
270
271         dataptr++;                      /* advance pointer to next column */
272     }
273 }
274
275 static inline void RestoreCPUState( )
276 {
277     ;
278 }
279
280 #include "idct_sparse.h"
281 #include "idct_decl.h"