grib2.h

Go to the documentation of this file.

 
#ifndef _grib2_H
#define _grib2_H
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
 
#define G2C_VERSION "2.0.0" 
#define G2_PNG_ENABLED 1      
#define G2_JPEG2000_ENABLED 1 
/* #undef G2_AEC_ENABLED */
 
typedef int64_t g2int;
 
typedef uint64_t g2intu;
 
typedef float g2float;
 
struct gribfield
{
    g2int version;
 
    g2int discipline;
 
    g2int *idsect;
 
    g2int idsectlen;
 
    unsigned char *local;
 
    g2int locallen;
 
    g2int ifldnum;
 
    g2int griddef;
 
    g2int ngrdpts;
 
    g2int numoct_opt;
 
    g2int interp_opt;
 
    g2int num_opt;
 
    g2int *list_opt;
 
    g2int igdtnum;
 
    g2int igdtlen;
 
    g2int *igdtmpl;
 
    g2int ipdtnum;
 
    g2int ipdtlen;
 
    g2int *ipdtmpl;
 
    g2int num_coord;
 
    float *coord_list;
 
    g2int ndpts;
 
    g2int idrtnum;
 
    g2int idrtlen;
 
    g2int *idrtmpl;
 
    g2int unpacked;
 
    g2int expanded;
 
    g2int ibmap;
 
    g2int *bmap;
 
    float *fld;
};
 
typedef struct gribfield gribfield; 
/*  Prototypes for unpacking sections API  */
g2int g2_unpack1(unsigned char *cgrib, g2int *iofst, g2int **ids, g2int *idslen);
g2int g2_unpack2(unsigned char *cgrib, g2int *iofst, g2int *lencsec2,
                 unsigned char **csec2);
g2int g2_unpack3(unsigned char *cgrib, g2int *iofst, g2int **igds, g2int **igdstmpl,
                 g2int *mapgridlen, g2int **ideflist, g2int *idefnum);
g2int g2_unpack4(unsigned char *cgrib, g2int *iofst, g2int *ipdsnum, g2int **ipdstmpl,
                 g2int *mappdslen, float **coordlist, g2int *numcoord);
g2int g2_unpack5(unsigned char *cgrib, g2int *iofst, g2int *ndpts, g2int *idrsnum,
                 g2int **idrstmpl, g2int *mapdrslen);
g2int g2_unpack6(unsigned char *cgrib, g2int *iofst, g2int ngpts, g2int *ibmap,
                 g2int **bmap);
g2int g2_unpack7(unsigned char *cgrib, g2int *iofst, g2int igdsnum, g2int *igdstmpl,
                 g2int idrsnum, g2int *idrstmpl, g2int ndpts, float **fld);
 
/*  Prototypes for unpacking API  */
void seekgb(FILE *lugb, g2int iseek, g2int mseek, g2int *lskip,
            g2int *lgrib);
g2int g2_info(unsigned char *cgrib, g2int *listsec0, g2int *listsec1,
              g2int *numfields, g2int *numlocal);
g2int g2_getfld(unsigned char *cgrib, g2int ifldnum, g2int unpack, g2int expand,
                gribfield **gfld);
void g2_free(gribfield *gfld);
 
/*  Prototypes for packing API  */
g2int g2_create(unsigned char *cgrib, g2int *listsec0, g2int *listsec1);
g2int g2_addlocal(unsigned char *cgrib, unsigned char *csec2, g2int lcsec2);
g2int g2_addgrid(unsigned char *cgrib, g2int *igds, g2int *igdstmpl, g2int *ideflist,
                 g2int idefnum);
g2int g2_addfield(unsigned char *cgrib, g2int ipdsnum, g2int *ipdstmpl,
                  float *coordlist, g2int numcoord, g2int idrsnum, g2int *idrstmpl,
                  float *fld, g2int ngrdpts, g2int ibmap, g2int *bmap);
g2int g2_gribend(unsigned char *cgrib);
 
/* The file-based g2c API was introduced in version 2.0.0 of the library. */
 
