update libchdr
[pcsx_rearmed.git] / deps / libchdr / deps / lzma-22.01 / include / Lzma86.h
diff --git a/deps/libchdr/deps/lzma-22.01/include/Lzma86.h b/deps/libchdr/deps/lzma-22.01/include/Lzma86.h
new file mode 100644 (file)
index 0000000..83057e5
--- /dev/null
@@ -0,0 +1,111 @@
+/* Lzma86.h -- LZMA + x86 (BCJ) Filter\r
+2013-01-18 : Igor Pavlov : Public domain */\r
+\r
+#ifndef __LZMA86_H\r
+#define __LZMA86_H\r
+\r
+#include "7zTypes.h"\r
+\r
+EXTERN_C_BEGIN\r
+\r
+#define LZMA86_SIZE_OFFSET (1 + 5)\r
+#define LZMA86_HEADER_SIZE (LZMA86_SIZE_OFFSET + 8)\r
+\r
+/*\r
+It's an example for LZMA + x86 Filter use.\r
+You can use .lzma86 extension, if you write that stream to file.\r
+.lzma86 header adds one additional byte to standard .lzma header.\r
+.lzma86 header (14 bytes):\r
+  Offset Size  Description\r
+    0     1    = 0 - no filter, pure LZMA\r
+               = 1 - x86 filter + LZMA\r
+    1     1    lc, lp and pb in encoded form\r
+    2     4    dictSize (little endian)\r
+    6     8    uncompressed size (little endian)\r
+\r
+\r
+Lzma86_Encode\r
+-------------\r
+level - compression level: 0 <= level <= 9, the default value for "level" is 5.\r
+\r
+dictSize - The dictionary size in bytes. The maximum value is\r
+        128 MB = (1 << 27) bytes for 32-bit version\r
+          1 GB = (1 << 30) bytes for 64-bit version\r
+     The default value is 16 MB = (1 << 24) bytes, for level = 5.\r
+     It's recommended to use the dictionary that is larger than 4 KB and\r
+     that can be calculated as (1 << N) or (3 << N) sizes.\r
+     For better compression ratio dictSize must be >= inSize.\r
+\r
+filterMode:\r
+    SZ_FILTER_NO   - no Filter\r
+    SZ_FILTER_YES  - x86 Filter\r
+    SZ_FILTER_AUTO - it tries both alternatives to select best.\r
+              Encoder will use 2 or 3 passes:\r
+              2 passes when FILTER_NO provides better compression.\r
+              3 passes when FILTER_YES provides better compression.\r
+\r
+Lzma86Encode allocates Data with MyAlloc functions.\r
+RAM Requirements for compressing:\r
+  RamSize = dictionarySize * 11.5 + 6MB + FilterBlockSize\r
+      filterMode     FilterBlockSize\r
+     SZ_FILTER_NO         0\r
+     SZ_FILTER_YES      inSize\r
+     SZ_FILTER_AUTO     inSize\r
+\r
+\r
+Return code:\r
+  SZ_OK               - OK\r
+  SZ_ERROR_MEM        - Memory allocation error\r
+  SZ_ERROR_PARAM      - Incorrect paramater\r
+  SZ_ERROR_OUTPUT_EOF - output buffer overflow\r
+  SZ_ERROR_THREAD     - errors in multithreading functions (only for Mt version)\r
+*/\r
+\r
+enum ESzFilterMode\r
+{\r
+  SZ_FILTER_NO,\r
+  SZ_FILTER_YES,\r
+  SZ_FILTER_AUTO\r
+};\r
+\r
+SRes Lzma86_Encode(Byte *dest, size_t *destLen, const Byte *src, size_t srcLen,\r
+    int level, UInt32 dictSize, int filterMode);\r
+\r
+\r
+/*\r
+Lzma86_GetUnpackSize:\r
+  In:\r
+    src      - input data\r
+    srcLen   - input data size\r
+  Out:\r
+    unpackSize - size of uncompressed stream\r
+  Return code:\r
+    SZ_OK               - OK\r
+    SZ_ERROR_INPUT_EOF  - Error in headers\r
+*/\r
+\r
+SRes Lzma86_GetUnpackSize(const Byte *src, SizeT srcLen, UInt64 *unpackSize);\r
+\r
+/*\r
+Lzma86_Decode:\r
+  In:\r
+    dest     - output data\r
+    destLen  - output data size\r
+    src      - input data\r
+    srcLen   - input data size\r
+  Out:\r
+    destLen  - processed output size\r
+    srcLen   - processed input size\r
+  Return code:\r
+    SZ_OK           - OK\r
+    SZ_ERROR_DATA  - Data error\r
+    SZ_ERROR_MEM   - Memory allocation error\r
+    SZ_ERROR_UNSUPPORTED - unsupported file\r
+    SZ_ERROR_INPUT_EOF - it needs more bytes in input buffer\r
+*/\r
+\r
+SRes Lzma86_Decode(Byte *dest, SizeT *destLen, const Byte *src, SizeT *srcLen);\r
+\r
+EXTERN_C_END\r
+\r
+#endif\r