blob: 510ca80d075a0f6b639f6ffcf08864bcea7fdb8b [file] [log] [blame]
Yann Collet439eb772015-01-31 10:52:59 +01001/*
2 zstd - standard compression library
3 Header File for static linking only
4 Copyright (C) 2014-2015, Yann Collet.
5
6 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
7
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions are
10 met:
11 * Redistributions of source code must retain the above copyright
12 notice, this list of conditions and the following disclaimer.
13 * Redistributions in binary form must reproduce the above
14 copyright notice, this list of conditions and the following disclaimer
15 in the documentation and/or other materials provided with the
16 distribution.
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 You can contact the author at :
30 - zstd source repository : https://github.com/Cyan4973/zstd
31 - ztsd public forum : https://groups.google.com/forum/#!forum/lz4c
32*/
Yann Colletaa074052015-10-30 11:21:50 +010033#ifndef ZSTD_STATIC_H
34#define ZSTD_STATIC_H
Yann Collet439eb772015-01-31 10:52:59 +010035
Yann Collet59aac5f2015-10-14 16:28:19 +010036/* The objects defined into this file should be considered experimental.
37 * They are not labelled stable, as their prototype may change in the future.
38 * You can use them for tests, provide feedback, or if you can endure risk of future changes.
39 */
40
Yann Collet439eb772015-01-31 10:52:59 +010041#if defined (__cplusplus)
42extern "C" {
43#endif
44
Yann Collet353c5d22015-10-21 14:39:26 +010045/* *************************************
Yann Collet439eb772015-01-31 10:52:59 +010046* Includes
Yann Collet353c5d22015-10-21 14:39:26 +010047***************************************/
Yann Collet439eb772015-01-31 10:52:59 +010048#include "zstd.h"
49
50
Yann Collet353c5d22015-10-21 14:39:26 +010051/* *************************************
Yann Collet439eb772015-01-31 10:52:59 +010052* Streaming functions
Yann Collet353c5d22015-10-21 14:39:26 +010053***************************************/
54size_t ZSTD_compressBegin(ZSTD_CCtx* cctx, void* dst, size_t maxDstSize);
55size_t ZSTD_compressContinue(ZSTD_CCtx* cctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize);
56size_t ZSTD_compressEnd(ZSTD_CCtx* cctx, void* dst, size_t maxDstSize);
Yann Collet439eb772015-01-31 10:52:59 +010057
Yann Collet439eb772015-01-31 10:52:59 +010058
Yann Collet353c5d22015-10-21 14:39:26 +010059typedef struct ZSTD_DCtx_s ZSTD_DCtx;
60ZSTD_DCtx* ZSTD_createDCtx(void);
61size_t ZSTD_resetDCtx(ZSTD_DCtx* dctx);
62size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx);
Yann Collet7393c5a2015-07-04 18:20:42 -080063
Yann Collet353c5d22015-10-21 14:39:26 +010064size_t ZSTD_nextSrcSizeToDecompress(ZSTD_DCtx* dctx);
65size_t ZSTD_decompressContinue(ZSTD_DCtx* dctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize);
Yann Collet00be3432015-02-20 18:53:31 +010066/*
67 Use above functions alternatively.
Yann Collet59aac5f2015-10-14 16:28:19 +010068 ZSTD_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTD_decompressContinue().
Yann Colletb1f3f4b2015-10-18 22:18:32 +010069 ZSTD_decompressContinue() will use previous data blocks to improve compression if they are located prior to current block.
Yann Collet59aac5f2015-10-14 16:28:19 +010070 Result is the number of bytes regenerated within 'dst'.
Yann Collet00be3432015-02-20 18:53:31 +010071 It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some header.
72*/
Yann Collet439eb772015-01-31 10:52:59 +010073
Yann Collet353c5d22015-10-21 14:39:26 +010074/* *************************************
Yann Colletb1f3f4b2015-10-18 22:18:32 +010075* Prefix - version detection
Yann Collet353c5d22015-10-21 14:39:26 +010076***************************************/
Yann Collet083fcc82015-10-25 14:06:35 +010077#define ZSTD_magicNumber 0xFD2FB523 /* v0.3 (current)*/
Yann Colletb1f3f4b2015-10-18 22:18:32 +010078
79
Yann Collet353c5d22015-10-21 14:39:26 +010080/* *************************************
Yann Collet439eb772015-01-31 10:52:59 +010081* Error management
Yann Collet353c5d22015-10-21 14:39:26 +010082***************************************/
Yann Colletb1f3f4b2015-10-18 22:18:32 +010083#include "error.h"
Yann Collet439eb772015-01-31 10:52:59 +010084
85
86#if defined (__cplusplus)
87}
Yann Colletc5d46b52015-02-16 18:06:26 +010088#endif
Yann Colletaa074052015-10-30 11:21:50 +010089
90#endif /* ZSTD_STATIC_H */