git.sesse.net Git - ffmpeg/blob - libavfilter/transform.h

   1 /*
   2  * Copyright (C) 2010 Georg Martius <georg.martius@web.de>
   3  * Copyright (C) 2010 Daniel G. Taylor <dan@programmer-art.org>
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef AVFILTER_TRANSFORM_H
  23 #define AVFILTER_TRANSFORM_H
  24
  25 /**
  26  * @file
  27  * transform input video
  28  *
  29  * All matrices are defined as a single 9-item block of contiguous memory. For
  30  * example, the identity matrix would be:
  31  *
  32  *     float *matrix = {1, 0, 0,
  33  *                      0, 1, 0,
  34  *                      0, 0, 1};
  35  */
  36
  37 enum InterpolateMethod {
  38     INTERPOLATE_NEAREST,        //< Nearest-neighbor (fast)
  39     INTERPOLATE_BILINEAR,       //< Bilinear
  40     INTERPOLATE_BIQUADRATIC,    //< Biquadratic (best)
  41     INTERPOLATE_COUNT,          //< Number of interpolation methods
  42 };
  43
  44 // Shortcuts for the fastest and best interpolation methods
  45 #define INTERPOLATE_DEFAULT INTERPOLATE_BILINEAR
  46 #define INTERPOLATE_FAST    INTERPOLATE_NEAREST
  47 #define INTERPOLATE_BEST    INTERPOLATE_BIQUADRATIC
  48
  49 enum FillMethod {
  50     FILL_BLANK,         //< Fill zeroes at blank locations
  51     FILL_ORIGINAL,      //< Original image at blank locations
  52     FILL_CLAMP,         //< Extruded edge value at blank locations
  53     FILL_MIRROR,        //< Mirrored edge at blank locations
  54     FILL_COUNT,         //< Number of edge fill methods
  55 };
  56
  57 // Shortcuts for fill methods
  58 #define FILL_DEFAULT FILL_ORIGINAL
  59
  60 /**
  61  * Get an affine transformation matrix from a given translation, rotation, and
  62  * zoom factor. The matrix will look like:
  63  *
  64  * [ zoom * cos(angle),           -sin(angle),     x_shift,
  65  *          sin(angle),     zoom * cos(angle),     y_shift,
  66  *                   0,                     0,           1 ]
  67  *
  68  * @param x_shift horizontal translation
  69  * @param y_shift vertical translation
  70  * @param angle   rotation in radians
  71  * @param zoom    scale percent (1.0 = 100%)
  72  * @param matrix  9-item affine transformation matrix
  73  */
  74 void avfilter_get_matrix(float x_shift, float y_shift, float angle, float zoom, float *matrix);
  75
  76 /**
  77  * Add two matrices together. result = m1 + m2.
  78  *
  79  * @param m1     9-item transformation matrix
  80  * @param m2     9-item transformation matrix
  81  * @param result 9-item transformation matrix
  82  */
  83 void avfilter_add_matrix(const float *m1, const float *m2, float *result);
  84
  85 /**
  86  * Subtract one matrix from another. result = m1 - m2.
  87  *
  88  * @param m1     9-item transformation matrix
  89  * @param m2     9-item transformation matrix
  90  * @param result 9-item transformation matrix
  91  */
  92 void avfilter_sub_matrix(const float *m1, const float *m2, float *result);
  93
  94 /**
  95  * Multiply a matrix by a scalar value. result = m1 * scalar.
  96  *
  97  * @param m1     9-item transformation matrix
  98  * @param scalar a number
  99  * @param result 9-item transformation matrix
 100  */
 101 void avfilter_mul_matrix(const float *m1, float scalar, float *result);
 102
 103 /**
 104  * Do an affine transformation with the given interpolation method. This
 105  * multiplies each vector [x,y,1] by the matrix and then interpolates to
 106  * get the final value.
 107  *
 108  * @param src         source image
 109  * @param dst         destination image
 110  * @param src_stride  source image line size in bytes
 111  * @param dst_stride  destination image line size in bytes
 112  * @param width       image width in pixels
 113  * @param height      image height in pixels
 114  * @param matrix      9-item affine transformation matrix
 115  * @param interpolate pixel interpolation method
 116  * @param fill        edge fill method
 117  */
 118 void avfilter_transform(const uint8_t *src, uint8_t *dst,
 119                         int src_stride, int dst_stride,
 120                         int width, int height, const float *matrix,
 121                         enum InterpolateMethod interpolate,
 122                         enum FillMethod fill);
 123
 124 #endif /* AVFILTER_TRANSFORM_H */