• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*  LzmaEnc.h -- LZMA Encoder
2 2017-07-27 : Igor Pavlov : Public domain */
3 
4 #ifndef __LZMA_ENC_H
5 #define __LZMA_ENC_H
6 
7 #include "7zTypes.h"
8 
9 EXTERN_C_BEGIN
10 
11 #define LZMA_PROPS_SIZE 5
12 
13 typedef struct _CLzmaEncProps
14 {
15   int level;       /* 0 <= level <= 9 */
16   UInt32 dictSize; /* (1 << 12) <= dictSize <= (1 << 27) for 32-bit version
17                       (1 << 12) <= dictSize <= (3 << 29) for 64-bit version
18                       default = (1 << 24) */
19   int lc;          /* 0 <= lc <= 8, default = 3 */
20   int lp;          /* 0 <= lp <= 4, default = 0 */
21   int pb;          /* 0 <= pb <= 4, default = 2 */
22   int algo;        /* 0 - fast, 1 - normal, default = 1 */
23   int fb;          /* 5 <= fb <= 273, default = 32 */
24   int btMode;      /* 0 - hashChain Mode, 1 - binTree mode - normal, default = 1 */
25   int numHashBytes; /* 2, 3 or 4, default = 4 */
26   UInt32 mc;       /* 1 <= mc <= (1 << 30), default = 32 */
27   unsigned writeEndMark;  /* 0 - do not write EOPM, 1 - write EOPM, default = 0 */
28   int numThreads;  /* 1 or 2, default = 2 */
29 
30   UInt64 reduceSize; /* estimated size of data that will be compressed. default = (UInt64)(Int64)-1.
31                         Encoder uses this value to reduce dictionary size */
32 } CLzmaEncProps;
33 
34 void LzmaEncProps_Init(CLzmaEncProps *p);
35 void LzmaEncProps_Normalize(CLzmaEncProps *p);
36 UInt32 LzmaEncProps_GetDictSize(const CLzmaEncProps *props2);
37 
38 
39 /* ---------- CLzmaEncHandle Interface ---------- */
40 
41 /* LzmaEnc* functions can return the following exit codes:
42 SRes:
43   SZ_OK           - OK
44   SZ_ERROR_MEM    - Memory allocation error
45   SZ_ERROR_PARAM  - Incorrect paramater in props
46   SZ_ERROR_WRITE  - ISeqOutStream write callback error
47   SZ_ERROR_OUTPUT_EOF - output buffer overflow - version with (Byte *) output
48   SZ_ERROR_PROGRESS - some break from progress callback
49   SZ_ERROR_THREAD - error in multithreading functions (only for Mt version)
50 */
51 
52 typedef void * CLzmaEncHandle;
53 
54 CLzmaEncHandle LzmaEnc_Create(ISzAllocPtr alloc);
55 void LzmaEnc_Destroy(CLzmaEncHandle p, ISzAllocPtr alloc, ISzAllocPtr allocBig);
56 
57 SRes LzmaEnc_SetProps(CLzmaEncHandle p, const CLzmaEncProps *props);
58 void LzmaEnc_SetDataSize(CLzmaEncHandle p, UInt64 expectedDataSiize);
59 SRes LzmaEnc_WriteProperties(CLzmaEncHandle p, Byte *properties, SizeT *size);
60 unsigned LzmaEnc_IsWriteEndMark(CLzmaEncHandle p);
61 
62 SRes LzmaEnc_Encode(CLzmaEncHandle p, ISeqOutStream *outStream, ISeqInStream *inStream,
63     ICompressProgress *progress, ISzAllocPtr alloc, ISzAllocPtr allocBig);
64 SRes LzmaEnc_MemEncode(CLzmaEncHandle p, Byte *dest, SizeT *destLen, const Byte *src, SizeT srcLen,
65     int writeEndMark, ICompressProgress *progress, ISzAllocPtr alloc, ISzAllocPtr allocBig);
66 
67 
68 /* ---------- One Call Interface ---------- */
69 
70 SRes LzmaEncode(Byte *dest, SizeT *destLen, const Byte *src, SizeT srcLen,
71     const CLzmaEncProps *props, Byte *propsEncoded, SizeT *propsSize, int writeEndMark,
72     ICompressProgress *progress, ISzAllocPtr alloc, ISzAllocPtr allocBig);
73 
74 EXTERN_C_END
75 
76 #endif
77