Lines Matching +full:zlib +full:- +full:level
3 /* zlib.h -- interface of the 'zlib-ng' compression library
4 Forked from and compatible with zlib 1.2.11
6 Copyright (C) 1995-2016 Jean-loup Gailly and Mark Adler
8 This software is provided 'as-is', without any express or implied
24 Jean-loup Gailly Mark Adler
28 The data format used by the zlib library is described by RFCs (Request for
30 (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
34 # error Include zlib-ng.h for zlib-ng API or zlib.h for zlib-compat API but not both
57 #define ZLIBNG_VER_STATUS 0 /* 0=devel, 1-E=beta, F=Release */
58 #define ZLIBNG_VER_MODIFIED 0 /* non-zero if modified externally from zlib-ng */
60 #define ZLIB_VERSION "1.2.11.zlib-ng"
68 The 'zlib' compression library provides in-memory compression and
79 The compressed data format used by default by the in-memory functions is
80 the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
85 with "gz". The gzip format is different from the zlib format. gzip is a
91 The zlib format was designed to be compact and fast for use in memory
92 and on communications channels. The gzip format was designed for single-
93 file compression on file systems, has a larger header than zlib to maintain
94 directory information, and uses a different, slower check method than zlib.
124 unsigned long adler; /* Adler-32 or CRC-32 value of the uncompressed data */
131 gzip header information passed to and from zlib routines. See RFC 1952
142 unsigned char *name; /* pointer to zero-terminated file name or NULL */
144 unsigned char *comment; /* pointer to zero-terminated comment or NULL */
165 If zlib is used in a multi-threaded application, zalloc and zfree must be
166 thread safe. In that case, zlib is thread-safe. When zalloc and zfree are
190 #define Z_ERRNO (-1)
191 #define Z_STREAM_ERROR (-2)
192 #define Z_DATA_ERROR (-3)
193 #define Z_MEM_ERROR (-4)
194 #define Z_BUF_ERROR (-5)
195 #define Z_VERSION_ERROR (-6)
203 #define Z_DEFAULT_COMPRESSION (-1)
222 #define Z_NULL NULL /* for compatibility with zlib, was for initializing zalloc, zfree, opaque */
233 compatible with the zlib.h header file used by the application. This check
238 Z_EXTERN int Z_EXPORT deflateInit (z_stream *strm, int level);
245 The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
249 equivalent to level 6).
252 memory, Z_STREAM_ERROR if level is not a valid compression level, or
253 Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
270 - Compress more input starting at next_in and update next_in and avail_in
275 - Generate more output starting at next_out and update next_out and avail_out
331 avail_out), until the flush is complete (deflate returns with non-zero
351 deflate() sets strm->adler to the Adler-32 checksum of all input read
353 strm->adler will be the CRC-32 checksum of the input read so far. (See
356 deflate() may update strm->data_type if it can make a good guess about
399 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
405 implementation of inflateInit() does not process any header information --
420 - Decompress more input starting at next_in and update next_in and avail_in
426 - Generate more output starting at next_out and update next_out and avail_out
446 the zlib or gzip format, this will cause inflate() to return immediately
452 To assist in this, on return inflate() always sets strm->data_type to the
453 number of unused bits in the last byte taken from strm->next_in, plus 64 if
455 128 if inflate() returned immediately after decoding an end-of-block code or
457 stream. The end-of-block will not be indicated until all of the uncompressed
458 data from that block has been written to strm->next_out. The number of
469 256 is added to the value of strm->data_type when inflate() returns
496 below), inflate sets strm->adler to the Adler-32 checksum of the dictionary
498 strm->adler to the Adler-32 checksum of all output produced so far (that is,
500 below. At the end of the stream, inflate() checks that its computed Adler-32
504 inflate() can decompress and check either zlib-wrapped or gzip-wrapped
508 gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output
509 produced so far. The CRC-32 is checked against the gzip trailer, as is the
516 corrupted (input stream not conforming to the zlib format or incorrect check
517 value, in which case strm->msg points to a string with a more specific
549 int level,
569 will result in 9 (a 512-byte window). In that case, providing 8 to
570 inflateInit2() will result in an error when the zlib header with 9 is
575 windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
577 with no zlib header or trailer, and will not compute a check value.
581 compressed data instead of a zlib wrapper. The gzip header will have no
585 being written, strm->adler is a CRC-32 instead of an Adler-32.
587 For raw deflate or gzip encoding, a request for a 256-byte window is
588 rejected as invalid, since only the zlib header provides a means of
600 string match), or Z_RLE to limit match distances to one (run-length
614 method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is
625 without producing any compressed output. When using the zlib format, this
650 Upon return of this function, strm->adler is set to the Adler-32 value
652 which dictionary has been used by the compressor. (The Adler-32 value
655 Adler-32 value is not computed and strm->adler is not set.
675 to 258 bytes less in that case, due to how zlib's implementation of deflate
677 up to 258 bytes long. If the application needs the last window-size bytes of
678 input, then that would need to be saved by the application outside of zlib.
689 tried, for example when there are several ways of pre-processing the input
705 will leave the compression level and any other attributes that may have been
712 Z_EXTERN int Z_EXPORT deflateParams(z_stream *strm, int level, int strategy);
714 Dynamically update the compression level and compression strategy. The
715 interpretation of level and strategy is as in deflateInit2(). This can be
718 If the compression approach (which is a function of the level) or the
721 compressed with the old level and strategy using deflate(strm, Z_BLOCK).
723 respectively. The new level and strategy will take effect at the next call
735 If this is done, the old level and strategy will be applied to the data
736 compressed before deflateParams(), and the new level and strategy will be
751 used by someone who understands the algorithm used by zlib's deflate for
810 ignored -- the extra flags are set according to the compression level). The
814 the current versions of the command-line version of gzip (up through version
815 1.3.x) do not support header crc's, and will report that it is a "multi-part
843 the zlib header of the compressed stream.
845 windowBits can also be -8..-15 for raw inflate. In this case, -windowBits
847 not looking for a zlib or gzip header, not generating a check value, and not
852 recommended that a check value such as an Adler-32 or a CRC-32 be applied to
853 the uncompressed data as is done in the zlib, gzip, and zip formats. For
854 most applications, the zlib format should be used as is. Note that comments
858 32 to windowBits to enable zlib and gzip decoding with automatic header
859 detection, or add 16 to decode only the gzip format (the zlib format will
860 return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a
861 CRC-32 instead of an Adler-32. Unlike the gunzip utility and gzread() (see
869 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
873 apart from possibly reading the zlib header if present: actual decompression
876 of inflateInit2() does not process any header information -- that is
885 can be determined from the Adler-32 value returned by that call of inflate.
896 expected one (incorrect Adler-32 value). inflateSetDictionary does not
994 return value down 16 bits. If the upper value is -1 and the lower value is
996 If the upper value is -1 and the lower value is non-zero, then inflate is in
998 bytes from the input remaining to copy. If the upper value is not -1, then
1014 inflateMark returns the value noted above, or -65536 if the provided
1023 As inflate() processes the gzip stream, head->done is zero until the header
1024 is completed, at which time head->done is set to one. If a zlib stream is
1025 being decoded, then head->done is set to -1 to indicate that there will be
1062 before the call. If zalloc and zfree are NULL, then the default library-
1083 inflateBack() does a raw inflate with a single call using a call-back
1092 and to initialize the state with the user-provided window buffer.
1097 A raw deflate stream is one with no zlib or gzip header or trailer.
1102 behavior of inflate(), which expects a zlib header and trailer around the
1112 there is no input available, in() must return zero -- buf is ignored in that
1113 case -- and inflateBack() will return a buffer error. inflateBack() will
1114 call out(out_desc, buf, len) to write the uncompressed data buf[0..len-1].
1115 out() should return zero on success, or non-zero on failure. If out()
1116 returns non-zero, inflateBack() will return with an error. Neither in() nor
1119 The length written by out() will be at most the window size. Any non-zero
1123 setting strm->next_in and strm->avail_in. If that input is exhausted, then
1124 in() will be called. Therefore strm->next_in must be initialized before
1125 calling inflateBack(). If strm->next_in is NULL, then in() will be called
1126 immediately for input. If strm->next_in is not NULL, then strm->avail_in
1127 must also be initialized, and then if strm->avail_in is not zero, input will
1128 initially be taken from strm->next_in[0 .. strm->avail_in - 1].
1132 descriptors can be optionally used to pass any information that the caller-
1135 On return, inflateBack() will set strm->next_in and strm->avail_in to
1139 in the deflate stream (in which case strm->msg is set to indicate the nature
1142 using strm->next_in which will be NULL only if in() returned an error. If
1143 strm->next_in is not NULL, then the Z_BUF_ERROR was due to out() returning
1144 non-zero. (in() will always be called before out(), so strm->next_in is
1145 assured to be defined if out() returns non-zero.) Note that inflateBack()
1158 /* Return flags indicating compile-time options.
1168 9: ASMV or ASMINF -- use ASM code
1169 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention
1172 One-time table building (smaller code, but not thread-safe if true):
1173 12: BUILDFIXED -- build static block decoding tables when needed (not supported by zlib-ng)
1174 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed
1178 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking
1180 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect
1182 18-19: 0 (reserved)
1185 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate
1186 21: FASTEST -- deflate algorithm with only one, lowest compression level
1190 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format
1191 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure!
1192 26: 0 = returns value, 1 = void -- 1 means inferred string length returned
1195 27-31: 0 (reserved)
1205 stream-oriented functions. To simplify the interface, some default options
1206 are assumed (compression level and memory usage, standard memory allocation
1217 compressed data. compress() is equivalent to compress2() with a level
1226 unsigned long sourceLen, int level);
1228 Compresses the source buffer into the destination buffer. The level
1237 Z_STREAM_ERROR if the level parameter is invalid.
1279 "gz". The gzip format is different from the zlib format. gzip is a gzip
1283 typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */
1290 but can also include a compression level ("wb9") or a strategy: 'f' for
1291 filtered data as in "wb6f", 'h' for Huffman-only compression as in "wb1h",
1292 'R' for run-length encoding as in "wb1R", or 'F' for fixed code compression
1313 reading, this will be detected automatically by looking for the magic two-
1335 double-close()ing the file descriptor. Both gzclose() and fclose() will
1341 provided, or '+' was provided), or if fd is -1. The file descriptor is not
1343 will not detect if fd is invalid (unless fd is -1).
1358 gzbuffer() returns 0 on success, or -1 on failure, such as being called
1362 Z_EXTERN int Z_EXPORT gzsetparams(gzFile file, int level, int strategy);
1364 Dynamically update the compression level and strategy for file. See the
1391 middle of a gzip stream. Note that gzread does not return -1 in the event
1398 len for end of file, or -1 for error. If len is too large to fit in an int,
1399 then nothing is read, -1 is returned, and the error state is set to
1421 and the end-of-file flag is set. The length of the partial item read is not
1425 file, resetting and retrying on end-of-file, when size is not 1.
1449 uncompressed bytes actually written, or a negative zlib error code in case
1455 zlib was compiled with the insecure functions sprintf() or vsprintf(),
1462 Compress and write the given null-terminated string s to file, excluding
1465 gzputs returns the number of characters written, or -1 in case of error.
1470 Read and decompress bytes from file into buf, until len-1 characters are
1472 end-of-file condition is encountered. If any characters are read or if len
1474 are read due to an end-of-file or len is less than one, then the buffer is
1477 gzgets returns buf which is a null-terminated string, or it returns NULL
1478 for end-of-file or in case of error. If there was an error, the contents at
1485 returns the value that was written, or -1 in case of error.
1490 Read and decompress one byte from file. gzgetc returns this byte or -1
1500 the next read. At least one character of push-back is always allowed.
1501 gzungetc() returns the character pushed, or -1 on failure. gzungetc() will
1502 fail if c is -1, and may fail if a character has been pushed but not read
1512 deflate() function. The return value is the zlib error number (see function
1538 the beginning of the uncompressed stream, or -1 in case of error, in
1568 be used for a progress indicator. On error, gzoffset() returns -1.
1573 Return true (1) if the end-of-file indicator for file has been set while
1574 reading, false (0) otherwise. Note that the end-of-file indicator is set
1582 unless the end-of-file indicator is reset by gzclearerr() and the input file
1603 linking statically, using gzdirect() will include all of the zlib code for
1625 using these instead of gzclose() is that they avoid linking in zlib
1629 zlib library.
1635 errnum is set to zlib error number. If an error occurred in the file system
1644 gzerror() should be used to distinguish errors from end-of-file for those
1650 Clear the error and end-of-file flags for file. This is analogous to the
1667 Update a running Adler-32 checksum with the bytes buf[0..len-1] and
1668 return the updated checksum. An Adler-32 value is in the range of a 32-bit
1672 An Adler-32 checksum is almost as reliable as a CRC-32 but can be computed
1693 Combine two Adler-32 checksums into one. For two sequences of bytes, seq1
1694 and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
1695 each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of
1703 Update a running CRC-32 with the bytes buf[0..len-1] and return the
1704 updated CRC-32. A CRC-32 value is in the range of a 32-bit unsigned integer.
1706 crc. Pre- and post-conditioning (one's complement) is performed within this
1727 Combine two CRC-32 check values into one. For two sequences of bytes,
1728 seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
1729 calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32
1752 /* deflateInit and inflateInit are macros to allow checking the zlib version
1755 Z_EXTERN int Z_EXPORT deflateInit_(z_stream *strm, int level, const char *version, int stream_size);
1757 Z_EXTERN int Z_EXPORT deflateInit2_(z_stream *strm, int level, int method, int windowBits, int me…
1762 #define @ZLIB_SYMBOL_PREFIX@deflateInit(strm, level) deflateInit_((strm), (level), ZLIB_VERSION, (i…
1764 #define @ZLIB_SYMBOL_PREFIX@deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
1765 deflateInit2_((strm), (level), (method), (windowBits), (memLevel), \
1786 # define @ZLIB_SYMBOL_PREFIX@gzgetc(g) ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : (@…
1788 /* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or
1791 * functions are changed to 64 bits) -- in case these are set on systems