/usr/include/ucl/ucl.h is in libucl-dev 1.03+repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | /* ucl.h -- prototypes for the UCL data compression library
This file is part of the UCL data compression library.
Copyright (C) 2004 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 2003 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
All Rights Reserved.
The UCL library is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
The UCL library 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with the UCL library; see the file COPYING.
If not, write to the Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
Markus F.X.J. Oberhumer
<markus@oberhumer.com>
http://www.oberhumer.com/opensource/ucl/
*/
#ifndef __UCL_H_INCLUDED
#define __UCL_H_INCLUDED
#ifndef __UCLCONF_H_INCLUDED
#include <ucl/uclconf.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/***********************************************************************
// Compression fine-tuning configuration.
//
// Pass a NULL pointer to the compression functions for default values.
// Otherwise set all values to -1 [i.e. initialize the struct by a
// `memset(x,0xff,sizeof(x))'] and then set the required values.
************************************************************************/
struct ucl_compress_config_t
{
int bb_endian;
int bb_size;
ucl_uint max_offset;
ucl_uint max_match;
int s_level;
int h_level;
int p_level;
int c_flags;
ucl_uint m_size;
};
#define ucl_compress_config_p ucl_compress_config_t __UCL_MMODEL *
/***********************************************************************
// compressors
//
// Pass NULL for `cb' (no progress callback), `conf' (default compression
// configuration) and `result' (no statistical result).
************************************************************************/
UCL_EXTERN(int)
ucl_nrv2b_99_compress ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_progress_callback_p cb,
int level,
const struct ucl_compress_config_p conf,
ucl_uintp result );
UCL_EXTERN(int)
ucl_nrv2d_99_compress ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_progress_callback_p cb,
int level,
const struct ucl_compress_config_p conf,
ucl_uintp result );
UCL_EXTERN(int)
ucl_nrv2e_99_compress ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_progress_callback_p cb,
int level,
const struct ucl_compress_config_p conf,
ucl_uintp result );
/***********************************************************************
// decompressors
//
// Always pass NULL for `wrkmem'. This parameter is for symetry
// with my other compression libaries and is not used in UCL -
// UCL does not need any additional memory (or even local stack space)
// for decompression.
************************************************************************/
UCL_EXTERN(int)
ucl_nrv2b_decompress_8 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2b_decompress_le16 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2b_decompress_le32 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2b_decompress_safe_8 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2b_decompress_safe_le16 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2b_decompress_safe_le32 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_decompress_8 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_decompress_le16 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_decompress_le32 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_decompress_safe_8 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_decompress_safe_le16 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_decompress_safe_le32 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_decompress_8 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_decompress_le16 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_decompress_le32 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_decompress_safe_8 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_decompress_safe_le16 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_decompress_safe_le32 ( const ucl_bytep src, ucl_uint src_len,
ucl_bytep dst, ucl_uintp dst_len,
ucl_voidp wrkmem );
/***********************************************************************
// assembler decompressors [TO BE ADDED]
************************************************************************/
/***********************************************************************
// test an overlapping in-place decompression within a buffer:
// - try a virtual decompression from &buf[src_off] -> &buf[0]
// - no data is actually written
// - only the bytes at buf[src_off..src_off+src_len-1] will get accessed
//
// NOTE: always pass NULL for `wrkmem' - see above.
************************************************************************/
UCL_EXTERN(int)
ucl_nrv2b_test_overlap_8 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2b_test_overlap_le16 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2b_test_overlap_le32 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_test_overlap_8 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_test_overlap_le16 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2d_test_overlap_le32 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_test_overlap_8 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_test_overlap_le16 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
UCL_EXTERN(int)
ucl_nrv2e_test_overlap_le32 ( const ucl_bytep buf, ucl_uint src_off,
ucl_uint src_len, ucl_uintp dst_len,
ucl_voidp wrkmem );
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* already included */
|