zlib.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:30k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /* zlib.h -- interface of the 'zlib' general purpose compression library
  2.   version 1.1.3, July 9th, 1998
  3.   Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler
  4.   This software is provided 'as-is', without any express or implied
  5.   warranty.  In no event will the authors be held liable for any damages
  6.   arising from the use of this software.
  7.   Permission is granted to anyone to use this software for any purpose,
  8.   including commercial applications, and to alter it and redistribute it
  9.   freely, subject to the following restrictions:
  10.   1. The origin of this software must not be misrepresented; you must not
  11.      claim that you wrote the original software. If you use this software
  12.      in a product, an acknowledgment in the product documentation would be
  13.      appreciated but is not required.
  14.   2. Altered source versions must be plainly marked as such, and must not be
  15.      misrepresented as being the original software.
  16.   3. This notice may not be removed or altered from any source distribution.
  17.   Jean-loup Gailly        Mark Adler
  18.   jloup@gzip.org          madler@alumni.caltech.edu
  19.   The data format used by the zlib library is described by RFCs (Request for
  20.   Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
  21.   (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
  22. */
  23. #ifndef _ZLIB_H
  24. #define _ZLIB_H
  25. #include "zconf.h"
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. #define ZLIB_VERSION "1.1.3"
  30. /* 
  31.      The 'zlib' compression library provides in-memory compression and
  32.   decompression functions, including integrity checks of the uncompressed
  33.   data.  This version of the library supports only one compression method
  34.   (deflation) but other algorithms will be added later and will have the same
  35.   stream interface.
  36.      Compression can be done in a single step if the buffers are large
  37.   enough (for example if an input file is mmap'ed), or can be done by
  38.   repeated calls of the compression function.  In the latter case, the
  39.   application must provide more input and/or consume the output
  40.   (providing more output space) before each call.
  41.      The library also supports reading and writing files in gzip (.gz) format
  42.   with an interface similar to that of stdio.
  43.      The library does not install any signal handler. The decoder checks
  44.   the consistency of the compressed data, so the library should never
  45.   crash even in case of corrupted input.
  46. */
  47. typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
  48. typedef void   (*free_func)  OF((voidpf opaque, voidpf address));
  49. struct internal_state;
  50. typedef struct z_stream_s {
  51.     Bytef    *next_in;  /* next input byte */
  52.     uInt     avail_in;  /* number of bytes available at next_in */
  53.     uLong    total_in;  /* total nb of input bytes read so far */
  54.     Bytef    *next_out; /* next output byte should be put there */
  55.     uInt     avail_out; /* remaining free space at next_out */
  56.     uLong    total_out; /* total nb of bytes output so far */
  57.     char     *msg;      /* last error message, NULL if no error */
  58.     struct internal_state FAR *state; /* not visible by applications */
  59.     void     *workspace; /* memory allocated for this stream */
  60.     int     data_type;  /* best guess about the data type: ascii or binary */
  61.     uLong   adler;      /* adler32 value of the uncompressed data */
  62.     uLong   reserved;   /* reserved for future use */
  63. } z_stream;
  64. typedef z_stream FAR *z_streamp;
  65. /*
  66.    The application must update next_in and avail_in when avail_in has
  67.    dropped to zero. It must update next_out and avail_out when avail_out
  68.    has dropped to zero. The application must initialize zalloc, zfree and
  69.    opaque before calling the init function. All other fields are set by the
  70.    compression library and must not be updated by the application.
  71.    The opaque value provided by the application will be passed as the first
  72.    parameter for calls of zalloc and zfree. This can be useful for custom
  73.    memory management. The compression library attaches no meaning to the
  74.    opaque value.
  75.    zalloc must return Z_NULL if there is not enough memory for the object.
  76.    If zlib is used in a multi-threaded application, zalloc and zfree must be
  77.    thread safe.
  78.    On 16-bit systems, the functions zalloc and zfree must be able to allocate
  79.    exactly 65536 bytes, but will not be required to allocate more than this
  80.    if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
  81.    pointers returned by zalloc for objects of exactly 65536 bytes *must*
  82.    have their offset normalized to zero. The default allocation function
  83.    provided by this library ensures this (see zutil.c). To reduce memory
  84.    requirements and avoid any allocation of 64K objects, at the expense of
  85.    compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
  86.    The fields total_in and total_out can be used for statistics or
  87.    progress reports. After compression, total_in holds the total size of
  88.    the uncompressed data and may be saved for use in the decompressor
  89.    (particularly if the decompressor wants to decompress everything in
  90.    a single step).
  91. */
  92.                         /* constants */
  93. #define Z_NO_FLUSH      0
  94. #define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */
  95. #define Z_PACKET_FLUSH  2
  96. #define Z_SYNC_FLUSH    3
  97. #define Z_FULL_FLUSH    4
  98. #define Z_FINISH        5
  99. /* Allowed flush values; see deflate() below for details */
  100. #define Z_OK            0
  101. #define Z_STREAM_END    1
  102. #define Z_NEED_DICT     2
  103. #define Z_ERRNO        (-1)
  104. #define Z_STREAM_ERROR (-2)
  105. #define Z_DATA_ERROR   (-3)
  106. #define Z_MEM_ERROR    (-4)
  107. #define Z_BUF_ERROR    (-5)
  108. #define Z_VERSION_ERROR (-6)
  109. /* Return codes for the compression/decompression functions. Negative
  110.  * values are errors, positive values are used for special but normal events.
  111.  */
  112. #define Z_NO_COMPRESSION         0
  113. #define Z_BEST_SPEED             1
  114. #define Z_BEST_COMPRESSION       9
  115. #define Z_DEFAULT_COMPRESSION  (-1)
  116. /* compression levels */
  117. #define Z_FILTERED            1
  118. #define Z_HUFFMAN_ONLY        2
  119. #define Z_DEFAULT_STRATEGY    0
  120. /* compression strategy; see deflateInit2() below for details */
  121. #define Z_BINARY   0
  122. #define Z_ASCII    1
  123. #define Z_UNKNOWN  2
  124. /* Possible values of the data_type field */
  125. #define Z_DEFLATED   8
  126. /* The deflate compression method (the only one supported in this version) */
  127. #define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
  128.                         /* basic functions */
  129. ZEXTERN const char * ZEXPORT zlib_zlibVersion OF((void));
  130. /* The application can compare zlibVersion and ZLIB_VERSION for consistency.
  131.    If the first character differs, the library code actually used is
  132.    not compatible with the zlib.h header file used by the application.
  133.    This check is automatically made by deflateInit and inflateInit.
  134.  */
  135. ZEXTERN int ZEXPORT zlib_deflate_workspacesize OF((void));
  136. /*
  137.    Returns the number of bytes that needs to be allocated for a per-
  138.    stream workspace.  A pointer to this number of bytes should be
  139.    returned in stream->workspace before calling zlib_deflateInit().
  140. */
  141. /* 
  142. ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
  143.      Initializes the internal stream state for compression. The fields
  144.    zalloc, zfree and opaque must be initialized before by the caller.
  145.    If zalloc and zfree are set to Z_NULL, deflateInit updates them to
  146.    use default allocation functions.
  147.      The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
  148.    1 gives best speed, 9 gives best compression, 0 gives no compression at
  149.    all (the input data is simply copied a block at a time).
  150.    Z_DEFAULT_COMPRESSION requests a default compromise between speed and
  151.    compression (currently equivalent to level 6).
  152.      deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
  153.    enough memory, Z_STREAM_ERROR if level is not a valid compression level,
  154.    Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
  155.    with the version assumed by the caller (ZLIB_VERSION).
  156.    msg is set to null if there is no error message.  deflateInit does not
  157.    perform any compression: this will be done by deflate().
  158. */
  159. ZEXTERN int ZEXPORT zlib_deflate OF((z_streamp strm, int flush));
  160. /*
  161.     deflate compresses as much data as possible, and stops when the input
  162.   buffer becomes empty or the output buffer becomes full. It may introduce some
  163.   output latency (reading input without producing any output) except when
  164.   forced to flush.
  165.     The detailed semantics are as follows. deflate performs one or both of the
  166.   following actions:
  167.   - Compress more input starting at next_in and update next_in and avail_in
  168.     accordingly. If not all input can be processed (because there is not
  169.     enough room in the output buffer), next_in and avail_in are updated and
  170.     processing will resume at this point for the next call of deflate().
  171.   - Provide more output starting at next_out and update next_out and avail_out
  172.     accordingly. This action is forced if the parameter flush is non zero.
  173.     Forcing flush frequently degrades the compression ratio, so this parameter
  174.     should be set only when necessary (in interactive applications).
  175.     Some output may be provided even if flush is not set.
  176.   Before the call of deflate(), the application should ensure that at least
  177.   one of the actions is possible, by providing more input and/or consuming
  178.   more output, and updating avail_in or avail_out accordingly; avail_out
  179.   should never be zero before the call. The application can consume the
  180.   compressed output when it wants, for example when the output buffer is full
  181.   (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK
  182.   and with zero avail_out, it must be called again after making room in the
  183.   output buffer because there might be more output pending.
  184.     If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
  185.   flushed to the output buffer and the output is aligned on a byte boundary, so
  186.   that the decompressor can get all input data available so far. (In particular
  187.   avail_in is zero after the call if enough output space has been provided
  188.   before the call.)  Flushing may degrade compression for some compression
  189.   algorithms and so it should be used only when necessary.
  190.     If flush is set to Z_FULL_FLUSH, all output is flushed as with
  191.   Z_SYNC_FLUSH, and the compression state is reset so that decompression can
  192.   restart from this point if previous compressed data has been damaged or if
  193.   random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
  194.   the compression.
  195.     If deflate returns with avail_out == 0, this function must be called again
  196.   with the same value of the flush parameter and more output space (updated
  197.   avail_out), until the flush is complete (deflate returns with non-zero
  198.   avail_out).
  199.     If the parameter flush is set to Z_FINISH, pending input is processed,
  200.   pending output is flushed and deflate returns with Z_STREAM_END if there
  201.   was enough output space; if deflate returns with Z_OK, this function must be
  202.   called again with Z_FINISH and more output space (updated avail_out) but no
  203.   more input data, until it returns with Z_STREAM_END or an error. After
  204.   deflate has returned Z_STREAM_END, the only possible operations on the
  205.   stream are deflateReset or deflateEnd.
  206.   
  207.     Z_FINISH can be used immediately after deflateInit if all the compression
  208.   is to be done in a single step. In this case, avail_out must be at least
  209.   0.1% larger than avail_in plus 12 bytes.  If deflate does not return
  210.   Z_STREAM_END, then it must be called again as described above.
  211.     deflate() sets strm->adler to the adler32 checksum of all input read
  212.   so far (that is, total_in bytes).
  213.     deflate() may update data_type if it can make a good guess about
  214.   the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered
  215.   binary. This field is only for information purposes and does not affect
  216.   the compression algorithm in any manner.
  217.     deflate() returns Z_OK if some progress has been made (more input
  218.   processed or more output produced), Z_STREAM_END if all input has been
  219.   consumed and all output has been produced (only when flush is set to
  220.   Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
  221.   if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible
  222.   (for example avail_in or avail_out was zero).
  223. */
  224. ZEXTERN int ZEXPORT zlib_deflateEnd OF((z_streamp strm));
  225. /*
  226.      All dynamically allocated data structures for this stream are freed.
  227.    This function discards any unprocessed input and does not flush any
  228.    pending output.
  229.      deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
  230.    stream state was inconsistent, Z_DATA_ERROR if the stream was freed
  231.    prematurely (some input or output was discarded). In the error case,
  232.    msg may be set but then points to a static string (which must not be
  233.    deallocated).
  234. */
  235. ZEXTERN int ZEXPORT zlib_inflate_workspacesize OF((void));
  236. /*
  237.    Returns the number of bytes that needs to be allocated for a per-
  238.    stream workspace.  A pointer to this number of bytes should be
  239.    returned in stream->workspace before calling zlib_inflateInit().
  240. */
  241. /* 
  242. ZEXTERN int ZEXPORT zlib_inflateInit OF((z_streamp strm));
  243.      Initializes the internal stream state for decompression. The fields
  244.    next_in, avail_in, and workspace must be initialized before by
  245.    the caller. If next_in is not Z_NULL and avail_in is large enough (the exact
  246.    value depends on the compression method), inflateInit determines the
  247.    compression method from the zlib header and allocates all data structures
  248.    accordingly; otherwise the allocation will be deferred to the first call of
  249.    inflate.  If zalloc and zfree are set to Z_NULL, inflateInit updates them to
  250.    use default allocation functions.
  251.      inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
  252.    memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
  253.    version assumed by the caller.  msg is set to null if there is no error
  254.    message. inflateInit does not perform any decompression apart from reading
  255.    the zlib header if present: this will be done by inflate().  (So next_in and
  256.    avail_in may be modified, but next_out and avail_out are unchanged.)
  257. */
  258. ZEXTERN int ZEXPORT zlib_inflate OF((z_streamp strm, int flush));
  259. /*
  260.     inflate decompresses as much data as possible, and stops when the input
  261.   buffer becomes empty or the output buffer becomes full. It may some
  262.   introduce some output latency (reading input without producing any output)
  263.   except when forced to flush.
  264.   The detailed semantics are as follows. inflate performs one or both of the
  265.   following actions:
  266.   - Decompress more input starting at next_in and update next_in and avail_in
  267.     accordingly. If not all input can be processed (because there is not
  268.     enough room in the output buffer), next_in is updated and processing
  269.     will resume at this point for the next call of inflate().
  270.   - Provide more output starting at next_out and update next_out and avail_out
  271.     accordingly.  inflate() provides as much output as possible, until there
  272.     is no more input data or no more space in the output buffer (see below
  273.     about the flush parameter).
  274.   Before the call of inflate(), the application should ensure that at least
  275.   one of the actions is possible, by providing more input and/or consuming
  276.   more output, and updating the next_* and avail_* values accordingly.
  277.   The application can consume the uncompressed output when it wants, for
  278.   example when the output buffer is full (avail_out == 0), or after each
  279.   call of inflate(). If inflate returns Z_OK and with zero avail_out, it
  280.   must be called again after making room in the output buffer because there
  281.   might be more output pending.
  282.     If the parameter flush is set to Z_SYNC_FLUSH, inflate flushes as much
  283.   output as possible to the output buffer. The flushing behavior of inflate is
  284.   not specified for values of the flush parameter other than Z_SYNC_FLUSH
  285.   and Z_FINISH, but the current implementation actually flushes as much output
  286.   as possible anyway.
  287.     inflate() should normally be called until it returns Z_STREAM_END or an
  288.   error. However if all decompression is to be performed in a single step
  289.   (a single call of inflate), the parameter flush should be set to
  290.   Z_FINISH. In this case all pending input is processed and all pending
  291.   output is flushed; avail_out must be large enough to hold all the
  292.   uncompressed data. (The size of the uncompressed data may have been saved
  293.   by the compressor for this purpose.) The next operation on this stream must
  294.   be inflateEnd to deallocate the decompression state. The use of Z_FINISH
  295.   is never required, but can be used to inform inflate that a faster routine
  296.   may be used for the single inflate() call.
  297.      If a preset dictionary is needed at this point (see inflateSetDictionary
  298.   below), inflate sets strm-adler to the adler32 checksum of the
  299.   dictionary chosen by the compressor and returns Z_NEED_DICT; otherwise 
  300.   it sets strm->adler to the adler32 checksum of all output produced
  301.   so far (that is, total_out bytes) and returns Z_OK, Z_STREAM_END or
  302.   an error code as described below. At the end of the stream, inflate()
  303.   checks that its computed adler32 checksum is equal to that saved by the
  304.   compressor and returns Z_STREAM_END only if the checksum is correct.
  305.     inflate() returns Z_OK if some progress has been made (more input processed
  306.   or more output produced), Z_STREAM_END if the end of the compressed data has
  307.   been reached and all uncompressed output has been produced, Z_NEED_DICT if a
  308.   preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
  309.   corrupted (input stream not conforming to the zlib format or incorrect
  310.   adler32 checksum), Z_STREAM_ERROR if the stream structure was inconsistent
  311.   (for example if next_in or next_out was NULL), Z_MEM_ERROR if there was not
  312.   enough memory, Z_BUF_ERROR if no progress is possible or if there was not
  313.   enough room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR
  314.   case, the application may then call inflateSync to look for a good
  315.   compression block.
  316. */
  317. ZEXTERN int ZEXPORT zlib_inflateEnd OF((z_streamp strm));
  318. /*
  319.      All dynamically allocated data structures for this stream are freed.
  320.    This function discards any unprocessed input and does not flush any
  321.    pending output.
  322.      inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
  323.    was inconsistent. In the error case, msg may be set but then points to a
  324.    static string (which must not be deallocated).
  325. */
  326.                         /* Advanced functions */
  327. /*
  328.     The following functions are needed only in some special applications.
  329. */
  330. /*   
  331. ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
  332.                                      int  level,
  333.                                      int  method,
  334.                                      int  windowBits,
  335.                                      int  memLevel,
  336.                                      int  strategy));
  337.      This is another version of deflateInit with more compression options. The
  338.    fields next_in, zalloc, zfree and opaque must be initialized before by
  339.    the caller.
  340.      The method parameter is the compression method. It must be Z_DEFLATED in
  341.    this version of the library.
  342.      The windowBits parameter is the base two logarithm of the window size
  343.    (the size of the history buffer).  It should be in the range 8..15 for this
  344.    version of the library. Larger values of this parameter result in better
  345.    compression at the expense of memory usage. The default value is 15 if
  346.    deflateInit is used instead.
  347.      The memLevel parameter specifies how much memory should be allocated
  348.    for the internal compression state. memLevel=1 uses minimum memory but
  349.    is slow and reduces compression ratio; memLevel=9 uses maximum memory
  350.    for optimal speed. The default value is 8. See zconf.h for total memory
  351.    usage as a function of windowBits and memLevel.
  352.      The strategy parameter is used to tune the compression algorithm. Use the
  353.    value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
  354.    filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no
  355.    string match).  Filtered data consists mostly of small values with a
  356.    somewhat random distribution. In this case, the compression algorithm is
  357.    tuned to compress them better. The effect of Z_FILTERED is to force more
  358.    Huffman coding and less string matching; it is somewhat intermediate
  359.    between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects
  360.    the compression ratio but not the correctness of the compressed output even
  361.    if it is not set appropriately.
  362.       deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
  363.    memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid
  364.    method). msg is set to null if there is no error message.  deflateInit2 does
  365.    not perform any compression: this will be done by deflate().
  366. */
  367.                             
  368. ZEXTERN int ZEXPORT zlib_deflateSetDictionary OF((z_streamp strm,
  369.      const Bytef *dictionary,
  370.      uInt  dictLength));
  371. /*
  372.      Initializes the compression dictionary from the given byte sequence
  373.    without producing any compressed output. This function must be called
  374.    immediately after deflateInit, deflateInit2 or deflateReset, before any
  375.    call of deflate. The compressor and decompressor must use exactly the same
  376.    dictionary (see inflateSetDictionary).
  377.      The dictionary should consist of strings (byte sequences) that are likely
  378.    to be encountered later in the data to be compressed, with the most commonly
  379.    used strings preferably put towards the end of the dictionary. Using a
  380.    dictionary is most useful when the data to be compressed is short and can be
  381.    predicted with good accuracy; the data can then be compressed better than
  382.    with the default empty dictionary.
  383.      Depending on the size of the compression data structures selected by
  384.    deflateInit or deflateInit2, a part of the dictionary may in effect be
  385.    discarded, for example if the dictionary is larger than the window size in
  386.    deflate or deflate2. Thus the strings most likely to be useful should be
  387.    put at the end of the dictionary, not at the front.
  388.      Upon return of this function, strm->adler is set to the Adler32 value
  389.    of the dictionary; the decompressor may later use this value to determine
  390.    which dictionary has been used by the compressor. (The Adler32 value
  391.    applies to the whole dictionary even if only a subset of the dictionary is
  392.    actually used by the compressor.)
  393.      deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
  394.    parameter is invalid (such as NULL dictionary) or the stream state is
  395.    inconsistent (for example if deflate has already been called for this stream
  396.    or if the compression method is bsort). deflateSetDictionary does not
  397.    perform any compression: this will be done by deflate().
  398. */
  399. ZEXTERN int ZEXPORT zlib_deflateCopy OF((z_streamp dest,
  400.     z_streamp source));
  401. /*
  402.      Sets the destination stream as a complete copy of the source stream.
  403.      This function can be useful when several compression strategies will be
  404.    tried, for example when there are several ways of pre-processing the input
  405.    data with a filter. The streams that will be discarded should then be freed
  406.    by calling deflateEnd.  Note that deflateCopy duplicates the internal
  407.    compression state which can be quite large, so this strategy is slow and
  408.    can consume lots of memory.
  409.      deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
  410.    enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
  411.    (such as zalloc being NULL). msg is left unchanged in both source and
  412.    destination.
  413. */
  414. ZEXTERN int ZEXPORT zlib_deflateReset OF((z_streamp strm));
  415. /*
  416.      This function is equivalent to deflateEnd followed by deflateInit,
  417.    but does not free and reallocate all the internal compression state.
  418.    The stream will keep the same compression level and any other attributes
  419.    that may have been set by deflateInit2.
  420.       deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
  421.    stream state was inconsistent (such as zalloc or state being NULL).
  422. */
  423. ZEXTERN int ZEXPORT zlib_deflateParams OF((z_streamp strm,
  424.       int level,
  425.       int strategy));
  426. /*
  427.      Dynamically update the compression level and compression strategy.  The
  428.    interpretation of level and strategy is as in deflateInit2.  This can be
  429.    used to switch between compression and straight copy of the input data, or
  430.    to switch to a different kind of input data requiring a different
  431.    strategy. If the compression level is changed, the input available so far
  432.    is compressed with the old level (and may be flushed); the new level will
  433.    take effect only at the next call of deflate().
  434.      Before the call of deflateParams, the stream state must be set as for
  435.    a call of deflate(), since the currently available input may have to
  436.    be compressed and flushed. In particular, strm->avail_out must be non-zero.
  437.      deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
  438.    stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR
  439.    if strm->avail_out was zero.
  440. */
  441. /*   
  442. ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,
  443.                                      int  windowBits));
  444.      This is another version of inflateInit with an extra parameter. The
  445.    fields next_in, avail_in, zalloc, zfree and opaque must be initialized
  446.    before by the caller.
  447.      The windowBits parameter is the base two logarithm of the maximum window
  448.    size (the size of the history buffer).  It should be in the range 8..15 for
  449.    this version of the library. The default value is 15 if inflateInit is used
  450.    instead. If a compressed stream with a larger window size is given as
  451.    input, inflate() will return with the error code Z_DATA_ERROR instead of
  452.    trying to allocate a larger window.
  453.       inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
  454.    memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative
  455.    memLevel). msg is set to null if there is no error message.  inflateInit2
  456.    does not perform any decompression apart from reading the zlib header if
  457.    present: this will be done by inflate(). (So next_in and avail_in may be
  458.    modified, but next_out and avail_out are unchanged.)
  459. */
  460. ZEXTERN int ZEXPORT zlib_inflateSetDictionary OF((z_streamp strm,
  461.      const Bytef *dictionary,
  462.      uInt  dictLength));
  463. /*
  464.      Initializes the decompression dictionary from the given uncompressed byte
  465.    sequence. This function must be called immediately after a call of inflate
  466.    if this call returned Z_NEED_DICT. The dictionary chosen by the compressor
  467.    can be determined from the Adler32 value returned by this call of
  468.    inflate. The compressor and decompressor must use exactly the same
  469.    dictionary (see deflateSetDictionary).
  470.      inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
  471.    parameter is invalid (such as NULL dictionary) or the stream state is
  472.    inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
  473.    expected one (incorrect Adler32 value). inflateSetDictionary does not
  474.    perform any decompression: this will be done by subsequent calls of
  475.    inflate().
  476. */
  477. ZEXTERN int ZEXPORT zlib_inflateSync OF((z_streamp strm));
  478. /* 
  479.     Skips invalid compressed data until a full flush point (see above the
  480.   description of deflate with Z_FULL_FLUSH) can be found, or until all
  481.   available input is skipped. No output is provided.
  482.     inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR
  483.   if no more input was provided, Z_DATA_ERROR if no flush point has been found,
  484.   or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
  485.   case, the application may save the current current value of total_in which
  486.   indicates where valid compressed data was found. In the error case, the
  487.   application may repeatedly call inflateSync, providing more input each time,
  488.   until success or end of the input data.
  489. */
  490. ZEXTERN int ZEXPORT zlib_inflateReset OF((z_streamp strm));
  491. /*
  492.      This function is equivalent to inflateEnd followed by inflateInit,
  493.    but does not free and reallocate all the internal decompression state.
  494.    The stream will keep attributes that may have been set by inflateInit2.
  495.       inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
  496.    stream state was inconsistent (such as zalloc or state being NULL).
  497. */
  498. extern int ZEXPORT zlib_inflateIncomp OF((z_stream *strm));
  499. /*
  500.      This function adds the data at next_in (avail_in bytes) to the output
  501.    history without performing any output.  There must be no pending output,
  502.    and the decompressor must be expecting to see the start of a block.
  503.    Calling this function is equivalent to decompressing a stored block
  504.    containing the data at next_in (except that the data is not output).
  505. */
  506.                         /* various hacks, don't look :) */
  507. /* deflateInit and inflateInit are macros to allow checking the zlib version
  508.  * and the compiler's view of z_stream:
  509.  */
  510. ZEXTERN int ZEXPORT zlib_deflateInit_ OF((z_streamp strm, int level,
  511.                                      const char *version, int stream_size));
  512. ZEXTERN int ZEXPORT zlib_inflateInit_ OF((z_streamp strm,
  513.                                      const char *version, int stream_size));
  514. ZEXTERN int ZEXPORT zlib_deflateInit2_ OF((z_streamp strm, int  level, int  method,
  515.                                       int windowBits, int memLevel,
  516.                                       int strategy, const char *version,
  517.                                       int stream_size));
  518. ZEXTERN int ZEXPORT zlib_inflateInit2_ OF((z_streamp strm, int  windowBits,
  519.                                       const char *version, int stream_size));
  520. #define zlib_deflateInit(strm, level) 
  521.         zlib_deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
  522. #define zlib_inflateInit(strm) 
  523.         zlib_inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream))
  524. #define zlib_deflateInit2(strm, level, method, windowBits, memLevel, strategy) 
  525.         zlib_deflateInit2_((strm),(level),(method),(windowBits),(memLevel),
  526.                       (strategy), ZLIB_VERSION, sizeof(z_stream))
  527. #define zlib_inflateInit2(strm, windowBits) 
  528.         zlib_inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
  529. #if !defined(_Z_UTIL_H) && !defined(NO_DUMMY_DECL)
  530.     struct internal_state {int dummy;}; /* hack for buggy compilers */
  531. #endif
  532. ZEXTERN const char   * ZEXPORT zlib_zError           OF((int err));
  533. ZEXTERN int            ZEXPORT zlib_inflateSyncPoint OF((z_streamp z));
  534. ZEXTERN const uLongf * ZEXPORT zlib_get_crc_table    OF((void));
  535. #ifdef __cplusplus
  536. }
  537. #endif
  538. #endif /* _ZLIB_H */