Implement Snappy decompression
[libav.git] / libavcodec / snappy.h
1 /*
2 * Snappy module
3 * Copyright (c) Luca Barbato
4 *
5 * This file is part of Libav.
6 *
7 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 /**
23 * @file
24 * Snappy decompression
25 *
26 * Snappy is a compression/decompression algorithm that does not aim for
27 * maximum compression, but rather for very high speeds and reasonable
28 * compression.
29 *
30 * http://en.wikipedia.org/wiki/Snappy_%28software%29
31 */
32
33 #ifndef AVCODEC_SNAPPY_H
34 #define AVCODEC_SNAPPY_H
35
36 #include <stdint.h>
37
38 #include "bytestream.h"
39
40 /**
41 * Decompress an input buffer using Snappy algorithm. Caller is
42 * responsible of freeing the memory allocated in buf.
43 *
44 * @param gb input GetByteContext.
45 * @param buf output buffer pointer.
46 * @param size output buffer size.
47 * @return 0 if success, AVERROR otherwise.
48 */
49 int ff_snappy_uncompress(GetByteContext *gb, uint8_t **buf, int64_t *size);
50
51 #endif /* AVCODEC_SNAPPY_H */