stream_gribapi.c 82.5 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
4
#if defined (HAVE_CONFIG_H)
#  include "config.h"
#endif

5
#if  defined  (HAVE_LIBGRIB_API)
6
#include <limits.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
7
8
#include <stdio.h>

Uwe Schulzweida's avatar
Uwe Schulzweida committed
9
#include "dmemory.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
10
#include "cdi.h"
11
#include "cdi_int.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
12
#include "file.h"
13
14
#include "gribapi_utilities.h"
#include "stream_grb.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
15
16
17
#include "varscan.h"
#include "datetime.h"
#include "vlist.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
18
#include "stream_grb.h"
19
#include "calendar.h"
20
#include "subtype.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
21
22


23
24
#include "cgribex.h"      /* gribGetSize, gribRead, gribGetZip, GRIB1_LTYPE_99 */
#include "gribapi.h"
25

26
#include <grib_api.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
27
28
29

extern int cdiInventoryMode;

30
static const var_tile_t dummy_tiles = { 0, -1, -1, -1, -1, -1 };
31

Uwe Schulzweida's avatar
Uwe Schulzweida committed
32
typedef struct {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
33
  int param;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
34
35
36
  int level1;
  int level2;
  int ltype;
37
  int tsteptype;
38
  char name[32];
39
40
41

  var_tile_t tiles;

42
} compvar2_t;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
43
44
45


