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

Thomas Jahns's avatar
Thomas Jahns committed
5
#ifdef 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"
15
#include "stream_gribapi.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
16
17
18
#include "varscan.h"
#include "datetime.h"
#include "vlist.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
19
#include "stream_grb.h"
20
#include "calendar.h"
21
#include "subtype.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
22
23


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

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

extern int cdiInventoryMode;

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
33
typedef struct {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
34
  int param;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
35
36
37
  int level1;
  int level2;
  int ltype;
38
  int tsteptype;
39
40
41
42
43
44
45
46
#ifdef HIRLAM_EXTENSIONS
    // NOTE: tsteptype MUST be part of attributes used to compare variables!
    // Modern NWP models (HARMONIE, HIRLAM) use timeRangeIndicator to specify
    // if the field is instantanous or accumulated.
    // Both types are typically in the same GRIB-file.
    // (181; 105, 0, timeRangeIndicator=0) .. instantanous rain
    // (181; 105, 0, timeRangeIndicator=4) .. accumulated rain  .. both can be in the same grib file
#endif // HIRLAM_EXTENSIONS
47
  char name[32];
48
49
50

  var_tile_t tiles;

51
} compvar2_t;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
52
53
54


static
55
int gribapiGetZaxisType(long editionNumber, int grib_ltype)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
56
{
Uwe Schulzweida's avatar
Uwe Schulzweida committed
57
58
59
  int zaxistype = ZAXIS_GENERIC;

  if ( editionNumber <= 1 )
Uwe Schulzweida's avatar
Uwe Schulzweida committed
60
    {
61
      zaxistype = grib1ltypeToZaxisType(grib_ltype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
62
63
64
    }
  else
    {
65
      zaxistype = grib2ltypeToZaxisType(grib_ltype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
66
67
    }

68
  return zaxistype;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
69
70
}

71
static
72
int getTimeunits(long unitsOfTime)
73
74
{
  int timeunits = -1;
75
76
77
78
79
80
81
82
83
84
85
86
87

  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;
    }

88
  return timeunits;
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
}

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;
        }
    }

110
  return factor;
111
112
113
114
115
116
}

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

119
  grib_get_long(gh, "indicatorOfUnitOfTimeRange", &unitsOfTime);
120

121
  GRIB_CHECK(my_grib_set_long(gh, "stepUnits", unitsOfTime), 0);
122

123
  timeunits = getTimeunits(unitsOfTime);
124

125
  return timeunits;
126
127
}

128
static
129
void gribapiGetSteps(grib_handle *gh, int timeunits, int *startStep, int *endStep)
130
{
131
  int timeunits2 = timeunits;
132
133
  long unitsOfTime;
  int status = grib_get_long(gh, "stepUnits", &unitsOfTime);
134
135
  if ( status == 0 ) timeunits2 = getTimeunits(unitsOfTime);
  //timeunits2 = gribapiGetTimeUnits(gh);
136

137
  long lpar;
138
139
140
141
142
143
144
145
  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);
    }
146

147
148
  *endStep = *startStep;
  status = grib_get_long(gh, "endStep", &lpar);
149
  if ( status == 0 )
150
151
    *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));
152
153
}

154
155
156
157
158
159
160
static
void gribapiGetDataDateTime(grib_handle *gh, int *datadate, int *datatime)
{
  long lpar;

  GRIB_CHECK(grib_get_long(gh, "dataDate", &lpar), 0);
  *datadate = (int) lpar;
161
  GRIB_CHECK(grib_get_long(gh, "dataTime", &lpar), 0);  //FIXME: This looses the seconds in GRIB2 files.
162
163
164
  *datatime = (int) lpar*100;
}

165
166
167
static
void gribapiSetDataDateTime(grib_handle *gh, int datadate, int datatime)
{
168
169
  GRIB_CHECK(my_grib_set_long(gh, "dataDate", datadate), 0);
  GRIB_CHECK(my_grib_set_long(gh, "dataTime", datatime/100), 0);
170
171
}

