*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#ifndef __GST_DATE_TIME_H__
#define __GST_DATE_TIME_H__
+#include <gst/gstconfig.h>
+
#include <time.h>
#include <glib.h>
+#include <glib-object.h>
G_BEGIN_DECLS
* information. It currently supports ranges from 0001-01-01 to
* 9999-12-31 in the Gregorian proleptic calendar.
*
- * Use the acessor functions to get the stored values.
+ * Use the accessor functions to get the stored values.
*/
typedef struct _GstDateTime GstDateTime;
-gint gst_date_time_get_year (const GstDateTime * datetime);
-gint gst_date_time_get_month (const GstDateTime * datetime);
-gint gst_date_time_get_day (const GstDateTime * datetime);
-gint gst_date_time_get_hour (const GstDateTime * datetime);
-gint gst_date_time_get_minute (const GstDateTime * datetime);
-gint gst_date_time_get_second (const GstDateTime * datetime);
-gint gst_date_time_get_microsecond (const GstDateTime * datetime);
-gfloat gst_date_time_get_time_zone_offset (const GstDateTime * datetime);
-
-GstDateTime *gst_date_time_new_from_unix_epoch_local_time (gint64 secs);
-GstDateTime *gst_date_time_new_from_unix_epoch_utc (gint64 secs);
-GstDateTime *gst_date_time_new_local_time (gint year, gint month,
- gint day, gint hour,
- gint minute,
- gdouble seconds);
-GstDateTime *gst_date_time_new (gfloat tzoffset,
- gint year, gint month,
- gint day, gint hour,
- gint minute,
- gdouble seconds);
-GstDateTime *gst_date_time_new_now_local_time (void);
-GstDateTime *gst_date_time_new_now_utc (void);
-
-GstDateTime *gst_date_time_ref (GstDateTime * datetime);
-void gst_date_time_unref (GstDateTime * datetime);
+GST_API GType _gst_date_time_type;
+
+/**
+ * GST_TYPE_DATE_TIME:
+ *
+ * a boxed #GValue type for #GstDateTime that represents a date and time.
+ *
+ * Returns: the #GType of GstDateTime
+ */
+
+#define GST_TYPE_DATE_TIME (_gst_date_time_type)
+
+GST_API
+GType gst_date_time_get_type (void);
+
+/* query which fields are set */
+
+GST_API
+gboolean gst_date_time_has_year (const GstDateTime * datetime);
+
+GST_API
+gboolean gst_date_time_has_month (const GstDateTime * datetime);
+
+GST_API
+gboolean gst_date_time_has_day (const GstDateTime * datetime);
+
+GST_API
+gboolean gst_date_time_has_time (const GstDateTime * datetime);
+
+GST_API
+gboolean gst_date_time_has_second (const GstDateTime * datetime);
+
+/* field getters */
+
+GST_API
+gint gst_date_time_get_year (const GstDateTime * datetime);
+
+GST_API
+gint gst_date_time_get_month (const GstDateTime * datetime);
+
+GST_API
+gint gst_date_time_get_day (const GstDateTime * datetime);
+
+GST_API
+gint gst_date_time_get_hour (const GstDateTime * datetime);
+
+GST_API
+gint gst_date_time_get_minute (const GstDateTime * datetime);
+
+GST_API
+gint gst_date_time_get_second (const GstDateTime * datetime);
+
+GST_API
+gint gst_date_time_get_microsecond (const GstDateTime * datetime);
+
+GST_API
+gfloat gst_date_time_get_time_zone_offset (const GstDateTime * datetime);
+
+/* constructors */
+
+GST_API
+GstDateTime * gst_date_time_new_from_unix_epoch_local_time (gint64 secs) G_GNUC_MALLOC;
+
+GST_API
+GstDateTime * gst_date_time_new_from_unix_epoch_utc (gint64 secs) G_GNUC_MALLOC;
+
+GST_API
+GstDateTime * gst_date_time_new_local_time (gint year,
+ gint month,
+ gint day,
+ gint hour,
+ gint minute,
+ gdouble seconds) G_GNUC_MALLOC;
+GST_API
+GstDateTime * gst_date_time_new_y (gint year) G_GNUC_MALLOC;
+
+GST_API
+GstDateTime * gst_date_time_new_ym (gint year,
+ gint month) G_GNUC_MALLOC;
+GST_API
+GstDateTime * gst_date_time_new_ymd (gint year,
+ gint month,
+ gint day) G_GNUC_MALLOC;
+GST_API
+GstDateTime * gst_date_time_new (gfloat tzoffset,
+ gint year, gint month,
+ gint day, gint hour,
+ gint minute,
+ gdouble seconds) G_GNUC_MALLOC;
+GST_API
+GstDateTime * gst_date_time_new_now_local_time (void) G_GNUC_MALLOC;
+
+GST_API
+GstDateTime * gst_date_time_new_now_utc (void) G_GNUC_MALLOC;
+
+GST_API
+gchar * gst_date_time_to_iso8601_string (GstDateTime * datetime) G_GNUC_MALLOC;
+
+GST_API
+GstDateTime * gst_date_time_new_from_iso8601_string (const gchar * string) G_GNUC_MALLOC;
+
+GST_API
+GDateTime * gst_date_time_to_g_date_time (GstDateTime * datetime);
+
+GST_API
+GstDateTime * gst_date_time_new_from_g_date_time (GDateTime * dt);
+
+/* refcounting */
+
+GST_API
+GstDateTime * gst_date_time_ref (GstDateTime * datetime);
+
+GST_API
+void gst_date_time_unref (GstDateTime * datetime);
+
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstDateTime, gst_date_time_unref)
+#endif
G_END_DECLS
+
#endif /* __GST_DATE_TIME_H__ */
projects / platform / upstream / gstreamer.git / blobdiff