more idiot proof dox
[libav.git] / libavcodec / dsputil.h
CommitLineData
ff4ec49e
FB
1/*
2 * DSP utils
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard.
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
de6d9b64
FB
19#ifndef DSPUTIL_H
20#define DSPUTIL_H
21
22#include "common.h"
43f1708f 23#include "avcodec.h"
de6d9b64 24
44eb4951 25//#define DEBUG
de6d9b64
FB
26/* dct code */
27typedef short DCTELEM;
0e15384d 28//typedef int DCTELEM;
de6d9b64 29
03c94ede 30void fdct_ifast (DCTELEM *data);
28db7fce 31void ff_jpeg_fdct_islow (DCTELEM *data);
de6d9b64
FB
32
33void j_rev_dct (DCTELEM *data);
34
3f09f52a 35void ff_fdct_mmx(DCTELEM *block);
de6d9b64 36
e0eac44e 37/* encoding scans */
0c1a9eda
ZK
38extern const uint8_t ff_alternate_horizontal_scan[64];
39extern const uint8_t ff_alternate_vertical_scan[64];
40extern const uint8_t ff_zigzag_direct[64];
5a240838 41
de6d9b64
FB
42/* pixel operations */
43#define MAX_NEG_CROP 384
44
45/* temporary */
0c1a9eda
ZK
46extern uint32_t squareTbl[512];
47extern uint8_t cropTbl[256 + 2 * MAX_NEG_CROP];
de6d9b64 48
de6d9b64 49
b7c27ee6 50/* minimum alignment rules ;)
eb4b3dd3 51if u notice errors in the align stuff, need more alignment for some asm code for some cpu
b7c27ee6
MN
52or need to use a function with less aligned data then send a mail to the ffmpeg-dev list, ...
53
54!warning these alignments might not match reallity, (missing attribute((align)) stuff somewhere possible)
55i (michael) didnt check them, these are just the alignents which i think could be reached easily ...
de6d9b64 56
b7c27ee6
MN
57!future video codecs might need functions with less strict alignment
58*/
59
eb4b3dd3 60/*
0c1a9eda
ZK
61void get_pixels_c(DCTELEM *block, const uint8_t *pixels, int line_size);
62void diff_pixels_c(DCTELEM *block, const uint8_t *s1, const uint8_t *s2, int stride);
63void put_pixels_clamped_c(const DCTELEM *block, uint8_t *pixels, int line_size);
64void add_pixels_clamped_c(const DCTELEM *block, uint8_t *pixels, int line_size);
649c00c9 65void clear_blocks_c(DCTELEM *blocks);
eb4b3dd3 66*/
de6d9b64
FB
67
68/* add and put pixel (decoding) */
b7c27ee6 69// blocksizes for op_pixels_func are 8x4,8x8 16x8 16x16
0c1a9eda
ZK
70typedef void (*op_pixels_func)(uint8_t *block/*align width (8 or 16)*/, const uint8_t *pixels/*align 1*/, int line_size, int h);
71typedef void (*qpel_mc_func)(uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, int stride);
b3184779 72
db794953 73#define DEF_OLD_QPEL(name)\
0c1a9eda
ZK
74void ff_put_ ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, int stride);\
75void ff_put_no_rnd_ ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, int stride);\
76void ff_avg_ ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, int stride);
db794953
MN
77
78DEF_OLD_QPEL(qpel16_mc11_old_c)
79DEF_OLD_QPEL(qpel16_mc31_old_c)
80DEF_OLD_QPEL(qpel16_mc12_old_c)
81DEF_OLD_QPEL(qpel16_mc32_old_c)
82DEF_OLD_QPEL(qpel16_mc13_old_c)
83DEF_OLD_QPEL(qpel16_mc33_old_c)
84DEF_OLD_QPEL(qpel8_mc11_old_c)
85DEF_OLD_QPEL(qpel8_mc31_old_c)
86DEF_OLD_QPEL(qpel8_mc12_old_c)
87DEF_OLD_QPEL(qpel8_mc32_old_c)
88DEF_OLD_QPEL(qpel8_mc13_old_c)
89DEF_OLD_QPEL(qpel8_mc33_old_c)
b3184779
MN
90
91#define CALL_2X_PIXELS(a, b, n)\
92static void a(uint8_t *block, const uint8_t *pixels, int line_size, int h){\
93 b(block , pixels , line_size, h);\
94 b(block+n, pixels+n, line_size, h);\
95}
44eb4951 96
de6d9b64
FB
97/* motion estimation */
98
0c1a9eda 99typedef int (*op_pixels_abs_func)(uint8_t *blk1/*align width (8 or 16)*/, uint8_t *blk2/*align 1*/, int line_size)/* __attribute__ ((const))*/;
1457ab52 100
0c1a9eda 101typedef int (*me_cmp_func)(void /*MpegEncContext*/ *s, uint8_t *blk1/*align width (8 or 16)*/, uint8_t *blk2/*align 1*/, int line_size)/* __attribute__ ((const))*/;
1457ab52 102
eb4b3dd3
ZK
103typedef struct DSPContext {
104 /* pixel ops : interface with DCT */
0c1a9eda
ZK
105 void (*get_pixels)(DCTELEM *block/*align 16*/, const uint8_t *pixels/*align 8*/, int line_size);
106 void (*diff_pixels)(DCTELEM *block/*align 16*/, const uint8_t *s1/*align 8*/, const uint8_t *s2/*align 8*/, int stride);
107 void (*put_pixels_clamped)(const DCTELEM *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
108 void (*add_pixels_clamped)(const DCTELEM *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
109 void (*gmc1)(uint8_t *dst/*align 8*/, uint8_t *src/*align 1*/, int srcStride, int h, int x16, int y16, int rounder);
110 void (*gmc )(uint8_t *dst/*align 8*/, uint8_t *src/*align 1*/, int stride, int h, int ox, int oy,
eb4b3dd3
ZK
111 int dxx, int dxy, int dyx, int dyy, int shift, int r, int width, int height);
112 void (*clear_blocks)(DCTELEM *blocks/*align 16*/);
0c1a9eda
ZK
113 int (*pix_sum)(uint8_t * pix, int line_size);
114 int (*pix_norm1)(uint8_t * pix, int line_size);
1457ab52
MN
115 me_cmp_func sad[2]; /* identical to pix_absAxA except additional void * */
116 me_cmp_func sse[2];
117 me_cmp_func hadamard8_diff[2];
118 me_cmp_func dct_sad[2];
119 me_cmp_func quant_psnr[2];
3a87ac94
MN
120 me_cmp_func bit[2];
121 me_cmp_func rd[2];
1457ab52
MN
122 int (*hadamard8_abs )(uint8_t *src, int stride, int mean);
123
826f429a 124 me_cmp_func me_pre_cmp[11];
1457ab52
MN
125 me_cmp_func me_cmp[11];
126 me_cmp_func me_sub_cmp[11];
127 me_cmp_func mb_cmp[11];
eb4b3dd3
ZK
128
129 /* maybe create an array for 16/8 functions */
130 op_pixels_func put_pixels_tab[2][4];
131 op_pixels_func avg_pixels_tab[2][4];
132 op_pixels_func put_no_rnd_pixels_tab[2][4];
133 op_pixels_func avg_no_rnd_pixels_tab[2][4];
134 qpel_mc_func put_qpel_pixels_tab[2][16];
135 qpel_mc_func avg_qpel_pixels_tab[2][16];
136 qpel_mc_func put_no_rnd_qpel_pixels_tab[2][16];
137 qpel_mc_func avg_no_rnd_qpel_pixels_tab[2][16];
1457ab52 138 qpel_mc_func put_mspel_pixels_tab[8];
eb4b3dd3
ZK
139
140 op_pixels_abs_func pix_abs16x16;
141 op_pixels_abs_func pix_abs16x16_x2;
142 op_pixels_abs_func pix_abs16x16_y2;
143 op_pixels_abs_func pix_abs16x16_xy2;
144 op_pixels_abs_func pix_abs8x8;
145 op_pixels_abs_func pix_abs8x8_x2;
146 op_pixels_abs_func pix_abs8x8_y2;
147 op_pixels_abs_func pix_abs8x8_xy2;
11f18faf
MN
148
149 /* huffyuv specific */
11f18faf 150 void (*add_bytes)(uint8_t *dst/*align 16*/, uint8_t *src/*align 16*/, int w);
1457ab52 151 void (*diff_bytes)(uint8_t *dst/*align 16*/, uint8_t *src1/*align 16*/, uint8_t *src2/*align 1*/,int w);
b0368839
MN
152
153 /* (I)DCT */
154 void (*fdct)(DCTELEM *block/* align 16*/);
155 void (*idct_put)(uint8_t *dest/*align 8*/, int line_size, DCTELEM *block/*align 16*/);
156 void (*idct_add)(uint8_t *dest/*align 8*/, int line_size, DCTELEM *block/*align 16*/);
157 uint8_t idct_permutation[64];
158 int idct_permutation_type;
159#define FF_NO_IDCT_PERM 1
160#define FF_LIBMPEG2_IDCT_PERM 2
161#define FF_SIMPLE_IDCT_PERM 3
162#define FF_TRANSPOSE_IDCT_PERM 4
163
eb4b3dd3
ZK
164} DSPContext;
165
b0368839 166void dsputil_init(DSPContext* p, AVCodecContext *avctx);
de6d9b64 167
7801d21d
MN
168/**
169 * permute block according to permuatation.
170 * @param last last non zero element in scantable order
171 */
0c1a9eda 172void ff_block_permute(DCTELEM *block, uint8_t *permutation, const uint8_t *scantable, int last);
e0eac44e 173
eb4b3dd3
ZK
174#define emms_c()
175
e629ab68
RD
176/* should be defined by architectures supporting
177 one or more MultiMedia extension */
178int mm_support(void);
179
3d03c0a2 180#if defined(HAVE_MMX)
de6d9b64 181
18f77016 182#undef emms_c
eb4b3dd3 183
de6d9b64
FB
184#define MM_MMX 0x0001 /* standard MMX */
185#define MM_3DNOW 0x0004 /* AMD 3DNOW */
186#define MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
187#define MM_SSE 0x0008 /* SSE functions */
188#define MM_SSE2 0x0010 /* PIV SSE2 functions */
189
190extern int mm_flags;
191
0c1a9eda
ZK
192void add_pixels_clamped_mmx(const DCTELEM *block, uint8_t *pixels, int line_size);
193void put_pixels_clamped_mmx(const DCTELEM *block, uint8_t *pixels, int line_size);
de6d9b64
FB
194
195static inline void emms(void)
196{
fb16b7e7
FB
197 __asm __volatile ("emms;":::"memory");
198}
199
1457ab52 200
fb16b7e7
FB
201#define emms_c() \
202{\
203 if (mm_flags & MM_MMX)\
204 emms();\
de6d9b64
FB
205}
206
207#define __align8 __attribute__ ((aligned (8)))
208
b0368839
MN
209void dsputil_init_mmx(DSPContext* c, AVCodecContext *avctx);
210void dsputil_init_pix_mmx(DSPContext* c, AVCodecContext *avctx);
2720569a 211
3d03c0a2
FB
212#elif defined(ARCH_ARMV4L)
213
3d03c0a2
FB
214/* This is to use 4 bytes read to the IDCT pointers for some 'zero'
215 line ptimizations */
216#define __align8 __attribute__ ((aligned (4)))
217
b0368839 218void dsputil_init_armv4l(DSPContext* c, AVCodecContext *avctx);
3d03c0a2 219
c34270f5 220#elif defined(HAVE_MLIB)
c34270f5
FB
221
222/* SPARC/VIS IDCT needs 8-byte aligned DCT blocks */
223#define __align8 __attribute__ ((aligned (8)))
224
b0368839 225void dsputil_init_mlib(DSPContext* c, AVCodecContext *avctx);
c34270f5 226
1e98dffb
NK
227#elif defined(ARCH_ALPHA)
228
1e98dffb
NK
229#define __align8 __attribute__ ((aligned (8)))
230
b0368839 231void dsputil_init_alpha(DSPContext* c, AVCodecContext *avctx);
1e98dffb 232
59925ef2
BF
233#elif defined(ARCH_POWERPC)
234
404d2241
BF
235#define MM_ALTIVEC 0x0001 /* standard AltiVec */
236
237extern int mm_flags;
238
3b991c54
RD
239#if defined(HAVE_ALTIVEC) && !defined(CONFIG_DARWIN)
240#include <altivec.h>
241#endif
242
59925ef2
BF
243#define __align8 __attribute__ ((aligned (16)))
244
b0368839 245void dsputil_init_ppc(DSPContext* c, AVCodecContext *avctx);
59925ef2 246
d46aba26
LS
247#elif defined(HAVE_MMI)
248
d46aba26
LS
249#define __align8 __attribute__ ((aligned (16)))
250
b0368839 251void dsputil_init_mmi(DSPContext* c, AVCodecContext *avctx);
d46aba26 252
de6d9b64
FB
253#else
254
255#define __align8
256
257#endif
258
6d4985bb
FB
259#ifdef __GNUC__
260
261struct unaligned_64 { uint64_t l; } __attribute__((packed));
262struct unaligned_32 { uint32_t l; } __attribute__((packed));
263
264#define LD32(a) (((const struct unaligned_32 *) (a))->l)
265#define LD64(a) (((const struct unaligned_64 *) (a))->l)
266
267#define ST32(a, b) (((struct unaligned_32 *) (a))->l) = (b)
268
269#else /* __GNUC__ */
270
271#define LD32(a) (*((uint32_t*)(a)))
272#define LD64(a) (*((uint64_t*)(a)))
273
274#define ST32(a, b) *((uint32_t*)(a)) = (b)
275
276#endif /* !__GNUC__ */
277
43f1708f 278/* PSNR */
0c1a9eda 279void get_psnr(uint8_t *orig_image[3], uint8_t *coded_image[3],
43f1708f
J
280 int orig_linesize[3], int coded_linesize,
281 AVCodecContext *avctx);
bb6f5690
FB
282
283/* FFT computation */
284
285/* NOTE: soon integer code will be added, so you must use the
286 FFTSample type */
287typedef float FFTSample;
288
289typedef struct FFTComplex {
290 FFTSample re, im;
291} FFTComplex;
292
293typedef struct FFTContext {
294 int nbits;
295 int inverse;
296 uint16_t *revtab;
297 FFTComplex *exptab;
298 FFTComplex *exptab1; /* only used by SSE code */
299 void (*fft_calc)(struct FFTContext *s, FFTComplex *z);
300} FFTContext;
301
302int fft_init(FFTContext *s, int nbits, int inverse);
303void fft_permute(FFTContext *s, FFTComplex *z);
304void fft_calc_c(FFTContext *s, FFTComplex *z);
305void fft_calc_sse(FFTContext *s, FFTComplex *z);
8d268a7d
FB
306void fft_calc_altivec(FFTContext *s, FFTComplex *z);
307
bb6f5690
FB
308static inline void fft_calc(FFTContext *s, FFTComplex *z)
309{
310 s->fft_calc(s, z);
311}
312void fft_end(FFTContext *s);
313
314/* MDCT computation */
315
316typedef struct MDCTContext {
317 int n; /* size of MDCT (i.e. number of input data * 2) */
318 int nbits; /* n = 2^nbits */
319 /* pre/post rotation tables */
320 FFTSample *tcos;
321 FFTSample *tsin;
322 FFTContext fft;
323} MDCTContext;
324
82696bee 325int ff_mdct_init(MDCTContext *s, int nbits, int inverse);
eb4b3dd3 326void ff_imdct_calc(MDCTContext *s, FFTSample *output,
bb6f5690 327 const FFTSample *input, FFTSample *tmp);
eb4b3dd3 328void ff_mdct_calc(MDCTContext *s, FFTSample *out,
bb6f5690 329 const FFTSample *input, FFTSample *tmp);
82696bee 330void ff_mdct_end(MDCTContext *s);
bb6f5690 331
1457ab52
MN
332#define WARPER88_1616(name8, name16)\
333static int name16(void /*MpegEncContext*/ *s, uint8_t *dst, uint8_t *src, int stride){\
334 return name8(s, dst , src , stride)\
335 +name8(s, dst+8 , src+8 , stride)\
336 +name8(s, dst +8*stride, src +8*stride, stride)\
337 +name8(s, dst+8+8*stride, src+8+8*stride, stride);\
338}
339
95e2ce4a 340#ifndef HAVE_LRINTF
9d85cbd9
FB
341/* XXX: add ISOC specific test to avoid specific BSD testing. */
342/* better than nothing implementation. */
6234d753 343/* btw, rintf() is existing on fbsd too -- alex */
9d85cbd9
FB
344static inline long int lrintf(float x)
345{
ea937d01
FB
346#ifdef CONFIG_WIN32
347 /* XXX: incorrect, but make it compile */
348 return (int)(x);
349#else
9d85cbd9 350 return (int)(rint(x));
ea937d01 351#endif
9d85cbd9
FB
352}
353#endif
354
de6d9b64 355#endif