spu: don't leave garbage in capture buffers

[pcsx_rearmed.git] / deps / libchdr / deps / lzma-22.01 / include / LzmaLib.h

/* LzmaLib.h -- LZMA library interface\r
2021-04-03 : Igor Pavlov : Public domain */\r
\r
#ifndef __LZMA_LIB_H\r
#define __LZMA_LIB_H\r
\r
#include "7zTypes.h"\r
\r
EXTERN_C_BEGIN\r
\r
#define MY_STDAPI int MY_STD_CALL\r
\r
#define LZMA_PROPS_SIZE 5\r
\r
/*\r
RAM requirements for LZMA:\r
  for compression:   (dictSize * 11.5 + 6 MB) + state_size\r
  for decompression: dictSize + state_size\r
    state_size = (4 + (1.5 << (lc + lp))) KB\r
    by default (lc=3, lp=0), state_size = 16 KB.\r
\r
LZMA properties (5 bytes) format\r
    Offset Size  Description\r
      0     1    lc, lp and pb in encoded form.\r
      1     4    dictSize (little endian).\r
*/\r
\r
/*\r
LzmaCompress\r
------------\r
\r
outPropsSize -\r
     In:  the pointer to the size of outProps buffer; *outPropsSize = LZMA_PROPS_SIZE = 5.\r
     Out: the pointer to the size of written properties in outProps buffer; *outPropsSize = LZMA_PROPS_SIZE = 5.\r
\r
  LZMA Encoder will use defult values for any parameter, if it is\r
  -1  for any from: level, loc, lp, pb, fb, numThreads\r
   0  for dictSize\r
  \r
level - compression level: 0 <= level <= 9;\r
\r
  level dictSize algo  fb\r
    0:    64 KB   0    32\r
    1:   256 KB   0    32\r
    2:     1 MB   0    32\r
    3:     4 MB   0    32\r
    4:    16 MB   0    32\r
    5:    16 MB   1    32\r
    6:    32 MB   1    32\r
    7:    32 MB   1    64\r
    8:    64 MB   1    64\r
    9:    64 MB   1    64\r
 \r
  The default value for "level" is 5.\r
\r
  algo = 0 means fast method\r
  algo = 1 means normal method\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.\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
\r
lc - The number of literal context bits (high bits of previous literal).\r
     It can be in the range from 0 to 8. The default value is 3.\r
     Sometimes lc=4 gives the gain for big files.\r
\r
lp - The number of literal pos bits (low bits of current position for literals).\r
     It can be in the range from 0 to 4. The default value is 0.\r
     The lp switch is intended for periodical data when the period is equal to 2^lp.\r
     For example, for 32-bit (4 bytes) periodical data you can use lp=2. Often it's\r
     better to set lc=0, if you change lp switch.\r
\r
pb - The number of pos bits (low bits of current position).\r
     It can be in the range from 0 to 4. The default value is 2.\r
     The pb switch is intended for periodical data when the period is equal 2^pb.\r
\r
fb - Word size (the number of fast bytes).\r
     It can be in the range from 5 to 273. The default value is 32.\r
     Usually, a big number gives a little bit better compression ratio and\r
     slower compression process.\r
\r
numThreads - The number of thereads. 1 or 2. The default value is 2.\r
     Fast mode (algo = 0) can use only 1 thread.\r
\r
In:\r
  dest     - output data buffer\r
  destLen  - output data buffer size\r
  src      - input data\r
  srcLen   - input data size\r
Out:\r
  destLen  - processed output size\r
Returns:\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
MY_STDAPI LzmaCompress(unsigned char *dest, size_t *destLen, const unsigned char *src, size_t srcLen,\r
  unsigned char *outProps, size_t *outPropsSize, /* *outPropsSize must be = 5 */\r
  int level,      /* 0 <= level <= 9, default = 5 */\r
  unsigned dictSize,  /* default = (1 << 24) */\r
  int lc,        /* 0 <= lc <= 8, default = 3  */\r
  int lp,        /* 0 <= lp <= 4, default = 0  */\r
  int pb,        /* 0 <= pb <= 4, default = 2  */\r
  int fb,        /* 5 <= fb <= 273, default = 32 */\r
  int numThreads /* 1 or 2, default = 2 */\r
  );\r
\r
/*\r
LzmaUncompress\r
--------------\r
In:\r
  dest     - output data buffer\r
  destLen  - output data buffer size\r
  src      - input data\r
  srcLen   - input data size\r
Out:\r
  destLen  - processed output size\r
  srcLen   - processed input size\r
Returns:\r
  SZ_OK                - OK\r
  SZ_ERROR_DATA        - Data error\r
  SZ_ERROR_MEM         - Memory allocation arror\r
  SZ_ERROR_UNSUPPORTED - Unsupported properties\r
  SZ_ERROR_INPUT_EOF   - it needs more bytes in input buffer (src)\r
*/\r
\r
MY_STDAPI LzmaUncompress(unsigned char *dest, size_t *destLen, const unsigned char *src, SizeT *srcLen,\r
  const unsigned char *props, size_t propsSize);\r
\r
EXTERN_C_END\r
\r
#endif\r