029591b171f1cb37cf1d9d66f218cc0bd64f9464
[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 (*tpel_mc_func)(uint8_t *block/*align width (8 or 16)*/, const uint8_t *pixels/*align 1*/, int line_size, int w, int h);
84 typedef void (*qpel_mc_func)(uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);
85
86 typedef void (*op_fill_func)(uint8_t *block/*align width (8 or 16)*/, uint8_t value, int line_size, int h);
87
88 #define DEF_OLD_QPEL(name)\
89 void ff_put_        ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);\
90 void ff_put_no_rnd_ ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);\
91 void ff_avg_        ## name (uint8_t *dst/*align width (8 or 16)*/, uint8_t *src/*align 1*/, ptrdiff_t stride);
92
93 DEF_OLD_QPEL(qpel16_mc11_old_c)
94 DEF_OLD_QPEL(qpel16_mc31_old_c)
95 DEF_OLD_QPEL(qpel16_mc12_old_c)
96 DEF_OLD_QPEL(qpel16_mc32_old_c)
97 DEF_OLD_QPEL(qpel16_mc13_old_c)
98 DEF_OLD_QPEL(qpel16_mc33_old_c)
99 DEF_OLD_QPEL(qpel8_mc11_old_c)
100 DEF_OLD_QPEL(qpel8_mc31_old_c)
101 DEF_OLD_QPEL(qpel8_mc12_old_c)
102 DEF_OLD_QPEL(qpel8_mc32_old_c)
103 DEF_OLD_QPEL(qpel8_mc13_old_c)
104 DEF_OLD_QPEL(qpel8_mc33_old_c)
105
106 /* motion estimation */
107 // h is limited to {width/2, width, 2*width} but never larger than 16 and never smaller than 2
108 // although currently h<4 is not used as functions with width <8 are neither used nor implemented
109 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))*/;
110
111 /**
112  * Scantable.
113  */
114 typedef struct ScanTable{
115     const uint8_t *scantable;
116     uint8_t permutated[64];
117     uint8_t raster_end[64];
118 } ScanTable;
119
120 void ff_init_scantable(uint8_t *, ScanTable *st, const uint8_t *src_scantable);
121 void ff_init_scantable_permutation(uint8_t *idct_permutation,
122                                    int idct_permutation_type);
123
124 /**
125  * DSPContext.
126  */
127 typedef struct DSPContext {
128     /* pixel ops : interface with DCT */
129     void (*get_pixels)(int16_t *block/*align 16*/, const uint8_t *pixels/*align 8*/, int line_size);
130     void (*diff_pixels)(int16_t *block/*align 16*/, const uint8_t *s1/*align 8*/, const uint8_t *s2/*align 8*/, int stride);
131     void (*put_pixels_clamped)(const int16_t *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
132     void (*put_signed_pixels_clamped)(const int16_t *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
133     void (*add_pixels_clamped)(const int16_t *block/*align 16*/, uint8_t *pixels/*align 8*/, int line_size);
134     void (*add_pixels8)(uint8_t *pixels, int16_t *block, int line_size);
135     int (*sum_abs_dctelem)(int16_t *block/*align 16*/);
136     /**
137      * translational global motion compensation.
138      */
139     void (*gmc1)(uint8_t *dst/*align 8*/, uint8_t *src/*align 1*/, int srcStride, int h, int x16, int y16, int rounder);
140     /**
141      * global motion compensation.
142      */
143     void (*gmc )(uint8_t *dst/*align 8*/, uint8_t *src/*align 1*/, int stride, int h, int ox, int oy,
144                     int dxx, int dxy, int dyx, int dyy, int shift, int r, int width, int height);
145     void (*clear_block)(int16_t *block/*align 16*/);
146     void (*clear_blocks)(int16_t *blocks/*align 16*/);
147     int (*pix_sum)(uint8_t * pix, int line_size);
148     int (*pix_norm1)(uint8_t * pix, int line_size);
149 // 16x16 8x8 4x4 2x2 16x8 8x4 4x2 8x16 4x8 2x4
150
151     me_cmp_func sad[6]; /* identical to pix_absAxA except additional void * */
152     me_cmp_func sse[6];
153     me_cmp_func hadamard8_diff[6];
154     me_cmp_func dct_sad[6];
155     me_cmp_func quant_psnr[6];
156     me_cmp_func bit[6];
157     me_cmp_func rd[6];
158     me_cmp_func vsad[6];
159     me_cmp_func vsse[6];
160     me_cmp_func nsse[6];
161     me_cmp_func dct_max[6];
162     me_cmp_func dct264_sad[6];
163
164     me_cmp_func me_pre_cmp[6];
165     me_cmp_func me_cmp[6];
166     me_cmp_func me_sub_cmp[6];
167     me_cmp_func mb_cmp[6];
168     me_cmp_func ildct_cmp[6]; //only width 16 used
169     me_cmp_func frame_skip_cmp[6]; //only width 8 used
170
171     int (*ssd_int8_vs_int16)(const int8_t *pix1, const int16_t *pix2,
172                              int size);
173
174     /**
175      * Thirdpel motion compensation with rounding (a+b+1)>>1.
176      * this is an array[12] of motion compensation functions for the 9 thirdpe
177      * positions<br>
178      * *pixels_tab[ xthirdpel + 4*ythirdpel ]
179      * @param block destination where the result is stored
180      * @param pixels source
181      * @param line_size number of bytes in a horizontal line of block
182      * @param h height
183      */
184     tpel_mc_func put_tpel_pixels_tab[11]; //FIXME individual func ptr per width?
185     tpel_mc_func avg_tpel_pixels_tab[11]; //FIXME individual func ptr per width?
186
187     qpel_mc_func put_qpel_pixels_tab[2][16];
188     qpel_mc_func avg_qpel_pixels_tab[2][16];
189     qpel_mc_func put_no_rnd_qpel_pixels_tab[2][16];
190     qpel_mc_func put_mspel_pixels_tab[8];
191
192     me_cmp_func pix_abs[2][4];
193
194     /* huffyuv specific */
195     void (*add_bytes)(uint8_t *dst/*align 16*/, uint8_t *src/*align 16*/, int w);
196     void (*diff_bytes)(uint8_t *dst/*align 16*/, uint8_t *src1/*align 16*/, uint8_t *src2/*align 1*/,int w);
197     /**
198      * subtract huffyuv's variant of median prediction
199      * note, this might read from src1[-1], src2[-1]
200      */
201     void (*sub_hfyu_median_prediction)(uint8_t *dst, const uint8_t *src1, const uint8_t *src2, int w, int *left, int *left_top);
202     void (*add_hfyu_median_prediction)(uint8_t *dst, const uint8_t *top, const uint8_t *diff, int w, int *left, int *left_top);
203     int  (*add_hfyu_left_prediction)(uint8_t *dst, const uint8_t *src, int w, int left);
204     void (*add_hfyu_left_prediction_bgr32)(uint8_t *dst, const uint8_t *src, int w, int *red, int *green, int *blue, int *alpha);
205     void (*bswap_buf)(uint32_t *dst, const uint32_t *src, int w);
206     void (*bswap16_buf)(uint16_t *dst, const uint16_t *src, int len);
207
208     void (*h263_v_loop_filter)(uint8_t *src, int stride, int qscale);
209     void (*h263_h_loop_filter)(uint8_t *src, int stride, int qscale);
210
211     /* assume len is a multiple of 8, and arrays are 16-byte aligned */
212     void (*vector_clipf)(float *dst /* align 16 */, const float *src /* align 16 */, float min, float max, int len /* align 16 */);
213
214     /* (I)DCT */
215     void (*fdct)(int16_t *block/* align 16*/);
216     void (*fdct248)(int16_t *block/* align 16*/);
217
218     /* IDCT really*/
219     void (*idct)(int16_t *block/* align 16*/);
220
221     /**
222      * block -> idct -> clip to unsigned 8 bit -> dest.
223      * (-1392, 0, 0, ...) -> idct -> (-174, -174, ...) -> put -> (0, 0, ...)
224      * @param line_size size in bytes of a horizontal line of dest
225      */
226     void (*idct_put)(uint8_t *dest/*align 8*/, int line_size, int16_t *block/*align 16*/);
227
228     /**
229      * block -> idct -> add dest -> clip to unsigned 8 bit -> dest.
230      * @param line_size size in bytes of a horizontal line of dest
231      */
232     void (*idct_add)(uint8_t *dest/*align 8*/, int line_size, int16_t *block/*align 16*/);
233
234     /**
235      * idct input permutation.
236      * several optimized IDCTs need a permutated input (relative to the normal order of the reference
237      * IDCT)
238      * this permutation must be performed before the idct_put/add, note, normally this can be merged
239      * with the zigzag/alternate scan<br>
240      * an example to avoid confusion:
241      * - (->decode coeffs -> zigzag reorder -> dequant -> reference idct ->...)
242      * - (x -> reference dct -> reference idct -> x)
243      * - (x -> reference dct -> simple_mmx_perm = idct_permutation -> simple_idct_mmx -> x)
244      * - (->decode coeffs -> zigzag reorder -> simple_mmx_perm -> dequant -> simple_idct_mmx ->...)
245      */
246     uint8_t idct_permutation[64];
247     int idct_permutation_type;
248 #define FF_NO_IDCT_PERM 1
249 #define FF_LIBMPEG2_IDCT_PERM 2
250 #define FF_SIMPLE_IDCT_PERM 3
251 #define FF_TRANSPOSE_IDCT_PERM 4
252 #define FF_PARTTRANS_IDCT_PERM 5
253 #define FF_SSE2_IDCT_PERM 6
254
255     int (*try_8x8basis)(int16_t rem[64], int16_t weight[64], int16_t basis[64], int scale);
256     void (*add_8x8basis)(int16_t rem[64], int16_t basis[64], int scale);
257 #define BASIS_SHIFT 16
258 #define RECON_SHIFT 6
259
260     void (*draw_edges)(uint8_t *buf, int wrap, int width, int height, int w, int h, int sides);
261 #define EDGE_WIDTH 16
262 #define EDGE_TOP    1
263 #define EDGE_BOTTOM 2
264
265     void (*shrink[4])(uint8_t *dst, int dst_wrap, const uint8_t *src, int src_wrap, int width, int height);
266
267     /**
268      * Calculate scalar product of two vectors.
269      * @param len length of vectors, should be multiple of 16
270      */
271     int32_t (*scalarproduct_int16)(const int16_t *v1, const int16_t *v2/*align 16*/, int len);
272     /* ape functions */
273     /**
274      * Calculate scalar product of v1 and v2,
275      * and v1[i] += v3[i] * mul
276      * @param len length of vectors, should be multiple of 16
277      */
278     int32_t (*scalarproduct_and_madd_int16)(int16_t *v1/*align 16*/, const int16_t *v2, const int16_t *v3, int len, int mul);
279
280     /**
281      * Apply symmetric window in 16-bit fixed-point.
282      * @param output destination array
283      *               constraints: 16-byte aligned
284      * @param input  source array
285      *               constraints: 16-byte aligned
286      * @param window window array
287      *               constraints: 16-byte aligned, at least len/2 elements
288      * @param len    full window length
289      *               constraints: multiple of ? greater than zero
290      */
291     void (*apply_window_int16)(int16_t *output, const int16_t *input,
292                                const int16_t *window, unsigned int len);
293
294     /**
295      * Clip each element in an array of int32_t to a given minimum and maximum value.
296      * @param dst  destination array
297      *             constraints: 16-byte aligned
298      * @param src  source array
299      *             constraints: 16-byte aligned
300      * @param min  minimum value
301      *             constraints: must be in the range [-(1 << 24), 1 << 24]
302      * @param max  maximum value
303      *             constraints: must be in the range [-(1 << 24), 1 << 24]
304      * @param len  number of elements in the array
305      *             constraints: multiple of 32 greater than zero
306      */
307     void (*vector_clip_int32)(int32_t *dst, const int32_t *src, int32_t min,
308                               int32_t max, unsigned int len);
309
310     op_fill_func fill_block_tab[2];
311 } DSPContext;
312
313 void ff_dsputil_static_init(void);
314 void ff_dsputil_init(DSPContext* p, AVCodecContext *avctx);
315
316 int ff_check_alignment(void);
317
318 void ff_set_cmp(DSPContext* c, me_cmp_func *cmp, int type);
319
320 void ff_dsputil_init_alpha(DSPContext* c, AVCodecContext *avctx);
321 void ff_dsputil_init_arm(DSPContext* c, AVCodecContext *avctx);
322 void ff_dsputil_init_bfin(DSPContext* c, AVCodecContext *avctx);
323 void ff_dsputil_init_mmx(DSPContext* c, AVCodecContext *avctx);
324 void ff_dsputil_init_ppc(DSPContext* c, AVCodecContext *avctx);
325 void ff_dsputil_init_sh4(DSPContext* c, AVCodecContext *avctx);
326 void ff_dsputil_init_vis(DSPContext* c, AVCodecContext *avctx);
327
328 #endif /* AVCODEC_DSPUTIL_H */