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