lz4file.h (3317B)
1 /* 2 LZ4 file library 3 Header File 4 Copyright (C) 2022, Xiaomi Inc. 5 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) 6 7 Redistribution and use in source and binary forms, with or without 8 modification, are permitted provided that the following conditions are 9 met: 10 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 18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 30 You can contact the author at : 31 - LZ4 source repository : https://github.com/lz4/lz4 32 - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c 33 */ 34 #if defined (__cplusplus) 35 extern "C" { 36 #endif 37 38 #ifndef LZ4FILE_H 39 #define LZ4FILE_H 40 41 #include <stdio.h> /* FILE* */ 42 #include "lz4frame_static.h" 43 44 typedef struct LZ4_readFile_s LZ4_readFile_t; 45 typedef struct LZ4_writeFile_s LZ4_writeFile_t; 46 47 /*! LZ4F_readOpen() : 48 * Set read lz4file handle. 49 * `lz4f` will set a lz4file handle. 50 * `fp` must be the return value of the lz4 file opened by fopen. 51 */ 52 LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_readOpen(LZ4_readFile_t** lz4fRead, FILE* fp); 53 54 /*! LZ4F_read() : 55 * Read lz4file content to buffer. 56 * `lz4f` must use LZ4_readOpen to set first. 57 * `buf` read data buffer. 58 * `size` read data buffer size. 59 */ 60 LZ4FLIB_STATIC_API size_t LZ4F_read(LZ4_readFile_t* lz4fRead, void* buf, size_t size); 61 62 /*! LZ4F_readClose() : 63 * Close lz4file handle. 64 * `lz4f` must use LZ4_readOpen to set first. 65 */ 66 LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_readClose(LZ4_readFile_t* lz4fRead); 67 68 /*! LZ4F_writeOpen() : 69 * Set write lz4file handle. 70 * `lz4f` will set a lz4file handle. 71 * `fp` must be the return value of the lz4 file opened by fopen. 72 */ 73 LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_writeOpen(LZ4_writeFile_t** lz4fWrite, FILE* fp, const LZ4F_preferences_t* prefsPtr); 74 75 /*! LZ4F_write() : 76 * Write buffer to lz4file. 77 * `lz4f` must use LZ4F_writeOpen to set first. 78 * `buf` write data buffer. 79 * `size` write data buffer size. 80 */ 81 LZ4FLIB_STATIC_API size_t LZ4F_write(LZ4_writeFile_t* lz4fWrite, const void* buf, size_t size); 82 83 /*! LZ4F_writeClose() : 84 * Close lz4file handle. 85 * `lz4f` must use LZ4F_writeOpen to set first. 86 */ 87 LZ4FLIB_STATIC_API LZ4F_errorCode_t LZ4F_writeClose(LZ4_writeFile_t* lz4fWrite); 88 89 #endif /* LZ4FILE_H */ 90 91 #if defined (__cplusplus) 92 } 93 #endif