1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 2 * Copyright by The HDF Group. * 3 * Copyright by the Board of Trustees of the University of Illinois. * 4 * All rights reserved. * 5 * * 6 * This file is part of HDF5. The full HDF5 copyright notice, including * 7 * terms governing use, modification, and redistribution, is contained in * 8 * the COPYING file, which can be found at the root of the source code * 9 * distribution tree, or in https://www.hdfgroup.org/licenses. * 10 * If you do not have access to either file, you may request a copy from * 11 * help@hdfgroup.org. * 12 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 13 14 /* Programmer: Robb Matzke 15 * Thursday, April 16, 1998 16 */ 17 18 #ifndef H5Zprivate_H 19 #define H5Zprivate_H 20 21 /* Early typedefs to avoid circular dependencies */ 22 typedef struct H5Z_filter_info_t H5Z_filter_info_t; 23 24 /* Include package's public header */ 25 #include "H5Zpublic.h" 26 27 /* Private headers needed by this file */ 28 #include "H5Tprivate.h" /* Datatypes */ 29 #include "H5Sprivate.h" /* Dataspace */ 30 31 /**************************/ 32 /* Library Private Macros */ 33 /**************************/ 34 35 /* Special parameters for szip compression */ 36 /* [These are aliases for the similar definitions in szlib.h, which we can't 37 * include directly due to the duplication of various symbols with the zlib.h 38 * header file] */ 39 #define H5_SZIP_LSB_OPTION_MASK 8 40 #define H5_SZIP_MSB_OPTION_MASK 16 41 #define H5_SZIP_RAW_OPTION_MASK 128 42 43 /* Common # of 'client data values' for filters */ 44 /* (avoids dynamic memory allocation in most cases) */ 45 #define H5Z_COMMON_CD_VALUES 4 46 47 /* Common size of filter name */ 48 /* (avoids dynamic memory allocation in most cases) */ 49 #define H5Z_COMMON_NAME_LEN 12 50 51 /****************************/ 52 /* Library Private Typedefs */ 53 /****************************/ 54 55 /* Structure to store information about each filter's parameters */ 56 struct H5Z_filter_info_t { 57 H5Z_filter_t id; /*filter identification number */ 58 unsigned flags; /*defn and invocation flags */ 59 char _name[H5Z_COMMON_NAME_LEN]; /*internal filter name */ 60 char * name; /*optional filter name */ 61 size_t cd_nelmts; /*number of elements in cd_values[] */ 62 unsigned _cd_values[H5Z_COMMON_CD_VALUES]; /*internal client data values */ 63 unsigned * cd_values; /*client data values */ 64 }; 65 66 /*****************************/ 67 /* Library-private Variables */ 68 /*****************************/ 69 70 /***************************************/ 71 /* Library-private Function Prototypes */ 72 /***************************************/ 73 struct H5O_pline_t; /*forward decl*/ 74 75 /* Internal API routines */ 76 H5_DLL herr_t H5Z_init(void); 77 H5_DLL herr_t H5Z_register(const H5Z_class2_t *cls); 78 H5_DLL herr_t H5Z_append(struct H5O_pline_t *pline, H5Z_filter_t filter, unsigned flags, size_t cd_nelmts, 79 const unsigned int cd_values[]); 80 H5_DLL herr_t H5Z_modify(const struct H5O_pline_t *pline, H5Z_filter_t filter, unsigned flags, 81 size_t cd_nelmts, const unsigned int cd_values[]); 82 H5_DLL herr_t H5Z_pipeline(const struct H5O_pline_t *pline, unsigned flags, unsigned *filter_mask /*in,out*/, 83 H5Z_EDC_t edc_read, H5Z_cb_t cb_struct, size_t *nbytes /*in,out*/, 84 size_t *buf_size /*in,out*/, void **buf /*in,out*/); 85 H5_DLL H5Z_class2_t *H5Z_find(H5Z_filter_t id); 86 H5_DLL herr_t H5Z_can_apply(hid_t dcpl_id, hid_t type_id); 87 H5_DLL herr_t H5Z_set_local(hid_t dcpl_id, hid_t type_id); 88 H5_DLL herr_t H5Z_can_apply_direct(const struct H5O_pline_t *pline); 89 H5_DLL herr_t H5Z_set_local_direct(const struct H5O_pline_t *pline); 90 H5_DLL htri_t H5Z_ignore_filters(hid_t dcpl_id, const H5T_t *type, const H5S_t *space); 91 H5_DLL H5Z_filter_info_t *H5Z_filter_info(const struct H5O_pline_t *pline, H5Z_filter_t filter); 92 H5_DLL htri_t H5Z_filter_in_pline(const struct H5O_pline_t *pline, H5Z_filter_t filter); 93 H5_DLL htri_t H5Z_all_filters_avail(const struct H5O_pline_t *pline); 94 H5_DLL htri_t H5Z_filter_avail(H5Z_filter_t id); 95 H5_DLL herr_t H5Z_delete(struct H5O_pline_t *pline, H5Z_filter_t filter); 96 H5_DLL herr_t H5Z_get_filter_info(H5Z_filter_t filter, unsigned int *filter_config_flags); 97 98 /* Data Transform Functions */ 99 typedef struct H5Z_data_xform_t H5Z_data_xform_t; /* Defined in H5Ztrans.c */ 100 101 H5_DLL H5Z_data_xform_t *H5Z_xform_create(const char *expr); 102 H5_DLL herr_t H5Z_xform_copy(H5Z_data_xform_t **data_xform_prop); 103 H5_DLL herr_t H5Z_xform_destroy(H5Z_data_xform_t *data_xform_prop); 104 H5_DLL herr_t H5Z_xform_eval(H5Z_data_xform_t *data_xform_prop, void *array, size_t array_size, 105 const H5T_t *buf_type); 106 H5_DLL hbool_t H5Z_xform_noop(const H5Z_data_xform_t *data_xform_prop); 107 H5_DLL const char * H5Z_xform_extract_xform_str(const H5Z_data_xform_t *data_xform_prop); 108 109 #endif 110