pcompress/bsc/libbsc/coder/qlfc/qlfc.h

94 lines
3.8 KiB
C
Raw Normal View History

/*-----------------------------------------------------------*/
/* Block Sorting, Lossless Data Compression Library. */
/* Interface to Quantized Local Frequency Coding functions */
/*-----------------------------------------------------------*/
/*--
This file is a part of bsc and/or libbsc, a program and a library for
lossless, block-sorting data compression.
Copyright (c) 2009-2012 Ilya Grebnov <ilya.grebnov@gmail.com>
See file AUTHORS for a full list of contributors.
The bsc and libbsc is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at your
option) any later version.
The bsc and libbsc is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public License
along with the bsc and libbsc. If not, see http://www.gnu.org/licenses/.
Please see the files COPYING and COPYING.LIB for full copyright information.
See also the bsc and libbsc web site:
http://libbsc.com/ for more information.
--*/
#ifndef _LIBBSC_QLFC_H
#define _LIBBSC_QLFC_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* You should call this function before you call any of the other functions in qlfc.
* @param features - the set of additional features.
* @return LIBBSC_NO_ERROR if no error occurred, error code otherwise.
*/
int bsc_qlfc_init(int features);
/**
* Compress a memory block using Quantized Local Frequency Coding algorithm.
* @param input - the input memory block of n bytes.
* @param output - the output memory block of n bytes.
* @param inputSize - the length of the input memory block.
* @param outputSize - the length of the output memory block.
* @return the length of compressed memory block if no error occurred, error code otherwise.
*/
int bsc_qlfc_static_encode_block(const unsigned char * input, unsigned char * output, int inputSize, int outputSize);
/**
* Decompress a memory block using Quantized Local Frequency Coding algorithm.
* @param input - the input memory block of n bytes.
* @param output - the output memory block of n bytes.
* @param inputSize - the length of the input memory block.
* @param outputSize - the length of the output memory block.
* @return the length of decompressed memory block if no error occurred, error code otherwise.
*/
int bsc_qlfc_adaptive_encode_block(const unsigned char * input, unsigned char * output, int inputSize, int outputSize);
/**
* Compress a memory block using Quantized Local Frequency Coding algorithm.
* @param input - the input memory block of n bytes.
* @param output - the output memory block of n bytes.
* @return the length of compressed memory block if no error occurred, error code otherwise.
*/
int bsc_qlfc_static_decode_block(const unsigned char * input, unsigned char * output);
/**
* Decompress a memory block using Quantized Local Frequency Coding algorithm.
* @param input - the input memory block of n bytes.
* @param output - the output memory block of n bytes.
* @return the length of decompressed memory block if no error occurred, error code otherwise.
*/
int bsc_qlfc_adaptive_decode_block(const unsigned char * input, unsigned char * output);
#ifdef __cplusplus
}
#endif
#endif
/*-----------------------------------------------------------*/
/* End qlfc.h */
/*-----------------------------------------------------------*/