Mercurial > mplayer.hg
annotate libswscale/swscale.h @ 28492:d31543ec920a
Document sws_cloneVec().
author | stefano |
---|---|
date | Tue, 10 Feb 2009 23:43:08 +0000 |
parents | c30fa7f74789 |
children | 95cfbbaa4f03 |
rev | line source |
---|---|
18861 | 1 /* |
20094
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
2 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at> |
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
3 * |
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
4 * This file is part of FFmpeg. |
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
5 * |
21029
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
6 * FFmpeg is free software; you can redistribute it and/or |
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
7 * modify it under the terms of the GNU Lesser General Public |
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
8 * License as published by the Free Software Foundation; either |
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
9 * version 2.1 of the License, or (at your option) any later version. |
20094
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
10 * |
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
11 * FFmpeg is distributed in the hope that it will be useful, |
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
21029
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
14 * Lesser General Public License for more details. |
20094
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
15 * |
21029
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
16 * You should have received a copy of the GNU Lesser General Public |
1f2ba24b4e47
Clarify that some of the non-SIMD code is now LGPLed.
lucabe
parents:
20094
diff
changeset
|
17 * License along with FFmpeg; if not, write to the Free Software |
23702 | 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
20094
aca9e9783f67
Change license headers to say 'FFmpeg' instead of 'this program'.
diego
parents:
19661
diff
changeset
|
19 */ |
18861 | 20 |
27467
239a049163eb
Change header inclusion guard names in line with FFmpeg r15120.
stefano
parents:
27460
diff
changeset
|
21 #ifndef SWSCALE_SWSCALE_H |
239a049163eb
Change header inclusion guard names in line with FFmpeg r15120.
stefano
parents:
27460
diff
changeset
|
22 #define SWSCALE_SWSCALE_H |
18861 | 23 |
24 /** | |
28379
296f37c6ff02
Use full internal pathname in doxygen @file directives.
diego
parents:
27560
diff
changeset
|
25 * @file libswscale/swscale.h |
23129 | 26 * @brief |
18861 | 27 * external api for the swscale stuff |
28 */ | |
29 | |
26065 | 30 #include "libavutil/avutil.h" |
21870
cad3e015ddde
deprecate sws_scale_ordered(), as it now is a duplicate of sws_scale()
lucabe
parents:
21029
diff
changeset
|
31 |
26073 | 32 #define LIBSWSCALE_VERSION_MAJOR 0 |
27460 | 33 #define LIBSWSCALE_VERSION_MINOR 6 |
26151
5884743208b6
change sws_format_name to return const char*, supress many warnings
bcoudurier
parents:
26073
diff
changeset
|
34 #define LIBSWSCALE_VERSION_MICRO 1 |
26002 | 35 |
26073 | 36 #define LIBSWSCALE_VERSION_INT AV_VERSION_INT(LIBSWSCALE_VERSION_MAJOR, \ |
37 LIBSWSCALE_VERSION_MINOR, \ | |
38 LIBSWSCALE_VERSION_MICRO) | |
39 #define LIBSWSCALE_VERSION AV_VERSION(LIBSWSCALE_VERSION_MAJOR, \ | |
40 LIBSWSCALE_VERSION_MINOR, \ | |
41 LIBSWSCALE_VERSION_MICRO) | |
19143
c4dac777b44c
Use libavutil in libswscale, and allow it to be built out of the mplayer tree
lucabe
parents:
18861
diff
changeset
|
42 #define LIBSWSCALE_BUILD LIBSWSCALE_VERSION_INT |
c4dac777b44c
Use libavutil in libswscale, and allow it to be built out of the mplayer tree
lucabe
parents:
18861
diff
changeset
|
43 |
c4dac777b44c
Use libavutil in libswscale, and allow it to be built out of the mplayer tree
lucabe
parents:
18861
diff
changeset
|
44 #define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION) |
c4dac777b44c
Use libavutil in libswscale, and allow it to be built out of the mplayer tree
lucabe
parents:
18861
diff
changeset
|
45 |
27460 | 46 /** |
47 * Returns the LIBSWSCALE_VERSION_INT constant. | |
48 */ | |
49 unsigned swscale_version(void); | |
50 | |
18861 | 51 /* values for the flags, the stuff on the command line is different */ |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
52 #define SWS_FAST_BILINEAR 1 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
53 #define SWS_BILINEAR 2 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
54 #define SWS_BICUBIC 4 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
55 #define SWS_X 8 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
56 #define SWS_POINT 0x10 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
57 #define SWS_AREA 0x20 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
58 #define SWS_BICUBLIN 0x40 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
59 #define SWS_GAUSS 0x80 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
60 #define SWS_SINC 0x100 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
61 #define SWS_LANCZOS 0x200 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
62 #define SWS_SPLINE 0x400 |
18861 | 63 |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
64 #define SWS_SRC_V_CHR_DROP_MASK 0x30000 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
65 #define SWS_SRC_V_CHR_DROP_SHIFT 16 |
18861 | 66 |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
67 #define SWS_PARAM_DEFAULT 123456 |
18861 | 68 |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
69 #define SWS_PRINT_INFO 0x1000 |
18861 | 70 |
23536 | 71 //the following 3 flags are not completely implemented |
72 //internal chrominace subsampling info | |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
73 #define SWS_FULL_CHR_H_INT 0x2000 |
18861 | 74 //input subsampling info |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
75 #define SWS_FULL_CHR_H_INP 0x4000 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
76 #define SWS_DIRECT_BGR 0x8000 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
77 #define SWS_ACCURATE_RND 0x40000 |
27560 | 78 #define SWS_BITEXACT 0x80000 |
18861 | 79 |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
80 #define SWS_CPU_CAPS_MMX 0x80000000 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
81 #define SWS_CPU_CAPS_MMX2 0x20000000 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
82 #define SWS_CPU_CAPS_3DNOW 0x40000000 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
83 #define SWS_CPU_CAPS_ALTIVEC 0x10000000 |
23289
786823779b67
Blackfin optimized YUV420 to RGB CSC Color Space Converters.
gpoirier
parents:
23155
diff
changeset
|
84 #define SWS_CPU_CAPS_BFIN 0x01000000 |
18861 | 85 |
86 #define SWS_MAX_REDUCE_CUTOFF 0.002 | |
87 | |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
88 #define SWS_CS_ITU709 1 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
89 #define SWS_CS_FCC 4 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
90 #define SWS_CS_ITU601 5 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
91 #define SWS_CS_ITU624 5 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
92 #define SWS_CS_SMPTE170M 5 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
93 #define SWS_CS_SMPTE240M 7 |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
94 #define SWS_CS_DEFAULT 5 |
18861 | 95 |
96 | |
97 | |
98 // when used for filters they must have an odd number of elements | |
99 // coeffs cannot be shared between vectors | |
100 typedef struct { | |
28477 | 101 double *coeff; ///< pointer to the list of coefficients |
102 int length; ///< number of coefficients in the vector | |
18861 | 103 } SwsVector; |
104 | |
105 // vectors can be shared | |
106 typedef struct { | |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
107 SwsVector *lumH; |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
108 SwsVector *lumV; |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
109 SwsVector *chrH; |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
110 SwsVector *chrV; |
18861 | 111 } SwsFilter; |
112 | |
113 struct SwsContext; | |
114 | |
115 void sws_freeContext(struct SwsContext *swsContext); | |
116 | |
28456
2402abd3a2d5
Replace int type with enum PixelFormat for the dstFormat/srcFormat
stefano
parents:
28455
diff
changeset
|
117 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat, int dstW, int dstH, enum PixelFormat dstFormat, int flags, |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
118 SwsFilter *srcFilter, SwsFilter *dstFilter, double *param); |
18861 | 119 int sws_scale(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY, |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
120 int srcSliceH, uint8_t* dst[], int dstStride[]); |
28457
7d49f24cc18f
Drop the deprecated sws_scale_ordered() at the next major version
stefano
parents:
28456
diff
changeset
|
121 #if LIBSWSCALE_VERSION_MAJOR < 1 |
28486
423d3751bfd2
Add a @deprecated notice to swscale_get_ordered().
stefano
parents:
28477
diff
changeset
|
122 /** |
423d3751bfd2
Add a @deprecated notice to swscale_get_ordered().
stefano
parents:
28477
diff
changeset
|
123 * @deprecated Use sws_scale() instead. |
423d3751bfd2
Add a @deprecated notice to swscale_get_ordered().
stefano
parents:
28477
diff
changeset
|
124 */ |
18861 | 125 int sws_scale_ordered(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY, |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
126 int srcSliceH, uint8_t* dst[], int dstStride[]) attribute_deprecated; |
28457
7d49f24cc18f
Drop the deprecated sws_scale_ordered() at the next major version
stefano
parents:
28456
diff
changeset
|
127 #endif |
18861 | 128 |
129 | |
130 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); | |
131 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation); | |
132 SwsVector *sws_getGaussianVec(double variance, double quality); | |
28489 | 133 |
134 /** | |
28491 | 135 * Allocates and returns a vector with \p length coefficients, all |
28489 | 136 * with the same value \p c. |
137 */ | |
18861 | 138 SwsVector *sws_getConstVec(double c, int length); |
139 SwsVector *sws_getIdentityVec(void); | |
28490 | 140 |
141 /** | |
142 * Scales all the coefficients of \p a by the \p scalar value. | |
143 */ | |
18861 | 144 void sws_scaleVec(SwsVector *a, double scalar); |
145 void sws_normalizeVec(SwsVector *a, double height); | |
146 void sws_convVec(SwsVector *a, SwsVector *b); | |
147 void sws_addVec(SwsVector *a, SwsVector *b); | |
148 void sws_subVec(SwsVector *a, SwsVector *b); | |
149 void sws_shiftVec(SwsVector *a, int shift); | |
28492 | 150 |
151 /** | |
152 * Allocates and returns a clone of the vector \p a, that is a vector | |
153 * with the same coefficients as \p a. | |
154 */ | |
18861 | 155 SwsVector *sws_cloneVec(SwsVector *a); |
156 | |
157 void sws_printVec(SwsVector *a); | |
158 void sws_freeVec(SwsVector *a); | |
159 | |
23129 | 160 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur, |
28455 | 161 float lumaSharpen, float chromaSharpen, |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
162 float chromaHShift, float chromaVShift, |
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
163 int verbose); |
18861 | 164 void sws_freeFilter(SwsFilter *filter); |
165 | |
28488
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
166 /** |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
167 * Checks if context is valid or reallocs a new one instead. |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
168 * If context is NULL, just calls sws_getContext() to get a new one. |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
169 * Otherwise, checks if the parameters are the ones already saved in context. |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
170 * If that is the case, returns the current context. |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
171 * Otherwise, frees context and gets a new one. |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
172 * |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
173 * Be warned that srcFilter, dstFilter are not checked, they are |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
174 * asumed to remain valid. |
01afb64ccf4a
Move documentation of sws_getCachedContext() from swscale.c to
stefano
parents:
28486
diff
changeset
|
175 */ |
19661
7b24faac56fd
Add sws_getCachedContext(), which checks if context is valid or reallocs a new one instead.
gpoirier
parents:
19594
diff
changeset
|
176 struct SwsContext *sws_getCachedContext(struct SwsContext *context, |
28456
2402abd3a2d5
Replace int type with enum PixelFormat for the dstFormat/srcFormat
stefano
parents:
28455
diff
changeset
|
177 int srcW, int srcH, enum PixelFormat srcFormat, |
2402abd3a2d5
Replace int type with enum PixelFormat for the dstFormat/srcFormat
stefano
parents:
28455
diff
changeset
|
178 int dstW, int dstH, enum PixelFormat dstFormat, int flags, |
23155
1befc8d767cd
cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents:
23129
diff
changeset
|
179 SwsFilter *srcFilter, SwsFilter *dstFilter, double *param); |
19661
7b24faac56fd
Add sws_getCachedContext(), which checks if context is valid or reallocs a new one instead.
gpoirier
parents:
19594
diff
changeset
|
180 |
27467
239a049163eb
Change header inclusion guard names in line with FFmpeg r15120.
stefano
parents:
27460
diff
changeset
|
181 #endif /* SWSCALE_SWSCALE_H */ |