mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-27 08:49:16 +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'
103 lines
2.9 KiB
Bash
103 lines
2.9 KiB
Bash
#!/bin/bash
|
|
|
|
# Define a function that attempts to locate a
|
|
# plugin with a given canonical name.
|
|
# Assumptions:
|
|
# 1. plugins is a top-level directory, possibly in "build"
|
|
# Inputs:
|
|
# $1 is the canonical name
|
|
# $2 is 1 if we are running under cmake
|
|
# $3 is 1 if we are running using Visual Studio, blank otherwise
|
|
# $4 is the build type; only used if $3 is 1
|
|
# Optional Input:
|
|
# HDF5_PLUGIN_PATH environment variable
|
|
# Outputs:
|
|
# return code is 0 is success, 1 if failed
|
|
# Variable HDF5_PLUGIN_LIB is set to the library file name
|
|
# Variable HDF5_PLUGIN_PATH is setthe absolute path to the
|
|
# directory containing the plugin library file
|
|
# Local variables are prefixed with FP_
|
|
#
|
|
# Note: we assume that the use of the CMAKE_BUILD_TYPE
|
|
# is obviated by setting the LIBRARY_OUTPUT_DIRECTORY
|
|
# variables: see hdf5plugins/CMakeLists.txt
|
|
|
|
findplugin() {
|
|
|
|
FP_NAME="$1"
|
|
|
|
# Figure out the compiler (some values from ./configure)
|
|
FP_ISCMAKE=@ISCMAKE@
|
|
FP_ISMSVC=@ISMSVC@
|
|
FP_ISCYGWIN=@ISCYGWIN@
|
|
FP_ISOSX=@ISOSX@
|
|
|
|
FP_PLUGIN_LIB=
|
|
FP_PLUGIN_PATH=
|
|
|
|
# Figure out the plugin file name
|
|
# Test for visual studio before cygwin since both might be true
|
|
if test "x$FP_ISMSVC" != x ; then
|
|
FP_PLUGIN_LIB="${FP_NAME}.dll"
|
|
elif test "x$FP_ISCYGWIN" != x ; then
|
|
FP_PLUGIN_LIB="cyg${FP_NAME}.dll"
|
|
elif test "x$FP_ISOSX" != x ; then
|
|
FP_PLUGIN_LIB="lib${FP_NAME}.so" # Should this include the version number in the name?
|
|
else # Presumably some form on *nix"
|
|
FP_PLUGIN_LIB="lib${FP_NAME}.so"
|
|
fi
|
|
|
|
# If HDF5_PLUGIN_PATH is defined, then it overrides everything else.
|
|
if test "x$HDF5_PLUGIN_PATH" != x ; then
|
|
HDF5_PLUGIN_LIB="$FP_PLUGIN_LIB"
|
|
# HDF5_PLUGIN_PATH already set
|
|
HDF5_PLUGIN_PATH=`${NCPATHCVT} $HDF5_PLUGIN_PATH`
|
|
return 0;
|
|
fi
|
|
|
|
# Figure out the path to where the lib is stored
|
|
# This can probably be simplified
|
|
|
|
CURWD=`pwd`
|
|
cd ${TOPBUILDDIR}/plugins
|
|
FP_PLUGINS=`pwd`
|
|
cd ${CURWD}
|
|
|
|
# Case 1: Cmake with Visual Studio
|
|
# Do not know where to look for a dylib
|
|
# Case 1: Cmake with Visual Studio
|
|
if test "x$FP_ISCMAKE" != x -a "x${FP_ISMSVC}" != x ; then
|
|
# Case 1a: ignore the build type directory
|
|
if test -f "${FP_PLUGINS}/${FP_PLUGIN_LIB}" ; then
|
|
FP_PLUGIN_PATH="${FP_PLUGINS}"
|
|
fi
|
|
else # Case 2: automake
|
|
# Case 2a: look in .libs
|
|
if test -f "${FP_PLUGINS}/.libs/${FP_PLUGIN_LIB}" ; then
|
|
FP_PLUGIN_PATH="${FP_PLUGINS}/.libs"
|
|
else # Case 2: look in FP_PLUGINS directly
|
|
if test -f "${FP_PLUGINS}/${FP_PLUGIN_LIB}" ; then
|
|
FP_PLUGIN_PATH="${FP_PLUGINS}"
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
# Verify
|
|
if test "x$FP_PLUGIN_PATH" = x ; then
|
|
echo "***Fail: Could not locate a usable HDF5_PLUGIN_PATH"
|
|
return 1
|
|
fi
|
|
if ! test -f "$FP_PLUGIN_PATH/$FP_PLUGIN_LIB" ; then
|
|
echo "***Fail: Could not locate a usable HDF5_PLUGIN_LIB"
|
|
return 1
|
|
fi
|
|
|
|
FP_PLUGIN_PATH=`${NCPATHCVT} $FP_PLUGIN_PATH`
|
|
|
|
# Set the final output variables
|
|
HDF5_PLUGIN_LIB="$FP_PLUGIN_LIB"
|
|
HDF5_PLUGIN_PATH="$FP_PLUGIN_PATH"
|
|
|
|
return 0
|
|
}
|