172
static
173
int gribapiGetValidityDateTime(grib_handle *gh, int *vdate, int *vtime)
174
{
175
  int rdate, rtime;
176
  int timeUnits, startStep = 0, endStep;
177
178
  int tstepRange = 0;
  int range;
179
180
  long sigofrtime = 3;

181
  if ( gribEditionNumber(gh) > 1 )
182
183
184
    {
      GRIB_CHECK(grib_get_long(gh, "significanceOfReferenceTime", &sigofrtime), 0);
    }
185
186
187
188
  else
    {
      GRIB_CHECK(grib_get_long(gh, "timeRangeIndicator", &sigofrtime), 0);
    }
189

190
  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())`.
191
    {
192
      gribapiGetDataDateTime(gh, vdate, vtime);
193
194
195
    }
  else
    {
196
197
      gribapiGetDataDateTime(gh, &rdate, &rtime);

198
      timeUnits = gribapiGetTimeUnits(gh);
199
      gribapiGetSteps(gh, timeUnits, &startStep, &endStep);
200
201
202
203
204
205
206
207
208

      range = endStep - startStep;

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

209
210
211
212
      {
	static int lprint = TRUE;
	extern int grib_calendar;
	int ryear, rmonth, rday, rhour, rminute, rsecond;
213
214
215
	int julday, secofday;
	int64_t time_period = endStep;
        int64_t addsec;
216
217
218
219

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

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
        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);
          }
247

248
249
250
	*vdate = cdiEncodeDate(ryear, rmonth, rday);
	*vtime = cdiEncodeTime(rhour, rminute, rsecond);
      }
251
    }
252

253
  return tstepRange;
254
255
}

256
static
257
void grib1GetLevel(grib_handle *gh, int *leveltype, int *lbounds, int *level1, int *level2)
258
{
259
  *leveltype = 0;
260
261
262
  *lbounds   = 0;
  *level1    = 0;
  *level2    = 0;
263

264
  long lpar;
265
  if ( !grib_get_long(gh, "indicatorOfTypeOfLevel", &lpar) )       //1 byte
266
    {
267
      *leveltype = (int) lpar;
268

269
      switch (*leveltype)
270
271
272
273
	{
	case GRIB1_LTYPE_SIGMA_LAYER:
	case GRIB1_LTYPE_HYBRID_LAYER:
	case GRIB1_LTYPE_LANDDEPTH_LAYER:
274
	  { *lbounds = 1; break; }
275
	}
276

277
278
279
280
281
282
283
284
      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
285
	{
286
          double dlevel;
287
	  GRIB_CHECK(grib_get_double(gh, "level", &dlevel), 0); //2 byte
288
	  if ( *leveltype == GRIB1_LTYPE_ISOBARIC ) dlevel *= 100;
289
	  if ( dlevel < -2.e9 || dlevel > 2.e9 ) dlevel = 0;
290
	  if ( *leveltype == GRIB1_LTYPE_99 || *leveltype == GRIB1_LTYPE_ISOBARIC_PA ) *leveltype = GRIB1_LTYPE_ISOBARIC;
291

292
293
294
	  *level1 = (int) dlevel;
	  *level2 = 0;
	}
295
    }
296
297
}

298
299
300
static
double grib2ScaleFactor(long factor)
{
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
  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
322
  if(level != GRIB_MISSING_LONG) result = (double)level*grib2ScaleFactor(factor);
323
324
  if(level_sf) result *= level_sf;
  return (int)result;
325
326
}

327
static
328
void grib2GetLevel(grib_handle *gh, int *leveltype1, int *leveltype2, int *lbounds, int *level1,
329
                   int *level2, int *level_sf, int *level_unit)
330
{
331
332
333
  int status;
  long lpar;
  long factor;
334

335
336
  *leveltype1 = 0;
  *leveltype2 = -1;
337
338
339
340
341
  *lbounds    = 0;
  *level1     = 0;
  *level2     = 0;
  *level_sf   = 0;
  *level_unit = 0;
342

343
  status = grib_get_long(gh, "typeOfFirstFixedSurface", &lpar); //1 byte
344
  if ( status == 0 )
345
    {
346
      long llevel;
347

348
      *leveltype1 = (int) lpar;
349

350
      status = grib_get_long(gh, "typeOfSecondFixedSurface", &lpar); //1 byte
351
      /* FIXME: assert(lpar >= INT_MIN && lpar <= INT_MAX) */
352
      if ( status == 0 ) *leveltype2 = (int)lpar;
353

354
      if ( *leveltype1 != 255 && *leveltype2 != 255 && *leveltype2 > 0 ) *lbounds = 1;
355
      switch(*leveltype1)
356
        {
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
          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;
375
        }
376

377
378
379
      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);
380

381
382
383
384
385
      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);
386
        }
387
388
    }
}
389

390
static
391
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)
392
393
394
395
396
397
398
399
400
401
402
{
  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);
403
404

      /* read in tiles attributes (if there are any) */
Thomas Jahns's avatar
Thomas Jahns committed
405
406
407
408
409
410
      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);
411
    }
412
413
}

414
415
416
417
418
static
void gribapiGetString(grib_handle *gh, const char *key, char *string, size_t length)
{
  string[0] = 0;

419
420
421
422
423
424
  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);
    }
425
426
427
428
  if      ( length == 8 && memcmp(string, "unknown", length) == 0 ) string[0] = 0;
  else if ( length == 2 && memcmp(string, "~", length)       == 0 ) string[0] = 0;
}

429
static
430
void gribapiAddRecord(stream_t * streamptr, int param, grib_handle *gh,
431
                      size_t recsize, off_t position, int datatype, int comptype, const char *varname,
432
                      int leveltype1, int leveltype2, int lbounds, int level1, int level2, int level_sf, int level_unit,
433
                      const var_tile_t *tiles, int lread_additional_keys)
434
435
{
  int levelID = 0;
436
  char stdname[CDI_MAX_NAME], longname[CDI_MAX_NAME], units[CDI_MAX_NAME];
437
  long ens_index = 0, ens_count = 0, ens_forecast_type = 0;
438

439
440
441
  int vlistID = streamptr->vlistID;
  int tsID    = streamptr->curTsID;
  int recID   = recordNewEntry(streamptr, tsID);
442
  record_t *record = &streamptr->tsteps[tsID].records[recID];
443

444
  int tsteptype = gribapiGetTsteptype(gh);
445
  // numavg  = ISEC1_AvgNum;
446
  int numavg = 0;
447

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

Thomas Jahns's avatar
Thomas Jahns committed
450
451
452
453
454
455
  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
456
  record->tsteptype = (short)tsteptype;
Thomas Jahns's avatar
Thomas Jahns committed
457
  record->tiles = tiles ? *tiles : dummy_tiles;
458
459
460
461
462
463
464
465
466
467
468
469

  //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));
470

471
  grid_t *grid = (grid_t *)Malloc(sizeof(*grid));
472
  gribapiGetGrid(gh, grid);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
473

Uwe Schulzweida's avatar
Uwe Schulzweida committed
474
  struct addIfNewRes gridAdded = cdiVlistAddGridIfNew(vlistID, grid, 0);
475
  int gridID = gridAdded.Id;
476
477
478
479
480
481
482
  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);
483
      xpole -= 180;
484
485
486
      if ( fabs(ypole) > 0 ) ypole = -ypole; // change from south to north pole
      if ( fabs(angle) > 0 ) angle = -angle;

487
      gridDefParamRLL(gridID, xpole, ypole, angle);
488
    }
489
490
491
492
493
494
  else if ( grid->projtype == CDI_PROJ_LCC )
    {
      double a = 6367470., rf = 0;
      long earthIsOblate;
      grib_get_long(gh, "earthIsOblate", &earthIsOblate);
      if ( earthIsOblate ) { a = 6378160.; rf = 297.0; }
495
      double lon_0, lat_1, lat_2, xval_0, yval_0;
496
497
498
499
500
501
      long projflag = 0;
      grib_get_double(gh, "longitudeOfFirstGridPointInDegrees", &xval_0);
      grib_get_double(gh, "latitudeOfFirstGridPointInDegrees", &yval_0);
      grib_get_double(gh, "LoVInDegrees", &lon_0);
      grib_get_double(gh, "Latin1InDegrees", &lat_1);
      grib_get_double(gh, "Latin2InDegrees", &lat_2);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
502
      grib_get_long(gh, "projectionCentreFlag", &projflag);
Thomas Jahns's avatar
Thomas Jahns committed
503
      bool lsouth = gribbyte_get_bit((int)projflag, 1);
504
505
      if ( lsouth ) { lat_1 = -lat_1; lat_2 = -lat_2; }

506
507
508
509
510
511
512
      double lat_0 = lat_2;
      double x_0 = grid_missval;
      double y_0 = grid_missval;

      if ( proj_lonlat_to_lcc_func )
        {
          x_0 = xval_0; y_0 = yval_0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
513
          proj_lonlat_to_lcc_func(grid_missval, lon_0, lat_0, lat_1, lat_2, a, rf, (size_t)1, &x_0, &y_0);
514
515
516
          if ( IS_NOT_EQUAL(x_0, grid_missval) && IS_NOT_EQUAL(y_0, grid_missval) )
            { x_0 = -x_0; y_0 = -y_0; }
        }
517
      gridDefParamLCC(gridID, grid_missval, lon_0, lat_0, lat_1, lat_2, a, rf, xval_0, yval_0, x_0, y_0);
518
    }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
519

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

522
  switch (zaxistype)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
523
    {
524
525
526
    case ZAXIS_HYBRID:
    case ZAXIS_HYBRID_HALF:
      {
527
        long lpar;
528
        GRIB_CHECK(grib_get_long(gh, "NV", &lpar), 0);
Thomas Jahns's avatar
Thomas Jahns committed
529
        /* FIXME: assert(lpar >= 0) */
Thomas Jahns's avatar
Thomas Jahns committed
530
        size_t vctsize = (size_t)lpar;
531
532
        if ( vctsize > 0 )
          {
Thomas Jahns's avatar
Thomas Jahns committed
533
534
            double *vctptr = (double *) Malloc(vctsize*sizeof(double));
            size_t dummy = vctsize;
535
            GRIB_CHECK(grib_get_double_array(gh, "pv", vctptr, &dummy), 0);
Thomas Jahns's avatar
Thomas Jahns committed
536
            varDefVCT(vctsize, vctptr);
537
            Free(vctptr);
538
539
540
541
542
          }
        break;
      }
    case ZAXIS_REFERENCE:
      {
543
        unsigned char uuid[CDI_UUID_SIZE];
544
        long lpar;
545
        GRIB_CHECK(grib_get_long(gh, "NV", &lpar), 0);
546
        if ( lpar != 6 ) fprintf(stderr, "Warning ...\n");
547
548
549
550
        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;
551
        size_t len = (size_t)CDI_UUID_SIZE;
552
553
        memset(uuid, 0, CDI_UUID_SIZE);
        GRIB_CHECK(grib_get_bytes(gh, "uuidOfVGrid", uuid, &len), 0);
554
        varDefZAxisReference(nhlev, nvgrid, uuid);
555
556
        break;
      }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
557
    }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
558

559
560
  // if ( datatype > 32 ) datatype = CDI_DATATYPE_PACK32;
  if ( datatype <  0 ) datatype = CDI_DATATYPE_PACK;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
561

562
  stdname[0] = 0;
563
564
565
  longname[0] = 0;
  units[0] = 0;

566
  if ( varname[0] != 0 )
Uwe Schulzweida's avatar
Uwe Schulzweida committed
567
    {
568
      size_t vlen = CDI_MAX_NAME;
569
      gribapiGetString(gh, "name", longname, vlen);
570
      vlen = CDI_MAX_NAME;
571
      gribapiGetString(gh, "units", units, vlen);
Thomas Jahns's avatar
Thomas Jahns committed
572
573
574
575
      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
576
    }
577
  // fprintf(stderr, "param %d name %s %s %s\n", param, name, longname, units);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
578

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

Thomas Jahns's avatar
Thomas Jahns committed
585
586
  record->varID   = (short)varID;
  record->levelID = (short)levelID;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
587

588
  varDefCompType(varID, comptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
589

590
591
  /*
    Get the ensemble Info from the grib-2 Tables and update the intermediate datastructure.
592
    Further update to the "vlist" is handled in the same way as for GRIB-1 by "cdi_generate_vars"
593
  */
594
  if ( grib_get_long(gh, "typeOfEnsembleForecast", &ens_forecast_type) == 0 )
595
596
597
598
599
    {
      GRIB_CHECK(grib_get_long(gh, "numberOfForecastsInEnsemble", &ens_count ), 0);
      GRIB_CHECK(grib_get_long(gh, "perturbationNumber", &ens_index ), 0);
    }

600
601
602
  if ( ens_index > 0 )
    varDefEnsembleInfo(varID, (int)ens_index, (int)ens_count, (int)ens_forecast_type);

603
  long typeOfGeneratingProcess = 0;
604
  if ( grib_get_long(gh, "typeOfGeneratingProcess", &typeOfGeneratingProcess) == 0 )
605
606
    varDefTypeOfGeneratingProcess(varID, (int) typeOfGeneratingProcess);

607
  long productDefinitionTemplate = 0;
608
  if ( grib_get_long(gh, "productDefinitionTemplateNumber", &productDefinitionTemplate) == 0 )
609
610
    varDefProductDefinitionTemplate(varID, (int) productDefinitionTemplate);

611
612
613
  long   lval;
  double dval;

614
  if (lread_additional_keys)
615
    for ( int i = 0; i < cdiNAdditionalGRIBKeys; i++ )
616
617
618
619
620
621
622
      {
        /* 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]);
      }
623

Uwe Schulzweida's avatar
Uwe Schulzweida committed
624
625
  if ( varInqInst(varID) == CDI_UNDEFID )
    {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
626
627
628
      long center, subcenter;
      GRIB_CHECK(grib_get_long(gh, "centre", &center), 0);
      GRIB_CHECK(grib_get_long(gh, "subCentre", &subcenter), 0);
629
      int instID = institutInq((int)center, (int)subcenter, NULL, NULL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
630
      if ( instID == CDI_UNDEFID )
Uwe Schulzweida's avatar
Uwe Schulzweida committed
631
	instID = institutDef((int)center, (int)subcenter, NULL, NULL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
632
633
634
635
636
      varDefInst(varID, instID);
    }

  if ( varInqModel(varID) == CDI_UNDEFID )
    {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
637
      long processID;
638
      if ( grib_get_long(gh, "generatingProcessIdentifier", &processID) == 0 )
639
	{
640
          /* FIXME: assert(processID >= INT_MIN && processID <= INT_MAX) */
641
	  int modelID = modelInq(varInqInst(varID), (int)processID, NULL);
642
	  if ( modelID == CDI_UNDEFID )
643
	    modelID = modelDef(varInqInst(varID), (int)processID, NULL);
644
645
	  varDefModel(varID, modelID);
	}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
646
647
648
649
    }

  if ( varInqTable(varID) == CDI_UNDEFID )
    {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
650
      int pdis, pcat, pnum;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
651
      cdiDecodeParam(param, &pnum, &pcat, &pdis);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
652

Uwe Schulzweida's avatar
Uwe Schulzweida committed
653
654
655
      if ( pdis == 255 )
	{
	  int tabnum = pcat;
656
	  int tableID = tableInq(varInqModel(varID), tabnum, NULL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
657
658
659
	  if ( tableID == CDI_UNDEFID )
	    tableID = tableDef(varInqModel(varID), tabnum, NULL);
	  varDefTable(varID, tableID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
660
661
662
663
664
665
666
	}
    }

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

  if ( CDI_Debug )
667
    Message("varID = %d  param = %d  zaxistype = %d  gridID = %d  levelID = %d",
Uwe Schulzweida's avatar
Uwe Schulzweida committed
668
	    varID, param, zaxistype, gridID, levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
669
}
670

671
static compvar2_t gribapiVarSet(int param, int level1, int level2, int leveltype,
672
                                int tsteptype, char *name, var_tile_t tiles_data)
673
674
{
  compvar2_t compVar;
675
676
677
  size_t maxlen = sizeof(compVar.name);
  size_t len = strlen(name);
  if ( len > maxlen ) len = maxlen;
678

679
680
681
682
683
  compVar.param     = param;
  compVar.level1    = level1;
  compVar.level2    = level2;
  compVar.ltype     = leveltype;
  compVar.tsteptype = tsteptype;
684
685
  memset(compVar.name, 0, maxlen);
  memcpy(compVar.name, name, len);
686
  compVar.tiles = tiles_data;
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
687

688
  return compVar;
689
690
691
}

static
692
int gribapiVarCompare(compvar2_t compVar, record_t record, int flag)
693
694
{
  compvar2_t compVar0;
695
696
697
698
699
  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
700
  memcpy(compVar0.name, record.varname, sizeof(compVar.name));
701

702
703
704
705
706
707
  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;
    }

708
709
  compVar0.tiles = record.tiles;

Thomas Jahns's avatar
Thomas Jahns committed
710
  return memcmp(&compVar0, &compVar, sizeof(compvar2_t));
711
}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
712

713
714
715
static
void ensureBufferSize(size_t requiredSize, size_t *curSize, void **buffer)
{
716
717
718
  if ( *curSize < requiredSize )
    {
      *curSize = requiredSize;
719
      *buffer = Realloc(*buffer, *curSize);
720
721
722
    }
}

723
static
Uwe Schulzweida's avatar
Uwe Schulzweida committed
724
grib_handle *gribapiGetDiskRepresentation(size_t recsize, size_t *buffersize, void **gribbuffer, int *outDatatype, int *outCompressionType, size_t *outUnzipsize)
725
{
726
727
728
729
730
731
732
733
734
735
736
737
738
739
  int gribversion = (int)((char*)*gribbuffer)[7];

  if ( gribversion <= 1 )
    {
      if ( gribGetZip(recsize, *gribbuffer, outUnzipsize) > 0 )
        {
          *outCompressionType = CDI_COMPRESS_SZIP;
          ensureBufferSize(*outUnzipsize + 100, buffersize, gribbuffer);
        }
      else
        {
          *outCompressionType = CDI_COMPRESS_NONE;
        }
    }
740

741
  grib_handle *gh = grib_handle_new_from_message(NULL, *gribbuffer, recsize);
742
743
744
745

  bool lieee = false;

  if ( gribversion > 1 )
746
747
748
749
750
751
752
    {
      size_t len = 256;
      char typeOfPacking[256];

      if ( grib_get_string(gh, "packingType", typeOfPacking, &len) == 0 )
        {
          // fprintf(stderr, "packingType %d %s\n", len, typeOfPacking);
753
754
          if      ( strncmp(typeOfPacking, "grid_jpeg", len) == 0 ) *outCompressionType = CDI_COMPRESS_JPEG;
          else if ( strncmp(typeOfPacking, "grid_ccsds", len) == 0 ) *outCompressionType = CDI_COMPRESS_SZIP;
755
          else if ( strncmp(typeOfPacking, "grid_ieee", len) == 0 ) lieee = true;
756
757
758
759
760
        }
    }

  if ( lieee )
    {
761
      *outDatatype = CDI_DATATYPE_FLT64;
762
763
      long precision;
      int status = grib_get_long(gh, "precision", &precision);
764
      if ( status == 0 && precision == 1 ) *outDatatype = CDI_DATATYPE_FLT32;
765
766
767
    }
  else
    {
768
      *outDatatype = CDI_DATATYPE_PACK;
769
770
771
772
773
774
      long bitsPerValue;
      if ( grib_get_long(gh, "bitsPerValue", &bitsPerValue) == 0 )
        {
          if ( bitsPerValue > 0 && bitsPerValue <= 32 ) *outDatatype = (int)bitsPerValue;
        }
    }
775

776
777
778
779
780
  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
781
  // First determine whether the current record exists already.
782
783
784
785
786
787
788
  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
789
  // Then we need to know whether the verification time is consistent.
790
791
  int consistentTime = !memcmp(verificationTime, expectedVTime, sizeof(*verificationTime));

Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
792
  // Finally, we make a decision.
793
794
795
796
797
798
799
800
801
802
  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
803

804
805
806
807
808
809
810
811
812
813
  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)
814

815
int gribapiScanTimestep1(stream_t * streamptr)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
816
817
{
  off_t recpos = 0;
818
  void *gribbuffer = NULL;
819
  size_t buffersize = 0;
820
821
  DateTime datetime0 = { .date = 10101, .time = 0 };
  int nrecs_scanned = 0;        //Only used for debug output.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
822
  int warn_time = TRUE;
823
  // int warn_numavg = TRUE;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
824
825
826
827
828
  int rdate = 0, rtime = 0, tunit = 0, fcast = 0;
  grib_handle *gh = NULL;

  streamptr->curTsID = 0;

829
830
  int tsID  = tstepsNewEntry(streamptr);
  taxis_t *taxis = &streamptr->tsteps[tsID].taxis;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
831
832

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

835
  int fileID = streamptr->fileID;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
836

Thomas Jahns's avatar
Thomas Jahns committed
837
  unsigned nrecs = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
838
839
  while ( TRUE )
    {
840
      int level1 = 0, level2 = 0;
841
842
      size_t recsize = gribGetSize(fileID);
      recpos = fileGetPos(fileID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
843
844

      if ( recsize == 0 )
845
846
847
848
849
        {
          streamptr->ntsteps = 1;
          break;
        }
      ensureBufferSize(recsize, &buffersize, &gribbuffer);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
850

851
      size_t readsize = recsize;
852
      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
853
      if ( rstatus ) break;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
854

855
      int datatype, comptype = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
856
      size_t unzipsize;
857
      gh = gribapiGetDiskRepresentation(recsize, &buffersize, &gribbuffer, &datatype, &comptype, &unzipsize);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
858

859
      nrecs_scanned++;
860
      GRIB_CHECK(my_grib_set_double(gh, "missingValue", cdiDefaultMissval), 0);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
861

862
863
      int param = gribapiGetParam(gh);
      int leveltype1 = -1, leveltype2 = -1, lbounds, level_sf, level_unit;
864
      var_tile_t tiles = dummy_tiles;
865
      gribGetLevel(gh, &leveltype1, &leveltype2, &lbounds, &level1, &level2, &level_sf, &level_unit, &tiles);
866

867
      char varname[256];
868
869
      varname[0] = 0;
      gribapiGetString(gh, "shortName", varname, sizeof(varname));
870

871
      int tsteptype = gribapiGetTsteptype(gh);
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
872

873
      int vdate = 0, vtime = 0;
874
      gribapiGetValidityDateTime(gh, &vdate, &vtime);
875
      DateTime datetime = { .date = vdate, .time = vtime };
876
      /*
877
      printf("%d %d %d\n", vdate, vtime, leveltype1);
878
      */
879

Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
880
      if ( datetime0.date == 10101 && datetime0.time == 0 )
881
        {
882
          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.
883
884
885
886
887
888
889
890
            {
              datetime0 = datetime;

              gribapiGetDataDateTime(gh, &rdate, &rtime);

              fcast = gribapiTimeIsFC(gh);
              if ( fcast ) tunit = gribapiGetTimeUnits(gh);
            }
891
        }
892

Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
893
      if ( nrecs )
894
        {
895
          checkTimeResult result = checkTime(streamptr, gribapiVarSet(param, level1, level2, leveltype1, tsteptype, varname, tiles), &datetime, &datetime0);
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
896
          if ( result == CHECKTIME_STOP )
897
            {
898
              break;
899
            }
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
900
          else if ( result == CHECKTIME_SKIP )
901
            {
902
903
              gribWarning("Parameter already exist, skipped!", nrecs_scanned, tsID+1, varname, param, level1, level2);
              continue;