ppc: dsputil: comment formatting and wording/grammar improvements
[ffmpeg.git] / libavcodec / ppc / dsputil_ppc.c
1 /*
2  * Copyright (c) 2002 Brian Foley
3  * Copyright (c) 2002 Dieter Shirley
4  * Copyright (c) 2003-2004 Romain Dolbeau <romain@dolbeau.org>
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #include <string.h>
24
25 #include "libavutil/attributes.h"
26 #include "libavutil/cpu.h"
27 #include "libavutil/mem.h"
28 #include "libavutil/ppc/cpu.h"
29 #include "libavcodec/avcodec.h"
30 #include "libavcodec/dsputil.h"
31 #include "dsputil_altivec.h"
32
33 /* ***** WARNING ***** WARNING ***** WARNING ***** */
34 /*
35  * clear_blocks_dcbz32_ppc will not work properly on PowerPC processors with
36  * a cache line size not equal to 32 bytes. Fortunately all processors used
37  * by Apple up to at least the 7450 (AKA second generation G4) use 32-byte
38  * cache lines. This is due to the use of the 'dcbz' instruction. It simply
39  * clears a single cache line to zero, so you need to know the cache line
40  * size to use it! It's absurd, but it's fast...
41  *
42  * update 24/06/2003: Apple released the G5 yesterday, with a PPC970.
43  * cache line size: 128 bytes. Oups.
44  * The semantics of dcbz was changed, it always clears 32 bytes. So the function
45  * below will work, but will be slow. So I fixed check_dcbz_effect to use dcbzl,
46  * which is defined to clear a cache line (as dcbz before). So we can still
47  * distinguish, and use dcbz (32 bytes) or dcbzl (one cache line) as required.
48  *
49  * see <http://developer.apple.com/technotes/tn/tn2087.html>
50  * and <http://developer.apple.com/technotes/tn/tn2086.html>
51  */
52 static void clear_blocks_dcbz32_ppc(int16_t *blocks)
53 {
54     register int misal = ((unsigned long)blocks & 0x00000010);
55     register int i = 0;
56     if (misal) {
57         ((unsigned long*)blocks)[0] = 0L;
58         ((unsigned long*)blocks)[1] = 0L;
59         ((unsigned long*)blocks)[2] = 0L;
60         ((unsigned long*)blocks)[3] = 0L;
61         i += 16;
62     }
63     for ( ; i < sizeof(int16_t)*6*64-31 ; i += 32) {
64         __asm__ volatile("dcbz %0,%1" : : "b" (blocks), "r" (i) : "memory");
65     }
66     if (misal) {
67         ((unsigned long*)blocks)[188] = 0L;
68         ((unsigned long*)blocks)[189] = 0L;
69         ((unsigned long*)blocks)[190] = 0L;
70         ((unsigned long*)blocks)[191] = 0L;
71         i += 16;
72     }
73 }
74
75 /* Same as above, when dcbzl clears a whole 128 bytes cache line
76  * i.e. the PPC970 AKA G5. */
77 #if HAVE_DCBZL
78 static void clear_blocks_dcbz128_ppc(int16_t *blocks)
79 {
80     register int misal = ((unsigned long)blocks & 0x0000007f);
81     register int i = 0;
82     if (misal) {
83         /* We could probably also optimize this case,
84          * but there's not much point as the machines
85          * aren't available yet (2003-06-26). */
86         memset(blocks, 0, sizeof(int16_t)*6*64);
87     }
88     else
89         for ( ; i < sizeof(int16_t)*6*64 ; i += 128) {
90             __asm__ volatile("dcbzl %0,%1" : : "b" (blocks), "r" (i) : "memory");
91         }
92 }
93 #else
94 static void clear_blocks_dcbz128_ppc(int16_t *blocks)
95 {
96     memset(blocks, 0, sizeof(int16_t)*6*64);
97 }
98 #endif
99
100 #if HAVE_DCBZL
101 /* Check dcbz report how many bytes are set to 0 by dcbz. */
102 /* update 24/06/2003: Replace dcbz by dcbzl to get the intended effect
103  * (Apple "fixed" dcbz). Unfortunately this cannot be used unless the
104  * assembler knows about dcbzl ... */
105 static long check_dcbzl_effect(void)
106 {
107     register char *fakedata = av_malloc(1024);
108     register char *fakedata_middle;
109     register long zero = 0;
110     register long i = 0;
111     long count = 0;
112
113     if (!fakedata) {
114         return 0L;
115     }
116
117     fakedata_middle = (fakedata + 512);
118
119     memset(fakedata, 0xFF, 1024);
120
121     /* Below the constraint "b" seems to mean "address base register"
122      * in gcc-3.3 / RS/6000 speaks. Seems to avoid using r0, so.... */
123     __asm__ volatile("dcbzl %0, %1" : : "b" (fakedata_middle), "r" (zero));
124
125     for (i = 0; i < 1024 ; i ++) {
126         if (fakedata[i] == (char)0)
127             count++;
128     }
129
130     av_free(fakedata);
131
132     return count;
133 }
134 #else
135 static long check_dcbzl_effect(void)
136 {
137   return 0;
138 }
139 #endif
140
141 av_cold void ff_dsputil_init_ppc(DSPContext *c, AVCodecContext *avctx)
142 {
143     const int high_bit_depth = avctx->bits_per_raw_sample > 8;
144
145     // common optimizations whether AltiVec is available or not
146     if (!high_bit_depth) {
147     switch (check_dcbzl_effect()) {
148         case 32:
149             c->clear_blocks = clear_blocks_dcbz32_ppc;
150             break;
151         case 128:
152             c->clear_blocks = clear_blocks_dcbz128_ppc;
153             break;
154         default:
155             break;
156     }
157     }
158
159     if (PPC_ALTIVEC(av_get_cpu_flags())) {
160         ff_dsputil_init_altivec(c, avctx);
161         ff_int_init_altivec(c, avctx);
162         c->gmc1 = ff_gmc1_altivec;
163
164 #if CONFIG_ENCODERS
165         if (avctx->bits_per_raw_sample <= 8 &&
166             (avctx->dct_algo == FF_DCT_AUTO ||
167              avctx->dct_algo == FF_DCT_ALTIVEC)) {
168             c->fdct = ff_fdct_altivec;
169         }
170 #endif //CONFIG_ENCODERS
171
172         if (avctx->bits_per_raw_sample <= 8) {
173             if ((avctx->idct_algo == FF_IDCT_AUTO) ||
174                 (avctx->idct_algo == FF_IDCT_ALTIVEC)) {
175                 c->idct_put = ff_idct_put_altivec;
176                 c->idct_add = ff_idct_add_altivec;
177                 c->idct_permutation_type = FF_TRANSPOSE_IDCT_PERM;
178             }
179         }
180
181     }
182 }