Correct GET/PUT_UTF8 comment: the get/put functions might be called up
[libav.git] / libswscale / swscale.h
CommitLineData
fe8054c0 1/*
d026b45e
DB
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 modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (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
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * 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 * the C code (not assembly, mmx, ...) of the swscaler which has been written
21 * by Michael Niedermayer can be used under the LGPL license too
22 */
3db822b0 23
5427e242
MN
24#ifndef SWSCALE_H
25#define SWSCALE_H
26
d4e24275
MN
27/**
28 * @file swscale.h
29 * @brief
30 * external api for the swscale stuff
31 */
32
33#ifdef __cplusplus
34extern "C" {
35#endif
5427e242 36
94c4def2
LA
37#define AV_STRINGIFY(s) AV_TOSTRING(s)
38#define AV_TOSTRING(s) #s
39
40#define LIBSWSCALE_VERSION_INT ((0<<16)+(5<<8)+0)
41#define LIBSWSCALE_VERSION 0.5.0
42#define LIBSWSCALE_BUILD LIBSWSCALE_VERSION_INT
43
44#define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
45
28bf81c9
MN
46/* values for the flags, the stuff on the command line is different */
47#define SWS_FAST_BILINEAR 1
48#define SWS_BILINEAR 2
49#define SWS_BICUBIC 4
50#define SWS_X 8
ff7ba856 51#define SWS_POINT 0x10
d8863d37 52#define SWS_AREA 0x20
81a571a8 53#define SWS_BICUBLIN 0x40
a86c461c
MN
54#define SWS_GAUSS 0x80
55#define SWS_SINC 0x100
56#define SWS_LANCZOS 0x200
57#define SWS_SPLINE 0x400
1e621b18 58
a86c461c
MN
59#define SWS_SRC_V_CHR_DROP_MASK 0x30000
60#define SWS_SRC_V_CHR_DROP_SHIFT 16
5859233b 61
66d1cdb6 62#define SWS_PARAM_DEFAULT 123456
a86c461c
MN
63
64#define SWS_PRINT_INFO 0x1000
65
66//the following 3 flags are not completly implemented
1e621b18 67//internal chrominace subsamling info
985c5133 68#define SWS_FULL_CHR_H_INT 0x2000
1e621b18 69//input subsampling info
985c5133
MN
70#define SWS_FULL_CHR_H_INP 0x4000
71#define SWS_DIRECT_BGR 0x8000
bca11e75 72#define SWS_ACCURATE_RND 0x40000
1e621b18 73
516b1f82
MN
74#define SWS_CPU_CAPS_MMX 0x80000000
75#define SWS_CPU_CAPS_MMX2 0x20000000
76#define SWS_CPU_CAPS_3DNOW 0x40000000
a2faa401 77#define SWS_CPU_CAPS_ALTIVEC 0x10000000
516b1f82 78
c7f822d9 79#define SWS_MAX_REDUCE_CUTOFF 0.002
28bf81c9 80
0481412a
MN
81#define SWS_CS_ITU709 1
82#define SWS_CS_FCC 4
83#define SWS_CS_ITU601 5
84#define SWS_CS_ITU624 5
85#define SWS_CS_SMPTE170M 5
86#define SWS_CS_SMPTE240M 7
87#define SWS_CS_DEFAULT 5
88
77a49659 89
28bf81c9 90
c7f822d9
MN
91// when used for filters they must have an odd number of elements
92// coeffs cannot be shared between vectors
28bf81c9 93typedef struct {
c7f822d9 94 double *coeff;
28bf81c9 95 int length;
c7f822d9
MN
96} SwsVector;
97
98// vectors can be shared
99typedef struct {
100 SwsVector *lumH;
101 SwsVector *lumV;
102 SwsVector *chrH;
103 SwsVector *chrV;
28bf81c9
MN
104} SwsFilter;
105
d4e24275 106struct SwsContext;
077ea8a7 107
d4e24275 108void sws_freeContext(struct SwsContext *swsContext);
28bf81c9 109
d4e24275 110struct SwsContext *sws_getContext(int srcW, int srcH, int srcFormat, int dstW, int dstH, int dstFormat, int flags,
66d1cdb6 111 SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
d4e24275
MN
112int sws_scale(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY,
113 int srcSliceH, uint8_t* dst[], int dstStride[]);
fccb9b2b
MN
114int sws_scale_ordered(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY,
115 int srcSliceH, uint8_t* dst[], int dstStride[]);
d4e24275 116
d4e24275
MN
117
118int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4], int srcRange, const int table[4], int dstRange, int brightness, int contrast, int saturation);
119int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation);
120SwsVector *sws_getGaussianVec(double variance, double quality);
121SwsVector *sws_getConstVec(double c, int length);
122SwsVector *sws_getIdentityVec(void);
123void sws_scaleVec(SwsVector *a, double scalar);
124void sws_normalizeVec(SwsVector *a, double height);
125void sws_convVec(SwsVector *a, SwsVector *b);
126void sws_addVec(SwsVector *a, SwsVector *b);
127void sws_subVec(SwsVector *a, SwsVector *b);
128void sws_shiftVec(SwsVector *a, int shift);
129SwsVector *sws_cloneVec(SwsVector *a);
130
131void sws_printVec(SwsVector *a);
132void sws_freeVec(SwsVector *a);
133
e21206a8
MN
134SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
135 float lumaSarpen, float chromaSharpen,
136 float chromaHShift, float chromaVShift,
137 int verbose);
138void sws_freeFilter(SwsFilter *filter);
139
22e46959
VP
140struct SwsContext *sws_getCachedContext(struct SwsContext *context,
141 int srcW, int srcH, int srcFormat,
142 int dstW, int dstH, int dstFormat, int flags,
143 SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
144
d4e24275
MN
145#ifdef __cplusplus
146}
147#endif
28bf81c9 148
5427e242 149#endif