NetCDF 4.9.3-rc3
Loading...
Searching...
No Matches
dfilter.c
Go to the documentation of this file.
1/*
2 * Copyright 2018, University Corporation for Atmospheric Research
3 * See netcdf/COPYRIGHT file for copying and redistribution conditions.
4 */
10#include "config.h"
11#include <stdlib.h>
12#include <stdio.h>
13#include <string.h>
14#ifdef _MSC_VER
15#include <io.h>
16#endif
17
18#include "netcdf.h"
19#include "netcdf_filter.h"
20#include "ncdispatch.h"
21#include "nc4internal.h"
22#include "nclog.h"
23
24#ifdef USE_HDF5
25#include "hdf5internal.h"
26#endif
27
28#ifdef NETCDF_ENABLE_NCZARR
29#include "zdispatch.h"
30#endif
31
32static void byteswap8(unsigned char*);
33static void byteswap4(unsigned char*);
34
35/*
36Unified filter related code
37*/
38
39/**************************************************/
40/* Per-variable filters */
41
61EXTERNL int
62nc_inq_var_filter_ids(int ncid, int varid, size_t* nfiltersp, unsigned int* ids)
63{
64 NC* ncp;
65 int stat = NC_check_id(ncid,&ncp);
66 if(stat != NC_NOERR) return stat;
68 if((stat = ncp->dispatch->inq_var_filter_ids(ncid,varid,nfiltersp,ids))) goto done;
69
70done:
71 return stat;
72}
73
97EXTERNL int
98nc_inq_var_filter_info(int ncid, int varid, unsigned int id, size_t* nparamsp, unsigned int* params)
99{
100 NC* ncp;
101 int stat = NC_check_id(ncid,&ncp);
102 if(stat != NC_NOERR) return stat;
104 if((stat = ncp->dispatch->inq_var_filter_info(ncid,varid,id,nparamsp,params))) goto done;
105
106done:
107 if(stat == NC_ENOFILTER) nclog(NCLOGWARN,"Undefined filter: %u",(unsigned)id);
108 return stat;
109}
110
128EXTERNL int
129nc_def_var_filter(int ncid, int varid, unsigned int id, size_t nparams, const unsigned int* params)
130{
131 int stat = NC_NOERR;
132 NC* ncp;
133
134 TRACE(nc_inq_var_filter);
135 if((stat = NC_check_id(ncid,&ncp))) return stat;
136 if((stat = ncp->dispatch->def_var_filter(ncid,varid,id,nparams,params))) goto done;
137done:
138 if(stat == NC_ENOFILTER) nclog(NCLOGWARN,"Undefined filter: %u",(unsigned)id);
139 return stat;
140}
141
169EXTERNL int
170nc_inq_var_filter(int ncid, int varid, unsigned int* idp, size_t* nparamsp, unsigned int* params)
171{
172 NC* ncp;
173 size_t nfilters;
174 unsigned int* ids = NULL;
175 int stat = NC_check_id(ncid,&ncp);
176
177 if(stat != NC_NOERR) return stat;
178 TRACE(nc_inq_var_filter);
179
180 /* Get the number of filters on this variable */
181 if((stat = nc_inq_var_filter_ids(ncid,varid,&nfilters, NULL))) goto done;
182 /* If no filters, then return zero */
183 if(nfilters == 0) {
184 if(idp) *idp = 0;
185 goto done;
186 }
187 /* Get the filter ids */
188 if((ids = calloc(sizeof(unsigned int),nfilters)) == NULL) {stat = NC_ENOMEM; goto done;}
189 if((stat = nc_inq_var_filter_ids(ncid,varid,&nfilters, ids))) goto done;
190 /* Get params for the first filter */
191 if((stat = nc_inq_var_filter_info(ncid,varid,ids[0],nparamsp,params))) goto done;
192 if(idp) *idp = ids[0];
193 done:
194 nullfree(ids);
195 return stat;
196}
197
211EXTERNL int
212nc_inq_filter_avail(int ncid, unsigned id)
213{
214 int stat = NC_NOERR;
215 NC* ncp;
216
217 stat = NC_check_id(ncid,&ncp);
218 if(stat != NC_NOERR) return stat;
219 if((stat = ncp->dispatch->inq_filter_avail(ncid,id))) goto done;
220done:
221 return stat;
222}
223
224/**************************************************/
225/* Functions for accessing standardized filters */
226
238int
239nc_def_var_bzip2(int ncid, int varid, int level)
240{
241 int stat = NC_NOERR;
242 unsigned ulevel;
243
244 if((stat = nc_inq_filter_avail(ncid,H5Z_FILTER_BZIP2))) goto done;
245 /* Filter is available */
246 /* 1 <= Level <= 9 */
247 if (level < 1 || level > 9)
248 return NC_EINVAL;
249 ulevel = (unsigned) level; /* Keep bit pattern */
250 if((stat = nc_def_var_filter(ncid,varid,H5Z_FILTER_BZIP2,1,&ulevel))) goto done;
251done:
252 return stat;
253}
254
269int
270nc_inq_var_bzip2(int ncid, int varid, int* hasfilterp, int *levelp)
271{
272 int stat = NC_NOERR;
273 size_t nparams;
274 unsigned params = 0;
275 int hasfilter = 0;
276
277 if((stat = nc_inq_filter_avail(ncid,H5Z_FILTER_BZIP2))) goto done;
278 /* Filter is available */
279 /* Get filter info */
280 stat = nc_inq_var_filter_info(ncid,varid,H5Z_FILTER_BZIP2,&nparams,NULL);
281 if(stat == NC_ENOFILTER) {stat = NC_NOERR; hasfilter = 0; goto done;}
282 if(stat != NC_NOERR) goto done;
283 hasfilter = 1;
284 if(nparams != 1) {stat = NC_EFILTER; goto done;}
285 if((stat = nc_inq_var_filter_info(ncid,varid,H5Z_FILTER_BZIP2,&nparams,&params))) goto done;
286done:
287 if(levelp) *levelp = (int)params;
288 if(hasfilterp) *hasfilterp = hasfilter;
289 return stat;
290}
291
306int
307nc_def_var_zstandard(int ncid, int varid, int level)
308{
309#ifdef HAVE_ZSTD
310 int stat = NC_NOERR;
311 unsigned ulevel;
312
313 if((stat = nc_inq_filter_avail(ncid,H5Z_FILTER_ZSTD))) goto done;
314 /* Filter is available */
315 /* Level must be between -131072 and 22 on Zstandard v. 1.4.5 (~202009)
316 Earlier versions have fewer levels (especially fewer negative levels) */
317 if (level < -131072 || level > 22)
318 return NC_EINVAL;
319 ulevel = (unsigned) level; /* Keep bit pattern */
320 if((stat = nc_def_var_filter(ncid,varid,H5Z_FILTER_ZSTD,1,&ulevel))) goto done;
321done:
322 return stat;
323#else
324 return NC_NOERR;
325#endif /*HAVE_ZSTD*/
326}
327
342int
343nc_inq_var_zstandard(int ncid, int varid, int* hasfilterp, int *levelp)
344{
345#ifdef HAVE_ZSTD
346 int stat = NC_NOERR;
347 size_t nparams;
348 unsigned params = 0;
349 int hasfilter = 0;
350
351 if((stat = nc_inq_filter_avail(ncid,H5Z_FILTER_ZSTD))) goto done;
352 /* Filter is available */
353 /* Get filter info */
354 stat = nc_inq_var_filter_info(ncid,varid,H5Z_FILTER_ZSTD,&nparams,NULL);
355 if(stat == NC_ENOFILTER) {stat = NC_NOERR; hasfilter = 0; goto done;}
356 if(stat != NC_NOERR) goto done;
357 hasfilter = 1;
358 if(nparams != 1) {stat = NC_EFILTER; goto done;}
359 if((stat = nc_inq_var_filter_info(ncid,varid,H5Z_FILTER_ZSTD,&nparams,&params))) goto done;
360done:
361 if(levelp) *levelp = (int)params;
362 if(hasfilterp) *hasfilterp = hasfilter;
363 return stat;
364#else
365 return NC_NOERR;
366#endif /*HAVE_ZSTD*/
367}
368
383int
384nc_def_var_blosc(int ncid, int varid, unsigned subcompressor, unsigned level, unsigned blocksize, unsigned addshuffle)
385{
386#ifdef HAVE_BLOSC
387 int stat = NC_NOERR;
388 unsigned params[7];;
389
390 if((stat = nc_inq_filter_avail(ncid,H5Z_FILTER_BLOSC))) goto done;
391 /* Filter is available */
392
393 /* Verify parameters */
394 if(addshuffle > (unsigned)BLOSC_BITSHUFFLE) {stat = NC_EINVAL; goto done;}
395 if(subcompressor > (unsigned)BLOSC_ZSTD) {stat = NC_EINVAL; goto done;}
396
397 /* Set the parameters */
398 params[0] = 0;
399 params[1] = 0;
400 params[2] = 0;
401 params[3] = blocksize;
402 params[4] = level;
403 params[5] = addshuffle;
404 params[6] = subcompressor;
405 if((stat = nc_def_var_filter(ncid,varid,H5Z_FILTER_BLOSC,7,params))) goto done;
406done:
407 return stat;
408#else
409 return NC_NOERR;
410#endif
411}
412
433int
434nc_inq_var_blosc(int ncid, int varid, int* hasfilterp, unsigned* subcompressorp,
435 unsigned* levelp, unsigned* blocksizep, unsigned* addshufflep)
436{
437#ifdef HAVE_BLOSC
438 int stat = NC_NOERR;
439 size_t nparams;
440 unsigned params[7];
441 int hasfilter = 0;
442
443 if((stat = nc_inq_filter_avail(ncid,H5Z_FILTER_BLOSC))) goto done;
444 /* Filter is available */
445
446 /* Get filter info */
447 stat = nc_inq_var_filter_info(ncid,varid,H5Z_FILTER_BLOSC,&nparams,NULL);
448 if(stat == NC_ENOFILTER) {stat = NC_NOERR; hasfilter = 0; goto done;}
449 if(stat != NC_NOERR) goto done;
450 hasfilter = 1;
451 if(nparams != 7) {stat = NC_EFILTER; goto done;}
452 if((stat = nc_inq_var_filter_info(ncid,varid,H5Z_FILTER_BLOSC,&nparams,params))) goto done;
453 if(blocksizep) *blocksizep = params[3];
454 if(levelp) *levelp = params[4];
455 if(addshufflep) *addshufflep = params[5];
456 if(subcompressorp) *subcompressorp = params[6];
457done:
458 if(hasfilterp) *hasfilterp = hasfilter;
459 return stat;
460#else
461 return NC_NOERR;
462#endif
463}
int nc_inq_var_blosc(int ncid, int varid, int *hasfilterp, unsigned *subcompressorp, unsigned *levelp, unsigned *blocksizep, unsigned *addshufflep)
Learn whether Blosc compression is on for a variable, and, if so, the settings.
Definition dfilter.c:434
int nc_def_var_zstandard(int ncid, int varid, int level)
Turn on Zstandard compression for a variable.
Definition dfilter.c:307
int nc_inq_var_bzip2(int ncid, int varid, int *hasfilterp, int *levelp)
Learn whether bzip2 compression is on for a variable, and, if so, the level setting.
Definition dfilter.c:270
int nc_def_var_bzip2(int ncid, int varid, int level)
Turn on bzip2 compression for a variable.
Definition dfilter.c:239
EXTERNL int nc_inq_filter_avail(int ncid, unsigned id)
Test if filter is available.
Definition dfilter.c:212
int nc_inq_var_zstandard(int ncid, int varid, int *hasfilterp, int *levelp)
Learn whether Zstandard compression is on for a variable, and, if so, the level setting.
Definition dfilter.c:343
EXTERNL int nc_def_var_filter(int ncid, int varid, unsigned int id, size_t nparams, const unsigned int *params)
Define a new variable filter Assumes HDF5 format using unsigned ints.
Definition dfilter.c:129
int nc_def_var_blosc(int ncid, int varid, unsigned subcompressor, unsigned level, unsigned blocksize, unsigned addshuffle)
Turn on blosc for a variable.
Definition dfilter.c:384
EXTERNL int nc_inq_var_filter_info(int ncid, int varid, unsigned int id, size_t *nparamsp, unsigned int *params)
Find the the param info about filter (if any) associated with a variable and with specified id.
Definition dfilter.c:98
EXTERNL int nc_inq_var_filter(int ncid, int varid, unsigned int *idp, size_t *nparamsp, unsigned int *params)
Find the first filter (if any) associated with a variable.
Definition dfilter.c:170
EXTERNL int nc_inq_var_filter_ids(int ncid, int varid, size_t *nfiltersp, unsigned int *ids)
Find the set of filters (if any) associated with a variable.
Definition dfilter.c:62
Main header file for the C API.
#define NC_EFILTER
Filter operation failed.
Definition netcdf.h:523
#define NC_ENOMEM
Memory allocation (malloc) failure.
Definition netcdf.h:458
#define EXTERNL
Needed for DLL build.
Definition netcdf.h:566
#define NC_EINVAL
Invalid Argument.
Definition netcdf.h:388
#define NC_NOERR
No Error.
Definition netcdf.h:378
#define NC_ENOFILTER
Filter not defined on variable.
Definition netcdf.h:527