GDAL

cpl_compressor.h
Go to the documentation of this file.
1 /**********************************************************************
2 * Project: CPL - Common Portability Library
3 * Purpose: Registry of compression/decompression functions
4 * Author: Even Rouault <even.rouault at spatialys.com>
5 *
6 **********************************************************************
7 * Copyright (c) 2021, Even Rouault <even.rouault at spatialys.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 * DEALINGS IN THE SOFTWARE.
26 ****************************************************************************/
27
28 #include "cpl_port.h"
29
30 #include <stdbool.h>
31
38 CPL_C_START
39
70 typedef bool (*CPLCompressionFunc)(const void* input_data,
71 size_t input_size,
72 void** output_data,
73 size_t* output_size,
74 CSLConstList options,
75 void* compressor_user_data);
76
78 typedef enum
79 {
81 CCT_COMPRESSOR,
83 CCT_FILTER
84 } CPLCompressorType;
85
87 typedef struct
88 {
90 int nStructVersion;
92 const char* pszId;
94 CPLCompressorType eType;
102 CSLConstList papszMetadata;
104 CPLCompressionFunc pfnFunc;
106 void* user_data;
107 } CPLCompressor;
108
109 bool CPL_DLL CPLRegisterCompressor(const CPLCompressor* compressor);
110
111 bool CPL_DLL CPLRegisterDecompressor(const CPLCompressor* decompressor);
112
113 char CPL_DLL ** CPLGetCompressors(void);
114
115 char CPL_DLL ** CPLGetDecompressors(void);
116
117 const CPLCompressor CPL_DLL *CPLGetCompressor(const char* pszId);
118
119 const CPLCompressor CPL_DLL *CPLGetDecompressor(const char* pszId);
120
122 void CPL_DLL CPLDestroyCompressorRegistry(void);
125 CPL_C_END
CPLCompressor::pfnFunc
CPLCompressionFunc pfnFunc
Compressor/decompressor callback.
Definition: cpl_compressor.h:104
CPLCompressor::pszId
const char * pszId
Id of the compressor/decompressor.
Definition: cpl_compressor.h:92
CCT_COMPRESSOR
@ CCT_COMPRESSOR
Compressor.
Definition: cpl_compressor.h:81
CPLRegisterDecompressor
bool CPLRegisterDecompressor(const CPLCompressor *decompressor)
Register a new decompressor.
Definition: cpl_compressor.cpp:1784
CPLCompressorType
CPLCompressorType
Type of compressor.
Definition: cpl_compressor.h:78
CPLCompressor::papszMetadata
CSLConstList papszMetadata
Metadata, as a NULL terminated list of strings.
Definition: cpl_compressor.h:102
CPLCompressor::eType
CPLCompressorType eType
Compressor type.
Definition: cpl_compressor.h:94
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:329
CPLRegisterCompressor
bool CPLRegisterCompressor(const CPLCompressor *compressor)
Register a new compressor.
Definition: cpl_compressor.cpp:1752
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1169
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:331
CPLGetDecompressor
const CPLCompressor * CPLGetDecompressor(const char *pszId)
Return a decompressor.
Definition: cpl_compressor.cpp:1884
CPLGetCompressor
const CPLCompressor * CPLGetCompressor(const char *pszId)
Return a compressor.
Definition: cpl_compressor.cpp:1858
CPLCompressor
Compressor/decompressor description.
Definition: cpl_compressor.h:87
CPLCompressionFunc
bool(* CPLCompressionFunc)(const void *input_data, size_t input_size, void **output_data, size_t *output_size, CSLConstList options, void *compressor_user_data)
Callback of a compressor/decompressor.
Definition: cpl_compressor.h:70
CPLGetCompressors
char ** CPLGetCompressors(void)
Return the list of registered compressors.
Definition: cpl_compressor.cpp:1813
cpl_port.h
CPLGetDecompressors
char ** CPLGetDecompressors(void)
Return the list of registered decompressors.
Definition: cpl_compressor.cpp:1835
CPLCompressor::user_data
void * user_data
User data to provide to the callback.
Definition: cpl_compressor.h:106
CCT_FILTER
@ CCT_FILTER
Filter.
Definition: cpl_compressor.h:83
CPLCompressor::nStructVersion
int nStructVersion
Structure version.
Definition: cpl_compressor.h:90