mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-03 08:01:25 +08:00
3ffe7be446
re: Discussion https://github.com/Unidata/netcdf-c/discussions/2214 The primary change is to support so-called "standard filters". A standard filter is one that is defined by the following netcdf-c API: ```` int nc_def_var_XXX(int ncid, int varid, size_t nparams, unsigned* params); int nc_inq_var_XXXX(int ncid, int varid, int* usefilterp, unsigned* params); ```` So for example, zstandard would be a standard filter by defining the functions *nc_def_var_zstandard* and *nc_inq_var_zstandard*. In order to define these functions, we need a new dispatch function: ```` int nc_inq_filter_avail(int ncid, unsigned filterid); ```` This function, combined with the existing filter API can be used to implement arbitrary standard filters using a simple code pattern. Note that I would have preferred that this function return a list of all available filters, but HDF5 does not support that functionality. So this PR implements the dispatch function and implements the following standard functions: + bzip2 + zstandard + blosc Specific test cases are also provided for HDF5 and NCZarr. Over time, other specific standard filters will be defined. ## Primary Changes * Add nc_inq_filter_avail() to netcdf-c API. * Add standard filter implementations to test use of *nc_inq_filter_avail*. * Bump the dispatch table version number and add to all the relevant dispatch tables (libsrc, libsrcp, etc). * Create a program to invoke nc_inq_filter_avail so that it is accessible to shell scripts. * Cleanup szip support to properly support szip when HDF5 is disabled. This involves detecting libsz separately from testing if HDF5 supports szip. * Integrate shuffle and fletcher32 into the existing filter API. This means that, for example, nc_def_var_fletcher32 is now a wrapper around nc_def_var_filter. * Extend the Codec defaulting to allow multiple default shared libraries. ## Misc. Changes * Modify configure.ac/CMakeLists.txt to look for the relevant libraries implementing standard filters. * Modify libnetcdf.settings to list available standard filters (including deflate and szip). * Add CMake test modules to locate libbz2 and libzstd. * Cleanup the HDF5 memory manager function use in the plugins. * remove unused file include//ncfilter.h * remove tests for the HDF5 memory operations e.g. H5allocate_memory. * Add flag to ncdump to force use of _Filter instead of _Deflate or _Shuffle or _Fletcher32. Used for testing.
148 lines
2.8 KiB
C
148 lines
2.8 KiB
C
/* Copyright 2005-2018 University Corporation for Atmospheric
|
|
Research/Unidata. */
|
|
/**
|
|
* @file
|
|
* @internal This header file contains prototypes and initialization
|
|
* for the HDF5 dispatch layer.
|
|
*
|
|
* @author Ed Hartnett, Dennis Heimbigner
|
|
*/
|
|
|
|
#include "config.h"
|
|
#include "hdf5internal.h"
|
|
|
|
#ifdef ENABLE_BYTERANGE
|
|
#include "H5FDhttp.h"
|
|
#endif
|
|
|
|
static const NC_Dispatch HDF5_dispatcher = {
|
|
|
|
NC_FORMATX_NC4,
|
|
NC_DISPATCH_VERSION,
|
|
|
|
NC4_create,
|
|
NC4_open,
|
|
|
|
NC4_redef,
|
|
NC4__enddef,
|
|
NC4_sync,
|
|
NC4_abort,
|
|
NC4_close,
|
|
NC4_set_fill,
|
|
NC4_inq_format,
|
|
NC4_inq_format_extended,
|
|
|
|
NC4_inq,
|
|
NC4_inq_type,
|
|
|
|
HDF5_def_dim,
|
|
NC4_inq_dimid,
|
|
HDF5_inq_dim,
|
|
NC4_inq_unlimdim,
|
|
HDF5_rename_dim,
|
|
|
|
NC4_HDF5_inq_att,
|
|
NC4_HDF5_inq_attid,
|
|
NC4_HDF5_inq_attname,
|
|
NC4_HDF5_rename_att,
|
|
NC4_HDF5_del_att,
|
|
NC4_HDF5_get_att,
|
|
NC4_HDF5_put_att,
|
|
|
|
NC4_def_var,
|
|
NC4_inq_varid,
|
|
NC4_rename_var,
|
|
NC4_get_vara,
|
|
NC4_put_vara,
|
|
NC4_get_vars,
|
|
NC4_put_vars,
|
|
NCDEFAULT_get_varm,
|
|
NCDEFAULT_put_varm,
|
|
|
|
NC4_HDF5_inq_var_all,
|
|
|
|
NC4_var_par_access,
|
|
NC4_def_var_fill,
|
|
|
|
NC4_show_metadata,
|
|
NC4_inq_unlimdims,
|
|
|
|
NC4_inq_ncid,
|
|
NC4_inq_grps,
|
|
NC4_inq_grpname,
|
|
NC4_inq_grpname_full,
|
|
NC4_inq_grp_parent,
|
|
NC4_inq_grp_full_ncid,
|
|
NC4_inq_varids,
|
|
NC4_inq_dimids,
|
|
NC4_inq_typeids,
|
|
NC4_inq_type_equal,
|
|
NC4_def_grp,
|
|
NC4_rename_grp,
|
|
NC4_inq_user_type,
|
|
NC4_inq_typeid,
|
|
|
|
NC4_def_compound,
|
|
NC4_insert_compound,
|
|
NC4_insert_array_compound,
|
|
NC4_inq_compound_field,
|
|
NC4_inq_compound_fieldindex,
|
|
NC4_def_vlen,
|
|
NC4_put_vlen_element,
|
|
NC4_get_vlen_element,
|
|
NC4_def_enum,
|
|
NC4_insert_enum,
|
|
NC4_inq_enum_member,
|
|
NC4_inq_enum_ident,
|
|
NC4_def_opaque,
|
|
NC4_def_var_deflate,
|
|
NC4_def_var_fletcher32,
|
|
NC4_def_var_chunking,
|
|
NC4_def_var_endian,
|
|
NC4_hdf5_def_var_filter,
|
|
NC4_HDF5_set_var_chunk_cache,
|
|
NC4_get_var_chunk_cache,
|
|
|
|
NC4_hdf5_inq_var_filter_ids,
|
|
NC4_hdf5_inq_var_filter_info,
|
|
|
|
NC4_def_var_quantize,
|
|
NC4_inq_var_quantize,
|
|
|
|
NC4_hdf5_inq_filter_avail,
|
|
};
|
|
|
|
const NC_Dispatch* HDF5_dispatch_table = NULL; /* moved here from ddispatch.c */
|
|
|
|
/**
|
|
* @internal Initialize the HDF5 dispatch layer.
|
|
*
|
|
* @return ::NC_NOERR No error.
|
|
* @author Ed Hartnett
|
|
*/
|
|
int
|
|
NC_HDF5_initialize(void)
|
|
{
|
|
HDF5_dispatch_table = &HDF5_dispatcher;
|
|
if (!nc4_hdf5_initialized)
|
|
nc4_hdf5_initialize();
|
|
|
|
#ifdef ENABLE_BYTERANGE
|
|
(void)H5FD_http_init();
|
|
#endif
|
|
return NC4_provenance_init();
|
|
}
|
|
|
|
/**
|
|
* @internal Finalize the HDF5 dispatch layer.
|
|
*
|
|
* @return ::NC_NOERR No error.
|
|
* @author Dennis Heimbigner
|
|
*/
|
|
int
|
|
NC_HDF5_finalize(void)
|
|
{
|
|
(void)nc4_hdf5_finalize();
|
|
return NC_NOERR;
|
|
}
|