zlib_compress.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (c) 2017, Fougue Ltd. <http://www.fougue.pro>
** 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
** OWNER 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.
****************************************************************************/

#pragma once

#include "global.h"

enum gmio_zlib_compress_level {
    GMIO_ZLIB_COMPRESS_LEVEL_NONE = -1,      
    GMIO_ZLIB_COMPRESS_LEVEL_DEFAULT = 0,    
    GMIO_ZLIB_COMPRESS_LEVEL_BEST_SPEED = 1, 
    GMIO_ZLIB_COMPRESS_LEVEL_BEST_SIZE = 9   
};

enum gmio_zlib_compress_strategy {
    GMIO_ZLIB_COMPRESSION_STRATEGY_DEFAULT = 0,   
    GMIO_ZLIB_COMPRESSION_STRATEGY_FILTERED = 1,  
    GMIO_ZLIB_COMPRESSION_STRATEGY_HUFFMAN_ONLY = 2, 
    GMIO_ZLIB_COMPRESSION_STRATEGY_RLE = 3,       
    GMIO_ZLIB_COMPRESSION_STRATEGY_FIXED = 4      
};

struct gmio_zlib_compress_options {
    uint8_t level;

    enum gmio_zlib_compress_strategy strategy;

    uint8_t memory_usage;

    void* (*func_alloc)(void* opaque, unsigned int items, unsigned int size);

    void  (*func_free)(void* opaque, void* address);

    void* opaque;
};