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 <Astro/orbits.hxx>
46 #include <Astro/sun.hxx>
47 #include <Astro/sky.hxx>
48 #include <Debug/fg_debug.h>
49 #include <Flight/flight.h>
50 #include <Include/fg_constants.h>
51 #include <Main/options.hxx>
52 #include <Time/light.hxx>
54 #include "fg_time.hxx"
57 #define DEGHR(x) ((x)/15.)
58 #define RADHR(x) DEGHR(x*RAD_TO_DEG)
60 // #define MK_TIME_IS_GMT 0 // default value
61 // #define TIME_ZONE_OFFSET_WORK 0 // default value
64 fgTIME cur_time_params;
67 // Force an update of the sky and lighting parameters
68 static void local_update_sky_and_lighting_params( void ) {
75 // Initialize the time dependent variables
76 void fgTimeInit(fgTIME *t) {
77 fgPrintf( FG_EVENT, FG_INFO, "Initializing Time\n");
79 t->gst_diff = -9999.0;
81 fgPrintf( FG_EVENT, FG_DEBUG, "time offset = %d\n",
82 current_options.get_time_offset() );
84 t->warp = current_options.get_time_offset();
87 t->pause = current_options.get_pause();
91 // Portability wrap to get current time.
92 void timestamp(fg_timestamp *timestamp) {
93 #if defined( HAVE_GETTIMEOFDAY )
94 struct timeval current;
96 // fg_timestamp currtime;
97 gettimeofday(¤t, &tz);
98 timestamp->seconds = current.tv_sec;
99 timestamp->millis = current.tv_usec / 1000;
100 #elif defined( HAVE_GETLOCALTIME )
102 GetLocalTime(¤t);
103 timestamp->seconds = current.wSecond;
104 timestamp->millis = current.wMilliseconds;
105 #elif defined( HAVE_FTIME )
106 struct timeb current;
108 timestamp->seconds = current.time;
109 timestamp->millis = current.millitm;
116 // Return duration in millis from first to last
117 long timediff(fg_timestamp *first, fg_timestamp *last) {
118 return 1000 * (last->seconds - first->seconds) +
119 (last->millis - first->millis);
123 // Return new timestamp given a time stamp and an interval to add in
124 void timesum(fg_timestamp *res, fg_timestamp *start, long millis) {
125 res->seconds = start->seconds +
126 ( start->millis + millis ) / 1000;
127 res->millis = ( start->millis + millis ) % 1000;
131 // given a date in months, mn, days, dy, years, yr, return the
132 // modified Julian date (number of days elapsed since 1900 jan 0.5),
133 // mjd. Adapted from Xephem.
135 double cal_mjd (int mn, double dy, int yr) {
136 static double last_mjd, last_dy;
138 static int last_mn, last_yr;
142 if (mn == last_mn && yr == last_yr && dy == last_dy) {
148 y = (yr < 0) ? yr + 1 : yr;
154 if (yr < 1582 || (yr == 1582 && (mn < 10 || (mn == 10 && dy < 15)))) {
163 c = (long)((365.25*y) - 0.75) - 694025L;
165 c = (long)(365.25*y) - 694025L;
168 d = (int)(30.6001*(m+1));
170 mjd = b + c + d + dy - 0.5;
181 // given an mjd, return greenwich mean siderial time, gst
183 double utc_gst (double mjd) {
185 double day = floor(mjd-0.5)+0.5;
186 double hr = (mjd-day)*24.0;
189 T = ((int)(mjd - 0.5) + 0.5 - J2000)/36525.0;
190 x = 24110.54841 + (8640184.812866 + (0.093104 - 6.2e-6 * T) * T) * T;
192 gst = (1.0/SIDRATE)*hr + x;
194 fgPrintf( FG_EVENT, FG_DEBUG, " gst => %.4f\n", gst);
200 // given Julian Date and Longitude (decimal degrees West) compute and
201 // return Local Sidereal Time, in decimal hours.
203 // Provided courtesy of ecdowney@noao.edu (Elwood Downey)
206 double sidereal_precise (double mjd, double lng) {
210 /* printf ("Current Lst on JD %13.5f at %8.4f degrees West: ",
213 // convert to required internal units
216 // compute LST and print
218 lst = gst - RADHR (lng);
219 lst -= 24.0*floor(lst/24.0);
220 // printf ("%7.4f\n", lst);
227 // Fix up timezone if using ftime()
228 long int fix_up_timezone( long int timezone_orig ) {
229 #if !defined( HAVE_GETTIMEOFDAY ) && defined( HAVE_FTIME )
230 // ftime() needs a little extra help finding the current timezone
231 struct timeb current;
233 return( current.timezone * 60 );
235 return( timezone_orig );
240 // Return time_t for Sat Mar 21 12:00:00 GMT
242 // I believe the mktime() has a SYSV vs. BSD behavior difference.
244 // The BSD style mktime() is nice because it returns its result
245 // assuming you have specified the input time in GMT
247 // The SYSV style mktime() is a pain because it returns its result
248 // assuming you have specified the input time in your local timezone.
249 // Therefore you have to go to extra trouble to convert back to GMT.
251 // If you are having problems with incorrectly positioned astronomical
252 // bodies, this is a really good place to start looking.
254 time_t get_start_gmt(int year) {
257 // For now we assume that if daylight is not defined in
258 // /usr/include/time.h that we have a machine with a BSD behaving
260 # if !defined(HAVE_DAYLIGHT)
261 # define MK_TIME_IS_GMT 1
264 // timezone seems to work as a proper offset for Linux & Solaris
265 # if defined( __linux__ ) || defined( __sun__ )
266 # define TIMEZONE_OFFSET_WORKS 1
275 mt.tm_isdst = -1; // let the system determine the proper time zone
277 # if defined( MK_TIME_IS_GMT )
278 return ( mktime(&mt) );
279 # else // ! defined ( MK_TIME_IS_GMT )
281 long int start = mktime(&mt);
283 fgPrintf( FG_EVENT, FG_DEBUG, "start1 = %ld\n", start);
284 // the ctime() call can screw up time progression on some versions
286 // fgPrintf( FG_EVENT, FG_DEBUG, "start2 = %s", ctime(&start));
287 fgPrintf( FG_EVENT, FG_DEBUG, "(tm_isdst = %d)\n", mt.tm_isdst);
289 timezone = fix_up_timezone( timezone );
291 # if defined( TIMEZONE_OFFSET_WORKS )
292 fgPrintf( FG_EVENT, FG_DEBUG,
293 "start = %ld, timezone = %ld\n", start, timezone );
294 return( start - timezone );
295 # else // ! defined( TIMEZONE_OFFSET_WORKS )
297 daylight = mt.tm_isdst;
298 if ( daylight > 0 ) {
300 } else if ( daylight < 0 ) {
301 fgPrintf( FG_EVENT, FG_WARN,
302 "OOOPS, problem in fg_time.cxx, no daylight savings info.\n");
305 long int offset = -(timezone / 3600 - daylight);
307 fgPrintf( FG_EVENT, FG_DEBUG,
308 " Raw time zone offset = %ld\n", timezone);
309 fgPrintf( FG_EVENT, FG_DEBUG,
310 " Daylight Savings = %d\n", daylight);
311 fgPrintf( FG_EVENT, FG_DEBUG,
312 " Local hours from GMT = %ld\n", offset);
314 long int start_gmt = start - timezone + (daylight * 3600);
316 fgPrintf( FG_EVENT, FG_DEBUG, " March 21 noon (CST) = %ld\n", start);
318 return ( start_gmt );
319 # endif // ! defined( TIMEZONE_OFFSET_WORKS )
320 # endif // ! defined ( MK_TIME_IS_GMT )
324 // return a courser but cheaper estimate of sidereal time
325 double sidereal_course(struct tm *gmt, time_t now, double lng) {
327 double diff, part, days, hours, lst;
329 start_gmt = get_start_gmt(gmt->tm_year);
331 fgPrintf(FG_EVENT, FG_DEBUG,
332 " COURSE: GMT = %d/%d/%2d %d:%02d:%02d\n",
333 gmt->tm_mon, gmt->tm_mday, gmt->tm_year,
334 gmt->tm_hour, gmt->tm_min, gmt->tm_sec);
336 fgPrintf( FG_EVENT, FG_DEBUG, " March 21 noon (GMT) = %ld\n", start_gmt);
338 diff = (now - start_gmt) / (3600.0 * 24.0);
340 fgPrintf( FG_EVENT, FG_DEBUG,
341 " Time since 3/21/%2d GMT = %.2f\n", gmt->tm_year, diff);
343 part = fmod(diff, 1.0);
345 hours = gmt->tm_hour + gmt->tm_min/60.0 + gmt->tm_sec/3600.0;
347 lst = (days - lng)/15.0 + hours - 12;
349 while ( lst < 0.0 ) {
353 fgPrintf( FG_EVENT, FG_DEBUG,
354 " days = %.1f hours = %.2f lon = %.2f lst = %.2f\n",
355 days, hours, lng, lst);
361 // Update time variables such as gmt, julian date, and sidereal time
362 void fgTimeUpdate(fgFLIGHT *f, fgTIME *t) {
363 double gst_precise, gst_course;
365 fgPrintf( FG_EVENT, FG_BULK, "Updating time\n");
367 // get current Unix calendar time (in seconds)
368 t->warp += t->warp_delta;
369 t->cur_time = time(NULL) + t->warp;
370 fgPrintf( FG_EVENT, FG_BULK,
371 " Current Unix calendar time = %ld warp = %ld delta = %ld\n",
372 t->cur_time, t->warp, t->warp_delta);
374 if ( t->warp_delta ) {
375 // time is changing so force an update
376 local_update_sky_and_lighting_params();
379 // get GMT break down for current time
380 t->gmt = gmtime(&t->cur_time);
381 fgPrintf( FG_EVENT, FG_BULK,
382 " Current GMT = %d/%d/%2d %d:%02d:%02d\n",
383 t->gmt->tm_mon+1, t->gmt->tm_mday, t->gmt->tm_year,
384 t->gmt->tm_hour, t->gmt->tm_min, t->gmt->tm_sec);
386 // calculate modified Julian date
387 t->mjd = cal_mjd ((int)(t->gmt->tm_mon+1), (double)t->gmt->tm_mday,
388 (int)(t->gmt->tm_year + 1900));
390 // add in partial day
391 t->mjd += (t->gmt->tm_hour / 24.0) + (t->gmt->tm_min / (24.0 * 60.0)) +
392 (t->gmt->tm_sec / (24.0 * 60.0 * 60.0));
394 // convert "back" to Julian date + partial day (as a fraction of one)
395 t->jd = t->mjd + MJD0;
396 fgPrintf( FG_EVENT, FG_BULK, " Current Julian Date = %.5f\n", t->jd);
398 // printf(" Current Longitude = %.3f\n", FG_Longitude * RAD_TO_DEG);
400 // Calculate local side real time
401 if ( t->gst_diff < -100.0 ) {
402 // first time through do the expensive calculation & cheap
403 // calculation to get the difference.
404 fgPrintf( FG_EVENT, FG_INFO, " First time, doing precise gst\n");
405 t->gst = gst_precise = sidereal_precise(t->mjd, 0.00);
406 gst_course = sidereal_course(t->gmt, t->cur_time, 0.00);
407 t->gst_diff = gst_precise - gst_course;
410 sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
413 // course + difference should drift off very slowly
415 sidereal_course(t->gmt, t->cur_time, 0.00) + t->gst_diff;
417 sidereal_course(t->gmt, t->cur_time, -(FG_Longitude * RAD_TO_DEG))
420 fgPrintf( FG_EVENT, FG_DEBUG,
421 " Current lon=0.00 Sidereal Time = %.3f\n", t->gst);
422 fgPrintf( FG_EVENT, FG_DEBUG,
423 " Current LOCAL Sidereal Time = %.3f (%.3f) (diff = %.3f)\n",
424 t->lst, sidereal_precise(t->mjd, -(FG_Longitude * RAD_TO_DEG)),
430 // Revision 1.14 1998/08/05 00:20:07 curt
431 // Added a local routine to update lighting params every frame when time is
434 // Revision 1.13 1998/07/30 23:48:55 curt
438 // Revision 1.12 1998/07/27 18:42:22 curt
439 // Added a pause option.
441 // Revision 1.11 1998/07/22 21:45:37 curt
442 // fg_time.cxx: Removed call to ctime() in a printf() which should be harmless
443 // but seems to be triggering a bug.
444 // light.cxx: Added code to adjust fog color based on sunrise/sunset effects
445 // and view orientation. This is an attempt to match the fog color to the
446 // sky color in the center of the screen. You see discrepancies at the
447 // edges, but what else can be done?
448 // sunpos.cxx: Caculate local direction to sun here. (what compass direction
449 // do we need to face to point directly at sun)
451 // Revision 1.10 1998/07/13 21:02:07 curt
452 // Wrote access functions for current fgOPTIONS.
454 // Revision 1.9 1998/06/12 00:59:53 curt
455 // Build only static libraries.
456 // Declare memmove/memset for Sloaris.
457 // Rewrote fg_time.c routine to get LST start seconds to better handle
458 // Solaris, and be easier to port, and understand the GMT vs. local
461 // Revision 1.8 1998/06/05 18:18:13 curt
462 // Incorporated some automake conditionals to try to support mktime() correctly
463 // on a wider variety of platforms.
464 // Added the declaration of memmove needed by the stl which apparently
465 // solaris only defines for cc compilations and not for c++ (__STDC__)
467 // Revision 1.7 1998/05/30 01:57:25 curt
470 // Revision 1.6 1998/05/02 01:53:17 curt
471 // Fine tuning mktime() support because of varying behavior on different
474 // Revision 1.5 1998/04/28 21:45:34 curt
475 // Fixed a horible bug that cause the time to be *WAY* off when compiling
476 // with the CygWin32 compiler. This may not yet completely address other
477 // Win32 compilers, but we'll have to take them on a case by case basis.
479 // Revision 1.4 1998/04/28 01:22:16 curt
480 // Type-ified fgTIME and fgVIEW.
482 // Revision 1.3 1998/04/25 22:06:33 curt
483 // Edited cvs log messages in source files ... bad bad bad!
485 // Revision 1.2 1998/04/25 20:24:02 curt
486 // Cleaned up initialization sequence to eliminate interdependencies
487 // between sun position, lighting, and view position. This creates a
488 // valid single pass initialization path.
490 // Revision 1.1 1998/04/24 00:52:27 curt
491 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
493 // Separated out lighting calcs into their own file.
495 // Revision 1.41 1998/04/22 13:24:05 curt
496 // C++ - ifiing the code a bit.
497 // Starting to reorginize some of the lighting calcs to use a table lookup.
499 // Revision 1.40 1998/04/18 04:14:09 curt
500 // Moved fg_debug.c to it's own library.
502 // Revision 1.39 1998/04/09 18:40:14 curt
503 // We had unified some of the platform disparate time handling code, and
504 // there was a bug in timesum() which calculated a new time stamp based on
505 // the current time stamp + offset. This hosed the periodic event processing
506 // logic because you'd never arrive at the time the event was scheduled for.
507 // Sky updates and lighting changes are handled via this event mechanism so
508 // they never changed ... it is fixed now.
510 // Revision 1.38 1998/04/08 23:35:40 curt
511 // Tweaks to Gnu automake/autoconf system.
513 // Revision 1.37 1998/04/03 22:12:55 curt
514 // Converting to Gnu autoconf system.
515 // Centralized time handling differences.
517 // Revision 1.36 1998/03/09 22:48:09 curt
518 // Debug message tweaks.
520 // Revision 1.35 1998/02/09 15:07:52 curt
523 // Revision 1.34 1998/02/07 15:29:47 curt
524 // Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
525 // <chotchkiss@namg.us.anritsu.com>
527 // Revision 1.33 1998/02/02 20:54:04 curt
528 // Incorporated Durk's changes.
530 // Revision 1.32 1998/02/01 03:39:56 curt
533 // Revision 1.31 1998/01/27 00:48:06 curt
534 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
535 // system and commandline/config file processing code.
537 // Revision 1.30 1998/01/21 21:11:35 curt
540 // Revision 1.29 1998/01/19 19:27:20 curt
541 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
542 // This should simplify things tremendously.
544 // Revision 1.28 1998/01/19 18:35:49 curt
545 // Minor tweaks and fixes for cygwin32.
547 // Revision 1.27 1998/01/13 00:23:13 curt
548 // Initial changes to support loading and management of scenery tiles. Note,
549 // there's still a fair amount of work left to be done.
551 // Revision 1.26 1998/01/05 18:44:36 curt
552 // Add an option to advance/decrease time from keyboard.
554 // Revision 1.25 1997/12/31 17:46:50 curt
555 // Tweaked fg_time.c to be able to use ftime() instead of gettimeofday()
557 // Revision 1.24 1997/12/30 22:22:42 curt
558 // Further integration of event manager.
560 // Revision 1.23 1997/12/30 20:47:58 curt
561 // Integrated new event manager with subsystem initializations.
563 // Revision 1.22 1997/12/30 01:38:47 curt
564 // Switched back to per vertex normals and smooth shading for terrain.
566 // Revision 1.21 1997/12/23 04:58:39 curt
567 // Tweaked the sky coloring a bit to build in structures to allow finer rgb
570 // Revision 1.20 1997/12/15 23:55:06 curt
571 // Add xgl wrappers for debugging.
572 // Generate terrain normals on the fly.
574 // Revision 1.19 1997/12/15 20:59:10 curt
577 // Revision 1.18 1997/12/12 21:41:31 curt
578 // More light/material property tweaking ... still a ways off.
580 // Revision 1.17 1997/12/12 19:53:04 curt
581 // Working on lightling and material properties.
583 // Revision 1.16 1997/12/11 04:43:57 curt
584 // Fixed sun vector and lighting problems. I thing the moon is now lit
587 // Revision 1.15 1997/12/10 22:37:54 curt
588 // Prepended "fg" on the name of all global structures that didn't have it yet.
589 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
591 // Revision 1.14 1997/12/10 01:19:52 curt
592 // Tweaks for verion 0.15 release.
594 // Revision 1.13 1997/12/09 05:11:56 curt
595 // Working on tweaking lighting.
597 // Revision 1.12 1997/12/09 04:25:37 curt
598 // Working on adding a global lighting params structure.
600 // Revision 1.11 1997/11/25 19:25:40 curt
601 // Changes to integrate Durk's moon/sun code updates + clean up.
603 // Revision 1.10 1997/11/15 18:16:42 curt
606 // Revision 1.9 1997/11/14 00:26:50 curt
607 // Transform scenery coordinates earlier in pipeline when scenery is being
608 // created, not when it is being loaded. Precalculate normals for each node
609 // as average of the normals of each containing polygon so Garoude shading is
612 // Revision 1.8 1997/10/25 03:30:08 curt
615 // Revision 1.7 1997/09/23 00:29:50 curt
616 // Tweaks to get things to compile with gcc-win32.
618 // Revision 1.6 1997/09/20 03:34:34 curt
619 // Still trying to get those durned stars aligned properly.
621 // Revision 1.5 1997/09/16 22:14:52 curt
622 // Tweaked time of day lighting equations. Don't draw stars during the day.
624 // Revision 1.4 1997/09/16 15:50:31 curt
625 // Working on star alignment and time issues.
627 // Revision 1.3 1997/09/13 02:00:08 curt
628 // Mostly working on stars and generating sidereal time for accurate star
631 // Revision 1.2 1997/08/27 03:30:35 curt
632 // Changed naming scheme of basic shared structures.
634 // Revision 1.1 1997/08/13 21:55:59 curt