From d0901645170b638c517f5c50866b6ef48f491c65 Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Thu, 24 Nov 2022 01:02:50 +0200 Subject: liblzma: Add new API function lzma_filters_free(). This is small but convenient and should have been added a long time ago. --- src/liblzma/api/lzma/filter.h | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'src/liblzma/api') diff --git a/src/liblzma/api/lzma/filter.h b/src/liblzma/api/lzma/filter.h index 5ec9976d..41c5895e 100644 --- a/src/liblzma/api/lzma/filter.h +++ b/src/liblzma/api/lzma/filter.h @@ -124,6 +124,27 @@ extern LZMA_API(lzma_ret) lzma_filters_copy( lzma_nothrow lzma_attr_warn_unused_result; +/** + * \brief Free the options in the array of lzma_filter structures + * + * This frees the filter chain options. The filters array itself is not freed. + * + * The filters array must have at most LZMA_FILTERS_MAX + 1 elements + * including the terminating element which must have .id = LZMA_VLI_UNKNOWN. + * For all elements before the terminating element: + * - options will be freed using the given lzma_allocator or, + * if allocator is NULL, using free(). + * - options will be set to NULL. + * - id will be set to LZMA_VLI_UNKNOWN. + * + * If filters is NULL, this does nothing but remember that this never frees + * the filters array itself. + */ +extern LZMA_API(void) lzma_filters_free( + lzma_filter *filters, const lzma_allocator *allocator) + lzma_nothrow; + + /** * \brief Calculate approximate memory requirements for raw encoder * -- cgit v1.2.3