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