mirror of
https://git.tukaani.org/xz.git
synced 2025-10-18 23:23:27 +00:00
55ba6e9300
The \mainpage command is used in the first block of comments in lzma.h. This changes the previously nearly empty index.html to use the first comment block in lzma.h for its contents. lzma.h is no longer documented separately, but this is for the better since lzma.h only defined a few macros that users do not need to use. The individual API header files all have a disclaimer that they should not be #included directly, so there should be no confusion on the fact that lzma.h should be the only header used by applications. Additionally, the note "See ../lzma.h for information about liblzma as a whole." was removed since lzma.h is now the main page of the generated HTML and does not have its own page anymore. So it would be confusing in the HTML version and was only a "nice to have" when browsing the source files.
97 lines
2.2 KiB
C
97 lines
2.2 KiB
C
/**
|
|
* \file lzma/delta.h
|
|
* \brief Delta filter
|
|
* \note Never include this file directly. Use <lzma.h> instead.
|
|
*/
|
|
|
|
/*
|
|
* Author: Lasse Collin
|
|
*
|
|
* This file has been put into the public domain.
|
|
* You can do whatever you want with this file.
|
|
*/
|
|
|
|
#ifndef LZMA_H_INTERNAL
|
|
# error Never include this file directly. Use <lzma.h> instead.
|
|
#endif
|
|
|
|
|
|
/**
|
|
* \brief Filter ID
|
|
*
|
|
* Filter ID of the Delta filter. This is used as lzma_filter.id.
|
|
*/
|
|
#define LZMA_FILTER_DELTA LZMA_VLI_C(0x03)
|
|
|
|
|
|
/**
|
|
* \brief Type of the delta calculation
|
|
*
|
|
* Currently only byte-wise delta is supported. Other possible types could
|
|
* be, for example, delta of 16/32/64-bit little/big endian integers, but
|
|
* these are not currently planned since byte-wise delta is almost as good.
|
|
*/
|
|
typedef enum {
|
|
LZMA_DELTA_TYPE_BYTE
|
|
} lzma_delta_type;
|
|
|
|
|
|
/**
|
|
* \brief Options for the Delta filter
|
|
*
|
|
* These options are needed by both encoder and decoder.
|
|
*/
|
|
typedef struct {
|
|
/** For now, this must always be LZMA_DELTA_TYPE_BYTE. */
|
|
lzma_delta_type type;
|
|
|
|
/**
|
|
* \brief Delta distance
|
|
*
|
|
* With the only currently supported type, LZMA_DELTA_TYPE_BYTE,
|
|
* the distance is as bytes.
|
|
*
|
|
* Examples:
|
|
* - 16-bit stereo audio: distance = 4 bytes
|
|
* - 24-bit RGB image data: distance = 3 bytes
|
|
*/
|
|
uint32_t dist;
|
|
|
|
/**
|
|
* \brief Minimum value for lzma_options_delta.dist.
|
|
*/
|
|
# define LZMA_DELTA_DIST_MIN 1
|
|
|
|
/**
|
|
* \brief Maximum value for lzma_options_delta.dist.
|
|
*/
|
|
# define LZMA_DELTA_DIST_MAX 256
|
|
|
|
/*
|
|
* Reserved space to allow possible future extensions without
|
|
* breaking the ABI. You should not touch these, because the names
|
|
* of these variables may change. These are and will never be used
|
|
* when type is LZMA_DELTA_TYPE_BYTE, so it is safe to leave these
|
|
* uninitialized.
|
|
*/
|
|
|
|
/** \private Reserved member. */
|
|
uint32_t reserved_int1;
|
|
|
|
/** \private Reserved member. */
|
|
uint32_t reserved_int2;
|
|
|
|
/** \private Reserved member. */
|
|
uint32_t reserved_int3;
|
|
|
|
/** \private Reserved member. */
|
|
uint32_t reserved_int4;
|
|
|
|
/** \private Reserved member. */
|
|
void *reserved_ptr1;
|
|
|
|
/** \private Reserved member. */
|
|
void *reserved_ptr2;
|
|
|
|
} lzma_options_delta;
|