api/lzma/filter.h

30  * \brief       Filter options
33  * options to liblzma. A few functions work with a single lzma_filter
57 	 * \brief       Pointer to filter-specific options structure
59 	 * If the filter doesn't need options, set this to NULL. If id is
60 	 * set to LZMA_VLI_UNKNOWN, options is ignored, and thus
63 	void *options;
76  * couldn't know what kind of options the filter would need.
95  * Copy the Filter IDs and filter-specific options from src to dest.
101  * Unless the filter-specific options is NULL, the Filter ID has to be
103  * filter-specific options structure. The filter-specific options are not
104  * validated. If options is NULL, any unsupported Filter IDs are copied
107  * Old filter-specific options in dest are not freed, so dest doesn't
115  *              - LZMA_OPTIONS_ERROR: Unsupported Filter ID and its options
212  *    the filter-specific options in the middle of encoding. The actual
214  *    it might become possible to change the filter options without
296  * \param       filter  Filter ID and options (the size of the properties may
297  *                      vary depending on the options)
304  *              necessarily validate the options. Thus, it is possible
315  * \param       filter  Filter ID and options
316  * \param       props   Buffer to hold the encoded options. The size of
324  * \note        Even this function won't validate more options than actually
326  *              succeeds but using the same options to initialize the encoder
342  *                          Filter ID. filter->options doesn't need to be
344  *                          decoded options will be stored to filter->options.
345  *                          filter->options is set to NULL if there are no
348  *                          options. Set to NULL to use the default malloc(),
371  * \param       filter  Filter ID and associated options whose encoded
375  *                guarantee that filter->options is valid, thus
377  *              - LZMA_OPTIONS_ERROR: Unknown Filter ID or unsupported options.
378  *              - LZMA_PROG_ERROR: Invalid options
394  * \param       filter      Filter ID and options to be encoded
401  *              - LZMA_OPTIONS_ERROR: Invalid or unsupported options.
402  *              - LZMA_PROG_ERROR: Invalid options or not enough output
415  * filter->options is not free()d.