dsputil: Split bswap*_buf() off into a separate context
[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 extern uint32_t ff_square_tab[512];
36
37 void ff_gmc_c(uint8_t *dst, uint8_t *src, int stride, int h, int ox, int oy,
38               int dxx, int dxy, int dyx, int dyy, int shift, int r,
39               int width, int height);
40
41 struct MpegEncContext;
42 /* Motion estimation:
43  * h is limited to { width / 2, width, 2 * width },
44  * but never larger than 16 and never smaller than 2.
45  * Although currently h < 4 is not used as functions with
46  * width < 8 are neither used nor implemented. */
47 typedef int (*me_cmp_func)(struct MpegEncContext *c,
48                            uint8_t *blk1 /* align width (8 or 16) */,
49                            uint8_t *blk2 /* align 1 */, int line_size, int h);
50
51 /**
52  * Scantable.
53  */
54 typedef struct ScanTable {
55     const uint8_t *scantable;
56     uint8_t permutated[64];
57     uint8_t raster_end[64];
58 } ScanTable;
59
60 void ff_init_scantable(uint8_t *permutation, ScanTable *st,
61                        const uint8_t *src_scantable);
62 void ff_init_scantable_permutation(uint8_t *idct_permutation,
63                                    int idct_permutation_type);
64
65 /**
66  * DSPContext.
67  */
68 typedef struct DSPContext {
69     /* pixel ops : interface with DCT */
70     void (*get_pixels)(int16_t *block /* align 16 */,
71                        const uint8_t *pixels /* align 8 */,
72                        int line_size);
73     void (*diff_pixels)(int16_t *block /* align 16 */,
74                         const uint8_t *s1 /* align 8 */,
75                         const uint8_t *s2 /* align 8 */,
76                         int stride);
77     void (*put_pixels_clamped)(const int16_t *block /* align 16 */,
78                                uint8_t *pixels /* align 8 */,
79                                int line_size);
80     void (*put_signed_pixels_clamped)(const int16_t *block /* align 16 */,
81                                       uint8_t *pixels /* align 8 */,
82                                       int line_size);
83     void (*add_pixels_clamped)(const int16_t *block /* align 16 */,
84                                uint8_t *pixels /* align 8 */,
85                                int line_size);
86     int (*sum_abs_dctelem)(int16_t *block /* align 16 */);
87     /**
88      * translational global motion compensation.
89      */
90     void (*gmc1)(uint8_t *dst /* align 8 */, uint8_t *src /* align 1 */,
91                  int srcStride, int h, int x16, int y16, int rounder);
92     /**
93      * global motion compensation.
94      */
95     void (*gmc)(uint8_t *dst /* align 8 */, uint8_t *src /* align 1 */,
96                 int stride, int h, int ox, int oy,
97                 int dxx, int dxy, int dyx, int dyy,
98                 int shift, int r, int width, int height);
99
100     int (*pix_sum)(uint8_t *pix, int line_size);
101     int (*pix_norm1)(uint8_t *pix, int line_size);
102
103     me_cmp_func sad[6]; /* identical to pix_absAxA except additional void * */
104     me_cmp_func sse[6];
105     me_cmp_func hadamard8_diff[6];
106     me_cmp_func dct_sad[6];
107     me_cmp_func quant_psnr[6];
108     me_cmp_func bit[6];
109     me_cmp_func rd[6];
110     me_cmp_func vsad[6];
111     me_cmp_func vsse[6];
112     me_cmp_func nsse[6];
113     me_cmp_func dct_max[6];
114     me_cmp_func dct264_sad[6];
115
116     me_cmp_func me_pre_cmp[6];
117     me_cmp_func me_cmp[6];
118     me_cmp_func me_sub_cmp[6];
119     me_cmp_func mb_cmp[6];
120     me_cmp_func ildct_cmp[6]; // only width 16 used
121     me_cmp_func frame_skip_cmp[6]; // only width 8 used
122
123     me_cmp_func pix_abs[2][4];
124
125     /* (I)DCT */
126     void (*fdct)(int16_t *block /* align 16 */);
127     void (*fdct248)(int16_t *block /* align 16 */);
128
129     /* IDCT really */
130     void (*idct)(int16_t *block /* align 16 */);
131
132     /**
133      * block -> idct -> clip to unsigned 8 bit -> dest.
134      * (-1392, 0, 0, ...) -> idct -> (-174, -174, ...) -> put -> (0, 0, ...)
135      * @param line_size size in bytes of a horizontal line of dest
136      */
137     void (*idct_put)(uint8_t *dest /* align 8 */,
138                      int line_size, int16_t *block /* align 16 */);
139
140     /**
141      * block -> idct -> add dest -> clip to unsigned 8 bit -> dest.
142      * @param line_size size in bytes of a horizontal line of dest
143      */
144     void (*idct_add)(uint8_t *dest /* align 8 */,
145                      int line_size, int16_t *block /* align 16 */);
146
147     /**
148      * IDCT input permutation.
149      * Several optimized IDCTs need a permutated input (relative to the
150      * normal order of the reference IDCT).
151      * This permutation must be performed before the idct_put/add.
152      * Note, normally this can be merged with the zigzag/alternate scan<br>
153      * An example to avoid confusion:
154      * - (->decode coeffs -> zigzag reorder -> dequant -> reference IDCT -> ...)
155      * - (x -> reference DCT -> reference IDCT -> x)
156      * - (x -> reference DCT -> simple_mmx_perm = idct_permutation
157      *    -> simple_idct_mmx -> x)
158      * - (-> decode coeffs -> zigzag reorder -> simple_mmx_perm -> dequant
159      *    -> simple_idct_mmx -> ...)
160      */
161     uint8_t idct_permutation[64];
162     int idct_permutation_type;
163 #define FF_NO_IDCT_PERM 1
164 #define FF_LIBMPEG2_IDCT_PERM 2
165 #define FF_SIMPLE_IDCT_PERM 3
166 #define FF_TRANSPOSE_IDCT_PERM 4
167 #define FF_PARTTRANS_IDCT_PERM 5
168 #define FF_SSE2_IDCT_PERM 6
169
170     int (*try_8x8basis)(int16_t rem[64], int16_t weight[64],
171                         int16_t basis[64], int scale);
172     void (*add_8x8basis)(int16_t rem[64], int16_t basis[64], int scale);
173 #define BASIS_SHIFT 16
174 #define RECON_SHIFT 6
175
176     void (*draw_edges)(uint8_t *buf, int wrap, int width, int height,
177                        int w, int h, int sides);
178 #define EDGE_WIDTH 16
179 #define EDGE_TOP    1
180 #define EDGE_BOTTOM 2
181
182     void (*shrink[4])(uint8_t *dst, int dst_wrap, const uint8_t *src,
183                       int src_wrap, int width, int height);
184 } DSPContext;
185
186 void ff_dsputil_static_init(void);
187 void ff_dsputil_init(DSPContext *p, AVCodecContext *avctx);
188
189 void ff_set_cmp(DSPContext *c, me_cmp_func *cmp, int type);
190
191 void ff_dsputil_init_arm(DSPContext *c, AVCodecContext *avctx,
192                          unsigned high_bit_depth);
193 void ff_dsputil_init_ppc(DSPContext *c, AVCodecContext *avctx,
194                          unsigned high_bit_depth);
195 void ff_dsputil_init_x86(DSPContext *c, AVCodecContext *avctx,
196                          unsigned high_bit_depth);
197
198 #endif /* AVCODEC_DSPUTIL_H */