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