Time/fg_time.c

   1 /**************************************************************************
   2  * fg_time.c -- data structures and routines for managing time related stuff.
   3  *
   4  * Written by Curtis Olson, started August 1997.
   5  *
   6  * Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * $Id$
  23  * (Log is kept at end of this file)
  24  **************************************************************************/
  25
  26
  27 #include <config.h>
  28
  29 #include <math.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <time.h>
  33
  34 #ifdef HAVE_SYS_TIMEB_H
  35 #  include <sys/timeb.h> /* for ftime() and struct timeb */
  36 #endif
  37 #ifdef HAVE_UNISTD_H
  38 #  include <unistd.h>  /* for gettimeofday() */
  39 #endif
  40 #ifdef HAVE_SYS_TIME_H
  41 #  include <sys/time.h>  /* for get/setitimer, gettimeofday, struct timeval */
  42 #endif
  43
  44 #include <Time/fg_time.h>
  45 #include <Include/fg_constants.h>
  46 #include <Flight/flight.h>
  47
  48
  49 #define DEGHR(x)        ((x)/15.)
  50 #define RADHR(x)        DEGHR(x*RAD_TO_DEG)
  51
  52 #include <Main/fg_debug.h>
  53
  54 struct fgTIME cur_time_params;
  55 struct fgLIGHT cur_light_params;
  56
  57
  58 /* Initialize the time dependent variables */
  59
  60 void fgTimeInit(struct fgTIME *t) {
  61     fgPrintf( FG_EVENT, FG_INFO, "Initializing Time\n");
  62
  63     t->gst_diff = -9999.0;
  64     t->warp = (0) * 3600;
  65     t->warp_delta = 0;
  66 }
  67
  68
  69 /* Portability wrap to get current time. */
  70 void timestamp(fg_timestamp *timestamp) {
  71 #if defined( HAVE_GETTIMEOFDAY )
  72     struct timeval current;
  73     struct timezone tz;
  74     fg_timestamp currtime;
  75     gettimeofday(&current, &tz);
  76     timestamp->seconds = current.tv_sec;
  77     timestamp->millis = current.tv_usec / 1000;
  78 #elif defined( HAVE_GETLOCALTIME )
  79     SYSTEMTIME current;
  80     GetLocalTime(&current);
  81     timestamp->seconds = current.wSecond;
  82     timestamp->millis = current.wMilliseconds;
  83 #elif defined( HAVE_FTIME )
  84     struct timeb current;
  85     ftime(&current);
  86     timestamp->seconds = current.time;
  87     timestamp->millis = current.millitm;
  88 #else
  89 # error Port me
  90 #endif
  91 }
  92
  93
  94 /* Return duration in millis from first to last */
  95 long timediff(fg_timestamp *first, fg_timestamp *last) {
  96     return 1000 * (last->seconds - first->seconds) +
  97         (last->millis - first->millis);
  98 }
  99
 100
 101 /* Return new timestamp given a time stamp and an interval to add in */
 102 void timesum(fg_timestamp *res, fg_timestamp *start, long millis) {
 103     res->millis = start->millis + millis;
 104     if (1000 < res->millis) {
 105         res->seconds = start->millis + 1;
 106         res->millis -= 1000;
 107     } else {
 108         res->seconds = start->millis;
 109     }
 110 }
 111
 112
 113 /* given a date in months, mn, days, dy, years, yr, return the
 114  * modified Julian date (number of days elapsed since 1900 jan 0.5),
 115  * mjd.  Adapted from Xephem.  */
 116
 117 double cal_mjd (int mn, double dy, int yr) {
 118     static double last_mjd, last_dy;
 119     double mjd;
 120     static int last_mn, last_yr;
 121     int b, d, m, y;
 122     long c;
 123
 124     if (mn == last_mn && yr == last_yr && dy == last_dy) {
 125         mjd = last_mjd;
 126         return(mjd);
 127     }
 128
 129     m = mn;
 130     y = (yr < 0) ? yr + 1 : yr;
 131     if (mn < 3) {
 132         m += 12;
 133         y -= 1;
 134     }
 135
 136     if (yr < 1582 || (yr == 1582 && (mn < 10 || (mn == 10 && dy < 15)))) {
 137         b = 0;
 138     } else {
 139         int a;
 140         a = y/100;
 141         b = 2 - a + a/4;
 142     }
 143
 144     if (y < 0) {
 145         c = (long)((365.25*y) - 0.75) - 694025L;
 146     } else {
 147         c = (long)(365.25*y) - 694025L;
 148     }
 149
 150     d = (int)(30.6001*(m+1));
 151
 152     mjd = b + c + d + dy - 0.5;
 153
 154     last_mn = mn;
 155     last_dy = dy;
 156     last_yr = yr;
 157     last_mjd = mjd;
 158
 159     return(mjd);
 160 }
 161
 162
 163 /* given an mjd, return greenwich mean siderial time, gst */
 164
 165 double utc_gst (double mjd) {
 166     double gst;
 167     double day = floor(mjd-0.5)+0.5;
 168     double hr = (mjd-day)*24.0;
 169     double T, x;
 170
 171     T = ((int)(mjd - 0.5) + 0.5 - J2000)/36525.0;
 172     x = 24110.54841 + (8640184.812866 + (0.093104 - 6.2e-6 * T) * T) * T;
 173     x /= 3600.0;
 174     gst = (1.0/SIDRATE)*hr + x;
 175
 176    fgPrintf( FG_EVENT, FG_DEBUG, "  gst => %.4f\n", gst);
 177
 178     return(gst);
 179 }
 180
 181
 182 /* given Julian Date and Longitude (decimal degrees West) compute and
 183  * return Local Sidereal Time, in decimal hours.
 184  *
 185  * Provided courtesy of ecdowney@noao.edu (Elwood Downey)
 186  */
 187
 188 double sidereal_precise (double mjd, double lng) {
 189     double gst;
 190     double lst;
 191
 192     /* printf ("Current Lst on JD %13.5f at %8.4f degrees West: ",
 193        mjd + MJD0, lng); */
 194
 195     /* convert to required internal units */
 196     lng *= DEG_TO_RAD;
 197
 198     /* compute LST and print */
 199     gst = utc_gst (mjd);
 200     lst = gst - RADHR (lng);
 201     lst -= 24.0*floor(lst/24.0);
 202     /* printf ("%7.4f\n", lst); */
 203
 204     /* that's all */
 205     return (lst);
 206 }
 207
 208
 209 /* return a courser but cheaper estimate of sidereal time */
 210 double sidereal_course(struct tm *gmt, time_t now, double lng) {
 211     time_t start, start_gmt;
 212     struct tm mt;
 213     long int offset;
 214     double diff, part, days, hours, lst;
 215
 216     // ftime() needs a little extra help finding the current timezone
 217 #if defined( HAVE_GETTIMEOFDAY )
 218 #elif defined( HAVE_GETLOCALTIME )
 219 #elif defined( HAVE_FTIME )
 220     struct timeb current;
 221 #else
 222 # error Port me
 223 #endif
 224
 225 #ifdef __CYGWIN32__
 226     int daylight;
 227     long int timezone;
 228 #endif /* WIN32 */
 229
 230     /*
 231     printf("  COURSE: GMT = %d/%d/%2d %d:%02d:%02d\n",
 232            gmt->tm_mon, gmt->tm_mday, gmt->tm_year,
 233            gmt->tm_hour, gmt->tm_min, gmt->tm_sec);
 234     */
 235
 236     mt.tm_mon = 2;
 237     mt.tm_mday = 21;
 238     mt.tm_year = gmt->tm_year;
 239     mt.tm_hour = 12;
 240     mt.tm_min = 0;
 241     mt.tm_sec = 0;
 242     mt.tm_isdst = -1; /* let the system determine the proper time zone */
 243
 244     start = mktime(&mt);
 245
 246     /* printf("start1 = %ld\n", start);
 247        fgPrintf( FG_EVENT, FG_DEBUG, "start2 = %s", ctime(&start));
 248        fgPrintf( FG_EVENT, FG_DEBUG, "start3 = %ld\n", start); */
 249
 250 #ifndef __CYGWIN32__
 251     daylight = mt.tm_isdst;
 252 #else
 253     /* Yargs ... I'm just hardcoding this arbitrarily so it doesn't
 254      * jump around */
 255     daylight = 0;
 256     fgPrintf( FG_EVENT, FG_WARN,
 257               "no daylight savings info ... being hardcoded to %d\n", daylight);
 258 #endif
 259
 260     // ftime() needs a little extra help finding the current timezone
 261 #if defined( HAVE_GETTIMEOFDAY )
 262 #elif defined( HAVE_GETLOCALTIME )
 263 #elif defined( HAVE_FTIME )
 264     ftime(&current);
 265     timezone = current.timezone * 60;
 266 #else
 267 # error Port me
 268 #endif
 269
 270     if ( daylight > 0 ) {
 271         daylight = 1;
 272     } else if ( daylight < 0 ) {
 273         fgPrintf( FG_EVENT, FG_WARN,
 274            "OOOPS, big time problem in fg_time.c, no daylight savings info.\n");
 275     }
 276
 277     offset = -(timezone / 3600 - daylight);
 278
 279     /* printf("  Raw time zone offset = %ld\n", timezone); */
 280     /* printf("  Daylight Savings = %d\n", daylight); */
 281
 282     /* printf("  Local hours from GMT = %ld\n", offset); */
 283
 284     start_gmt = start - timezone + (daylight * 3600);
 285
 286     /* printf("  March 21 noon (CST) = %ld\n", start); */
 287     /* printf("  March 21 noon (GMT) = %ld\n", start_gmt); */
 288
 289     diff = (now - start_gmt) / (3600.0 * 24.0);
 290
 291     /* printf("  Time since 3/21/%2d GMT = %.2f\n", gmt->tm_year, diff); */
 292
 293     part = fmod(diff, 1.0);
 294     days = diff - part;
 295     hours = gmt->tm_hour + gmt->tm_min/60.0 + gmt->tm_sec/3600.0;
 296
 297     lst = (days - lng)/15.0 + hours - 12;
 298
 299     while ( lst < 0.0 ) {
 300         lst += 24.0;
 301     }
 302
 303     /* printf("  days = %.1f  hours = %.2f  lon = %.2f  lst = %.2f\n",
 304            days, hours, lng, lst); */
 305
 306     return(lst);
 307 }
 308
 309
 310 /* Update the time dependent variables */
 311
 312 void fgTimeUpdate(fgFLIGHT *f, struct fgTIME *t) {
 313     double gst_precise, gst_course;
 314
 315     fgPrintf( FG_EVENT, FG_BULK, "Updating time\n");
 316
 317     /* get current Unix calendar time (in seconds) */
 318     t->warp += t->warp_delta;
 319     t->cur_time = time(NULL) + t->warp;
 320     fgPrintf( FG_EVENT, FG_BULK,
 321               "  Current Unix calendar time = %ld  warp = %ld  delta = %ld\n",
 322               t->cur_time, t->warp, t->warp_delta);
 323
 324     /* get GMT break down for current time */
 325     t->gmt = gmtime(&t->cur_time);
 326     fgPrintf( FG_EVENT, FG_BULK,
 327               "  Current GMT = %d/%d/%2d %d:%02d:%02d\n",
 328               t->gmt->tm_mon+1, t->gmt->tm_mday, t->gmt->tm_year,
 329               t->gmt->tm_hour, t->gmt->tm_min, t->gmt->tm_sec);
 330
 331     /* calculate modified Julian date */
 332     t->mjd = cal_mjd ((int)(t->gmt->tm_mon+1), (double)t->gmt->tm_mday,
 333              (int)(t->gmt->tm_year + 1900));
 334
 335     /* add in partial day */
 336     t->mjd += (t->gmt->tm_hour / 24.0) + (t->gmt->tm_min / (24.0 * 60.0)) +
 337            (t->gmt->tm_sec / (24.0 * 60.0 * 60.0));
 338
 339     /* convert "back" to Julian date + partial day (as a fraction of one) */
 340     t->jd = t->mjd + MJD0;
 341     fgPrintf( FG_EVENT, FG_BULK, "  Current Julian Date = %.5f\n", t->jd);
 342
 343     /* printf("  Current Longitude = %.3f\n", FG_Longitude * RAD_TO_DEG); */
 344
 345     /* Calculate local side real time */
 346     if ( t->gst_diff < -100.0 ) {
 347         /* first time through do the expensive calculation & cheap
 348            calculation to get the difference. */
 349       fgPrintf( FG_EVENT, FG_INFO, "  First time, doing precise gst\n");
 350       t->gst = gst_precise = sidereal_precise(t->mjd, 0.00);
 351       gst_course = sidereal_course(t->gmt, t->cur_time, 0.00);
 352       t->gst_diff = gst_precise - gst_course;
 353
 354       t->lst =
 355         sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
 356         + t->gst_diff;
 357     } else {
 358         /* course + difference should drift off very slowly */
 359         t->gst =
 360             sidereal_course(t->gmt, t->cur_time, 0.00) + t->gst_diff;
 361         t->lst =
 362             sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
 363             + t->gst_diff;
 364     }
 365     fgPrintf( FG_EVENT, FG_DEBUG,
 366               "  Current lon=0.00 Sidereal Time = %.3f\n", t->gst);
 367     fgPrintf( FG_EVENT, FG_DEBUG,
 368               "  Current LOCAL Sidereal Time = %.3f (%.3f) (diff = %.3f)\n",
 369               t->lst, sidereal_precise(t->mjd, -(FG_Longitude * RAD_TO_DEG)),
 370               t->gst_diff);
 371 }
 372
 373
 374 /* $Log$
 375 /* Revision 1.38  1998/04/08 23:35:40  curt
 376 /* Tweaks to Gnu automake/autoconf system.
 377 /*
 378  * Revision 1.37  1998/04/03 22:12:55  curt
 379  * Converting to Gnu autoconf system.
 380  * Centralized time handling differences.
 381  *
 382  * Revision 1.36  1998/03/09 22:48:09  curt
 383  * Debug message tweaks.
 384  *
 385  * Revision 1.35  1998/02/09 15:07:52  curt
 386  * Minor tweaks.
 387  *
 388  * Revision 1.34  1998/02/07 15:29:47  curt
 389  * Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 390  * <chotchkiss@namg.us.anritsu.com>
 391  *
 392  * Revision 1.33  1998/02/02 20:54:04  curt
 393  * Incorporated Durk's changes.
 394  *
 395  * Revision 1.32  1998/02/01 03:39:56  curt
 396  * Minor tweaks.
 397  *
 398  * Revision 1.31  1998/01/27 00:48:06  curt
 399  * Incorporated Paul Bleisch's <bleisch@chromatic.com> new debug message
 400  * system and commandline/config file processing code.
 401  *
 402  * Revision 1.30  1998/01/21 21:11:35  curt
 403  * Misc. tweaks.
 404  *
 405  * Revision 1.29  1998/01/19 19:27:20  curt
 406  * Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 407  * This should simplify things tremendously.
 408  *
 409  * Revision 1.28  1998/01/19 18:35:49  curt
 410  * Minor tweaks and fixes for cygwin32.
 411  *
 412  * Revision 1.27  1998/01/13 00:23:13  curt
 413  * Initial changes to support loading and management of scenery tiles.  Note,
 414  * there's still a fair amount of work left to be done.
 415  *
 416  * Revision 1.26  1998/01/05 18:44:36  curt
 417  * Add an option to advance/decrease time from keyboard.
 418  *
 419  * Revision 1.25  1997/12/31 17:46:50  curt
 420  * Tweaked fg_time.c to be able to use ftime() instead of gettimeofday()
 421  *
 422  * Revision 1.24  1997/12/30 22:22:42  curt
 423  * Further integration of event manager.
 424  *
 425  * Revision 1.23  1997/12/30 20:47:58  curt
 426  * Integrated new event manager with subsystem initializations.
 427  *
 428  * Revision 1.22  1997/12/30 01:38:47  curt
 429  * Switched back to per vertex normals and smooth shading for terrain.
 430  *
 431  * Revision 1.21  1997/12/23 04:58:39  curt
 432  * Tweaked the sky coloring a bit to build in structures to allow finer rgb
 433  * control.
 434  *
 435  * Revision 1.20  1997/12/15 23:55:06  curt
 436  * Add xgl wrappers for debugging.
 437  * Generate terrain normals on the fly.
 438  *
 439  * Revision 1.19  1997/12/15 20:59:10  curt
 440  * Misc. tweaks.
 441  *
 442  * Revision 1.18  1997/12/12 21:41:31  curt
 443  * More light/material property tweaking ... still a ways off.
 444  *
 445  * Revision 1.17  1997/12/12 19:53:04  curt
 446  * Working on lightling and material properties.
 447  *
 448  * Revision 1.16  1997/12/11 04:43:57  curt
 449  * Fixed sun vector and lighting problems.  I thing the moon is now lit
 450  * correctly.
 451  *
 452  * Revision 1.15  1997/12/10 22:37:54  curt
 453  * Prepended "fg" on the name of all global structures that didn't have it yet.
 454  * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 455  *
 456  * Revision 1.14  1997/12/10 01:19:52  curt
 457  * Tweaks for verion 0.15 release.
 458  *
 459  * Revision 1.13  1997/12/09 05:11:56  curt
 460  * Working on tweaking lighting.
 461  *
 462  * Revision 1.12  1997/12/09 04:25:37  curt
 463  * Working on adding a global lighting params structure.
 464  *
 465  * Revision 1.11  1997/11/25 19:25:40  curt
 466  * Changes to integrate Durk's moon/sun code updates + clean up.
 467  *
 468  * Revision 1.10  1997/11/15 18:16:42  curt
 469  * minor tweaks.
 470  *
 471  * Revision 1.9  1997/11/14 00:26:50  curt
 472  * Transform scenery coordinates earlier in pipeline when scenery is being
 473  * created, not when it is being loaded.  Precalculate normals for each node
 474  * as average of the normals of each containing polygon so Garoude shading is
 475  * now supportable.
 476  *
 477  * Revision 1.8  1997/10/25 03:30:08  curt
 478  * Misc. tweaks.
 479  *
 480  * Revision 1.7  1997/09/23 00:29:50  curt
 481  * Tweaks to get things to compile with gcc-win32.
 482  *
 483  * Revision 1.6  1997/09/20 03:34:34  curt
 484  * Still trying to get those durned stars aligned properly.
 485  *
 486  * Revision 1.5  1997/09/16 22:14:52  curt
 487  * Tweaked time of day lighting equations.  Don't draw stars during the day.
 488  *
 489  * Revision 1.4  1997/09/16 15:50:31  curt
 490  * Working on star alignment and time issues.
 491  *
 492  * Revision 1.3  1997/09/13 02:00:08  curt
 493  * Mostly working on stars and generating sidereal time for accurate star
 494  * placement.
 495  *
 496  * Revision 1.2  1997/08/27 03:30:35  curt
 497  * Changed naming scheme of basic shared structures.
 498  *
 499  * Revision 1.1  1997/08/13 21:55:59  curt
 500  * Initial revision.
 501  *
 502  */