X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=include%2Fwimlib.h;h=4ac826a5da4b9c2db97454fde3f886cf84259ae3;hp=7d39ba646c922230c6419045c515f0aecc8423ef;hb=91b0f909393476f39ed5865dfe4b27c244ba3c48;hpb=b7071062542143113ad654d89ee6b0603b23b524 diff --git a/include/wimlib.h b/include/wimlib.h index 7d39ba64..4ac826a5 100644 --- a/include/wimlib.h +++ b/include/wimlib.h @@ -31,28 +31,45 @@ /** * @mainpage * - * @section sec_intro Introduction - * - * This is the documentation for the library interface of wimlib 1.7.0, a C + * This is the documentation for the library interface of wimlib 1.7.1, a C * library for creating, modifying, extracting, and mounting files in the * Windows Imaging Format. This documentation is intended for developers only. * If you have installed wimlib and want to know how to use the @b wimlib-imagex - * program, please see the README file or manual pages. + * program, please see the manual pages and also the README + * file. * - * @section sec_installing_and_compiling Installing and Compiling + * @section sec_installing Installing * - * wimlib uses the GNU autotools, so, on UNIX-like systems, it should be easy to - * install with configure && make && sudo make install; however, - * please see the README for more information about installing it. + * @subsection UNIX * - * To use wimlib in your program after installing it, include wimlib.h and link - * your program with @c -lwim. + * Download the source code from http://sourceforge.net/projects/wimlib/files. + * Install the library by running configure && make && sudo make install. + * See the README for information about configuration options. To use wimlib in + * your program after installing it, include wimlib.h and link your program with + * -lwim. * - * As of wimlib 1.5.0, wimlib.h is also compatible with C++. + * @subsection Windows * - * Note: before calling any other function declared in wimlib.h, - * wimlib_global_init() can (and in some cases, must) be called. See its - * documentation for more details. + * Download the Windows binary distribution with the appropriate architecture + * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from http://sourceforge.net/projects/wimlib/files. + * Link your program with the libwim-15.dll file. Make sure to also download + * the source code so you can get wimlib.h, as it is not included in the binary + * distribution. If you need to access the DLL from other programming + * languages, note that the calling convention is "cdecl". + * + * @section sec_examples Examples + * + * Several examples are located in the examples + * directory of the source distribution. + * + * There is also the + * source code of wimlib-imagex, which is complicated but uses most + * capabilities of wimlib. * * @section sec_basic_wim_handling_concepts Basic WIM handling concepts * @@ -88,6 +105,10 @@ * you can make multiple changes to a WIM and commit them all to the underlying * file in only one overwrite operation, which is more efficient. * + * Note: before calling any other function declared in wimlib.h, + * wimlib_global_init() can (and in some cases, must) be called. See its + * documentation for more details. + * * @section sec_cleaning_up Cleaning up * * After you are done with any ::WIMStruct, you can call wimlib_free() to free @@ -312,17 +333,17 @@ * @brief Write and overwrite on-disk WIM files. * * As described in @ref sec_basic_wim_handling_concepts, these functions are - * critical to the design of the library as they allow new or modified WIMs to - * actually be written to on-disk files. Generally, wimlib_write() is the - * function you need to call to write a new WIM file, and wimlib_overwrite() is - * the function you need to call to persistently update an existing WIM file. + * fundamental to the design of the library as they allow new or modified + * ::WIMStruct's to actually be written to on-disk files. Call wimlib_write() + * to write a new WIM file, or wimlib_overwrite() to persistently update an + * existing WIM file. */ /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs * * @brief Create and handle non-standalone WIMs, such as split and delta WIMs. * - * Normally, ::WIMStruct represents a WIM file, but there's a bit more to it + * Normally, a ::WIMStruct represents a WIM file, but there's a bit more to it * than that. Normally, WIM files are "standalone". However, WIM files can * also be arranged in non-standalone ways, such as a set of on-disk files that * together form a single "split WIM" or "delta WIM". Such arrangements are @@ -346,7 +367,13 @@ #include #include -/** @ingroup G_general +#ifdef __GNUC__ +# define _wimlib_deprecated __attribute__((deprecated)) +#else +# define _wimlib_deprecated +#endif + +/** @addtogroup G_general * @{ */ /** Major version of the library (for example, the 1 in 1.2.5). */ @@ -356,16 +383,12 @@ #define WIMLIB_MINOR_VERSION 7 /** Patch version of the library (for example, the 5 in 1.2.5). */ -#define WIMLIB_PATCH_VERSION 0 +#define WIMLIB_PATCH_VERSION 1 #ifdef __cplusplus extern "C" { #endif -/** @} */ -/** @ingroup G_general - * @{ */ - /** * Opaque structure that represents a WIM file. This is an in-memory structure * and need not correspond to a specific on-disk file. However, a ::WIMStruct @@ -394,11 +417,13 @@ typedef char wimlib_tchar; #endif #ifdef __WIN32__ -/** Path separator for WIM paths passed back to progress callbacks. */ +/** Path separator for WIM paths passed back to progress callbacks. + * This is forward slash on UNIX and backslash on Windows. */ # define WIMLIB_WIM_PATH_SEPARATOR '\\' # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\" #else -/** Path separator for WIM paths passed back to progress callbacks. */ +/** Path separator for WIM paths passed back to progress callbacks. + * This is forward slash on UNIX and backslash on Windows. */ # define WIMLIB_WIM_PATH_SEPARATOR '/' # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/" #endif @@ -412,39 +437,54 @@ typedef char wimlib_tchar; ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \ (path)[1] == 0) -#ifdef __GNUC__ -# define _wimlib_deprecated __attribute__((deprecated)) -#else -# define _wimlib_deprecated -#endif - +/** Length of a Globally Unique Identifier (GUID) */ #define WIMLIB_GUID_LEN 16 /** - * Specifies the compression type of a WIM file. + * Specifies a compression format. Pass one of these values to + * wimlib_create_new_wim(), wimlib_create_compressor(), or + * wimlib_create_decompressor(). + * + * A WIM file has one default compression type and chunk size. Normally, each + * resource is compressed with this compression type. However, resources may be + * stored as uncompressed. In addition, a WIM with the new version number of + * 3584, or "ESD file", might contain solid blocks with different compression + * types. */ enum wimlib_compression_type { - /** An invalid compression type. */ - WIMLIB_COMPRESSION_TYPE_INVALID = -1, - - /** The WIM does not include any compressed resources. */ + /** No compression. */ WIMLIB_COMPRESSION_TYPE_NONE = 0, - /** Compressed resources in the WIM use XPRESS compression. */ + /** The XPRESS compression format. This format combines Lempel-Ziv + * factorization with Huffman encoding. Compression and decompression + * are both fast. This format supports chunk sizes that are powers of 2 + * between 2^12 and 2^16, inclusively. */ WIMLIB_COMPRESSION_TYPE_XPRESS = 1, - /** Compressed resources in the WIM use LZX compression. */ + /** The LZX compression format. This format combines Lempel-Ziv + * factorization with Huffman encoding, but with more features and + * complexity than XPRESS. Compression is slow to somewhat fast, + * depending on the settings. Decompression is fast but slower than + * XPRESS. This format supports chunk sizes that are powers of 2 + * between 2^15 and 2^21, inclusively. Note: chunk sizes + * other than 2^15 are not compatible with the Microsoft + * implementation. */ WIMLIB_COMPRESSION_TYPE_LZX = 2, - /** 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). */ + /** The LZMS compression format. This format combines Lempel-Ziv + * factorization with adaptive Huffman encoding and range coding. + * Compression and decompression are both fairly slow. This format + * supports chunk sizes that are powers of 2 between 2^15 and + * 2^30, inclusively. This format is best used for large chunk + * sizes. Note: LZMS compression is only compatible with wimlib v1.6.0 + * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and + * later. Also, chunk sizes larger than 2^26 are not compatible + * with the Microsoft implementation. */ WIMLIB_COMPRESSION_TYPE_LZMS = 3, }; /** @} */ -/** @ingroup G_progress +/** @addtogroup G_progress * @{ */ /** Possible values of the first parameter to the user-supplied @@ -571,14 +611,21 @@ enum wimlib_progress_msg { /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and * a file is being extracted normally (not as a WIMBoot "pointer file") * due to it matching a pattern in the [PrepopulateList] section of the - * configuration file \Windows\System32\WimBootCompress.ini in the WIM - * image. @p info will point to ::wimlib_progress_info.wimboot_exclude. + * configuration file @c \\Windows\\System32\\WimBootCompress.ini in the + * WIM image. @p info will point to + * ::wimlib_progress_info.wimboot_exclude. */ WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24, /** Starting to unmount a WIM image. @p info will point to * ::wimlib_progress_info.unmount. */ WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25, + + /** wimlib has used a file's data for the last time (including all data + * streams, if it has multiple). @p info will point to + * ::wimlib_progress_info.done_with_file. This message is only received + * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */ + WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26, }; /** Valid return values from user-provided progress functions @@ -598,7 +645,8 @@ enum wimlib_progress_status { WIMLIB_PROGRESS_STATUS_ABORT = 1, }; -/** A pointer to this union is passed to the user-supplied +/** + * A pointer to this union is passed to the user-supplied * ::wimlib_progress_func_t progress function. One (or none) of the structures * contained in this union will be applicable for the operation * (::wimlib_progress_msg) indicated in the first argument to the progress @@ -716,14 +764,6 @@ union wimlib_progress_info { * unsupported (e.g. an encrypted or device file). */ WIMLIB_SCAN_DENTRY_UNSUPPORTED, - /** The file is an absolute symbolic link or junction - * point and it is being excluded from capture because - * it points outside of the capture directory and - * reparse-point fixups are enabled. (Reparse point - * fixups can be disabled by using the flag - * ::WIMLIB_ADD_FLAG_NORPFIX.) */ - WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK, - /** The file is an absolute symbolic link or junction * that points into the capture directory, and * reparse-point fixups are enabled, so its target is @@ -731,6 +771,12 @@ union wimlib_progress_info { * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.) */ WIMLIB_SCAN_DENTRY_FIXED_SYMLINK, + + /** Reparse-point fixups are enabled, but the file is an + * absolute symbolic link or junction that does + * not point into the capture directory, so its + * target is not being adjusted. */ + WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, } status; union { @@ -740,9 +786,9 @@ union wimlib_progress_info { const wimlib_tchar *wim_target_path; /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status - * of @p WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK or @p - * WIMLIB_SCAN_DENTRY_FIXED_SYMLINK, this is the target - * of the absolute symbolic link or junction. */ + * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p + * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the + * target of the absolute symbolic link or junction. */ const wimlib_tchar *symlink_target; }; @@ -849,10 +895,11 @@ union wimlib_progress_info { * potentially multiple streams per file (named data streams). * A "stream" may be the default contents of a file, a named * data stream, or a reparse data buffer. */ - uint64_t num_streams; + uint64_t total_streams; - /** Reserved. */ - const wimlib_tchar *reserved_2; + /** Number of (not necessarily unique) streams that have been + * extracted so far. */ + uint64_t completed_streams; /** Currently only used for * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */ @@ -984,6 +1031,28 @@ union wimlib_progress_info { /** Flags passed to wimlib_unmount_image(). */ uint32_t unmount_flags; } unmount; + + /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */ + struct wimlib_progress_info_done_with_file { + /* Path to the file whose data has been written to the WIM file, + * or is currently being asynchronously compressed in memory, + * and therefore is no longer needed by wimlib. + * + * WARNING: The file data will not actually be accessible in the + * WIM file until the WIM file has been completely written. + * Ordinarily you should not treat this message as a + * green light to go ahead and delete the specified file, since + * that would result in data loss if the WIM file cannot be + * successfully created for any reason. + * + * If a file has multiple names (hard links), + * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received + * for one name. Also, this message will not be received for + * empty files or reparse points (or symbolic links), unless + * they have nonempty named data streams. + */ + const wimlib_tchar *path_to_file; + } done_with_file; }; /** @@ -1010,7 +1079,7 @@ typedef enum wimlib_progress_status void *progctx); /** @} */ -/** @ingroup G_modifying_wims +/** @addtogroup G_modifying_wims * @{ */ /** An array of these structures is passed to wimlib_add_image_multisource() to @@ -1055,8 +1124,11 @@ struct wimlib_capture_source { #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008 /** @} */ -/** @ingroup G_wim_information - * @{ */ + +/** @addtogroup G_wim_information + * { */ + +/** @{ */ /** General information about a WIM file. */ struct wimlib_wim_info { @@ -1188,7 +1260,7 @@ struct wimlib_resource_entry { uint64_t reserved[2]; }; -/** A stream of a file in the WIM. */ +/** Information about a stream of a particular file in the WIM. */ struct wimlib_stream_entry { /** Name of the stream, or NULL if the stream is unnamed. */ const wimlib_tchar *stream_name; @@ -1331,15 +1403,21 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour /** @} */ -/** @ingroup G_modifying_wims +/** @addtogroup G_modifying_wims * @{ */ -/** Directly capture an NTFS volume rather than a generic directory. This flag - * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or - * ::WIMLIB_ADD_FLAG_UNIX_DATA. */ +/** UNIX-like systems only: Directly capture an NTFS volume rather than a + * generic directory. This requires that wimlib was compiled with support for + * libntfs-3g. + * + * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or + * ::WIMLIB_ADD_FLAG_UNIX_DATA. + * + * Do not use this flag on Windows, where wimlib already supports all + * Windows-native filesystems, including NTFS, through the Windows APIs. */ #define WIMLIB_ADD_FLAG_NTFS 0x00000001 -/** Follow symlinks; archive and dump the files they point to. Currently only +/** Follow symbolic links when scanning the directory tree. Currently only * supported on UNIX-like systems. */ #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002 @@ -1348,66 +1426,72 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour * scanned. */ #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004 -/** Mark the image being added as the bootable image of the WIM. Not valid for - * wimlib_update_image(). */ +/** Mark the image being added as the bootable image of the WIM. This flag is + * valid only for wimlib_add_image() and wimlib_add_image_multisource(). + * + * Note that you can also change the bootable image of a WIM using + * wimlib_set_wim_info(). + * + * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent + * from, ::WIMLIB_ADD_FLAG_WIMBOOT. */ #define WIMLIB_ADD_FLAG_BOOT 0x00000008 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID - * (major and minor number) of each file. See the documentation for the + * (major and minor number) of each file. Also allows capturing special files + * such as device nodes and FIFOs. See the documentation for the * --unix-data option to wimlib-imagex capture for more * information. */ #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010 /** Do not capture security descriptors. Only has an effect in NTFS capture - * mode, or in Windows native builds. */ + * mode, or in Windows native builds. */ #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020 /** Fail immediately if the full security descriptor of any file or directory * cannot be accessed. Only has an effect in Windows native builds. The * default behavior without this flag is to first try omitting the SACL from the * security descriptor, then to try omitting the security descriptor entirely. - * */ + */ #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040 /** Call the progress function with the message * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from * capture. This is a subset of the messages provided by - * ::WIMLIB_ADD_FLAG_VERBOSE. */ + * ::WIMLIB_ADD_FLAG_VERBOSE. */ #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080 -/** Reparse-point fixups: Modify absolute symbolic links (or junction points, - * in the case of Windows) that point inside the directory being captured to - * instead be absolute relative to the directory being captured, rather than the - * current root; also exclude absolute symbolic links that point outside the - * directory tree being captured. +/** Reparse-point fixups: Modify absolute symbolic links (and junctions, in the + * case of Windows) that point inside the directory being captured to instead be + * absolute relative to the directory being captured. * - * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in - * the WIM header or if this is the first image being added. - * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with - * reparse point fixups enabled and currently cannot be unset. */ + * Without this flag, the default is to do reparse-point fixups if + * WIM_HDR_FLAG_RP_FIX is set in the WIM header or if this is the first image + * being added. WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is + * captured with reparse point fixups enabled and currently cannot be unset. */ #define WIMLIB_ADD_FLAG_RPFIX 0x00000100 -/** Don't do reparse point fixups. The default behavior is described in the - * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */ +/** Don't do reparse point fixups. See ::WIMLIB_ADD_FLAG_RPFIX. */ #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200 /** Do not automatically exclude unsupported files or directories from capture; * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on - * UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when - * such a file is encountered. */ + * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA. Instead, + * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered. */ #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400 /** * Automatically select a capture configuration appropriate for capturing * filesystems containing Windows operating systems. For example, - * "pagefile.sys" and "System Volume Information" will be excluded. + * "/pagefile.sys" and "System Volume Information" will be excluded. * - * When this flag is specified, the corresponding @p config parameter or member - * must be @c NULL. + * When this flag is specified, the corresponding @p config parameter (for + * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL. + * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned. * - * Note that the default behavior--- that is, when this flag is not specified - * and @p config is @c NULL--- is to use no capture configuration, meaning that - * no files are excluded from capture. + * Note that the default behavior--- that is, when neither + * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p + * config is @c NULL--- is to use no capture configuration, meaning that no + * files are excluded from capture. */ #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800 @@ -1429,6 +1513,9 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour * * since that makes access to the data faster (at the cost of a worse * compression ratio compared to the 32768-byte LZX chunks usually used). + * + * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and + * independent from, ::WIMLIB_ADD_FLAG_BOOT. */ #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000 @@ -1458,7 +1545,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour /** @} */ -/** @ingroup G_modifying_wims +/** @addtogroup G_modifying_wims * @{ */ /** Do not issue an error if the path to delete does not exist. */ @@ -1469,7 +1556,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002 /** @} */ -/** @ingroup G_modifying_wims +/** @addtogroup G_modifying_wims * @{ */ /** @@ -1497,8 +1584,9 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour * Mark each exported image as WIMBoot-compatible. * * Note: by itself, this does change the destination WIM's compression type, nor - * does it add the file \Windows\System32\WimBootCompress.ini in the WIM image. - * Before writing the destination WIM, it's recommended to do something like: + * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM + * image. Before writing the destination WIM, it's recommended to do something + * like: * * \code * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS); @@ -1510,7 +1598,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010 /** @} */ -/** @ingroup G_extracting_wims +/** @addtogroup G_extracting_wims * @{ */ /** Extract the image directly to an NTFS volume rather than a generic directory. @@ -1618,7 +1706,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000 /** @} */ -/** @ingroup G_mounting_wim_images +/** @addtogroup G_mounting_wim_images * @{ */ /** Mount the WIM image read-write rather than the default of read-only. */ @@ -1648,32 +1736,33 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040 /** @} */ -/** @ingroup G_creating_and_opening_wims +/** @addtogroup G_creating_and_opening_wims * @{ */ /** Verify the WIM contents against the WIM's integrity table, if present. This * causes the raw data of the WIM file, divided into 10 MB chunks, to be * checksummed and checked against the SHA1 message digests specified in the - * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any - * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the - * integrity table is invalid). */ + * integrity table. If there are any mismatches, ::WIMLIB_ERR_INTEGRITY is + * issued. If the WIM file does not contain an integrity table, this flag has + * no effect. */ #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001 -/** Issue an error if the WIM is part of a split WIM. Software can provide - * this flag for convenience if it explicitly does not want to support split - * WIMs. */ +/** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split + * WIM. Software can provide this flag for convenience if it explicitly does + * not want to support split WIMs. */ #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002 -/** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it - * is not. A WIM is considered writable only if it is writable at the - * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its - * header, and is not part of a spanned set. It is not required to provide this - * flag before attempting to make changes to the WIM, but with this flag you get - * an error sooner rather than later. */ +/** Check if the WIM is writable and issue an error + * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable + * only if it is writable at the filesystem level, does not have the + * WIM_HDR_FLAG_READONLY flag set in its header, and is not part of a spanned + * set. It is not required to provide this flag before attempting to make + * changes to the WIM, but with this flag you get an error sooner rather than + * later. */ #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004 /** @} */ -/** @ingroup G_mounting_wim_images +/** @addtogroup G_mounting_wim_images * @{ */ /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image. @@ -1709,7 +1798,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020 /** @} */ -/** @ingroup G_modifying_wims +/** @addtogroup G_modifying_wims * @{ */ /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and @@ -1717,7 +1806,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001 /** @} */ -/** @ingroup G_writing_and_overwriting_wims +/** @addtogroup G_writing_and_overwriting_wims * @{ */ /** @@ -1740,9 +1829,10 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour /** * Write the WIM as "pipable". After writing a WIM with this flag specified, * images from it can be applied directly from a pipe using - * wimlib_extract_image_from_pipe(). See the documentation for the --pipable - * flag of `wimlib-imagex capture' for more information. Beware: WIMs written - * with this flag will not be compatible with Microsoft's software. + * wimlib_extract_image_from_pipe(). See the documentation for the + * --pipable option of wimlib-imagex capture for more information. + * Beware: WIMs written with this flag will not be compatible with Microsoft's + * software. * * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to * write the WIM as pipable if and only if it was pipable before. For @@ -1766,8 +1856,8 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour * compression ratio for the same compression type and chunk size. wimlib's LZX * compressor currently can be given different parameters in order to achieve * different balances between compression ratio and time. In its default mode - * as of v1.5.3, it usually compresses slightly better than the competing - * Microsoft implementation. + * as of v1.7.0, it usually compresses slightly better than the competing + * Microsoft implementation and is almost as fast. * * ::WIMLIB_WRITE_FLAG_RECOMPRESS can also be used in combination with * ::WIMLIB_WRITE_FLAG_PACK_STREAMS to prevent any solid blocks from being @@ -1793,7 +1883,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour /** * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise - * could be updated merely be appending to it. + * could be updated merely by appending to it. * * When rebuilding the WIM file, stream reference counts will be recomputed, and * any streams with 0 reference count (e.g. from deleted files or images) will @@ -1874,7 +1964,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour * all streams recompressed in solid mode. * * Currently, new solid blocks will, by default, be written using LZMS - * compression with 64 MiB (67108864 byte) chunks. Use + * compression with 32 MiB (33554432 byte) chunks. Use * wimlib_set_output_pack_compression_type() and/or * wimlib_set_output_pack_chunk_size() to change this. This is independent of * the WIM's main compression type and chunk size; you can have a WIM that @@ -1891,8 +1981,15 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour */ #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000 +/** + * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM + * file. This is only needed in the unusual case that the library user needs to + * know exactly when wimlib has read each file for the last time. + */ +#define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000 + /** @} */ -/** @ingroup G_general +/** @addtogroup G_general * @{ */ /** Assume that strings are represented in UTF-8, even if this is not the @@ -1932,7 +2029,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020 /** @} */ -/** @ingroup G_nonstandalone_wims +/** @addtogroup G_nonstandalone_wims * @{ */ /** For wimlib_reference_resource_files(), enable shell-style filename globbing. @@ -1949,7 +2046,7 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002 /** @} */ -/** @ingroup G_modifying_wims +/** @addtogroup G_modifying_wims * @{ */ /** The specific type of update to perform. */ @@ -2022,7 +2119,7 @@ struct wimlib_update_command { }; /** @} */ -/** @ingroup G_general +/** @addtogroup G_general * @{ */ /** @@ -2173,8 +2270,7 @@ wimlib_add_empty_image(WIMStruct *wim, * any) until wimlib_write() or wimlib_overwrite() is called. * * @param wim - * Pointer to the ::WIMStruct for a WIM file to which the image will be - * added. + * Pointer to the ::WIMStruct to which to add the image. * @param source * A path to a directory or unmounted NTFS volume that will be captured as * a WIM image. @@ -2271,7 +2367,7 @@ wimlib_add_tree(WIMStruct *wim, int image, * ::wimlib_compression_type constants. * @param wim_ret * On success, a pointer to an opaque ::WIMStruct for the new WIM file is - * written to the memory location pointed to by this paramater. The + * written to the memory location pointed to by this parameter. The * ::WIMStruct must be freed using using wimlib_free() when finished with * it. * @return 0 on success; nonzero on error. @@ -2343,13 +2439,9 @@ wimlib_delete_path(WIMStruct *wim, int image, * * The destination image is made to share the same dentry tree and security data * structure as the source image. This places some restrictions on additional - * functions that may be called. wimlib_mount_image() may not be called on - * either the source image or the destination image without an intervening call - * to a function that un-shares the images, such as wimlib_free() on @p - * dest_wim, or wimlib_delete_image() on either the source or destination image. - * Furthermore, you may not call wimlib_free() on @p src_wim before calling - * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will - * have references back to @p src_wim. + * functions that may be called. For example, you may not call wimlib_free() on + * @p src_wim before calling wimlib_write() or wimlib_overwrite() on @p dest_wim + * because @p dest_wim will have references back to @p src_wim. * * If this function fails, all changes to @p dest_wim are rolled back. * @@ -2607,16 +2699,16 @@ wimlib_extract_image_from_pipe_with_progress(int pipe_fd, * @ingroup G_extracting_wims * * Since wimlib v1.6.0: Similar to wimlib_extract_paths(), but the paths to - * extract from the WIM image are specified in the UTF-8 text file named by @p - * path_list_file which itself contains the list of paths to use, one per line. - * Leading and trailing whitespace, and otherwise empty lines and lines - * beginning with the ';' character are ignored. No quotes are needed as paths - * are otherwise delimited by the newline character. + * extract from the WIM image are specified in the ASCII, UTF-8, or UTF-16LE + * text file named by @p path_list_file which itself contains the list of paths + * to use, one per line. Leading and trailing whitespace, and otherwise empty + * lines and lines beginning with the ';' character are ignored. No quotes are + * needed as paths are otherwise delimited by the newline character. * * The error codes are the same as those returned by wimlib_extract_paths(), * except that wimlib_extract_pathlist() returns an appropriate error code if it - * cannot read the path list file (::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT, - * ::WIMLIB_ERR_READ, ::WIMLIB_ERR_NOMEM, or ::WIMLIB_ERR_INVALID_UTF8_STRING). + * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT, + * ::WIMLIB_ERR_READ). */ extern int wimlib_extract_pathlist(WIMStruct *wim, int image, @@ -2718,8 +2810,8 @@ wimlib_extract_paths(WIMStruct *wim, * See wimlib_get_xml_data() to read the XML data into memory instead. * * @param wim - * Pointer to the ::WIMStruct for a WIM file, which does not necessarily - * have to be standalone (e.g. it could be part of a split WIM). + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * @param fp * @c stdout, or a FILE* opened for writing, to extract the data to. * @@ -2727,9 +2819,11 @@ wimlib_extract_paths(WIMStruct *wim, * @retval ::WIMLIB_ERR_INVALID_PARAM * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(). * @retval ::WIMLIB_ERR_NOMEM + * Failed to allocate needed memory. * @retval ::WIMLIB_ERR_READ + * Error reading the XML data from the WIM file. * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE - * Failed to read the XML data from the WIM. + * Error reading the XML data from the WIM file. * @retval ::WIMLIB_ERR_WRITE * Failed to completely write the XML data to @p fp. */ @@ -2743,7 +2837,7 @@ wimlib_extract_xml_data(WIMStruct *wim, FILE *fp); * with it. * * @param wim - * Pointer to the ::WIMStruct for a WIM file. + * Pointer to the ::WIMStruct to free. * * @return This function has no return value. */ @@ -2786,8 +2880,8 @@ wimlib_get_error_string(enum wimlib_error_code code); * Returns the description of the specified image. * * @param wim - * Pointer to the ::WIMStruct for a WIM file that does not necessarily have - * to be standalone (e.g. it could be part of a split WIM). + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * @param image * The number of the image, numbered starting at 1. * @@ -2807,8 +2901,8 @@ wimlib_get_image_description(const WIMStruct *wim, int image); * Returns the name of the specified image. * * @param wim - * Pointer to the ::WIMStruct for a WIM file that does not necessarily have - * to be standalone (e.g. it could be part of a split WIM). + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * @param image * The number of the image, numbered starting at 1. * @@ -2842,8 +2936,8 @@ wimlib_get_version(void); * Get basic information about a WIM file. * * @param wim - * Pointer to the ::WIMStruct for a WIM file that does not necessarily have - * to be standalone (e.g. it could be part of a split WIM). + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * @param info * A ::wimlib_wim_info structure that will be filled in with information * about the WIM file. @@ -2863,8 +2957,8 @@ wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info); * instead. * * @param wim - * Pointer to the ::WIMStruct for a WIM file, which does not necessarily - * have to be standalone (e.g. it could be part of a split WIM). + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * @param buf_ret * On success, a pointer to an allocated buffer containing the raw UTF16-LE * XML data is written to this location. @@ -2921,7 +3015,8 @@ wimlib_global_cleanup(void); * Determines if an image name is already used by some image in the WIM. * * @param wim - * Pointer to the ::WIMStruct for a WIM file. + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * @param name * The name to check. * @@ -3004,8 +3099,8 @@ wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path, * explicitly referenced. * * @param wim - * Pointer to the ::WIMStruct for a WIM file that does not necessarily have - * to be standalone (e.g. it could be part of a split WIM). + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * * @param flags * Reserved; set to 0. @@ -3183,60 +3278,60 @@ wimlib_mount_image(WIMStruct *wim, * @param wim_ret * On success, a pointer to an opaque ::WIMStruct for the opened WIM file * is written to the memory location pointed to by this parameter. The - * ::WIMStruct can be freed using using wimlib_free() when finished with + * ::WIMStruct must be freed using using wimlib_free() when finished with * it. * * @return 0 on success; nonzero on error. * @retval ::WIMLIB_ERR_IMAGE_COUNT - * The WIM is not the non-first part of a split WIM, and the number of - * metadata resources found in the WIM did not match the image count given - * in the WIM header, or the number of <IMAGE> elements in the XML - * data for the WIM did not match the image count given in the WIM header. + * The number of metadata resources found in the WIM did not match the + * image count specified in the WIM header, or the number of <IMAGE> + * elements in the XML data of the WIM did not match the image count + * specified in the WIM header. * @retval ::WIMLIB_ERR_INTEGRITY - * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p - * wim_file contains an integrity table, but the SHA1 message digest for a - * chunk of the WIM does not match the corresponding message digest given - * in the integrity table. + * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and + * the WIM contained an integrity table, but the SHA1 message digest for a + * chunk of the WIM did not match the corresponding value in the integrity + * table. * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE - * Resources in @p wim_file are compressed, but the chunk size was invalid - * for the WIM's compression type. + * The library did not recognize the compression chunk size of the WIM as + * valid for its compression type. * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE - * The header of @p wim_file says that resources in the WIM are compressed, - * but the header flag for a recognized compression type is not set. + * The library did not recognize the compression type of the WIM. * @retval ::WIMLIB_ERR_INVALID_HEADER - * The header of @p wim_file was otherwise invalid. + * The header of the WIM was otherwise invalid. * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE - * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p - * wim_file contains an integrity table, but the integrity table is + * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and + * the WIM contained an integrity table, but the integrity table was * invalid. * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY - * The lookup table for the WIM was invalid. + * The lookup table of the WIM was invalid. * @retval ::WIMLIB_ERR_INVALID_PARAM * @p wim_ret was @c NULL. * @retval ::WIMLIB_ERR_IS_SPLIT_WIM - * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was + * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was * specified in @p open_flags. * @retval ::WIMLIB_ERR_NOMEM * Failed to allocated needed memory. * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE - * @p wim_file does not begin with the expected magic characters. + * The file did not begin with the magic characters that identify a WIM + * file. * @retval ::WIMLIB_ERR_OPEN - * Failed to open the file @p wim_file for reading. + * Failed to open the file for reading. * @retval ::WIMLIB_ERR_READ - * Failed to read data from @p wim_file. + * Failed to read data from the file. * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE - * Unexpected end-of-file while reading data from @p wim_file. + * Unexpected end-of-file while reading data from the file. * @retval ::WIMLIB_ERR_UNKNOWN_VERSION * The WIM version number was not recognized. (May be a pre-Vista WIM.) * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED * The WIM cannot be opened because it contains encrypted segments. (It - * may be a Windows 8 "ESD" file). + * may be a Windows 8 "ESD" file.) * @retval ::WIMLIB_ERR_WIM_IS_READONLY * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was * considered read-only because of any of the reasons mentioned in the * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag. * @retval ::WIMLIB_ERR_XML - * The XML data for @p wim_file is invalid. + * The XML data of the WIM was invalid. */ extern int wimlib_open_wim(const wimlib_tchar *wim_file, @@ -3248,7 +3343,8 @@ wimlib_open_wim(const wimlib_tchar *wim_file, * * Same as wimlib_open_wim(), but allows specifying a progress function and * progress context. If successful, the progress function will be registered in - * the newly open ::WIMStruct. In addition, if + * the newly open ::WIMStruct, as if by an automatic call to + * wimlib_register_progress_function(). In addition, if * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, the * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY * messages while checking the WIM's integrity. @@ -3271,10 +3367,8 @@ wimlib_open_wim_with_progress(const wimlib_tchar *wim_file, * rebuild. In this mode, the new WIM is written to a temporary file and then * renamed to the original file after it is has been completely written. The * temporary file is made in the same directory as the original WIM file. A - * full rebuild may take a while, but can be used even if images have been - * modified or deleted, will produce a WIM with no holes, and has little chance - * of unintentional data loss because the temporary WIM is fsync()ed before - * being renamed to the original WIM. + * full rebuild may take a while, but it will save space by producing a WIM with + * no "holes". * * The second way to overwrite a WIM is by appending to the end of it and * overwriting the header. This can be much faster than a full rebuild, but the @@ -3293,13 +3387,6 @@ wimlib_open_wim_with_progress(const wimlib_tchar *wim_file, * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if * images have been deleted from the WIM. * - * In the temporary-file overwrite mode, no changes are made to the WIM on - * failure, and the temporary file is deleted if possible. Abnormal termination - * of the program will result in the temporary file being orphaned. In the - * direct append mode, the WIM is truncated to the original length on failure; - * and while abnormal termination of the program will result in extra data - * appended to the original WIM, it should still be a valid WIM. - * * If this function completes successfully, no more functions should be called * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read * the WIM file anew. @@ -3322,8 +3409,8 @@ wimlib_open_wim_with_progress(const wimlib_tchar *wim_file, * because another thread or process has mounted an image from the WIM * read-write or is currently modifying the WIM in-place. * @retval ::WIMLIB_ERR_NO_FILENAME - * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather - * than a WIM read with wimlib_open_wim(). + * @p wim corresponds to a ::WIMStruct created with wimlib_create_new_wim() + * rather than a WIM read with wimlib_open_wim(). * @retval ::WIMLIB_ERR_RENAME * The temporary file that the WIM was written to could not be renamed to * the original filename of @p wim. @@ -3346,7 +3433,8 @@ wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads); * Prints information about one image, or all images, contained in a WIM. * * @param wim - * Pointer to the ::WIMStruct for a WIM file. + * Pointer to the ::WIMStruct to query. This need not represent a + * standalone WIM (e.g. it could represent part of a split WIM). * @param image * The image about which to print information. Can be the number of an * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the @@ -3589,6 +3677,43 @@ extern int wimlib_resolve_image(WIMStruct *wim, const wimlib_tchar *image_name_or_num); +/** + * @ingroup G_general + * + * Sets the file to which the library will print error and warning messages. + * + * This version of the function takes a C library FILE * opened for + * writing (or appending). Use wimlib_set_error_file_by_name() to specify the + * file by name instead. + * + * This also enables error messages, as if by a call to + * wimlib_set_print_errors(true). + * + * @return 0 on success; nonzero on error. + * @retval ::WIMLIB_ERR_UNSUPPORTED + * wimlib was compiled using the --without-error-messages option. + */ +extern int +wimlib_set_error_file(FILE *fp); + +/** + * @ingroup G_general + * + * Sets the path to the file to which the library will print error and warning + * messages. The library will open this file for appending. + * + * This also enables error messages, as if by a call to + * wimlib_set_print_errors(true). + * + * @return 0 on success; nonzero on error. + * @retval ::WIMLIB_ERR_OPEN + * The file named by @p path could not be opened for appending. + * @retval ::WIMLIB_ERR_UNSUPPORTED + * wimlib was compiled using the --without-error-messages option. + */ +extern int +wimlib_set_error_file_by_name(const wimlib_tchar *path); + /** * @ingroup G_modifying_wims * @@ -3622,10 +3747,6 @@ wimlib_set_image_descripton(WIMStruct *wim, int image, * Set the compression chunk size of a WIM to use in subsequent calls to * wimlib_write() or wimlib_overwrite(). * - * For compatibility reasons, using this function is not generally recommended. - * See the documentation for the @c --chunk-size option of wimlib-imagex - * capture for more information. - * * A larger compression chunk size will likely result in a better compression * ratio, but the speed of random access to the WIM will be reduced. * Furthermore, the effect of a larger compression chunk size is limited by the @@ -3635,10 +3756,10 @@ wimlib_set_image_descripton(WIMStruct *wim, int image, * ::WIMStruct for a WIM. * @param chunk_size * The chunk size (in bytes) to set. The valid chunk sizes are dependent - * on the compression format; see the documentation for the @c --chunk-size - * option of wimlib-imagex capture for more information. As a - * special case, if @p chunk_size is specified as 0, the chunk size is set - * to the default for the currently selected output compression type. + * on the compression format. See the documentation for each + * ::wimlib_compression_type constant for more information. As a special + * case, if @p 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. * @@ -3786,7 +3907,7 @@ wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name); * library. * * Please note that some external functions, such as those in @c libntfs-3g, may - * use the standard memory allocation functions. + * use the standard memory allocation functions regardless of this setting. * * @param malloc_func * A function equivalent to @c malloc() that wimlib will use to allocate @@ -3863,11 +3984,6 @@ wimlib_set_print_errors(bool show_messages); * @retval ::WIMLIB_ERR_INVALID_PARAM * @p swm_name was not a nonempty string, or @p part_size was 0. * - * Note: the WIM's uncompressed and compressed resources are not checksummed - * when they are copied from the joined WIM to the split WIM parts, nor are - * compressed resources re-compressed (unless explicitly requested with - * ::WIMLIB_WRITE_FLAG_RECOMPRESS). - * * If a progress function is registered with @p wim, for each split WIM part * that is written it will receive the messages * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and @@ -4167,144 +4283,6 @@ wimlib_write_to_fd(WIMStruct *wim, * @{ */ -/** Header for compression parameters to pass to wimlib_create_compressor() or - * wimlib_set_default_compressor_params(). */ -struct wimlib_compressor_params_header { - /** Size of the parameters, in bytes. */ - uint32_t size; -}; - -/** Header for decompression parameters to pass to wimlib_create_decompressor() - * or wimlib_set_default_decompressor_params() */ -struct wimlib_decompressor_params_header { - /** Size of the parameters, in bytes. */ - uint32_t size; -}; - -/** LZX compression parameters that can optionally be passed to - * wimlib_create_compressor() with the compression type - * ::WIMLIB_COMPRESSION_TYPE_LZX. */ -struct wimlib_lzx_compressor_params { - /** hdr.size Must be set to the size of this structure, in bytes. */ - struct wimlib_compressor_params_header hdr; - - /** Relatively fast LZX compression algorithm with a decent compression - * ratio. */ -#define WIMLIB_LZX_ALGORITHM_FAST 0 - - /** Slower LZX compression algorithm that provides a better compression - * ratio. This is the default. */ -#define WIMLIB_LZX_ALGORITHM_SLOW 1 - - /** Algorithm to use to perform the compression: either - * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The - * format is still LZX; this refers to the method the code will use to - * perform LZX-compatible compression. */ - uint32_t algorithm : 3; - - /** If set to 1, the default parameters for the specified algorithm are - * used rather than the ones specified in the following union. */ - uint32_t use_defaults : 1; - - union { - /** Parameters for the fast algorithm. */ - struct wimlib_lzx_fast_params { - uint32_t fast_reserved1[10]; - } fast; - - /** Parameters for the "slow" algorithm. */ - struct wimlib_lzx_slow_params { - /** If set to 1, the compressor can output length 2 - * matches. If set 0, the compressor can only output - * matches of length 3 or greater. Suggested value: 1 - */ - uint32_t use_len2_matches : 1; - - uint32_t slow_reserved1 : 31; - - /** Matches with length (in bytes) greater than or equal - * to this value are immediately taken without spending - * time on minimum-cost measurements. Suggested value: - * 32. */ - uint32_t nice_match_length; - - /** Number of passes to compute a match/literal sequence - * for each LZX block. This is for an iterative - * algorithm that attempts to minimize the cost of the - * match/literal sequence by using a cost model provided - * by the previous iteration. Must be at least 1. - * Suggested value: 2. */ - uint32_t num_optim_passes; - - /** Reserved; set to 0. */ - uint32_t slow_reserved_blocksplit; - - /** Maximum depth to search for matches at each - * position. Suggested value: 50. */ - uint32_t max_search_depth; - - /* Note: max_matches_per_pos has been removed and no - * longer has any effect. */ - - uint32_t slow_reserved2[3]; - - /** Assumed cost of a main symbol with zero frequency. - * Must be at least 1 and no more than 16. Suggested - * value: 15. */ - uint8_t main_nostat_cost; - - /** Assumed cost of a length symbol with zero frequency. - * Must be at least 1 and no more than 16. Suggested - * value: 15. */ - uint8_t len_nostat_cost; - - /** Assumed cost of an aligned symbol with zero - * frequency. Must be at least 1 and no more than 8. - * Suggested value: 7. */ - uint8_t aligned_nostat_cost; - - uint8_t slow_reserved3[5]; - } slow; - } alg_params; -}; - -/** LZMS compression parameters that can optionally be passed to - * wimlib_create_compressor() with the compression type - * ::WIMLIB_COMPRESSION_TYPE_LZMS. */ -struct wimlib_lzms_compressor_params { - /** hdr.size Must be set to the size of this structure, in bytes. */ - struct wimlib_compressor_params_header hdr; - - /** Minimum match length to output. This must be at least 2. Suggested - * value: 2 */ - uint32_t min_match_length; - - /** Maximum match length to output. This must be at least @p - * min_match_length. Suggested value: @p UINT32_MAX. */ - uint32_t max_match_length; - - /** Matches with length (in bytes) greater than or equal to this value - * are immediately taken without spending time on minimum-cost - * measurements. The minimum of @p max_match_length and @p - * nice_match_length may not exceed 65536. Suggested value: 32. */ - uint32_t nice_match_length; - - /** Maximum depth to search for matches at each position. Suggested - * value: 50. */ - uint32_t max_search_depth; - - /* Note: max_matches_per_pos has been removed and no longer has any - * effect. */ - - uint32_t reserved1; - - /** Length of the array for the near-optimal LZ parsing algorithm. This - * must be at least 1. Suggested value: 1024. */ - uint32_t optim_array_length; - - uint64_t reserved2[4]; -}; - /** Opaque compressor handle. */ struct wimlib_compressor; @@ -4312,45 +4290,45 @@ struct wimlib_compressor; struct wimlib_decompressor; /** - * Set the default compression parameters for the specified compression type. - * This will affect both explicit and wimlib-internal calls to + * Set the default compression level for the specified compression type. This + * will affect both explicit and library-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 @c NULL, in which - * case the "default default" parameters are restored. + * Compression type for which to set the default compression level, as one + * of the ::wimlib_compression_type constants. Or, if this is the special + * value -1, the default compression levels for all known compression types + * will be set. + * @param compression_level + * The default compression level to set. If 0, the "default default" level + * is restored. Otherwise, a higher value indicates higher compression. + * The values are scaled so that 10 is low compression, 50 is medium + * compression, and 100 is high compression. * * @return 0 on success; nonzero on error. * * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE - * @p ctype was not a supported compression type. - * @retval ::WIMLIB_ERR_INVALID_PARAM - * @p params were invalid. - * @retval ::WIMLIB_ERR_NOMEM - * Not enough memory to duplicate the parameters (perhaps @c params->size - * was invalid). + * @p ctype was neither a supported compression type nor -1. */ extern int -wimlib_set_default_compressor_params(enum wimlib_compression_type ctype, - const struct wimlib_compressor_params_header *params); +wimlib_set_default_compression_level(int ctype, unsigned int compression_level); /** * Returns the approximate number of bytes needed to allocate a compressor with * wimlib_create_compressor() for the specified compression type, block size, - * and parameters. @p params may be @c NULL, in which case the current default - * parameters for @p ctype are used. Returns 0 if the compression type or - * parameters are invalid. + * and compression level. @p compression_level may be 0, in which case the + * current default compression level for @p ctype is used. Returns 0 if the + * compression type is invalid. */ extern uint64_t wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype, size_t max_block_size, - const struct wimlib_compressor_params_header *params); + unsigned int compression_level); /** * Allocate a compressor for the specified compression type using the specified - * parameters. + * parameters. This function is part of wimlib's compression API; it is not + * necessary to call this to process a WIM file. * * @param ctype * Compression type for which to create the compressor. @@ -4358,11 +4336,11 @@ wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype, * Maximum block size to support. The exact meaning and allowed values for * this parameter depend on the compression type, but it at least specifies * the maximum allowed value for @p uncompressed_size to wimlib_compress(). - * @param extra_params - * An optional pointer to extra compressor parameters for the specified - * compression type. For LZX, a pointer to ::wimlib_lzx_compressor_params - * may be specified here. If left @c NULL, the default parameters are - * used. + * @param compression_level + * The compression level to use. If 0, the default compression level is + * used. Otherwise, a higher value indicates higher compression. The + * values are scaled so that 10 is low compression, 50 is medium + * compression, and 100 is high compression. * @param compressor_ret * A location into which to return the pointer to the allocated compressor, * which can be used for any number of calls to wimlib_compress() before @@ -4373,14 +4351,14 @@ wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype, * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE * @p ctype was not a supported compression type. * @retval ::WIMLIB_ERR_INVALID_PARAM - * The compression parameters were invalid. + * The compressor does not support the specified maximum block size. * @retval ::WIMLIB_ERR_NOMEM * Insufficient memory to allocate the compressor. */ extern int wimlib_create_compressor(enum wimlib_compression_type ctype, size_t max_block_size, - const struct wimlib_compressor_params_header *extra_params, + unsigned int compression_level, struct wimlib_compressor **compressor_ret); /** @@ -4416,32 +4394,10 @@ wimlib_compress(const void *uncompressed_data, size_t uncompressed_size, extern void wimlib_free_compressor(struct wimlib_compressor *compressor); -/** - * 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 @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); - /** * Allocate a decompressor for the specified compression type using the - * specified parameters. + * specified parameters. This function is part of wimlib's compression API; it + * is not necessary to call this to process a WIM file. * * @param ctype * Compression type for which to create the decompressor. @@ -4450,9 +4406,6 @@ wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype, * this parameter depend on the compression type, but it at least specifies * the maximum allowed value for @p uncompressed_size to * wimlib_decompress(). - * @param extra_params - * An optional pointer to extra decompressor parameters for the specified - * compression type. If @c NULL, the default parameters are used. * @param decompressor_ret * A location into which to return the pointer to the allocated * decompressor, which can be used for any number of calls to @@ -4462,15 +4415,12 @@ wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype, * * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE * @p ctype was not a supported compression type. - * @retval ::WIMLIB_ERR_INVALID_PARAM - * The decompression parameters were invalid. * @retval ::WIMLIB_ERR_NOMEM * Insufficient memory to allocate the decompressor. */ extern int wimlib_create_decompressor(enum wimlib_compression_type ctype, size_t max_block_size, - const struct wimlib_decompressor_params_header *extra_params, struct wimlib_decompressor **decompressor_ret); /**