/* Data types. */
#define G2C_BYTE 1    
#define G2C_CHAR 2    
#define G2C_SHORT 3   
#define G2C_INT 4     
#define G2C_FLOAT 5   
#define G2C_DOUBLE 6  
#define G2C_UBYTE 7   
#define G2C_USHORT 8  
#define G2C_UINT 9    
#define G2C_INT64 10  
#define G2C_UINT64 11 
/* Defines for file handling. */
#define G2C_MAX_FILES 3             
#define G2C_MAX_NAME 1024           
#define G2C_NOWRITE 0x0000          
#define G2C_WRITE 0x0001            
#define G2C_CLOBBER 0x0000          
#define G2C_NOCLOBBER 0x0004        
#define G2C_LARGE_FILE_INDEX 0x0008 
/* Useful constants. */
#define G2C_SECTION0_BYTES 16 
#define G2C_SECTION1_BYTES 21
 
#define G2C_SECTION0_LEN 3  
#define G2C_SECTION1_LEN 13 
/* Constants to help with templates. */
#define G2C_MAX_GDS_TEMPLATE 31        
#define G2C_MAX_GDS_TEMPLATE_MAPLEN 28 
#define G2C_MAX_PDS_TEMPLATE 47        
#define G2C_MAX_PDS_TEMPLATE_MAPLEN 45 
#define G2C_MAX_DRS_TEMPLATE 10        
#define G2C_MAX_DRS_TEMPLATE_MAPLEN 18 
/* File handling functions. */
int g2c_open(const char *path, int mode, int *g2cid);
int g2c_open_index(const char *data_file, const char *index_file, int mode, int *g2cid);
int g2c_close(int g2cid);
int g2c_write_index(int g2cid, int mode, const char *index_file);
 
/* GRIB1 file functions. */
int g2c_open_index1(const char *index_file);
 
/* Inquiry functions. */
int g2c_inq(int g2cid, int *num_msg);
int g2c_inq_msg(int g2cid, int msg_num, unsigned char *discipline, int *num_fields,
                int *num_local, short *center, short *subcenter, unsigned char *master_version,
                unsigned char *local_version);
int g2c_inq_msg_time(int g2cid, int msg_num, unsigned char *sig_ref_time, short *year,
                     unsigned char *month, unsigned char *day, unsigned char *hour,
                     unsigned char *minute, unsigned char *second);
int g2c_inq_prod(int g2cid, int msg_num, int prod_num, int *pds_template_len,
                 long long int *pds_template, int *gds_template_len, long long int *gds_template,
                 int *drs_template_len, long long int *drs_template);
int g2c_inq_dim(int g2cid, int msg_num, int prod_num, int dim_num, size_t *len,
                char *name, float *val);
 
/* Getting data. */
int g2c_get_prod(int g2cid, int msg_num, int prod_num, int *num_data_points,
                 float *data);
 
/* Templates. */
int g2c_get_grid_template(int grid_template_num, int *maplen, int *map, int *needext);
int g2c_get_grid_template_extension(int grid_template_num, int *g2c_template,
                                    int *extlen, int *ext);
int g2c_get_pds_template_extension(int pds_template_num, int *g2c_template,
                                   int *extlen, int *ext);
int g2c_get_pds_template(int pds_template_num, int *maplen, int *map, int *needext);
int g2c_get_drs_template(int drs_template_num, int *maplen, int *map, int *needext);
 
/* Internal functions. */
int g2c_get_msg(int g2cid, size_t skip_bytes, size_t max_bytes, size_t *bytes_to_msg,
                size_t *bytes_in_msg, unsigned char **cbuf);
int g2c_find_msg2(int g2cid, size_t skip_bytes, size_t max_bytes, size_t *bytes_to_msg,
                  size_t *bytes_in_msg);
int g2c_csv_init();
int g2c_find_desc_str(char *title, char *code, char *desc);
int g2c_find_desc(char *title, int code, char *desc);
void g2c_free_tables();
void g2c_gbit_int(unsigned char *in, int *iout, int iskip, int nbits);
int g2c_gbits_int(unsigned char *in, int *iout, int iskip, int nbits,
                  int nskip, int n);
int g2c_seekmsg(int g2cid, size_t skip, size_t *offset, size_t *msglen);
 
