gst/gstsystemclock.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstsystemclock.h: A clock implementation based on system time
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24
  25 #ifndef __GST_SYSTEM_CLOCK_H__
  26 #define __GST_SYSTEM_CLOCK_H__
  27
  28 #include <gst/gstclock.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_SYSTEM_CLOCK                   (gst_system_clock_get_type ())
  33 #define GST_SYSTEM_CLOCK(obj)                   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SYSTEM_CLOCK, GstSystemClock))
  34 #define GST_SYSTEM_CLOCK_CAST(obj)              ((GstSystemClock *)(obj))
  35 #define GST_IS_SYSTEM_CLOCK(obj)                (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SYSTEM_CLOCK))
  36 #define GST_SYSTEM_CLOCK_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SYSTEM_CLOCK, GstSystemClockClass))
  37 #define GST_IS_SYSTEM_CLOCK_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SYSTEM_CLOCK))
  38 #define GST_SYSTEM_CLOCK_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_SYSTEM_CLOCK, GstSystemClockClass))
  39
  40
  41 typedef struct _GstSystemClock GstSystemClock;
  42 typedef struct _GstSystemClockClass GstSystemClockClass;
  43 typedef struct _GstSystemClockPrivate GstSystemClockPrivate;
  44
  45 /**
  46  * GstClockType:
  47  * @GST_CLOCK_TYPE_REALTIME: time since Epoch
  48  * @GST_CLOCK_TYPE_MONOTONIC: monotonic time since some unspecified starting
  49  *                            point
  50  * @GST_CLOCK_TYPE_OTHER: some other time source is used (Since: 1.0.5)
  51  *
  52  * The different kind of clocks.
  53  */
  54 typedef enum {
  55   GST_CLOCK_TYPE_REALTIME       = 0,
  56   GST_CLOCK_TYPE_MONOTONIC      = 1,
  57   GST_CLOCK_TYPE_OTHER          = 2
  58 } GstClockType;
  59
  60 /**
  61  * GstSystemClock:
  62  *
  63  * The default implementation of a #GstClock that uses the system time.
  64  */
  65 struct _GstSystemClock {
  66   GstClock       clock;
  67
  68   /*< private >*/
  69   GstSystemClockPrivate *priv;
  70
  71   gpointer _gst_reserved[GST_PADDING];
  72 };
  73
  74 struct _GstSystemClockClass {
  75   GstClockClass  parent_class;
  76
  77   /*< private >*/
  78   gpointer _gst_reserved[GST_PADDING];
  79 };
  80
  81 GST_API
  82 GType                   gst_system_clock_get_type       (void);
  83
  84 GST_API
  85 GstClock*               gst_system_clock_obtain         (void);
  86
  87 GST_API
  88 void                    gst_system_clock_set_default    (GstClock *new_clock);
  89
  90 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
  91 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstSystemClock, gst_object_unref)
  92 #endif
  93
  94 G_END_DECLS
  95
  96 #endif /* __GST_SYSTEM_CLOCK_H__ */