src/liblzma/api/lzma/container.h

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