Lines Matching +full:input +full:- +full:only
1 /* SPDX-License-Identifier: 0BSD */
35 * This is useful only if you need to extract the level from the preset
44 * Currently only one flag is defined.
51 * while improving the compression ratio only marginally. This is useful
56 * a little but only at the lowest preset levels (0-3).
72 * Decoder: Bitwise-or of zero or more of the decoder flags:
73 * - LZMA_TELL_NO_CHECK
74 * - LZMA_TELL_UNSUPPORTED_CHECK
75 * - LZMA_TELL_ANY_CHECK
76 * - LZMA_IGNORE_CHECK
77 * - LZMA_CONCATENATED
78 * - LZMA_FAIL_FAST
88 * \brief Encoder only: Maximum uncompressed size of a Block
94 * With LZMA2, a recommended block size is 2-4 times the LZMA2
98 * these are only recommendations for typical use cases; feel free
115 * Multithreading can make liblzma consume input and produce
116 * output in a very bursty way: it may first read a lot of input
117 * to fill internal buffers, then no input or output occurs for
120 * In single-threaded mode, lzma_code() won't return until it has
121 * either consumed all the input or filled the output buffer. If
134 * lzma_code() block until all the input is consumed or the output
143 * \brief Encoder only: Compression preset
146 * The preset is ignored if filters below is non-NULL.
151 * \brief Encoder only: Filter chain (alternative to a preset)
159 * \brief Encoder only: Integrity check type
206 * be met even in single-threaded mode, then decoding will continue
207 * in single-threaded mode and memlimit_threading may be exceeded
220 * a file; this will only reduce the number of threads.
233 * memory even in the single-threaded mode, then lzma_code() will
308 * the options -0 ... -9 of the xz command line tool.
309 * Additional flags can be set using bitwise-or with
318 * - LZMA_OK: Initialization succeeded. Use lzma_code() to
320 * - LZMA_MEM_ERROR: Memory allocation failed.
321 * - LZMA_OPTIONS_ERROR: The given compression preset is not
323 * - LZMA_UNSUPPORTED_CHECK: The given check type is not
325 * - LZMA_PROG_ERROR: One or more of the parameters have values
334 * \brief Single-call .xz Stream encoding using a preset number
345 * \param in Beginning of the input buffer
346 * \param in_size Size of the input buffer
349 * *out_pos is updated only if encoding succeeds.
354 * - LZMA_OK: Encoding was successful.
355 * - LZMA_BUF_ERROR: Not enough output buffer space.
356 * - LZMA_UNSUPPORTED_CHECK
357 * - LZMA_OPTIONS_ERROR
358 * - LZMA_MEM_ERROR
359 * - LZMA_DATA_ERROR
360 * - LZMA_PROG_ERROR
381 * - LZMA_OK: Initialization was successful.
382 * - LZMA_MEM_ERROR
383 * - LZMA_UNSUPPORTED_CHECK
384 * - LZMA_OPTIONS_ERROR
385 * - LZMA_PROG_ERROR
396 * requirements of single-threaded decompressor, you can use
397 * lzma_easy_decoder_memusage(options->preset) or
398 * lzma_raw_decoder_memusage(options->filters) to calculate
426 * - LZMA_OK
427 * - LZMA_MEM_ERROR
428 * - LZMA_UNSUPPORTED_CHECK
429 * - LZMA_OPTIONS_ERROR
430 * - LZMA_PROG_ERROR
469 * reason for the name of this function. The .lzma format supports only the
472 * Use this function if and only if you need to create files readable by
485 * - LZMA_OK
486 * - LZMA_MEM_ERROR
487 * - LZMA_OPTIONS_ERROR
488 * - LZMA_PROG_ERROR
496 * \brief Calculate output buffer size for single-call Stream encoder
499 * slightly bigger than the input data. This function calculates how much
511 * \note The limit calculated by this function applies only to
512 * single-call encoding. Multi-call encoding may (and probably
515 * calculate the maximum expansion of multi-call encoding.
518 * input data
527 * \brief Single-call .xz Stream encoder
536 * \param in Beginning of the input buffer
537 * \param in_size Size of the input buffer
540 * *out_pos is updated only if encoding succeeds.
545 * - LZMA_OK: Encoding was successful.
546 * - LZMA_BUF_ERROR: Not enough output buffer space.
547 * - LZMA_UNSUPPORTED_CHECK
548 * - LZMA_OPTIONS_ERROR
549 * - LZMA_MEM_ERROR
550 * - LZMA_DATA_ERROR
551 * - LZMA_PROG_ERROR
565 * has been replaced with bitwise-negation of the LZMA properties (lc/lp/pb).
579 * lzma_code() will try to encode as much input as is possible to fit into
580 * the given output buffer. If not all input can be encoded, the stream will
581 * be finished without encoding all the input. The caller must check both
582 * input and output buffer usage after lzma_code() (total_in and total_out
584 * buffer completely if there is a lot of input, but sometimes a few bytes
591 * re-initialization. A good value is bigger than the resulting
606 * - LZMA_STREAM_END: All good. Check the amounts of input used
607 * and output produced. Store the amount of input used
610 * - LZMA_OPTIONS_ERROR
611 * - LZMA_MEM_ERROR
612 * - LZMA_PROG_ERROR: In addition to the generic reasons for this
626 * This flag makes lzma_code() return LZMA_NO_CHECK if the input stream
635 * This flag makes lzma_code() return LZMA_UNSUPPORTED_CHECK if the input
657 * This flag only affects the checks of the compressed data itself; the CRC32
663 * - Trying to recover data from a corrupt .xz file.
665 * - Speeding up decompression, which matters mostly with SHA-256
678 * supported by liblzma, only the .xz and .lz formats allow concatenated
696 * due to timing randomness, if the same truncated or corrupt input is
701 * the decoder when no more input will be coming because it can help fast
708 * matches the single-threaded decoder and provides repeatable behavior
709 * with truncated or corrupt input. There are a few special cases where the
712 * Single-threaded decoders currently ignore this flag.
731 * \param flags Bitwise-or of zero or more of the decoder flags:
737 * - LZMA_OK: Initialization was successful.
738 * - LZMA_MEM_ERROR: Cannot allocate memory.
739 * - LZMA_OPTIONS_ERROR: Unsupported flags
740 * - LZMA_PROG_ERROR
752 * which are added by the multi-threaded encoder, see lzma_stream_encoder_mt().
754 * A Stream with one Block will only utilize one thread. A Stream with multiple
756 * single-threaded mode in the same way as done by lzma_stream_decoder().
757 * Concatenated Streams are processed one Stream at a time; no inter-Stream
760 * This function behaves like lzma_stream_decoder() when options->threads == 1
761 * and options->memlimit_threading <= 1.
768 * - LZMA_OK: Initialization was successful.
769 * - LZMA_MEM_ERROR: Cannot allocate memory.
770 * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached.
771 * - LZMA_OPTIONS_ERROR: Unsupported flags.
772 * - LZMA_PROG_ERROR
784 * lzma_lzip_decoder() once the type of the input file has been detected.
788 * If the flag LZMA_CONCATENATED is used and the input is a .lzma file:
802 * \param flags Bitwise-or of zero or more of the decoder flags:
808 * - LZMA_OK: Initialization was successful.
809 * - LZMA_MEM_ERROR: Cannot allocate memory.
810 * - LZMA_OPTIONS_ERROR: Unsupported flags
811 * - LZMA_PROG_ERROR
834 * - LZMA_OK
835 * - LZMA_MEM_ERROR
836 * - LZMA_PROG_ERROR
849 * - Files in the format version 0 were produced by lzip 1.3 and older.
855 * - lzip 1.3 added decompression support for .lz format version 1 files.
866 * The .lz format allows putting non-.lz data at the end of a file after at
869 * is relevant only when LZMA_CONCATENATED is used. In that case lzma_code()
871 * the first byte of the non-.lz data. An exception to this is if the first
872 * 1-3 bytes of the non-.lz data are identical to the .lz magic bytes
873 * (0x4C, 0x5A, 0x49, 0x50; "LZIP" in US-ASCII). In such a case the 1-3 bytes
874 * will have been ignored by lzma_code(). If one wishes to locate the non-.lz
883 * \param flags Bitwise-or of flags, or zero for no flags.
885 * although only LZMA_CONCATENATED and (in very rare
889 * is supported for consistency only as CRC32 is
893 * - LZMA_OK: Initialization was successful.
894 * - LZMA_MEM_ERROR: Cannot allocate memory.
895 * - LZMA_OPTIONS_ERROR: Unsupported flags
896 * - LZMA_PROG_ERROR
904 * \brief Single-call .xz Stream decoder
908 * modified if and only if LZMA_MEMLIMIT_ERROR is
910 * \param flags Bitwise-or of zero or more of the decoder flags:
917 * \param in Beginning of the input buffer
919 * *in_pos is updated only if decoding succeeds.
920 * \param in_size Size of the input buffer; the first byte that
924 * *out_pos is updated only if decoding succeeds.
929 * - LZMA_OK: Decoding was successful.
930 * - LZMA_FORMAT_ERROR
931 * - LZMA_OPTIONS_ERROR
932 * - LZMA_DATA_ERROR
933 * - LZMA_NO_CHECK: This can be returned only if using
935 * - LZMA_UNSUPPORTED_CHECK: This can be returned only if using
937 * - LZMA_MEM_ERROR
938 * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached.
940 * - LZMA_BUF_ERROR: Output buffer was too small.
941 * - LZMA_PROG_ERROR
957 * special behavior of lzma_code() applies to lzma_microlzma_encoder() only.
987 * - LZMA_OK
988 * - LZMA_MEM_ERROR
989 * - LZMA_OPTIONS_ERROR
990 * - LZMA_PROG_ERROR