OLD | NEW |
1 /** | 1 /** |
2 * \file lzma/block.h | 2 * \file lzma/block.h |
3 * \brief .xz Block handling | 3 * \brief .xz Block handling |
4 */ | 4 */ |
5 | 5 |
6 /* | 6 /* |
7 * Author: Lasse Collin | 7 * Author: Lasse Collin |
8 * | 8 * |
9 * This file has been put into the public domain. | 9 * This file has been put into the public domain. |
10 * You can do whatever you want with this file. | 10 * You can do whatever you want with this file. |
(...skipping 300 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
311 * \brief Decode Block Header | 311 * \brief Decode Block Header |
312 * | 312 * |
313 * block->version should be set to the highest value supported by the | 313 * block->version should be set to the highest value supported by the |
314 * application; currently the only possible version is zero. This function | 314 * application; currently the only possible version is zero. This function |
315 * will set version to the lowest value that still supports all the features | 315 * will set version to the lowest value that still supports all the features |
316 * required by the Block Header. | 316 * required by the Block Header. |
317 * | 317 * |
318 * The size of the Block Header must have already been decoded with | 318 * The size of the Block Header must have already been decoded with |
319 * lzma_block_header_size_decode() macro and stored to block->header_size. | 319 * lzma_block_header_size_decode() macro and stored to block->header_size. |
320 * | 320 * |
321 * block->filters must have been allocated, but not necessarily initialized. | 321 * block->filters must have been allocated, but they don't need to be |
322 * Possible existing filter options are _not_ freed. | 322 * initialized (possible existing filter options are not freed). |
323 * | 323 * |
324 * \param block Destination for Block options. | 324 * \param block Destination for Block options. |
325 * \param allocator lzma_allocator for custom allocator functions. | 325 * \param allocator lzma_allocator for custom allocator functions. |
326 * Set to NULL to use malloc() (and also free() | 326 * Set to NULL to use malloc() (and also free() |
327 * if an error occurs). | 327 * if an error occurs). |
328 * \param in Beginning of the input buffer. This must be | 328 * \param in Beginning of the input buffer. This must be |
329 * at least block->header_size bytes. | 329 * at least block->header_size bytes. |
330 * | 330 * |
331 * \return - LZMA_OK: Decoding was successful. block->header_size | 331 * \return - LZMA_OK: Decoding was successful. block->header_size |
332 * bytes were read from the input buffer. | 332 * bytes were read from the input buffer. |
(...skipping 143 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
476 * \param in Beginning of the input buffer | 476 * \param in Beginning of the input buffer |
477 * \param in_size Size of the input buffer | 477 * \param in_size Size of the input buffer |
478 * \param out Beginning of the output buffer | 478 * \param out Beginning of the output buffer |
479 * \param out_pos The next byte will be written to out[*out_pos]. | 479 * \param out_pos The next byte will be written to out[*out_pos]. |
480 * *out_pos is updated only if encoding succeeds. | 480 * *out_pos is updated only if encoding succeeds. |
481 * \param out_size Size of the out buffer; the first byte into | 481 * \param out_size Size of the out buffer; the first byte into |
482 * which no data is written to is out[out_size]. | 482 * which no data is written to is out[out_size]. |
483 * | 483 * |
484 * \return - LZMA_OK: Encoding was successful. | 484 * \return - LZMA_OK: Encoding was successful. |
485 * - LZMA_BUF_ERROR: Not enough output buffer space. | 485 * - LZMA_BUF_ERROR: Not enough output buffer space. |
| 486 * - LZMA_UNSUPPORTED_CHECK |
486 * - LZMA_OPTIONS_ERROR | 487 * - LZMA_OPTIONS_ERROR |
487 * - LZMA_MEM_ERROR | 488 * - LZMA_MEM_ERROR |
488 * - LZMA_DATA_ERROR | 489 * - LZMA_DATA_ERROR |
489 * - LZMA_PROG_ERROR | 490 * - LZMA_PROG_ERROR |
490 */ | 491 */ |
491 extern LZMA_API(lzma_ret) lzma_block_buffer_encode( | 492 extern LZMA_API(lzma_ret) lzma_block_buffer_encode( |
492 lzma_block *block, lzma_allocator *allocator, | 493 lzma_block *block, lzma_allocator *allocator, |
493 const uint8_t *in, size_t in_size, | 494 const uint8_t *in, size_t in_size, |
494 uint8_t *out, size_t *out_pos, size_t out_size) | 495 uint8_t *out, size_t *out_pos, size_t out_size) |
495 lzma_nothrow lzma_attr_warn_unused_result; | 496 lzma_nothrow lzma_attr_warn_unused_result; |
(...skipping 24 matching lines...) Expand all Loading... |
520 * - LZMA_DATA_ERROR | 521 * - LZMA_DATA_ERROR |
521 * - LZMA_MEM_ERROR | 522 * - LZMA_MEM_ERROR |
522 * - LZMA_BUF_ERROR: Output buffer was too small. | 523 * - LZMA_BUF_ERROR: Output buffer was too small. |
523 * - LZMA_PROG_ERROR | 524 * - LZMA_PROG_ERROR |
524 */ | 525 */ |
525 extern LZMA_API(lzma_ret) lzma_block_buffer_decode( | 526 extern LZMA_API(lzma_ret) lzma_block_buffer_decode( |
526 lzma_block *block, lzma_allocator *allocator, | 527 lzma_block *block, lzma_allocator *allocator, |
527 const uint8_t *in, size_t *in_pos, size_t in_size, | 528 const uint8_t *in, size_t *in_pos, size_t in_size, |
528 uint8_t *out, size_t *out_pos, size_t out_size) | 529 uint8_t *out, size_t *out_pos, size_t out_size) |
529 lzma_nothrow; | 530 lzma_nothrow; |
OLD | NEW |