/* Logging, for debugging purposes. */
int g2c_set_log_level(int new_level);
int g2c_log_file(int g2cid);
 
/* Error handling. */
const char *g2c_strerror(int g2cerr);
 
/* Compression. */
int g2c_unpack7(unsigned char *cgrib, int igdsnum, int gds_tmpl_len, long long int *gdstmpl,
                int idrsnum, int drs_tmpl_len, long long int *drstmpl, int ndpts, float *fld);
int g2c_pngpackf(float *fld, size_t width, size_t height, int *idrstmpl,
                 unsigned char *cpack, int *lcpack);
int g2c_pngpackd(double *fld, size_t width, size_t height, int *idrstmpl,
                 unsigned char *cpack, int *lcpack);
int g2c_pngunpackf(unsigned char *cpack, size_t len, int *idrstmpl, size_t ndpts,
                   float *fld);
int g2c_pngunpackd(unsigned char *cpack, size_t len, int *idrstmpl, size_t ndpts,
                   double *fld);
int g2c_jpcpackf(float *fld, size_t width, size_t height, int *idrstmpl,
                 unsigned char *cpack, size_t *lcpack);
int g2c_jpcpackd(double *fld, size_t width, size_t height, int *idrstmpl,
                 unsigned char *cpack, size_t *lcpack);
int g2c_jpcunpackf(unsigned char *cpack, size_t len, int *idrstmpl, size_t ndpts,
                   float *fld);
int g2c_jpcunpackd(unsigned char *cpack, size_t len, int *idrstmpl, size_t ndpts,
                   double *fld);
int g2c_enc_jpeg2000(unsigned char *cin, int width, int height, int nbits,
                     int ltype, int ratio, int retry, char *outjpc,
                     size_t jpclen);
int g2c_dec_jpeg2000(char *injpc, size_t bufsize, int *outfld);
int g2c_aecpackf(float *fld, size_t width, size_t height, int *idrstmpl,
                 unsigned char *cpack, size_t *lcpack);
int g2c_aecpackd(double *fld, size_t width, size_t height, int *idrstmpl,
                 unsigned char *cpack, size_t *lcpack);
int g2c_aecunpackf(unsigned char *cpack, size_t len, int *idrstmpl, size_t ndpts,
                   float *fld);
int g2c_aecunpackd(unsigned char *cpack, size_t len, int *idrstmpl, size_t ndpts,
                   double *fld);
 
/* Testing. */
int g2c_compare(int g2cid1, int g2cid2);
 
/* Output. */
int g2c_degrib2(int g2cid, const char *fileout);
 
/* Parameters. */
int g2c_param_g1tog2(int g1val, int g1ver, int *g2disc, int *g2cat, int *g2num);
int g2c_param_abbrev(int g2disc, int g2cat, int g2num, char *abbrev);
int g2c_param_g2tog1(int g2disc, int g2cat, int g2num, int *g1val, int *g1ver);
int g2c_param_all(int param_idx, int *g1ver, int *g1val, int *g2disc, int *g2cat,
                  int *g2num, char *abbdrev);
 
