lz4io.h revision ef54f9f9dd5d69ab69a085f25adaf4ce4533fe5c 
1/*
2  LZ4io.h - LZ4 File/Stream Interface
3  Copyright (C) Yann Collet 2011-2015
4  GPL v2 License
5
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  GNU General Public License for more details.
15
16  You should have received a copy of the GNU General Public License along
17  with this program; if not, write to the Free Software Foundation, Inc.,
18  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20  You can contact the author at :
21  - LZ4 source repository : https://github.com/lz4/lz4
22  - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c
23*/
24/*
25  Note : this is stand-alone program.
26  It is not part of LZ4 compression library, it is a user code of the LZ4 library.
27  - The license of LZ4 library is BSD.
28  - The license of xxHash library is BSD.
29  - The license of this source file is GPLv2.
30*/
31
32#pragma once
33
34/* ************************************************** */
35/* Special input/output values                        */
36/* ************************************************** */
37#define NULL_OUTPUT "null"
38static char const stdinmark[] = "stdin";
39static char const stdoutmark[] = "stdout";
40#ifdef _WIN32
41static char const nulmark[] = "nul";
42#else
43static char const nulmark[] = "/dev/null";
44#endif
45
46
47/* ************************************************** */
48/* ****************** Functions ********************* */
49/* ************************************************** */
50
51int LZ4IO_compressFilename  (const char* input_filename, const char* output_filename, int compressionlevel);
52int LZ4IO_decompressFilename(const char* input_filename, const char* output_filename);
53
54
55int LZ4IO_compressMultipleFilenames(const char** inFileNamesTable, int ifntSize, const char* suffix, int compressionlevel);
56int LZ4IO_decompressMultipleFilenames(const char** inFileNamesTable, int ifntSize, const char* suffix);
57
58/* ************************************************** */
59/* ****************** Parameters ******************** */
60/* ************************************************** */
61
62/* Default setting : overwrite = 1;
63   return : overwrite mode (0/1) */
64int LZ4IO_setOverwrite(int yes);
65
66/* Default setting : testMode = 0;
67   return : testMode (0/1) */
68int LZ4IO_setTestMode(int yes);
69
70/* blockSizeID : valid values : 4-5-6-7
71   return : -1 if error, blockSize if OK */
72int LZ4IO_setBlockSizeID(int blockSizeID);
73
74/* Default setting : independent blocks */
75typedef enum { LZ4IO_blockLinked=0, LZ4IO_blockIndependent} LZ4IO_blockMode_t;
76int LZ4IO_setBlockMode(LZ4IO_blockMode_t blockMode);
77
78/* Default setting : no block checksum */
79int LZ4IO_setBlockChecksumMode(int xxhash);
80
81/* Default setting : stream checksum enabled */
82int LZ4IO_setStreamChecksumMode(int xxhash);
83
84/* Default setting : 0 (no notification) */
85int LZ4IO_setNotificationLevel(int level);
86
87/* Default setting : 0 (disabled) */
88int LZ4IO_setSparseFile(int enable);
89
90/* Default setting : 0 (disabled) */
91int LZ4IO_setContentSize(int enable);
92
93void LZ4IO_setRemoveSrcFile(unsigned flag);
94