/**
- * \brief EROFS LZMA encoder
+ * \brief MicroLZMA encoder
*
- * The EROFS LZMA format is a raw LZMA stream whose first byte (always 0x00)
+ * The MicroLZMA format is a raw LZMA stream whose first byte (always 0x00)
* has been replaced with bitwise-negation of the LZMA properties (lc/lp/pb).
- * This encoding ensures that the first byte of EROFS LZMA stream is never
+ * This encoding ensures that the first byte of MicroLZMA stream is never
* 0x00. There is no end of payload marker and thus the uncompressed size
* must be stored separately. For the best error detection the dictionary
* size should be stored separately as well but alternatively one may use
* the uncompressed size as the dictionary size when decoding.
*
- * With the EROFS LZMA encoder, lzma_code() behaves slightly unusually.
- * The action argument must be LZMA_FINISH and the return value cannot be
+ * With the MicroLZMA encoder, lzma_code() behaves slightly unusually.
+ * The action argument must be LZMA_FINISH and the return value will never be
* LZMA_OK. Thus the encoding is always done with a single lzma_code() after
* the initialization. The benefit of the combination of initialization
* function and lzma_code() is that memory allocations can be re-used for
* size is 4 KiB, dictionary size of 32 KiB or 64 KiB is good. If the
* data compresses extremely well, even 128 KiB may be useful.
*
+ * The MicroLZMA format and this encoder variant were made with the EROFS
+ * file system in mind. This format may be convenient in other embedded
+ * uses too where many small streams are needed. XZ Embedded includes a
+ * decoder for this format.
+ *
* \return - LZMA_STREAM_END: All good. Check the amounts of input used
* and output produced. Store the amount of input used
* (uncompressed size) as it needs to be known to decompress
* - LZMA_MEM_ERROR
* - LZMA_PROG_ERROR: In addition to the generic reasons for this
* error code, this may also be returned if there isn't enough
- * output space (6 bytes) to create a valid EROFS LZMA stream.
+ * output space (6 bytes) to create a valid MicroLZMA stream.
*/
-extern LZMA_API(lzma_ret) lzma_erofs_encoder(
+extern LZMA_API(lzma_ret) lzma_microlzma_encoder(
lzma_stream *strm, const lzma_options_lzma *options);
/**
- * \brief EROFS LZMA decoder
+ * \brief MicroLZMA decoder
*
- * See lzma_erofs_decoder() for more information.
+ * See lzma_microlzma_decoder() for more information.
*
- * The lzma_code() usage with this decoder is completely normal.
- * The special behavior of lzma_code() applies to lzma_erofs_encoder() only.
+ * The lzma_code() usage with this decoder is completely normal. The
+ * special behavior of lzma_code() applies to lzma_microlzma_encoder() only.
*
* \param strm Pointer to properly prepared lzma_stream
- * \param comp_size Compressed size of the EROFS LZMA stream.
+ * \param comp_size Compressed size of the MicroLZMA stream.
* The caller must somehow know this exactly.
- * \param uncomp_size Uncompressed size of the EROFS LZMA stream.
+ * \param uncomp_size Uncompressed size of the MicroLZMA stream.
* If the exact uncompressed size isn't known, this
* can be set to a value that is at most as big as
* the exact uncompressed size would be, but then the
* affect the memory usage if one specifies bigger
* dictionary than actually required.)
*/
-extern LZMA_API(lzma_ret) lzma_erofs_decoder(
+extern LZMA_API(lzma_ret) lzma_microlzma_decoder(
lzma_stream *strm, uint64_t comp_size,
uint64_t uncomp_size, lzma_bool uncomp_size_is_exact,
uint32_t dict_size);
common/easy_buffer_encoder.c \
common/easy_encoder.c \
common/easy_encoder_memusage.c \
- common/erofs_encoder.c \
+ common/microlzma_encoder.c \
common/filter_buffer_encoder.c \
common/filter_encoder.c \
common/filter_encoder.h \
common/block_decoder.h \
common/block_header_decoder.c \
common/easy_decoder_memusage.c \
- common/erofs_decoder.c \
+ common/microlzma_decoder.c \
common/file_info.c \
common/filter_buffer_decoder.c \
common/filter_decoder.c \
///////////////////////////////////////////////////////////////////////////////
//
-/// \file erofs_decoder.c
-/// \brief Decode EROFS LZMA format
+/// \file microlzma_decoder.c
+/// \brief Decode MicroLZMA format
//
// Author: Lasse Collin
//
/// uncomp_size may never be bigger than the real uncompressed size.
bool uncomp_size_is_exact;
- /// True once the first byte of the EROFS LZMA stream
+ /// True once the first byte of the MicroLZMA stream
/// has been processed.
bool props_decoded;
-} lzma_erofs_coder;
+} lzma_microlzma_coder;
static lzma_ret
-erofs_decode(void *coder_ptr, const lzma_allocator *allocator,
+microlzma_decode(void *coder_ptr, const lzma_allocator *allocator,
const uint8_t *restrict in, size_t *restrict in_pos,
size_t in_size, uint8_t *restrict out,
size_t *restrict out_pos, size_t out_size, lzma_action action)
{
- lzma_erofs_coder *coder = coder_ptr;
+ lzma_microlzma_coder *coder = coder_ptr;
// Remember the in start position so that we can update comp_size.
const size_t in_start = *in_pos;
static void
-erofs_decoder_end(void *coder_ptr, const lzma_allocator *allocator)
+microlzma_decoder_end(void *coder_ptr, const lzma_allocator *allocator)
{
- lzma_erofs_coder *coder = coder_ptr;
+ lzma_microlzma_coder *coder = coder_ptr;
lzma_next_end(&coder->lzma, allocator);
lzma_free(coder, allocator);
return;
static lzma_ret
-erofs_decoder_init(lzma_next_coder *next, const lzma_allocator *allocator,
+microlzma_decoder_init(lzma_next_coder *next, const lzma_allocator *allocator,
uint64_t comp_size,
uint64_t uncomp_size, bool uncomp_size_is_exact,
uint32_t dict_size)
{
- lzma_next_coder_init(&erofs_decoder_init, next, allocator);
+ lzma_next_coder_init(µlzma_decoder_init, next, allocator);
- lzma_erofs_coder *coder = next->coder;
+ lzma_microlzma_coder *coder = next->coder;
if (coder == NULL) {
- coder = lzma_alloc(sizeof(lzma_erofs_coder), allocator);
+ coder = lzma_alloc(sizeof(lzma_microlzma_coder), allocator);
if (coder == NULL)
return LZMA_MEM_ERROR;
next->coder = coder;
- next->code = &erofs_decode;
- next->end = &erofs_decoder_end;
+ next->code = µlzma_decode;
+ next->end = µlzma_decoder_end;
coder->lzma = LZMA_NEXT_CODER_INIT;
}
extern LZMA_API(lzma_ret)
-lzma_erofs_decoder(lzma_stream *strm, uint64_t comp_size,
+lzma_microlzma_decoder(lzma_stream *strm, uint64_t comp_size,
uint64_t uncomp_size, lzma_bool uncomp_size_is_exact,
uint32_t dict_size)
{
- lzma_next_strm_init(erofs_decoder_init, strm, comp_size,
+ lzma_next_strm_init(microlzma_decoder_init, strm, comp_size,
uncomp_size, uncomp_size_is_exact, dict_size);
strm->internal->supported_actions[LZMA_RUN] = true;
///////////////////////////////////////////////////////////////////////////////
//
-/// \file erofs_encoder.c
-/// \brief Encode into EROFS LZMA format
+/// \file microlzma_encoder.c
+/// \brief Encode into MicroLZMA format
//
// Author: Lasse Collin
//
/// LZMA properties byte (lc/lp/pb)
uint8_t props;
-} lzma_erofs_coder;
+} lzma_microlzma_coder;
static lzma_ret
-erofs_encode(void *coder_ptr, const lzma_allocator *allocator,
+microlzma_encode(void *coder_ptr, const lzma_allocator *allocator,
const uint8_t *restrict in, size_t *restrict in_pos,
size_t in_size, uint8_t *restrict out,
size_t *restrict out_pos, size_t out_size, lzma_action action)
{
- lzma_erofs_coder *coder = coder_ptr;
+ lzma_microlzma_coder *coder = coder_ptr;
// Remember *out_pos so that we can overwrite the first byte with
// the LZMA properties byte.
static void
-erofs_encoder_end(void *coder_ptr, const lzma_allocator *allocator)
+microlzma_encoder_end(void *coder_ptr, const lzma_allocator *allocator)
{
- lzma_erofs_coder *coder = coder_ptr;
+ lzma_microlzma_coder *coder = coder_ptr;
lzma_next_end(&coder->lzma, allocator);
lzma_free(coder, allocator);
return;
static lzma_ret
-erofs_encoder_init(lzma_next_coder *next, const lzma_allocator *allocator,
+microlzma_encoder_init(lzma_next_coder *next, const lzma_allocator *allocator,
const lzma_options_lzma *options)
{
- lzma_next_coder_init(&erofs_encoder_init, next, allocator);
+ lzma_next_coder_init(µlzma_encoder_init, next, allocator);
- lzma_erofs_coder *coder = next->coder;
+ lzma_microlzma_coder *coder = next->coder;
if (coder == NULL) {
- coder = lzma_alloc(sizeof(lzma_erofs_coder), allocator);
+ coder = lzma_alloc(sizeof(lzma_microlzma_coder), allocator);
if (coder == NULL)
return LZMA_MEM_ERROR;
next->coder = coder;
- next->code = &erofs_encode;
- next->end = &erofs_encoder_end;
+ next->code = µlzma_encode;
+ next->end = µlzma_encoder_end;
coder->lzma = LZMA_NEXT_CODER_INIT;
}
extern LZMA_API(lzma_ret)
-lzma_erofs_encoder(lzma_stream *strm, const lzma_options_lzma *options)
+lzma_microlzma_encoder(lzma_stream *strm, const lzma_options_lzma *options)
{
- lzma_next_strm_init(erofs_encoder_init, strm, options);
+ lzma_next_strm_init(microlzma_encoder_init, strm, options);
strm->internal->supported_actions[LZMA_FINISH] = true;
projects / thirdparty / xz.git / commitdiff
