* documented in the man page for @b wimlib-imagex.
*
* - The old WIM format from Vista pre-releases is not supported.
- * - Compressed resource chunk sizes other than 32768 are not supported. This
- * doesn't seem to be a real problem because the chunk size always seems to be
- * this value.
* - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
* functionality other than that already present in @b ImageX, that allows you
* to make certain Windows-specific modifications to a Windows PE image, such
/** Compressed resources in the WIM use XPRESS compression. */
WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
- /** Compressed resources in the WIM use LZMS compression. Currently,
- * wimlib has a decompressor for this format but not a compressor. LZMS
+ /** Compressed resources in the WIM use LZMS compression. Note: LZMS
* compression is only compatible with wimlib v1.6.0 and later and with
* WIMGAPI Windows 8 and later (and some restrictions apply on the
* latter). */
#define WIMLIB_WRITE_FLAG_RESERVED 0x00000800
-/** When writing streams in the resulting WIM file, pack multiple streams into a
+/**
+ * When writing streams in the resulting WIM file, pack multiple streams into a
* single WIM resource instead of compressing them independently. This tends to
* produce a better compression ratio at the cost of less random access.
- * Furthermore, WIMs created with this flag are only compatible with wimlib
- * v1.6.0 or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup
- * only and <b>not including ImageX and Dism</b>. WIMs created with this flag
- * use version number 3584 in their header instead of 68864. If this flag is
- * passed to wimlib_overwrite() and the WIM did not previously contain packed
- * streams, the WIM's version number will be changed to 3584 and the new streams
- * will be written packed. */
+ * However, WIMs created with this flag are only compatible with wimlib v1.6.0
+ * or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup only and
+ * <b>not including ImageX and Dism</b>. WIMs created with this flag must use
+ * version number 3584 in their header instead of 68864.
+ *
+ * If this flag is passed to wimlib_overwrite() and the WIM did not previously
+ * contain packed streams, the WIM's version number will be changed to 3584 and
+ * the new streams will be written packed. Use ::WIMLIB_WRITE_FLAG_REBUILD to
+ * force the WIM to be fully rebuilt. */
#define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
-/** Compress all streams independently. This produces a WIM optimized for
- * random access and compatibility, as noted in the documentation for
- * ::WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS. For wimlib_write(), this is the
- * default behavior. For wimlib_overwrite(), this is the default if the WIM file
- * did not already contain packed streams. Also, for wimlib_overwrite(), if the
- * WIM already contained packed streams, specifying this flag but not
- * ::WIMLIB_WRITE_FLAG_REBUILD will cause new streams to be written unpacked,
- * but the WIM itself will not be rebuilt and may still contain packed streams.
- */
-#define WIMLIB_WRITE_FLAG_NO_PACK_STREAMS 0x00002000
-
/** @} */
/** @ingroup G_general
* @{ */
* increased compression chunk size is limited by the size of each file being
* compressed.
*
- * <b>WARNING: Changing the compression chunk size to any value other than the
- * default of 32768 bytes eliminates compatibility with Microsoft's software,
- * except when increasing the XPRESS chunk size before Windows 8. Chunk sizes
- * other than 32768 are also incompatible with wimlib v1.5.3 and earlier.</b>
+ * <b>WARNING: Microsoft's software is seemingly incompatible with LZX chunk
+ * sizes other than 32768. Chunk sizes other than 32768 (for any format) are
+ * also incompatible with wimlib v1.5.3 and earlier.</b>
*
* @param wim
* ::WIMStruct for a WIM.
* on the compression format. The XPRESS compression format supports chunk
* sizes that are powers of 2 with exponents between 15 and 26 inclusively,
* whereas the LZX compression format supports chunk sizes that are powers
- * of 2 with exponents between 15 and 21 inclusively.
+ * of 2 with exponents between 15 and 21 inclusively. As a special case,
+ * if @p out_chunk_size is specified as 0, the chunk size is set to the
+ * default for the currently selected output compression type.
*
* @return 0 on success; nonzero on error.
*
extern int
wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
+/**
+ * @ingroup G_writing_and_overwriting_wims
+ *
+ * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
+ * packed streams.
+ */
+extern int
+wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
+
/**
* @ingroup G_writing_and_overwriting_wims
*
*
* @return 0 on success; nonzero on error.
*
- * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
* @p ctype did not specify a valid compression type.
*/
extern int
wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
+/**
+ * @ingroup G_writing_and_overwriting_wims
+ *
+ * Similar to wimlib_set_output_compression_type(), but set the compression type
+ * for writing packed streams.
+ */
+extern int
+wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
+
/**
* @ingroup G_modifying_wims
*
* A function equivalent to @c realloc() that wimlib will use to reallocate
* memory. If @c NULL, the free function is set back to the default @c
* realloc() from the C library.
- * @return 0 on success; nonzero on error.
- * @retval ::WIMLIB_ERR_UNSUPPORTED
- * wimlib was compiled with the @c --without-custom-memory-allocator flag,
- * so custom memory allocators are unsupported.
+ * @return 0
*/
extern int
wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
* decompressors currently support sliding windows, and there also exist
* slightly different variants of these formats that are not supported
* unmodified.
- *
+ */
+
+/**
+ * @ingroup G_compression
* @{
*/
struct wimlib_compressor_params_header {
/** Size of the parameters, in bytes. */
uint32_t size;
-
- uint32_t reserved;
};
/** Header for decompression parameters to pass to wimlib_create_decompressor()
struct wimlib_decompressor_params_header {
/** Size of the parameters, in bytes. */
uint32_t size;
-
- uint32_t reserved;
};
/** LZX compression parameters that can optionally be passed to
struct wimlib_decompressor;
/**
- * @ingroup G_compression
- *
* Set the default compression parameters for the specified compression type.
* This will affect both explicit and wimlib-internal calls to
* wimlib_create_compressor().
* @param ctype
* Compression type for which to set the default compression parameters.
* @param params
- * Compression-type specific parameters. This may be @ NULL, in which case
- * the "default default" parameters are restored.
+ * Compression-type specific parameters. This may be @c NULL, in which
+ * case the "default default" parameters are restored.
*
* @return 0 on success; nonzero on error.
*
* @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
* @p ctype was not a supported compression type.
+ * @retval ::WIMLIB_ERR_NOMEM
+ * Not enough memory to duplicate the parameters (perhaps @c params->size
+ * was invalid).
*/
extern int
wimlib_set_default_compressor_params(enum wimlib_compression_type ctype,
const struct wimlib_compressor_params_header *params);
/**
- * @ingroup G_compression
- *
* Allocate a compressor for the specified compression type using the specified
* parameters.
*
struct wimlib_compressor **compressor_ret);
/**
- * @ingroup G_compression
- *
* Losslessly compress a block of data using a compressor previously created
* with wimlib_create_compressor().
*
* @param compressed_data
* Buffer into which to write the compressed data.
* @param compressed_size_avail
- * Number of bytes available in @compressed_data.
+ * Number of bytes available in @p compressed_data.
* @param compressor
* A compressor previously allocated with wimlib_create_compressor().
*
* @return
* The size of the compressed data, in bytes, or 0 if the input data could
- * not be compressed to @compressed_size_avail or fewer bytes.
+ * not be compressed to @p compressed_size_avail or fewer bytes.
*/
extern size_t
wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
struct wimlib_compressor *compressor);
/**
- * @ingroup G_compression
- *
* Free a compressor previously allocated with wimlib_create_compressor().
*
* @param compressor
wimlib_free_compressor(struct wimlib_compressor *compressor);
/**
- * @ingroup G_compression
- *
* Set the default decompression parameters for the specified compression type.
* This will affect both explicit and wimlib-internal calls to
* wimlib_create_decompressor().
* @param ctype
* Compression type for which to set the default decompression parameters.
* @param params
- * Compression-type specific parameters. This may be @ NULL, in which case
- * the "default default" parameters are restored.
+ * Compression-type specific parameters. This may be @c NULL, in which
+ * case the "default default" parameters are restored.
*
* @return 0 on success; nonzero on error.
*
* @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
* @p ctype was not a supported compression type.
+ * @retval ::WIMLIB_ERR_NOMEM
+ * Not enough memory to duplicate the parameters (perhaps @c params->size
+ * was invalid).
*/
extern int
wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype,
const struct wimlib_decompressor_params_header *params);
/**
- * @ingroup G_compression
- *
* Allocate a decompressor for the specified compression type using the
* specified parameters.
*
struct wimlib_decompressor **decompressor_ret);
/**
- * @ingroup G_compression
- *
* Decompress a block of data using a decompressor previously created with
* wimlib_create_decompressor().
*
struct wimlib_decompressor *decompressor);
/**
- * @ingroup G_compression
- *
* Free a decompressor previously allocated with wimlib_create_decompressor().
*
* @param decompressor
wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
+struct wimlib_lzx_params_old;
+struct wimlib_lzx_context_old;
+
+/** Deprecated; do not use. */
+extern int
+wimlib_lzx_set_default_params(const struct wimlib_lzx_params_old *params)
+ _wimlib_deprecated;
+
+/** Deprecated; do not use. */
+extern int
+wimlib_lzx_alloc_context(const struct wimlib_lzx_params_old *params,
+ struct wimlib_lzx_context_old **ctx_pp)
+ _wimlib_deprecated;
+
+/** Deprecated; do not use. */
+extern void
+wimlib_lzx_free_context(struct wimlib_lzx_context_old *ctx)
+ _wimlib_deprecated;
+
+/** Deprecated; do not use. */
+extern unsigned
+wimlib_lzx_compress2(const void *udata, unsigned ulen, void *cdata,
+ struct wimlib_lzx_context_old *ctx)
+ _wimlib_deprecated;
+
+/** Deprecated; do not use. */
+extern unsigned
+wimlib_lzx_compress(const void *udata, unsigned ulen, void *cdata)
+ _wimlib_deprecated;
+
+/** Deprecated; do not use. */
+extern unsigned
+wimlib_xpress_compress(const void *udata, unsigned ulen, void *cdata)
+ _wimlib_deprecated;
+
+/** Deprecated; do not use. */
+extern int
+wimlib_lzx_decompress(const void *cdata, unsigned clen,
+ void *udata, unsigned ulen)
+ _wimlib_deprecated;
+
+/** Deprecated; do not use. */
+extern int
+wimlib_xpress_decompress(const void *cdata, unsigned clen,
+ void *udata, unsigned ulen)
+ _wimlib_deprecated;
+
+/** @} */
+
+
+
#ifdef __cplusplus
}
#endif
git://wimlib.net / wimlib / blobdiff