97 lines
4.7 KiB
C
97 lines
4.7 KiB
C
/*
|
|
* shrink_streaming.h - streaming compression definitions
|
|
*
|
|
* Copyright (C) 2019 Emmanuel Marty
|
|
*
|
|
* This software is provided 'as-is', without any express or implied
|
|
* warranty. In no event will the authors be held liable for any damages
|
|
* arising from the use of this software.
|
|
*
|
|
* Permission is granted to anyone to use this software for any purpose,
|
|
* including commercial applications, and to alter it and redistribute it
|
|
* freely, subject to the following restrictions:
|
|
*
|
|
* 1. The origin of this software must not be misrepresented; you must not
|
|
* claim that you wrote the original software. If you use this software
|
|
* in a product, an acknowledgment in the product documentation would be
|
|
* appreciated but is not required.
|
|
* 2. Altered source versions must be plainly marked as such, and must not be
|
|
* misrepresented as being the original software.
|
|
* 3. This notice may not be removed or altered from any source distribution.
|
|
*/
|
|
|
|
/*
|
|
* Uses the libdivsufsort library Copyright (c) 2003-2008 Yuta Mori
|
|
*
|
|
* Inspired by LZ4 by Yann Collet. https://github.com/lz4/lz4
|
|
* With help, ideas, optimizations and speed measurements by spke <zxintrospec@gmail.com>
|
|
* With ideas from Lizard by Przemyslaw Skibinski and Yann Collet. https://github.com/inikep/lizard
|
|
* Also with ideas from smallz4 by Stephan Brumme. https://create.stephan-brumme.com/smallz4/
|
|
*
|
|
*/
|
|
|
|
#ifndef _SHRINK_STREAMING_H
|
|
#define _SHRINK_STREAMING_H
|
|
|
|
#include "shrink_context.h"
|
|
#include "stream.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*-------------- File API -------------- */
|
|
|
|
/**
|
|
* Compress file
|
|
*
|
|
* @param pszInFilename name of input(source) file to compress
|
|
* @param pszOutFilename name of output(compressed) file to generate
|
|
* @param pszDictionaryFilename name of dictionary file, or NULL for none
|
|
* @param nFlags compression flags (LZSA_FLAG_xxx)
|
|
* @param nMinMatchSize minimum match size
|
|
* @param nFormatVersion version of format to use (1-2)
|
|
* @param progress progress function, called after compressing each block, or NULL for none
|
|
* @param pOriginalSize pointer to returned input(source) size, updated when this function is successful
|
|
* @param pCompressedSize pointer to returned output(compressed) size, updated when this function is successful
|
|
* @param pCommandCount pointer to returned token(compression commands) count, updated when this function is successful
|
|
* @param pSafeDist pointer to return safe distance for raw blocks, updated when this function is successful
|
|
* @param pStats pointer to compression stats that are filled if this function is successful, or NULL
|
|
*
|
|
* @return LZSA_OK for success, or an error value from lzsa_status_t
|
|
*/
|
|
lzsa_status_t lzsa_compress_file(const char *pszInFilename, const char *pszOutFilename, const char *pszDictionaryFilename,
|
|
const unsigned int nFlags, const int nMinMatchSize, const int nFormatVersion,
|
|
void(*progress)(long long nOriginalSize, long long nCompressedSize), long long *pOriginalSize, long long *pCompressedSize, int *pCommandCount, int *pSafeDist, lzsa_stats *pStats);
|
|
|
|
/*-------------- Streaming API -------------- */
|
|
|
|
/**
|
|
* Compress stream
|
|
*
|
|
* @param pInStream input(source) stream to compress
|
|
* @param pOutStream output(compressed) stream to write to
|
|
* @param pDictionaryData dictionary contents, or NULL for none
|
|
* @param nDictionaryDataSize size of dictionary contents, or 0
|
|
* @param nFlags compression flags (LZSA_FLAG_xxx)
|
|
* @param nMinMatchSize minimum match size
|
|
* @param nFormatVersion version of format to use (1-2)
|
|
* @param progress progress function, called after compressing each block, or NULL for none
|
|
* @param pOriginalSize pointer to returned input(source) size, updated when this function is successful
|
|
* @param pCompressedSize pointer to returned output(compressed) size, updated when this function is successful
|
|
* @param pCommandCount pointer to returned token(compression commands) count, updated when this function is successful
|
|
* @param pSafeDist pointer to return safe distance for raw blocks, updated when this function is successful
|
|
* @param pStats pointer to compression stats that are filled if this function is successful, or NULL
|
|
*
|
|
* @return LZSA_OK for success, or an error value from lzsa_status_t
|
|
*/
|
|
lzsa_status_t lzsa_compress_stream(lzsa_stream_t *pInStream, lzsa_stream_t *pOutStream, const void *pDictionaryData, int nDictionaryDataSize,
|
|
const unsigned int nFlags, const int nMinMatchSize, const int nFormatVersion,
|
|
void(*progress)(long long nOriginalSize, long long nCompressedSize), long long *pOriginalSize, long long *pCompressedSize, int *pCommandCount, int *pSafeDist, lzsa_stats *pStats);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _SHRINK_STREAMING_H */
|