deps/libchdr/deps/lzma-24.05/include/LzmaEnc.h

   1 /*  LzmaEnc.h -- LZMA Encoder
   2 2023-04-13 : Igor Pavlov : Public domain */
   3
   4 #ifndef ZIP7_INC_LZMA_ENC_H
   5 #define ZIP7_INC_LZMA_ENC_H
   6
   7 #include "7zTypes.h"
   8
   9 EXTERN_C_BEGIN
  10
  11 #define LZMA_PROPS_SIZE 5
  12
  13 typedef struct
  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   unsigned numHashOutBits;  /* default = ? */
  27   UInt32 mc;       /* 1 <= mc <= (1 << 30), default = 32 */
  28   unsigned writeEndMark;  /* 0 - do not write EOPM, 1 - write EOPM, default = 0 */
  29   int numThreads;  /* 1 or 2, default = 2 */
  30
  31   // int _pad;
  32
  33   UInt64 reduceSize; /* estimated size of data that will be compressed. default = (UInt64)(Int64)-1.
  34                         Encoder uses this value to reduce dictionary size */
  35
  36   UInt64 affinity;
  37 } CLzmaEncProps;
  38
  39 void LzmaEncProps_Init(CLzmaEncProps *p);
  40 void LzmaEncProps_Normalize(CLzmaEncProps *p);
  41 UInt32 LzmaEncProps_GetDictSize(const CLzmaEncProps *props2);
  42
  43
  44 /* ---------- CLzmaEncHandle Interface ---------- */
  45
  46 /* LzmaEnc* functions can return the following exit codes:
  47 SRes:
  48   SZ_OK           - OK
  49   SZ_ERROR_MEM    - Memory allocation error
  50   SZ_ERROR_PARAM  - Incorrect paramater in props
  51   SZ_ERROR_WRITE  - ISeqOutStream write callback error
  52   SZ_ERROR_OUTPUT_EOF - output buffer overflow - version with (Byte *) output
  53   SZ_ERROR_PROGRESS - some break from progress callback
  54   SZ_ERROR_THREAD - error in multithreading functions (only for Mt version)
  55 */
  56
  57 typedef struct CLzmaEnc CLzmaEnc;
  58 typedef CLzmaEnc * CLzmaEncHandle;
  59 // Z7_DECLARE_HANDLE(CLzmaEncHandle)
  60
  61 CLzmaEncHandle LzmaEnc_Create(ISzAllocPtr alloc);
  62 void LzmaEnc_Destroy(CLzmaEncHandle p, ISzAllocPtr alloc, ISzAllocPtr allocBig);
  63
  64 SRes LzmaEnc_SetProps(CLzmaEncHandle p, const CLzmaEncProps *props);
  65 void LzmaEnc_SetDataSize(CLzmaEncHandle p, UInt64 expectedDataSiize);
  66 SRes LzmaEnc_WriteProperties(CLzmaEncHandle p, Byte *properties, SizeT *size);
  67 unsigned LzmaEnc_IsWriteEndMark(CLzmaEncHandle p);
  68
  69 SRes LzmaEnc_Encode(CLzmaEncHandle p, ISeqOutStreamPtr outStream, ISeqInStreamPtr inStream,
  70     ICompressProgressPtr progress, ISzAllocPtr alloc, ISzAllocPtr allocBig);
  71 SRes LzmaEnc_MemEncode(CLzmaEncHandle p, Byte *dest, SizeT *destLen, const Byte *src, SizeT srcLen,
  72     int writeEndMark, ICompressProgressPtr progress, ISzAllocPtr alloc, ISzAllocPtr allocBig);
  73
  74
  75 /* ---------- One Call Interface ---------- */
  76
  77 SRes LzmaEncode(Byte *dest, SizeT *destLen, const Byte *src, SizeT srcLen,
  78     const CLzmaEncProps *props, Byte *propsEncoded, SizeT *propsSize, int writeEndMark,
  79     ICompressProgressPtr progress, ISzAllocPtr alloc, ISzAllocPtr allocBig);
  80
  81 EXTERN_C_END
  82
  83 #endif