1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include "hdf5.h"
#include "h5test.h"
#include "h5repack.h"
/*-------------------------------------------------------------------------
* Function: aux_objinsert_filter
*
* Purpose: auxiliary function, inserts the filter in object OBJ
*
* Return: void
*
*-------------------------------------------------------------------------
*/
static void aux_objinsert_filter(pack_info_t *obj,
filter_info_t filt)
{
obj->nfilters=1;
obj->filter[0]=filt;
}
/*-------------------------------------------------------------------------
* Function: filter_this
*
* Purpose: find the object name NAME (got from the traverse list)
* in the repack options list; assign the filter information OBJ
*
* Return: 0 not found, 1 found
*
* Programmer: Pedro Vicente, pvn@ncsa.uiuc.edu
*
* Date: December 19, 2003
*
*-------------------------------------------------------------------------
*/
int filter_this(const char* name, /* object name from traverse list */
pack_opt_t *options, /* repack options */
pack_info_t *obj /*OUT*/) /* info about object to filter */
{
char *pdest;
int result;
int i, j;
/* if we are applying to all objects just return true */
if (options->all_filter)
{
/* assign the global filter and chunk info to the OBJ info */
aux_objinsert_filter( obj, options->filter_g );
obj->chunk=options->chunk_g;
return 1;
}
for ( i=0; i<options->op_tbl->nelems; i++)
{
for ( j=0; j<options->op_tbl->objs[i].nfilters; j++)
{
if (options->op_tbl->objs[i].filter[j].filtn != -1 )
{
if (strcmp(options->op_tbl->objs[i].path,name)==0)
{
*obj=options->op_tbl->objs[i];
return 1;
}
pdest = strstr(name,options->op_tbl->objs[i].path);
result = (int)(pdest - name);
/* found at position 1, meaning without '/' */
if( pdest != NULL && result==1 )
{
*obj=options->op_tbl->objs[i];
return 1;
}
} /*if*/
}/*j*/
}/*i*/
return 0;
}
/*-------------------------------------------------------------------------
* Function: apply_filters
*
* Purpose: apply the filters in the object to the property list;
* do extra checking in the case of SZIP; delete all filters in the case
* of H5Z_FILTER_NONE present in the PACK_INFO_T filter array
*
* Return: 0 success, -1 an error occured
*
* Programmer: Pedro Vicente, pvn@ncsa.uiuc.edu
*
* Date: December 19, 2003
*
*-------------------------------------------------------------------------
*/
int apply_filters(const char* name, /* object name from traverse list */
int rank, /* rank of dataset */
hsize_t *dims, /* dimensions of dataset */
hid_t dcpl_id, /* dataset creation property list */
hid_t type_id, /* dataset datatype */
pack_opt_t *options, /* repack options */
pack_info_t *obj) /* info about object to filter */
{
int nfilters; /* number of filters in DCPL */
unsigned aggression; /* the deflate level */
hsize_t nelmts; /* number of elements in dataset */
size_t size; /* size of datatype in bytes */
int i;
/* check first if the object is to be filtered */
if (filter_this(name,options,obj)==0)
return 0;
if (rank==0)
goto out;
/* check for datasets too small */
if ((size=H5Tget_size(type_id))==0)
return 0;
nelmts=1;
for (i=0; i<rank; i++)
nelmts*=dims[i];
if (nelmts*size < options->threshold )
{
if (options->verbose)
printf("Warning: Filter not applied to <%s>. Dataset smaller than <%d> bytes\n",
name,(int)options->threshold);
return 0;
}
/* get information about input filters */
if ((nfilters = H5Pget_nfilters(dcpl_id))<0)
return -1;
/*-------------------------------------------------------------------------
* check if we have filters in the pipeline
* we want to replace them with the input filters
*-------------------------------------------------------------------------
*/
if (nfilters) {
if (H5Premove_filter(dcpl_id,H5Z_FILTER_ALL)<0)
return -1;
}
/*-------------------------------------------------------------------------
* filters require CHUNK layout; if we do not have one define a default
*-------------------------------------------------------------------------
*/
if (obj->chunk.rank<=0)
{
obj->chunk.rank=rank;
for (i=0; i<rank; i++)
obj->chunk.chunk_lengths[i] = dims[i];
}
/*-------------------------------------------------------------------------
* the type of filter and additional parameter
* type can be one of the filters
* H5Z_FILTER_NONE 0, uncompress if compressed
* H5Z_FILTER_DEFLATE 1 , deflation like gzip
* H5Z_FILTER_SHUFFLE 2 , shuffle the data
* H5Z_FILTER_FLETCHER32 3 , fletcher32 checksum of EDC
* H5Z_FILTER_SZIP 4 , szip compression
*-------------------------------------------------------------------------
*/
for ( i=0; i<obj->nfilters; i++)
{
switch (obj->filter[i].filtn)
{
default:
break;
/*-------------------------------------------------------------------------
* H5Z_FILTER_DEFLATE 1 , deflation like gzip
*-------------------------------------------------------------------------
*/
case H5Z_FILTER_DEFLATE:
aggression=obj->filter[i].cd_values[0];
/* set up for deflated data */
if(H5Pset_chunk(dcpl_id, obj->chunk.rank, obj->chunk.chunk_lengths)<0)
return -1;
if(H5Pset_deflate(dcpl_id,aggression)<0)
return -1;
break;
/*-------------------------------------------------------------------------
* H5Z_FILTER_SZIP 4 , szip compression
*-------------------------------------------------------------------------
*/
case H5Z_FILTER_SZIP:
{
unsigned options_mask;
unsigned pixels_per_block;
pixels_per_block=obj->filter[i].cd_values[0];
if (obj->filter[i].szip_coding==0)
options_mask=H5_SZIP_NN_OPTION_MASK;
else
options_mask=H5_SZIP_EC_OPTION_MASK;
#if defined (CHECK_SZIP)
/* check szip parameters */
if (check_szip(type_id,
obj->chunk.rank,
obj->chunk.chunk_lengths,
options_mask,
&pixels_per_block,
options)==1)
{
#endif
/* set up for szip data */
if(H5Pset_chunk(dcpl_id,obj->chunk.rank,obj->chunk.chunk_lengths)<0)
return -1;
if (H5Pset_szip(dcpl_id,options_mask,pixels_per_block)<0)
return -1;
#if defined (CHECK_SZIP)
}
else
{
if (options->verbose)
printf("Warning: SZIP filter cannot be applied to <%s>\n",name);
}
#endif
}
break;
/*-------------------------------------------------------------------------
* H5Z_FILTER_SHUFFLE 2 , shuffle the data
*-------------------------------------------------------------------------
*/
case H5Z_FILTER_SHUFFLE:
if(H5Pset_chunk(dcpl_id, obj->chunk.rank, obj->chunk.chunk_lengths)<0)
return -1;
if (H5Pset_shuffle(dcpl_id)<0)
return -1;
break;
/*-------------------------------------------------------------------------
* H5Z_FILTER_FLETCHER32 3 , fletcher32 checksum of EDC
*-------------------------------------------------------------------------
*/
case H5Z_FILTER_FLETCHER32:
if(H5Pset_chunk(dcpl_id, obj->chunk.rank, obj->chunk.chunk_lengths)<0)
return -1;
if (H5Pset_fletcher32(dcpl_id)<0)
return -1;
break;
} /* switch */
}/*i*/
return 0;
out:
if (options->verbose)
printf("Warning: Filter could not be applied to <%s>\n",name);
return 0;
}
/*-------------------------------------------------------------------------
* Function: print_filters
*
* Purpose: print the filters in DCPL
*
* Return: 0, ok, -1 no
*
* Programmer: Pedro Vicente, pvn@ncsa.uiuc.edu
*
* Date: December 19, 2003
*
*-------------------------------------------------------------------------
*/
int print_filters(hid_t dcpl_id)
{
int nfilters; /* number of filters */
unsigned filt_flags; /* filter flags */
H5Z_filter_t filtn; /* filter identification number */
unsigned cd_values[20]; /* filter client data values */
size_t cd_nelmts; /* filter client number of values */
size_t cd_num; /* filter client data counter */
char f_name[256]; /* filter name */
char s[64]; /* temporary string buffer */
int i;
/* get information about filters */
if ((nfilters = H5Pget_nfilters(dcpl_id))<0)
return -1;
for (i=0; i<nfilters; i++)
{
cd_nelmts = NELMTS(cd_values);
#ifdef H5_WANT_H5_V1_6_COMPAT
filtn = H5Pget_filter(dcpl_id,
(unsigned)i,
&filt_flags,
&cd_nelmts,
cd_values,
sizeof(f_name),
f_name);
#else
filtn = H5Pget_filter(dcpl_id,
(unsigned)i,
&filt_flags,
&cd_nelmts,
cd_values,
sizeof(f_name),
f_name,
NULL);
#endif /* H5_WANT_H5_V1_6_COMPAT */
f_name[sizeof(f_name)-1] = '\0';
sprintf(s, "Filter-%d:", i);
printf(" %-10s %s-%u %s {", s,
f_name[0]?f_name:"method",
(unsigned)filtn,
filt_flags & H5Z_FLAG_OPTIONAL?"OPT":"");
for (cd_num=0; cd_num<cd_nelmts; cd_num++) {
printf("%s%u", cd_num?", ":"", cd_values[cd_num]);
}
printf("}\n");
}
return 0;
}
#if defined (CHECK_SZIP)
/*-------------------------------------------------------------------------
* Function: check_szip
*
* Purpose: utility to check SZIP parameters
*
* SZIP compresses data block by block, with a user-tunable block size.
* This block size is passed in the parameter pixels_per_block and must be even,
* with typical values being 8, 10, 16, and 32. The more pixel values vary,
* the smaller this number should be. For optimal performance, the number of
* pixels per scan line (i.e., the size of the fastest-changing dimension in the chunk)
* should be an even multiple of the number of pixels per block.
*
* Return: 1=can apply the filter
* 0=cannot apply the filter
*
* Programmer: Pedro Vicente, pvn@ncsa.uiuc.edu
*
* Date: December 23, 2003
*
*-------------------------------------------------------------------------
*/
int check_szip(hid_t type_id, /* dataset datatype */
int rank, /* chunk rank */
hsize_t *dims, /* chunk dims */
unsigned szip_options_mask /*IN*/,
unsigned *szip_pixels_per_block /*IN,OUT*/,
pack_opt_t *options)
{
size_t size=0; /* size of datatype in bytes */
szip_comp_t szip;
int i;
unsigned ppb=*szip_pixels_per_block;
if (type_id)
{
if ((size=H5Tget_size(type_id))==0)
return 0;
switch (H5Tget_class(type_id))
{
default:
return 0;
case H5T_INTEGER:
case H5T_FLOAT:
break;
}
}
/*
pixels_per_scanline = size of the fastest-changing dimension
Must be <= MAX_PIXELS_PER_SCANLINE and <= pixels
*/
szip.pixels_per_scanline = (unsigned)dims[rank-1];
szip.pixels = 1;
for ( i = 0; i < rank; i++)
{
szip.pixels *= dims[i];
}
if (szip.pixels_per_scanline > MAX_PIXELS_PER_SCANLINE)
{
printf("Warning: in SZIP setting, pixels per scanline was set to <%d>, \
MAX_PIXELS_PER_SCANLINE\n",MAX_PIXELS_PER_SCANLINE);
szip.pixels_per_scanline = MAX_PIXELS_PER_SCANLINE;
}
/*
pixels_per_block must be an even number, and <= pixels_per_scanline
and <= MAX_PIXELS_PER_BLOCK
*/
if (ppb > szip.pixels_per_scanline)
{
/* set ppb to pixels per scanline and try to make it an even number */
ppb=szip.pixels_per_scanline;
if (ppb%2!=0)
ppb--;
if (ppb<=1 )
{
printf("Warning: in SZIP settings, pixels per block <%d>,\
cannot be set with pixels per scanline <%d>\n",
ppb, szip.pixels_per_scanline);
return 0;
}
else
{
if (options->verbose)
printf("Warning: In SZIP settings, pixels per block was set to <%d>\n", ppb);
}
}
szip.pixels_per_block = ppb;
*szip_pixels_per_block = ppb;
szip.options_mask = szip_options_mask;
szip.compression_mode = NN_MODE;
/*
bits_per_pixel
Must be in range 1..24,32,64
*/
szip.bits_per_pixel = 0;
if (type_id) {
switch(size)
{
case 1:
szip.bits_per_pixel = 8;
break;
case 2:
szip.bits_per_pixel = 16;
break;
case 4:
szip.bits_per_pixel = 32;
break;
case 8:
szip.bits_per_pixel = 64;
break;
default:
printf("Warning: Invalid numeric type of size <%u> for SZIP\n",(unsigned)size);
return 0;
}}
return check_szip_params( szip.bits_per_pixel,
szip.pixels_per_block,
szip.pixels_per_scanline,
szip.pixels);
}
/*-------------------------------------------------------------------------
* Function: check_szip_params
*
* Purpose: Adapted from rice.c. Checks the SZIP parameters
*
* Return: 1=can apply the filter
* 0=cannot apply the filter
*
*-------------------------------------------------------------------------
*/
int check_szip_params( unsigned bits_per_pixel,
unsigned pixels_per_block,
unsigned pixels_per_scanline,
hsize_t image_pixels)
{
if (pixels_per_block & 1)
{
printf("Pixels per block must be even.\n");
return 0;
}
if (pixels_per_block > pixels_per_scanline)
{
printf("Pixels per block is greater than pixels per scanline.\n");
return 0;
}
if (bits_per_pixel) /* if provided for test */
{
if (bits_per_pixel >= 1 && bits_per_pixel <= 24)
;
else if (bits_per_pixel == 32 || bits_per_pixel == 64)
;
else
{
printf("bits per pixel must be in range 1..24,32,64");
return 0;
}
}
if (pixels_per_block > MAX_PIXELS_PER_BLOCK)
{
printf("maximum pixels per block exceeded");
return 0;
}
if (pixels_per_block & 1)
{
printf("pixels per block must be even");
return 0;
}
if (pixels_per_block > pixels_per_scanline)
{
printf("pixels per block > pixels per scanline");
return 0;
}
if (pixels_per_scanline > MAX_PIXELS_PER_SCANLINE)
{
printf("maximum pixels per scanline exceeded");
return 0;
}
if (image_pixels < pixels_per_scanline)
{
printf("image pixels less than pixels per scanline");
return 0;
}
if (image_pixels % pixels_per_scanline)
{
printf("Pixels (%d) must be integer multiple of pixels per scanline (%d)\n",
(unsigned)image_pixels,pixels_per_scanline);
return 0;
}
#if 0
if (pixels_per_scanline % pixels_per_block)
{
printf("Pixels per scanline (%d) must be an integer multiple of pixels per block (%d)\n",
pixels_per_scanline, pixels_per_block);
return 0;
}
#endif
return 1;
}
#endif /* CHECK_SZIP */
|