ccrush.h

Go to the documentation of this file.

/*
 
BSD 2-Clause License
 
Copyright (c) 2020, Raphael Beck
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/
 
#ifndef CCRUSH_LIBRARY_H
#define CCRUSH_LIBRARY_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(_WIN32) && defined(CCRUSH_DLL)
#ifdef CCRUSH_BUILD_DLL
#define CCRUSH_API __declspec(dllexport)
#else
#define CCRUSH_API __declspec(dllimport)
#endif
#else
#define CCRUSH_API
#endif
 
#include <stdio.h>
#include <stdint.h>
#include <stddef.h>
 
#define CCRUSH_VERSION 210
 
#define CCRUSH_VERSION_STR "2.1.0"
 
#ifndef CCRUSH_MAX_BUFFER_SIZE_KiB
#define CCRUSH_MAX_BUFFER_SIZE_KiB (1024 * 256)
#endif
 
#ifndef CCRUSH_DEFAULT_CHUNKSIZE
#define CCRUSH_DEFAULT_CHUNKSIZE (1024 * 256)
#endif
 
#define CCRUSH_ERROR_INVALID_ARGS 1000
 
#define CCRUSH_ERROR_BUFFERSIZE_TOO_LARGE 1001
 
#define CCRUSH_ERROR_FILE_ACCESS_FAILED 1002
 
#define CCRUSH_ERROR_OUT_OF_MEMORY 2000
 
#define CCRUSH_MIN(x, y) (((x) < (y)) ? (x) : (y))
 
#define CCRUSH_MAX(x, y) (((x) > (y)) ? (x) : (y))
 
#ifndef CCRUSH_MAX_WIN_FILEPATH_LENGTH
#define CCRUSH_MAX_WIN_FILEPATH_LENGTH (1024 * 32)
#endif
 
CCRUSH_API int ccrush_compress(const uint8_t* data, size_t data_length, uint32_t buffer_size_kib, int level, uint8_t** out, size_t* out_length);
 
CCRUSH_API int ccrush_compress_file(const char* input_file_path, const char* output_file_path, uint32_t buffer_size_kib, int level);
 
CCRUSH_API int ccrush_compress_file_raw(FILE* input_file, FILE* output_file, uint32_t buffer_size_kib, int level, int close_input_file, int close_output_file);
 
CCRUSH_API int ccrush_decompress(const uint8_t* data, size_t data_length, uint32_t buffer_size_kib, uint8_t** out, size_t* out_length);
 
CCRUSH_API int ccrush_decompress_file(const char* input_file_path, const char* output_file_path, uint32_t buffer_size_kib);
 
CCRUSH_API int ccrush_decompress_file_raw(FILE* input_file, FILE* output_file, uint32_t buffer_size_kib, int close_input_file, int close_output_file);
 
CCRUSH_API void ccrush_free(void* mem);
 
CCRUSH_API uint32_t ccrush_get_version_nr();
 
CCRUSH_API char* ccrush_get_version_nr_string();
 
static inline uint64_t ccrush_nextpow2(uint64_t n)
{
    n--;
    n |= n >> 1;
    n |= n >> 2;
    n |= n >> 4;
    n |= n >> 8;
    n |= n >> 16;
    n |= n >> 32;
    return ++n;
}
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // CCRUSH_LIBRARY_H