static
46
int gribapiGetZaxisType(long editionNumber, int grib_ltype)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
47
{
Uwe Schulzweida's avatar
Uwe Schulzweida committed
48
49
50
  int zaxistype = ZAXIS_GENERIC;

  if ( editionNumber <= 1 )
Uwe Schulzweida's avatar
Uwe Schulzweida committed
51
    {
52
      zaxistype = grib1ltypeToZaxisType(grib_ltype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
53
54
55
    }
  else
    {
56
      zaxistype = grib2ltypeToZaxisType(grib_ltype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
57
58
    }

59
  return zaxistype;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
60
61
}

62
static
63
int getTimeunits(long unitsOfTime)
64
65
{
  int timeunits = -1;
66
67
68
69
70
71
72
73
74
75
76
77
78

  switch (unitsOfTime)
    {
    case 13:  timeunits = TUNIT_SECOND;  break;
    case  0:  timeunits = TUNIT_MINUTE;  break;
    case  1:  timeunits = TUNIT_HOUR;    break;
    case 10:  timeunits = TUNIT_3HOURS;  break;
    case 11:  timeunits = TUNIT_6HOURS;  break;
    case 12:  timeunits = TUNIT_12HOURS; break;
    case  2:  timeunits = TUNIT_DAY;     break;
    default:  timeunits = TUNIT_HOUR;    break;
    }

79
  return timeunits;
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
}

static
double timeunit_factor(int tu1, int tu2)
{
  double factor = 1;

  if ( tu2 == TUNIT_HOUR )
    {
      switch (tu1)
        {
        case TUNIT_SECOND:  factor = 3600;   break;
        case TUNIT_MINUTE:  factor = 60;     break;
        case TUNIT_HOUR:    factor = 1;      break;
        case TUNIT_3HOURS:  factor = 1./3;   break;
        case TUNIT_6HOURS:  factor = 1./6;   break;
        case TUNIT_12HOURS: factor = 1./12;  break;
        case TUNIT_DAY:     factor = 1./24;  break;
        }
    }

101
  return factor;
102
103
104
105
106
107
}

static
int gribapiGetTimeUnits(grib_handle *gh)
{
  int timeunits = -1;
108
  long unitsOfTime = -1;
109

110
  grib_get_long(gh, "indicatorOfUnitOfTimeRange", &unitsOfTime);
111

112
  GRIB_CHECK(my_grib_set_long(gh, "stepUnits", unitsOfTime), 0);
113

114
  timeunits = getTimeunits(unitsOfTime);
115

116
  return timeunits;
117
118
}

119
static
120
void gribapiGetSteps(grib_handle *gh, int timeunits, int *startStep, int *endStep)
121
{
122
  int timeunits2 = timeunits;
123
124
  long unitsOfTime;
  int status = grib_get_long(gh, "stepUnits", &unitsOfTime);
125
126
  if ( status == 0 ) timeunits2 = getTimeunits(unitsOfTime);
  //timeunits2 = gribapiGetTimeUnits(gh);
127

128
  long lpar;
129
130
131
132
133
134
135
136
  status = grib_get_long(gh, "forecastTime", &lpar);
  if ( status == 0 ) *startStep = (int) lpar;
  else
    {
      status = grib_get_long(gh, "startStep", &lpar);
      if ( status == 0 )
        *startStep = (int) (((double)lpar * timeunit_factor(timeunits, timeunits2)) + 0.5);
    }
137

138
139
  *endStep = *startStep;
  status = grib_get_long(gh, "endStep", &lpar);
140
  if ( status == 0 )
141
142
    *endStep = (int) (((double)lpar * timeunit_factor(timeunits, timeunits2)) + 0.5);
  // printf("%d %d %d %d %d %g\n", *startStep, *endStep, lpar, timeunits, timeunits2, timeunit_factor(timeunits, timeunits2));
143
144
}

145
146
147
148
149
150
151
static
void gribapiGetDataDateTime(grib_handle *gh, int *datadate, int *datatime)
{
  long lpar;

  GRIB_CHECK(grib_get_long(gh, "dataDate", &lpar), 0);
  *datadate = (int) lpar;
152
  GRIB_CHECK(grib_get_long(gh, "dataTime", &lpar), 0);  //FIXME: This looses the seconds in GRIB2 files.
153
154
155
  *datatime = (int) lpar*100;
}

156
157
158
static
void gribapiSetDataDateTime(grib_handle *gh, int datadate, int datatime)
{
159
160
  GRIB_CHECK(my_grib_set_long(gh, "dataDate", datadate), 0);
  GRIB_CHECK(my_grib_set_long(gh, "dataTime", datatime/100), 0);
161
162
}

163
static
164
int gribapiGetValidityDateTime(grib_handle *gh, int *vdate, int *vtime)
165
{
166
  int rdate, rtime;
167
  int timeUnits, startStep = 0, endStep;
168
169
  int tstepRange = 0;
  int range;
170
171
  long sigofrtime = 3;

172
  if ( gribEditionNumber(gh) > 1 )
173
174
175
    {
      GRIB_CHECK(grib_get_long(gh, "significanceOfReferenceTime", &sigofrtime), 0);
    }
176
177
178
179
  else
    {
      GRIB_CHECK(grib_get_long(gh, "timeRangeIndicator", &sigofrtime), 0);
    }
180

181
  if ( sigofrtime == 3 )        //XXX: This looks like a bug to me, because timeRangeIndicator == 3 does not seem to have the same meaning as significanceOfReferenceTime == 3. I would recommend replacing this condition with `if(!gribapiTimeIsFC())`.
182
    {
183
      gribapiGetDataDateTime(gh, vdate, vtime);
184
185
186
    }
  else
    {
187
188
      gribapiGetDataDateTime(gh, &rdate, &rtime);

189
      timeUnits = gribapiGetTimeUnits(gh);
190
      gribapiGetSteps(gh, timeUnits, &startStep, &endStep);
191
192
193
194
195
196
197
198
199

      range = endStep - startStep;

      if ( range > 0 )
	{
	  if ( startStep == 0 ) tstepRange = -1;
	  else                  tstepRange =  1;
	}

200
201
202
203
      {
	static int lprint = TRUE;
	extern int grib_calendar;
	int ryear, rmonth, rday, rhour, rminute, rsecond;
204
205
206
	int julday, secofday;
	int64_t time_period = endStep;
        int64_t addsec;
207
208
209
210

	cdiDecodeDate(rdate, &ryear, &rmonth, &rday);
	cdiDecodeTime(rtime, &rhour, &rminute, &rsecond);

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
        if ( rday > 0 )
          {
            encode_caldaysec(grib_calendar, ryear, rmonth, rday, rhour, rminute, rsecond, &julday, &secofday);

            addsec = 0;
            switch ( timeUnits )
              {
              case TUNIT_SECOND:  addsec =         time_period; break;
              case TUNIT_MINUTE:  addsec =    60 * time_period; break;
              case TUNIT_HOUR:    addsec =  3600 * time_period; break;
              case TUNIT_3HOURS:  addsec = 10800 * time_period; break;
              case TUNIT_6HOURS:  addsec = 21600 * time_period; break;
              case TUNIT_12HOURS: addsec = 43200 * time_period; break;
              case TUNIT_DAY:     addsec = 86400 * time_period; break;
              default:
                if ( lprint )
                  {
                    Warning("Time unit %d unsupported", timeUnits);
                    lprint = FALSE;
                  }
                break;
              }

            julday_add_seconds(addsec, &julday, &secofday);

            decode_caldaysec(grib_calendar, julday, secofday, &ryear, &rmonth, &rday, &rhour, &rminute, &rsecond);
          }
238

239
240
241
	*vdate = cdiEncodeDate(ryear, rmonth, rday);
	*vtime = cdiEncodeTime(rhour, rminute, rsecond);
      }
242
    }
243

244
  return tstepRange;
245
246
}

247
static
248
void grib1GetLevel(grib_handle *gh, int *leveltype, int *lbounds, int *level1, int *level2)
249
{
250
  *leveltype = 0;
251
252
253
  *lbounds   = 0;
  *level1    = 0;
  *level2    = 0;
254

255
  long lpar;
256
  if ( !grib_get_long(gh, "indicatorOfTypeOfLevel", &lpar) )       //1 byte
257
    {
258
      *leveltype = (int) lpar;
259

260
      switch (*leveltype)
261
262
263
264
	{
	case GRIB1_LTYPE_SIGMA_LAYER:
	case GRIB1_LTYPE_HYBRID_LAYER:
	case GRIB1_LTYPE_LANDDEPTH_LAYER:
265
	  { *lbounds = 1; break; }
266
	}
267

268
269
270
271
272
273
274
275
      if ( *lbounds )
	{
	  GRIB_CHECK(grib_get_long(gh, "topLevel", &lpar), 0);  //1 byte
	  *level1 = (int)lpar;
	  GRIB_CHECK(grib_get_long(gh, "bottomLevel", &lpar), 0);       //1 byte
	  *level2 = (int)lpar;
	}
      else
276
	{
277
          double dlevel;
278
	  GRIB_CHECK(grib_get_double(gh, "level", &dlevel), 0); //2 byte
279
	  if ( *leveltype == GRIB1_LTYPE_ISOBARIC ) dlevel *= 100;
280
	  if ( dlevel < -2.e9 || dlevel > 2.e9 ) dlevel = 0;
281
	  if ( *leveltype == GRIB1_LTYPE_99 || *leveltype == GRIB1_LTYPE_ISOBARIC_PA ) *leveltype = GRIB1_LTYPE_ISOBARIC;
282

283
284
285
	  *level1 = (int) dlevel;
	  *level2 = 0;
	}
286
    }
287
288
}

289
290
291
static
double grib2ScaleFactor(long factor)
{
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  switch(factor)
    {
      case GRIB_MISSING_LONG: return 1;
      case 0: return 1;
      case 1: return 0.1;
      case 2: return 0.01;
      case 3: return 0.001;
      case 4: return 0.0001;
      case 5: return 0.00001;
      case 6: return 0.000001;
      case 7: return 0.0000001;
      case 8: return 0.00000001;
      case 9: return 0.000000001;
      default: return 0;
    }
}

static
int calcLevel(int level_sf, long factor, long level)
{
  double result = 0;
Thomas Jahns's avatar
Thomas Jahns committed
313
  if(level != GRIB_MISSING_LONG) result = (double)level*grib2ScaleFactor(factor);
314
315
  if(level_sf) result *= level_sf;
  return (int)result;
316
317
}

318
static
319
void grib2GetLevel(grib_handle *gh, int *leveltype1, int *leveltype2, int *lbounds, int *level1,
320
                   int *level2, int *level_sf, int *level_unit)
321
{
322
323
324
  int status;
  long lpar;
  long factor;
325

326
327
  *leveltype1 = 0;
  *leveltype2 = -1;
328
329
330
331
332
  *lbounds    = 0;
  *level1     = 0;
  *level2     = 0;
  *level_sf   = 0;
  *level_unit = 0;
333

334
  status = grib_get_long(gh, "typeOfFirstFixedSurface", &lpar); //1 byte
335
  if ( status == 0 )
336
    {
337
      long llevel;
338

339
      *leveltype1 = (int) lpar;
340

341
      status = grib_get_long(gh, "typeOfSecondFixedSurface", &lpar); //1 byte
342
      /* FIXME: assert(lpar >= INT_MIN && lpar <= INT_MAX) */
343
      if ( status == 0 ) *leveltype2 = (int)lpar;
344

345
      if ( *leveltype1 != 255 && *leveltype2 != 255 && *leveltype2 > 0 ) *lbounds = 1;
346
      switch(*leveltype1)
347
        {
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
          case GRIB2_LTYPE_REFERENCE:
            if(*leveltype2 == 1) *lbounds = 0;
            break;

          case GRIB2_LTYPE_LANDDEPTH:
            *level_sf = 1000;
            *level_unit = CDI_UNIT_M;
            break;

          case GRIB2_LTYPE_ISOBARIC:
            *level_sf = 1000;
            *level_unit = CDI_UNIT_PA;
            break;

          case GRIB2_LTYPE_SIGMA:
            *level_sf = 1000;
            *level_unit = 0;
            break;
366
        }
367

368
369
370
      GRIB_CHECK(grib_get_long(gh, "scaleFactorOfFirstFixedSurface", &factor), 0);      //1 byte
      GRIB_CHECK(grib_get_long(gh, "scaledValueOfFirstFixedSurface", &llevel), 0);      //4 byte
      *level1 = calcLevel(*level_sf, factor, llevel);
371

372
373
374
375
376
      if ( *lbounds )
        {
          GRIB_CHECK(grib_get_long(gh, "scaleFactorOfSecondFixedSurface", &factor), 0); //1 byte
          GRIB_CHECK(grib_get_long(gh, "scaledValueOfSecondFixedSurface", &llevel), 0); //4 byte
          *level2 = calcLevel(*level_sf, factor, llevel);
377
        }
378
379
    }
}
380

381
static
382
void gribGetLevel(grib_handle *gh, int* leveltype1, int* leveltype2, int* lbounds, int* level1, int* level2, int* level_sf, int* level_unit, var_tile_t* tiles)
383
384
385
386
387
388
389
390
391
392
393
{
  if ( gribEditionNumber(gh) <= 1 )
    {
      grib1GetLevel(gh, leveltype1, lbounds, level1, level2);
      *leveltype2 = -1;
      *level_sf = 0;
      *level_unit = 0;
    }
  else
    {
      grib2GetLevel(gh, leveltype1, leveltype2, lbounds, level1, level2, level_sf, level_unit);
394
395

      /* read in tiles attributes (if there are any) */
Thomas Jahns's avatar
Thomas Jahns committed
396
397
398
399
400
401
      tiles->tileindex = (int)gribGetLongDefault(gh, cdiSubtypeAttributeName[SUBTYPE_ATT_TILEINDEX], -1);
      tiles->totalno_of_tileattr_pairs = (int)gribGetLongDefault(gh, cdiSubtypeAttributeName[SUBTYPE_ATT_TOTALNO_OF_TILEATTR_PAIRS], -1);
      tiles->tileClassification = (int)gribGetLongDefault(gh, cdiSubtypeAttributeName[SUBTYPE_ATT_TILE_CLASSIFICATION], -1);
      tiles->numberOfTiles = (int)gribGetLongDefault(gh, cdiSubtypeAttributeName[SUBTYPE_ATT_NUMBER_OF_TILES], -1);
      tiles->numberOfAttributes = (int)gribGetLongDefault(gh, cdiSubtypeAttributeName[SUBTYPE_ATT_NUMBER_OF_ATTR], -1);
      tiles->attribute = (int)gribGetLongDefault(gh, cdiSubtypeAttributeName[SUBTYPE_ATT_TILEATTRIBUTE], -1);
402
    }
403
404
}

405
406
407
408
409
static
void gribapiGetString(grib_handle *gh, const char *key, char *string, size_t length)
{
  string[0] = 0;

410
411
412
413
414
415
  int ret = grib_get_string(gh, key, string, &length);
  if (ret != 0)
    {
      fprintf(stderr, "grib_get_string(gh, \"%s\", ...) failed!\n", key);
      GRIB_CHECK(ret, 0);
    }
416
417
418
419
  if      ( length == 8 && memcmp(string, "unknown", length) == 0 ) string[0] = 0;
  else if ( length == 2 && memcmp(string, "~", length)       == 0 ) string[0] = 0;
}

420
static
421
void gribapiAddRecord(stream_t * streamptr, int param, grib_handle *gh,
422
                      size_t recsize, off_t position, int datatype, int comptype, const char *varname,
423
                      int leveltype1, int leveltype2, int lbounds, int level1, int level2, int level_sf, int level_unit,
424
                      const var_tile_t *tiles, int lread_additional_keys)
425
426
{
  int levelID = 0;
427
  char stdname[CDI_MAX_NAME], longname[CDI_MAX_NAME], units[CDI_MAX_NAME];
428
  long ens_index = 0, ens_count = 0, ens_forecast_type = 0;
429

430
431
432
  int vlistID = streamptr->vlistID;
  int tsID    = streamptr->curTsID;
  int recID   = recordNewEntry(streamptr, tsID);
433
  record_t *record = &streamptr->tsteps[tsID].records[recID];
434

435
  int tsteptype = gribapiGetTsteptype(gh);
436
  // numavg  = ISEC1_AvgNum;
437
  int numavg = 0;
438

439
  // fprintf(stderr, "param %d %d %d %d\n", param, level1, level2, leveltype1);
440

Thomas Jahns's avatar
Thomas Jahns committed
441
442
443
444
445
446
  record->size      = recsize;
  record->position  = position;
  record->param     = param;
  record->ilevel    = level1;
  record->ilevel2   = level2;
  record->ltype     = leveltype1;
Thomas Jahns's avatar
Thomas Jahns committed
447
  record->tsteptype = (short)tsteptype;
Thomas Jahns's avatar
Thomas Jahns committed
448
  record->tiles = tiles ? *tiles : dummy_tiles;
449
450
451
452
453
454
455
456
457
458
459
460

  //FIXME: This may leave the variable name unterminated (which is the behavior that I found in the code).
  //       I don't know precisely how this field is used, so I did not change this behavior to avoid regressions,
  //       but I think that it would be better to at least add a line
  //
  //           record->varname[sizeof(record->varname) - 1] = 0;`
  //
  //       after the `strncpy()` call.
  //
  //       I would consider using strdup() (that requires POSIX-2008 compliance, though), or a similar homebrew approach.
  //       I. e. kick the fixed size array and allocate enough space, whatever that may be.
  strncpy(record->varname, varname, sizeof(record->varname));
461

462
  grid_t *grid = (grid_t *)Malloc(sizeof(*grid));
463
  gribapiGetGrid(gh, grid);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
464

Uwe Schulzweida's avatar
Uwe Schulzweida committed
465
  struct addIfNewRes gridAdded = cdiVlistAddGridIfNew(vlistID, grid, 0);
466
  int gridID = gridAdded.Id;
467
468
469
470
471
472
473
474
475
476
477
  if ( !gridAdded.isNew ) Free(grid);
  else if ( grid->projtype == CDI_PROJ_RLL )
    {
      double xpole = 0, ypole = 0, angle = 0;
      grib_get_double(gh, "latitudeOfSouthernPoleInDegrees",  &ypole);
      grib_get_double(gh, "longitudeOfSouthernPoleInDegrees", &xpole);
      grib_get_double(gh, "angleOfRotation", &angle);
      xpole =  xpole - 180;
      if ( fabs(ypole) > 0 ) ypole = -ypole; // change from south to north pole
      if ( fabs(angle) > 0 ) angle = -angle;

478
      gridDefParamRLL(gridID, xpole, ypole, angle);
479
    }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
480

481
  int zaxistype = gribapiGetZaxisType(gribEditionNumber(gh), leveltype1);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
482

483
  switch (zaxistype)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
484
    {
485
486
487
    case ZAXIS_HYBRID:
    case ZAXIS_HYBRID_HALF:
      {
488
        long lpar;
489
        GRIB_CHECK(grib_get_long(gh, "NV", &lpar), 0);
Thomas Jahns's avatar
Thomas Jahns committed
490
        /* FIXME: assert(lpar >= 0) */
Thomas Jahns's avatar
Thomas Jahns committed
491
        size_t vctsize = (size_t)lpar;
492
493
        if ( vctsize > 0 )
          {
Thomas Jahns's avatar
Thomas Jahns committed
494
495
            double *vctptr = (double *) Malloc(vctsize*sizeof(double));
            size_t dummy = vctsize;
496
            GRIB_CHECK(grib_get_double_array(gh, "pv", vctptr, &dummy), 0);
Thomas Jahns's avatar
Thomas Jahns committed
497
            varDefVCT(vctsize, vctptr);
498
            Free(vctptr);
499
500
501
502
503
          }
        break;
      }
    case ZAXIS_REFERENCE:
      {
504
        unsigned char uuid[CDI_UUID_SIZE];
505
        long lpar;
506
        GRIB_CHECK(grib_get_long(gh, "NV", &lpar), 0);
507
        if ( lpar != 6 ) fprintf(stderr, "Warning ...\n");
508
509
510
511
        GRIB_CHECK(grib_get_long(gh, "nlev", &lpar), 0);
        int nhlev = (int)lpar;
        GRIB_CHECK(grib_get_long(gh, "numberOfVGridUsed", &lpar), 0);
        int nvgrid = (int)lpar;
512
        size_t len = (size_t)CDI_UUID_SIZE;
513
514
        memset(uuid, 0, CDI_UUID_SIZE);
        GRIB_CHECK(grib_get_bytes(gh, "uuidOfVGrid", uuid, &len), 0);
515
        varDefZAxisReference(nhlev, nvgrid, uuid);
516
517
        break;
      }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
518
    }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
519

520
521
  // if ( datatype > 32 ) datatype = CDI_DATATYPE_PACK32;
  if ( datatype <  0 ) datatype = CDI_DATATYPE_PACK;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
522

523
  stdname[0] = 0;
524
525
526
  longname[0] = 0;
  units[0] = 0;

527
  if ( varname[0] != 0 )
Uwe Schulzweida's avatar
Uwe Schulzweida committed
528
    {
529
      size_t vlen = CDI_MAX_NAME;
530
      gribapiGetString(gh, "name", longname, vlen);
531
      vlen = CDI_MAX_NAME;
532
      gribapiGetString(gh, "units", units, vlen);
Thomas Jahns's avatar
Thomas Jahns committed
533
534
535
536
      vlen = CDI_MAX_NAME;
      int status = grib_get_string(gh, "cfName", stdname, &vlen);
      if ( status != 0 || vlen <= 1 || strncmp(stdname, "unknown", 7) == 0 )
        stdname[0] = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
537
    }
538
  // fprintf(stderr, "param %d name %s %s %s\n", param, name, longname, units);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
539

540
  /* add the previously read record data to the (intermediate) list of records */
541
  int tile_index = 0, varID;
542
  varAddRecord(recID, param, gridID, zaxistype, lbounds, level1, level2, level_sf, level_unit,
543
	       datatype, &varID, &levelID, tsteptype, numavg, leveltype1, leveltype2,
544
	       varname, stdname, longname, units, tiles, &tile_index);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
545

Thomas Jahns's avatar
Thomas Jahns committed
546
547
  record->varID   = (short)varID;
  record->levelID = (short)levelID;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
548

549
  varDefCompType(varID, comptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
550

551
552
  /*
    Get the ensemble Info from the grib-2 Tables and update the intermediate datastructure.
553
    Further update to the "vlist" is handled in the same way as for GRIB-1 by "cdi_generate_vars"
554
  */
555
  if ( grib_get_long(gh, "typeOfEnsembleForecast", &ens_forecast_type) == 0 )
556
557
558
559
560
    {
      GRIB_CHECK(grib_get_long(gh, "numberOfForecastsInEnsemble", &ens_count ), 0);
      GRIB_CHECK(grib_get_long(gh, "perturbationNumber", &ens_index ), 0);
    }

561
562
563
  if ( ens_index > 0 )
    varDefEnsembleInfo(varID, (int)ens_index, (int)ens_count, (int)ens_forecast_type);

564
  long typeOfGeneratingProcess = 0;
565
  if ( grib_get_long(gh, "typeOfGeneratingProcess", &typeOfGeneratingProcess) == 0 )
566
567
    varDefTypeOfGeneratingProcess(varID, (int) typeOfGeneratingProcess);

568
  long productDefinitionTemplate = 0;
569
  if ( grib_get_long(gh, "productDefinitionTemplateNumber", &productDefinitionTemplate) == 0 )
570
571
    varDefProductDefinitionTemplate(varID, (int) productDefinitionTemplate);

572
573
574
  long   lval;
  double dval;

575
  if (lread_additional_keys)
576
    for ( int i = 0; i < cdiNAdditionalGRIBKeys; i++ )
577
578
579
580
581
582
583
      {
        /* note: if the key is not defined, we do not throw an error! */
        if ( grib_get_long(gh, cdiAdditionalGRIBKeys[i], &lval) == 0 )
          varDefOptGribInt(varID, tile_index, lval, cdiAdditionalGRIBKeys[i]);
        if ( grib_get_double(gh, cdiAdditionalGRIBKeys[i], &dval) == 0 )
          varDefOptGribDbl(varID, tile_index, dval, cdiAdditionalGRIBKeys[i]);
      }
584

Uwe Schulzweida's avatar
Uwe Schulzweida committed
585
586
  if ( varInqInst(varID) == CDI_UNDEFID )
    {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
587
588
589
      long center, subcenter;
      GRIB_CHECK(grib_get_long(gh, "centre", &center), 0);
      GRIB_CHECK(grib_get_long(gh, "subCentre", &subcenter), 0);
590
      int instID = institutInq((int)center, (int)subcenter, NULL, NULL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
591
      if ( instID == CDI_UNDEFID )
Uwe Schulzweida's avatar
Uwe Schulzweida committed
592
	instID = institutDef((int)center, (int)subcenter, NULL, NULL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
593
594
595
596
597
      varDefInst(varID, instID);
    }

  if ( varInqModel(varID) == CDI_UNDEFID )
    {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
598
      long processID;
599
      if ( grib_get_long(gh, "generatingProcessIdentifier", &processID) == 0 )
600
	{
601
          /* FIXME: assert(processID >= INT_MIN && processID <= INT_MAX) */
602
	  int modelID = modelInq(varInqInst(varID), (int)processID, NULL);
603
	  if ( modelID == CDI_UNDEFID )
604
	    modelID = modelDef(varInqInst(varID), (int)processID, NULL);
605
606
	  varDefModel(varID, modelID);
	}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
607
608
609
610
    }

  if ( varInqTable(varID) == CDI_UNDEFID )
    {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
611
      int pdis, pcat, pnum;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
612
      cdiDecodeParam(param, &pnum, &pcat, &pdis);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
613

Uwe Schulzweida's avatar
Uwe Schulzweida committed
614
615
616
      if ( pdis == 255 )
	{
	  int tabnum = pcat;
617
	  int tableID = tableInq(varInqModel(varID), tabnum, NULL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
618
619
620
	  if ( tableID == CDI_UNDEFID )
	    tableID = tableDef(varInqModel(varID), tabnum, NULL);
	  varDefTable(varID, tableID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
621
622
623
624
625
626
627
	}
    }

  streamptr->tsteps[tsID].nallrecs++;
  streamptr->nrecs++;

  if ( CDI_Debug )
628
    Message("varID = %d  param = %d  zaxistype = %d  gridID = %d  levelID = %d",
Uwe Schulzweida's avatar
Uwe Schulzweida committed
629
	    varID, param, zaxistype, gridID, levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
630
}
631

632
static compvar2_t gribapiVarSet(int param, int level1, int level2, int leveltype,
633
                                int tsteptype, char *name, var_tile_t tiles_data)
634
635
{
  compvar2_t compVar;
636
637
638
  size_t maxlen = sizeof(compVar.name);
  size_t len = strlen(name);
  if ( len > maxlen ) len = maxlen;
639

640
641
642
643
644
  compVar.param     = param;
  compVar.level1    = level1;
  compVar.level2    = level2;
  compVar.ltype     = leveltype;
  compVar.tsteptype = tsteptype;
645
646
  memset(compVar.name, 0, maxlen);
  memcpy(compVar.name, name, len);
647
  compVar.tiles = tiles_data;
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
648

649
  return compVar;
650
651
652
}

static
653
int gribapiVarCompare(compvar2_t compVar, record_t record, int flag)
654
655
{
  compvar2_t compVar0;
656
657
658
659
660
  compVar0.param     = record.param;
  compVar0.level1    = record.ilevel;
  compVar0.level2    = record.ilevel2;
  compVar0.ltype     = record.ltype;
  compVar0.tsteptype = record.tsteptype;
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
661
  memcpy(compVar0.name, record.varname, sizeof(compVar.name));
662

663
664
665
666
667
668
  if ( flag == 0 )
    {
      if ( compVar0.tsteptype == TSTEP_INSTANT  && compVar.tsteptype == TSTEP_INSTANT3 ) compVar0.tsteptype = TSTEP_INSTANT3;
      if ( compVar0.tsteptype == TSTEP_INSTANT3 && compVar.tsteptype == TSTEP_INSTANT  ) compVar0.tsteptype = TSTEP_INSTANT;
    }

669
670
  compVar0.tiles = record.tiles;

Thomas Jahns's avatar
Thomas Jahns committed
671
  return memcmp(&compVar0, &compVar, sizeof(compvar2_t));
672
}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
673

674
675
676
static
void ensureBufferSize(size_t requiredSize, size_t *curSize, void **buffer)
{
677
678
679
  if ( *curSize < requiredSize )
    {
      *curSize = requiredSize;
680
      *buffer = Realloc(*buffer, *curSize);
681
682
683
    }
}

684
static
Uwe Schulzweida's avatar
Uwe Schulzweida committed
685
grib_handle *gribapiGetDiskRepresentation(size_t recsize, size_t *buffersize, void **gribbuffer, int *outDatatype, int *outCompressionType, size_t *outUnzipsize)
686
{
687
  bool lieee = false;
688

689
  grib_handle *gh = grib_handle_new_from_message(NULL, *gribbuffer, recsize);
690
691
692
693
694
695
696
697
  if(gribEditionNumber(gh) > 1)
    {
      size_t len = 256;
      char typeOfPacking[256];

      if ( grib_get_string(gh, "packingType", typeOfPacking, &len) == 0 )
        {
          // fprintf(stderr, "packingType %d %s\n", len, typeOfPacking);
698
699
          if      ( strncmp(typeOfPacking, "grid_jpeg", len) == 0 ) *outCompressionType = CDI_COMPRESS_JPEG;
          else if ( strncmp(typeOfPacking, "grid_ccsds", len) == 0 ) *outCompressionType = CDI_COMPRESS_SZIP;
700
          else if ( strncmp(typeOfPacking, "grid_ieee", len) == 0 ) lieee = true;
701
702
703
704
        }
    }
  else
    {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
705
      if( gribGetZip(recsize, *gribbuffer, outUnzipsize) > 0 )
706
        {
707
          *outCompressionType = CDI_COMPRESS_SZIP;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
708
          ensureBufferSize(*outUnzipsize + 100, buffersize, gribbuffer);
709
710
711
        }
      else
        {
712
          *outCompressionType = CDI_COMPRESS_NONE;
713
714
715
716
717
        }
    }

  if ( lieee )
    {
718
      *outDatatype = CDI_DATATYPE_FLT64;
719
720
      long precision;
      int status = grib_get_long(gh, "precision", &precision);
721
      if ( status == 0 && precision == 1 ) *outDatatype = CDI_DATATYPE_FLT32;
722
723
724
    }
  else
    {
725
      *outDatatype = CDI_DATATYPE_PACK;
726
727
728
729
730
731
732
733
734
735
736
      long bitsPerValue;
      if ( grib_get_long(gh, "bitsPerValue", &bitsPerValue) == 0 )
        {
          if ( bitsPerValue > 0 && bitsPerValue <= 32 ) *outDatatype = (int)bitsPerValue;
        }
    }
  return gh;
}

typedef enum { CHECKTIME_OK, CHECKTIME_SKIP, CHECKTIME_STOP, CHECKTIME_INCONSISTENT } checkTimeResult;
static checkTimeResult checkTime(stream_t* streamptr, compvar2_t compVar, const DateTime* verificationTime, const DateTime* expectedVTime) {
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
737
  // First determine whether the current record exists already.
738
739
740
741
742
743
744
  int recID = 0;
  for ( ; recID < streamptr->nrecs; recID++ )
    {
      if ( gribapiVarCompare(compVar, streamptr->tsteps[0].records[recID], 1) == 0 ) break;
    }
  int recordExists = recID < streamptr->nrecs;

Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
745
  // Then we need to know whether the verification time is consistent.
746
747
  int consistentTime = !memcmp(verificationTime, expectedVTime, sizeof(*verificationTime));

Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
748
  // Finally, we make a decision.
749
750
751
752
753
754
755
756
757
758
  if ( cdiInventoryMode == 1 )
    {
      if ( recordExists ) return CHECKTIME_STOP;
      if ( !consistentTime ) return CHECKTIME_INCONSISTENT;
    }
  else
    {
      if ( !consistentTime ) return CHECKTIME_STOP;
      if ( recordExists ) return CHECKTIME_SKIP;
    }
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
759

760
761
762
763
764
765
766
767
768
769
  return CHECKTIME_OK;
}

#define gribWarning(text, nrecs, timestep, varname, param, level1, level2) do \
  { \
    char paramstr[32]; \
    cdiParamToString(param, paramstr, sizeof(paramstr)); \
    Warning("Record %2d (name=%s id=%s lev1=%d lev2=%d) timestep %d: %s", nrecs, varname, paramstr, level1, level2, timestep, text); \
  } \
while(0)
770

771
int gribapiScanTimestep1(stream_t * streamptr)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
772
773
{
  off_t recpos = 0;
774
  void *gribbuffer = NULL;
775
  size_t buffersize = 0;
776
777
  DateTime datetime0 = { .date = 10101, .time = 0 };
  int nrecs_scanned = 0;        //Only used for debug output.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
778
  int warn_time = TRUE;
779
  // int warn_numavg = TRUE;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
780
781
782
783
784
  int rdate = 0, rtime = 0, tunit = 0, fcast = 0;
  grib_handle *gh = NULL;

  streamptr->curTsID = 0;

785
786
  int tsID  = tstepsNewEntry(streamptr);
  taxis_t *taxis = &streamptr->tsteps[tsID].taxis;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
787
788

  if ( tsID != 0 )
789
    Error("Internal problem! tstepsNewEntry returns %d", tsID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
790

791
  int fileID = streamptr->fileID;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
792

Thomas Jahns's avatar
Thomas Jahns committed
793
  unsigned nrecs = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
794
795
  while ( TRUE )
    {
796
      int level1 = 0, level2 = 0;
797
798
      size_t recsize = gribGetSize(fileID);
      recpos = fileGetPos(fileID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
799
800

      if ( recsize == 0 )
801
802
803
804
805
        {
          streamptr->ntsteps = 1;
          break;
        }
      ensureBufferSize(recsize, &buffersize, &gribbuffer);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
806

807
      size_t readsize = recsize;
808
      int rstatus = gribRead(fileID, gribbuffer, &readsize); //Search for next 'GRIB', read the following record, and position file offset after it.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
809
      if ( rstatus ) break;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
810

811
      int datatype, comptype = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
812
      size_t unzipsize;
813
      gh = gribapiGetDiskRepresentation(recsize, &buffersize, &gribbuffer, &datatype, &comptype, &unzipsize);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
814

815
      nrecs_scanned++;
816
      GRIB_CHECK(my_grib_set_double(gh, "missingValue", cdiDefaultMissval), 0);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
817

818
819
      int param = gribapiGetParam(gh);
      int leveltype1 = -1, leveltype2 = -1, lbounds, level_sf, level_unit;
820
      var_tile_t tiles = dummy_tiles;
821
      gribGetLevel(gh, &leveltype1, &leveltype2, &lbounds, &level1, &level2, &level_sf, &level_unit, &tiles);
822

823
      char varname[256];
824
825
      varname[0] = 0;
      gribapiGetString(gh, "shortName", varname, sizeof(varname));
826

827
      int tsteptype = gribapiGetTsteptype(gh);
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
828

829
      int vdate = 0, vtime = 0;
830
      gribapiGetValidityDateTime(gh, &vdate, &vtime);
831
      DateTime datetime = { .date = vdate, .time = vtime };
832
      /*
833
      printf("%d %d %d\n", vdate, vtime, leveltype1);
834
      */
835

Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
836
      if ( datetime0.date == 10101 && datetime0.time == 0 )
837
        {
838
          if( datetimeCmp(datetime, datetime0) || !nrecs )       //Do we really need this condition? I have included it in order not to change the number of times gribapiGetDataDateTime() etc. get called. But if those are sideeffect-free, this condition should be removed.
839
840
841
842
843
844
845
846
            {
              datetime0 = datetime;

              gribapiGetDataDateTime(gh, &rdate, &rtime);

              fcast = gribapiTimeIsFC(gh);
              if ( fcast ) tunit = gribapiGetTimeUnits(gh);
            }
847
        }
848

Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
849
      if ( nrecs )
850
        {
851
          checkTimeResult result = checkTime(streamptr, gribapiVarSet(param, level1, level2, leveltype1, tsteptype, varname, tiles), &datetime, &datetime0);
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
852
          if ( result == CHECKTIME_STOP )
853
            {
854
              break;
855
            }
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
856
          else if ( result == CHECKTIME_SKIP )
857
            {
858
859
              gribWarning("Parameter already exist, skipped!", nrecs_scanned, tsID+1, varname, param, level1, level2);
              continue;
860
            }
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
861
          else if ( result == CHECKTIME_INCONSISTENT && warn_time )
862
863
864
865
866
            {
              gribWarning("Inconsistent verification time!", nrecs_scanned, tsID+1, varname, param, level1, level2);
              warn_time = FALSE;
            }
          assert(result == CHECKTIME_OK || result == CHECKTIME_INCONSISTENT);
867
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
868
869
      /*
      if ( ISEC1_AvgNum )
870
871
872
873
874
875
876
877
878
879
880
881
        {
          if (  taxis->numavg && warn_numavg && (taxis->numavg != ISEC1_AvgNum) )
            {
              Message("Change numavg from %d to %d not allowed!",
                      taxis->numavg, ISEC1_AvgNum);
              warn_numavg = FALSE;
            }
          else
            {
              taxis->numavg = ISEC1_AvgNum;
            }
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
882
883
884
885
      */
      nrecs++;

      if ( CDI_Debug )
886
887
888
        {
          char paramstr[32];
          cdiParamToString(param, paramstr, sizeof(paramstr));
Thomas Jahns's avatar
Thomas Jahns committed
889
          Message("%4u %8d name=%s id=%s ltype=%d lev1=%d lev2=%d vdate=%d vtime=%d",
890
                nrecs, (int)recpos, varname, paramstr, leveltype1, level1, level2, vdate, vtime);
891
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
892

893
894
      var_tile_t *ptiles = NULL;
      if ( memcmp(&tiles, &dummy_tiles, sizeof(var_tile_t)) != 0 ) ptiles = &tiles;
895
      gribapiAddRecord(streamptr, param, gh, recsize, recpos, datatype, comptype, varname,
896