mirror of
https://github.com/emmanuel-marty/lzsa.git
synced 2025-01-01 05:31:57 +00:00
92 lines
3.6 KiB
C
92 lines
3.6 KiB
C
/*
|
|
* matchfinder.h - LZ match finder 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 _MATCHFINDER_H
|
|
#define _MATCHFINDER_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Forward declarations */
|
|
typedef struct _lzsa_match lzsa_match;
|
|
typedef struct _lzsa_compressor lzsa_compressor;
|
|
|
|
/**
|
|
* Parse input data, build suffix array and overlaid data structures to speed up match finding
|
|
*
|
|
* @param pCompressor compression context
|
|
* @param pInWindow pointer to input data window (previously compressed bytes + bytes to compress)
|
|
* @param nInWindowSize total input size in bytes (previously compressed bytes + bytes to compress)
|
|
*
|
|
* @return 0 for success, non-zero for failure
|
|
*/
|
|
int lzsa_build_suffix_array(lzsa_compressor *pCompressor, const unsigned char *pInWindow, const int nInWindowSize);
|
|
|
|
/**
|
|
* Find matches at the specified offset in the input window
|
|
*
|
|
* @param pCompressor compression context
|
|
* @param nOffset offset to find matches at, in the input window
|
|
* @param pMatches pointer to returned matches
|
|
* @param nMaxMatches maximum number of matches to return (0 for none)
|
|
* @param nInWindowSize total input size in bytes (previously compressed bytes + bytes to compress)
|
|
*
|
|
* @return number of matches
|
|
*/
|
|
int lzsa_find_matches_at(lzsa_compressor *pCompressor, const int nOffset, lzsa_match *pMatches, const int nMaxMatches, const int nInWindowSize);
|
|
|
|
/**
|
|
* Skip previously compressed bytes
|
|
*
|
|
* @param pCompressor compression context
|
|
* @param nStartOffset current offset in input window (typically 0)
|
|
* @param nEndOffset offset to skip to in input window (typically the number of previously compressed bytes)
|
|
*/
|
|
void lzsa_skip_matches(lzsa_compressor *pCompressor, const int nStartOffset, const int nEndOffset);
|
|
|
|
/**
|
|
* Find all matches for the data to be compressed
|
|
*
|
|
* @param pCompressor compression context
|
|
* @param nMatchesPerOffset maximum number of matches to store for each offset
|
|
* @param nStartOffset current offset in input window (typically the number of previously compressed bytes)
|
|
* @param nEndOffset offset to end finding matches at (typically the size of the total input window in bytes
|
|
*/
|
|
void lzsa_find_all_matches(lzsa_compressor *pCompressor, const int nMatchesPerOffset, const int nStartOffset, const int nEndOffset);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _MATCHFINDER_H */
|