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