cpl_compressor.h

Go to the documentation of this file.

/**********************************************************************
 * Project:  CPL - Common Portability Library
 * Purpose:  Registry of compression/decompression functions
 * Author:   Even Rouault <even.rouault at spatialys.com>
 *
 **********************************************************************
 * Copyright (c) 2021, Even Rouault <even.rouault at spatialys.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/
 
#include "cpl_port.h"
 
#include <stdbool.h>

 
CPL_C_START

typedef bool (*CPLCompressionFunc)(const void* input_data,
                                   size_t input_size,
                                   void** output_data,
                                   size_t* output_size,
                                   CSLConstList options,
                                   void* compressor_user_data);

typedef enum
{
    CCT_COMPRESSOR,
    CCT_FILTER
} CPLCompressorType;

typedef struct
{
    int                 nStructVersion;
    const char*         pszId;
    CPLCompressorType   eType;
    CSLConstList        papszMetadata;
    CPLCompressionFunc  pfnFunc;
    void*               user_data;
} CPLCompressor;
 
bool CPL_DLL CPLRegisterCompressor(const CPLCompressor* compressor);
 
bool CPL_DLL CPLRegisterDecompressor(const CPLCompressor* decompressor);
 
char CPL_DLL ** CPLGetCompressors(void);
 
char CPL_DLL ** CPLGetDecompressors(void);
 
const CPLCompressor CPL_DLL *CPLGetCompressor(const char* pszId);
 
const CPLCompressor CPL_DLL *CPLGetDecompressor(const char* pszId);

void CPL_DLL CPLDestroyCompressorRegistry(void);
 
CPL_C_END