grib2_int.h

Go to the documentation of this file.

 
#ifndef _grib2_int_H
#define _grib2_int_H
 
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <assert.h>
#include <ctype.h>
 
#include <errno.h>
#if defined(WIN32)
#include <winsock2.h> /* ntohl() function for Windows. */
#else
#include <arpa/inet.h> /* ntohl() function for Unix/Mac. */
#endif
 
#ifdef PTHREADS
#include <pthread.h>
#endif
 
#include "grib2.h"
 
#define ALOG2 (0.69314718) 
#define G2C_JASPER_JPEG_FORMAT_NAME "jpc"
 
#define G2C_MIN_MAX_BYTES 16
 
#define G2C_MAGIC_HEADER "GRIB"
 
#define G2C_MAGIC_HEADER_LEN 8
 
#define G2C_MAX_MESSAGES 1024
 
#define BYTE 8 
#define WORD 32 
#define ONE_BYTE 1 
#define TWO_BYTES 2 
#define FOUR_BYTES 4 
#define EIGHT_BYTES 8 
#define LATITUDE "Latitude"
 
#define LONGITUDE "Longitude"
 
/* For GRIB1. */
 
#define G2C_INDEX1_PDS_VAL_LEN 27
 
#define G2C_INDEX1_GDS_VAL_LEN 41
 
#define G2C_INDEX1_BMS_VAL_LEN 5
 
#define G2C_INDEX1_BDS_VAL_LEN 10
 
#define G2C_INDEX1_PDS_VAL2_LEN 27
 
#define G2C_INDEX1_PDS_VAL3_LEN 27
 
#define G2C_INDEX1_GDS_VAL2_LEN 27
 
/* For thread-safety, use these macros. */
#ifdef PTHREADS
 
#define MUTEX(m) pthread_mutex_t m = PTHREAD_MUTEX_INITIALIZER;
 
#define EXTERN_MUTEX(m) extern pthread_mutex_t m;
 
#define MUTEX_LOCK(m)                           \
    do {                                        \
        pthread_mutex_lock(&m);                 \
    } while(0)
 
#define MUTEX_UNLOCK(m)                         \
    do {                                        \
        pthread_mutex_unlock(&m);               \
    } while(0)
 
#else /* not PTHREADS */
 
#define MUTEX(m)
 
#define EXTERN_MUTEX(m)
 
#define MUTEX_LOCK(m)
 
#define MUTEX_UNLOCK(m)
 
#endif /* PTHREADS */
 
#define ntoh64(y) (((uint64_t)ntohl(y)) << WORD | ntohl(y >> WORD))
 
#define hton64(y) (((uint64_t)htonl(y)) << WORD | htonl(y >> WORD))
 
#define G2C_FILE_READ 0 
#define G2C_FILE_WRITE 1 
typedef struct g2c_message_info
{
    size_t msg_num; 
    size_t bytes_to_msg; 
    size_t bytes_in_msg; 
    unsigned char discipline; 
    int section1[G2C_SECTION1_ARRAY_LEN]; 
    int num_fields; 
    int num_local; 
    int bytes_to_local; 
    int bytes_to_bms; 
    int bytes_to_data; 
    int num_sections; 
    int *section_number; 
    size_t *section_offset; 
    int sec1_len; 
    short center; 
    short subcenter; 
    unsigned char master_version; 
    unsigned char local_version; 
    unsigned char sig_ref_time; 
    short year; 
    unsigned char month; 
    unsigned char day; 
    unsigned char hour; 
    unsigned char minute; 
    unsigned char second; 
    unsigned char status; 
    unsigned char type; 
    struct g2c_section_info *sec; 
    struct g2c_file_info *file; 
    struct g2c_message_info *next; 
} G2C_MESSAGE_INFO_T;
 
typedef struct g2c_section_info
{
    int sec_id; 
    unsigned int sec_len; 
    size_t bytes_to_sec; 
    unsigned char sec_num; 
    G2C_MESSAGE_INFO_T *msg; 
    void *sec_info; 
    struct g2c_section_info *next; 
    struct g2c_section_info *prev; 
    long long int *template; 
    int template_len; 
} G2C_SECTION_INFO_T;
 
typedef struct g2c_dim_info
{
    int dimid; 
    size_t len; 
    char name[G2C_MAX_NAME + 1]; 
    float *value; 
} G2C_DIM_INFO_T;
 
typedef struct g2c_section3_info
{
    unsigned char source_grid_def; 
    unsigned int num_data_points; 
    unsigned char num_opt; 
    unsigned char interp_list; 
    unsigned short grid_def; 
    int *optional; 
    G2C_DIM_INFO_T dim[2]; 
} G2C_SECTION3_INFO_T;
 
