add doxygen comments
[ffmpeg.git] / libavcodec / s3tc.h
1 /*
2  * S3 Texture Compression (S3TC) decoding functions
3  * Copyright (c) 2007 by Ivo van Poorten
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  */
22
23 #ifndef FF_S3TC_H
24 #define FF_S3TC_H
25
26 #define FF_S3TC_DXT1    0x31545844
27 #define FF_S3TC_DXT3    0x33545844
28
29 /**
30  * Decode DXT1 encoded data to RGB32
31  * @param *src source buffer, has to be aligned on a 4-byte boundary
32  * @param *dst destination buffer
33  * @param w width of output image
34  * @param h height of output image
35  * @param stride line size of output image
36  */
37 void ff_decode_dxt1(const uint8_t *src, uint8_t *dst,
38                     const unsigned int w, const unsigned int h,
39                     const unsigned int stride);
40 /**
41  * Decode DXT3 encoded data to RGB32
42  * @param *src source buffer, has to be aligned on a 4-byte boundary
43  * @param *dst destination buffer
44  * @param w width of output image
45  * @param h height of output image
46  * @param stride line size of output image
47  */
48 void ff_decode_dxt3(const uint8_t *src, uint8_t *dst,
49                     const unsigned int w, const unsigned int h,
50                     const unsigned int stride);
51
52 #endif