gst/gstdatetime.h

   1 /* GStreamer
   2  * Copyright (C) 2010 Thiago Santos <thiago.sousa.santos@collabora.co.uk>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #ifndef __GST_DATE_TIME_H__
  21 #define __GST_DATE_TIME_H__
  22
  23 #include <time.h>
  24 #include <glib.h>
  25
  26 G_BEGIN_DECLS
  27
  28 /**
  29  * GstDateTime:
  30  *
  31  * Opaque, immutable, refcounted struct that stores date, time and timezone
  32  * information. It currently supports ranges from 0001-01-01 to
  33  * 9999-12-31 in the Gregorian proleptic calendar.
  34  *
  35  * Use the acessor functions to get the stored values.
  36  */
  37 typedef struct _GstDateTime GstDateTime;
  38
  39 /* query which fields are set */
  40
  41 gboolean        gst_date_time_has_year                (const GstDateTime * datetime);
  42 gboolean        gst_date_time_has_month               (const GstDateTime * datetime);
  43 gboolean        gst_date_time_has_day                 (const GstDateTime * datetime);
  44 gboolean        gst_date_time_has_time                (const GstDateTime * datetime);
  45 gboolean        gst_date_time_has_second              (const GstDateTime * datetime);
  46
  47 /* field getters */
  48
  49 gint            gst_date_time_get_year                (const GstDateTime * datetime);
  50 gint            gst_date_time_get_month               (const GstDateTime * datetime);
  51 gint            gst_date_time_get_day                 (const GstDateTime * datetime);
  52 gint            gst_date_time_get_hour                (const GstDateTime * datetime);
  53 gint            gst_date_time_get_minute              (const GstDateTime * datetime);
  54 gint            gst_date_time_get_second              (const GstDateTime * datetime);
  55 gint            gst_date_time_get_microsecond         (const GstDateTime * datetime);
  56 gfloat          gst_date_time_get_time_zone_offset    (const GstDateTime * datetime);
  57
  58 /* constructors */
  59
  60 GstDateTime *   gst_date_time_new_from_unix_epoch_local_time (gint64 secs) G_GNUC_MALLOC;
  61
  62 GstDateTime *   gst_date_time_new_from_unix_epoch_utc   (gint64 secs) G_GNUC_MALLOC;
  63
  64 GstDateTime *   gst_date_time_new_local_time            (gint year,
  65                                                          gint month,
  66                                                          gint day,
  67                                                          gint hour,
  68                                                          gint minute,
  69                                                          gdouble seconds) G_GNUC_MALLOC;
  70
  71 GstDateTime *   gst_date_time_new_y                     (gint year) G_GNUC_MALLOC;
  72
  73 GstDateTime *   gst_date_time_new_ym                    (gint year,
  74                                                          gint month) G_GNUC_MALLOC;
  75
  76 GstDateTime *   gst_date_time_new_ymd                   (gint year,
  77                                                          gint month,
  78                                                          gint day) G_GNUC_MALLOC;
  79
  80 GstDateTime *   gst_date_time_new                       (gfloat tzoffset,
  81                                                          gint year, gint month,
  82                                                          gint day, gint hour,
  83                                                          gint minute,
  84                                                          gdouble seconds) G_GNUC_MALLOC;
  85
  86 GstDateTime *   gst_date_time_new_now_local_time (void) G_GNUC_MALLOC;
  87
  88 GstDateTime *   gst_date_time_new_now_utc        (void) G_GNUC_MALLOC;
  89
  90 /* refcounting */
  91
  92 GstDateTime *   gst_date_time_ref                (GstDateTime * datetime);
  93
  94 void            gst_date_time_unref              (GstDateTime * datetime);
  95
  96 G_END_DECLS
  97
  98 #endif /* __GST_DATE_TIME_H__ */