9c4976bc88f308120b1d31e106692c410926cef0
[ffmpeg.git] / libavcodec / dsputil.h
1 /*
2  * DSP utils
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
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 /**
24  * @file
25  * DSP utils.
26  * note, many functions in here may use MMX which trashes the FPU state, it is
27  * absolutely necessary to call emms_c() between dsp & float/double code
28  */
29
30 #ifndef AVCODEC_DSPUTIL_H
31 #define AVCODEC_DSPUTIL_H
32
33 #include "libavutil/intreadwrite.h"
34 #include "avcodec.h"
35 #include "rnd_avg.h"
36
37
38 //#define DEBUG
39
40 /* encoding scans */
41 extern const uint8_t ff_alternate_horizontal_scan[64];
42 extern const uint8_t ff_alternate_vertical_scan[64];
43 extern const uint8_t ff_zigzag_direct[64];
44 extern const uint8_t ff_zigzag248_direct[64];
45
46 /* pixel operations */
47 #define MAX_NEG_CROP 1024
48
49 /* temporary */
50 extern uint32_t ff_squareTbl[512];
51 extern const uint8_t ff_cropTbl[256 + 2 * MAX_NEG_CROP];
52
53 void ff_put_pixels8x8_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
54 void ff_avg_pixels8x8_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
55 void ff_put_pixels16x16_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
56 void ff_avg_pixels16x16_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
57
58 /* RV40 functions */
59 void ff_put_rv40_qpel16_mc33_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
60 void ff_avg_rv40_qpel16_mc33_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
61 void ff_put_rv40_qpel8_mc33_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
62 void ff_avg_rv40_qpel8_mc33_c(uint8_t *dst, uint8_t *src, ptrdiff_t stride);
63
64 void ff_gmc_c(uint8_t *dst, uint8_t *src, int stride, int h, int ox, int oy,
65               int dxx, int dxy, int dyx, int dyy, int shift, int r, int width, int height);
66
67 /* minimum alignment rules ;)
68 If you notice errors in the align stuff, need more alignment for some ASM code
69 for some CPU or need to use a function with less aligned data then send a mail
70 to the libav-devel mailing list, ...
71
72 !warning These alignments might not match reality, (missing attribute((align))
73 stuff somewhere possible).
74 I (Michael) did not check them, these are just the alignments which I think
75 could be reached easily ...
76
77 !future video codecs might need functions with less strict alignment
78 */
79
80 /* add and put pixel (decoding) */
81 // blocksizes for op_pixels_func are 8x4,8x8 16x8 16x16
82 //h for op_pixels_func is limited to {width/2, width} but never larger than 16 and never smaller than 4
83 typedef void (*op_pixels_func)(uint8_t *block/*align width (8 or 16)*/, const uint8_t *pixels/*align 1*/, ptrdiff_t line_size, int h);
84 typedef void (*tpel_mc_func)(uint8_t *block/*align width (8 or 16)*/, const uint8_t *pixels/*align 1*/, int line_size, int w, int h);
85 typedef void (*qpel_mc_func)(uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);
86
87 typedef void (*op_fill_func)(uint8_t *block/*align width (8 or 16)*/, uint8_t value, int line_size, int h);
88
89 #define DEF_OLD_QPEL(name)\
90 void ff_put_        ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);\
91 void ff_put_no_rnd_ ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);\
92 void ff_avg_        ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);
93
94 DEF_OLD_QPEL(qpel16_mc11_old_c)
95 DEF_OLD_QPEL(qpel16_mc31_old_c)
96 DEF_OLD_QPEL(qpel16_mc12_old_c)
97 DEF_OLD_QPEL(qpel16_mc32_old_c)
98 DEF_OLD_QPEL(qpel16_mc13_old_c)
99 DEF_OLD_QPEL(qpel16_mc33_old_c)
100 DEF_OLD_QPEL(qpel8_mc11_old_c)
101 DEF_OLD_QPEL(qpel8_mc31_old_c)
102 DEF_OLD_QPEL(qpel8_mc12_old_c)
103 DEF_OLD_QPEL(qpel8_mc32_old_c)
104 DEF_OLD_QPEL(qpel8_mc13_old_c)
105 DEF_OLD_QPEL(qpel8_mc33_old_c)
106
107 /* motion estimation */
108 // h is limited to {width/2, width, 2*width} but never larger than 16 and never smaller than 2
109 // although currently h<4 is not used as functions with width <8 are neither used nor implemented
110 typedef int (*me_cmp_func)(void /*MpegEncContext*/ *s, uint8_t *blk1/*align width (8 or 16)*/, uint8_t *blk2/*align 1*/, int line_size, int h)/* __attribute__ ((const))*/;
111
112 /**
113  * Scantable.
114  */
115 typedef struct ScanTable{
116     const uint8_t *scantable;
117     uint8_t permutated[64];
118     uint8_t raster_end[64];
119 } ScanTable;
120
121 void ff_init_scantable(uint8_t *, ScanTable *st, const uint8_t *src_scantable);
122 void ff_init_scantable_permutation(uint8_t *idct_permutation,
123                                    int idct_permutation_type);
124
125 /**
126  * DSPContext.
127  */
128 typedef struct DSPContext {
129     /**
130      * Size of DCT coefficients.
131      */
132     int dct_bits;
133
134     /* pixel ops : interface with DCT */
135     void (*get_pixels)(int16_t *block/*align 16*/, const uint8_t *pixels/*align 8*/, int line_size);
136     void (*diff_pixels)(int16_t *block/*align 16*/, const uint8_t *s1/*align 8*/, const uint8_t *s2/*align 8*/, int stride);
137     void (*put_pixels_clamped)(const int16_t *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
138     void (*put_signed_pixels_clamped)(const int16_t *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
139     void (*add_pixels_clamped)(const int16_t *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
140     void (*add_pixels8)(uint8_t *pixels, int16_t *block, int line_size);
141     int (*sum_abs_dctelem)(int16_t *block/*align 16*/);
142     /**
143      * translational global motion compensation.
144      */
145     void (*gmc1)(uint8_t *dst/*align 8*/, uint8_t *src/*align 1*/, int srcStride, int h, int x16, int y16, int rounder);
146     /**
147      * global motion compensation.
148      */
149     void (*gmc )(uint8_t *dst/*align 8*/, uint8_t *src/*align 1*/, int stride, int h, int ox, int oy,
150                     int dxx, int dxy, int dyx, int dyy, int shift, int r, int width, int height);
151     void (*clear_block)(int16_t *block/*align 16*/);
152     void (*clear_blocks)(int16_t *blocks/*align 16*/);
153     int (*pix_sum)(uint8_t * pix, int line_size);
154     int (*pix_norm1)(uint8_t * pix, int line_size);
155 // 16x16 8x8 4x4 2x2 16x8 8x4 4x2 8x16 4x8 2x4
156
157     me_cmp_func sad[6]; /* identical to pix_absAxA except additional void * */
158     me_cmp_func sse[6];
159     me_cmp_func hadamard8_diff[6];
160     me_cmp_func dct_sad[6];
161     me_cmp_func quant_psnr[6];
162     me_cmp_func bit[6];
163     me_cmp_func rd[6];
164     me_cmp_func vsad[6];
165     me_cmp_func vsse[6];
166     me_cmp_func nsse[6];
167     me_cmp_func dct_max[6];
168     me_cmp_func dct264_sad[6];
169
170     me_cmp_func me_pre_cmp[6];
171     me_cmp_func me_cmp[6];
172     me_cmp_func me_sub_cmp[6];
173     me_cmp_func mb_cmp[6];
174     me_cmp_func ildct_cmp[6]; //only width 16 used
175     me_cmp_func frame_skip_cmp[6]; //only width 8 used
176
177     int (*ssd_int8_vs_int16)(const int8_t *pix1, const int16_t *pix2,
178                              int size);
179
180     /**
181      * Halfpel motion compensation with rounding (a+b+1)>>1.
182      * this is an array[4][4] of motion compensation functions for 4
183      * horizontal blocksizes (8,16) and the 4 halfpel positions<br>
184      * *pixels_tab[ 0->16xH 1->8xH ][ xhalfpel + 2*yhalfpel ]
185      * @param block destination where the result is stored
186      * @param pixels source
187      * @param line_size number of bytes in a horizontal line of block
188      * @param h height
189      */
190     op_pixels_func put_pixels_tab[4][4];
191
192     /**
193      * Halfpel motion compensation with rounding (a+b+1)>>1.
194      * This is an array[4][4] of motion compensation functions for 4
195      * horizontal blocksizes (8,16) and the 4 halfpel positions<br>
196      * *pixels_tab[ 0->16xH 1->8xH ][ xhalfpel + 2*yhalfpel ]
197      * @param block destination into which the result is averaged (a+b+1)>>1
198      * @param pixels source
199      * @param line_size number of bytes in a horizontal line of block
200      * @param h height
201      */
202     op_pixels_func avg_pixels_tab[4][4];
203
204     /**
205      * Halfpel motion compensation with no rounding (a+b)>>1.
206      * this is an array[2][4] of motion compensation functions for 2
207      * horizontal blocksizes (8,16) and the 4 halfpel positions<br>
208      * *pixels_tab[ 0->16xH 1->8xH ][ xhalfpel + 2*yhalfpel ]
209      * @param block destination where the result is stored
210      * @param pixels source
211      * @param line_size number of bytes in a horizontal line of block
212      * @param h height
213      */
214     op_pixels_func put_no_rnd_pixels_tab[2][4];
215
216     /**
217      * Halfpel motion compensation with no rounding (a+b)>>1.
218      * this is an array[4] of motion compensation functions for 1
219      * horizontal blocksize (16) and the 4 halfpel positions<br>
220      * *pixels_tab[0][ xhalfpel + 2*yhalfpel ]
221      * @param block destination into which the result is averaged (a+b)>>1
222      * @param pixels source
223      * @param line_size number of bytes in a horizontal line of block
224      * @param h height
225      */
226     op_pixels_func avg_no_rnd_pixels_tab[4];
227
228     /**
229      * Thirdpel motion compensation with rounding (a+b+1)>>1.
230      * this is an array[12] of motion compensation functions for the 9 thirdpe
231      * positions<br>
232      * *pixels_tab[ xthirdpel + 4*ythirdpel ]
233      * @param block destination where the result is stored
234      * @param pixels source
235      * @param line_size number of bytes in a horizontal line of block
236      * @param h height
237      */
238     tpel_mc_func put_tpel_pixels_tab[11]; //FIXME individual func ptr per width?
239     tpel_mc_func avg_tpel_pixels_tab[11]; //FIXME individual func ptr per width?
240
241     qpel_mc_func put_qpel_pixels_tab[2][16];
242     qpel_mc_func avg_qpel_pixels_tab[2][16];
243     qpel_mc_func put_no_rnd_qpel_pixels_tab[2][16];
244     qpel_mc_func put_mspel_pixels_tab[8];
245
246     me_cmp_func pix_abs[2][4];
247
248     /* huffyuv specific */
249     void (*add_bytes)(uint8_t *dst/*align 16*/, uint8_t *src/*align 16*/, int w);
250     void (*diff_bytes)(uint8_t *dst/*align 16*/, uint8_t *src1/*align 16*/, uint8_t *src2/*align 1*/,int w);
251     /**
252      * subtract huffyuv's variant of median prediction
253      * note, this might read from src1[-1], src2[-1]
254      */
255     void (*sub_hfyu_median_prediction)(uint8_t *dst, const uint8_t *src1, const uint8_t *src2, int w, int *left, int *left_top);
256     void (*add_hfyu_median_prediction)(uint8_t *dst, const uint8_t *top, const uint8_t *diff, int w, int *left, int *left_top);
257     int  (*add_hfyu_left_prediction)(uint8_t *dst, const uint8_t *src, int w, int left);
258     void (*add_hfyu_left_prediction_bgr32)(uint8_t *dst, const uint8_t *src, int w, int *red, int *green, int *blue, int *alpha);
259     void (*bswap_buf)(uint32_t *dst, const uint32_t *src, int w);
260     void (*bswap16_buf)(uint16_t *dst, const uint16_t *src, int len);
261
262     void (*h263_v_loop_filter)(uint8_t *src, int stride, int qscale);
263     void (*h263_h_loop_filter)(uint8_t *src, int stride, int qscale);
264
265     /* assume len is a multiple of 8, and arrays are 16-byte aligned */
266     void (*vector_clipf)(float *dst /* align 16 */, const float *src /* align 16 */, float min, float max, int len /* align 16 */);
267
268     /* (I)DCT */
269     void (*fdct)(int16_t *block/* align 16*/);
270     void (*fdct248)(int16_t *block/* align 16*/);
271
272     /* IDCT really*/
273     void (*idct)(int16_t *block/* align 16*/);
274
275     /**
276      * block -> idct -> clip to unsigned 8 bit -> dest.
277      * (-1392, 0, 0, ...) -> idct -> (-174, -174, ...) -> put -> (0, 0, ...)
278      * @param line_size size in bytes of a horizontal line of dest
279      */
280     void (*idct_put)(uint8_t *dest/*align 8*/, int line_size, int16_t *block/*align 16*/);
281
282     /**
283      * block -> idct -> add dest -> clip to unsigned 8 bit -> dest.
284      * @param line_size size in bytes of a horizontal line of dest
285      */
286     void (*idct_add)(uint8_t *dest/*align 8*/, int line_size, int16_t *block/*align 16*/);
287
288     /**
289      * idct input permutation.
290      * several optimized IDCTs need a permutated input (relative to the normal order of the reference
291      * IDCT)
292      * this permutation must be performed before the idct_put/add, note, normally this can be merged
293      * with the zigzag/alternate scan<br>
294      * an example to avoid confusion:
295      * - (->decode coeffs -> zigzag reorder -> dequant -> reference idct ->...)
296      * - (x -> reference dct -> reference idct -> x)
297      * - (x -> reference dct -> simple_mmx_perm = idct_permutation -> simple_idct_mmx -> x)
298      * - (->decode coeffs -> zigzag reorder -> simple_mmx_perm -> dequant -> simple_idct_mmx ->...)
299      */
300     uint8_t idct_permutation[64];
301     int idct_permutation_type;
302 #define FF_NO_IDCT_PERM 1
303 #define FF_LIBMPEG2_IDCT_PERM 2
304 #define FF_SIMPLE_IDCT_PERM 3
305 #define FF_TRANSPOSE_IDCT_PERM 4
306 #define FF_PARTTRANS_IDCT_PERM 5
307 #define FF_SSE2_IDCT_PERM 6
308
309     int (*try_8x8basis)(int16_t rem[64], int16_t weight[64], int16_t basis[64], int scale);
310     void (*add_8x8basis)(int16_t rem[64], int16_t basis[64], int scale);
311 #define BASIS_SHIFT 16
312 #define RECON_SHIFT 6
313
314     void (*draw_edges)(uint8_t *buf, int wrap, int width, int height, int w, int h, int sides);
315 #define EDGE_WIDTH 16
316 #define EDGE_TOP    1
317 #define EDGE_BOTTOM 2
318
319     void (*shrink[4])(uint8_t *dst, int dst_wrap, const uint8_t *src, int src_wrap, int width, int height);
320
321     /**
322      * Calculate scalar product of two vectors.
323      * @param len length of vectors, should be multiple of 16
324      */
325     int32_t (*scalarproduct_int16)(const int16_t *v1, const int16_t *v2/*align 16*/, int len);
326     /* ape functions */
327     /**
328      * Calculate scalar product of v1 and v2,
329      * and v1[i] += v3[i] * mul
330      * @param len length of vectors, should be multiple of 16
331      */
332     int32_t (*scalarproduct_and_madd_int16)(int16_t *v1/*align 16*/, const int16_t *v2, const int16_t *v3, int len, int mul);
333
334     /**
335      * Apply symmetric window in 16-bit fixed-point.
336      * @param output destination array
337      *               constraints: 16-byte aligned
338      * @param input  source array
339      *               constraints: 16-byte aligned
340      * @param window window array
341      *               constraints: 16-byte aligned, at least len/2 elements
342      * @param len    full window length
343      *               constraints: multiple of ? greater than zero
344      */
345     void (*apply_window_int16)(int16_t *output, const int16_t *input,
346                                const int16_t *window, unsigned int len);
347
348     /**
349      * Clip each element in an array of int32_t to a given minimum and maximum value.
350      * @param dst  destination array
351      *             constraints: 16-byte aligned
352      * @param src  source array
353      *             constraints: 16-byte aligned
354      * @param min  minimum value
355      *             constraints: must be in the range [-(1 << 24), 1 << 24]
356      * @param max  maximum value
357      *             constraints: must be in the range [-(1 << 24), 1 << 24]
358      * @param len  number of elements in the array
359      *             constraints: multiple of 32 greater than zero
360      */
361     void (*vector_clip_int32)(int32_t *dst, const int32_t *src, int32_t min,
362                               int32_t max, unsigned int len);
363
364     op_fill_func fill_block_tab[2];
365 } DSPContext;
366
367 void ff_dsputil_static_init(void);
368 void ff_dsputil_init(DSPContext* p, AVCodecContext *avctx);
369
370 int ff_check_alignment(void);
371
372 void ff_set_cmp(DSPContext* c, me_cmp_func *cmp, int type);
373
374 void ff_dsputil_init_alpha(DSPContext* c, AVCodecContext *avctx);
375 void ff_dsputil_init_arm(DSPContext* c, AVCodecContext *avctx);
376 void ff_dsputil_init_bfin(DSPContext* c, AVCodecContext *avctx);
377 void ff_dsputil_init_mmx(DSPContext* c, AVCodecContext *avctx);
378 void ff_dsputil_init_ppc(DSPContext* c, AVCodecContext *avctx);
379 void ff_dsputil_init_sh4(DSPContext* c, AVCodecContext *avctx);
380 void ff_dsputil_init_vis(DSPContext* c, AVCodecContext *avctx);
381
382 #endif /* AVCODEC_DSPUTIL_H */