Mercurial > mplayer.hg
comparison libswscale/swscale.h @ 29309:037740689e99
Remove '\p' doxygen markup, as it should improve plain text doxy
readability.
author | stefano |
---|---|
date | Sat, 06 Jun 2009 09:37:46 +0000 |
parents | 8861e08033eb |
children | 86786d090e11 |
comparison
equal
deleted
inserted
replaced
29308:880c5d014d37 | 29309:037740689e99 |
---|---|
131 int dstW, int dstH, enum PixelFormat dstFormat, | 131 int dstW, int dstH, enum PixelFormat dstFormat, |
132 int flags, SwsFilter *srcFilter, | 132 int flags, SwsFilter *srcFilter, |
133 SwsFilter *dstFilter, const double *param); | 133 SwsFilter *dstFilter, const double *param); |
134 | 134 |
135 /** | 135 /** |
136 * Scales the image slice in \p srcSlice and puts the resulting scaled | 136 * Scales the image slice in srcSlice and puts the resulting scaled |
137 * slice in the image in \p dst. A slice is a sequence of consecutive | 137 * slice in the image in dst. A slice is a sequence of consecutive |
138 * rows in an image. | 138 * rows in an image. |
139 * | 139 * |
140 * @param context the scaling context previously created with | 140 * @param context the scaling context previously created with |
141 * sws_getContext() | 141 * sws_getContext() |
142 * @param srcSlice the array containing the pointers to the planes of | 142 * @param srcSlice the array containing the pointers to the planes of |
186 * quality=3 is high quality, lower is lower quality. | 186 * quality=3 is high quality, lower is lower quality. |
187 */ | 187 */ |
188 SwsVector *sws_getGaussianVec(double variance, double quality); | 188 SwsVector *sws_getGaussianVec(double variance, double quality); |
189 | 189 |
190 /** | 190 /** |
191 * Allocates and returns a vector with \p length coefficients, all | 191 * Allocates and returns a vector with length coefficients, all |
192 * with the same value \p c. | 192 * with the same value c. |
193 */ | 193 */ |
194 SwsVector *sws_getConstVec(double c, int length); | 194 SwsVector *sws_getConstVec(double c, int length); |
195 | 195 |
196 /** | 196 /** |
197 * Allocates and returns a vector with just one coefficient, with | 197 * Allocates and returns a vector with just one coefficient, with |
198 * value 1.0. | 198 * value 1.0. |
199 */ | 199 */ |
200 SwsVector *sws_getIdentityVec(void); | 200 SwsVector *sws_getIdentityVec(void); |
201 | 201 |
202 /** | 202 /** |
203 * Scales all the coefficients of \p a by the \p scalar value. | 203 * Scales all the coefficients of a by the scalar value. |
204 */ | 204 */ |
205 void sws_scaleVec(SwsVector *a, double scalar); | 205 void sws_scaleVec(SwsVector *a, double scalar); |
206 | 206 |
207 /** | 207 /** |
208 * Scales all the coefficients of \p a so that their sum equals \p | 208 * Scales all the coefficients of a so that their sum equals height. |
209 * height." | |
210 */ | 209 */ |
211 void sws_normalizeVec(SwsVector *a, double height); | 210 void sws_normalizeVec(SwsVector *a, double height); |
212 void sws_convVec(SwsVector *a, SwsVector *b); | 211 void sws_convVec(SwsVector *a, SwsVector *b); |
213 void sws_addVec(SwsVector *a, SwsVector *b); | 212 void sws_addVec(SwsVector *a, SwsVector *b); |
214 void sws_subVec(SwsVector *a, SwsVector *b); | 213 void sws_subVec(SwsVector *a, SwsVector *b); |
215 void sws_shiftVec(SwsVector *a, int shift); | 214 void sws_shiftVec(SwsVector *a, int shift); |
216 | 215 |
217 /** | 216 /** |
218 * Allocates and returns a clone of the vector \p a, that is a vector | 217 * Allocates and returns a clone of the vector a, that is a vector |
219 * with the same coefficients as \p a. | 218 * with the same coefficients as a. |
220 */ | 219 */ |
221 SwsVector *sws_cloneVec(SwsVector *a); | 220 SwsVector *sws_cloneVec(SwsVector *a); |
222 | 221 |
223 #if LIBSWSCALE_VERSION_MAJOR < 1 | 222 #if LIBSWSCALE_VERSION_MAJOR < 1 |
224 /** | 223 /** |
226 */ | 225 */ |
227 attribute_deprecated void sws_printVec(SwsVector *a); | 226 attribute_deprecated void sws_printVec(SwsVector *a); |
228 #endif | 227 #endif |
229 | 228 |
230 /** | 229 /** |
231 * Prints with av_log() a textual representation of the vector \p a | 230 * Prints with av_log() a textual representation of the vector a |
232 * if \p log_level <= av_log_level. | 231 * if log_level <= av_log_level. |
233 */ | 232 */ |
234 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level); | 233 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level); |
235 | 234 |
236 void sws_freeVec(SwsVector *a); | 235 void sws_freeVec(SwsVector *a); |
237 | 236 |
240 float chromaHShift, float chromaVShift, | 239 float chromaHShift, float chromaVShift, |
241 int verbose); | 240 int verbose); |
242 void sws_freeFilter(SwsFilter *filter); | 241 void sws_freeFilter(SwsFilter *filter); |
243 | 242 |
244 /** | 243 /** |
245 * Checks if \p context can be reused, otherwise reallocates a new | 244 * Checks if context can be reused, otherwise reallocates a new |
246 * one. | 245 * one. |
247 * | 246 * |
248 * If \p context is NULL, just calls sws_getContext() to get a new | 247 * If context is NULL, just calls sws_getContext() to get a new |
249 * context. Otherwise, checks if the parameters are the ones already | 248 * context. Otherwise, checks if the parameters are the ones already |
250 * saved in \p context. If that is the case, returns the current | 249 * saved in context. If that is the case, returns the current |
251 * context. Otherwise, frees \p context and gets a new context with | 250 * context. Otherwise, frees context and gets a new context with |
252 * the new parameters. | 251 * the new parameters. |
253 * | 252 * |
254 * Be warned that \p srcFilter and \p dstFilter are not checked, they | 253 * Be warned that srcFilter and dstFilter are not checked, they |
255 * are assumed to remain the same. | 254 * are assumed to remain the same. |
256 */ | 255 */ |
257 struct SwsContext *sws_getCachedContext(struct SwsContext *context, | 256 struct SwsContext *sws_getCachedContext(struct SwsContext *context, |
258 int srcW, int srcH, enum PixelFormat srcFormat, | 257 int srcW, int srcH, enum PixelFormat srcFormat, |
259 int dstW, int dstH, enum PixelFormat dstFormat, | 258 int dstW, int dstH, enum PixelFormat dstFormat, |