swscale: use 15-bit intermediates for 9/10-bit scaling.
[ffmpeg.git] / libswscale / swscale_internal.h
1 /*
2  * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef SWSCALE_SWSCALE_INTERNAL_H
22 #define SWSCALE_SWSCALE_INTERNAL_H
23
24 #include "config.h"
25
26 #if HAVE_ALTIVEC_H
27 #include <altivec.h>
28 #endif
29
30 #include "libavutil/avutil.h"
31 #include "libavutil/log.h"
32 #include "libavutil/pixfmt.h"
33
34 #define STR(s)         AV_TOSTRING(s) //AV_STRINGIFY is too long
35
36 #define FAST_BGR2YV12 //use 7-bit instead of 15-bit coefficients
37
38 #define MAX_FILTER_SIZE 256
39
40 #if HAVE_BIGENDIAN
41 #define ALT32_CORR (-1)
42 #else
43 #define ALT32_CORR   1
44 #endif
45
46 #if ARCH_X86_64
47 #   define APCK_PTR2 8
48 #   define APCK_COEF 16
49 #   define APCK_SIZE 24
50 #else
51 #   define APCK_PTR2 4
52 #   define APCK_COEF 8
53 #   define APCK_SIZE 16
54 #endif
55
56 struct SwsContext;
57
58 typedef int (*SwsFunc)(struct SwsContext *context, const uint8_t* src[],
59                        int srcStride[], int srcSliceY, int srcSliceH,
60                        uint8_t* dst[], int dstStride[]);
61
62 /**
63  * Write one line of horizontally scaled Y/U/V/A to planar output
64  * without any additional vertical scaling (or point-scaling).
65  *
66  * @param c       SWS scaling context
67  * @param lumSrc  scaled luma (Y) source data, 15bit for 8-10bit output,
68  *                19-bit for 16bit output (in int32_t)
69  * @param chrUSrc scaled chroma (U) source data, 15bit for 8-10bit output,
70  *                19-bit for 16bit output (in int32_t)
71  * @param chrVSrc scaled chroma (V) source data, 15bit for 8-10bit output,
72  *                19-bit for 16bit output (in int32_t)
73  * @param alpSrc  scaled alpha (A) source data, 15bit for 8-10bit output,
74  *                19-bit for 16bit output (in int32_t)
75  * @param dest    pointer to the 4 output planes (Y/U/V/A). For >8bit
76  *                output, this is in uint16_t
77  * @param dstW    width of dest[0], dest[3], lumSrc and alpSrc in pixels
78  * @param chrDstW width of dest[1], dest[2], chrUSrc and chrVSrc
79  */
80 typedef void (*yuv2planar1_fn) (struct SwsContext *c,
81                                 const int16_t *lumSrc, const int16_t *chrUSrc,
82                                 const int16_t *chrVSrc, const int16_t *alpSrc,
83                                 uint8_t *dest[4], int dstW, int chrDstW);
84 /**
85  * Write one line of horizontally scaled Y/U/V/A to planar output
86  * with multi-point vertical scaling between input pixels.
87  *
88  * @param c             SWS scaling context
89  * @param lumFilter     vertical luma/alpha scaling coefficients, 12bit [0,4096]
90  * @param lumSrc        scaled luma (Y) source data, 15bit for 8-10bit output,
91  *                      19-bit for 16bit output (in int32_t)
92  * @param lumFilterSize number of vertical luma/alpha input lines to scale
93  * @param chrFilter     vertical chroma scaling coefficients, 12bit [0,4096]
94  * @param chrUSrc       scaled chroma (U) source data, 15bit for 8-10bit output,
95  *                      19-bit for 16bit output (in int32_t)
96  * @param chrVSrc       scaled chroma (V) source data, 15bit for 8-10bit output,
97  *                      19-bit for 16bit output (in int32_t)
98  * @param chrFilterSize number of vertical chroma input lines to scale
99  * @param alpSrc        scaled alpha (A) source data, 15bit for 8-10bit output,
100  *                      19-bit for 16bit output (in int32_t)
101  * @param dest          pointer to the 4 output planes (Y/U/V/A). For >8bit
102  *                      output, this is in uint16_t
103  * @param dstW          width of dest[0], dest[3], lumSrc and alpSrc in pixels
104  * @param chrDstW       width of dest[1], dest[2], chrUSrc and chrVSrc
105  */
106 typedef void (*yuv2planarX_fn) (struct SwsContext *c, const int16_t *lumFilter,
107                                 const int16_t **lumSrc, int lumFilterSize,
108                                 const int16_t *chrFilter, const int16_t **chrUSrc,
109                                 const int16_t **chrVSrc,  int chrFilterSize,
110                                 const int16_t **alpSrc, uint8_t *dest[4],
111                                 int dstW, int chrDstW);
112 /**
113  * Write one line of horizontally scaled Y/U/V/A to packed-pixel YUV/RGB
114  * output without any additional vertical scaling (or point-scaling). Note
115  * that this function may do chroma scaling, see the "uvalpha" argument.
116  *
117  * @param c       SWS scaling context
118  * @param lumSrc  scaled luma (Y) source data, 15bit for 8-10bit output,
119  *                19-bit for 16bit output (in int32_t)
120  * @param chrUSrc scaled chroma (U) source data, 15bit for 8-10bit output,
121  *                19-bit for 16bit output (in int32_t)
122  * @param chrVSrc scaled chroma (V) source data, 15bit for 8-10bit output,
123  *                19-bit for 16bit output (in int32_t)
124  * @param alpSrc  scaled alpha (A) source data, 15bit for 8-10bit output,
125  *                19-bit for 16bit output (in int32_t)
126  * @param dest    pointer to the output plane. For 16bit output, this is
127  *                uint16_t
128  * @param dstW    width of lumSrc and alpSrc in pixels, number of pixels
129  *                to write into dest[]
130  * @param uvalpha chroma scaling coefficient for the second line of chroma
131  *                pixels, either 2048 or 0. If 0, one chroma input is used
132  *                for 2 output pixels (or if the SWS_FLAG_FULL_CHR_INT flag
133  *                is set, it generates 1 output pixel). If 2048, two chroma
134  *                input pixels should be averaged for 2 output pixels (this
135  *                only happens if SWS_FLAG_FULL_CHR_INT is not set)
136  * @param y       vertical line number for this output. This does not need
137  *                to be used to calculate the offset in the destination,
138  *                but can be used to generate comfort noise using dithering
139  *                for some output formats.
140  */
141 typedef void (*yuv2packed1_fn) (struct SwsContext *c,  const int16_t *lumSrc,
142                                 const int16_t *chrUSrc[2], const int16_t *chrVSrc[2],
143                                 const int16_t *alpSrc,  uint8_t *dest,
144                                 int dstW, int uvalpha, int y);
145 /**
146  * Write one line of horizontally scaled Y/U/V/A to packed-pixel YUV/RGB
147  * output by doing bilinear scaling between two input lines.
148  *
149  * @param c       SWS scaling context
150  * @param lumSrc  scaled luma (Y) source data, 15bit for 8-10bit output,
151  *                19-bit for 16bit output (in int32_t)
152  * @param chrUSrc scaled chroma (U) source data, 15bit for 8-10bit output,
153  *                19-bit for 16bit output (in int32_t)
154  * @param chrVSrc scaled chroma (V) source data, 15bit for 8-10bit output,
155  *                19-bit for 16bit output (in int32_t)
156  * @param alpSrc  scaled alpha (A) source data, 15bit for 8-10bit output,
157  *                19-bit for 16bit output (in int32_t)
158  * @param dest    pointer to the output plane. For 16bit output, this is
159  *                uint16_t
160  * @param dstW    width of lumSrc and alpSrc in pixels, number of pixels
161  *                to write into dest[]
162  * @param yalpha  luma/alpha scaling coefficients for the second input line.
163  *                The first line's coefficients can be calculated by using
164  *                4096 - yalpha
165  * @param uvalpha chroma scaling coefficient for the second input line. The
166  *                first line's coefficients can be calculated by using
167  *                4096 - uvalpha
168  * @param y       vertical line number for this output. This does not need
169  *                to be used to calculate the offset in the destination,
170  *                but can be used to generate comfort noise using dithering
171  *                for some output formats.
172  */
173 typedef void (*yuv2packed2_fn) (struct SwsContext *c,  const int16_t *lumSrc[2],
174                                 const int16_t *chrUSrc[2], const int16_t *chrVSrc[2],
175                                 const int16_t *alpSrc[2], uint8_t *dest,
176                                 int dstW, int yalpha, int uvalpha, int y);
177 /**
178  * Write one line of horizontally scaled Y/U/V/A to packed-pixel YUV/RGB
179  * output by doing multi-point vertical scaling between input pixels.
180  *
181  * @param c             SWS scaling context
182  * @param lumFilter     vertical luma/alpha scaling coefficients, 12bit [0,4096]
183  * @param lumSrc        scaled luma (Y) source data, 15bit for 8-10bit output,
184  *                      19-bit for 16bit output (in int32_t)
185  * @param lumFilterSize number of vertical luma/alpha input lines to scale
186  * @param chrFilter     vertical chroma scaling coefficients, 12bit [0,4096]
187  * @param chrUSrc       scaled chroma (U) source data, 15bit for 8-10bit output,
188  *                      19-bit for 16bit output (in int32_t)
189  * @param chrVSrc       scaled chroma (V) source data, 15bit for 8-10bit output,
190  *                      19-bit for 16bit output (in int32_t)
191  * @param chrFilterSize number of vertical chroma input lines to scale
192  * @param alpSrc        scaled alpha (A) source data, 15bit for 8-10bit output,
193  *                      19-bit for 16bit output (in int32_t)
194  * @param dest          pointer to the output plane. For 16bit output, this is
195  *                      uint16_t
196  * @param dstW          width of lumSrc and alpSrc in pixels, number of pixels
197  *                      to write into dest[]
198  * @param y             vertical line number for this output. This does not need
199  *                      to be used to calculate the offset in the destination,
200  *                      but can be used to generate comfort noise using dithering
201  *                      or some output formats.
202  */
203 typedef void (*yuv2packedX_fn) (struct SwsContext *c, const int16_t *lumFilter,
204                                 const int16_t **lumSrc, int lumFilterSize,
205                                 const int16_t *chrFilter, const int16_t **chrUSrc,
206                                 const int16_t **chrVSrc, int chrFilterSize,
207                                 const int16_t **alpSrc, uint8_t *dest,
208                                 int dstW, int y);
209
210 /* This struct should be aligned on at least a 32-byte boundary. */
211 typedef struct SwsContext {
212     /**
213      * info on struct for av_log
214      */
215     const AVClass *av_class;
216
217     /**
218      * Note that src, dst, srcStride, dstStride will be copied in the
219      * sws_scale() wrapper so they can be freely modified here.
220      */
221     SwsFunc swScale;
222     int srcW;                     ///< Width  of source      luma/alpha planes.
223     int srcH;                     ///< Height of source      luma/alpha planes.
224     int dstH;                     ///< Height of destination luma/alpha planes.
225     int chrSrcW;                  ///< Width  of source      chroma     planes.
226     int chrSrcH;                  ///< Height of source      chroma     planes.
227     int chrDstW;                  ///< Width  of destination chroma     planes.
228     int chrDstH;                  ///< Height of destination chroma     planes.
229     int lumXInc, chrXInc;
230     int lumYInc, chrYInc;
231     enum PixelFormat dstFormat;   ///< Destination pixel format.
232     enum PixelFormat srcFormat;   ///< Source      pixel format.
233     int dstFormatBpp;             ///< Number of bits per pixel of the destination pixel format.
234     int srcFormatBpp;             ///< Number of bits per pixel of the source      pixel format.
235     int scalingBpp;
236     int chrSrcHSubSample;         ///< Binary logarithm of horizontal subsampling factor between luma/alpha and chroma planes in source      image.
237     int chrSrcVSubSample;         ///< Binary logarithm of vertical   subsampling factor between luma/alpha and chroma planes in source      image.
238     int chrDstHSubSample;         ///< Binary logarithm of horizontal subsampling factor between luma/alpha and chroma planes in destination image.
239     int chrDstVSubSample;         ///< Binary logarithm of vertical   subsampling factor between luma/alpha and chroma planes in destination image.
240     int vChrDrop;                 ///< Binary logarithm of extra vertical subsampling factor in source image chroma planes specified by user.
241     int sliceDir;                 ///< Direction that slices are fed to the scaler (1 = top-to-bottom, -1 = bottom-to-top).
242     double param[2];              ///< Input parameters for scaling algorithms that need them.
243
244     uint32_t pal_yuv[256];
245     uint32_t pal_rgb[256];
246
247     /**
248      * @name Scaled horizontal lines ring buffer.
249      * The horizontal scaler keeps just enough scaled lines in a ring buffer
250      * so they may be passed to the vertical scaler. The pointers to the
251      * allocated buffers for each line are duplicated in sequence in the ring
252      * buffer to simplify indexing and avoid wrapping around between lines
253      * inside the vertical scaler code. The wrapping is done before the
254      * vertical scaler is called.
255      */
256     //@{
257     int16_t **lumPixBuf;          ///< Ring buffer for scaled horizontal luma   plane lines to be fed to the vertical scaler.
258     int16_t **chrUPixBuf;         ///< Ring buffer for scaled horizontal chroma plane lines to be fed to the vertical scaler.
259     int16_t **chrVPixBuf;         ///< Ring buffer for scaled horizontal chroma plane lines to be fed to the vertical scaler.
260     int16_t **alpPixBuf;          ///< Ring buffer for scaled horizontal alpha  plane lines to be fed to the vertical scaler.
261     int       vLumBufSize;        ///< Number of vertical luma/alpha lines allocated in the ring buffer.
262     int       vChrBufSize;        ///< Number of vertical chroma     lines allocated in the ring buffer.
263     int       lastInLumBuf;       ///< Last scaled horizontal luma/alpha line from source in the ring buffer.
264     int       lastInChrBuf;       ///< Last scaled horizontal chroma     line from source in the ring buffer.
265     int       lumBufIndex;        ///< Index in ring buffer of the last scaled horizontal luma/alpha line from source.
266     int       chrBufIndex;        ///< Index in ring buffer of the last scaled horizontal chroma     line from source.
267     //@}
268
269     uint8_t *formatConvBuffer;
270
271     /**
272      * @name Horizontal and vertical filters.
273      * To better understand the following fields, here is a pseudo-code of
274      * their usage in filtering a horizontal line:
275      * @code
276      * for (i = 0; i < width; i++) {
277      *     dst[i] = 0;
278      *     for (j = 0; j < filterSize; j++)
279      *         dst[i] += src[ filterPos[i] + j ] * filter[ filterSize * i + j ];
280      *     dst[i] >>= FRAC_BITS; // The actual implementation is fixed-point.
281      * }
282      * @endcode
283      */
284     //@{
285     int16_t *hLumFilter;          ///< Array of horizontal filter coefficients for luma/alpha planes.
286     int16_t *hChrFilter;          ///< Array of horizontal filter coefficients for chroma     planes.
287     int16_t *vLumFilter;          ///< Array of vertical   filter coefficients for luma/alpha planes.
288     int16_t *vChrFilter;          ///< Array of vertical   filter coefficients for chroma     planes.
289     int16_t *hLumFilterPos;       ///< Array of horizontal filter starting positions for each dst[i] for luma/alpha planes.
290     int16_t *hChrFilterPos;       ///< Array of horizontal filter starting positions for each dst[i] for chroma     planes.
291     int16_t *vLumFilterPos;       ///< Array of vertical   filter starting positions for each dst[i] for luma/alpha planes.
292     int16_t *vChrFilterPos;       ///< Array of vertical   filter starting positions for each dst[i] for chroma     planes.
293     int      hLumFilterSize;      ///< Horizontal filter size for luma/alpha pixels.
294     int      hChrFilterSize;      ///< Horizontal filter size for chroma     pixels.
295     int      vLumFilterSize;      ///< Vertical   filter size for luma/alpha pixels.
296     int      vChrFilterSize;      ///< Vertical   filter size for chroma     pixels.
297     //@}
298
299     int lumMmx2FilterCodeSize;    ///< Runtime-generated MMX2 horizontal fast bilinear scaler code size for luma/alpha planes.
300     int chrMmx2FilterCodeSize;    ///< Runtime-generated MMX2 horizontal fast bilinear scaler code size for chroma     planes.
301     uint8_t *lumMmx2FilterCode;   ///< Runtime-generated MMX2 horizontal fast bilinear scaler code for luma/alpha planes.
302     uint8_t *chrMmx2FilterCode;   ///< Runtime-generated MMX2 horizontal fast bilinear scaler code for chroma     planes.
303
304     int canMMX2BeUsed;
305
306     int dstY;                     ///< Last destination vertical line output from last slice.
307     int flags;                    ///< Flags passed by the user to select scaler algorithm, optimizations, subsampling, etc...
308     void * yuvTable;            // pointer to the yuv->rgb table start so it can be freed()
309     uint8_t * table_rV[256];
310     uint8_t * table_gU[256];
311     int    table_gV[256];
312     uint8_t * table_bU[256];
313
314     //Colorspace stuff
315     int contrast, brightness, saturation;    // for sws_getColorspaceDetails
316     int srcColorspaceTable[4];
317     int dstColorspaceTable[4];
318     int srcRange;                 ///< 0 = MPG YUV range, 1 = JPG YUV range (source      image).
319     int dstRange;                 ///< 0 = MPG YUV range, 1 = JPG YUV range (destination image).
320     int yuv2rgb_y_offset;
321     int yuv2rgb_y_coeff;
322     int yuv2rgb_v2r_coeff;
323     int yuv2rgb_v2g_coeff;
324     int yuv2rgb_u2g_coeff;
325     int yuv2rgb_u2b_coeff;
326
327 #define RED_DITHER            "0*8"
328 #define GREEN_DITHER          "1*8"
329 #define BLUE_DITHER           "2*8"
330 #define Y_COEFF               "3*8"
331 #define VR_COEFF              "4*8"
332 #define UB_COEFF              "5*8"
333 #define VG_COEFF              "6*8"
334 #define UG_COEFF              "7*8"
335 #define Y_OFFSET              "8*8"
336 #define U_OFFSET              "9*8"
337 #define V_OFFSET              "10*8"
338 #define LUM_MMX_FILTER_OFFSET "11*8"
339 #define CHR_MMX_FILTER_OFFSET "11*8+4*4*256"
340 #define DSTW_OFFSET           "11*8+4*4*256*2" //do not change, it is hardcoded in the ASM
341 #define ESP_OFFSET            "11*8+4*4*256*2+8"
342 #define VROUNDER_OFFSET       "11*8+4*4*256*2+16"
343 #define U_TEMP                "11*8+4*4*256*2+24"
344 #define V_TEMP                "11*8+4*4*256*2+32"
345 #define Y_TEMP                "11*8+4*4*256*2+40"
346 #define ALP_MMX_FILTER_OFFSET "11*8+4*4*256*2+48"
347 #define UV_OFF_PX             "11*8+4*4*256*3+48"
348 #define UV_OFF_BYTE           "11*8+4*4*256*3+56"
349 #define DITHER16              "11*8+4*4*256*3+64"
350 #define DITHER32              "11*8+4*4*256*3+80"
351
352     DECLARE_ALIGNED(8, uint64_t, redDither);
353     DECLARE_ALIGNED(8, uint64_t, greenDither);
354     DECLARE_ALIGNED(8, uint64_t, blueDither);
355
356     DECLARE_ALIGNED(8, uint64_t, yCoeff);
357     DECLARE_ALIGNED(8, uint64_t, vrCoeff);
358     DECLARE_ALIGNED(8, uint64_t, ubCoeff);
359     DECLARE_ALIGNED(8, uint64_t, vgCoeff);
360     DECLARE_ALIGNED(8, uint64_t, ugCoeff);
361     DECLARE_ALIGNED(8, uint64_t, yOffset);
362     DECLARE_ALIGNED(8, uint64_t, uOffset);
363     DECLARE_ALIGNED(8, uint64_t, vOffset);
364     int32_t  lumMmxFilter[4*MAX_FILTER_SIZE];
365     int32_t  chrMmxFilter[4*MAX_FILTER_SIZE];
366     int dstW;                     ///< Width  of destination luma/alpha planes.
367     DECLARE_ALIGNED(8, uint64_t, esp);
368     DECLARE_ALIGNED(8, uint64_t, vRounder);
369     DECLARE_ALIGNED(8, uint64_t, u_temp);
370     DECLARE_ALIGNED(8, uint64_t, v_temp);
371     DECLARE_ALIGNED(8, uint64_t, y_temp);
372     int32_t  alpMmxFilter[4*MAX_FILTER_SIZE];
373     // alignment of these values is not necessary, but merely here
374     // to maintain the same offset across x8632 and x86-64. Once we
375     // use proper offset macros in the asm, they can be removed.
376     DECLARE_ALIGNED(8, ptrdiff_t, uv_off_px);   ///< offset (in pixels) between u and v planes
377     DECLARE_ALIGNED(8, ptrdiff_t, uv_off_byte); ///< offset (in bytes) between u and v planes
378     DECLARE_ALIGNED(8, uint16_t, dither16)[8];
379     DECLARE_ALIGNED(8, uint32_t, dither32)[8];
380
381     const uint8_t *chrDither8, *lumDither8;
382
383 #if HAVE_ALTIVEC
384     vector signed short   CY;
385     vector signed short   CRV;
386     vector signed short   CBU;
387     vector signed short   CGU;
388     vector signed short   CGV;
389     vector signed short   OY;
390     vector unsigned short CSHIFT;
391     vector signed short   *vYCoeffsBank, *vCCoeffsBank;
392 #endif
393
394 #if ARCH_BFIN
395     DECLARE_ALIGNED(4, uint32_t, oy);
396     DECLARE_ALIGNED(4, uint32_t, oc);
397     DECLARE_ALIGNED(4, uint32_t, zero);
398     DECLARE_ALIGNED(4, uint32_t, cy);
399     DECLARE_ALIGNED(4, uint32_t, crv);
400     DECLARE_ALIGNED(4, uint32_t, rmask);
401     DECLARE_ALIGNED(4, uint32_t, cbu);
402     DECLARE_ALIGNED(4, uint32_t, bmask);
403     DECLARE_ALIGNED(4, uint32_t, cgu);
404     DECLARE_ALIGNED(4, uint32_t, cgv);
405     DECLARE_ALIGNED(4, uint32_t, gmask);
406 #endif
407
408 #if HAVE_VIS
409     DECLARE_ALIGNED(8, uint64_t, sparc_coeffs)[10];
410 #endif
411
412     /* function pointers for swScale() */
413     yuv2planar1_fn yuv2yuv1;
414     yuv2planarX_fn yuv2yuvX;
415     yuv2packed1_fn yuv2packed1;
416     yuv2packed2_fn yuv2packed2;
417     yuv2packedX_fn yuv2packedX;
418
419     void (*lumToYV12)(uint8_t *dst, const uint8_t *src,
420                       int width, uint32_t *pal); ///< Unscaled conversion of luma plane to YV12 for horizontal scaler.
421     void (*alpToYV12)(uint8_t *dst, const uint8_t *src,
422                       int width, uint32_t *pal); ///< Unscaled conversion of alpha plane to YV12 for horizontal scaler.
423     void (*chrToYV12)(uint8_t *dstU, uint8_t *dstV,
424                       const uint8_t *src1, const uint8_t *src2,
425                       int width, uint32_t *pal); ///< Unscaled conversion of chroma planes to YV12 for horizontal scaler.
426     /**
427      * Scale one horizontal line of input data using a bilinear filter
428      * to produce one line of output data. Compared to SwsContext->hScale(),
429      * please take note of the following caveats when using these:
430      * - Scaling is done using only 7bit instead of 14bit coefficients.
431      * - You can use no more than 5 input pixels to produce 4 output
432      *   pixels. Therefore, this filter should not be used for downscaling
433      *   by more than ~20% in width (because that equals more than 5/4th
434      *   downscaling and thus more than 5 pixels input per 4 pixels output).
435      * - In general, bilinear filters create artifacts during downscaling
436      *   (even when <20%), because one output pixel will span more than one
437      *   input pixel, and thus some pixels will need edges of both neighbor
438      *   pixels to interpolate the output pixel. Since you can use at most
439      *   two input pixels per output pixel in bilinear scaling, this is
440      *   impossible and thus downscaling by any size will create artifacts.
441      * To enable this type of scaling, set SWS_FLAG_FAST_BILINEAR
442      * in SwsContext->flags.
443      */
444     /** @{ */
445     void (*hyscale_fast)(struct SwsContext *c,
446                          int16_t *dst, int dstWidth,
447                          const uint8_t *src, int srcW, int xInc);
448     void (*hcscale_fast)(struct SwsContext *c,
449                          int16_t *dst1, int16_t *dst2, int dstWidth,
450                          const uint8_t *src1, const uint8_t *src2,
451                          int srcW, int xInc);
452     /** @} */
453
454     /**
455      * Scale one horizontal line of input data using a filter over the input
456      * lines, to produce one (differently sized) line of output data.
457      *
458      * @param dst        pointer to destination buffer for horizontally scaled
459      *                   data. If the scaling depth (SwsContext->scalingBpp) is
460      *                   8, data will be 15bpp in 16bits (int16_t) width. If
461      *                   scaling depth is 16, data will be 19bpp in 32bpp
462      *                   (int32_t) width.
463      * @param dstW       width of destination image
464      * @param src        pointer to source data to be scaled. If scaling depth
465      *                   is 8, this is 8bpp in 8bpp (uint8_t) width. If scaling
466      *                   depth is 16, this is native depth in 16bbp (uint16_t)
467      *                   width. In other words, for 9-bit YUV input, this is
468      *                   9bpp, for 10-bit YUV input, this is 10bpp, and for
469      *                   16-bit RGB or YUV, this is 16bpp.
470      * @param filter     filter coefficients to be used per output pixel for
471      *                   scaling. This contains 14bpp filtering coefficients.
472      *                   Guaranteed to contain dstW * filterSize entries.
473      * @param filterPos  position of the first input pixel to be used for
474      *                   each output pixel during scaling. Guaranteed to
475      *                   contain dstW entries.
476      * @param filterSize the number of input coefficients to be used (and
477      *                   thus the number of input pixels to be used) for
478      *                   creating a single output pixel. Is aligned to 4
479      *                   (and input coefficients thus padded with zeroes)
480      *                   to simplify creating SIMD code.
481      */
482     void (*hScale)(struct SwsContext *c, int16_t *dst, int dstW, const uint8_t *src,
483                    const int16_t *filter, const int16_t *filterPos,
484                    int filterSize);
485
486     void (*lumConvertRange)(int16_t *dst, int width); ///< Color range conversion function for luma plane if needed.
487     void (*chrConvertRange)(int16_t *dst1, int16_t *dst2, int width); ///< Color range conversion function for chroma planes if needed.
488
489     /**
490      * dst[..] = (src[..] << 8) | src[..];
491      */
492     void (*scale8To16Rv)(uint16_t *dst, const uint8_t *src, int len);
493     /**
494      * dst[..] = src[..] >> 4;
495      */
496     void (*scale19To15Fw)(int16_t *dst, const int32_t *src, int len);
497
498     int needs_hcscale; ///< Set if there are chroma planes to be converted.
499
500 } SwsContext;
501 //FIXME check init (where 0)
502
503 SwsFunc ff_yuv2rgb_get_func_ptr(SwsContext *c);
504 int ff_yuv2rgb_c_init_tables(SwsContext *c, const int inv_table[4],
505                              int fullRange, int brightness,
506                              int contrast, int saturation);
507
508 void ff_yuv2rgb_init_tables_altivec(SwsContext *c, const int inv_table[4],
509                                     int brightness, int contrast, int saturation);
510 void updateMMXDitherTables(SwsContext *c, int dstY, int lumBufIndex, int chrBufIndex,
511                            int lastInLumBuf, int lastInChrBuf);
512
513 SwsFunc ff_yuv2rgb_init_mmx(SwsContext *c);
514 SwsFunc ff_yuv2rgb_init_vis(SwsContext *c);
515 SwsFunc ff_yuv2rgb_init_mlib(SwsContext *c);
516 SwsFunc ff_yuv2rgb_init_altivec(SwsContext *c);
517 SwsFunc ff_yuv2rgb_get_func_ptr_bfin(SwsContext *c);
518 void ff_bfin_get_unscaled_swscale(SwsContext *c);
519
520 const char *sws_format_name(enum PixelFormat format);
521
522 //FIXME replace this with something faster
523 #define is16BPS(x)      (           \
524            (x)==PIX_FMT_GRAY16BE    \
525         || (x)==PIX_FMT_GRAY16LE    \
526         || (x)==PIX_FMT_BGR48BE     \
527         || (x)==PIX_FMT_BGR48LE     \
528         || (x)==PIX_FMT_RGB48BE     \
529         || (x)==PIX_FMT_RGB48LE     \
530         || (x)==PIX_FMT_YUV420P16LE \
531         || (x)==PIX_FMT_YUV422P16LE \
532         || (x)==PIX_FMT_YUV444P16LE \
533         || (x)==PIX_FMT_YUV420P16BE \
534         || (x)==PIX_FMT_YUV422P16BE \
535         || (x)==PIX_FMT_YUV444P16BE \
536     )
537 #define is9_OR_10BPS(x) (           \
538            (x)==PIX_FMT_YUV420P9LE  \
539         || (x)==PIX_FMT_YUV420P9BE  \
540         || (x)==PIX_FMT_YUV444P9BE  \
541         || (x)==PIX_FMT_YUV444P9LE  \
542         || (x)==PIX_FMT_YUV422P10BE \
543         || (x)==PIX_FMT_YUV422P10LE \
544         || (x)==PIX_FMT_YUV444P10BE \
545         || (x)==PIX_FMT_YUV444P10LE \
546         || (x)==PIX_FMT_YUV420P10LE \
547         || (x)==PIX_FMT_YUV420P10BE \
548     )
549 #define isBE(x) ((x)&1)
550 #define isPlanar8YUV(x) (           \
551            (x)==PIX_FMT_YUV410P     \
552         || (x)==PIX_FMT_YUV420P     \
553         || (x)==PIX_FMT_YUVA420P    \
554         || (x)==PIX_FMT_YUV411P     \
555         || (x)==PIX_FMT_YUV422P     \
556         || (x)==PIX_FMT_YUV444P     \
557         || (x)==PIX_FMT_YUV440P     \
558         || (x)==PIX_FMT_NV12        \
559         || (x)==PIX_FMT_NV21        \
560     )
561 #define isPlanarYUV(x)  (           \
562         isPlanar8YUV(x)             \
563         || (x)==PIX_FMT_YUV420P9LE  \
564         || (x)==PIX_FMT_YUV444P9LE  \
565         || (x)==PIX_FMT_YUV420P10LE \
566         || (x)==PIX_FMT_YUV422P10LE \
567         || (x)==PIX_FMT_YUV444P10LE \
568         || (x)==PIX_FMT_YUV420P16LE \
569         || (x)==PIX_FMT_YUV422P16LE \
570         || (x)==PIX_FMT_YUV444P16LE \
571         || (x)==PIX_FMT_YUV420P9BE  \
572         || (x)==PIX_FMT_YUV444P9BE  \
573         || (x)==PIX_FMT_YUV420P10BE \
574         || (x)==PIX_FMT_YUV422P10BE \
575         || (x)==PIX_FMT_YUV444P10BE \
576         || (x)==PIX_FMT_YUV420P16BE \
577         || (x)==PIX_FMT_YUV422P16BE \
578         || (x)==PIX_FMT_YUV444P16BE \
579     )
580 #define isYUV(x)        (           \
581            (x)==PIX_FMT_UYVY422     \
582         || (x)==PIX_FMT_YUYV422     \
583         || isPlanarYUV(x)           \
584     )
585 #define isGray(x)       (           \
586            (x)==PIX_FMT_GRAY8       \
587         || (x)==PIX_FMT_Y400A      \
588         || (x)==PIX_FMT_GRAY16BE    \
589         || (x)==PIX_FMT_GRAY16LE    \
590     )
591 #define isGray16(x)     (           \
592            (x)==PIX_FMT_GRAY16BE    \
593         || (x)==PIX_FMT_GRAY16LE    \
594     )
595 #define isRGBinInt(x)   (           \
596            (x)==PIX_FMT_RGB48BE     \
597         || (x)==PIX_FMT_RGB48LE     \
598         || (x)==PIX_FMT_RGB32       \
599         || (x)==PIX_FMT_RGB32_1     \
600         || (x)==PIX_FMT_RGB24       \
601         || (x)==PIX_FMT_RGB565BE    \
602         || (x)==PIX_FMT_RGB565LE    \
603         || (x)==PIX_FMT_RGB555BE    \
604         || (x)==PIX_FMT_RGB555LE    \
605         || (x)==PIX_FMT_RGB444BE    \
606         || (x)==PIX_FMT_RGB444LE    \
607         || (x)==PIX_FMT_RGB8        \
608         || (x)==PIX_FMT_RGB4        \
609         || (x)==PIX_FMT_RGB4_BYTE   \
610         || (x)==PIX_FMT_MONOBLACK   \
611         || (x)==PIX_FMT_MONOWHITE   \
612     )
613 #define isBGRinInt(x)   (           \
614            (x)==PIX_FMT_BGR48BE     \
615         || (x)==PIX_FMT_BGR48LE     \
616         || (x)==PIX_FMT_BGR32       \
617         || (x)==PIX_FMT_BGR32_1     \
618         || (x)==PIX_FMT_BGR24       \
619         || (x)==PIX_FMT_BGR565BE    \
620         || (x)==PIX_FMT_BGR565LE    \
621         || (x)==PIX_FMT_BGR555BE    \
622         || (x)==PIX_FMT_BGR555LE    \
623         || (x)==PIX_FMT_BGR444BE    \
624         || (x)==PIX_FMT_BGR444LE    \
625         || (x)==PIX_FMT_BGR8        \
626         || (x)==PIX_FMT_BGR4        \
627         || (x)==PIX_FMT_BGR4_BYTE   \
628         || (x)==PIX_FMT_MONOBLACK   \
629         || (x)==PIX_FMT_MONOWHITE   \
630     )
631 #define isRGBinBytes(x) (           \
632            (x)==PIX_FMT_RGB48BE     \
633         || (x)==PIX_FMT_RGB48LE     \
634         || (x)==PIX_FMT_RGBA        \
635         || (x)==PIX_FMT_ARGB        \
636         || (x)==PIX_FMT_RGB24       \
637     )
638 #define isBGRinBytes(x) (           \
639            (x)==PIX_FMT_BGR48BE     \
640         || (x)==PIX_FMT_BGR48LE     \
641         || (x)==PIX_FMT_BGRA        \
642         || (x)==PIX_FMT_ABGR        \
643         || (x)==PIX_FMT_BGR24       \
644     )
645 #define isAnyRGB(x)     (           \
646             isRGBinInt(x)           \
647         ||  isBGRinInt(x)           \
648     )
649 #define isALPHA(x)      (           \
650            (x)==PIX_FMT_BGR32       \
651         || (x)==PIX_FMT_BGR32_1     \
652         || (x)==PIX_FMT_RGB32       \
653         || (x)==PIX_FMT_RGB32_1     \
654         || (x)==PIX_FMT_Y400A       \
655         || (x)==PIX_FMT_YUVA420P    \
656     )
657 #define isPacked(x)         (       \
658            (x)==PIX_FMT_PAL8        \
659         || (x)==PIX_FMT_YUYV422     \
660         || (x)==PIX_FMT_UYVY422     \
661         || (x)==PIX_FMT_Y400A       \
662         || isAnyRGB(x)              \
663     )
664 #define usePal(x) ((av_pix_fmt_descriptors[x].flags & PIX_FMT_PAL) || (x) == PIX_FMT_Y400A)
665
666 extern const uint64_t ff_dither4[2];
667 extern const uint64_t ff_dither8[2];
668
669 extern const AVClass sws_context_class;
670
671 /**
672  * Sets c->swScale to an unscaled converter if one exists for the specific
673  * source and destination formats, bit depths, flags, etc.
674  */
675 void ff_get_unscaled_swscale(SwsContext *c);
676
677 void ff_swscale_get_unscaled_altivec(SwsContext *c);
678
679 /**
680  * Returns function pointer to fastest main scaler path function depending
681  * on architecture and available optimizations.
682  */
683 SwsFunc ff_getSwsFunc(SwsContext *c);
684
685 void ff_sws_init_swScale_altivec(SwsContext *c);
686 void ff_sws_init_swScale_mmx(SwsContext *c);
687
688 #endif /* SWSCALE_SWSCALE_INTERNAL_H */