container.h revision 207753
1/** 2 * \file lzma/container.h 3 * \brief File formats 4 */ 5 6/* 7 * Author: Lasse Collin 8 * 9 * This file has been put into the public domain. 10 * You can do whatever you want with this file. 11 * 12 * See ../lzma.h for information about liblzma as a whole. 13 */ 14 15#ifndef LZMA_H_INTERNAL 16# error Never include this file directly. Use <lzma.h> instead. 17#endif 18 19 20/************ 21 * Encoding * 22 ************/ 23 24/** 25 * \brief Default compression preset 26 * 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. 30 */ 31#define LZMA_PRESET_DEFAULT UINT32_C(6) 32 33 34/** 35 * \brief Mask for preset level 36 * 37 * This is useful only if you need to extract the level from the preset 38 * variable. That should be rare. 39 */ 40#define LZMA_PRESET_LEVEL_MASK UINT32_C(0x1F) 41 42 43/* 44 * Preset flags 45 * 46 * Currently only one flag is defined. 47 */ 48 49/** 50 * \brief Extreme compression preset 51 * 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. 55 * 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-2). 59 */ 60#define LZMA_PRESET_EXTREME (UINT32_C(1) << 31) 61 62 63/** 64 * \brief Calculate rough memory usage of easy encoder 65 * 66 * This function is a wrapper for lzma_raw_encoder_memusage(). 67 * 68 * \param preset Compression preset (level and possible flags) 69 */ 70extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset) 71 lzma_nothrow lzma_attr_pure; 72 73 74/** 75 * \brief Calculate rough decoder memory usage of a preset 76 * 77 * This function is a wrapper for lzma_raw_decoder_memusage(). 78 * 79 * \param preset Compression preset (level and possible flags) 80 */ 81extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset) 82 lzma_nothrow lzma_attr_pure; 83 84 85/** 86 * \brief Initialize .xz Stream encoder using a preset number 87 * 88 * This function is intended for those who just want to use the basic features 89 * if liblzma (that is, most developers out there). 90 * 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. If you are unsure, use LZMA_CHECK_CRC32. 101 * 102 * \return - LZMA_OK: Initialization succeeded. Use lzma_code() to 103 * encode your data. 104 * - LZMA_MEM_ERROR: Memory allocation failed. 105 * - LZMA_OPTIONS_ERROR: The given compression level is not 106 * supported by this build of liblzma. 107 * - LZMA_UNSUPPORTED_CHECK: The given check type is not 108 * supported by this liblzma build. 109 * - LZMA_PROG_ERROR: One or more of the parameters have values 110 * that will never be valid. For example, strm == NULL. 111 * 112 * If initialization fails (return value is not LZMA_OK), all the memory 113 * allocated for *strm by liblzma is always freed. Thus, there is no need 114 * to call lzma_end() after failed initialization. 115 * 116 * If initialization succeeds, use lzma_code() to do the actual encoding. 117 * Valid values for `action' (the second argument of lzma_code()) are 118 * LZMA_RUN, LZMA_SYNC_FLUSH, LZMA_FULL_FLUSH, and LZMA_FINISH. In future, 119 * there may be compression levels or flags that don't support LZMA_SYNC_FLUSH. 120 */ 121extern LZMA_API(lzma_ret) lzma_easy_encoder( 122 lzma_stream *strm, uint32_t preset, lzma_check check) 123 lzma_nothrow lzma_attr_warn_unused_result; 124 125 126/** 127 * \brief Single-call .xz Stream encoding using a preset number 128 * 129 * The maximum required output buffer size can be calculated with 130 * lzma_stream_buffer_bound(). 131 * 132 * \param preset Compression preset to use. See the description 133 * in lzma_easy_encoder(). 134 * \param check Type of the integrity check to calculate from 135 * uncompressed data. 136 * \param allocator lzma_allocator for custom allocator functions. 137 * Set to NULL to use malloc() and free(). 138 * \param in Beginning of the input buffer 139 * \param in_size Size of the input buffer 140 * \param out Beginning of the output buffer 141 * \param out_pos The next byte will be written to out[*out_pos]. 142 * *out_pos is updated only if encoding succeeds. 143 * \param out_size Size of the out buffer; the first byte into 144 * which no data is written to is out[out_size]. 145 * 146 * \return - LZMA_OK: Encoding was successful. 147 * - LZMA_BUF_ERROR: Not enough output buffer space. 148 * - LZMA_OPTIONS_ERROR 149 * - LZMA_MEM_ERROR 150 * - LZMA_DATA_ERROR 151 * - LZMA_PROG_ERROR 152 */ 153extern LZMA_API(lzma_ret) lzma_easy_buffer_encode( 154 uint32_t preset, lzma_check check, 155 lzma_allocator *allocator, const uint8_t *in, size_t in_size, 156 uint8_t *out, size_t *out_pos, size_t out_size) lzma_nothrow; 157 158 159/** 160 * \brief Initialize .xz Stream encoder using a custom filter chain 161 * 162 * \param strm Pointer to properly prepared lzma_stream 163 * \param filters Array of filters. This must be terminated with 164 * filters[n].id = LZMA_VLI_UNKNOWN. See filter.h for 165 * more information. 166 * \param check Type of the integrity check to calculate from 167 * uncompressed data. 168 * 169 * \return - LZMA_OK: Initialization was successful. 170 * - LZMA_MEM_ERROR 171 * - LZMA_OPTIONS_ERROR 172 * - LZMA_PROG_ERROR 173 */ 174extern LZMA_API(lzma_ret) lzma_stream_encoder(lzma_stream *strm, 175 const lzma_filter *filters, lzma_check check) 176 lzma_nothrow lzma_attr_warn_unused_result; 177 178 179/** 180 * \brief Initialize .lzma encoder (legacy file format) 181 * 182 * The .lzma format is sometimes called the LZMA_Alone format, which is the 183 * reason for the name of this function. The .lzma format supports only the 184 * LZMA1 filter. There is no support for integrity checks like CRC32. 185 * 186 * Use this function if and only if you need to create files readable by 187 * legacy LZMA tools such as LZMA Utils 4.32.x. Moving to the .xz format 188 * is strongly recommended. 189 * 190 * The valid action values for lzma_code() are LZMA_RUN and LZMA_FINISH. 191 * No kind of flushing is supported, because the file format doesn't make 192 * it possible. 193 * 194 * \return - LZMA_OK 195 * - LZMA_MEM_ERROR 196 * - LZMA_OPTIONS_ERROR 197 * - LZMA_PROG_ERROR 198 */ 199extern LZMA_API(lzma_ret) lzma_alone_encoder( 200 lzma_stream *strm, const lzma_options_lzma *options) 201 lzma_nothrow lzma_attr_warn_unused_result; 202 203 204/** 205 * \brief Calculate output buffer size for single-call Stream encoder 206 * 207 * When trying to compress uncompressible data, the encoded size will be 208 * slightly bigger than the input data. This function calculates how much 209 * output buffer space is required to be sure that lzma_stream_buffer_encode() 210 * doesn't return LZMA_BUF_ERROR. 211 * 212 * The calculated value is not exact, but it is guaranteed to be big enough. 213 * The actual maximum output space required may be slightly smaller (up to 214 * about 100 bytes). This should not be a problem in practice. 215 * 216 * If the calculated maximum size doesn't fit into size_t or would make the 217 * Stream grow past LZMA_VLI_MAX (which should never happen in practice), 218 * zero is returned to indicate the error. 219 * 220 * \note The limit calculated by this function applies only to 221 * single-call encoding. Multi-call encoding may (and probably 222 * will) have larger maximum expansion when encoding 223 * uncompressible data. Currently there is no function to 224 * calculate the maximum expansion of multi-call encoding. 225 */ 226extern LZMA_API(size_t) lzma_stream_buffer_bound(size_t uncompressed_size) 227 lzma_nothrow; 228 229 230/** 231 * \brief Single-call .xz Stream encoder 232 * 233 * \param filters Array of filters. This must be terminated with 234 * filters[n].id = LZMA_VLI_UNKNOWN. See filter.h 235 * for more information. 236 * \param check Type of the integrity check to calculate from 237 * uncompressed data. 238 * \param allocator lzma_allocator for custom allocator functions. 239 * Set to NULL to use malloc() and free(). 240 * \param in Beginning of the input buffer 241 * \param in_size Size of the input buffer 242 * \param out Beginning of the output buffer 243 * \param out_pos The next byte will be written to out[*out_pos]. 244 * *out_pos is updated only if encoding succeeds. 245 * \param out_size Size of the out buffer; the first byte into 246 * which no data is written to is out[out_size]. 247 * 248 * \return - LZMA_OK: Encoding was successful. 249 * - LZMA_BUF_ERROR: Not enough output buffer space. 250 * - LZMA_OPTIONS_ERROR 251 * - LZMA_MEM_ERROR 252 * - LZMA_DATA_ERROR 253 * - LZMA_PROG_ERROR 254 */ 255extern LZMA_API(lzma_ret) lzma_stream_buffer_encode( 256 lzma_filter *filters, lzma_check check, 257 lzma_allocator *allocator, const uint8_t *in, size_t in_size, 258 uint8_t *out, size_t *out_pos, size_t out_size) 259 lzma_nothrow lzma_attr_warn_unused_result; 260 261 262/************ 263 * Decoding * 264 ************/ 265 266/** 267 * This flag makes lzma_code() return LZMA_NO_CHECK if the input stream 268 * being decoded has no integrity check. Note that when used with 269 * lzma_auto_decoder(), all .lzma files will trigger LZMA_NO_CHECK 270 * if LZMA_TELL_NO_CHECK is used. 271 */ 272#define LZMA_TELL_NO_CHECK UINT32_C(0x01) 273 274 275/** 276 * This flag makes lzma_code() return LZMA_UNSUPPORTED_CHECK if the input 277 * stream has an integrity check, but the type of the integrity check is not 278 * supported by this liblzma version or build. Such files can still be 279 * decoded, but the integrity check cannot be verified. 280 */ 281#define LZMA_TELL_UNSUPPORTED_CHECK UINT32_C(0x02) 282 283 284/** 285 * This flag makes lzma_code() return LZMA_GET_CHECK as soon as the type 286 * of the integrity check is known. The type can then be got with 287 * lzma_get_check(). 288 */ 289#define LZMA_TELL_ANY_CHECK UINT32_C(0x04) 290 291 292/** 293 * This flag enables decoding of concatenated files with file formats that 294 * allow concatenating compressed files as is. From the formats currently 295 * supported by liblzma, only the .xz format allows concatenated files. 296 * Concatenated files are not allowed with the legacy .lzma format. 297 * 298 * This flag also affects the usage of the `action' argument for lzma_code(). 299 * When LZMA_CONCATENATED is used, lzma_code() won't return LZMA_STREAM_END 300 * unless LZMA_FINISH is used as `action'. Thus, the application has to set 301 * LZMA_FINISH in the same way as it does when encoding. 302 * 303 * If LZMA_CONCATENATED is not used, the decoders still accept LZMA_FINISH 304 * as `action' for lzma_code(), but the usage of LZMA_FINISH isn't required. 305 */ 306#define LZMA_CONCATENATED UINT32_C(0x08) 307 308 309/** 310 * \brief Initialize .xz Stream decoder 311 * 312 * \param strm Pointer to properly prepared lzma_stream 313 * \param memlimit Rough memory usage limit as bytes 314 * \param flags Bitwise-or of zero or more of the decoder flags: 315 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, 316 * LZMA_TELL_ANY_CHECK, LZMA_CONCATENATED 317 * 318 * \return - LZMA_OK: Initialization was successful. 319 * - LZMA_MEM_ERROR: Cannot allocate memory. 320 * - LZMA_OPTIONS_ERROR: Unsupported flags 321 */ 322extern LZMA_API(lzma_ret) lzma_stream_decoder( 323 lzma_stream *strm, uint64_t memlimit, uint32_t flags) 324 lzma_nothrow lzma_attr_warn_unused_result; 325 326 327/** 328 * \brief Decode .xz Streams and .lzma files with autodetection 329 * 330 * This decoder autodetects between the .xz and .lzma file formats, and 331 * calls lzma_stream_decoder() or lzma_alone_decoder() once the type 332 * of the input file has been detected. 333 * 334 * \param strm Pointer to properly prepared lzma_stream 335 * \param memlimit Rough memory usage limit as bytes 336 * \param flags Bitwise-or of flags, or zero for no flags. 337 * 338 * \return - LZMA_OK: Initialization was successful. 339 * - LZMA_MEM_ERROR: Cannot allocate memory. 340 * - LZMA_OPTIONS_ERROR: Unsupported flags 341 */ 342extern LZMA_API(lzma_ret) lzma_auto_decoder( 343 lzma_stream *strm, uint64_t memlimit, uint32_t flags) 344 lzma_nothrow lzma_attr_warn_unused_result; 345 346 347/** 348 * \brief Initialize .lzma decoder (legacy file format) 349 * 350 * Valid `action' arguments to lzma_code() are LZMA_RUN and LZMA_FINISH. 351 * There is no need to use LZMA_FINISH, but allowing it may simplify 352 * certain types of applications. 353 * 354 * \return - LZMA_OK 355 * - LZMA_MEM_ERROR 356 */ 357extern LZMA_API(lzma_ret) lzma_alone_decoder( 358 lzma_stream *strm, uint64_t memlimit) 359 lzma_nothrow lzma_attr_warn_unused_result; 360 361 362/** 363 * \brief Single-call .xz Stream decoder 364 * 365 * \param memlimit Pointer to how much memory the decoder is allowed 366 * to allocate. The value pointed by this pointer is 367 * modified if and only if LZMA_MEMLIMIT_ERROR is 368 * returned. 369 * \param flags Bitwise-or of zero or more of the decoder flags: 370 * LZMA_TELL_NO_CHECK, LZMA_TELL_UNSUPPORTED_CHECK, 371 * LZMA_CONCATENATED. Note that LZMA_TELL_ANY_CHECK 372 * is not allowed and will return LZMA_PROG_ERROR. 373 * \param allocator lzma_allocator for custom allocator functions. 374 * Set to NULL to use malloc() and free(). 375 * \param in Beginning of the input buffer 376 * \param in_pos The next byte will be read from in[*in_pos]. 377 * *in_pos is updated only if decoding succeeds. 378 * \param in_size Size of the input buffer; the first byte that 379 * won't be read is in[in_size]. 380 * \param out Beginning of the output buffer 381 * \param out_pos The next byte will be written to out[*out_pos]. 382 * *out_pos is updated only if encoding succeeds. 383 * \param out_size Size of the out buffer; the first byte into 384 * which no data is written to is out[out_size]. 385 * 386 * \return - LZMA_OK: Decoding was successful. 387 * - LZMA_FORMAT_ERROR 388 * - LZMA_OPTIONS_ERROR 389 * - LZMA_DATA_ERROR 390 * - LZMA_NO_CHECK: This can be returned only if using 391 * the LZMA_TELL_NO_CHECK flag. 392 * - LZMA_UNSUPPORTED_CHECK: This can be returned only if using 393 * the LZMA_TELL_UNSUPPORTED_CHECK flag. 394 * - LZMA_MEM_ERROR 395 * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached. 396 * The minimum required memlimit value was stored to *memlimit. 397 * - LZMA_BUF_ERROR: Output buffer was too small. 398 * - LZMA_PROG_ERROR 399 */ 400extern LZMA_API(lzma_ret) lzma_stream_buffer_decode( 401 uint64_t *memlimit, uint32_t flags, lzma_allocator *allocator, 402 const uint8_t *in, size_t *in_pos, size_t in_size, 403 uint8_t *out, size_t *out_pos, size_t out_size) 404 lzma_nothrow lzma_attr_warn_unused_result; 405