2 * \file lzma/container.h
9 * This file has been put into the public domain.
10 * You can do whatever you want with this file.
12 * See ../lzma.h for information about liblzma as a whole.
15 #ifndef LZMA_H_INTERNAL
16 # error Never include this file directly. Use <lzma.h> instead.
25 * \brief Default compression preset
27 * It's not straightforward to recommend a default preset, because in some
28 * cases keeping the resource usage relatively low is more important that
29 * getting the maximum compression ratio.
31 #define LZMA_PRESET_DEFAULT UINT32_C(6)
35 * \brief Mask for preset level
37 * This is useful only if you need to extract the level from the preset
38 * variable. That should be rare.
40 #define LZMA_PRESET_LEVEL_MASK UINT32_C(0x1F)
46 * Currently only one flag is defined.
50 * \brief Extreme compression preset
52 * This flag modifies the preset to make the encoding significantly slower
53 * while improving the compression ratio only marginally. This is useful
54 * when you don't mind wasting time to get as small result as possible.
56 * This flag doesn't affect the memory usage requirements of the decoder (at
57 * least not significantly). The memory usage of the encoder may be increased
58 * a little but only at the lowest preset levels (0-3).
60 #define LZMA_PRESET_EXTREME (UINT32_C(1) << 31)
64 * \brief Calculate approximate memory usage of easy encoder
66 * This function is a wrapper for lzma_raw_encoder_memusage().
68 * \param preset Compression preset (level and possible flags)
70 extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset)
71 lzma_nothrow lzma_attr_pure;
75 * \brief Calculate approximate decoder memory usage of a preset
77 * This function is a wrapper for lzma_raw_decoder_memusage().
79 * \param preset Compression preset (level and possible flags)
81 extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset)
82 lzma_nothrow lzma_attr_pure;
86 * \brief Initialize .xz Stream encoder using a preset number
88 * This function is intended for those who just want to use the basic features
89 * if liblzma (that is, most developers out there).
91 * \param strm Pointer to lzma_stream that is at least initialized
92 * with LZMA_STREAM_INIT.
93 * \param preset Compression preset to use. A preset consist of level
94 * number and zero or more flags. Usually flags aren't
95 * used, so preset is simply a number [0, 9] which match
96 * the options -0 ... -9 of the xz command line tool.
97 * Additional flags can be be set using bitwise-or with
98 * the preset level number, e.g. 6 | LZMA_PRESET_EXTREME.
99 * \param check Integrity check type to use. See check.h for available
100 * checks. The xz command line tool defaults to
101 * LZMA_CHECK_CRC64, which is a good choice if you are
102 * unsure. LZMA_CHECK_CRC32 is good too as long as the
103 * uncompressed file is not many gigabytes.
105 * \return - LZMA_OK: Initialization succeeded. Use lzma_code() to
107 * - LZMA_MEM_ERROR: Memory allocation failed.
108 * - LZMA_OPTIONS_ERROR: The given compression preset is not
109 * supported by this build of liblzma.
110 * - LZMA_UNSUPPORTED_CHECK: The given check type is not
111 * supported by this liblzma build.
112 * - LZMA_PROG_ERROR: One or more of the parameters have values
113 * that will never be valid. For example, strm == NULL.
115 * If initialization fails (return value is not LZMA_OK), all the memory
116 * allocated for *strm by liblzma is always freed. Thus, there is no need
117 * to call lzma_end() after failed initialization.
119 * If initialization succeeds, use lzma_code() to do the actual encoding.
120 * Valid values for `action' (the second argument of lzma_code()) are
121 * LZMA_RUN, LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, and LZMA_FINISH. In future,
122 * there may be compression levels or flags that don't support LZMA_SYNC_FLUSH.
124 extern LZMA_API(lzma_ret) lzma_easy_encoder(
125 lzma_stream *strm, uint32_t preset, lzma_check check)
126 lzma_nothrow lzma_attr_warn_unused_result;
130 * \brief Single-call .xz Stream encoding using a preset number
132 * The maximum required output buffer size can be calculated with
133 * lzma_stream_buffer_bound().
135 * \param preset Compression preset to use. See the description
136 * in lzma_easy_encoder().
137 * \param check Type of the integrity check to calculate from
139 * \param allocator lzma_allocator for custom allocator functions.
140 * Set to NULL to use malloc() and free().
141 * \param in Beginning of the input buffer
142 * \param in_size Size of the input buffer
143 * \param out Beginning of the output buffer
144 * \param out_pos The next byte will be written to out[*out_pos].
145 * *out_pos is updated only if encoding succeeds.
146 * \param out_size Size of the out buffer; the first byte into
147 * which no data is written to is out[out_size].
149 * \return - LZMA_OK: Encoding was successful.
150 * - LZMA_BUF_ERROR: Not enough output buffer space.
151 * - LZMA_OPTIONS_ERROR
156 extern LZMA_API(lzma_ret) lzma_easy_buffer_encode(
157 uint32_t preset, lzma_check check,
158 lzma_allocator *allocator, const uint8_t *in, size_t in_size,
159 uint8_t *out, size_t *out_pos, size_t out_size) lzma_nothrow;
163 * \brief Initialize .xz Stream encoder using a custom filter chain
165 * \param strm Pointer to properly prepared lzma_stream
166 * \param filters Array of filters. This must be terminated with
167 * filters[n].id = LZMA_VLI_UNKNOWN. See filter.h for
169 * \param check Type of the integrity check to calculate from
172 * \return - LZMA_OK: Initialization was successful.
174 * - LZMA_OPTIONS_ERROR
177 extern LZMA_API(lzma_ret) lzma_stream_encoder(lzma_stream *strm,
178 const lzma_filter *filters, lzma_check check)
179 lzma_nothrow lzma_attr_warn_unused_result;
183 * \brief Initialize .lzma encoder (legacy file format)
185 * The .lzma format is sometimes called the LZMA_Alone format, which is the
186 * reason for the name of this function. The .lzma format supports only the
187 * LZMA1 filter. There is no support for integrity checks like CRC32.
189 * Use this function if and only if you need to create files readable by
190 * legacy LZMA tools such as LZMA Utils 4.32.x. Moving to the .xz format
191 * is strongly recommended.
193 * The valid action values for lzma_code() are LZMA_RUN and LZMA_FINISH.
194 * No kind of flushing is supported, because the file format doesn't make
199 * - LZMA_OPTIONS_ERROR
202 extern LZMA_API(lzma_ret) lzma_alone_encoder(
203 lzma_stream *strm, const lzma_options_lzma *options)
204 lzma_nothrow lzma_attr_warn_unused_result;
208 * \brief Calculate output buffer size for single-call Stream encoder
210 * When trying to compress uncompressible data, the encoded size will be
211 * slightly bigger than the input data. This function calculates how much
212 * output buffer space is required to be sure that lzma_stream_buffer_encode()
213 * doesn't return LZMA_BUF_ERROR.
215 * The calculated value is not exact, but it is guaranteed to be big enough.
216 * The actual maximum output space required may be slightly smaller (up to
217 * about 100 bytes). This should not be a problem in practice.
219 * If the calculated maximum size doesn't fit into size_t or would make the
220 * Stream grow past LZMA_VLI_MAX (which should never happen in practice),
221 * zero is returned to indicate the error.
223 * \note The limit calculated by this function applies only to
224 * single-call encoding. Multi-call encoding may (and probably
225 * will) have larger maximum expansion when encoding
226 * uncompressible data. Currently there is no function to
227 * calculate the maximum expansion of multi-call encoding.
229 extern LZMA_API(size_t) lzma_stream_buffer_bound(size_t uncompressed_size)
234 * \brief Single-call .xz Stream encoder
236 * \param filters Array of filters. This must be terminated with
237 * filters[n].id = LZMA_VLI_UNKNOWN. See filter.h
238 * for more information.
239 * \param check Type of the integrity check to calculate from
241 * \param allocator lzma_allocator for custom allocator functions.
242 * Set to NULL to use malloc() and free().
243 * \param in Beginning of the input buffer
244 * \param in_size Size of the input buffer
245 * \param out Beginning of the output buffer
246 * \param out_pos The next byte will be written to out[*out_pos].
247 * *out_pos is updated only if encoding succeeds.
248 * \param out_size Size of the out buffer; the first byte into
249 * which no data is written to is out[out_size].
251 * \return - LZMA_OK: Encoding was successful.
252 * - LZMA_BUF_ERROR: Not enough output buffer space.
253 * - LZMA_OPTIONS_ERROR
258 extern LZMA_API(lzma_ret) lzma_stream_buffer_encode(
259 lzma_filter *filters, lzma_check check,
260 lzma_allocator *allocator, const uint8_t *in, size_t in_size,
261 uint8_t *out, size_t *out_pos, size_t out_size)
262 lzma_nothrow lzma_attr_warn_unused_result;
270 * This flag makes lzma_code() return LZMA_NO_CHECK if the input stream
271 * being decoded has no integrity check. Note that when used with
272 * lzma_auto_decoder(), all .lzma files will trigger LZMA_NO_CHECK
273 * if LZMA_TELL_NO_CHECK is used.
275 #define LZMA_TELL_NO_CHECK UINT32_C(0x01)
279 * This flag makes lzma_code() return LZMA_UNSUPPORTED_CHECK if the input
280 * stream has an integrity check, but the type of the integrity check is not
281 * supported by this liblzma version or build. Such files can still be
282 * decoded, but the integrity check cannot be verified.
284 #define LZMA_TELL_UNSUPPORTED_CHECK UINT32_C(0x02)
288 * This flag makes lzma_code() return LZMA_GET_CHECK as soon as the type
289 * of the integrity check is known. The type can then be got with
292 #define LZMA_TELL_ANY_CHECK UINT32_C(0x04)
296 * This flag enables decoding of concatenated files with file formats that
297 * allow concatenating compressed files as is. From the formats currently
298 * supported by liblzma, only the .xz format allows concatenated files.
299 * Concatenated files are not allowed with the legacy .lzma format.
301 * This flag also affects the usage of the `action' argument for lzma_code().
302 * When LZMA_CONCATENATED is used, lzma_code() won't return LZMA_STREAM_END
303 * unless LZMA_FINISH is used as `action'. Thus, the application has to set
304 * LZMA_FINISH in the same way as it does when encoding.
306 * If LZMA_CONCATENATED is not used, the decoders still accept LZMA_FINISH
307 * as `action' for lzma_code(), but the usage of LZMA_FINISH isn't required.
309 #define LZMA_CONCATENATED UINT32_C(0x08)
313 * \brief Initialize .xz Stream decoder
315 * \param strm Pointer to properly prepared lzma_stream
316 * \param memlimit Memory usage limit as bytes. Use UINT64_MAX
317 * to effectively disable the limiter.
318 * \param flags Bitwise-or of zero or more of the decoder flags:
319 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
320 * LZMA_TELL_ANY_CHECK, LZMA_CONCATENATED
322 * \return - LZMA_OK: Initialization was successful.
323 * - LZMA_MEM_ERROR: Cannot allocate memory.
324 * - LZMA_OPTIONS_ERROR: Unsupported flags
327 extern LZMA_API(lzma_ret) lzma_stream_decoder(
328 lzma_stream *strm, uint64_t memlimit, uint32_t flags)
329 lzma_nothrow lzma_attr_warn_unused_result;
333 * \brief Decode .xz Streams and .lzma files with autodetection
335 * This decoder autodetects between the .xz and .lzma file formats, and
336 * calls lzma_stream_decoder() or lzma_alone_decoder() once the type
337 * of the input file has been detected.
339 * \param strm Pointer to properly prepared lzma_stream
340 * \param memlimit Memory usage limit as bytes. Use UINT64_MAX
341 * to effectively disable the limiter.
342 * \param flags Bitwise-or of flags, or zero for no flags.
344 * \return - LZMA_OK: Initialization was successful.
345 * - LZMA_MEM_ERROR: Cannot allocate memory.
346 * - LZMA_OPTIONS_ERROR: Unsupported flags
349 extern LZMA_API(lzma_ret) lzma_auto_decoder(
350 lzma_stream *strm, uint64_t memlimit, uint32_t flags)
351 lzma_nothrow lzma_attr_warn_unused_result;
355 * \brief Initialize .lzma decoder (legacy file format)
357 * Valid `action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH.
358 * There is no need to use LZMA_FINISH, but allowing it may simplify
359 * certain types of applications.
365 extern LZMA_API(lzma_ret) lzma_alone_decoder(
366 lzma_stream *strm, uint64_t memlimit)
367 lzma_nothrow lzma_attr_warn_unused_result;
371 * \brief Single-call .xz Stream decoder
373 * \param memlimit Pointer to how much memory the decoder is allowed
374 * to allocate. The value pointed by this pointer is
375 * modified if and only if LZMA_MEMLIMIT_ERROR is
377 * \param flags Bitwise-or of zero or more of the decoder flags:
378 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK,
379 * LZMA_CONCATENATED. Note that LZMA_TELL_ANY_CHECK
380 * is not allowed and will return LZMA_PROG_ERROR.
381 * \param allocator lzma_allocator for custom allocator functions.
382 * Set to NULL to use malloc() and free().
383 * \param in Beginning of the input buffer
384 * \param in_pos The next byte will be read from in[*in_pos].
385 * *in_pos is updated only if decoding succeeds.
386 * \param in_size Size of the input buffer; the first byte that
387 * won't be read is in[in_size].
388 * \param out Beginning of the output buffer
389 * \param out_pos The next byte will be written to out[*out_pos].
390 * *out_pos is updated only if decoding succeeds.
391 * \param out_size Size of the out buffer; the first byte into
392 * which no data is written to is out[out_size].
394 * \return - LZMA_OK: Decoding was successful.
395 * - LZMA_FORMAT_ERROR
396 * - LZMA_OPTIONS_ERROR
398 * - LZMA_NO_CHECK: This can be returned only if using
399 * the LZMA_TELL_NO_CHECK flag.
400 * - LZMA_UNSUPPORTED_CHECK: This can be returned only if using
401 * the LZMA_TELL_UNSUPPORTED_CHECK flag.
403 * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached.
404 * The minimum required memlimit value was stored to *memlimit.
405 * - LZMA_BUF_ERROR: Output buffer was too small.
408 extern LZMA_API(lzma_ret) lzma_stream_buffer_decode(
409 uint64_t *memlimit, uint32_t flags, lzma_allocator *allocator,
410 const uint8_t *in, size_t *in_pos, size_t in_size,
411 uint8_t *out, size_t *out_pos, size_t out_size)
412 lzma_nothrow lzma_attr_warn_unused_result;