mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-11-21 03:13:42 +08:00
11fe00ea05
Filter support has three goals: 1. Use the existing HDF5 filter implementations, 2. Allow filter metadata to be stored in the NumCodecs metadata format used by Zarr, 3. Allow filters to be used even when HDF5 is disabled Detailed usage directions are define in docs/filters.md. For now, the existing filter API is left in place. So filters are defined using ''nc_def_var_filter'' using the HDF5 style where the id and parameters are unsigned integers. This is a big change since filters affect many parts of the code. In the following, the terms "compressor" and "filter" and "codec" are generally used synonomously. ### Filter-Related Changes: * In order to support dynamic loading of shared filter libraries, a new library was added in the libncpoco directory; it helps to isolate dynamic loading across multiple platforms. * Provide a json parsing library for use by plugins; this is created by merging libdispatch/ncjson.c with include/ncjson.h. * Add a new _Codecs attribute to allow clients to see what codecs are being used; let ncdump -s print it out. * Provide special headers to help support compilation of HDF5 filters when HDF5 is not enabled: netcdf_filter_hdf5_build.h and netcdf_filter_build.h. * Add a number of new test to test the new nczarr filters. * Let ncgen parse _Codecs attribute, although it is ignored. ### Plugin directory changes: * Add support for the Blosc compressor; this is essential because it is the most common compressor used in Zarr datasets. This also necessitated adding a CMake FindBlosc.cmake file * Add NCZarr support for the big-four filters provided by HDF5: shuffle, fletcher32, deflate (zlib), and szip * Add a Codec defaulter (see docs/filters.md) for the big four filters. * Make plugins work with windows by properly adding __declspec declaration. ### Misc. Non-Filter Changes * Replace most uses of USE_NETCDF4 (deprecated) with USE_HDF5. * Improve support for caching * More fixes for path conversion code * Fix misc. memory leaks * Add new utility -- ncdump/ncpathcvt -- that does more or less the same thing as cygpath. * Add a number of new test to test the non-filter fixes. * Update the parsers * Convert most instances of '#ifdef _MSC_VER' to '#ifdef _WIN32'
77 lines
2.3 KiB
C
Executable File
77 lines
2.3 KiB
C
Executable File
/*********************************************************************
|
|
* Copyright 1993, UCAR/Unidata
|
|
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
|
|
* Derived from poco library from Boost Software: see nccpoco/SourceLicence file.
|
|
*********************************************************************/
|
|
|
|
#ifndef NCPOCO_H
|
|
#define NCPOCO_H
|
|
|
|
/* Use NCP or nccp or ncpoco as our "namespace */
|
|
|
|
/* Forward */
|
|
typedef struct NCPSharedLib NCPSharedLib;
|
|
typedef enum NCP_Flags NCP_Flags;
|
|
|
|
enum NCP_Flags {
|
|
NCP_GLOBAL = 1, /* (default) use RTLD_GLOBAL; ignored on platforms that do not use dlopen(). */
|
|
NCP_LOCAL = 2 /* use RTLD_LOCAL; RTTI will not work with this flag. */
|
|
};
|
|
|
|
struct NCPSharedLib {
|
|
char* path;
|
|
int flags;
|
|
struct NCPstate {
|
|
void* handle;
|
|
int flags;
|
|
} state;
|
|
struct {
|
|
char msg[4096];
|
|
} err;
|
|
struct NCPAPI {
|
|
int (*init)(NCPSharedLib*);
|
|
int (*reclaim)(NCPSharedLib*); /* reclaim resources; do not free lib */
|
|
int (*load)(NCPSharedLib*,const char*,int);
|
|
int (*unload)(NCPSharedLib*);
|
|
int (*isloaded)(NCPSharedLib*);
|
|
void* (*getsymbol)(NCPSharedLib*,const char*);
|
|
const char* (*getpath)(NCPSharedLib*);
|
|
} api;
|
|
};
|
|
|
|
|
|
/**************************************************/
|
|
/* SharedLib API */
|
|
|
|
EXTERNL int ncpsharedlibnew(NCPSharedLib**); /* Creates a NCPSharedLib object. */
|
|
|
|
EXTERNL int ncpsharedlibfree(NCPSharedLib*); /* free this shared library */
|
|
|
|
/*
|
|
Loads a shared library from the given path using specified flags.
|
|
Returns error + message if a library has already been loaded or cannot be loaded.
|
|
*/
|
|
EXTERNL int ncpload(NCPSharedLib*,const char* path, int flags);
|
|
|
|
EXTERNL int ncpunload(NCPSharedLib*); /* Unloads a shared library. */
|
|
|
|
EXTERNL int ncpisloaded(NCPSharedLib*); /* Returns 1 iff a library has been loaded.*/
|
|
|
|
/* Returns the address of the symbol with the given name.
|
|
For functions, this is the entry point of the function.
|
|
Return NULL if the symbol does not exist
|
|
*/
|
|
EXTERNL void* ncpgetsymbol(NCPSharedLib*,const char* name);
|
|
|
|
/* Returns the path of the library, as specified in
|
|
a call to load(NCPSharedLib*)
|
|
*/
|
|
EXTERNL const char* ncpgetpath(NCPSharedLib*);
|
|
|
|
/* Return last err msg */
|
|
EXTERNL const char* ncpgeterrmsg(NCPSharedLib* lib);
|
|
|
|
EXTERNL const char* intstr(int err1);
|
|
|
|
#endif /*NCPOCO_H*/
|