/*------------------------------------------------------------------------- * * Copyright (C) 2000 National Center for Supercomputing Applications. * All rights reserved. * *------------------------------------------------------------------------- */ /****************************************************************************** Description: 1. converter See HDF4 to HDF5 mapping specification at (http://hdf.ncsa.uiuc.edu/HDF5/papers/h4toh5) for the default mapping from HDF4 object to HDF5 object. The whole converter includes 10 files, h4toh5util.h, h4toh5main.h, h4toh5util.c, h4toh5main.c, h4toh5sds.c, h4toh5image.c,h4toh5vdata.c,h4toh5vgroup.c,h4toh5pal.c and h4toh5anno.c. 2. this file converting an hdf4 image object into an hdf5 dataset, for three component image, this object will be converted into an hdf5 dataset with compound data type. Author: Kent Yang(ymuqun@ncsa.uiuc.edu) *****************************************************************************/ #include "h4toh5main.h" /*------------------------------------------------------------------------- * Function: Image_h4_to_h5 * * Purpose: translate Image object into hdf5 dataset * * Return: FAIL if failed, SUCCEED if successful. * * In : ri_id: RI identifier h5_group: hdf5 group id h5_palgroup: hdf5 palette group id *------------------------------------------------------------------------- */ int Image_h4_to_h5(int32 file_id,int32 ri_id,hid_t h5_group,hid_t h5_palgroup,int h4_attr) { int32 istat; int32 ngrattrs; int32 ncomp; int check_gloattr; int32 start[2]; int32 edges[2]; int32 dimsizes[2]; uint16 gr_ref; int32 image_dtype; int check_imagename; int i; char image_name[MAX_GR_NAME]; char grlabel[MAX_GR_NAME]; char image_class[MAX_GR_NAME]; char* h5cimage_name; void* image_data; HDF_CHUNK_DEF c_def_out; hsize_t chunk_dims[2]; hsize_t chunk_dims24[3]; int32 c_flags; int32 interlace_mode; /* for checking compression */ sp_info_block_t info_block; int16 special_code; int32 access_id; uint16 ri_ref; int gzip_level; uint16 temp_tag; uint16* ptag_out; /* define varibles for hdf5. */ hid_t h5ty_id; hid_t h5memtype; hid_t h5_ctype; hid_t h5_cmemtype; hid_t h5d_sid; hid_t h5dset; size_t h4size; size_t h4memsize; hsize_t fielddim[1]; hsize_t h5dims[2]; hsize_t h5dims24[3]; #ifdef H5_WANT_H5_V1_4_COMPAT hsize_t bufsize; #else /* H5_WANT_H5_V1_4_COMPAT */ size_t bufsize; #endif /* H5_WANT_H5_V1_4_COMPAT */ herr_t ret; hid_t create_plist; hid_t write_plist; temp_tag = DFTAG_NULL; ptag_out = &temp_tag; /* zeroing out memory.*/ h4toh5_ZeroMemory(image_name,MAX_GR_NAME); h4toh5_ZeroMemory(image_class,MAX_GR_NAME); h4toh5_ZeroMemory(grlabel,MAX_GR_NAME); /* Obtain information of the image.*/ if(GRgetchunkinfo(ri_id,&c_def_out,&c_flags)==FAIL){ printf("error in getting chunking information. \n"); return FAIL; } istat = GRgetiminfo(ri_id, image_name, &ncomp, &image_dtype, &interlace_mode, dimsizes, &ngrattrs); if(istat == FAIL) { printf("Cannot obtain GR info. at Image routine.\n"); return FAIL; } /* data type transferring from hdf4 to hdf5. */ if(h4type_to_h5type(image_dtype,&h5memtype,&h4memsize, &h4size,&h5ty_id)== FAIL) { printf("failed to translate image datatype. \n"); return FAIL; } /* check whether the datatype is string. */ if (h5ty_id == H5T_STRING) { /* rechange string datatype into numerical datatype.*/ if(h5string_to_int(image_dtype,&h5memtype,h4memsize, &h5ty_id)== FAIL) { printf("error in translating H5T_STRING to int.\n"); return FAIL; } } start[0] = 0; start[1] = 0; edges[0] = dimsizes[0]; edges[1] = dimsizes[1]; image_data = malloc(h4memsize*dimsizes[0]*dimsizes[1]*ncomp); if(image_data == NULL) { printf("error in allocating memory for image data. \n"); return FAIL; } /* GRreqimageil or GRreadimage are not working, comment this out for the time being. if(interlace_mode == MFGR_INTERLACE_LINE){ istat = GRreqimageil(ri_id,MFGR_INTERLACE_PIXEL); if(istat == FAIL){ printf("error in setting interlace_mode.\n"); free(image_data); return FAIL; } } */ istat = GRreadimage(ri_id, start, NULL, edges, (VOIDP)image_data); if (istat == FAIL) { printf("error in reading images.\n"); free(image_data); return FAIL; } /* change the order of image dimension: due to the difference of hdf4 image specification and hdf5 image specification. Here we should separate 8-bit from 24-bit according to H4TOH5 mapping specification.*/ if(ncomp == 1) { h5dims[0] = edges[1]-start[1]; h5dims[1] = edges[0]-start[0]; } else { if(interlace_mode == MFGR_INTERLACE_PIXEL){ h5dims24[0] = edges[1]-start[1]; h5dims24[1] = edges[0]-start[0]; h5dims24[2] = 3; } /* currently scan-line is not supported. */ else if (interlace_mode == MFGR_INTERLACE_LINE){ printf("currently line interleaving is not supported.\n"); printf("the image %s will not be converted.\n",image_name); free(image_data); return SUCCEED; /*h5dims24[0] = 3; h5dims24[1] = edges[1]-start[1]; h5dims24[2] = edges[0]-start[0];*/ } else if (interlace_mode == MFGR_INTERLACE_COMPONENT){ h5dims24[0] = 3; h5dims24[1] = edges[1]-start[1]; h5dims24[2] = edges[0]-start[0]; } else {/* treat as pixel */ h5dims24[0] = edges[1]-start[1]; h5dims24[1] = edges[0]-start[0]; h5dims24[2] = 3; } } gr_ref = GRidtoref(ri_id); if(gr_ref == 0) { printf("error in obtaining gr reference number. \n"); free(image_data); return FAIL; } /* obtaining absolute path of image name.*/ check_imagename = -10; h5cimage_name = get_name(gr_ref,2*num_images,gr_hashtab,&check_imagename); if (h5cimage_name == NULL && check_imagename == 0 ) { printf("error,cannot find image name.\n"); free(image_data); return FAIL; } if (h5cimage_name == NULL && check_imagename == -1) { printf("error,image name is not defined.\n"); free(image_data); return FAIL; } if (h5cimage_name == NULL && check_imagename == -2) { printf("error,not enough memory for get_name. \n"); free(image_data); return FAIL; } /**** check number of component of the image object, and transfer HDF4 object into HDF5 object. ****/ if (ncomp <= 0) { printf("error in obtaining image component\n"); free(image_data); free(h5cimage_name); return FAIL; } /* create property list. */ create_plist = H5Pcreate(H5P_DATASET_CREATE); /* wait until the compression information can be obtained for image, 4/28/2001, Kent Yang.*/ /* the following code deals with compression. Has to use some middle-level APIs. */ ri_ref = 0; /* ri_ref = get_RIref(file_id,DFTAG_VG,gr_ref,ptag_out); if(ri_ref >0 ){ if(*ptag_out == DFTAG_RI) printf("okay\n"); access_id = Hstartread(file_id,*ptag_out,ri_ref); } */ if(ri_ref == 0) access_id = FAIL; /* if(access_id == FAIL){ printf("cannot find RI tag,the compression mode will not be checked"); printf(" when RIG is not chunked.\n"); }*/ if(access_id != FAIL) { istat = Hinquire(access_id,NULL,NULL,NULL,NULL,NULL,NULL,NULL,&special_code); if(istat == FAIL) { printf("failed to inquire information \n "); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } if(special_code >0){ if(HDget_special_info(access_id,&info_block)==FAIL){ printf("fail to get special info.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } if(info_block.key == SPECIAL_COMP) { if(c_flags == HDF_NONE){ /* 1. the current HDF5 will not handle compression case itself, in order that the converted HDF5 is compressed, we have to provide a chunking size. currently it is set to h5dim[i].*/ if(ncomp == 1) { chunk_dims[0] = (hsize_t)(h5dims[0]); chunk_dims[1] =(hsize_t)(h5dims[1]); if(H5Pset_chunk(create_plist, 2, chunk_dims)<0) { printf("failed to set up chunking information for "); printf("property list.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } } else if(ncomp ==3) {/*24-bit chunk dimension is set to the current HDF5 dimension.*/ if(interlace_mode == MFGR_INTERLACE_PIXEL){ chunk_dims24[0] = edges[1]-start[1]; chunk_dims24[1] = edges[0]-start[0]; chunk_dims24[2] = 3; } /* currently scan-line is not supported. else if (interlace_mode == MFGR_INTERLACE_LINE){ chunk_dims24[0] = 3; chunk_dims24[1] = edges[1]-start[1]; chunk_dims24[2] = edges[0]-start[0]; } */ else if (interlace_mode == MFGR_INTERLACE_COMPONENT){ chunk_dims24[1] = edges[1]-start[1]; chunk_dims24[2] = edges[0]-start[0]; chunk_dims24[0] = 3; } else {/* treat as pixel */ chunk_dims24[0] = edges[1]-start[1]; chunk_dims24[1] = edges[0]-start[0]; chunk_dims24[2] = 3; } if(H5Pset_chunk(create_plist, 3, chunk_dims24)<0) { printf("failed to set up chunking information for "); printf("property list.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } } if(H5Pset_deflate(create_plist,GZIP_COMLEVEL)<0){ /* if(H5Pset_deflate(create_plist,2)<0){*/ printf("fail to set compression method for HDF5 file.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } } } } } if(c_flags == HDF_CHUNK || c_flags == (HDF_CHUNK | HDF_COMP) || c_flags == (HDF_CHUNK | HDF_NBIT) ){ if(c_def_out.comp.comp_type == COMP_CODE_RLE || c_def_out.comp.comp_type == COMP_CODE_NBIT || c_def_out.comp.comp_type == COMP_CODE_SKPHUFF || c_def_out.comp.comp_type == COMP_CODE_DEFLATE || c_def_out.comp.comp_type == COMP_CODE_JPEG) { if(ncomp ==1) { chunk_dims[0] = c_def_out.chunk_lengths[0]; chunk_dims[1] = c_def_out.chunk_lengths[1]; if(H5Pset_chunk(create_plist, 2, (hsize_t *)chunk_dims)<0) { printf("failed to set up chunking information for "); printf("property list.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } } else if(ncomp ==3) { if(interlace_mode == MFGR_INTERLACE_PIXEL){ chunk_dims24[0] = c_def_out.chunk_lengths[1]; chunk_dims24[1] = c_def_out.chunk_lengths[0]; chunk_dims24[2] = 3; } /* currently scan-line is not supported. else if (interlace_mode == MFGR_INTERLACE_LINE){ chunk_dims24[0] = c_def_out.chunk_lengths[1]; chunk_dims24[2] = c_def_out.chunk_lengths[0]; chunk_dims24[1] = 3; } */ else if (interlace_mode == MFGR_INTERLACE_COMPONENT){ chunk_dims24[1] = c_def_out.chunk_lengths[1]; chunk_dims24[2] = c_def_out.chunk_lengths[0]; chunk_dims24[0] = 3; } else {/* treat as pixel */ chunk_dims24[0] = c_def_out.chunk_lengths[1]; chunk_dims24[1] = c_def_out.chunk_lengths[0]; chunk_dims24[2] = 3; } } if(c_def_out.comp.comp_type == COMP_CODE_DEFLATE) gzip_level = c_def_out.comp.cinfo.deflate.level; else gzip_level = GZIP_COMLEVEL; if(H5Pset_deflate(create_plist,gzip_level)<0){ printf("fail to set compression method for HDF5 file.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); } } } /* HDF4 can support various compression methods including simple RLE, NBIT, Skip Huffman, gzip,Jpeg , HDF5 currently only supports gzip compression. By default, we will compress HDF5 dataset by using gzip compression if HDF5 file is compressed. */ /* we don't use data transfer property list. write_plist = H5Pcreate(H5P_DATASET_XFER); bufsize = h4memsize *h5dims[1]*ncomp; if(H5Pset_buffer(write_plist,bufsize,NULL,NULL)<0) { printf("fail to create data transfer property list.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } */ if (ncomp == 1) { h5d_sid = H5Screate_simple(2,h5dims,NULL); if(h5d_sid <0) { printf("error in creating space for dataset. \n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } h5dset = H5Dcreate(h5_group,h5cimage_name,h5ty_id,h5d_sid,create_plist); if(h5dset < 0) { printf("error in creating hdf5 dataset converted from images. \n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } if (H5Dwrite(h5dset,h5memtype,h5d_sid,h5d_sid,H5P_DEFAULT, image_data)<0) { printf("error writing data for hdf5 dataset converted from images.\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } } else { /* 24-bit image */ h5d_sid = H5Screate_simple(3,h5dims24,NULL); h5dset = H5Dcreate(h5_group,h5cimage_name,h5ty_id,h5d_sid, create_plist); if(h5dset < 0) { printf("error in creating dataset. \n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } if (H5Dwrite(h5dset,h5memtype,h5d_sid,h5d_sid,H5P_DEFAULT, (void *)image_data)<0) { printf("error writing data\n"); free(image_data); free(h5cimage_name); H5Pclose(create_plist); return FAIL; } } free(image_data); /* convert image annotation into attribute of image dataset. Since there is no routines to find the exact tag of image object, we will check three possible object tags of image objects, that is: DFTAG_RIG,DFTAG_RI,DFTAG_RI8. If the object tag of image object is falling out of this scope, we will not convert annotations into hdf5 attributes; it is user's responsibility to make sure object tags for image objects are only one of the above three tags.*/ if(Annoobj_h4_to_h5(file_id,gr_ref,DFTAG_RIG,h5dset)== FAIL){ printf("failed to convert image annotation into hdf5 attribute.\n"); free(h5cimage_name); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); return FAIL; } if(Annoobj_h4_to_h5(file_id,gr_ref,DFTAG_RI,h5dset)== FAIL){ printf("failed to convert image annotation into hdf5 attribute.\n"); free(h5cimage_name); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); return FAIL; } if(Annoobj_h4_to_h5(file_id,gr_ref,DFTAG_RI8,h5dset)== FAIL){ printf("failed to convert image annotation into hdf5 attribute.\n"); free(h5cimage_name); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); return FAIL; } /************************************/ /* translate GR attributes into HDF5 dataset attribute.*/ check_gloattr = 0; if(gr_tranattrs(ri_id,h5dset,ngrattrs,check_gloattr)==FAIL){ printf(" cannot obtain attributes. \n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); return FAIL; } /* deal with h5dset predefined and user-defined attributes. Obtain the name and data type and the total number of attributes. Data attribute at hdf4 is only one-dimensional array. */ if (ncomp == 1 && h4size == 1) strcpy(grlabel,RAST8LABEL); else if(ncomp == 3 && h4size == 1) strcpy(grlabel,RAST24LABEL); else strcpy(grlabel,GRLABEL); strcpy(image_class,IM_CLASS); /* transfer hdf4 predefined attributes into hdf5 dataset.*/ if(h4_transpredattrs(h5dset,HDF4_OBJECT_TYPE,grlabel)==FAIL){ printf("error in getting hdf4 image type attribute \n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } if(h4_attr!=0) { if(h4_transpredattrs(h5dset,HDF4_OBJECT_NAME,image_name)==FAIL){ printf("error in getting hdf4 image name attribute. \n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } } if(h4_transpredattrs(h5dset,HDF4_IMAGE_CLASS,image_class)==FAIL){ printf("error in getting hdf4 image class attribute. \n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } if(ncomp >1) { if(interlace_mode == MFGR_INTERLACE_PIXEL){ if(h4_transpredattrs(h5dset,INTERLACE_MODE,PIXEL_INTERLACE)==FAIL){ printf("unable to generate image pixel attribute.\n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } } /* currently scan-line is not supported. else if (interlace_mode == MFGR_INTERLACE_LINE){ if(h4_transpredattrs(h5dset,INTERLACE_MODE,LINE_INTERLACE)==FAIL){ printf("unable to generate image line attribute.\n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } }*/ else if (interlace_mode == MFGR_INTERLACE_COMPONENT){ if(h4_transpredattrs(h5dset,INTERLACE_MODE,PLANE_INTERLACE)==FAIL){ printf("unable to generate image component attribute.\n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } } else {/* treat as pixel interlace mode. */ if(h4_transpredattrs(h5dset,INTERLACE_MODE,PIXEL_INTERLACE)==FAIL){ printf("unable to generate image pixel attribute.\n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } } } if(h4_attr !=0){ gr_ref = GRidtoref(ri_id); if(gr_ref == 0) { printf("error in obtaining reference number of GR.\n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } if(h4_transnumattr(h5dset,HDF4_REF_NUM,gr_ref)==FAIL) { printf("error in getting hdf4 image number attribute.\n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } } /* deal with palette. */ if(gr_palette(file_id,ri_id,h5dset,h5_palgroup,h4_attr)== FAIL) { printf("error in translating palette into h5 dataset.\n"); H5Pclose(create_plist); H5Sclose(h5d_sid); H5Dclose(h5dset); free(h5cimage_name); return FAIL; } ret = H5Pclose(create_plist); ret = H5Sclose(h5d_sid); ret = H5Dclose(h5dset); istat = GRendaccess(ri_id); free(h5cimage_name); return SUCCEED; } /**** palette routine. ****/ /*------------------------------------------------------------------------- * Function: gr_palette * * Purpose: translate palette into hdf5 dataset * * Return: FAIL if failed, SUCCEED if successful. * * In : file_id: HDF4 identifier ri: raster image id h5dset: hdf5 dataset h5_palgroup: hdf5 palette group Out: *------------------------------------------------------------------------- */ int gr_palette(int32 file_id,int32 ri_id,hid_t h5dset,hid_t h5_palgroup,int h4_attr) { int32 pal_id; uint16 pal_ref; char palref_str[MAXREF_LENGTH]; char palg_name[MAX_GR_NAME]; char image_index[MAX_GR_NAME]; int check_pal; int check_palname; int pal_stat; char* h5pal_name=NULL; /* get palette id */ pal_id = GRgetlutid(ri_id,0); if(pal_id == FAIL) { printf("error in obtaining palette id. \n"); return FAIL; } pal_ref = GRluttoref(pal_id); if(pal_ref >0) { /* convert reference number into string format. */ if(conv_int_str(pal_ref,palref_str)==FAIL) { printf("error in converting palette reference number into string.\n"); return FAIL; } /* check whether this palette has been looked up already. */ check_pal = lookup(pal_ref,PAL_HASHSIZE,pal_hashtab); if( check_pal < 0) { printf("error at looking up palette table. \n"); return FAIL; } /* if check_pal equals to 1, this palette has already been converted into hdf5 dataset, just obtain the palette name. if check_pal equals to 0, we will do the converting. */ if(check_pal == 1) { h5pal_name = get_name(pal_ref,PAL_HASHSIZE,pal_hashtab, &check_palname); if (h5pal_name == NULL && check_palname == 0 ) { printf("error,cannot find group\n"); return FAIL; } if (h5pal_name == NULL && check_palname == -1 ) { printf("error,group name is not defined.\n"); return FAIL; } } if(check_pal == 0) { /* do converting. */ strcpy(palg_name,HDF4_PALG); /* obtain hdf5 dataset name converted from palette, no name for hdf4 palette.*/ h5pal_name = get_obj_aboname(NULL,palref_str,palg_name,HDF4_PALETTE); if(h5pal_name == NULL) { printf("error in getting hdf5 palette name.\n"); return FAIL; } if(set_name(pal_ref,PAL_HASHSIZE,pal_hashtab,h5pal_name)==FAIL) { printf("error in setting object name.\n"); free(h5pal_name); return FAIL; } pal_stat = Palette_h4_to_h5(file_id,pal_id,h5_palgroup,h5pal_name,h4_attr); if(pal_stat == FAIL) { printf("error occurring in transferring palette into dataset. \n"); free(h5pal_name); return FAIL; } } if(create_pal_objref(h5dset,h5_palgroup,h5pal_name)== FAIL) { printf("error in creating palette object reference.\n"); free(h5pal_name); return FAIL; } if(h5pal_name != NULL) free(h5pal_name); strcpy(image_index,HDF4_IMAGE_INDEXED); if(h4_transpredattrs(h5dset,HDF4_IMAGE_SUBCLASS,image_index)== FAIL) { printf("failed to transfer hdf4 image indexed.\n"); return FAIL; } } return SUCCEED; } /***** end of palette application. *****/ /*------------------------------------------------------------------------- * Function: gr_tranattrs * * Purpose: translate attributes of Image object into hdf5 dataset * * Return: FAIL if failed, SUCCEED if successful. * * In : sri_id: RI identifier sh5_dset: hdf5 dataset snum_grattrs: number of attribute check_gloflag: flag to check whether this attribute belongs to gr interface. Out: *------------------------------------------------------------------------- */ int gr_tranattrs(int32 sri_id, hid_t sh5_dset,int snum_grattrs, int check_gloflag) { char sgratrr_name[2*MAX_NC_NAME]; char grglo[MAX_NC_NAME]; char* grrepattr_name; int32 count_sgradata; int32 sgr_atype; size_t sh4_amemsize; size_t sh4_asize; hid_t sh5a_sid; hid_t sh5a_id; hid_t sh5_atype; hid_t sh5_amemtype; hid_t sh5str_type; hid_t sh5str_memtype; hsize_t sh5dims[MAX_VAR_DIMS]; void* sgr_adata; herr_t sret; int i; for (i =0;i