typedef struct g2c_section4_info
{
    int field_num;
    unsigned short num_coord; 
    unsigned short prod_def; 
    int *optional; 
} G2C_SECTION4_INFO_T;
 
typedef struct g2c_section5_info
{
    unsigned int num_data_points;
    unsigned short data_def; 
} G2C_SECTION5_INFO_T;
 
typedef struct g2c_section6_info
{
    unsigned char indicator;
} G2C_SECTION6_INFO_T;
 
typedef struct g2c_file_info
{
    int g2cid; 
    char path[G2C_MAX_NAME + 1]; 
    FILE *f; 
    size_t num_messages; 
    G2C_MESSAGE_INFO_T *msg; 
} G2C_FILE_INFO_T;
 
typedef struct g2c_entry
{
    struct g2c_entry *next;
    char desc[G2C_MAX_GRIB_DESC_LEN + 1];
    char status[G2C_MAX_GRIB_STATUS_LEN + 1];
    char code[G2C_MAX_GRIB_CODE_LEN + 1];
} G2C_CODE_ENTRY_T;
 
typedef struct g2c_code_table
{
    struct g2c_code_table *next;
    char title[G2C_MAX_GRIB_TITLE_LEN + 1];
    G2C_CODE_ENTRY_T *entry;
} G2C_CODE_TABLE_T;
 
typedef struct g2c_param
{
    int g1num; 
    int g1ver; 
    int g2disc; 
    int g2cat; 
    int g2num; 
    char abbrev[G2C_MAX_NOAA_ABBREV_LEN + 1]; 
} G2C_PARAM_T;
 
struct gtemplate
{
    g2int type;
 
    g2int num; 
    g2int maplen;
 
    g2int *map;
 
    g2int needext;
 
    g2int extlen;
 
    g2int *ext;
};
 
typedef struct gtemplate gtemplate; 
/* Legacy support functions. */
double int_power(double x, g2int y);
void mkieee(float *a, g2int *rieee, g2int num);
void rdieee(g2int *rieee, float *a, g2int num);
 
/* Get the various templates. */
gtemplate *getdrstemplate(g2int number);
gtemplate *extdrstemplate(g2int number, g2int *list);
gtemplate *getpdstemplate(g2int number);
gtemplate *extpdstemplate(g2int number, g2int *list);
gtemplate *getgridtemplate(g2int number);
gtemplate *extgridtemplate(g2int number, g2int *list);
 
/* Level and date/time info. */
int g2c_get_datetime(int ipdtn, long long int *ipdtmpl, short year, unsigned char month, unsigned char day,
                     unsigned char hour, unsigned char minute, unsigned char second, char *tabbrev);
int g2c_get_level_desc(int ipdtn, long long int *ipdtmpl, char *level_desc);
 
/* Packing and unpacking data. */
void simpack(float *fld, g2int ndpts, g2int *idrstmpl,
             unsigned char *cpack, g2int *lcpack);
g2int simunpack(unsigned char *cpack, g2int *idrstmpl, g2int ndpts,
                float *fld);
void compack(float *fld, g2int ndpts, g2int idrsnum, g2int *idrstmpl,
             unsigned char *cpack, g2int *lcpack);
int comunpack(unsigned char *cpack, g2int lensec, g2int idrsnum,
              g2int *idrstmpl, g2int ndpts, float *fld);
void misspack(float *fld, g2int ndpts, g2int idrsnum, g2int *idrstmpl,
              unsigned char *cpack, g2int *lcpack);
void cmplxpack(float *fld, g2int ndpts, g2int idrsnum, g2int *idrstmpl,
               unsigned char *cpack, g2int *lcpack);
g2int getpoly(unsigned char *csec3, g2int *jj, g2int *kk, g2int *mm);
void specpack(float *fld, g2int ndpts, g2int JJ, g2int KK, g2int MM,
              g2int *idrstmpl, unsigned char *cpack, g2int *lcpack);
g2int specunpack(unsigned char *cpack, g2int *idrstmpl, g2int ndpts, g2int JJ,
                 g2int KK, g2int MM, float *fld);
g2int getdim(unsigned char *csec3, g2int *width, g2int *height, g2int *iscan);
 
int enc_png(unsigned char *data, g2int width, g2int height, g2int nbits,
            unsigned char *pngbuf);
int dec_png(unsigned char *pngbuf, g2int *width, g2int *height,
            unsigned char *cout);
void pngpack(float *fld, g2int width, g2int height, g2int *idrstmpl,
             unsigned char *cpack, g2int *lcpack);
