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 <math.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <time.h>
  31
  32 #ifdef USE_FTIME
  33 #  include <sys/timeb.h> /* for ftime() and struct timeb */
  34 #else
  35 #  include <unistd.h>  /* for gettimeofday() */
  36 #  include <sys/time.h>  /* for get/setitimer, gettimeofday, struct timeval */
  37 #endif /* USE_FTIME */
  38
  39 #include <Time/fg_time.h>
  40 #include <Include/fg_constants.h>
  41 #include <Flight/flight.h>
  42
  43
  44 #define DEGHR(x)        ((x)/15.)
  45 #define RADHR(x)        DEGHR(x*RAD_TO_DEG)
  46
  47 #include <Main/fg_debug.h>
  48
  49 struct fgTIME cur_time_params;
  50 struct fgLIGHT cur_light_params;
  51
  52
  53 /* Initialize the time dependent variables */
  54
  55 void fgTimeInit(struct fgTIME *t) {
  56     fgPrintf( FG_EVENT, FG_INFO, "Initializing Time\n");
  57
  58     t->gst_diff = -9999.0;
  59     t->warp = (0) * 3600;
  60     t->warp_delta = 0;
  61 }
  62
  63
  64 /* given a date in months, mn, days, dy, years, yr, return the
  65  * modified Julian date (number of days elapsed since 1900 jan 0.5),
  66  * mjd.  Adapted from Xephem.  */
  67
  68 double cal_mjd (int mn, double dy, int yr) {
  69     static double last_mjd, last_dy;
  70     double mjd;
  71     static int last_mn, last_yr;
  72     int b, d, m, y;
  73     long c;
  74
  75     if (mn == last_mn && yr == last_yr && dy == last_dy) {
  76         mjd = last_mjd;
  77         return(mjd);
  78     }
  79
  80     m = mn;
  81     y = (yr < 0) ? yr + 1 : yr;
  82     if (mn < 3) {
  83         m += 12;
  84         y -= 1;
  85     }
  86
  87     if (yr < 1582 || (yr == 1582 && (mn < 10 || (mn == 10 && dy < 15)))) {
  88         b = 0;
  89     } else {
  90         int a;
  91         a = y/100;
  92         b = 2 - a + a/4;
  93     }
  94
  95     if (y < 0) {
  96         c = (long)((365.25*y) - 0.75) - 694025L;
  97     } else {
  98         c = (long)(365.25*y) - 694025L;
  99     }
 100
 101     d = 30.6001*(m+1);
 102
 103     mjd = b + c + d + dy - 0.5;
 104
 105     last_mn = mn;
 106     last_dy = dy;
 107     last_yr = yr;
 108     last_mjd = mjd;
 109
 110     return(mjd);
 111 }
 112
 113
 114 /* given an mjd, return greenwich mean siderial time, gst */
 115
 116 double utc_gst (double mjd) {
 117     double gst;
 118     double day = floor(mjd-0.5)+0.5;
 119     double hr = (mjd-day)*24.0;
 120     double T, x;
 121
 122     T = ((int)(mjd - 0.5) + 0.5 - J2000)/36525.0;
 123     x = 24110.54841 + (8640184.812866 + (0.093104 - 6.2e-6 * T) * T) * T;
 124     x /= 3600.0;
 125     gst = (1.0/SIDRATE)*hr + x;
 126
 127    fgPrintf( FG_EVENT, FG_DEBUG, "  gst => %.4f\n", gst);
 128
 129     return(gst);
 130 }
 131
 132
 133 /* given Julian Date and Longitude (decimal degrees West) compute and
 134  * return Local Sidereal Time, in decimal hours.
 135  *
 136  * Provided courtesy of ecdowney@noao.edu (Elwood Downey)
 137  */
 138
 139 double sidereal_precise (double mjd, double lng) {
 140     double gst;
 141     double lst;
 142
 143     /* printf ("Current Lst on JD %13.5f at %8.4f degrees West: ",
 144        mjd + MJD0, lng); */
 145
 146     /* convert to required internal units */
 147     lng *= DEG_TO_RAD;
 148
 149     /* compute LST and print */
 150     gst = utc_gst (mjd);
 151     lst = gst - RADHR (lng);
 152     lst -= 24.0*floor(lst/24.0);
 153     /* printf ("%7.4f\n", lst); */
 154
 155     /* that's all */
 156     return (lst);
 157 }
 158
 159
 160 /* return a courser but cheaper estimate of sidereal time */
 161 double sidereal_course(struct tm *gmt, time_t now, double lng) {
 162     time_t start, start_gmt;
 163     struct tm mt;
 164     long int offset;
 165     double diff, part, days, hours, lst;
 166
 167 #ifdef USE_FTIME
 168     struct timeb current;
 169 #endif /* USE_FTIME */
 170
 171 #ifdef WIN32
 172     int daylight;
 173     long int timezone;
 174 #endif /* WIN32 */
 175
 176     /*
 177     printf("  COURSE: GMT = %d/%d/%2d %d:%02d:%02d\n",
 178            gmt->tm_mon, gmt->tm_mday, gmt->tm_year,
 179            gmt->tm_hour, gmt->tm_min, gmt->tm_sec);
 180     */
 181
 182     mt.tm_mon = 2;
 183     mt.tm_mday = 21;
 184     mt.tm_year = gmt->tm_year;
 185     mt.tm_hour = 12;
 186     mt.tm_min = 0;
 187     mt.tm_sec = 0;
 188     mt.tm_isdst = -1; /* let the system determine the proper time zone */
 189
 190     start = mktime(&mt);
 191
 192     /* printf("start1 = %ld\n", start);
 193    fgPrintf( FG_EVENT, FG_DEBUG, "start2 = %s", ctime(&start));
 194    fgPrintf( FG_EVENT, FG_DEBUG, "start3 = %ld\n", start); */
 195
 196     daylight = mt.tm_isdst;
 197
 198 #ifdef USE_FTIME
 199     ftime(&current);
 200     timezone = current.timezone * 60;
 201 #endif /* USE_FTIME */
 202
 203     if ( daylight > 0 ) {
 204         daylight = 1;
 205     } else if ( daylight < 0 ) {
 206         fgPrintf( FG_EVENT, FG_WARN, "OOOPS, big time problem in fg_time.c, no daylight savings info.\n");
 207     }
 208
 209     offset = -(timezone / 3600 - daylight);
 210
 211     /* printf("  Raw time zone offset = %ld\n", timezone); */
 212     /* printf("  Daylight Savings = %d\n", daylight); */
 213
 214     /* printf("  Local hours from GMT = %ld\n", offset); */
 215
 216     start_gmt = start - timezone + (daylight * 3600);
 217
 218     /* printf("  March 21 noon (CST) = %ld\n", start); */
 219     /* printf("  March 21 noon (GMT) = %ld\n", start_gmt); */
 220
 221     diff = (now - start_gmt) / (3600.0 * 24.0);
 222
 223     /* printf("  Time since 3/21/%2d GMT = %.2f\n", gmt->tm_year, diff); */
 224
 225     part = fmod(diff, 1.0);
 226     days = diff - part;
 227     hours = gmt->tm_hour + gmt->tm_min/60.0 + gmt->tm_sec/3600.0;
 228
 229     lst = (days - lng)/15.0 + hours - 12;
 230
 231     while ( lst < 0.0 ) {
 232         lst += 24.0;
 233     }
 234
 235     /* printf("  days = %.1f  hours = %.2f  lon = %.2f  lst = %.2f\n",
 236            days, hours, lng, lst); */
 237
 238     return(lst);
 239 }
 240
 241
 242 /* Update the time dependent variables */
 243
 244 void fgTimeUpdate(struct fgFLIGHT *f, struct fgTIME *t) {
 245     double gst_precise, gst_course;
 246
 247     fgPrintf( FG_EVENT, FG_BULK, "Updating time\n");
 248
 249     /* get current Unix calendar time (in seconds) */
 250     t->warp += t->warp_delta;
 251     t->cur_time = time(NULL) + t->warp;
 252     fgPrintf( FG_EVENT, FG_BULK,
 253               "  Current Unix calendar time = %ld  warp = %ld  delta = %ld\n",
 254               t->cur_time, t->warp, t->warp_delta);
 255
 256     /* get GMT break down for current time */
 257     t->gmt = gmtime(&t->cur_time);
 258     fgPrintf( FG_EVENT, FG_BULK,
 259               "  Current GMT = %d/%d/%2d %d:%02d:%02d\n",
 260               t->gmt->tm_mon+1, t->gmt->tm_mday, t->gmt->tm_year,
 261               t->gmt->tm_hour, t->gmt->tm_min, t->gmt->tm_sec);
 262
 263     /* calculate modified Julian date */
 264     t->mjd = cal_mjd ((int)(t->gmt->tm_mon+1), (double)t->gmt->tm_mday,
 265              (int)(t->gmt->tm_year + 1900));
 266
 267     /* add in partial day */
 268     t->mjd += (t->gmt->tm_hour / 24.0) + (t->gmt->tm_min / (24.0 * 60.0)) +
 269            (t->gmt->tm_sec / (24.0 * 60.0 * 60.0));
 270
 271     /* convert "back" to Julian date + partial day (as a fraction of one) */
 272     t->jd = t->mjd + MJD0;
 273     fgPrintf( FG_EVENT, FG_BULK, "  Current Julian Date = %.5f\n", t->jd);
 274
 275     /* printf("  Current Longitude = %.3f\n", FG_Longitude * RAD_TO_DEG); */
 276
 277     /* Calculate local side real time */
 278     if ( t->gst_diff < -100.0 ) {
 279         /* first time through do the expensive calculation & cheap
 280            calculation to get the difference. */
 281       fgPrintf( FG_EVENT, FG_INFO, "  First time, doing precise gst\n");
 282       t->gst = gst_precise = sidereal_precise(t->mjd, 0.00);
 283       gst_course = sidereal_course(t->gmt, t->cur_time, 0.00);
 284       t->gst_diff = gst_precise - gst_course;
 285
 286       t->lst =
 287         sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
 288         + t->gst_diff;
 289     } else {
 290         /* course + difference should drift off very slowly */
 291         t->gst =
 292             sidereal_course(t->gmt, t->cur_time, 0.00) + t->gst_diff;
 293         t->lst =
 294             sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
 295             + t->gst_diff;
 296     }
 297     /* printf("  Current lon=0.00 Sidereal Time = %.3f\n", t->gst); */
 298     /* printf("  Current LOCAL Sidereal Time = %.3f (%.3f) (diff = %.3f)\n",
 299            t->lst, sidereal_precise(t->mjd, -(FG_Longitude * RAD_TO_DEG)),
 300            t->gst_diff); */
 301 }
 302
 303
 304 /* $Log$
 305 /* Revision 1.31  1998/01/27 00:48:06  curt
 306 /* Incorporated Paul Bleisch's <bleisch@chromatic.com> new debug message
 307 /* system and commandline/config file processing code.
 308 /*
 309  * Revision 1.30  1998/01/21 21:11:35  curt
 310  * Misc. tweaks.
 311  *
 312  * Revision 1.29  1998/01/19 19:27:20  curt
 313  * Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 314  * This should simplify things tremendously.
 315  *
 316  * Revision 1.28  1998/01/19 18:35:49  curt
 317  * Minor tweaks and fixes for cygwin32.
 318  *
 319  * Revision 1.27  1998/01/13 00:23:13  curt
 320  * Initial changes to support loading and management of scenery tiles.  Note,
 321  * there's still a fair amount of work left to be done.
 322  *
 323  * Revision 1.26  1998/01/05 18:44:36  curt
 324  * Add an option to advance/decrease time from keyboard.
 325  *
 326  * Revision 1.25  1997/12/31 17:46:50  curt
 327  * Tweaked fg_time.c to be able to use ftime() instead of gettimeofday()
 328  *
 329  * Revision 1.24  1997/12/30 22:22:42  curt
 330  * Further integration of event manager.
 331  *
 332  * Revision 1.23  1997/12/30 20:47:58  curt
 333  * Integrated new event manager with subsystem initializations.
 334  *
 335  * Revision 1.22  1997/12/30 01:38:47  curt
 336  * Switched back to per vertex normals and smooth shading for terrain.
 337  *
 338  * Revision 1.21  1997/12/23 04:58:39  curt
 339  * Tweaked the sky coloring a bit to build in structures to allow finer rgb
 340  * control.
 341  *
 342  * Revision 1.20  1997/12/15 23:55:06  curt
 343  * Add xgl wrappers for debugging.
 344  * Generate terrain normals on the fly.
 345  *
 346  * Revision 1.19  1997/12/15 20:59:10  curt
 347  * Misc. tweaks.
 348  *
 349  * Revision 1.18  1997/12/12 21:41:31  curt
 350  * More light/material property tweaking ... still a ways off.
 351  *
 352  * Revision 1.17  1997/12/12 19:53:04  curt
 353  * Working on lightling and material properties.
 354  *
 355  * Revision 1.16  1997/12/11 04:43:57  curt
 356  * Fixed sun vector and lighting problems.  I thing the moon is now lit
 357  * correctly.
 358  *
 359  * Revision 1.15  1997/12/10 22:37:54  curt
 360  * Prepended "fg" on the name of all global structures that didn't have it yet.
 361  * i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 362  *
 363  * Revision 1.14  1997/12/10 01:19:52  curt
 364  * Tweaks for verion 0.15 release.
 365  *
 366  * Revision 1.13  1997/12/09 05:11:56  curt
 367  * Working on tweaking lighting.
 368  *
 369  * Revision 1.12  1997/12/09 04:25:37  curt
 370  * Working on adding a global lighting params structure.
 371  *
 372  * Revision 1.11  1997/11/25 19:25:40  curt
 373  * Changes to integrate Durk's moon/sun code updates + clean up.
 374  *
 375  * Revision 1.10  1997/11/15 18:16:42  curt
 376  * minor tweaks.
 377  *
 378  * Revision 1.9  1997/11/14 00:26:50  curt
 379  * Transform scenery coordinates earlier in pipeline when scenery is being
 380  * created, not when it is being loaded.  Precalculate normals for each node
 381  * as average of the normals of each containing polygon so Garoude shading is
 382  * now supportable.
 383  *
 384  * Revision 1.8  1997/10/25 03:30:08  curt
 385  * Misc. tweaks.
 386  *
 387  * Revision 1.7  1997/09/23 00:29:50  curt
 388  * Tweaks to get things to compile with gcc-win32.
 389  *
 390  * Revision 1.6  1997/09/20 03:34:34  curt
 391  * Still trying to get those durned stars aligned properly.
 392  *
 393  * Revision 1.5  1997/09/16 22:14:52  curt
 394  * Tweaked time of day lighting equations.  Don't draw stars during the day.
 395  *
 396  * Revision 1.4  1997/09/16 15:50:31  curt
 397  * Working on star alignment and time issues.
 398  *
 399  * Revision 1.3  1997/09/13 02:00:08  curt
 400  * Mostly working on stars and generating sidereal time for accurate star
 401  * placement.
 402  *
 403  * Revision 1.2  1997/08/27 03:30:35  curt
 404  * Changed naming scheme of basic shared structures.
 405  *
 406  * Revision 1.1  1997/08/13 21:55:59  curt
 407  * Initial revision.
 408  *
 409  */