2 // fg_time.cxx -- data structures and routines for managing time related stuff.
4 // Written by Curtis Olson, started August 1997.
6 // Copyright (C) 1997 Curtis L. Olson - curt@infoplane.com
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.
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.
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.
23 // (Log is kept at end of this file)
35 #ifdef HAVE_SYS_TIMEB_H
36 # include <sys/timeb.h> // for ftime() and struct timeb
39 # include <unistd.h> // for gettimeofday()
41 #ifdef HAVE_SYS_TIME_H
42 # include <sys/time.h> // for get/setitimer, gettimeofday, struct timeval
45 #include <Debug/fg_debug.h>
46 #include <Flight/flight.h>
47 #include <Include/fg_constants.h>
48 #include <Main/options.hxx>
50 #include "fg_time.hxx"
53 #define DEGHR(x) ((x)/15.)
54 #define RADHR(x) DEGHR(x*RAD_TO_DEG)
56 // #define MK_TIME_IS_GMT 0 // default value
57 // #define TIME_ZONE_OFFSET_WORK 0 // default value
60 fgTIME cur_time_params;
63 // Initialize the time dependent variables
65 void fgTimeInit(fgTIME *t) {
66 fgPrintf( FG_EVENT, FG_INFO, "Initializing Time\n");
68 t->gst_diff = -9999.0;
70 fgPrintf( FG_EVENT, FG_DEBUG, "time offset = %d\n",
71 current_options.get_time_offset() );
73 t->warp = current_options.get_time_offset();
76 t->pause = current_options.get_pause();
80 // Portability wrap to get current time.
81 void timestamp(fg_timestamp *timestamp) {
82 #if defined( HAVE_GETTIMEOFDAY )
83 struct timeval current;
85 // fg_timestamp currtime;
86 gettimeofday(¤t, &tz);
87 timestamp->seconds = current.tv_sec;
88 timestamp->millis = current.tv_usec / 1000;
89 #elif defined( HAVE_GETLOCALTIME )
91 GetLocalTime(¤t);
92 timestamp->seconds = current.wSecond;
93 timestamp->millis = current.wMilliseconds;
94 #elif defined( HAVE_FTIME )
97 timestamp->seconds = current.time;
98 timestamp->millis = current.millitm;
105 // Return duration in millis from first to last
106 long timediff(fg_timestamp *first, fg_timestamp *last) {
107 return 1000 * (last->seconds - first->seconds) +
108 (last->millis - first->millis);
112 // Return new timestamp given a time stamp and an interval to add in
113 void timesum(fg_timestamp *res, fg_timestamp *start, long millis) {
114 res->seconds = start->seconds +
115 ( start->millis + millis ) / 1000;
116 res->millis = ( start->millis + millis ) % 1000;
120 // given a date in months, mn, days, dy, years, yr, return the
121 // modified Julian date (number of days elapsed since 1900 jan 0.5),
122 // mjd. Adapted from Xephem.
124 double cal_mjd (int mn, double dy, int yr) {
125 static double last_mjd, last_dy;
127 static int last_mn, last_yr;
131 if (mn == last_mn && yr == last_yr && dy == last_dy) {
137 y = (yr < 0) ? yr + 1 : yr;
143 if (yr < 1582 || (yr == 1582 && (mn < 10 || (mn == 10 && dy < 15)))) {
152 c = (long)((365.25*y) - 0.75) - 694025L;
154 c = (long)(365.25*y) - 694025L;
157 d = (int)(30.6001*(m+1));
159 mjd = b + c + d + dy - 0.5;
170 // given an mjd, return greenwich mean siderial time, gst
172 double utc_gst (double mjd) {
174 double day = floor(mjd-0.5)+0.5;
175 double hr = (mjd-day)*24.0;
178 T = ((int)(mjd - 0.5) + 0.5 - J2000)/36525.0;
179 x = 24110.54841 + (8640184.812866 + (0.093104 - 6.2e-6 * T) * T) * T;
181 gst = (1.0/SIDRATE)*hr + x;
183 fgPrintf( FG_EVENT, FG_DEBUG, " gst => %.4f\n", gst);
189 // given Julian Date and Longitude (decimal degrees West) compute and
190 // return Local Sidereal Time, in decimal hours.
192 // Provided courtesy of ecdowney@noao.edu (Elwood Downey)
195 double sidereal_precise (double mjd, double lng) {
199 /* printf ("Current Lst on JD %13.5f at %8.4f degrees West: ",
202 // convert to required internal units
205 // compute LST and print
207 lst = gst - RADHR (lng);
208 lst -= 24.0*floor(lst/24.0);
209 // printf ("%7.4f\n", lst);
216 // Fix up timezone if using ftime()
217 long int fix_up_timezone( long int timezone_orig ) {
218 #if !defined( HAVE_GETTIMEOFDAY ) && defined( HAVE_FTIME )
219 // ftime() needs a little extra help finding the current timezone
220 struct timeb current;
222 return( current.timezone * 60 );
224 return( timezone_orig );
229 // Return time_t for Sat Mar 21 12:00:00 GMT
231 // I believe the mktime() has a SYSV vs. BSD behavior difference.
233 // The BSD style mktime() is nice because it returns its result
234 // assuming you have specified the input time in GMT
236 // The SYSV style mktime() is a pain because it returns its result
237 // assuming you have specified the input time in your local timezone.
238 // Therefore you have to go to extra trouble to convert back to GMT.
240 // If you are having problems with incorrectly positioned astronomical
241 // bodies, this is a really good place to start looking.
243 time_t get_start_gmt(int year) {
246 // For now we assume that if daylight is not defined in
247 // /usr/include/time.h that we have a machine with a BSD behaving
249 # if !defined(HAVE_DAYLIGHT)
250 # define MK_TIME_IS_GMT 1
253 // timezone seems to work as a proper offset for Linux & Solaris
254 # if defined( __linux__ ) || defined( __sun__ )
255 # define TIMEZONE_OFFSET_WORKS 1
264 mt.tm_isdst = -1; // let the system determine the proper time zone
266 # if defined( MK_TIME_IS_GMT )
267 return ( mktime(&mt) );
268 # else // ! defined ( MK_TIME_IS_GMT )
270 long int start = mktime(&mt);
272 fgPrintf( FG_EVENT, FG_DEBUG, "start1 = %ld\n", start);
273 // the ctime() call can screw up time progression on some versions
275 // fgPrintf( FG_EVENT, FG_DEBUG, "start2 = %s", ctime(&start));
276 fgPrintf( FG_EVENT, FG_DEBUG, "(tm_isdst = %d)\n", mt.tm_isdst);
278 timezone = fix_up_timezone( timezone );
280 # if defined( TIMEZONE_OFFSET_WORKS )
281 fgPrintf( FG_EVENT, FG_DEBUG,
282 "start = %ld, timezone = %ld\n", start, timezone );
283 return( start - timezone );
284 # else // ! defined( TIMEZONE_OFFSET_WORKS )
286 daylight = mt.tm_isdst;
287 if ( daylight > 0 ) {
289 } else if ( daylight < 0 ) {
290 fgPrintf( FG_EVENT, FG_WARN,
291 "OOOPS, problem in fg_time.cxx, no daylight savings info.\n");
294 long int offset = -(timezone / 3600 - daylight);
296 fgPrintf( FG_EVENT, FG_DEBUG,
297 " Raw time zone offset = %ld\n", timezone);
298 fgPrintf( FG_EVENT, FG_DEBUG,
299 " Daylight Savings = %d\n", daylight);
300 fgPrintf( FG_EVENT, FG_DEBUG,
301 " Local hours from GMT = %ld\n", offset);
303 long int start_gmt = start - timezone + (daylight * 3600);
305 fgPrintf( FG_EVENT, FG_DEBUG, " March 21 noon (CST) = %ld\n", start);
307 return ( start_gmt );
308 # endif // ! defined( TIMEZONE_OFFSET_WORKS )
309 # endif // ! defined ( MK_TIME_IS_GMT )
313 // return a courser but cheaper estimate of sidereal time
314 double sidereal_course(struct tm *gmt, time_t now, double lng) {
316 double diff, part, days, hours, lst;
318 start_gmt = get_start_gmt(gmt->tm_year);
320 fgPrintf(FG_EVENT, FG_DEBUG,
321 " COURSE: GMT = %d/%d/%2d %d:%02d:%02d\n",
322 gmt->tm_mon, gmt->tm_mday, gmt->tm_year,
323 gmt->tm_hour, gmt->tm_min, gmt->tm_sec);
325 fgPrintf( FG_EVENT, FG_DEBUG, " March 21 noon (GMT) = %ld\n", start_gmt);
327 diff = (now - start_gmt) / (3600.0 * 24.0);
329 fgPrintf( FG_EVENT, FG_DEBUG,
330 " Time since 3/21/%2d GMT = %.2f\n", gmt->tm_year, diff);
332 part = fmod(diff, 1.0);
334 hours = gmt->tm_hour + gmt->tm_min/60.0 + gmt->tm_sec/3600.0;
336 lst = (days - lng)/15.0 + hours - 12;
338 while ( lst < 0.0 ) {
342 fgPrintf( FG_EVENT, FG_DEBUG,
343 " days = %.1f hours = %.2f lon = %.2f lst = %.2f\n",
344 days, hours, lng, lst);
350 // Update time variables such as gmt, julian date, and sidereal time
351 void fgTimeUpdate(fgFLIGHT *f, fgTIME *t) {
352 double gst_precise, gst_course;
354 fgPrintf( FG_EVENT, FG_BULK, "Updating time\n");
356 // get current Unix calendar time (in seconds)
357 t->warp += t->warp_delta;
358 t->cur_time = time(NULL) + t->warp;
359 fgPrintf( FG_EVENT, FG_BULK,
360 " Current Unix calendar time = %ld warp = %ld delta = %ld\n",
361 t->cur_time, t->warp, t->warp_delta);
363 // get GMT break down for current time
364 t->gmt = gmtime(&t->cur_time);
365 fgPrintf( FG_EVENT, FG_BULK,
366 " Current GMT = %d/%d/%2d %d:%02d:%02d\n",
367 t->gmt->tm_mon+1, t->gmt->tm_mday, t->gmt->tm_year,
368 t->gmt->tm_hour, t->gmt->tm_min, t->gmt->tm_sec);
370 // calculate modified Julian date
371 t->mjd = cal_mjd ((int)(t->gmt->tm_mon+1), (double)t->gmt->tm_mday,
372 (int)(t->gmt->tm_year + 1900));
374 // add in partial day
375 t->mjd += (t->gmt->tm_hour / 24.0) + (t->gmt->tm_min / (24.0 * 60.0)) +
376 (t->gmt->tm_sec / (24.0 * 60.0 * 60.0));
378 // convert "back" to Julian date + partial day (as a fraction of one)
379 t->jd = t->mjd + MJD0;
380 fgPrintf( FG_EVENT, FG_BULK, " Current Julian Date = %.5f\n", t->jd);
382 // printf(" Current Longitude = %.3f\n", FG_Longitude * RAD_TO_DEG);
384 // Calculate local side real time
385 if ( t->gst_diff < -100.0 ) {
386 // first time through do the expensive calculation & cheap
387 // calculation to get the difference.
388 fgPrintf( FG_EVENT, FG_INFO, " First time, doing precise gst\n");
389 t->gst = gst_precise = sidereal_precise(t->mjd, 0.00);
390 gst_course = sidereal_course(t->gmt, t->cur_time, 0.00);
391 t->gst_diff = gst_precise - gst_course;
394 sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
397 // course + difference should drift off very slowly
399 sidereal_course(t->gmt, t->cur_time, 0.00) + t->gst_diff;
401 sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
404 fgPrintf( FG_EVENT, FG_DEBUG,
405 " Current lon=0.00 Sidereal Time = %.3f\n", t->gst);
406 fgPrintf( FG_EVENT, FG_DEBUG,
407 " Current LOCAL Sidereal Time = %.3f (%.3f) (diff = %.3f)\n",
408 t->lst, sidereal_precise(t->mjd, -(FG_Longitude * RAD_TO_DEG)),
414 // Revision 1.13 1998/07/30 23:48:55 curt
418 // Revision 1.12 1998/07/27 18:42:22 curt
419 // Added a pause option.
421 // Revision 1.11 1998/07/22 21:45:37 curt
422 // fg_time.cxx: Removed call to ctime() in a printf() which should be harmless
423 // but seems to be triggering a bug.
424 // light.cxx: Added code to adjust fog color based on sunrise/sunset effects
425 // and view orientation. This is an attempt to match the fog color to the
426 // sky color in the center of the screen. You see discrepancies at the
427 // edges, but what else can be done?
428 // sunpos.cxx: Caculate local direction to sun here. (what compass direction
429 // do we need to face to point directly at sun)
431 // Revision 1.10 1998/07/13 21:02:07 curt
432 // Wrote access functions for current fgOPTIONS.
434 // Revision 1.9 1998/06/12 00:59:53 curt
435 // Build only static libraries.
436 // Declare memmove/memset for Sloaris.
437 // Rewrote fg_time.c routine to get LST start seconds to better handle
438 // Solaris, and be easier to port, and understand the GMT vs. local
441 // Revision 1.8 1998/06/05 18:18:13 curt
442 // Incorporated some automake conditionals to try to support mktime() correctly
443 // on a wider variety of platforms.
444 // Added the declaration of memmove needed by the stl which apparently
445 // solaris only defines for cc compilations and not for c++ (__STDC__)
447 // Revision 1.7 1998/05/30 01:57:25 curt
450 // Revision 1.6 1998/05/02 01:53:17 curt
451 // Fine tuning mktime() support because of varying behavior on different
454 // Revision 1.5 1998/04/28 21:45:34 curt
455 // Fixed a horible bug that cause the time to be *WAY* off when compiling
456 // with the CygWin32 compiler. This may not yet completely address other
457 // Win32 compilers, but we'll have to take them on a case by case basis.
459 // Revision 1.4 1998/04/28 01:22:16 curt
460 // Type-ified fgTIME and fgVIEW.
462 // Revision 1.3 1998/04/25 22:06:33 curt
463 // Edited cvs log messages in source files ... bad bad bad!
465 // Revision 1.2 1998/04/25 20:24:02 curt
466 // Cleaned up initialization sequence to eliminate interdependencies
467 // between sun position, lighting, and view position. This creates a
468 // valid single pass initialization path.
470 // Revision 1.1 1998/04/24 00:52:27 curt
471 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
473 // Separated out lighting calcs into their own file.
475 // Revision 1.41 1998/04/22 13:24:05 curt
476 // C++ - ifiing the code a bit.
477 // Starting to reorginize some of the lighting calcs to use a table lookup.
479 // Revision 1.40 1998/04/18 04:14:09 curt
480 // Moved fg_debug.c to it's own library.
482 // Revision 1.39 1998/04/09 18:40:14 curt
483 // We had unified some of the platform disparate time handling code, and
484 // there was a bug in timesum() which calculated a new time stamp based on
485 // the current time stamp + offset. This hosed the periodic event processing
486 // logic because you'd never arrive at the time the event was scheduled for.
487 // Sky updates and lighting changes are handled via this event mechanism so
488 // they never changed ... it is fixed now.
490 // Revision 1.38 1998/04/08 23:35:40 curt
491 // Tweaks to Gnu automake/autoconf system.
493 // Revision 1.37 1998/04/03 22:12:55 curt
494 // Converting to Gnu autoconf system.
495 // Centralized time handling differences.
497 // Revision 1.36 1998/03/09 22:48:09 curt
498 // Debug message tweaks.
500 // Revision 1.35 1998/02/09 15:07:52 curt
503 // Revision 1.34 1998/02/07 15:29:47 curt
504 // Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
505 // <chotchkiss@namg.us.anritsu.com>
507 // Revision 1.33 1998/02/02 20:54:04 curt
508 // Incorporated Durk's changes.
510 // Revision 1.32 1998/02/01 03:39:56 curt
513 // Revision 1.31 1998/01/27 00:48:06 curt
514 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
515 // system and commandline/config file processing code.
517 // Revision 1.30 1998/01/21 21:11:35 curt
520 // Revision 1.29 1998/01/19 19:27:20 curt
521 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
522 // This should simplify things tremendously.
524 // Revision 1.28 1998/01/19 18:35:49 curt
525 // Minor tweaks and fixes for cygwin32.
527 // Revision 1.27 1998/01/13 00:23:13 curt
528 // Initial changes to support loading and management of scenery tiles. Note,
529 // there's still a fair amount of work left to be done.
531 // Revision 1.26 1998/01/05 18:44:36 curt
532 // Add an option to advance/decrease time from keyboard.
534 // Revision 1.25 1997/12/31 17:46:50 curt
535 // Tweaked fg_time.c to be able to use ftime() instead of gettimeofday()
537 // Revision 1.24 1997/12/30 22:22:42 curt
538 // Further integration of event manager.
540 // Revision 1.23 1997/12/30 20:47:58 curt
541 // Integrated new event manager with subsystem initializations.
543 // Revision 1.22 1997/12/30 01:38:47 curt
544 // Switched back to per vertex normals and smooth shading for terrain.
546 // Revision 1.21 1997/12/23 04:58:39 curt
547 // Tweaked the sky coloring a bit to build in structures to allow finer rgb
550 // Revision 1.20 1997/12/15 23:55:06 curt
551 // Add xgl wrappers for debugging.
552 // Generate terrain normals on the fly.
554 // Revision 1.19 1997/12/15 20:59:10 curt
557 // Revision 1.18 1997/12/12 21:41:31 curt
558 // More light/material property tweaking ... still a ways off.
560 // Revision 1.17 1997/12/12 19:53:04 curt
561 // Working on lightling and material properties.
563 // Revision 1.16 1997/12/11 04:43:57 curt
564 // Fixed sun vector and lighting problems. I thing the moon is now lit
567 // Revision 1.15 1997/12/10 22:37:54 curt
568 // Prepended "fg" on the name of all global structures that didn't have it yet.
569 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
571 // Revision 1.14 1997/12/10 01:19:52 curt
572 // Tweaks for verion 0.15 release.
574 // Revision 1.13 1997/12/09 05:11:56 curt
575 // Working on tweaking lighting.
577 // Revision 1.12 1997/12/09 04:25:37 curt
578 // Working on adding a global lighting params structure.
580 // Revision 1.11 1997/11/25 19:25:40 curt
581 // Changes to integrate Durk's moon/sun code updates + clean up.
583 // Revision 1.10 1997/11/15 18:16:42 curt
586 // Revision 1.9 1997/11/14 00:26:50 curt
587 // Transform scenery coordinates earlier in pipeline when scenery is being
588 // created, not when it is being loaded. Precalculate normals for each node
589 // as average of the normals of each containing polygon so Garoude shading is
592 // Revision 1.8 1997/10/25 03:30:08 curt
595 // Revision 1.7 1997/09/23 00:29:50 curt
596 // Tweaks to get things to compile with gcc-win32.
598 // Revision 1.6 1997/09/20 03:34:34 curt
599 // Still trying to get those durned stars aligned properly.
601 // Revision 1.5 1997/09/16 22:14:52 curt
602 // Tweaked time of day lighting equations. Don't draw stars during the day.
604 // Revision 1.4 1997/09/16 15:50:31 curt
605 // Working on star alignment and time issues.
607 // Revision 1.3 1997/09/13 02:00:08 curt
608 // Mostly working on stars and generating sidereal time for accurate star
611 // Revision 1.2 1997/08/27 03:30:35 curt
612 // Changed naming scheme of basic shared structures.
614 // Revision 1.1 1997/08/13 21:55:59 curt