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