/* Useful constants. */
#define G2C_SECTION0_ARRAY_LEN 3  
#define G2C_SECTION1_ARRAY_LEN 13 
#define G2C_JPEG_DRS_TEMPLATE_LEN 7 
#define G2C_PNG_DRS_TEMPLATE_LEN 5  
#define G2C_AEC_DRS_TEMPLATE_LEN 8  
#define G2C_MAX_GRIB_DESC_LEN 512      
#define G2C_MAX_GRIB_STATUS_LEN 40     
#define G2C_MAX_GRIB_LEVEL_DESC_LEN 40 
#define G2C_MAX_GRIB_CODE_LEN 20       
#define G2C_MAX_GRIB_TITLE_LEN 200     
#define G2C_MAX_NUM_SECTIONS 1024      
#define G2C_MAX_NOAA_PARAMS 2000        
#define G2C_MAX_NOAA_ABBREV_LEN 8       
#define G2C_MAX_NOAA_PARAM_LINE_LEN 120 
#define G2C_JASPER_MAX_MEM 268435456 
/* Error codes for G2 API. */
#define G2_NO_ERROR 0             
#define G2_CREATE_GRIB_VERSION -1 
#define G2_INFO_NO_GRIB 1         
#define G2_INFO_GRIB_VERSION 2    
#define G2_INFO_NO_SEC1 3         
#define G2_INFO_WRONG_END 4       
#define G2_INFO_BAD_END 5         
#define G2_INFO_INVAL_SEC 6       
#define G2_GETFLD_NO_GRIB 1       
#define G2_GETFLD_GRIB_VERSION 2  
#define G2_GETFLD_INVAL 3         
#define G2_GETFLD_WRONG_END 4     
#define G2_GETFLD_WRONG_NFLDS 6   
#define G2_GETFLD_BAD_END 7       
#define G2_GETFLD_INVAL_SEC 8     
#define G2_GETFLD_NO_DRT 9        
#define G2_GETFLD_BAD_SEC1 15     
#define G2_GETFLD_BAD_SEC2 16     
#define G2_GETFLD_BAD_SEC3 10     
#define G2_GETFLD_BAD_SEC4 11     
#define G2_GETFLD_BAD_SEC5 12     
#define G2_GETFLD_BAD_SEC6 13     
#define G2_GETFLD_BAD_SEC7 14     
#define G2_GETFLD_NO_BITMAP 17    
#define G2_GRIBEND_MSG_INIT -1    
#define G2_BAD_SEC -4             
#define G2_UNPACK_BAD_SEC 2       
#define G2_UNPACK_NO_MEM 6        
#define G2_UNPACK3_BAD_GDT 5      
#define G2_UNPACK4_BAD_PDT 5      
#define G2_UNPACK5_BAD_DRT 7      
#define G2_UNPACK6_BAD_BITMAP 4   
#define G2_UNPACK7_CORRUPT_SEC 7  
#define G2_UNPACK7_WRONG_GDT 5    
#define G2_UNPACK7_BAD_DRT 4      
#define G2_ADD_MSG_INIT -1        
#define G2_ADD_MSG_COMPLETE -2    
#define G2_BAD_SEC_COUNTS -3      
#define G2_ADDFIELD_BAD_PDT -5    
#define G2_ADDFIELD_BAD_GDS -6    
#define G2_ADDFIELD_BAD_DRT -7    
#define G2_ADDFIELD_BAD_BITMAP -8 
#define G2_ADDFIELD_BAD_GDT -9    
#define G2_ADDFIELD_ERR -10       
#define G2_ADDGRID_BAD_GDT -5     
#define G2_JPCUNPACK_MEM 1        
#define G2_SPECUNPACK_TYPE -3     
#define G2_JASPER_INIT -2         
#define G2_JASPER_ENCODE -3       
#define G2_JASPER_DECODE -3       
#define G2_JASPER_DECODE_COLOR -5 
/* These are the new error codes. */
#define G2C_NOERROR 0           
#define G2C_ERROR 1             
#define G2C_ENOTGRIB (-50)      
#define G2C_EMSGCOMPLETE (-51)  
#define G2C_ENAMETOOLONG (-52)  
#define G2C_EINVAL (-53)        
#define G2C_EFILE (-54)         
#define G2C_EBADID (-55)        
#define G2C_ETOOMANYFILES (-56) 
#define G2C_ENOMEM (-57)        
#define G2C_EMSG (-58)          
#define G2C_ENOMSG (-59)        
#define G2C_EXML (-60)          
#define G2C_ENOTFOUND (-61)     
#define G2C_ENOTGRIB2 (-62)     
#define G2C_ENOSECTION (-63)    
#define G2C_ENOEND (-64)        
#define G2C_EBADEND (-65)       
#define G2C_EBADSECTION (-66)   
#define G2C_EJPEG (-67)         
#define G2C_EPNG (-68)          
#define G2C_ENOTEMPLATE (-69)   
#define G2C_EBADTEMPLATE (-70)  
#define G2C_ENOPARAM (-71)      
#define G2C_ENOPRODUCT (-72)    
#define G2C_EBADTYPE (-73)      
#define G2C_EAEC (-74)          
#define G2C_ECSV (-75)          
#endif /*  _grib2_H  */