2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstclock.h: Header for clock subsystem
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_CLOCK_H__
24 #define __GST_CLOCK_H__
26 #include <gst/gstobject.h>
30 /* --- standard type macros --- */
31 #define GST_TYPE_CLOCK (gst_clock_get_type ())
32 #define GST_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_CAST ((clock), GST_TYPE_CLOCK, GstClock))
33 #define GST_IS_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_TYPE ((clock), GST_TYPE_CLOCK))
34 #define GST_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_CAST ((cclass), GST_TYPE_CLOCK, GstClockClass))
35 #define GST_IS_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_TYPE ((cclass), GST_TYPE_CLOCK))
36 #define GST_CLOCK_GET_CLASS(clock) (G_TYPE_INSTANCE_GET_CLASS ((clock), GST_TYPE_CLOCK, GstClockClass))
38 typedef guint64 GstClockTime;
39 typedef gint64 GstClockTimeDiff;
40 typedef gpointer GstClockID;
42 #define GST_CLOCK_TIME_NONE ((GstClockTime)-1)
43 #define GST_CLOCK_TIME_IS_VALID(time) ((time) != GST_CLOCK_TIME_NONE)
45 #define GST_SECOND ((guint64) G_USEC_PER_SEC * G_GINT64_CONSTANT (1000))
46 #define GST_MSECOND ((guint64) GST_SECOND / G_GINT64_CONSTANT (1000))
47 #define GST_USECOND ((guint64) GST_SECOND / G_GINT64_CONSTANT (1000000))
48 #define GST_NSECOND ((guint64) GST_SECOND / G_GINT64_CONSTANT (1000000000))
50 #define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((s) - (e))
51 #define GST_TIMEVAL_TO_TIME(tv) ((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
52 #define GST_TIME_TO_TIMEVAL(t,tv) \
54 (tv).tv_sec = (t) / GST_SECOND; \
55 (tv).tv_usec = ((t) / GST_USECOND) % GST_MSECOND; \
58 #define GST_CLOCK_ENTRY_TRACE_NAME "GstClockEntry"
60 typedef struct _GstClockEntry GstClockEntry;
61 typedef struct _GstClock GstClock;
62 typedef struct _GstClockClass GstClockClass;
64 /* --- prototype for async callbacks --- */
65 typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
66 GstClockID id, gpointer user_data);
69 /* --- protected --- */
71 GST_CLOCK_ENTRY_EARLY,
72 GST_CLOCK_ENTRY_RESTART
73 } GstClockEntryStatus;
76 /* --- protected --- */
77 GST_CLOCK_ENTRY_SINGLE,
78 GST_CLOCK_ENTRY_PERIODIC
81 #define GST_CLOCK_ENTRY(entry) ((GstClockEntry *)(entry))
82 #define GST_CLOCK_ENTRY_CLOCK(entry) ((entry)->clock)
83 #define GST_CLOCK_ENTRY_TYPE(entry) ((entry)->type)
84 #define GST_CLOCK_ENTRY_TIME(entry) ((entry)->time)
85 #define GST_CLOCK_ENTRY_INTERVAL(entry) ((entry)->interval)
86 #define GST_CLOCK_ENTRY_STATUS(entry) ((entry)->status)
88 struct _GstClockEntry {
89 /* --- protected --- */
91 GstClockEntryType type;
93 GstClockTime interval;
94 GstClockEntryStatus status;
95 GstClockCallback func;
101 GST_CLOCK_STOPPED = 0,
102 GST_CLOCK_TIMEOUT = 1,
105 GST_CLOCK_UNSUPPORTED = 4
110 GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC = (1 << 1),
111 GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC = (1 << 2),
112 GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC = (1 << 3),
113 GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC = (1 << 4),
114 GST_CLOCK_FLAG_CAN_SET_RESOLUTION = (1 << 5),
115 GST_CLOCK_FLAG_CAN_SET_SPEED = (1 << 6)
118 #define GST_CLOCK_FLAGS(clock) (GST_CLOCK(clock)->flags)
125 /* --- protected --- */
126 GstClockTime start_time;
127 GstClockTime last_time;
130 /* --- private --- */
133 GMutex *active_mutex;
137 GstClockTime last_event;
138 GstClockTime max_event_diff;
140 gpointer _gst_reserved[GST_PADDING];
143 struct _GstClockClass {
144 GstObjectClass parent_class;
147 gdouble (*change_speed) (GstClock *clock,
148 gdouble oldspeed, gdouble newspeed);
149 gdouble (*get_speed) (GstClock *clock);
150 guint64 (*change_resolution) (GstClock *clock, guint64 old_resolution,
151 guint64 new_resolution);
152 guint64 (*get_resolution) (GstClock *clock);
154 GstClockTime (*get_internal_time) (GstClock *clock);
156 /* waiting on an ID */
157 GstClockEntryStatus (*wait) (GstClock *clock, GstClockEntry *entry);
158 GstClockEntryStatus (*wait_async) (GstClock *clock, GstClockEntry *entry);
159 void (*unschedule) (GstClock *clock, GstClockEntry *entry);
160 void (*unlock) (GstClock *clock, GstClockEntry *entry);
161 gpointer _gst_reserved[GST_PADDING];
164 GType gst_clock_get_type (void);
166 #ifndef GST_DISABLE_DEPRECATED
167 gdouble gst_clock_set_speed (GstClock *clock, gdouble speed);
168 gdouble gst_clock_get_speed (GstClock *clock);
171 guint64 gst_clock_set_resolution (GstClock *clock, guint64 resolution);
172 guint64 gst_clock_get_resolution (GstClock *clock);
174 #ifndef GST_DISABLE_DEPRECATED
175 void gst_clock_set_active (GstClock *clock, gboolean active);
176 gboolean gst_clock_is_active (GstClock *clock);
177 void gst_clock_reset (GstClock *clock);
178 gboolean gst_clock_handle_discont (GstClock *clock, guint64 time);
181 GstClockTime gst_clock_get_time (GstClock *clock);
182 GstClockTime gst_clock_get_event_time (GstClock *clock);
185 /* FIXME: deprecate? */
186 #ifndef GST_DISABLE_DEPRECATED
187 GstClockID gst_clock_get_next_id (GstClock *clock);
189 /* creating IDs that can be used to get notifications */
190 GstClockID gst_clock_new_single_shot_id (GstClock *clock,
192 GstClockID gst_clock_new_periodic_id (GstClock *clock,
193 GstClockTime start_time,
194 GstClockTime interval);
196 /* operations on IDs */
197 GstClockTime gst_clock_id_get_time (GstClockID id);
198 GstClockReturn gst_clock_id_wait (GstClockID id,
199 GstClockTimeDiff *jitter);
200 GstClockReturn gst_clock_id_wait_async (GstClockID id,
201 GstClockCallback func,
203 void gst_clock_id_unschedule (GstClockID id);
204 void gst_clock_id_unlock (GstClockID id);
205 void gst_clock_id_free (GstClockID id);
211 #endif /* __GST_CLOCK_H__ */