Move doxygen documentation from lzo.c to lzo.h
[ffmpeg.git] / libavutil / lzo.h
1 /*
2  * LZO 1x decompression
3  * copyright (c) 2006 Reimar Doeffinger
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 #ifndef AVUTIL_LZO_H
23 #define AVUTIL_LZO_H
24
25 #include <stdint.h>
26
27 #define AV_LZO_INPUT_DEPLETED 1
28 #define AV_LZO_OUTPUT_FULL 2
29 #define AV_LZO_INVALID_BACKPTR 4
30 #define AV_LZO_ERROR 8
31
32 #define AV_LZO_INPUT_PADDING 8
33 #define AV_LZO_OUTPUT_PADDING 12
34
35 /**
36  * \brief Decodes LZO 1x compressed data.
37  * \param out output buffer
38  * \param outlen size of output buffer, number of bytes left are returned here
39  * \param in input buffer
40  * \param inlen size of input buffer, number of bytes left are returned here
41  * \return 0 on success, otherwise error flags, see lzo.h
42  *
43  * Make sure all buffers are appropriately padded, in must provide
44  * AV_LZO_INPUT_PADDING, out must provide AV_LZO_OUTPUT_PADDING additional bytes.
45  */
46 int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen);
47
48 /**
49  * \brief deliberately overlapping memcpy implementation
50  * \param dst destination buffer; must be padded with 12 additional bytes
51  * \param back how many bytes back we start (the initial size of the overlapping window)
52  * \param cnt number of bytes to copy, must be >= 0
53  *
54  * cnt > back is valid, this will copy the bytes we just copied,
55  * thus creating a repeating pattern with a period length of back.
56  */
57 void av_memcpy_backptr(uint8_t *dst, int back, int cnt);
58
59 #endif /* AVUTIL_LZO_H */