doxygen: do not include license boilerplate in Doxygen documentation
[ffmpeg.git] / libavcodec / vp8dsp.h
1 /*
2  * Copyright (C) 2010 David Conrad
3  * Copyright (C) 2010 Ronald S. Bultje
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * VP8 compatible video decoder
25  */
26
27 #ifndef AVCODEC_VP8DSP_H
28 #define AVCODEC_VP8DSP_H
29
30 #include "dsputil.h"
31
32 typedef void (*vp8_mc_func)(uint8_t *dst/*align 8*/, int dstStride, uint8_t *src/*align 1*/, int srcStride, int h, int x, int y);
33
34 typedef struct VP8DSPContext {
35     void (*vp8_luma_dc_wht)(DCTELEM block[4][4][16], DCTELEM dc[16]);
36     void (*vp8_luma_dc_wht_dc)(DCTELEM block[4][4][16], DCTELEM dc[16]);
37     void (*vp8_idct_add)(uint8_t *dst, DCTELEM block[16], int stride);
38     void (*vp8_idct_dc_add)(uint8_t *dst, DCTELEM block[16], int stride);
39     void (*vp8_idct_dc_add4y)(uint8_t *dst, DCTELEM block[4][16], int stride);
40     void (*vp8_idct_dc_add4uv)(uint8_t *dst, DCTELEM block[4][16], int stride);
41
42     // loop filter applied to edges between macroblocks
43     void (*vp8_v_loop_filter16y)(uint8_t *dst, int stride,
44                                  int flim_E, int flim_I, int hev_thresh);
45     void (*vp8_h_loop_filter16y)(uint8_t *dst, int stride,
46                                  int flim_E, int flim_I, int hev_thresh);
47     void (*vp8_v_loop_filter8uv)(uint8_t *dstU, uint8_t *dstV, int stride,
48                                  int flim_E, int flim_I, int hev_thresh);
49     void (*vp8_h_loop_filter8uv)(uint8_t *dstU, uint8_t *dstV, int stride,
50                                  int flim_E, int flim_I, int hev_thresh);
51
52     // loop filter applied to inner macroblock edges
53     void (*vp8_v_loop_filter16y_inner)(uint8_t *dst, int stride,
54                                        int flim_E, int flim_I, int hev_thresh);
55     void (*vp8_h_loop_filter16y_inner)(uint8_t *dst, int stride,
56                                        int flim_E, int flim_I, int hev_thresh);
57     void (*vp8_v_loop_filter8uv_inner)(uint8_t *dstU, uint8_t *dstV, int stride,
58                                        int flim_E, int flim_I, int hev_thresh);
59     void (*vp8_h_loop_filter8uv_inner)(uint8_t *dstU, uint8_t *dstV, int stride,
60                                        int flim_E, int flim_I, int hev_thresh);
61
62     void (*vp8_v_loop_filter_simple)(uint8_t *dst, int stride, int flim);
63     void (*vp8_h_loop_filter_simple)(uint8_t *dst, int stride, int flim);
64
65     /**
66      * first dimension: width>>3, height is assumed equal to width
67      * second dimension: 0 if no vertical interpolation is needed;
68      *                   1 4-tap vertical interpolation filter (my & 1)
69      *                   2 6-tap vertical interpolation filter (!(my & 1))
70      * third dimension: same as second dimention, for horizontal interpolation
71      * so something like put_vp8_epel_pixels_tab[width>>3][2*!!my-(my&1)][2*!!mx-(mx&1)](..., mx, my)
72      */
73     vp8_mc_func put_vp8_epel_pixels_tab[3][3][3];
74     vp8_mc_func put_vp8_bilinear_pixels_tab[3][3][3];
75 } VP8DSPContext;
76
77 void ff_put_vp8_pixels16_c(uint8_t *dst, uint8_t *src, int stride, int h, int x, int y);
78 void ff_put_vp8_pixels8_c(uint8_t *dst, uint8_t *src, int stride, int h, int x, int y);
79 void ff_put_vp8_pixels4_c(uint8_t *dst, uint8_t *src, int stride, int h, int x, int y);
80
81 void ff_vp8dsp_init(VP8DSPContext *c);
82 void ff_vp8dsp_init_x86(VP8DSPContext *c);
83 void ff_vp8dsp_init_altivec(VP8DSPContext *c);
84 void ff_vp8dsp_init_arm(VP8DSPContext *c);
85
86 #endif /* AVCODEC_VP8DSP_H */