annotate libswscale/swscale.h @ 26418:c55423b185fa

Fix the indentation after the noconfig patch. Patch by Andrew Savchenko (Bircoph -at- list -dot- ru).
author albeu
date Mon, 14 Apr 2008 11:24:24 +0000
parents 5884743208b6
children 1b5516898adb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
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
5159b5f8784e license header consistency cosmetics
diego
parents: 23536
diff changeset
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
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
20
24772
fff1db0add79 Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 23702
diff changeset
21 #ifndef FFMPEG_SWSCALE_H
fff1db0add79 Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 23702
diff changeset
22 #define FFMPEG_SWSCALE_H
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
23
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
24 /**
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
25 * @file swscale.h
23129
9528d1ebe68f cosmetics: Remove trailing whitespace.
diego
parents: 21870
diff changeset
26 * @brief
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
27 * external api for the swscale stuff
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
28 */
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
29
26065
68b558c4c833 #include "libavutil/avutil.h" in swscale.h
mru
parents: 26002
diff changeset
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
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
32 #define LIBSWSCALE_VERSION_MAJOR 0
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
33 #define LIBSWSCALE_VERSION_MINOR 5
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
b225be4ade8a Clean up lib* version definitions
mru
parents: 25981
diff changeset
35
26073
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
36 #define LIBSWSCALE_VERSION_INT AV_VERSION_INT(LIBSWSCALE_VERSION_MAJOR, \
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
37 LIBSWSCALE_VERSION_MINOR, \
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
38 LIBSWSCALE_VERSION_MICRO)
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
39 #define LIBSWSCALE_VERSION AV_VERSION(LIBSWSCALE_VERSION_MAJOR, \
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
40 LIBSWSCALE_VERSION_MINOR, \
123219eaeeca less preprocessor magic in version number macros
mru
parents: 26065
diff changeset
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
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
46 /* 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
47 #define SWS_FAST_BILINEAR 1
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
48 #define SWS_BILINEAR 2
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
49 #define SWS_BICUBIC 4
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
50 #define SWS_X 8
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
51 #define SWS_POINT 0x10
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
52 #define SWS_AREA 0x20
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
53 #define SWS_BICUBLIN 0x40
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
54 #define SWS_GAUSS 0x80
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
55 #define SWS_SINC 0x100
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
56 #define SWS_LANCZOS 0x200
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
57 #define SWS_SPLINE 0x400
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
58
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
59 #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
60 #define SWS_SRC_V_CHR_DROP_SHIFT 16
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
61
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
62 #define SWS_PARAM_DEFAULT 123456
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
63
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
64 #define SWS_PRINT_INFO 0x1000
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
65
23536
ab4c0bba8f22 misc spelling fixes
diego
parents: 23304
diff changeset
66 //the following 3 flags are not completely implemented
ab4c0bba8f22 misc spelling fixes
diego
parents: 23304
diff changeset
67 //internal chrominace subsampling info
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
68 #define SWS_FULL_CHR_H_INT 0x2000
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
69 //input subsampling info
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
70 #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
71 #define SWS_DIRECT_BGR 0x8000
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
72 #define SWS_ACCURATE_RND 0x40000
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
73
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
74 #define SWS_CPU_CAPS_MMX 0x80000000
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
75 #define SWS_CPU_CAPS_MMX2 0x20000000
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
76 #define SWS_CPU_CAPS_3DNOW 0x40000000
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
77 #define SWS_CPU_CAPS_ALTIVEC 0x10000000
23289
786823779b67 Blackfin optimized YUV420 to RGB CSC Color Space Converters.
gpoirier
parents: 23155
diff changeset
78 #define SWS_CPU_CAPS_BFIN 0x01000000
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
79
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
80 #define SWS_MAX_REDUCE_CUTOFF 0.002
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
81
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
82 #define SWS_CS_ITU709 1
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
83 #define SWS_CS_FCC 4
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
84 #define SWS_CS_ITU601 5
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
85 #define SWS_CS_ITU624 5
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
86 #define SWS_CS_SMPTE170M 5
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
87 #define SWS_CS_SMPTE240M 7
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
88 #define SWS_CS_DEFAULT 5
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
89
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
90
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
91
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
92 // when used for filters they must have an odd number of elements
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
93 // coeffs cannot be shared between vectors
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
94 typedef struct {
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
95 double *coeff;
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
96 int length;
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
97 } SwsVector;
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
98
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
99 // vectors can be shared
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
100 typedef struct {
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
101 SwsVector *lumH;
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
102 SwsVector *lumV;
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
103 SwsVector *chrH;
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
104 SwsVector *chrV;
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
105 } SwsFilter;
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
106
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
107 struct SwsContext;
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
108
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
109 void sws_freeContext(struct SwsContext *swsContext);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
110
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
111 struct SwsContext *sws_getContext(int srcW, int srcH, int srcFormat, int dstW, int dstH, int dstFormat, int flags,
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
112 SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
113 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
114 int srcSliceH, uint8_t* dst[], int dstStride[]);
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
115 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
116 int srcSliceH, uint8_t* dst[], int dstStride[]) attribute_deprecated;
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
117
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
118
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
119 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);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
120 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
121 SwsVector *sws_getGaussianVec(double variance, double quality);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
122 SwsVector *sws_getConstVec(double c, int length);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
123 SwsVector *sws_getIdentityVec(void);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
124 void sws_scaleVec(SwsVector *a, double scalar);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
125 void sws_normalizeVec(SwsVector *a, double height);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
126 void sws_convVec(SwsVector *a, SwsVector *b);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
127 void sws_addVec(SwsVector *a, SwsVector *b);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
128 void sws_subVec(SwsVector *a, SwsVector *b);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
129 void sws_shiftVec(SwsVector *a, int shift);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
130 SwsVector *sws_cloneVec(SwsVector *a);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
131
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
132 void sws_printVec(SwsVector *a);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
133 void sws_freeVec(SwsVector *a);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
134
23129
9528d1ebe68f cosmetics: Remove trailing whitespace.
diego
parents: 21870
diff changeset
135 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
136 float lumaSarpen, float chromaSharpen,
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
137 float chromaHShift, float chromaVShift,
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
138 int verbose);
18861
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
139 void sws_freeFilter(SwsFilter *filter);
8579acff875e Move postproc ---> libswscale
lucabe
parents:
diff changeset
140
19661
7b24faac56fd Add sws_getCachedContext(), which checks if context is valid or reallocs a new one instead.
gpoirier
parents: 19594
diff changeset
141 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
23155
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
142 int srcW, int srcH, int srcFormat,
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
143 int dstW, int dstH, int dstFormat, int flags,
1befc8d767cd cosmetics attack, part II: Remove all tabs and prettyprint/reindent the code.
diego
parents: 23129
diff changeset
144 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
145
24772
fff1db0add79 Add FFMPEG_ prefix to all multiple inclusion guards.
diego
parents: 23702
diff changeset
146 #endif /* FFMPEG_SWSCALE_H */