| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 1 | /* |
| 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 | */ |
| 33 | #pragma once |
| 34 | |
| Yann Collet | 59aac5f | 2015-10-14 16:28:19 +0100 | [diff] [blame] | 35 | /* The objects defined into this file should be considered experimental. |
| 36 | * They are not labelled stable, as their prototype may change in the future. |
| 37 | * You can use them for tests, provide feedback, or if you can endure risk of future changes. |
| 38 | */ |
| 39 | |
| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 40 | #if defined (__cplusplus) |
| 41 | extern "C" { |
| 42 | #endif |
| 43 | |
| 44 | /************************************** |
| 45 | * Includes |
| 46 | **************************************/ |
| 47 | #include "zstd.h" |
| 48 | |
| 49 | |
| 50 | /************************************** |
| 51 | * Streaming functions |
| 52 | **************************************/ |
| Yann Collet | 7393c5a | 2015-07-04 18:20:42 -0800 | [diff] [blame] | 53 | typedef struct ZSTD_Cctx_s ZSTD_Cctx; |
| 54 | ZSTD_Cctx* ZSTD_createCCtx(void); |
| 55 | size_t ZSTD_freeCCtx(ZSTD_Cctx* cctx); |
| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 56 | |
| Yann Collet | 7393c5a | 2015-07-04 18:20:42 -0800 | [diff] [blame] | 57 | size_t ZSTD_compressBegin(ZSTD_Cctx* cctx, void* dst, size_t maxDstSize); |
| 58 | size_t ZSTD_compressContinue(ZSTD_Cctx* cctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize); |
| 59 | size_t ZSTD_compressEnd(ZSTD_Cctx* cctx, void* dst, size_t maxDstSize); |
| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 60 | |
| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 61 | |
| Yann Collet | 7393c5a | 2015-07-04 18:20:42 -0800 | [diff] [blame] | 62 | typedef struct ZSTD_Dctx_s ZSTD_Dctx; |
| 63 | ZSTD_Dctx* ZSTD_createDCtx(void); |
| Yann Collet | be50aaa | 2015-09-10 23:26:09 +0100 | [diff] [blame] | 64 | size_t ZSTD_resetDCtx(ZSTD_Dctx* dctx); |
| Yann Collet | 7393c5a | 2015-07-04 18:20:42 -0800 | [diff] [blame] | 65 | size_t ZSTD_freeDCtx(ZSTD_Dctx* dctx); |
| 66 | |
| 67 | size_t ZSTD_nextSrcSizeToDecompress(ZSTD_Dctx* dctx); |
| 68 | size_t ZSTD_decompressContinue(ZSTD_Dctx* dctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize); |
| Yann Collet | 00be343 | 2015-02-20 18:53:31 +0100 | [diff] [blame] | 69 | /* |
| 70 | Use above functions alternatively. |
| Yann Collet | 59aac5f | 2015-10-14 16:28:19 +0100 | [diff] [blame] | 71 | ZSTD_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTD_decompressContinue(). |
| Yann Collet | b1f3f4b | 2015-10-18 22:18:32 +0100 | [diff] [blame^] | 72 | ZSTD_decompressContinue() will use previous data blocks to improve compression if they are located prior to current block. |
| Yann Collet | 59aac5f | 2015-10-14 16:28:19 +0100 | [diff] [blame] | 73 | Result is the number of bytes regenerated within 'dst'. |
| Yann Collet | 00be343 | 2015-02-20 18:53:31 +0100 | [diff] [blame] | 74 | It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some header. |
| 75 | */ |
| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 76 | |
| 77 | /************************************** |
| Yann Collet | b1f3f4b | 2015-10-18 22:18:32 +0100 | [diff] [blame^] | 78 | * Prefix - version detection |
| 79 | **************************************/ |
| 80 | #define ZSTD_magicNumber 0xFD2FB522 /* v0.2 (current)*/ |
| 81 | |
| 82 | |
| 83 | /************************************** |
| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 84 | * Error management |
| 85 | **************************************/ |
| Yann Collet | b1f3f4b | 2015-10-18 22:18:32 +0100 | [diff] [blame^] | 86 | #include "error.h" |
| Yann Collet | 439eb77 | 2015-01-31 10:52:59 +0100 | [diff] [blame] | 87 | |
| 88 | |
| 89 | #if defined (__cplusplus) |
| 90 | } |
| Yann Collet | c5d46b5 | 2015-02-16 18:06:26 +0100 | [diff] [blame] | 91 | #endif |