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