• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2   LZ4io.h - LZ4 File/Stream Interface
3   Copyright (C) Yann Collet 2011-2016
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 #ifndef LZ4IO_H_237902873
33 #define LZ4IO_H_237902873
34 
35 /*---   Dependency   ---*/
36 #include <stddef.h>   /* size_t */
37 
38 
39 /* ************************************************** */
40 /* Special input/output values                        */
41 /* ************************************************** */
42 #define NULL_OUTPUT "null"
43 static const char stdinmark[]  = "stdin";
44 static const char stdoutmark[] = "stdout";
45 #ifdef _WIN32
46 static const char nulmark[] = "nul";
47 #else
48 static const char nulmark[] = "/dev/null";
49 #endif
50 
51 
52 /* ************************************************** */
53 /* ****************** Functions ********************* */
54 /* ************************************************** */
55 
56 int LZ4IO_compressFilename  (const char* input_filename, const char* output_filename, int compressionlevel);
57 int LZ4IO_decompressFilename(const char* input_filename, const char* output_filename);
58 
59 int LZ4IO_compressMultipleFilenames(const char** inFileNamesTable, int ifntSize, const char* suffix, int compressionlevel);
60 int LZ4IO_decompressMultipleFilenames(const char** inFileNamesTable, int ifntSize, const char* suffix);
61 
62 
63 /* ************************************************** */
64 /* ****************** Parameters ******************** */
65 /* ************************************************** */
66 
67 int LZ4IO_setDictionaryFilename(const char* dictionaryFilename);
68 
69 /* Default setting : overwrite = 1;
70    return : overwrite mode (0/1) */
71 int LZ4IO_setOverwrite(int yes);
72 
73 /* Default setting : testMode = 0;
74    return : testMode (0/1) */
75 int LZ4IO_setTestMode(int yes);
76 
77 /* blockSizeID : valid values : 4-5-6-7
78    return : 0 if error, blockSize if OK */
79 size_t LZ4IO_setBlockSizeID(unsigned blockSizeID);
80 
81 /* Default setting : independent blocks */
82 typedef enum { LZ4IO_blockLinked=0, LZ4IO_blockIndependent} LZ4IO_blockMode_t;
83 int LZ4IO_setBlockMode(LZ4IO_blockMode_t blockMode);
84 
85 /* Default setting : no block checksum */
86 int LZ4IO_setBlockChecksumMode(int xxhash);
87 
88 /* Default setting : stream checksum enabled */
89 int LZ4IO_setStreamChecksumMode(int xxhash);
90 
91 /* Default setting : 0 (no notification) */
92 int LZ4IO_setNotificationLevel(int level);
93 
94 /* Default setting : 0 (disabled) */
95 int LZ4IO_setSparseFile(int enable);
96 
97 /* Default setting : 0 == no content size present in frame header */
98 int LZ4IO_setContentSize(int enable);
99 
100 /* Default setting : 0 == src file preserved */
101 void LZ4IO_setRemoveSrcFile(unsigned flag);
102 
103 /* Default setting : 0 == favor compression ratio
104  * Note : 1 only works for high compression levels (10+) */
105 void LZ4IO_favorDecSpeed(int favor);
106 
107 
108 #endif  /* LZ4IO_H_237902873 */
109