gstreamer/gst/gstdatetime.h
Niels De Graef 09141c6e1f Use G_DEFINE_AUTOPTR_CLEANUP_FUNC unconditionally
Since we started depending on GLib 2.44, we can be sure this macro is
defined (it will be a no-op on compilers that don't support it). For
plugins we should just start using `G_DECLARE_FINAL_TYPE` which means
we no longer need the macro there, but for most types in core we don't
want to break ABI, which means it's better to just keep it like it is
(and use the `#ifdef` instead).
2019-06-04 08:50:59 +02:00

161 lines
5.1 KiB
C

/* GStreamer
* Copyright (C) 2010 Thiago Santos <thiago.sousa.santos@collabora.co.uk>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* 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., 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
/**
* GstDateTime:
*
* Opaque, immutable, refcounted struct that stores date, time and timezone
* information. It currently supports ranges from 0001-01-01 to
* 9999-12-31 in the Gregorian proleptic calendar.
*
* Use the accessor functions to get the stored values.
*/
typedef struct _GstDateTime GstDateTime;
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);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstDateTime, gst_date_time_unref)
G_END_DECLS
#endif /* __GST_DATE_TIME_H__ */