netcdf-c/ncdump/ref_tst_ncf213.cdl
Dennis Heimbigner 3ffe7be446 Enhance/Fix filter support
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.
2022-03-14 12:39:37 -06:00

50 lines
1.1 KiB
Plaintext

netcdf tst_ncf213 {
types:
compound obs_t {
byte day ;
short elev ;
int count ;
float relhum ;
double time ;
ubyte category ;
ushort id ;
uint particularity ;
int64 attention_span ;
}; // obs_t
dimensions:
dim1 = 10 ;
dim2 = 20 ;
dim3 = 30 ;
variables:
int var1(dim1) ;
var1:_Storage = "contiguous" ;
var1:_Endianness = "little" ;
int var2(dim1, dim2) ;
var2:_Storage = "chunked" ;
var2:_ChunkSizes = 6, 7 ;
var2:_Filter = "3" ;
var2:_Endianness = "big" ;
int var3(dim1, dim2, dim3) ;
var3:_Storage = "chunked" ;
var3:_ChunkSizes = 6, 7, 8 ;
var3:_Filter = "1,2" ;
var3:_Endianness = "little" ;
int var4(dim1, dim2, dim3) ;
var4:_Storage = "chunked" ;
var4:_ChunkSizes = 6, 7, 8 ;
var4:_Filter = "1,2" ;
var4:_Endianness = "little" ;
var4:_NoFill = "true" ;
obs_t var5(dim1) ;
var5:_Storage = "chunked" ;
var5:_ChunkSizes = 6 ;
var5:_Filter = "3|2,40|1,2" ;
var5:_NoFill = "true" ;
// global attributes:
:_NCProperties = "version=2,netcdf=4.6.2-development,hdf5=1.10.1" ;
:_SuperblockVersion = 0 ;
:_IsNetcdf4 = 1 ;
:_Format = "netCDF-4" ;
}