g2int pngunpack(unsigned char *cpack, g2int len, g2int *idrstmpl, g2int ndpts,
                float *fld);
int enc_jpeg2000(unsigned char *cin, g2int width, g2int height, g2int nbits,
                 g2int ltype, g2int ratio, g2int retry, char *outjpc,
                 g2int jpclen);
int dec_jpeg2000(char *injpc, g2int bufsize, g2int *outfld);
void jpcpack(float *fld, g2int width, g2int height, g2int *idrstmpl,
             unsigned char *cpack, g2int *lcpack);
g2int jpcunpack(unsigned char *cpack, g2int len, g2int *idrstmpl, g2int ndpts,
                float *fld);
 
void aecpack(float *fld, g2int width, g2int height, g2int *idrstmpl,
             unsigned char *cpack, g2int *lcpack);
g2int aecunpack(unsigned char *cpack, g2int len, g2int *idrstmpl, g2int ndpts,
                float *fld);
int enc_aec(unsigned char *data, g2int ctemplen, g2int nbits, g2int flags,
            g2int block_size, g2int rsi, unsigned char *aecbuf, g2int *aecbuflen);
int dec_aec(unsigned char *cpack, g2int len, g2int nbits, g2int flags,
            g2int block_size, g2int rsi, unsigned char *cfld, g2int cfldlen);
 
/* Packing and unpacking bits. */
void gbit(unsigned char *in, g2int *iout, g2int iskip, g2int nbits);
void sbit(unsigned char *out, g2int *in, g2int iskip, g2int nbits);
void gbits(unsigned char *in, g2int *iout, g2int iskip, g2int nbits,
           g2int nskip, g2int n);
void sbits(unsigned char *out, g2int *in, g2int iskip, g2int nbits,
           g2int nskip, g2int n);
 
/* Deal with grib groups. */
int pack_gp(g2int *kfildo, g2int *ic, g2int *nxy,
            g2int *is523, g2int *minpk, g2int *inc, g2int *missp, g2int *misss,
            g2int *jmin, g2int *jmax, g2int *lbit, g2int *nov,
            g2int *ndg, g2int *lx, g2int *ibit, g2int *jbit, g2int *kbit,
            g2int *novref, g2int *lbitref, g2int *ier);
 
/* Check the message header and check for message termination. */
int g2c_check_msg(unsigned char *cgrib, g2int *lencurr, int verbose);
 
/* Basic file I/O. */
int g2c_file_io(FILE *f, int write, int g2ctype, void *var);
int g2c_file_io_byte(FILE *f, int write, char *var);
int g2c_file_io_ubyte(FILE *f, int write, unsigned char *var);
int g2c_file_io_short(FILE *f, int write, short *var);
int g2c_file_io_ushort(FILE *f, int write, unsigned short *var);
int g2c_file_io_int(FILE *f, int write, int *var);
int g2c_file_io_uint(FILE *f, int write, unsigned int *var);
int g2c_file_io_longlong(FILE *f, int write, long long *var);
int g2c_file_io_ulonglong(FILE *f, int write, unsigned long long *var);
int g2c_file_io_template(FILE *f, int rw_flag, int map, long long int *template_value);
 
/* Read and remember file, message, and section metadata. */
int g2c_add_file(const char *path, int mode, int *g2cid);
int add_msg(G2C_FILE_INFO_T *file, int msg_num, size_t bytes_to_msg, size_t bytes_in_msg,
            int read_file, G2C_MESSAGE_INFO_T **msg);
int add_section(FILE *f, G2C_MESSAGE_INFO_T *msg, int sec_id, unsigned int sec_len, size_t bytes_to_sec,
                unsigned char sec_num);
int g2c_rw_section1_metadata(FILE *f, int rw_flag, G2C_MESSAGE_INFO_T *msg);
int g2c_rw_section3_metadata(FILE *f, int rw_flag, G2C_SECTION_INFO_T *sec);
int g2c_rw_section4_metadata(FILE *f, int rw_flag, G2C_SECTION_INFO_T *sec);
int g2c_rw_section5_metadata(FILE *f, int rw_flag, G2C_SECTION_INFO_T *sec);
int g2c_rw_section6_metadata(FILE *f, int rw_flag, G2C_SECTION_INFO_T *sec);
 
/* Logging output. */
int g2c_log_section1(G2C_MESSAGE_INFO_T *msg);
 
/* Handle logging. */
#ifdef LOGGING
 
/* To log something... */
void g2_log(int severity, const char *fmt, ...);
 
#define LOG(e) g2_log e
 
#else /* LOGGING */
 
#define LOG(e)
 
#endif /* LOGGING */
 
#endif  /*  _grib2_int_H  */