2 * Copyright (C) 2010 Thiago Santos <thiago.sousa.santos@collabora.co.uk>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
24 #include "glib-compat-private.h"
25 #include "gst_private.h"
26 #include "gstdatetime.h"
33 * @short_description: A date, time and timezone structure
35 * Struct to store date, time and timezone information altogether.
36 * #GstDateTime is refcounted and immutable.
38 * Date information is handled using the proleptic Gregorian calendar.
40 * Provides basic creation functions and accessor functions to its fields.
46 * gst_date_time_get_year:
47 * @datetime: a #GstDateTime
49 * Returns the year of this #GstDateTime
51 * Return value: The year of this #GstDateTime
56 * gst_date_time_get_month:
57 * @datetime: a #GstDateTime
59 * Returns the month of this #GstDateTime. January is 1, February is 2, etc..
61 * Return value: The month of this #GstDateTime
66 * gst_date_time_get_day:
67 * @datetime: a #GstDateTime
69 * Returns the day of this #GstDateTime.
71 * Return value: The day of this #GstDateTime
76 * gst_date_time_get_hour:
77 * @datetime: a #GstDateTime
79 * Retrieves the hour of the day represented by @datetime in the gregorian
80 * calendar. The return is in the range of 0 to 23.
82 * Return value: the hour of the day
88 * gst_date_time_get_microsecond:
89 * @datetime: a #GstDateTime
91 * Retrieves the fractional part of the seconds in microseconds represented by
92 * @datetime in the gregorian calendar.
94 * Return value: the microsecond of the second
100 * gst_date_time_get_minute:
101 * @datetime: a #GstDateTime
103 * Retrieves the minute of the hour represented by @datetime in the gregorian
106 * Return value: the minute of the hour
112 * gst_date_time_get_second:
113 * @datetime: a #GstDateTime
115 * Retrieves the second of the minute represented by @datetime in the gregorian
118 * Return value: the second represented by @datetime
124 * gst_date_time_get_second:
125 * @datetime: a #GstDateTime
127 * Retrieves the second of the minute represented by @datetime in the gregorian
130 * Return value: the second represented by @datetime
136 * gst_date_time_get_time_zone_offset:
137 * @datetime: a #GstDateTime
139 * Retrieves the offset from UTC in hours that the timezone specified
140 * by @datetime represents. Timezones ahead (to the east) of UTC have positive
141 * values, timezones before (to the west) of UTC have negative values.
142 * If @datetime represents UTC time, then the offset is zero.
144 * Return value: the offset from UTC in hours
149 * gst_date_time_new_from_unix_epoch_local_time:
150 * @secs: seconds from the Unix epoch
152 * Creates a new #GstDateTime using the time since Jan 1, 1970 specified by
153 * @secs. The #GstDateTime is in the local timezone.
155 * Return value: the newly created #GstDateTime
161 * gst_date_time_new_from_unix_epoch_utc:
162 * @secs: seconds from the Unix epoch
164 * Creates a new #GstDateTime using the time since Jan 1, 1970 specified by
165 * @secs. The #GstDateTime is in the UTC timezone.
167 * Return value: the newly created #GstDateTime
173 * gst_date_time_new_local_time:
174 * @year: the gregorian year
175 * @month: the gregorian month
176 * @day: the day of the gregorian month
177 * @hour: the hour of the day
178 * @minute: the minute of the hour
179 * @second: the second of the minute
180 * @microsecond: the microsecond of the second
182 * Creates a new #GstDateTime using the date and times in the gregorian calendar
183 * in the local timezone.
185 * @year should be from 1 to 9999, @month should be from 1 to 12, @day from
186 * 1 to 31, @hour from 0 to 23, @minutes and @seconds from 0 to 59 and
187 * @microsecond from 0 to 999999.
189 * Return value: the newly created #GstDateTime
196 * @tzoffset: Offset from UTC in hours.
197 * @year: the gregorian year
198 * @month: the gregorian month
199 * @day: the day of the gregorian month
200 * @hour: the hour of the day
201 * @minute: the minute of the hour
202 * @second: the second of the minute
203 * @microsecond: the microsecond of the second
205 * Creates a new #GstDateTime using the date and times in the gregorian calendar
206 * in the supplied timezone.
208 * @year should be from 1 to 9999, @month should be from 1 to 12, @day from
209 * 1 to 31, @hour from 0 to 23, @minutes and @seconds from 0 to 59 and
210 * @microsecond from 0 to 999999.
212 * Note that @tzoffset is a float and was chosen so for being able to handle
213 * some fractional timezones, while it still keeps the readability of
214 * represeting it in hours for most timezones.
216 * Return value: the newly created #GstDateTime
222 * gst_date_time_new_now_local_time:
224 * Creates a new #GstDateTime representing the current date and time.
226 * Return value: the newly created #GstDateTime which should be freed with
227 * gst_date_time_unref().
233 * gst_date_time_new_now_utc:
235 * Creates a new #GstDateTime that represents the current instant at Universal
238 * Return value: the newly created #GstDateTime which should be freed with
239 * gst_date_time_unref().
245 #define GST_DATE_TIME_SEC_PER_DAY (G_GINT64_CONSTANT (86400))
246 #define GST_DATE_TIME_USEC_PER_DAY (G_GINT64_CONSTANT (86400000000))
247 #define GST_DATE_TIME_USEC_PER_HOUR (G_GINT64_CONSTANT (3600000000))
248 #define GST_DATE_TIME_USEC_PER_MINUTE (G_GINT64_CONSTANT (60000000))
249 #define GST_DATE_TIME_USEC_PER_SECOND (G_GINT64_CONSTANT (1000000))
250 #define GST_DATE_TIME_USEC_PER_MILLISECOND (G_GINT64_CONSTANT (1000))
252 #ifndef GLIB_HAS_GDATETIME
254 #define MAX_SUPPORTED_YEAR 9999
255 #define GREGORIAN_LEAP(y) (((y%4)==0)&&(!(((y%100)==0)&&((y%400)!=0))))
257 static const guint16 days_in_months[2][13] = {
258 {0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31},
259 {0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31}
265 * As we don't have a datetime math API, we can have fields split here.
266 * (There is still some math done internally, but nothing really relevant).
268 * If we ever add one, we should go for a days since some epoch counter.
269 * (Proleptic Gregorian with 0001-01-01 as day 1)
274 guint64 usec; /* Microsecond timekeeping within Day */
278 volatile gint ref_count;
282 * Returns the utc offset in seconds for this time structure
285 gmt_offset (struct tm *tm, time_t t)
287 #if defined (HAVE_TM_GMTOFF)
288 return tm->tm_gmtoff;
298 return (int) difftime (t, t2);
303 gst_date_time_set_local_timezone (GstDateTime * dt)
308 g_return_if_fail (dt != NULL);
310 memset (&tt, 0, sizeof (tt));
312 tt.tm_mday = gst_date_time_get_day (dt);
313 tt.tm_mon = gst_date_time_get_month (dt) - 1;
314 tt.tm_year = gst_date_time_get_year (dt) - 1900;
315 tt.tm_hour = gst_date_time_get_hour (dt);
316 tt.tm_min = gst_date_time_get_minute (dt);
317 tt.tm_sec = gst_date_time_get_second (dt);
321 dt->tzoffset = gmt_offset (&tt, t) / 60;
325 gst_date_time_alloc (void)
327 GstDateTime *datetime;
329 datetime = g_slice_new0 (GstDateTime);
330 datetime->ref_count = 1;
336 gst_date_time_free (GstDateTime * datetime)
338 g_slice_free (GstDateTime, datetime);
342 gst_date_time_new_from_date (gint year, gint month, gint day)
346 g_return_val_if_fail (year > 0 && year <= 9999, NULL);
347 g_return_val_if_fail ((month > 0 && month <= 12), NULL);
348 g_return_val_if_fail ((day > 0 && day <= 31), NULL);
350 dt = gst_date_time_alloc ();
355 gst_date_time_set_local_timezone (dt);
361 gst_date_time_get_year (const GstDateTime * datetime)
363 g_return_val_if_fail (datetime != NULL, 0);
365 return datetime->year;
369 gst_date_time_get_month (const GstDateTime * datetime)
371 g_return_val_if_fail (datetime != NULL, 0);
373 return datetime->month;
377 gst_date_time_get_day (const GstDateTime * datetime)
379 g_return_val_if_fail (datetime != NULL, 0);
381 return datetime->day;
385 gst_date_time_get_hour (const GstDateTime * datetime)
387 g_return_val_if_fail (datetime != NULL, 0);
388 return (datetime->usec / GST_DATE_TIME_USEC_PER_HOUR);
392 gst_date_time_get_microsecond (const GstDateTime * datetime)
394 g_return_val_if_fail (datetime != NULL, 0);
395 return (datetime->usec % GST_DATE_TIME_USEC_PER_SECOND);
399 gst_date_time_get_minute (const GstDateTime * datetime)
401 g_return_val_if_fail (datetime != NULL, 0);
402 return (datetime->usec % GST_DATE_TIME_USEC_PER_HOUR) /
403 GST_DATE_TIME_USEC_PER_MINUTE;
407 gst_date_time_get_second (const GstDateTime * datetime)
409 g_return_val_if_fail (datetime != NULL, 0);
410 return (datetime->usec % GST_DATE_TIME_USEC_PER_MINUTE) /
411 GST_DATE_TIME_USEC_PER_SECOND;
415 gst_date_time_get_time_zone_offset (const GstDateTime * datetime)
417 g_return_val_if_fail (datetime != NULL, 0);
419 return datetime->tzoffset / 60.0f;
423 gst_date_time_new_from_unix_epoch_local_time (gint64 secs)
429 memset (&tm, 0, sizeof (tm));
432 #ifdef HAVE_LOCALTIME_R
433 localtime_r (&tt, &tm);
435 memcpy (&tm, localtime (&tt), sizeof (struct tm));
438 dt = gst_date_time_new (0, tm.tm_year + 1900,
439 tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec);
440 gst_date_time_set_local_timezone (dt);
445 gst_date_time_new_from_unix_epoch_utc (gint64 secs)
451 memset (&tm, 0, sizeof (tm));
457 memcpy (&tm, gmtime (&tt), sizeof (struct tm));
460 dt = gst_date_time_new (0, tm.tm_year + 1900,
461 tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec);
466 gst_date_time_new_local_time (gint year, gint month, gint day, gint hour,
467 gint minute, gdouble seconds)
471 dt = gst_date_time_new (0, year, month, day, hour, minute, seconds);
473 gst_date_time_set_local_timezone (dt);
479 gst_date_time_new (gfloat tzoffset, gint year, gint month, gint day, gint hour,
480 gint minute, gdouble seconds)
484 g_return_val_if_fail (hour >= 0 && hour < 24, NULL);
485 g_return_val_if_fail (minute >= 0 && minute < 60, NULL);
486 g_return_val_if_fail (seconds >= 0 && seconds < 60, NULL);
487 g_return_val_if_fail (tzoffset >= -12.0 && tzoffset <= 12.0, NULL);
489 if (!(dt = gst_date_time_new_from_date (year, month, day)))
492 dt->usec = (hour * GST_DATE_TIME_USEC_PER_HOUR)
493 + (minute * GST_DATE_TIME_USEC_PER_MINUTE)
494 + (guint64) (floor (seconds * GST_DATE_TIME_USEC_PER_SECOND + 0.5));
496 /* we store in minutes */
497 dt->tzoffset = (gint) tzoffset *60.0;
503 gst_date_time_new_now_local_time (void)
505 GstDateTime *datetime;
507 g_get_current_time (&tv);
509 datetime = gst_date_time_new_from_unix_epoch_local_time (tv.tv_sec);
510 datetime->usec += tv.tv_usec;
511 gst_date_time_set_local_timezone (datetime);
516 gst_date_time_copy (const GstDateTime * dt)
518 GstDateTime *copy = gst_date_time_alloc ();
520 memcpy (copy, dt, sizeof (GstDateTime));
527 gst_date_time_to_utc (const GstDateTime * dt)
534 g_return_val_if_fail (dt != NULL, NULL);
536 utc = gst_date_time_copy (dt);
538 usec = dt->usec - dt->tzoffset * GST_DATE_TIME_USEC_PER_MINUTE;
539 days = usec / GST_DATE_TIME_USEC_PER_DAY;
544 leap = GREGORIAN_LEAP (utc->year) ? 1 : 0;
546 /* check if we should update month/year */
548 if (utc->month == 1) {
554 if (GREGORIAN_LEAP (utc->year))
555 utc->day = days_in_months[1][utc->month];
557 utc->day = days_in_months[0][utc->month];
558 } else if (utc->day > days_in_months[leap][utc->month]) {
559 if (utc->month == 12) {
570 GST_DATE_TIME_USEC_PER_DAY + (usec % GST_DATE_TIME_USEC_PER_DAY);
572 utc->usec = usec % GST_DATE_TIME_USEC_PER_DAY;
578 gst_date_time_new_now_utc (void)
580 GstDateTime *now, *utc;
582 now = gst_date_time_new_now_local_time ();
583 utc = gst_date_time_to_utc (now);
584 gst_date_time_unref (now);
589 priv_gst_date_time_compare (gconstpointer dt1, gconstpointer dt2)
594 a = gst_date_time_to_utc (dt1);
595 b = gst_date_time_to_utc (dt2);
597 #define GST_DATE_TIME_COMPARE_VALUE(a,b,v) \
598 if ((a)->v > (b)->v) { \
601 } else if ((a)->v < (b)->v) { \
606 GST_DATE_TIME_COMPARE_VALUE (a, b, year);
607 GST_DATE_TIME_COMPARE_VALUE (a, b, month);
608 GST_DATE_TIME_COMPARE_VALUE (a, b, day);
609 GST_DATE_TIME_COMPARE_VALUE (a, b, usec);
611 #undef GST_DATE_TIME_COMPARE_VALUE
614 gst_date_time_unref (a);
615 gst_date_time_unref (b);
625 volatile gint ref_count;
629 gst_date_time_new_from_gdatetime (GDateTime * dt)
636 gst_dt = g_slice_new (GstDateTime);
637 gst_dt->datetime = dt;
638 gst_dt->ref_count = 1;
643 gst_date_time_get_year (const GstDateTime * datetime)
645 return g_date_time_get_year (datetime->datetime);
649 gst_date_time_get_month (const GstDateTime * datetime)
651 return g_date_time_get_month (datetime->datetime);
655 gst_date_time_get_day (const GstDateTime * datetime)
657 return g_date_time_get_day_of_month (datetime->datetime);
661 gst_date_time_get_hour (const GstDateTime * datetime)
663 return g_date_time_get_hour (datetime->datetime);
667 gst_date_time_get_minute (const GstDateTime * datetime)
669 return g_date_time_get_minute (datetime->datetime);
673 gst_date_time_get_second (const GstDateTime * datetime)
675 return g_date_time_get_second (datetime->datetime);
679 gst_date_time_get_microsecond (const GstDateTime * datetime)
681 return g_date_time_get_microsecond (datetime->datetime);
685 gst_date_time_get_time_zone_offset (const GstDateTime * datetime)
687 return g_date_time_get_utc_offset (datetime->datetime) /
688 (G_USEC_PER_SEC * G_GINT64_CONSTANT (3600));
692 gst_date_time_new_from_unix_epoch_local_time (gint64 secs)
695 gst_date_time_new_from_gdatetime (g_date_time_new_from_unix_local (secs));
699 gst_date_time_new_from_unix_epoch_utc (gint64 secs)
702 gst_date_time_new_from_gdatetime (g_date_time_new_from_unix_utc (secs));
706 gst_date_time_new_local_time (gint year, gint month, gint day, gint hour,
707 gint minute, gdouble seconds)
709 return gst_date_time_new_from_gdatetime (g_date_time_new_local (year, month,
710 day, hour, minute, seconds));
714 gst_date_time_new_now_local_time (void)
716 return gst_date_time_new_from_gdatetime (g_date_time_new_now_local ());
720 gst_date_time_new_now_utc (void)
722 return gst_date_time_new_from_gdatetime (g_date_time_new_now_utc ());
726 priv_gst_date_time_compare (gconstpointer dt1, gconstpointer dt2)
728 const GstDateTime *datetime1 = dt1;
729 const GstDateTime *datetime2 = dt2;
730 return g_date_time_compare (datetime1->datetime, datetime2->datetime);
734 gst_date_time_new (gfloat tzoffset, gint year, gint month, gint day, gint hour,
735 gint minute, gdouble seconds)
740 gint tzhour, tzminute;
742 tzhour = (gint) ABS (tzoffset);
743 tzminute = (gint) ((ABS (tzoffset) - tzhour) * 60);
745 g_snprintf (buf, 6, "%c%02d%02d", tzoffset >= 0 ? '+' : '-', tzhour,
748 tz = g_time_zone_new (buf);
749 dt = g_date_time_new (tz, year, month, day, hour, minute, seconds);
750 g_time_zone_unref (tz);
751 return gst_date_time_new_from_gdatetime (dt);
755 gst_date_time_free (GstDateTime * datetime)
757 g_date_time_unref (datetime->datetime);
758 g_slice_free (GstDateTime, datetime);
765 * @datetime: a #GstDateTime
767 * Atomically increments the reference count of @datetime by one.
769 * Return value: the reference @datetime
774 gst_date_time_ref (GstDateTime * datetime)
776 g_return_val_if_fail (datetime != NULL, NULL);
777 g_return_val_if_fail (datetime->ref_count > 0, NULL);
778 g_atomic_int_inc (&datetime->ref_count);
783 * gst_date_time_unref:
784 * @datetime: a #GstDateTime
786 * Atomically decrements the reference count of @datetime by one. When the
787 * reference count reaches zero, the structure is freed.
792 gst_date_time_unref (GstDateTime * datetime)
794 g_return_if_fail (datetime != NULL);
795 g_return_if_fail (datetime->ref_count > 0);
797 if (g_atomic_int_dec_and_test (&datetime->ref_count))
798 gst_date_time_free (datetime);