external/io_grib1/MEL_grib1/gribputbds.c

   1 #include <stdio.h>
   2 #include <stdlib.h>
   3 #include <string.h>
   4 #include "dprints.h"            /* for dprints */
   5 #include "gribfuncs.h"          /* prototypes */
   6
   7 /*
   8 ******************************************************************************
   9 * A.  FUNCTION:  gribputbds
  10 *       Use the information provided to create a  Binary Data Section of
  11 *       the GRIB format and store it in the GRIB_HDR structure;
  12 *
  13 *    INTERFACE:
  14 *      int   gribputbds (user_input, lgrid_size, sDec_sc_fctr, pfData_Array,
  15 *                         pBDS_Head_Input,  pgrib_hdr, errmsg)
  16 *
  17 *    ARGUMENTS (I=input, O=output, I&O=input and output):
  18 *      (I)  USER_INPUT user_input;
  19 *           Structure containing encoder configuration data
  20 *      (I)  long lgrid_size;
  21 *           number of datapoints expected for this projection
  22 *      (I)  short sDec_sc_fctr;
  23 *           Decimal Scle Factor used when packing up data
  24 *    (I&O)  float *pfData_Array;
  25 *           float array to be packed up.  Returned scaled up by Dec Scale Fctr.
  26 *      (O)  BDS_HEAD_INPUT *pBDS_Head_Input
  27 *           returned filled;
  28 *    (I&O)  GRIB_HDR **pgrib_hdr;
  29 *           structure to hold encoded BDS and its info
  30 *      (O)  char *errmsg
  31 *           empty array, returned filled if error occurred;
  32 *
  33 *     RETURN CODE:
  34 *      0> no errors; GRIB_HDR now has a valid Binary Data Section;
  35 *         BDS_HEAD_INPUT filled also;
  36 *      1> error occurred, errmsg filled;
  37 *         either GRIB_HDR structure is corrupted, or
  38 *         non-shuffle mode but the Data array is Null, or
  39 *         failed to pack the Data array up, or
  40 *         failed to expand 'entire_msg' in GRIB_HDR to support encoded BDS;
  41 ******************************************************************************
  42 */
  43 #if PROTOTYPE_NEEDED
  44 int   gribputbds ( USER_INPUT user_input, long lgrid_size,
  45                 short sDec_sc_fctr, float *pfData_Array,
  46                 BDS_HEAD_INPUT *pBDS_Head_Input, GRIB_HDR **pgrib_hdr,
  47                 char *errmsg)
  48 #else
  49 int   gribputbds ( user_input, lgrid_size, sDec_sc_fctr, pfData_Array,
  50                    pBDS_Head_Input, pgrib_hdr, errmsg)
  51
  52                   USER_INPUT    user_input;             /* input */
  53                   long          lgrid_size;             /* input */
  54                   short                 sDec_sc_fctr;   /* input */
  55                   float                 *pfData_Array;  /* input */
  56                   BDS_HEAD_INPUT  *pBDS_Head_Input;     /* output */
  57                   GRIB_HDR      **pgrib_hdr;            /* input & output */
  58                   char          *errmsg;                /* output */
  59
  60 #endif
  61 {
  62 /*
  63 *
  64 * A.0       DEFAULT to Error Stat
  65 */
  66 char *func= "gribputbds";
  67 long lBDS_length= 0;    /* Rnd2_len bytes */
  68 void *pvbstr= 0;        /* remains null until after Inp2true_bds */
  69 GRIB_HDR *gh;           /* working var */
  70 long newsize;           /* working var */
  71 void  create_inpBDS();
  72 int  n, stat=1;
  73
  74     DPRINT1 ("\nEntering %s() ...\n",func);
  75 /*
  76 *
  77 * A.1       ASSIGN the GRIB_HDR pointer to local ptr;
  78 *           IF (it's null OR entire_msg is null) THEN
  79 *              RETURN error !errmsg filled
  80 *           ENDIF
  81 */
  82     gh= *pgrib_hdr;
  83     if (!gh || !gh->entire_msg) {
  84         DPRINT1( "%s:  Grib Header or its Entire_msg is NULL\n", func);
  85         sprintf(errmsg,"%s:  Grib Header or its Entire_msg is NULL\n", func);
  86         goto BYE;
  87         }
  88
  89 /*
  90 *
  91 * A.2       IF (the floating point array is null) THEN
  92 */
  93     if (pfData_Array == NULL) {
  94
  95 /*
  96 * A.2.1         IF (creating all sections mode)
  97 * A.2.1.a       THEN
  98 *                  RETURN error      !cannot go on w/o float array
  99 */
 100           if  (! gh->shuffled) {
 101                DPRINT1 ("%s:  Float array is Null, cannot proceed;\n",func);
 102                sprintf(errmsg,
 103                 "%s:  Float array is Null, cannot proceed;\n",func);
 104                 goto BYE;
 105                }
 106 /*
 107 * A.2.1.b       ELSE   /# Create all sections mode #/
 108 *                  !bds must already exist & has non-zero length, else error;
 109 *
 110 *                  IF (bds is null or bdslen <=0) THEN
 111 *                      RETURN error    !errmsg filled
 112 *                  ELSE
 113 *                      RETURN no error !bds already defined & has nonzero len
 114 *                  ENDIF
 115 */
 116           else {  /* create all mode */
 117                 if (gh->bds_ptr== NULL || gh->bds_len<=0)
 118                    {
 119                     DPRINT3 ( "%s:  No FloatData avail and GribHdr "\
 120                     "has no BDS yet (ptr=%ld len=%ld)\n"
 121                      ,func,gh->bds_ptr,gh->bds_len);
 122                     sprintf(errmsg,
 123                     "%s:  No FloatData avail and GribHdr has no BDS yet"\
 124                     "(ptr=%ld len=%ld)\n",func,gh->bds_ptr,gh->bds_len);
 125                     }
 126                 else {
 127                     stat= 0;
 128                     DPRINT2 ("%s: No need to proceed, GribHdr already "\
 129                     "has a BDS  (len=%ld)\n", func, gh->bds_len);
 130                    }
 131 /*
 132 * A.2.1         ENDIF
 133 */
 134                } /* if */
 135
 136 /*
 137 * A.2.2         RETURN with Stat   !not decoding anything
 138 */
 139         goto BYE;  /* quit */
 140 /*
 141 *
 142 * A.2       ENDIF    !no float data
 143 */
 144       }  /* no flt data */
 145
 146
 147     DPRINT0 ("Need to pack Float Data & Store in (Char*);\n");
 148
 149 /*
 150 *
 151 * A.3         FILL the BDS Head Input struct;
 152 */
 153    pBDS_Head_Input->Bin_sc_fctr = 0;     /* INPUT NOT USED AT THIS TIME */
 154    pBDS_Head_Input->fReference = 0.0;    /* INPUT NOT USED AT THIS TIME */
 155    pBDS_Head_Input->usBit_pack_num = user_input.usBit_pack_num;
 156                                          /* #bits used for packing, 0=default*/
 157    pBDS_Head_Input->ulGrid_size = (unsigned long) lgrid_size;  /* Grid size */
 158    pBDS_Head_Input->fPack_null = 1e10;   /* Pack null value */
 159
 160    DPRINT3 ("\t bds_head_input->usBit_pack_num = %u\n" \
 161            "\t bds_head_input->ulGrid_size = %u\n" \
 162           "\t bds_head_input->fPack_null = %f\n",
 163           pBDS_Head_Input->usBit_pack_num, pBDS_Head_Input->ulGrid_size,
 164           pBDS_Head_Input->fPack_null );
 165
 166 /*
 167 *
 168 * A.4       FUNCTION pack_spatial !packs data into binary bitstream
 169 *           IF (error in pack grid routine)
 170 *           THEN
 171 *               RETURN with error !errmsg filled
 172 *           ENDIF
 173 */
 174      if ((n= pack_spatial ( (long *)&(pBDS_Head_Input->ulGrid_size),
 175                     &(pBDS_Head_Input->usBit_pack_num),
 176                     &(pBDS_Head_Input->fPack_null),
 177                     pfData_Array,
 178                     (unsigned long **) &pvbstr,
 179                     sDec_sc_fctr, &lBDS_length, errmsg)) )
 180           {
 181           DPRINT2 ("%s:  Pack Spatial returned err=%d\n", func, n);
 182           upd_child_errmsg (func, errmsg);
 183           goto BYE;
 184           }
 185
 186 /*
 187 *
 188 * A.5       CALCULATE new message length including new BDS
 189 *             (Include 4 bytes for EDS to avoid another realloc)
 190 */
 191      newsize=  gh->msg_length + lBDS_length + 4;
 192
 193 /*
 194 *
 195 * A.6       IF gribhdr's buffer is too small AND
 196 *               FUCTION Expand_gribhdr failed
 197 *           THEN
 198 *               RETURN with error   !errmsg filled
 199 *           ENDIF
 200 */
 201      if (newsize > gh->abs_size
 202         && Expand_gribhdr (gh, newsize, errmsg) !=0)
 203         {
 204         upd_child_errmsg (func, errmsg);
 205         goto BYE;
 206         }
 207
 208 /*
 209 *
 210 * A.7       STORE bds & its info into Grib Hdr
 211 *           !copy true BDS struct over into entire message array
 212 *           !update message length also in Grib Hdr
 213 *           !save length of bds into Internal Struct too
 214 */
 215     gh->bds_ptr= gh->entire_msg + gh->msg_length;
 216     memcpy ((void *) gh->bds_ptr, pvbstr, lBDS_length);
 217     gh->bds_len    = lBDS_length;
 218     gh->msg_length += gh->bds_len;
 219
 220     /* Added by Todd Hutchinson, TASC  4/16/99*/
 221     /* This stops a memory leak */
 222     free(pvbstr);
 223
 224     pBDS_Head_Input->length = lBDS_length;  /* update the Input struct too */
 225
 226     DPRINT2("%s: copied %ld bytes from pvbstr to BDSPTR\n", func, lBDS_length);
 227
 228 /*
 229 *
 230 * A.8       CHANGE status to no errors
 231 */
 232     stat = 0;
 233
 234 BYE:
 235 /*
 236 *
 237 * A.9       RETURN w/ Stat
 238 */
 239     DPRINT2 ("Leaving %s,  Stat=%d\n", func , stat);
 240     return (stat);
 241 /*
 242 *
 243 * END OF FUNCTION
 244 *
 245 *
 246 */
 247 }