misc spelling fixes
[ffmpeg.git] / libswscale / swscale.h
1 /*
2  * Copyright (C) 2001-2003 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 St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef SWSCALE_H
22 #define SWSCALE_H
23
24 /**
25  * @file swscale.h
26  * @brief
27  *     external api for the swscale stuff
28  */
29
30 #include "avutil.h"
31
32 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
33 #define AV_TOSTRING(s) #s
34
35 #define LIBSWSCALE_VERSION_INT  ((0<<16)+(5<<8)+0)
36 #define LIBSWSCALE_VERSION      0.5.0
37 #define LIBSWSCALE_BUILD        LIBSWSCALE_VERSION_INT
38
39 #define LIBSWSCALE_IDENT        "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
40
41 /* values for the flags, the stuff on the command line is different */
42 #define SWS_FAST_BILINEAR     1
43 #define SWS_BILINEAR          2
44 #define SWS_BICUBIC           4
45 #define SWS_X                 8
46 #define SWS_POINT          0x10
47 #define SWS_AREA           0x20
48 #define SWS_BICUBLIN       0x40
49 #define SWS_GAUSS          0x80
50 #define SWS_SINC          0x100
51 #define SWS_LANCZOS       0x200
52 #define SWS_SPLINE        0x400
53
54 #define SWS_SRC_V_CHR_DROP_MASK     0x30000
55 #define SWS_SRC_V_CHR_DROP_SHIFT    16
56
57 #define SWS_PARAM_DEFAULT           123456
58
59 #define SWS_PRINT_INFO              0x1000
60
61 //the following 3 flags are not completely implemented
62 //internal chrominace subsampling info
63 #define SWS_FULL_CHR_H_INT    0x2000
64 //input subsampling info
65 #define SWS_FULL_CHR_H_INP    0x4000
66 #define SWS_DIRECT_BGR        0x8000
67 #define SWS_ACCURATE_RND      0x40000
68
69 #define SWS_CPU_CAPS_MMX      0x80000000
70 #define SWS_CPU_CAPS_MMX2     0x20000000
71 #define SWS_CPU_CAPS_3DNOW    0x40000000
72 #define SWS_CPU_CAPS_ALTIVEC  0x10000000
73 #define SWS_CPU_CAPS_BFIN     0x01000000
74
75 #define SWS_MAX_REDUCE_CUTOFF 0.002
76
77 #define SWS_CS_ITU709         1
78 #define SWS_CS_FCC            4
79 #define SWS_CS_ITU601         5
80 #define SWS_CS_ITU624         5
81 #define SWS_CS_SMPTE170M      5
82 #define SWS_CS_SMPTE240M      7
83 #define SWS_CS_DEFAULT        5
84
85
86
87 // when used for filters they must have an odd number of elements
88 // coeffs cannot be shared between vectors
89 typedef struct {
90     double *coeff;
91     int length;
92 } SwsVector;
93
94 // vectors can be shared
95 typedef struct {
96     SwsVector *lumH;
97     SwsVector *lumV;
98     SwsVector *chrH;
99     SwsVector *chrV;
100 } SwsFilter;
101
102 struct SwsContext;
103
104 void sws_freeContext(struct SwsContext *swsContext);
105
106 struct SwsContext *sws_getContext(int srcW, int srcH, int srcFormat, int dstW, int dstH, int dstFormat, int flags,
107                                   SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
108 int sws_scale(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY,
109               int srcSliceH, uint8_t* dst[], int dstStride[]);
110 int sws_scale_ordered(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY,
111                       int srcSliceH, uint8_t* dst[], int dstStride[]) attribute_deprecated;
112
113
114 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4], int srcRange, const int table[4], int dstRange, int brightness, int contrast, int saturation);
115 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation);
116 SwsVector *sws_getGaussianVec(double variance, double quality);
117 SwsVector *sws_getConstVec(double c, int length);
118 SwsVector *sws_getIdentityVec(void);
119 void sws_scaleVec(SwsVector *a, double scalar);
120 void sws_normalizeVec(SwsVector *a, double height);
121 void sws_convVec(SwsVector *a, SwsVector *b);
122 void sws_addVec(SwsVector *a, SwsVector *b);
123 void sws_subVec(SwsVector *a, SwsVector *b);
124 void sws_shiftVec(SwsVector *a, int shift);
125 SwsVector *sws_cloneVec(SwsVector *a);
126
127 void sws_printVec(SwsVector *a);
128 void sws_freeVec(SwsVector *a);
129
130 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
131                                 float lumaSarpen, float chromaSharpen,
132                                 float chromaHShift, float chromaVShift,
133                                 int verbose);
134 void sws_freeFilter(SwsFilter *filter);
135
136 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
137                                         int srcW, int srcH, int srcFormat,
138                                         int dstW, int dstH, int dstFormat, int flags,
139                                         SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
140
141 #endif