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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
extern crate libc; use libc::{c_int, size_t, c_void, c_char}; pub const BLOSC_VERSION_MAJOR: u32 = 1; pub const BLOSC_VERSION_MINOR: u32 = 7; pub const BLOSC_VERSION_RELEASE: u32 = 1; pub const BLOSC_VERSION_STRING: &'static str = "1.7.1.dev"; pub const BLOSC_VERSION_REVISION: &'static str = "$Rev$"; pub const BLOSC_VERSION_DATE: &'static str = "$Date:: 2015-07-05 #$"; pub const BLOSCLZ_VERSION_STRING: &'static str = "1.0.5"; pub const BLOSC_VERSION_FORMAT: u32 = 2; pub const BLOSC_MIN_HEADER_LENGTH: u32 = 16; pub const BLOSC_MAX_OVERHEAD: u32 = BLOSC_MIN_HEADER_LENGTH; pub const BLOSC_MAX_BUFFERSIZE: i32 = (std::i32::MAX - BLOSC_MAX_OVERHEAD as i32); pub const BLOSC_MAX_TYPESIZE: u32 = 255; pub const BLOSC_MAX_THREADS: u32 = 256; pub const BLOSC_NOSHUFFLE: u32 = 0; pub const BLOSC_SHUFFLE: u32 = 1; pub const BLOSC_BITSHUFFLE: u32 = 2; pub const BLOSC_DOSHUFFLE: u32 = 0x1; pub const BLOSC_MEMCPYED: u32 = 0x2; pub const BLOSC_DOBITSHUFFLE: u32 = 0x4; pub const BLOSC_BLOSCLZ: u32 = 0; pub const BLOSC_LZ4: u32 = 1; pub const BLOSC_LZ4HC: u32 = 2; pub const BLOSC_SNAPPY: u32 = 3; pub const BLOSC_ZLIB: u32 = 4; pub const BLOSC_BLOSCLZ_COMPNAME: &'static str = "blosclz"; pub const BLOSC_LZ4_COMPNAME: &'static str = "lz4"; pub const BLOSC_LZ4HC_COMPNAME: &'static str = "lz4hc"; pub const BLOSC_SNAPPY_COMPNAME: &'static str = "snappy"; pub const BLOSC_ZLIB_COMPNAME: &'static str = "zlib"; pub const BLOSC_BLOSCLZ_LIB: u32 = 0; pub const BLOSC_LZ4_LIB: u32 = 1; pub const BLOSC_SNAPPY_LIB: u32 = 2; pub const BLOSC_ZLIB_LIB: u32 = 3; pub const BLOSC_BLOSCLZ_LIBNAME: &'static str = "BloscLZ"; pub const BLOSC_LZ4_LIBNAME: &'static str = "LZ4"; pub const BLOSC_SNAPPY_LIBNAME: &'static str = "Snappy"; pub const BLOSC_ZLIB_LIBNAME: &'static str = "Zlib"; pub const BLOSC_BLOSCLZ_FORMAT: u32 =BLOSC_BLOSCLZ_LIB; pub const BLOSC_LZ4_FORMAT: u32 = BLOSC_LZ4_LIB; pub const BLOSC_LZ4HC_FORMAT: u32 = BLOSC_LZ4_LIB; pub const BLOSC_SNAPPY_FORMAT: u32 = BLOSC_SNAPPY_LIB; pub const BLOSC_ZLIB_FORMAT: u32 = BLOSC_ZLIB_LIB; pub const BLOSC_BLOSCLZ_VERSION_FORMAT: u32 = 1; pub const BLOSC_LZ4_VERSION_FORMAT: u32 = 1; pub const BLOSC_LZ4HC_VERSION_FORMAT: u32 = 1; pub const BLOSC_SNAPPY_VERSION_FORMAT: u32 = 1; pub const BLOSC_ZLIB_VERSION_FORMAT: u32 = 1; extern "C" { /** Initialize the Blosc library environment. You must call this previous to any other Blosc call, unless you want Blosc to be used simultaneously in a multi-threaded environment, in which case you should *exclusively* use the blosc_compress_ctx()/blosc_decompress_ctx() pair (see below). */ pub fn blosc_init(); /** Destroy the Blosc library environment. You must call this after to you are done with all the Blosc calls, unless you have not used blosc_init() before (see blosc_init() above). */ pub fn blosc_destroy(); /** Compress a block of data in the `src` buffer and returns the size of compressed block. The size of `src` buffer is specified by `nbytes`. There is not a minimum for `src` buffer size (`nbytes`). `clevel` is the desired compression level and must be a number between 0 (no compression) and 9 (maximum compression). `doshuffle` specifies whether the shuffle compression preconditioner should be applied or not. BLOSC_NOSHUFFLE means not applying it, BLOSC_SHUFFLE means applying it at a byte level and BLOSC_BITSHUFFLE at a bit level (slower but may achieve better entropy alignment). `typesize` is the number of bytes for the atomic type in binary `src` buffer. This is mainly useful for the shuffle preconditioner. For implementation reasons, only a 1 < typesize < 256 will allow the shuffle filter to work. When typesize is not in this range, shuffle will be silently disabled. The `dest` buffer must have at least the size of `destsize`. Blosc guarantees that if you set `destsize` to, at least, (`nbytes`+BLOSC_MAX_OVERHEAD), the compression will always succeed. The `src` buffer and the `dest` buffer can not overlap. Compression is memory safe and guaranteed not to write the `dest` buffer more than what is specified in `destsize`. If `src` buffer cannot be compressed into `destsize`, the return value is zero and you should discard the contents of the `dest` buffer. A negative return value means that an internal error happened. This should never happen. If you see this, please report it back together with the buffer data causing this and compression settings. */ pub fn blosc_compress(clevel: c_int, doshuffle: c_int, typesize: size_t, nbytes: size_t, src: *const c_void, dest: *mut c_void, destsize: size_t) -> c_int; /** Context interface to blosc compression. This does not require a call to blosc_init() and can be called from multithreaded applications without the global lock being used, so allowing Blosc be executed simultaneously in those scenarios. It uses the same parameters than the blosc_compress() function plus: `compressor`: the string representing the type of compressor to use. `blocksize`: the requested size of the compressed blocks. If 0, an automatic blocksize will be used. `numinternalthreads`: the number of threads to use internally. A negative return value means that an internal error happened. This should never happen. If you see this, please report it back together with the buffer data causing this and compression settings. */ pub fn blosc_compress_ctx(clevel: c_int, doshuffle: c_int, typesize: size_t, nbytes: size_t, src: *const c_void, dest: *mut c_void, destsize: size_t, compressor: *const u8, blocksize: size_t, numinternalthreads: c_int) -> c_int; /** Decompress a block of compressed data in `src`, put the result in `dest` and returns the size of the decompressed block. The `src` buffer and the `dest` buffer can not overlap. Decompression is memory safe and guaranteed not to write the `dest` buffer more than what is specified in `destsize`. If an error occurs, e.g. the compressed data is corrupted or the output buffer is not large enough, then 0 (zero) or a negative value will be returned instead. */ pub fn blosc_decompress(src: *const c_void, dest: *mut c_void, destsize: size_t) -> c_int; /** Context interface to blosc decompression. This does not require a call to blosc_init() and can be called from multithreaded applications without the global lock being used, so allowing Blosc be executed simultaneously in those scenarios. It uses the same parameters than the blosc_decompress() function plus: `numinternalthreads`: number of threads to use internally. Decompression is memory safe and guaranteed not to write the `dest` buffer more than what is specified in `destsize`. If an error occurs, e.g. the compressed data is corrupted or the output buffer is not large enough, then 0 (zero) or a negative value will be returned instead. */ pub fn blosc_decompress_ctx(src: *const c_void, dest: *mut c_void, destsize: size_t, numinternalthreads: c_int) -> c_int; /** Get `nitems` (of typesize size) in `src` buffer starting in `start`. The items are returned in `dest` buffer, which has to have enough space for storing all items. Returns the number of bytes copied to `dest` or a negative value if some error happens. */ pub fn blosc_getitem(src: *const c_void, start: c_int, nitems: c_int, dest: *mut c_void) -> c_int; /** Initialize a pool of threads for compression/decompression. If `nthreads` is 1, then the serial version is chosen and a possible previous existing pool is ended. If this is not called, `nthreads` is set to 1 internally. Returns the previous number of threads. */ pub fn blosc_set_nthreads(nthreads: c_int) -> c_int; /** Select the compressor to be used. The supported ones are "blosclz", "lz4", "lz4hc", "snappy" and "zlib". If this function is not called, then "blosclz" will be used. In case the compressor is not recognized, or there is not support for it in this build, it returns a -1. Else it returns the code for the compressor (>=0). */ pub fn blosc_set_compressor(compname: *const c_char) -> c_int; /** Get the `compname` associated with the `compcode`. If the compressor code is not recognized, or there is not support for it in this build, -1 is returned. Else, the compressor code is returned. */ pub fn blosc_compcode_to_compname(compcode: c_int, copmname: *mut *mut c_char) -> c_int; /** Return the compressor code associated with the compressor name. If the compressor name is not recognized, or there is not support for it in this build, -1 is returned instead. */ pub fn blosc_compname_to_compcode(compname: *const c_char) -> c_int; /** Get a list of compressors supported in the current build. The returned value is a string with a concatenation of "blosclz", "lz4", "lz4hc", "snappy" or "zlib" separated by commas, depending on which ones are present in the build. This function does not leak, so you should not free() the returned list. This function should always succeed. */ pub fn blosc_list_compressors() -> *const c_char; /** Return the version of blosc in string format. Useful for dynamic libraries. */ pub fn blosc_get_version_string() -> *const c_char; /** Get info from compression libraries included in the current build. In `compname` you pass the compressor name that you want info from. In `complib` and `version` you get the compression library name and version (if available) as output. In `complib` and `version` you get a pointer to the compressor library name and the version in string format respectively. After using the name and version, you should free() them so as to avoid leaks. If the compressor is supported, it returns the code for the library (>=0). If it is not supported, this function returns -1. */ pub fn blosc_get_complib_info(compname: *mut c_char, complib: *mut *mut c_char, version: *mut *mut c_char) -> c_int; /** Free possible memory temporaries and thread resources. Use this when you are not going to use Blosc for a long while. In case of problems releasing the resources, it returns a negative number, else it returns 0. */ pub fn blosc_free_resources(); /** Return information about a compressed buffer, namely the number of uncompressed bytes (`nbytes`) and compressed (`cbytes`). It also returns the `blocksize` (which is used internally for doing the compression by blocks). You only need to pass the first BLOSC_MIN_HEADER_LENGTH bytes of a compressed buffer for this call to work. This function should always succeed. */ pub fn blosc_cbuffer_sizes(cbuffer: *const c_void, nbytes: *mut size_t, cbytes: *mut size_t, blocksize: *mut size_t); /** Return information about a compressed buffer, namely the type size (`typesize`), as well as some internal `flags`. The `flags` is a set of bits, where the currently used ones are: * bit 0: whether the shuffle filter has been applied or not * bit 1: whether the internal buffer is a pure memcpy or not You can use the `BLOSC_DOSHUFFLE`, `BLOSC_DOBITSHUFFLE` and `BLOSC_MEMCPYED` symbols for extracting the interesting bits (e.g. ``flags & BLOSC_DOSHUFFLE`` says whether the buffer is byte-shuffled or not). This function should always succeed. */ pub fn blosc_cbuffer_metainfo(cbuffer: *const c_void, typesize: *mut size_t, flags: *mut c_int); /** Return information about a compressed buffer, namely the internal Blosc format version (`version`) and the format for the internal Lempel-Ziv compressor used (`versionlz`). This function should always succeed. */ pub fn blosc_cbuffer_versions(cbuffer: *const c_void, version: *mut c_int, versionlz: *mut c_int); /** Return the compressor library/format used in a compressed buffer. This function should always succeed. */ pub fn blosc_cbuffer_complib(cbuffer: *const c_void) -> *mut c_char; /** Force the use of a specific blocksize. If 0, an automatic blocksize will be used (the default). */ pub fn blosc_set_blocksize(blocksize: size_t); }