jpayne@69: /* SPDX-License-Identifier: 0BSD */ jpayne@69: jpayne@69: /** jpayne@69: * \file lzma/container.h jpayne@69: * \brief File formats jpayne@69: * \note Never include this file directly. Use instead. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * Author: Lasse Collin jpayne@69: */ jpayne@69: jpayne@69: #ifndef LZMA_H_INTERNAL jpayne@69: # error Never include this file directly. Use instead. jpayne@69: #endif jpayne@69: jpayne@69: jpayne@69: /************ jpayne@69: * Encoding * jpayne@69: ************/ jpayne@69: jpayne@69: /** jpayne@69: * \brief Default compression preset jpayne@69: * jpayne@69: * It's not straightforward to recommend a default preset, because in some jpayne@69: * cases keeping the resource usage relatively low is more important that jpayne@69: * getting the maximum compression ratio. jpayne@69: */ jpayne@69: #define LZMA_PRESET_DEFAULT UINT32_C(6) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Mask for preset level jpayne@69: * jpayne@69: * This is useful only if you need to extract the level from the preset jpayne@69: * variable. That should be rare. jpayne@69: */ jpayne@69: #define LZMA_PRESET_LEVEL_MASK UINT32_C(0x1F) jpayne@69: jpayne@69: jpayne@69: /* jpayne@69: * Preset flags jpayne@69: * jpayne@69: * Currently only one flag is defined. jpayne@69: */ jpayne@69: jpayne@69: /** jpayne@69: * \brief Extreme compression preset jpayne@69: * jpayne@69: * This flag modifies the preset to make the encoding significantly slower jpayne@69: * while improving the compression ratio only marginally. This is useful jpayne@69: * when you don't mind spending time to get as small result as possible. jpayne@69: * jpayne@69: * This flag doesn't affect the memory usage requirements of the decoder (at jpayne@69: * least not significantly). The memory usage of the encoder may be increased jpayne@69: * a little but only at the lowest preset levels (0-3). jpayne@69: */ jpayne@69: #define LZMA_PRESET_EXTREME (UINT32_C(1) << 31) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Multithreading options jpayne@69: */ jpayne@69: typedef struct { jpayne@69: /** jpayne@69: * \brief Flags jpayne@69: * jpayne@69: * Set this to zero if no flags are wanted. jpayne@69: * jpayne@69: * Encoder: No flags are currently supported. jpayne@69: * jpayne@69: * Decoder: Bitwise-or of zero or more of the decoder flags: jpayne@69: * - LZMA_TELL_NO_CHECK jpayne@69: * - LZMA_TELL_UNSUPPORTED_CHECK jpayne@69: * - LZMA_TELL_ANY_CHECK jpayne@69: * - LZMA_IGNORE_CHECK jpayne@69: * - LZMA_CONCATENATED jpayne@69: * - LZMA_FAIL_FAST jpayne@69: */ jpayne@69: uint32_t flags; jpayne@69: jpayne@69: /** jpayne@69: * \brief Number of worker threads to use jpayne@69: */ jpayne@69: uint32_t threads; jpayne@69: jpayne@69: /** jpayne@69: * \brief Encoder only: Maximum uncompressed size of a Block jpayne@69: * jpayne@69: * The encoder will start a new .xz Block every block_size bytes. jpayne@69: * Using LZMA_FULL_FLUSH or LZMA_FULL_BARRIER with lzma_code() jpayne@69: * the caller may tell liblzma to start a new Block earlier. jpayne@69: * jpayne@69: * With LZMA2, a recommended block size is 2-4 times the LZMA2 jpayne@69: * dictionary size. With very small dictionaries, it is recommended jpayne@69: * to use at least 1 MiB block size for good compression ratio, even jpayne@69: * if this is more than four times the dictionary size. Note that jpayne@69: * these are only recommendations for typical use cases; feel free jpayne@69: * to use other values. Just keep in mind that using a block size jpayne@69: * less than the LZMA2 dictionary size is waste of RAM. jpayne@69: * jpayne@69: * Set this to 0 to let liblzma choose the block size depending jpayne@69: * on the compression options. For LZMA2 it will be 3*dict_size jpayne@69: * or 1 MiB, whichever is more. jpayne@69: * jpayne@69: * For each thread, about 3 * block_size bytes of memory will be jpayne@69: * allocated. This may change in later liblzma versions. If so, jpayne@69: * the memory usage will probably be reduced, not increased. jpayne@69: */ jpayne@69: uint64_t block_size; jpayne@69: jpayne@69: /** jpayne@69: * \brief Timeout to allow lzma_code() to return early jpayne@69: * jpayne@69: * Multithreading can make liblzma consume input and produce jpayne@69: * output in a very bursty way: it may first read a lot of input jpayne@69: * to fill internal buffers, then no input or output occurs for jpayne@69: * a while. jpayne@69: * jpayne@69: * In single-threaded mode, lzma_code() won't return until it has jpayne@69: * either consumed all the input or filled the output buffer. If jpayne@69: * this is done in multithreaded mode, it may cause a call jpayne@69: * lzma_code() to take even tens of seconds, which isn't acceptable jpayne@69: * in all applications. jpayne@69: * jpayne@69: * To avoid very long blocking times in lzma_code(), a timeout jpayne@69: * (in milliseconds) may be set here. If lzma_code() would block jpayne@69: * longer than this number of milliseconds, it will return with jpayne@69: * LZMA_OK. Reasonable values are 100 ms or more. The xz command jpayne@69: * line tool uses 300 ms. jpayne@69: * jpayne@69: * If long blocking times are acceptable, set timeout to a special jpayne@69: * value of 0. This will disable the timeout mechanism and will make jpayne@69: * lzma_code() block until all the input is consumed or the output jpayne@69: * buffer has been filled. jpayne@69: * jpayne@69: * \note Even with a timeout, lzma_code() might sometimes take jpayne@69: * a long time to return. No timing guarantees are made. jpayne@69: */ jpayne@69: uint32_t timeout; jpayne@69: jpayne@69: /** jpayne@69: * \brief Encoder only: Compression preset jpayne@69: * jpayne@69: * The preset is set just like with lzma_easy_encoder(). jpayne@69: * The preset is ignored if filters below is non-NULL. jpayne@69: */ jpayne@69: uint32_t preset; jpayne@69: jpayne@69: /** jpayne@69: * \brief Encoder only: Filter chain (alternative to a preset) jpayne@69: * jpayne@69: * If this is NULL, the preset above is used. Otherwise the preset jpayne@69: * is ignored and the filter chain specified here is used. jpayne@69: */ jpayne@69: const lzma_filter *filters; jpayne@69: jpayne@69: /** jpayne@69: * \brief Encoder only: Integrity check type jpayne@69: * jpayne@69: * See check.h for available checks. The xz command line tool jpayne@69: * defaults to LZMA_CHECK_CRC64, which is a good choice if you jpayne@69: * are unsure. jpayne@69: */ jpayne@69: lzma_check check; jpayne@69: jpayne@69: /* jpayne@69: * Reserved space to allow possible future extensions without jpayne@69: * breaking the ABI. You should not touch these, because the names jpayne@69: * of these variables may change. These are and will never be used jpayne@69: * with the currently supported options, so it is safe to leave these jpayne@69: * uninitialized. jpayne@69: */ jpayne@69: /** \private Reserved member. */ jpayne@69: lzma_reserved_enum reserved_enum1; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: lzma_reserved_enum reserved_enum2; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: lzma_reserved_enum reserved_enum3; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: uint32_t reserved_int1; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: uint32_t reserved_int2; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: uint32_t reserved_int3; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: uint32_t reserved_int4; jpayne@69: jpayne@69: /** jpayne@69: * \brief Memory usage limit to reduce the number of threads jpayne@69: * jpayne@69: * Encoder: Ignored. jpayne@69: * jpayne@69: * Decoder: jpayne@69: * jpayne@69: * If the number of threads has been set so high that more than jpayne@69: * memlimit_threading bytes of memory would be needed, the number jpayne@69: * of threads will be reduced so that the memory usage will not exceed jpayne@69: * memlimit_threading bytes. However, if memlimit_threading cannot jpayne@69: * be met even in single-threaded mode, then decoding will continue jpayne@69: * in single-threaded mode and memlimit_threading may be exceeded jpayne@69: * even by a large amount. That is, memlimit_threading will never make jpayne@69: * lzma_code() return LZMA_MEMLIMIT_ERROR. To truly cap the memory jpayne@69: * usage, see memlimit_stop below. jpayne@69: * jpayne@69: * Setting memlimit_threading to UINT64_MAX or a similar huge value jpayne@69: * means that liblzma is allowed to keep the whole compressed file jpayne@69: * and the whole uncompressed file in memory in addition to the memory jpayne@69: * needed by the decompressor data structures used by each thread! jpayne@69: * In other words, a reasonable value limit must be set here or it jpayne@69: * will cause problems sooner or later. If you have no idea what jpayne@69: * a reasonable value could be, try lzma_physmem() / 4 as a starting jpayne@69: * point. Setting this limit will never prevent decompression of jpayne@69: * a file; this will only reduce the number of threads. jpayne@69: * jpayne@69: * If memlimit_threading is greater than memlimit_stop, then the value jpayne@69: * of memlimit_stop will be used for both. jpayne@69: */ jpayne@69: uint64_t memlimit_threading; jpayne@69: jpayne@69: /** jpayne@69: * \brief Memory usage limit that should never be exceeded jpayne@69: * jpayne@69: * Encoder: Ignored. jpayne@69: * jpayne@69: * Decoder: If decompressing will need more than this amount of jpayne@69: * memory even in the single-threaded mode, then lzma_code() will jpayne@69: * return LZMA_MEMLIMIT_ERROR. jpayne@69: */ jpayne@69: uint64_t memlimit_stop; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: uint64_t reserved_int7; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: uint64_t reserved_int8; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: void *reserved_ptr1; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: void *reserved_ptr2; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: void *reserved_ptr3; jpayne@69: jpayne@69: /** \private Reserved member. */ jpayne@69: void *reserved_ptr4; jpayne@69: jpayne@69: } lzma_mt; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Calculate approximate memory usage of easy encoder jpayne@69: * jpayne@69: * This function is a wrapper for lzma_raw_encoder_memusage(). jpayne@69: * jpayne@69: * \param preset Compression preset (level and possible flags) jpayne@69: * jpayne@69: * \return Number of bytes of memory required for the given jpayne@69: * preset when encoding or UINT64_MAX on error. jpayne@69: */ jpayne@69: extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset) jpayne@69: lzma_nothrow lzma_attr_pure; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Calculate approximate decoder memory usage of a preset jpayne@69: * jpayne@69: * This function is a wrapper for lzma_raw_decoder_memusage(). jpayne@69: * jpayne@69: * \param preset Compression preset (level and possible flags) jpayne@69: * jpayne@69: * \return Number of bytes of memory required to decompress a file jpayne@69: * that was compressed using the given preset or UINT64_MAX jpayne@69: * on error. jpayne@69: */ jpayne@69: extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset) jpayne@69: lzma_nothrow lzma_attr_pure; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize .xz Stream encoder using a preset number jpayne@69: * jpayne@69: * This function is intended for those who just want to use the basic features jpayne@69: * of liblzma (that is, most developers out there). jpayne@69: * jpayne@69: * If initialization fails (return value is not LZMA_OK), all the memory jpayne@69: * allocated for *strm by liblzma is always freed. Thus, there is no need jpayne@69: * to call lzma_end() after failed initialization. jpayne@69: * jpayne@69: * If initialization succeeds, use lzma_code() to do the actual encoding. jpayne@69: * Valid values for 'action' (the second argument of lzma_code()) are jpayne@69: * LZMA_RUN, LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, and LZMA_FINISH. In future, jpayne@69: * there may be compression levels or flags that don't support LZMA_SYNC_FLUSH. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param preset Compression preset to use. A preset consist of level jpayne@69: * number and zero or more flags. Usually flags aren't jpayne@69: * used, so preset is simply a number [0, 9] which match jpayne@69: * the options -0 ... -9 of the xz command line tool. jpayne@69: * Additional flags can be set using bitwise-or with jpayne@69: * the preset level number, e.g. 6 | LZMA_PRESET_EXTREME. jpayne@69: * \param check Integrity check type to use. See check.h for available jpayne@69: * checks. The xz command line tool defaults to jpayne@69: * LZMA_CHECK_CRC64, which is a good choice if you are jpayne@69: * unsure. LZMA_CHECK_CRC32 is good too as long as the jpayne@69: * uncompressed file is not many gigabytes. jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Initialization succeeded. Use lzma_code() to jpayne@69: * encode your data. jpayne@69: * - LZMA_MEM_ERROR: Memory allocation failed. jpayne@69: * - LZMA_OPTIONS_ERROR: The given compression preset is not jpayne@69: * supported by this build of liblzma. jpayne@69: * - LZMA_UNSUPPORTED_CHECK: The given check type is not jpayne@69: * supported by this liblzma build. jpayne@69: * - LZMA_PROG_ERROR: One or more of the parameters have values jpayne@69: * that will never be valid. For example, strm == NULL. jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_easy_encoder( jpayne@69: lzma_stream *strm, uint32_t preset, lzma_check check) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Single-call .xz Stream encoding using a preset number jpayne@69: * jpayne@69: * The maximum required output buffer size can be calculated with jpayne@69: * lzma_stream_buffer_bound(). jpayne@69: * jpayne@69: * \param preset Compression preset to use. See the description jpayne@69: * in lzma_easy_encoder(). jpayne@69: * \param check Type of the integrity check to calculate from jpayne@69: * uncompressed data. jpayne@69: * \param allocator lzma_allocator for custom allocator functions. jpayne@69: * Set to NULL to use malloc() and free(). jpayne@69: * \param in Beginning of the input buffer jpayne@69: * \param in_size Size of the input buffer jpayne@69: * \param[out] out Beginning of the output buffer jpayne@69: * \param[out] out_pos The next byte will be written to out[*out_pos]. jpayne@69: * *out_pos is updated only if encoding succeeds. jpayne@69: * \param out_size Size of the out buffer; the first byte into jpayne@69: * which no data is written to is out[out_size]. jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Encoding was successful. jpayne@69: * - LZMA_BUF_ERROR: Not enough output buffer space. jpayne@69: * - LZMA_UNSUPPORTED_CHECK jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_DATA_ERROR jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_easy_buffer_encode( jpayne@69: uint32_t preset, lzma_check check, jpayne@69: const lzma_allocator *allocator, jpayne@69: const uint8_t *in, size_t in_size, jpayne@69: uint8_t *out, size_t *out_pos, size_t out_size) lzma_nothrow; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize .xz Stream encoder using a custom filter chain jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param filters Array of filters terminated with jpayne@69: * .id == LZMA_VLI_UNKNOWN. See filters.h for more jpayne@69: * information. jpayne@69: * \param check Type of the integrity check to calculate from jpayne@69: * uncompressed data. jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Initialization was successful. jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_UNSUPPORTED_CHECK jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_stream_encoder(lzma_stream *strm, jpayne@69: const lzma_filter *filters, lzma_check check) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Calculate approximate memory usage of multithreaded .xz encoder jpayne@69: * jpayne@69: * Since doing the encoding in threaded mode doesn't affect the memory jpayne@69: * requirements of single-threaded decompressor, you can use jpayne@69: * lzma_easy_decoder_memusage(options->preset) or jpayne@69: * lzma_raw_decoder_memusage(options->filters) to calculate jpayne@69: * the decompressor memory requirements. jpayne@69: * jpayne@69: * \param options Compression options jpayne@69: * jpayne@69: * \return Number of bytes of memory required for encoding with the jpayne@69: * given options. If an error occurs, for example due to jpayne@69: * unsupported preset or filter chain, UINT64_MAX is returned. jpayne@69: */ jpayne@69: extern LZMA_API(uint64_t) lzma_stream_encoder_mt_memusage( jpayne@69: const lzma_mt *options) lzma_nothrow lzma_attr_pure; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize multithreaded .xz Stream encoder jpayne@69: * jpayne@69: * This provides the functionality of lzma_easy_encoder() and jpayne@69: * lzma_stream_encoder() as a single function for multithreaded use. jpayne@69: * jpayne@69: * The supported actions for lzma_code() are LZMA_RUN, LZMA_FULL_FLUSH, jpayne@69: * LZMA_FULL_BARRIER, and LZMA_FINISH. Support for LZMA_SYNC_FLUSH might be jpayne@69: * added in the future. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param options Pointer to multithreaded compression options jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_UNSUPPORTED_CHECK jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_stream_encoder_mt( jpayne@69: lzma_stream *strm, const lzma_mt *options) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Calculate recommended Block size for multithreaded .xz encoder jpayne@69: * jpayne@69: * This calculates a recommended Block size for multithreaded encoding given jpayne@69: * a filter chain. This is used internally by lzma_stream_encoder_mt() to jpayne@69: * determine the Block size if the block_size member is not set to the jpayne@69: * special value of 0 in the lzma_mt options struct. jpayne@69: * jpayne@69: * If one wishes to change the filters between Blocks, this function is jpayne@69: * helpful to set the block_size member of the lzma_mt struct before calling jpayne@69: * lzma_stream_encoder_mt(). Since the block_size member represents the jpayne@69: * maximum possible Block size for the multithreaded .xz encoder, one can jpayne@69: * use this function to find the maximum recommended Block size based on jpayne@69: * all planned filter chains. Otherwise, the multithreaded encoder will jpayne@69: * base its maximum Block size on the first filter chain used (if the jpayne@69: * block_size member is not set), which may unnecessarily limit the Block jpayne@69: * size for a later filter chain. jpayne@69: * jpayne@69: * \param filters Array of filters terminated with jpayne@69: * .id == LZMA_VLI_UNKNOWN. jpayne@69: * jpayne@69: * \return Recommended Block size in bytes, or UINT64_MAX if jpayne@69: * an error occurred. jpayne@69: */ jpayne@69: extern LZMA_API(uint64_t) lzma_mt_block_size(const lzma_filter *filters) jpayne@69: lzma_nothrow; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize .lzma encoder (legacy file format) jpayne@69: * jpayne@69: * The .lzma format is sometimes called the LZMA_Alone format, which is the jpayne@69: * reason for the name of this function. The .lzma format supports only the jpayne@69: * LZMA1 filter. There is no support for integrity checks like CRC32. jpayne@69: * jpayne@69: * Use this function if and only if you need to create files readable by jpayne@69: * legacy LZMA tools such as LZMA Utils 4.32.x. Moving to the .xz format jpayne@69: * is strongly recommended. jpayne@69: * jpayne@69: * The valid action values for lzma_code() are LZMA_RUN and LZMA_FINISH. jpayne@69: * No kind of flushing is supported, because the file format doesn't make jpayne@69: * it possible. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param options Pointer to encoder options jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_alone_encoder( jpayne@69: lzma_stream *strm, const lzma_options_lzma *options) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Calculate output buffer size for single-call Stream encoder jpayne@69: * jpayne@69: * When trying to compress incompressible data, the encoded size will be jpayne@69: * slightly bigger than the input data. This function calculates how much jpayne@69: * output buffer space is required to be sure that lzma_stream_buffer_encode() jpayne@69: * doesn't return LZMA_BUF_ERROR. jpayne@69: * jpayne@69: * The calculated value is not exact, but it is guaranteed to be big enough. jpayne@69: * The actual maximum output space required may be slightly smaller (up to jpayne@69: * about 100 bytes). This should not be a problem in practice. jpayne@69: * jpayne@69: * If the calculated maximum size doesn't fit into size_t or would make the jpayne@69: * Stream grow past LZMA_VLI_MAX (which should never happen in practice), jpayne@69: * zero is returned to indicate the error. jpayne@69: * jpayne@69: * \note The limit calculated by this function applies only to jpayne@69: * single-call encoding. Multi-call encoding may (and probably jpayne@69: * will) have larger maximum expansion when encoding jpayne@69: * incompressible data. Currently there is no function to jpayne@69: * calculate the maximum expansion of multi-call encoding. jpayne@69: * jpayne@69: * \param uncompressed_size Size in bytes of the uncompressed jpayne@69: * input data jpayne@69: * jpayne@69: * \return Maximum number of bytes needed to store the compressed data. jpayne@69: */ jpayne@69: extern LZMA_API(size_t) lzma_stream_buffer_bound(size_t uncompressed_size) jpayne@69: lzma_nothrow; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Single-call .xz Stream encoder jpayne@69: * jpayne@69: * \param filters Array of filters terminated with jpayne@69: * .id == LZMA_VLI_UNKNOWN. See filters.h for more jpayne@69: * information. jpayne@69: * \param check Type of the integrity check to calculate from jpayne@69: * uncompressed data. jpayne@69: * \param allocator lzma_allocator for custom allocator functions. jpayne@69: * Set to NULL to use malloc() and free(). jpayne@69: * \param in Beginning of the input buffer jpayne@69: * \param in_size Size of the input buffer jpayne@69: * \param[out] out Beginning of the output buffer jpayne@69: * \param[out] out_pos The next byte will be written to out[*out_pos]. jpayne@69: * *out_pos is updated only if encoding succeeds. jpayne@69: * \param out_size Size of the out buffer; the first byte into jpayne@69: * which no data is written to is out[out_size]. jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Encoding was successful. jpayne@69: * - LZMA_BUF_ERROR: Not enough output buffer space. jpayne@69: * - LZMA_UNSUPPORTED_CHECK jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_DATA_ERROR jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_stream_buffer_encode( jpayne@69: lzma_filter *filters, lzma_check check, jpayne@69: const lzma_allocator *allocator, jpayne@69: const uint8_t *in, size_t in_size, jpayne@69: uint8_t *out, size_t *out_pos, size_t out_size) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief MicroLZMA encoder jpayne@69: * jpayne@69: * The MicroLZMA format is a raw LZMA stream whose first byte (always 0x00) jpayne@69: * has been replaced with bitwise-negation of the LZMA properties (lc/lp/pb). jpayne@69: * This encoding ensures that the first byte of MicroLZMA stream is never jpayne@69: * 0x00. There is no end of payload marker and thus the uncompressed size jpayne@69: * must be stored separately. For the best error detection the dictionary jpayne@69: * size should be stored separately as well but alternatively one may use jpayne@69: * the uncompressed size as the dictionary size when decoding. jpayne@69: * jpayne@69: * With the MicroLZMA encoder, lzma_code() behaves slightly unusually. jpayne@69: * The action argument must be LZMA_FINISH and the return value will never be jpayne@69: * LZMA_OK. Thus the encoding is always done with a single lzma_code() after jpayne@69: * the initialization. The benefit of the combination of initialization jpayne@69: * function and lzma_code() is that memory allocations can be re-used for jpayne@69: * better performance. jpayne@69: * jpayne@69: * lzma_code() will try to encode as much input as is possible to fit into jpayne@69: * the given output buffer. If not all input can be encoded, the stream will jpayne@69: * be finished without encoding all the input. The caller must check both jpayne@69: * input and output buffer usage after lzma_code() (total_in and total_out jpayne@69: * in lzma_stream can be convenient). Often lzma_code() can fill the output jpayne@69: * buffer completely if there is a lot of input, but sometimes a few bytes jpayne@69: * may remain unused because the next LZMA symbol would require more space. jpayne@69: * jpayne@69: * lzma_stream.avail_out must be at least 6. Otherwise LZMA_PROG_ERROR jpayne@69: * will be returned. jpayne@69: * jpayne@69: * The LZMA dictionary should be reasonably low to speed up the encoder jpayne@69: * re-initialization. A good value is bigger than the resulting jpayne@69: * uncompressed size of most of the output chunks. For example, if output jpayne@69: * size is 4 KiB, dictionary size of 32 KiB or 64 KiB is good. If the jpayne@69: * data compresses extremely well, even 128 KiB may be useful. jpayne@69: * jpayne@69: * The MicroLZMA format and this encoder variant were made with the EROFS jpayne@69: * file system in mind. This format may be convenient in other embedded jpayne@69: * uses too where many small streams are needed. XZ Embedded includes a jpayne@69: * decoder for this format. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param options Pointer to encoder options jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_STREAM_END: All good. Check the amounts of input used jpayne@69: * and output produced. Store the amount of input used jpayne@69: * (uncompressed size) as it needs to be known to decompress jpayne@69: * the data. jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_PROG_ERROR: In addition to the generic reasons for this jpayne@69: * error code, this may also be returned if there isn't enough jpayne@69: * output space (6 bytes) to create a valid MicroLZMA stream. jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_microlzma_encoder( jpayne@69: lzma_stream *strm, const lzma_options_lzma *options) jpayne@69: lzma_nothrow; jpayne@69: jpayne@69: jpayne@69: /************ jpayne@69: * Decoding * jpayne@69: ************/ jpayne@69: jpayne@69: /** jpayne@69: * This flag makes lzma_code() return LZMA_NO_CHECK if the input stream jpayne@69: * being decoded has no integrity check. Note that when used with jpayne@69: * lzma_auto_decoder(), all .lzma files will trigger LZMA_NO_CHECK jpayne@69: * if LZMA_TELL_NO_CHECK is used. jpayne@69: */ jpayne@69: #define LZMA_TELL_NO_CHECK UINT32_C(0x01) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * This flag makes lzma_code() return LZMA_UNSUPPORTED_CHECK if the input jpayne@69: * stream has an integrity check, but the type of the integrity check is not jpayne@69: * supported by this liblzma version or build. Such files can still be jpayne@69: * decoded, but the integrity check cannot be verified. jpayne@69: */ jpayne@69: #define LZMA_TELL_UNSUPPORTED_CHECK UINT32_C(0x02) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * This flag makes lzma_code() return LZMA_GET_CHECK as soon as the type jpayne@69: * of the integrity check is known. The type can then be got with jpayne@69: * lzma_get_check(). jpayne@69: */ jpayne@69: #define LZMA_TELL_ANY_CHECK UINT32_C(0x04) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * This flag makes lzma_code() not calculate and verify the integrity check jpayne@69: * of the compressed data in .xz files. This means that invalid integrity jpayne@69: * check values won't be detected and LZMA_DATA_ERROR won't be returned in jpayne@69: * such cases. jpayne@69: * jpayne@69: * This flag only affects the checks of the compressed data itself; the CRC32 jpayne@69: * values in the .xz headers will still be verified normally. jpayne@69: * jpayne@69: * Don't use this flag unless you know what you are doing. Possible reasons jpayne@69: * to use this flag: jpayne@69: * jpayne@69: * - Trying to recover data from a corrupt .xz file. jpayne@69: * jpayne@69: * - Speeding up decompression, which matters mostly with SHA-256 jpayne@69: * or with files that have compressed extremely well. It's recommended jpayne@69: * to not use this flag for this purpose unless the file integrity is jpayne@69: * verified externally in some other way. jpayne@69: * jpayne@69: * Support for this flag was added in liblzma 5.1.4beta. jpayne@69: */ jpayne@69: #define LZMA_IGNORE_CHECK UINT32_C(0x10) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * This flag enables decoding of concatenated files with file formats that jpayne@69: * allow concatenating compressed files as is. From the formats currently jpayne@69: * supported by liblzma, only the .xz and .lz formats allow concatenated jpayne@69: * files. Concatenated files are not allowed with the legacy .lzma format. jpayne@69: * jpayne@69: * This flag also affects the usage of the 'action' argument for lzma_code(). jpayne@69: * When LZMA_CONCATENATED is used, lzma_code() won't return LZMA_STREAM_END jpayne@69: * unless LZMA_FINISH is used as 'action'. Thus, the application has to set jpayne@69: * LZMA_FINISH in the same way as it does when encoding. jpayne@69: * jpayne@69: * If LZMA_CONCATENATED is not used, the decoders still accept LZMA_FINISH jpayne@69: * as 'action' for lzma_code(), but the usage of LZMA_FINISH isn't required. jpayne@69: */ jpayne@69: #define LZMA_CONCATENATED UINT32_C(0x08) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * This flag makes the threaded decoder report errors (like LZMA_DATA_ERROR) jpayne@69: * as soon as they are detected. This saves time when the application has no jpayne@69: * interest in a partially decompressed truncated or corrupt file. Note that jpayne@69: * due to timing randomness, if the same truncated or corrupt input is jpayne@69: * decompressed multiple times with this flag, a different amount of output jpayne@69: * may be produced by different runs, and even the error code might vary. jpayne@69: * jpayne@69: * When using LZMA_FAIL_FAST, it is recommended to use LZMA_FINISH to tell jpayne@69: * the decoder when no more input will be coming because it can help fast jpayne@69: * detection and reporting of truncated files. Note that in this situation jpayne@69: * truncated files might be diagnosed with LZMA_DATA_ERROR instead of jpayne@69: * LZMA_OK or LZMA_BUF_ERROR! jpayne@69: * jpayne@69: * Without this flag the threaded decoder will provide as much output as jpayne@69: * possible at first and then report the pending error. This default behavior jpayne@69: * matches the single-threaded decoder and provides repeatable behavior jpayne@69: * with truncated or corrupt input. There are a few special cases where the jpayne@69: * behavior can still differ like memory allocation failures (LZMA_MEM_ERROR). jpayne@69: * jpayne@69: * Single-threaded decoders currently ignore this flag. jpayne@69: * jpayne@69: * Support for this flag was added in liblzma 5.3.3alpha. Note that in older jpayne@69: * versions this flag isn't supported (LZMA_OPTIONS_ERROR) even by functions jpayne@69: * that ignore this flag in newer liblzma versions. jpayne@69: */ jpayne@69: #define LZMA_FAIL_FAST UINT32_C(0x20) jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize .xz Stream decoder jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param memlimit Memory usage limit as bytes. Use UINT64_MAX jpayne@69: * to effectively disable the limiter. liblzma jpayne@69: * 5.2.3 and earlier don't allow 0 here and return jpayne@69: * LZMA_PROG_ERROR; later versions treat 0 as if 1 jpayne@69: * had been specified. jpayne@69: * \param flags Bitwise-or of zero or more of the decoder flags: jpayne@69: * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, jpayne@69: * LZMA_TELL_ANY_CHECK, LZMA_IGNORE_CHECK, jpayne@69: * LZMA_CONCATENATED, LZMA_FAIL_FAST jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Initialization was successful. jpayne@69: * - LZMA_MEM_ERROR: Cannot allocate memory. jpayne@69: * - LZMA_OPTIONS_ERROR: Unsupported flags jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_stream_decoder( jpayne@69: lzma_stream *strm, uint64_t memlimit, uint32_t flags) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize multithreaded .xz Stream decoder jpayne@69: * jpayne@69: * The decoder can decode multiple Blocks in parallel. This requires that each jpayne@69: * Block Header contains the Compressed Size and Uncompressed size fields jpayne@69: * which are added by the multi-threaded encoder, see lzma_stream_encoder_mt(). jpayne@69: * jpayne@69: * A Stream with one Block will only utilize one thread. A Stream with multiple jpayne@69: * Blocks but without size information in Block Headers will be processed in jpayne@69: * single-threaded mode in the same way as done by lzma_stream_decoder(). jpayne@69: * Concatenated Streams are processed one Stream at a time; no inter-Stream jpayne@69: * parallelization is done. jpayne@69: * jpayne@69: * This function behaves like lzma_stream_decoder() when options->threads == 1 jpayne@69: * and options->memlimit_threading <= 1. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param options Pointer to multithreaded compression options jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Initialization was successful. jpayne@69: * - LZMA_MEM_ERROR: Cannot allocate memory. jpayne@69: * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached. jpayne@69: * - LZMA_OPTIONS_ERROR: Unsupported flags. jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_stream_decoder_mt( jpayne@69: lzma_stream *strm, const lzma_mt *options) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Decode .xz, .lzma, and .lz (lzip) files with autodetection jpayne@69: * jpayne@69: * This decoder autodetects between the .xz, .lzma, and .lz file formats, jpayne@69: * and calls lzma_stream_decoder(), lzma_alone_decoder(), or jpayne@69: * lzma_lzip_decoder() once the type of the input file has been detected. jpayne@69: * jpayne@69: * Support for .lz was added in 5.4.0. jpayne@69: * jpayne@69: * If the flag LZMA_CONCATENATED is used and the input is a .lzma file: jpayne@69: * For historical reasons concatenated .lzma files aren't supported. jpayne@69: * If there is trailing data after one .lzma stream, lzma_code() will jpayne@69: * return LZMA_DATA_ERROR. (lzma_alone_decoder() doesn't have such a check jpayne@69: * as it doesn't support any decoder flags. It will return LZMA_STREAM_END jpayne@69: * after one .lzma stream.) jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param memlimit Memory usage limit as bytes. Use UINT64_MAX jpayne@69: * to effectively disable the limiter. liblzma jpayne@69: * 5.2.3 and earlier don't allow 0 here and return jpayne@69: * LZMA_PROG_ERROR; later versions treat 0 as if 1 jpayne@69: * had been specified. jpayne@69: * \param flags Bitwise-or of zero or more of the decoder flags: jpayne@69: * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, jpayne@69: * LZMA_TELL_ANY_CHECK, LZMA_IGNORE_CHECK, jpayne@69: * LZMA_CONCATENATED, LZMA_FAIL_FAST jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Initialization was successful. jpayne@69: * - LZMA_MEM_ERROR: Cannot allocate memory. jpayne@69: * - LZMA_OPTIONS_ERROR: Unsupported flags jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_auto_decoder( jpayne@69: lzma_stream *strm, uint64_t memlimit, uint32_t flags) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize .lzma decoder (legacy file format) jpayne@69: * jpayne@69: * Valid 'action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH. jpayne@69: * There is no need to use LZMA_FINISH, but it's allowed because it may jpayne@69: * simplify certain types of applications. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param memlimit Memory usage limit as bytes. Use UINT64_MAX jpayne@69: * to effectively disable the limiter. liblzma jpayne@69: * 5.2.3 and earlier don't allow 0 here and return jpayne@69: * LZMA_PROG_ERROR; later versions treat 0 as if 1 jpayne@69: * had been specified. jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_alone_decoder( jpayne@69: lzma_stream *strm, uint64_t memlimit) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Initialize .lz (lzip) decoder (a foreign file format) jpayne@69: * jpayne@69: * This decoder supports the .lz format version 0 and the unextended .lz jpayne@69: * format version 1: jpayne@69: * jpayne@69: * - Files in the format version 0 were produced by lzip 1.3 and older. jpayne@69: * Such files aren't common but may be found from file archives jpayne@69: * as a few source packages were released in this format. People jpayne@69: * might have old personal files in this format too. Decompression jpayne@69: * support for the format version 0 was removed in lzip 1.18. jpayne@69: * jpayne@69: * - lzip 1.3 added decompression support for .lz format version 1 files. jpayne@69: * Compression support was added in lzip 1.4. In lzip 1.6 the .lz format jpayne@69: * version 1 was extended to support the Sync Flush marker. This extension jpayne@69: * is not supported by liblzma. lzma_code() will return LZMA_DATA_ERROR jpayne@69: * at the location of the Sync Flush marker. In practice files with jpayne@69: * the Sync Flush marker are very rare and thus liblzma can decompress jpayne@69: * almost all .lz files. jpayne@69: * jpayne@69: * Just like with lzma_stream_decoder() for .xz files, LZMA_CONCATENATED jpayne@69: * should be used when decompressing normal standalone .lz files. jpayne@69: * jpayne@69: * The .lz format allows putting non-.lz data at the end of a file after at jpayne@69: * least one valid .lz member. That is, one can append custom data at the end jpayne@69: * of a .lz file and the decoder is required to ignore it. In liblzma this jpayne@69: * is relevant only when LZMA_CONCATENATED is used. In that case lzma_code() jpayne@69: * will return LZMA_STREAM_END and leave lzma_stream.next_in pointing to jpayne@69: * the first byte of the non-.lz data. An exception to this is if the first jpayne@69: * 1-3 bytes of the non-.lz data are identical to the .lz magic bytes jpayne@69: * (0x4C, 0x5A, 0x49, 0x50; "LZIP" in US-ASCII). In such a case the 1-3 bytes jpayne@69: * will have been ignored by lzma_code(). If one wishes to locate the non-.lz jpayne@69: * data reliably, one must ensure that the first byte isn't 0x4C. Actually jpayne@69: * one should ensure that none of the first four bytes of trailing data are jpayne@69: * equal to the magic bytes because lzip >= 1.20 requires it by default. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param memlimit Memory usage limit as bytes. Use UINT64_MAX jpayne@69: * to effectively disable the limiter. jpayne@69: * \param flags Bitwise-or of flags, or zero for no flags. jpayne@69: * All decoder flags listed above are supported jpayne@69: * although only LZMA_CONCATENATED and (in very rare jpayne@69: * cases) LZMA_IGNORE_CHECK are actually useful. jpayne@69: * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, jpayne@69: * and LZMA_FAIL_FAST do nothing. LZMA_TELL_ANY_CHECK jpayne@69: * is supported for consistency only as CRC32 is jpayne@69: * always used in the .lz format. jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Initialization was successful. jpayne@69: * - LZMA_MEM_ERROR: Cannot allocate memory. jpayne@69: * - LZMA_OPTIONS_ERROR: Unsupported flags jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_lzip_decoder( jpayne@69: lzma_stream *strm, uint64_t memlimit, uint32_t flags) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief Single-call .xz Stream decoder jpayne@69: * jpayne@69: * \param memlimit Pointer to how much memory the decoder is allowed jpayne@69: * to allocate. The value pointed by this pointer is jpayne@69: * modified if and only if LZMA_MEMLIMIT_ERROR is jpayne@69: * returned. jpayne@69: * \param flags Bitwise-or of zero or more of the decoder flags: jpayne@69: * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, jpayne@69: * LZMA_IGNORE_CHECK, LZMA_CONCATENATED, jpayne@69: * LZMA_FAIL_FAST. Note that LZMA_TELL_ANY_CHECK jpayne@69: * is not allowed and will return LZMA_PROG_ERROR. jpayne@69: * \param allocator lzma_allocator for custom allocator functions. jpayne@69: * Set to NULL to use malloc() and free(). jpayne@69: * \param in Beginning of the input buffer jpayne@69: * \param in_pos The next byte will be read from in[*in_pos]. jpayne@69: * *in_pos is updated only if decoding succeeds. jpayne@69: * \param in_size Size of the input buffer; the first byte that jpayne@69: * won't be read is in[in_size]. jpayne@69: * \param[out] out Beginning of the output buffer jpayne@69: * \param[out] out_pos The next byte will be written to out[*out_pos]. jpayne@69: * *out_pos is updated only if decoding succeeds. jpayne@69: * \param out_size Size of the out buffer; the first byte into jpayne@69: * which no data is written to is out[out_size]. jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK: Decoding was successful. jpayne@69: * - LZMA_FORMAT_ERROR jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_DATA_ERROR jpayne@69: * - LZMA_NO_CHECK: This can be returned only if using jpayne@69: * the LZMA_TELL_NO_CHECK flag. jpayne@69: * - LZMA_UNSUPPORTED_CHECK: This can be returned only if using jpayne@69: * the LZMA_TELL_UNSUPPORTED_CHECK flag. jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached. jpayne@69: * The minimum required memlimit value was stored to *memlimit. jpayne@69: * - LZMA_BUF_ERROR: Output buffer was too small. jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_stream_buffer_decode( jpayne@69: uint64_t *memlimit, uint32_t flags, jpayne@69: const lzma_allocator *allocator, jpayne@69: const uint8_t *in, size_t *in_pos, size_t in_size, jpayne@69: uint8_t *out, size_t *out_pos, size_t out_size) jpayne@69: lzma_nothrow lzma_attr_warn_unused_result; jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * \brief MicroLZMA decoder jpayne@69: * jpayne@69: * See lzma_microlzma_encoder() for more information. jpayne@69: * jpayne@69: * The lzma_code() usage with this decoder is completely normal. The jpayne@69: * special behavior of lzma_code() applies to lzma_microlzma_encoder() only. jpayne@69: * jpayne@69: * \param strm Pointer to lzma_stream that is at least initialized jpayne@69: * with LZMA_STREAM_INIT. jpayne@69: * \param comp_size Compressed size of the MicroLZMA stream. jpayne@69: * The caller must somehow know this exactly. jpayne@69: * \param uncomp_size Uncompressed size of the MicroLZMA stream. jpayne@69: * If the exact uncompressed size isn't known, this jpayne@69: * can be set to a value that is at most as big as jpayne@69: * the exact uncompressed size would be, but then the jpayne@69: * next argument uncomp_size_is_exact must be false. jpayne@69: * \param uncomp_size_is_exact jpayne@69: * If true, uncomp_size must be exactly correct. jpayne@69: * This will improve error detection at the end of jpayne@69: * the stream. If the exact uncompressed size isn't jpayne@69: * known, this must be false. uncomp_size must still jpayne@69: * be at most as big as the exact uncompressed size jpayne@69: * is. Setting this to false when the exact size is jpayne@69: * known will work but error detection at the end of jpayne@69: * the stream will be weaker. jpayne@69: * \param dict_size LZMA dictionary size that was used when jpayne@69: * compressing the data. It is OK to use a bigger jpayne@69: * value too but liblzma will then allocate more jpayne@69: * memory than would actually be required and error jpayne@69: * detection will be slightly worse. (Note that with jpayne@69: * the implementation in XZ Embedded it doesn't jpayne@69: * affect the memory usage if one specifies bigger jpayne@69: * dictionary than actually required.) jpayne@69: * jpayne@69: * \return Possible lzma_ret values: jpayne@69: * - LZMA_OK jpayne@69: * - LZMA_MEM_ERROR jpayne@69: * - LZMA_OPTIONS_ERROR jpayne@69: * - LZMA_PROG_ERROR jpayne@69: */ jpayne@69: extern LZMA_API(lzma_ret) lzma_microlzma_decoder( jpayne@69: lzma_stream *strm, uint64_t comp_size, jpayne@69: uint64_t uncomp_size, lzma_bool uncomp_size_is_exact, jpayne@69: uint32_t dict_size) lzma_nothrow;