1 /** 2 * \file lzma/container.h 3 * \brief File formats 4 * \note Never include this file directly. Use <lzma.h> instead. 5 */ 6 7 /* 8 * Author: Lasse Collin 9 * 10 * This file has been put into the public domain. 11 * You can do whatever you want with this file. 12 */ 13 14 #ifndef LZMA_H_INTERNAL 15 # error Never include this file directly. Use <lzma.h> instead. 16 #endif 17 18 19 /************ 20 * Encoding * 21 ************/ 22 23 /** 24 * \brief Default compression preset 25 * 26 * It's not straightforward to recommend a default preset, because in some 27 * cases keeping the resource usage relatively low is more important that 28 * getting the maximum compression ratio. 29 */ 30 #define LZMA_PRESET_DEFAULT UINT32_C(6) 31 32 33 /** 34 * \brief Mask for preset level 35 * 36 * This is useful only if you need to extract the level from the preset 37 * variable. That should be rare. 38 */ 39 #define LZMA_PRESET_LEVEL_MASK UINT32_C(0x1F) 40 41 42 /* 43 * Preset flags 44 * 45 * Currently only one flag is defined. 46 */ 47 48 /** 49 * \brief Extreme compression preset 50 * 51 * This flag modifies the preset to make the encoding significantly slower 52 * while improving the compression ratio only marginally. This is useful 53 * when you don't mind spending time to get as small result as possible. 54 * 55 * This flag doesn't affect the memory usage requirements of the decoder (at 56 * least not significantly). The memory usage of the encoder may be increased 57 * a little but only at the lowest preset levels (0-3). 58 */ 59 #define LZMA_PRESET_EXTREME (UINT32_C(1) << 31) 60 61 62 /** 63 * \brief Multithreading options 64 */ 65 typedef struct { 66 /** 67 * \brief Flags 68 * 69 * Set this to zero if no flags are wanted. 70 * 71 * Encoder: No flags are currently supported. 72 * 73 * Decoder: Bitwise-or of zero or more of the decoder flags: 74 * - LZMA_TELL_NO_CHECK 75 * - LZMA_TELL_UNSUPPORTED_CHECK 76 * - LZMA_TELL_ANY_CHECK 77 * - LZMA_IGNORE_CHECK 78 * - LZMA_CONCATENATED 79 * - LZMA_FAIL_FAST 80 */ 81 uint32_t flags; 82 83 /** 84 * \brief Number of worker threads to use 85 */ 86 uint32_t threads; 87 88 /** 89 * \brief Encoder only: Maximum uncompressed size of a Block 90 * 91 * The encoder will start a new .xz Block every block_size bytes. 92 * Using LZMA_FULL_FLUSH or LZMA_FULL_BARRIER with lzma_code() 93 * the caller may tell liblzma to start a new Block earlier. 94 * 95 * With LZMA2, a recommended block size is 2-4 times the LZMA2 96 * dictionary size. With very small dictionaries, it is recommended 97 * to use at least 1 MiB block size for good compression ratio, even 98 * if this is more than four times the dictionary size. Note that 99 * these are only recommendations for typical use cases; feel free 100 * to use other values. Just keep in mind that using a block size 101 * less than the LZMA2 dictionary size is waste of RAM. 102 * 103 * Set this to 0 to let liblzma choose the block size depending 104 * on the compression options. For LZMA2 it will be 3*dict_size 105 * or 1 MiB, whichever is more. 106 * 107 * For each thread, about 3 * block_size bytes of memory will be 108 * allocated. This may change in later liblzma versions. If so, 109 * the memory usage will probably be reduced, not increased. 110 */ 111 uint64_t block_size; 112 113 /** 114 * \brief Timeout to allow lzma_code() to return early 115 * 116 * Multithreading can make liblzma consume input and produce 117 * output in a very bursty way: it may first read a lot of input 118 * to fill internal buffers, then no input or output occurs for 119 * a while. 120 * 121 * In single-threaded mode, lzma_code() won't return until it has 122 * either consumed all the input or filled the output buffer. If 123 * this is done in multithreaded mode, it may cause a call 124 * lzma_code() to take even tens of seconds, which isn't acceptable 125 * in all applications. 126 * 127 * To avoid very long blocking times in lzma_code(), a timeout 128 * (in milliseconds) may be set here. If lzma_code() would block 129 * longer than this number of milliseconds, it will return with 130 * LZMA_OK. Reasonable values are 100 ms or more. The xz command 131 * line tool uses 300 ms. 132 * 133 * If long blocking times are acceptable, set timeout to a special 134 * value of 0. This will disable the timeout mechanism and will make 135 * lzma_code() block until all the input is consumed or the output 136 * buffer has been filled. 137 * 138 * \note Even with a timeout, lzma_code() might sometimes take 139 * a long time to return. No timing guarantees are made. 140 */ 141 uint32_t timeout; 142 143 /** 144 * \brief Encoder only: Compression preset 145 * 146 * The preset is set just like with lzma_easy_encoder(). 147 * The preset is ignored if filters below is non-NULL. 148 */ 149 uint32_t preset; 150 151 /** 152 * \brief Encoder only: Filter chain (alternative to a preset) 153 * 154 * If this is NULL, the preset above is used. Otherwise the preset 155 * is ignored and the filter chain specified here is used. 156 */ 157 const lzma_filter *filters; 158 159 /** 160 * \brief Encoder only: Integrity check type 161 * 162 * See check.h for available checks. The xz command line tool 163 * defaults to LZMA_CHECK_CRC64, which is a good choice if you 164 * are unsure. 165 */ 166 lzma_check check; 167 168 /* 169 * Reserved space to allow possible future extensions without 170 * breaking the ABI. You should not touch these, because the names 171 * of these variables may change. These are and will never be used 172 * with the currently supported options, so it is safe to leave these 173 * uninitialized. 174 */ 175 /** \private Reserved member. */ 176 lzma_reserved_enum reserved_enum1; 177 178 /** \private Reserved member. */ 179 lzma_reserved_enum reserved_enum2; 180 181 /** \private Reserved member. */ 182 lzma_reserved_enum reserved_enum3; 183 184 /** \private Reserved member. */ 185 uint32_t reserved_int1; 186 187 /** \private Reserved member. */ 188 uint32_t reserved_int2; 189 190 /** \private Reserved member. */ 191 uint32_t reserved_int3; 192 193 /** \private Reserved member. */ 194 uint32_t reserved_int4; 195 196 /** 197 * \brief Memory usage limit to reduce the number of threads 198 * 199 * Encoder: Ignored. 200 * 201 * Decoder: 202 * 203 * If the number of threads has been set so high that more than 204 * memlimit_threading bytes of memory would be needed, the number 205 * of threads will be reduced so that the memory usage will not exceed 206 * memlimit_threading bytes. However, if memlimit_threading cannot 207 * be met even in single-threaded mode, then decoding will continue 208 * in single-threaded mode and memlimit_threading may be exceeded 209 * even by a large amount. That is, memlimit_threading will never make 210 * lzma_code() return LZMA_MEMLIMIT_ERROR. To truly cap the memory 211 * usage, see memlimit_stop below. 212 * 213 * Setting memlimit_threading to UINT64_MAX or a similar huge value 214 * means that liblzma is allowed to keep the whole compressed file 215 * and the whole uncompressed file in memory in addition to the memory 216 * needed by the decompressor data structures used by each thread! 217 * In other words, a reasonable value limit must be set here or it 218 * will cause problems sooner or later. If you have no idea what 219 * a reasonable value could be, try lzma_physmem() / 4 as a starting 220 * point. Setting this limit will never prevent decompression of 221 * a file; this will only reduce the number of threads. 222 * 223 * If memlimit_threading is greater than memlimit_stop, then the value 224 * of memlimit_stop will be used for both. 225 */ 226 uint64_t memlimit_threading; 227 228 /** 229 * \brief Memory usage limit that should never be exceeded 230 * 231 * Encoder: Ignored. 232 * 233 * Decoder: If decompressing will need more than this amount of 234 * memory even in the single-threaded mode, then lzma_code() will 235 * return LZMA_MEMLIMIT_ERROR. 236 */ 237 uint64_t memlimit_stop; 238 239 /** \private Reserved member. */ 240 uint64_t reserved_int7; 241 242 /** \private Reserved member. */ 243 uint64_t reserved_int8; 244 245 /** \private Reserved member. */ 246 void *reserved_ptr1; 247 248 /** \private Reserved member. */ 249 void *reserved_ptr2; 250 251 /** \private Reserved member. */ 252 void *reserved_ptr3; 253 254 /** \private Reserved member. */ 255 void *reserved_ptr4; 256 257 } lzma_mt; 258 259 260 /** 261 * \brief Calculate approximate memory usage of easy encoder 262 * 263 * This function is a wrapper for lzma_raw_encoder_memusage(). 264 * 265 * \param preset Compression preset (level and possible flags) 266 * 267 * \return Number of bytes of memory required for the given 268 * preset when encoding or UINT64_MAX on error. 269 */ 270 extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset) 271 lzma_nothrow lzma_attr_pure; 272 273 274 /** 275 * \brief Calculate approximate decoder memory usage of a preset 276 * 277 * This function is a wrapper for lzma_raw_decoder_memusage(). 278 * 279 * \param preset Compression preset (level and possible flags) 280 * 281 * \return Number of bytes of memory required to decompress a file 282 * that was compressed using the given preset or UINT64_MAX 283 * on error. 284 */ 285 extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset) 286 lzma_nothrow lzma_attr_pure; 287 288 289 /** 290 * \brief Initialize .xz Stream encoder using a preset number 291 * 292 * This function is intended for those who just want to use the basic features 293 * of liblzma (that is, most developers out there). 294 * 295 * If initialization fails (return value is not LZMA_OK), all the memory 296 * allocated for *strm by liblzma is always freed. Thus, there is no need 297 * to call lzma_end() after failed initialization. 298 * 299 * If initialization succeeds, use lzma_code() to do the actual encoding. 300 * Valid values for `action' (the second argument of lzma_code()) are 301 * LZMA_RUN, LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, and LZMA_FINISH. In future, 302 * there may be compression levels or flags that don't support LZMA_SYNC_FLUSH. 303 * 304 * \param strm Pointer to lzma_stream that is at least initialized 305 * with LZMA_STREAM_INIT. 306 * \param preset Compression preset to use. A preset consist of level 307 * number and zero or more flags. Usually flags aren't 308 * used, so preset is simply a number [0, 9] which match 309 * the options -0 ... -9 of the xz command line tool. 310 * Additional flags can be be set using bitwise-or with 311 * the preset level number, e.g. 6 | LZMA_PRESET_EXTREME. 312 * \param check Integrity check type to use. See check.h for available 313 * checks. The xz command line tool defaults to 314 * LZMA_CHECK_CRC64, which is a good choice if you are 315 * unsure. LZMA_CHECK_CRC32 is good too as long as the 316 * uncompressed file is not many gigabytes. 317 * 318 * \return Possible lzma_ret values: 319 * - LZMA_OK: Initialization succeeded. Use lzma_code() to 320 * encode your data. 321 * - LZMA_MEM_ERROR: Memory allocation failed. 322 * - LZMA_OPTIONS_ERROR: The given compression preset is not 323 * supported by this build of liblzma. 324 * - LZMA_UNSUPPORTED_CHECK: The given check type is not 325 * supported by this liblzma build. 326 * - LZMA_PROG_ERROR: One or more of the parameters have values 327 * that will never be valid. For example, strm == NULL. 328 */ 329 extern LZMA_API(lzma_ret) lzma_easy_encoder( 330 lzma_stream *strm, uint32_t preset, lzma_check check) 331 lzma_nothrow lzma_attr_warn_unused_result; 332 333 334 /** 335 * \brief Single-call .xz Stream encoding using a preset number 336 * 337 * The maximum required output buffer size can be calculated with 338 * lzma_stream_buffer_bound(). 339 * 340 * \param preset Compression preset to use. See the description 341 * in lzma_easy_encoder(). 342 * \param check Type of the integrity check to calculate from 343 * uncompressed data. 344 * \param allocator lzma_allocator for custom allocator functions. 345 * Set to NULL to use malloc() and free(). 346 * \param in Beginning of the input buffer 347 * \param in_size Size of the input buffer 348 * \param[out] out Beginning of the output buffer 349 * \param[out] out_pos The next byte will be written to out[*out_pos]. 350 * *out_pos is updated only if encoding succeeds. 351 * \param out_size Size of the out buffer; the first byte into 352 * which no data is written to is out[out_size]. 353 * 354 * \return Possible lzma_ret values: 355 * - LZMA_OK: Encoding was successful. 356 * - LZMA_BUF_ERROR: Not enough output buffer space. 357 * - LZMA_UNSUPPORTED_CHECK 358 * - LZMA_OPTIONS_ERROR 359 * - LZMA_MEM_ERROR 360 * - LZMA_DATA_ERROR 361 * - LZMA_PROG_ERROR 362 */ 363 extern LZMA_API(lzma_ret) lzma_easy_buffer_encode( 364 uint32_t preset, lzma_check check, 365 const lzma_allocator *allocator, 366 const uint8_t *in, size_t in_size, 367 uint8_t *out, size_t *out_pos, size_t out_size) lzma_nothrow; 368 369 370 /** 371 * \brief Initialize .xz Stream encoder using a custom filter chain 372 * 373 * \param strm Pointer to lzma_stream that is at least initialized 374 * with LZMA_STREAM_INIT. 375 * \param filters Array of filters terminated with 376 * .id == LZMA_VLI_UNKNOWN. See filters.h for more 377 * information. 378 * \param check Type of the integrity check to calculate from 379 * uncompressed data. 380 * 381 * \return Possible lzma_ret values: 382 * - LZMA_OK: Initialization was successful. 383 * - LZMA_MEM_ERROR 384 * - LZMA_UNSUPPORTED_CHECK 385 * - LZMA_OPTIONS_ERROR 386 * - LZMA_PROG_ERROR 387 */ 388 extern LZMA_API(lzma_ret) lzma_stream_encoder(lzma_stream *strm, 389 const lzma_filter *filters, lzma_check check) 390 lzma_nothrow lzma_attr_warn_unused_result; 391 392 393 /** 394 * \brief Calculate approximate memory usage of multithreaded .xz encoder 395 * 396 * Since doing the encoding in threaded mode doesn't affect the memory 397 * requirements of single-threaded decompressor, you can use 398 * lzma_easy_decoder_memusage(options->preset) or 399 * lzma_raw_decoder_memusage(options->filters) to calculate 400 * the decompressor memory requirements. 401 * 402 * \param options Compression options 403 * 404 * \return Number of bytes of memory required for encoding with the 405 * given options. If an error occurs, for example due to 406 * unsupported preset or filter chain, UINT64_MAX is returned. 407 */ 408 extern LZMA_API(uint64_t) lzma_stream_encoder_mt_memusage( 409 const lzma_mt *options) lzma_nothrow lzma_attr_pure; 410 411 412 /** 413 * \brief Initialize multithreaded .xz Stream encoder 414 * 415 * This provides the functionality of lzma_easy_encoder() and 416 * lzma_stream_encoder() as a single function for multithreaded use. 417 * 418 * The supported actions for lzma_code() are LZMA_RUN, LZMA_FULL_FLUSH, 419 * LZMA_FULL_BARRIER, and LZMA_FINISH. Support for LZMA_SYNC_FLUSH might be 420 * added in the future. 421 * 422 * \param strm Pointer to lzma_stream that is at least initialized 423 * with LZMA_STREAM_INIT. 424 * \param options Pointer to multithreaded compression options 425 * 426 * \return Possible lzma_ret values: 427 * - LZMA_OK 428 * - LZMA_MEM_ERROR 429 * - LZMA_UNSUPPORTED_CHECK 430 * - LZMA_OPTIONS_ERROR 431 * - LZMA_PROG_ERROR 432 */ 433 extern LZMA_API(lzma_ret) lzma_stream_encoder_mt( 434 lzma_stream *strm, const lzma_mt *options) 435 lzma_nothrow lzma_attr_warn_unused_result; 436 437 438 /** 439 * \brief Calculate recommended Block size for multithreaded .xz encoder 440 * 441 * This calculates a recommended Block size for multithreaded encoding given 442 * a filter chain. This is used internally by lzma_stream_encoder_mt() to 443 * determine the Block size if the block_size member is not set to the 444 * special value of 0 in the lzma_mt options struct. 445 * 446 * If one wishes to change the filters between Blocks, this function is 447 * helpful to set the block_size member of the lzma_mt struct before calling 448 * lzma_stream_encoder_mt(). Since the block_size member represents the 449 * maximum possible Block size for the multithreaded .xz encoder, one can 450 * use this function to find the maximum recommended Block size based on 451 * all planned filter chains. Otherwise, the multithreaded encoder will 452 * base its maximum Block size on the first filter chain used (if the 453 * block_size member is not set), which may unnecessarily limit the Block 454 * size for a later filter chain. 455 * 456 * \param filters Array of filters terminated with 457 * .id == LZMA_VLI_UNKNOWN. 458 * 459 * \return Recommended Block size in bytes, or UINT64_MAX if 460 * an error occurred. 461 */ 462 extern LZMA_API(uint64_t) lzma_mt_block_size(const lzma_filter *filters) 463 lzma_nothrow; 464 465 466 /** 467 * \brief Initialize .lzma encoder (legacy file format) 468 * 469 * The .lzma format is sometimes called the LZMA_Alone format, which is the 470 * reason for the name of this function. The .lzma format supports only the 471 * LZMA1 filter. There is no support for integrity checks like CRC32. 472 * 473 * Use this function if and only if you need to create files readable by 474 * legacy LZMA tools such as LZMA Utils 4.32.x. Moving to the .xz format 475 * is strongly recommended. 476 * 477 * The valid action values for lzma_code() are LZMA_RUN and LZMA_FINISH. 478 * No kind of flushing is supported, because the file format doesn't make 479 * it possible. 480 * 481 * \param strm Pointer to lzma_stream that is at least initialized 482 * with LZMA_STREAM_INIT. 483 * \param options Pointer to encoder options 484 * 485 * \return Possible lzma_ret values: 486 * - LZMA_OK 487 * - LZMA_MEM_ERROR 488 * - LZMA_OPTIONS_ERROR 489 * - LZMA_PROG_ERROR 490 */ 491 extern LZMA_API(lzma_ret) lzma_alone_encoder( 492 lzma_stream *strm, const lzma_options_lzma *options) 493 lzma_nothrow lzma_attr_warn_unused_result; 494 495 496 /** 497 * \brief Calculate output buffer size for single-call Stream encoder 498 * 499 * When trying to compress incompressible data, the encoded size will be 500 * slightly bigger than the input data. This function calculates how much 501 * output buffer space is required to be sure that lzma_stream_buffer_encode() 502 * doesn't return LZMA_BUF_ERROR. 503 * 504 * The calculated value is not exact, but it is guaranteed to be big enough. 505 * The actual maximum output space required may be slightly smaller (up to 506 * about 100 bytes). This should not be a problem in practice. 507 * 508 * If the calculated maximum size doesn't fit into size_t or would make the 509 * Stream grow past LZMA_VLI_MAX (which should never happen in practice), 510 * zero is returned to indicate the error. 511 * 512 * \note The limit calculated by this function applies only to 513 * single-call encoding. Multi-call encoding may (and probably 514 * will) have larger maximum expansion when encoding 515 * incompressible data. Currently there is no function to 516 * calculate the maximum expansion of multi-call encoding. 517 * 518 * \param uncompressed_size Size in bytes of the uncompressed 519 * input data 520 * 521 * \return Maximum number of bytes needed to store the compressed data. 522 */ 523 extern LZMA_API(size_t) lzma_stream_buffer_bound(size_t uncompressed_size) 524 lzma_nothrow; 525 526 527 /** 528 * \brief Single-call .xz Stream encoder 529 * 530 * \param filters Array of filters terminated with 531 * .id == LZMA_VLI_UNKNOWN. See filters.h for more 532 * information. 533 * \param check Type of the integrity check to calculate from 534 * uncompressed data. 535 * \param allocator lzma_allocator for custom allocator functions. 536 * Set to NULL to use malloc() and free(). 537 * \param in Beginning of the input buffer 538 * \param in_size Size of the input buffer 539 * \param[out] out Beginning of the output buffer 540 * \param[out] out_pos The next byte will be written to out[*out_pos]. 541 * *out_pos is updated only if encoding succeeds. 542 * \param out_size Size of the out buffer; the first byte into 543 * which no data is written to is out[out_size]. 544 * 545 * \return Possible lzma_ret values: 546 * - LZMA_OK: Encoding was successful. 547 * - LZMA_BUF_ERROR: Not enough output buffer space. 548 * - LZMA_UNSUPPORTED_CHECK 549 * - LZMA_OPTIONS_ERROR 550 * - LZMA_MEM_ERROR 551 * - LZMA_DATA_ERROR 552 * - LZMA_PROG_ERROR 553 */ 554 extern LZMA_API(lzma_ret) lzma_stream_buffer_encode( 555 lzma_filter *filters, lzma_check check, 556 const lzma_allocator *allocator, 557 const uint8_t *in, size_t in_size, 558 uint8_t *out, size_t *out_pos, size_t out_size) 559 lzma_nothrow lzma_attr_warn_unused_result; 560 561 562 /** 563 * \brief MicroLZMA encoder 564 * 565 * The MicroLZMA format is a raw LZMA stream whose first byte (always 0x00) 566 * has been replaced with bitwise-negation of the LZMA properties (lc/lp/pb). 567 * This encoding ensures that the first byte of MicroLZMA stream is never 568 * 0x00. There is no end of payload marker and thus the uncompressed size 569 * must be stored separately. For the best error detection the dictionary 570 * size should be stored separately as well but alternatively one may use 571 * the uncompressed size as the dictionary size when decoding. 572 * 573 * With the MicroLZMA encoder, lzma_code() behaves slightly unusually. 574 * The action argument must be LZMA_FINISH and the return value will never be 575 * LZMA_OK. Thus the encoding is always done with a single lzma_code() after 576 * the initialization. The benefit of the combination of initialization 577 * function and lzma_code() is that memory allocations can be re-used for 578 * better performance. 579 * 580 * lzma_code() will try to encode as much input as is possible to fit into 581 * the given output buffer. If not all input can be encoded, the stream will 582 * be finished without encoding all the input. The caller must check both 583 * input and output buffer usage after lzma_code() (total_in and total_out 584 * in lzma_stream can be convenient). Often lzma_code() can fill the output 585 * buffer completely if there is a lot of input, but sometimes a few bytes 586 * may remain unused because the next LZMA symbol would require more space. 587 * 588 * lzma_stream.avail_out must be at least 6. Otherwise LZMA_PROG_ERROR 589 * will be returned. 590 * 591 * The LZMA dictionary should be reasonably low to speed up the encoder 592 * re-initialization. A good value is bigger than the resulting 593 * uncompressed size of most of the output chunks. For example, if output 594 * size is 4 KiB, dictionary size of 32 KiB or 64 KiB is good. If the 595 * data compresses extremely well, even 128 KiB may be useful. 596 * 597 * The MicroLZMA format and this encoder variant were made with the EROFS 598 * file system in mind. This format may be convenient in other embedded 599 * uses too where many small streams are needed. XZ Embedded includes a 600 * decoder for this format. 601 * 602 * \param strm Pointer to lzma_stream that is at least initialized 603 * with LZMA_STREAM_INIT. 604 * \param options Pointer to encoder options 605 * 606 * \return Possible lzma_ret values: 607 * - LZMA_STREAM_END: All good. Check the amounts of input used 608 * and output produced. Store the amount of input used 609 * (uncompressed size) as it needs to be known to decompress 610 * the data. 611 * - LZMA_OPTIONS_ERROR 612 * - LZMA_MEM_ERROR 613 * - LZMA_PROG_ERROR: In addition to the generic reasons for this 614 * error code, this may also be returned if there isn't enough 615 * output space (6 bytes) to create a valid MicroLZMA stream. 616 */ 617 extern LZMA_API(lzma_ret) lzma_microlzma_encoder( 618 lzma_stream *strm, const lzma_options_lzma *options) 619 lzma_nothrow; 620 621 622 /************ 623 * Decoding * 624 ************/ 625 626 /** 627 * This flag makes lzma_code() return LZMA_NO_CHECK if the input stream 628 * being decoded has no integrity check. Note that when used with 629 * lzma_auto_decoder(), all .lzma files will trigger LZMA_NO_CHECK 630 * if LZMA_TELL_NO_CHECK is used. 631 */ 632 #define LZMA_TELL_NO_CHECK UINT32_C(0x01) 633 634 635 /** 636 * This flag makes lzma_code() return LZMA_UNSUPPORTED_CHECK if the input 637 * stream has an integrity check, but the type of the integrity check is not 638 * supported by this liblzma version or build. Such files can still be 639 * decoded, but the integrity check cannot be verified. 640 */ 641 #define LZMA_TELL_UNSUPPORTED_CHECK UINT32_C(0x02) 642 643 644 /** 645 * This flag makes lzma_code() return LZMA_GET_CHECK as soon as the type 646 * of the integrity check is known. The type can then be got with 647 * lzma_get_check(). 648 */ 649 #define LZMA_TELL_ANY_CHECK UINT32_C(0x04) 650 651 652 /** 653 * This flag makes lzma_code() not calculate and verify the integrity check 654 * of the compressed data in .xz files. This means that invalid integrity 655 * check values won't be detected and LZMA_DATA_ERROR won't be returned in 656 * such cases. 657 * 658 * This flag only affects the checks of the compressed data itself; the CRC32 659 * values in the .xz headers will still be verified normally. 660 * 661 * Don't use this flag unless you know what you are doing. Possible reasons 662 * to use this flag: 663 * 664 * - Trying to recover data from a corrupt .xz file. 665 * 666 * - Speeding up decompression, which matters mostly with SHA-256 667 * or with files that have compressed extremely well. It's recommended 668 * to not use this flag for this purpose unless the file integrity is 669 * verified externally in some other way. 670 * 671 * Support for this flag was added in liblzma 5.1.4beta. 672 */ 673 #define LZMA_IGNORE_CHECK UINT32_C(0x10) 674 675 676 /** 677 * This flag enables decoding of concatenated files with file formats that 678 * allow concatenating compressed files as is. From the formats currently 679 * supported by liblzma, only the .xz and .lz formats allow concatenated 680 * files. Concatenated files are not allowed with the legacy .lzma format. 681 * 682 * This flag also affects the usage of the `action' argument for lzma_code(). 683 * When LZMA_CONCATENATED is used, lzma_code() won't return LZMA_STREAM_END 684 * unless LZMA_FINISH is used as `action'. Thus, the application has to set 685 * LZMA_FINISH in the same way as it does when encoding. 686 * 687 * If LZMA_CONCATENATED is not used, the decoders still accept LZMA_FINISH 688 * as `action' for lzma_code(), but the usage of LZMA_FINISH isn't required. 689 */ 690 #define LZMA_CONCATENATED UINT32_C(0x08) 691 692 693 /** 694 * This flag makes the threaded decoder report errors (like LZMA_DATA_ERROR) 695 * as soon as they are detected. This saves time when the application has no 696 * interest in a partially decompressed truncated or corrupt file. Note that 697 * due to timing randomness, if the same truncated or corrupt input is 698 * decompressed multiple times with this flag, a different amount of output 699 * may be produced by different runs, and even the error code might vary. 700 * 701 * When using LZMA_FAIL_FAST, it is recommended to use LZMA_FINISH to tell 702 * the decoder when no more input will be coming because it can help fast 703 * detection and reporting of truncated files. Note that in this situation 704 * truncated files might be diagnosed with LZMA_DATA_ERROR instead of 705 * LZMA_OK or LZMA_BUF_ERROR! 706 * 707 * Without this flag the threaded decoder will provide as much output as 708 * possible at first and then report the pending error. This default behavior 709 * matches the single-threaded decoder and provides repeatable behavior 710 * with truncated or corrupt input. There are a few special cases where the 711 * behavior can still differ like memory allocation failures (LZMA_MEM_ERROR). 712 * 713 * Single-threaded decoders currently ignore this flag. 714 * 715 * Support for this flag was added in liblzma 5.3.3alpha. Note that in older 716 * versions this flag isn't supported (LZMA_OPTIONS_ERROR) even by functions 717 * that ignore this flag in newer liblzma versions. 718 */ 719 #define LZMA_FAIL_FAST UINT32_C(0x20) 720 721 722 /** 723 * \brief Initialize .xz Stream decoder 724 * 725 * \param strm Pointer to lzma_stream that is at least initialized 726 * with LZMA_STREAM_INIT. 727 * \param memlimit Memory usage limit as bytes. Use UINT64_MAX 728 * to effectively disable the limiter. liblzma 729 * 5.2.3 and earlier don't allow 0 here and return 730 * LZMA_PROG_ERROR; later versions treat 0 as if 1 731 * had been specified. 732 * \param flags Bitwise-or of zero or more of the decoder flags: 733 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, 734 * LZMA_TELL_ANY_CHECK, LZMA_IGNORE_CHECK, 735 * LZMA_CONCATENATED, LZMA_FAIL_FAST 736 * 737 * \return Possible lzma_ret values: 738 * - LZMA_OK: Initialization was successful. 739 * - LZMA_MEM_ERROR: Cannot allocate memory. 740 * - LZMA_OPTIONS_ERROR: Unsupported flags 741 * - LZMA_PROG_ERROR 742 */ 743 extern LZMA_API(lzma_ret) lzma_stream_decoder( 744 lzma_stream *strm, uint64_t memlimit, uint32_t flags) 745 lzma_nothrow lzma_attr_warn_unused_result; 746 747 748 /** 749 * \brief Initialize multithreaded .xz Stream decoder 750 * 751 * The decoder can decode multiple Blocks in parallel. This requires that each 752 * Block Header contains the Compressed Size and Uncompressed size fields 753 * which are added by the multi-threaded encoder, see lzma_stream_encoder_mt(). 754 * 755 * A Stream with one Block will only utilize one thread. A Stream with multiple 756 * Blocks but without size information in Block Headers will be processed in 757 * single-threaded mode in the same way as done by lzma_stream_decoder(). 758 * Concatenated Streams are processed one Stream at a time; no inter-Stream 759 * parallelization is done. 760 * 761 * This function behaves like lzma_stream_decoder() when options->threads == 1 762 * and options->memlimit_threading <= 1. 763 * 764 * \param strm Pointer to lzma_stream that is at least initialized 765 * with LZMA_STREAM_INIT. 766 * \param options Pointer to multithreaded compression options 767 * 768 * \return Possible lzma_ret values: 769 * - LZMA_OK: Initialization was successful. 770 * - LZMA_MEM_ERROR: Cannot allocate memory. 771 * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached. 772 * - LZMA_OPTIONS_ERROR: Unsupported flags. 773 * - LZMA_PROG_ERROR 774 */ 775 extern LZMA_API(lzma_ret) lzma_stream_decoder_mt( 776 lzma_stream *strm, const lzma_mt *options) 777 lzma_nothrow lzma_attr_warn_unused_result; 778 779 780 /** 781 * \brief Decode .xz, .lzma, and .lz (lzip) files with autodetection 782 * 783 * This decoder autodetects between the .xz, .lzma, and .lz file formats, 784 * and calls lzma_stream_decoder(), lzma_alone_decoder(), or 785 * lzma_lzip_decoder() once the type of the input file has been detected. 786 * 787 * Support for .lz was added in 5.4.0. 788 * 789 * If the flag LZMA_CONCATENATED is used and the input is a .lzma file: 790 * For historical reasons concatenated .lzma files aren't supported. 791 * If there is trailing data after one .lzma stream, lzma_code() will 792 * return LZMA_DATA_ERROR. (lzma_alone_decoder() doesn't have such a check 793 * as it doesn't support any decoder flags. It will return LZMA_STREAM_END 794 * after one .lzma stream.) 795 * 796 * \param strm Pointer to lzma_stream that is at least initialized 797 * with LZMA_STREAM_INIT. 798 * \param memlimit Memory usage limit as bytes. Use UINT64_MAX 799 * to effectively disable the limiter. liblzma 800 * 5.2.3 and earlier don't allow 0 here and return 801 * LZMA_PROG_ERROR; later versions treat 0 as if 1 802 * had been specified. 803 * \param flags Bitwise-or of zero or more of the decoder flags: 804 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, 805 * LZMA_TELL_ANY_CHECK, LZMA_IGNORE_CHECK, 806 * LZMA_CONCATENATED, LZMA_FAIL_FAST 807 * 808 * \return Possible lzma_ret values: 809 * - LZMA_OK: Initialization was successful. 810 * - LZMA_MEM_ERROR: Cannot allocate memory. 811 * - LZMA_OPTIONS_ERROR: Unsupported flags 812 * - LZMA_PROG_ERROR 813 */ 814 extern LZMA_API(lzma_ret) lzma_auto_decoder( 815 lzma_stream *strm, uint64_t memlimit, uint32_t flags) 816 lzma_nothrow lzma_attr_warn_unused_result; 817 818 819 /** 820 * \brief Initialize .lzma decoder (legacy file format) 821 * 822 * Valid `action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH. 823 * There is no need to use LZMA_FINISH, but it's allowed because it may 824 * simplify certain types of applications. 825 * 826 * \param strm Pointer to lzma_stream that is at least initialized 827 * with LZMA_STREAM_INIT. 828 * \param memlimit Memory usage limit as bytes. Use UINT64_MAX 829 * to effectively disable the limiter. liblzma 830 * 5.2.3 and earlier don't allow 0 here and return 831 * LZMA_PROG_ERROR; later versions treat 0 as if 1 832 * had been specified. 833 * 834 * \return Possible lzma_ret values: 835 * - LZMA_OK 836 * - LZMA_MEM_ERROR 837 * - LZMA_PROG_ERROR 838 */ 839 extern LZMA_API(lzma_ret) lzma_alone_decoder( 840 lzma_stream *strm, uint64_t memlimit) 841 lzma_nothrow lzma_attr_warn_unused_result; 842 843 844 /** 845 * \brief Initialize .lz (lzip) decoder (a foreign file format) 846 * 847 * This decoder supports the .lz format version 0 and the unextended .lz 848 * format version 1: 849 * 850 * - Files in the format version 0 were produced by lzip 1.3 and older. 851 * Such files aren't common but may be found from file archives 852 * as a few source packages were released in this format. People 853 * might have old personal files in this format too. Decompression 854 * support for the format version 0 was removed in lzip 1.18. 855 * 856 * - lzip 1.3 added decompression support for .lz format version 1 files. 857 * Compression support was added in lzip 1.4. In lzip 1.6 the .lz format 858 * version 1 was extended to support the Sync Flush marker. This extension 859 * is not supported by liblzma. lzma_code() will return LZMA_DATA_ERROR 860 * at the location of the Sync Flush marker. In practice files with 861 * the Sync Flush marker are very rare and thus liblzma can decompress 862 * almost all .lz files. 863 * 864 * Just like with lzma_stream_decoder() for .xz files, LZMA_CONCATENATED 865 * should be used when decompressing normal standalone .lz files. 866 * 867 * The .lz format allows putting non-.lz data at the end of a file after at 868 * least one valid .lz member. That is, one can append custom data at the end 869 * of a .lz file and the decoder is required to ignore it. In liblzma this 870 * is relevant only when LZMA_CONCATENATED is used. In that case lzma_code() 871 * will return LZMA_STREAM_END and leave lzma_stream.next_in pointing to 872 * the first byte of the non-.lz data. An exception to this is if the first 873 * 1-3 bytes of the non-.lz data are identical to the .lz magic bytes 874 * (0x4C, 0x5A, 0x49, 0x50; "LZIP" in US-ASCII). In such a case the 1-3 bytes 875 * will have been ignored by lzma_code(). If one wishes to locate the non-.lz 876 * data reliably, one must ensure that the first byte isn't 0x4C. Actually 877 * one should ensure that none of the first four bytes of trailing data are 878 * equal to the magic bytes because lzip >= 1.20 requires it by default. 879 * 880 * \param strm Pointer to lzma_stream that is at least initialized 881 * with LZMA_STREAM_INIT. 882 * \param memlimit Memory usage limit as bytes. Use UINT64_MAX 883 * to effectively disable the limiter. 884 * \param flags Bitwise-or of flags, or zero for no flags. 885 * All decoder flags listed above are supported 886 * although only LZMA_CONCATENATED and (in very rare 887 * cases) LZMA_IGNORE_CHECK are actually useful. 888 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, 889 * and LZMA_FAIL_FAST do nothing. LZMA_TELL_ANY_CHECK 890 * is supported for consistency only as CRC32 is 891 * always used in the .lz format. 892 * 893 * \return Possible lzma_ret values: 894 * - LZMA_OK: Initialization was successful. 895 * - LZMA_MEM_ERROR: Cannot allocate memory. 896 * - LZMA_OPTIONS_ERROR: Unsupported flags 897 * - LZMA_PROG_ERROR 898 */ 899 extern LZMA_API(lzma_ret) lzma_lzip_decoder( 900 lzma_stream *strm, uint64_t memlimit, uint32_t flags) 901 lzma_nothrow lzma_attr_warn_unused_result; 902 903 904 /** 905 * \brief Single-call .xz Stream decoder 906 * 907 * \param memlimit Pointer to how much memory the decoder is allowed 908 * to allocate. The value pointed by this pointer is 909 * modified if and only if LZMA_MEMLIMIT_ERROR is 910 * returned. 911 * \param flags Bitwise-or of zero or more of the decoder flags: 912 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, 913 * LZMA_IGNORE_CHECK, LZMA_CONCATENATED, 914 * LZMA_FAIL_FAST. Note that LZMA_TELL_ANY_CHECK 915 * is not allowed and will return LZMA_PROG_ERROR. 916 * \param allocator lzma_allocator for custom allocator functions. 917 * Set to NULL to use malloc() and free(). 918 * \param in Beginning of the input buffer 919 * \param in_pos The next byte will be read from in[*in_pos]. 920 * *in_pos is updated only if decoding succeeds. 921 * \param in_size Size of the input buffer; the first byte that 922 * won't be read is in[in_size]. 923 * \param[out] out Beginning of the output buffer 924 * \param[out] out_pos The next byte will be written to out[*out_pos]. 925 * *out_pos is updated only if decoding succeeds. 926 * \param out_size Size of the out buffer; the first byte into 927 * which no data is written to is out[out_size]. 928 * 929 * \return Possible lzma_ret values: 930 * - LZMA_OK: Decoding was successful. 931 * - LZMA_FORMAT_ERROR 932 * - LZMA_OPTIONS_ERROR 933 * - LZMA_DATA_ERROR 934 * - LZMA_NO_CHECK: This can be returned only if using 935 * the LZMA_TELL_NO_CHECK flag. 936 * - LZMA_UNSUPPORTED_CHECK: This can be returned only if using 937 * the LZMA_TELL_UNSUPPORTED_CHECK flag. 938 * - LZMA_MEM_ERROR 939 * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached. 940 * The minimum required memlimit value was stored to *memlimit. 941 * - LZMA_BUF_ERROR: Output buffer was too small. 942 * - LZMA_PROG_ERROR 943 */ 944 extern LZMA_API(lzma_ret) lzma_stream_buffer_decode( 945 uint64_t *memlimit, uint32_t flags, 946 const lzma_allocator *allocator, 947 const uint8_t *in, size_t *in_pos, size_t in_size, 948 uint8_t *out, size_t *out_pos, size_t out_size) 949 lzma_nothrow lzma_attr_warn_unused_result; 950 951 952 /** 953 * \brief MicroLZMA decoder 954 * 955 * See lzma_microlzma_encoder() for more information. 956 * 957 * The lzma_code() usage with this decoder is completely normal. The 958 * special behavior of lzma_code() applies to lzma_microlzma_encoder() only. 959 * 960 * \param strm Pointer to lzma_stream that is at least initialized 961 * with LZMA_STREAM_INIT. 962 * \param comp_size Compressed size of the MicroLZMA stream. 963 * The caller must somehow know this exactly. 964 * \param uncomp_size Uncompressed size of the MicroLZMA stream. 965 * If the exact uncompressed size isn't known, this 966 * can be set to a value that is at most as big as 967 * the exact uncompressed size would be, but then the 968 * next argument uncomp_size_is_exact must be false. 969 * \param uncomp_size_is_exact 970 * If true, uncomp_size must be exactly correct. 971 * This will improve error detection at the end of 972 * the stream. If the exact uncompressed size isn't 973 * known, this must be false. uncomp_size must still 974 * be at most as big as the exact uncompressed size 975 * is. Setting this to false when the exact size is 976 * known will work but error detection at the end of 977 * the stream will be weaker. 978 * \param dict_size LZMA dictionary size that was used when 979 * compressing the data. It is OK to use a bigger 980 * value too but liblzma will then allocate more 981 * memory than would actually be required and error 982 * detection will be slightly worse. (Note that with 983 * the implementation in XZ Embedded it doesn't 984 * affect the memory usage if one specifies bigger 985 * dictionary than actually required.) 986 * 987 * \return Possible lzma_ret values: 988 * - LZMA_OK 989 * - LZMA_MEM_ERROR 990 * - LZMA_OPTIONS_ERROR 991 * - LZMA_PROG_ERROR 992 */ 993 extern LZMA_API(lzma_ret) lzma_microlzma_decoder( 994 lzma_stream *strm, uint64_t comp_size, 995 uint64_t uncomp_size, lzma_bool uncomp_size_is_exact, 996 uint32_t dict_size) lzma_nothrow; 997