2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2005 Wim Taymans <wim@fluendo.com>
5 * gstaudioclock.h: Clock for use by audio plugins
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_AUDIO_CLOCK_H__
24 #define __GST_AUDIO_CLOCK_H__
27 #include <gst/gstsystemclock.h>
31 #define GST_TYPE_AUDIO_CLOCK \
32 (gst_audio_clock_get_type())
33 #define GST_AUDIO_CLOCK(obj) \
34 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_AUDIO_CLOCK,GstAudioClock))
35 #define GST_AUDIO_CLOCK_CLASS(klass) \
36 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_AUDIO_CLOCK,GstAudioClockClass))
37 #define GST_IS_AUDIO_CLOCK(obj) \
38 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_AUDIO_CLOCK))
39 #define GST_IS_AUDIO_CLOCK_CLASS(klass) \
40 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_AUDIO_CLOCK))
41 #define GST_AUDIO_CLOCK_CAST(obj) \
42 ((GstAudioClock*)(obj))
44 typedef struct _GstAudioClock GstAudioClock;
45 typedef struct _GstAudioClockClass GstAudioClockClass;
48 * GstAudioClockGetTimeFunc:
49 * @clock: the #GstAudioClock
50 * @user_data: user data
52 * This function will be called whenever the current clock time needs to be
53 * calculated. If this function returns #GST_CLOCK_TIME_NONE, the last reported
54 * time will be returned by the clock.
56 * Returns: the current time or #GST_CLOCK_TIME_NONE if the previous time should
59 typedef GstClockTime (*GstAudioClockGetTimeFunc) (GstClock *clock, gpointer user_data);
63 * @clock: parent #GstSystemClock
65 * Opaque #GstAudioClock.
67 struct _GstAudioClock {
70 /* --- protected --- */
71 GstAudioClockGetTimeFunc func;
74 GstClockTime last_time;
79 GstClockTimeDiff time_offset;
80 GDestroyNotify destroy_notify;
82 /* adding + 0 to mark ABI change to be undone later */
83 gpointer _gst_reserved[GST_PADDING + 0];
87 struct _GstAudioClockClass {
88 GstSystemClockClass parent_class;
91 gpointer _gst_reserved[GST_PADDING];
94 GType gst_audio_clock_get_type (void);
95 GstClock* gst_audio_clock_new (const gchar *name, GstAudioClockGetTimeFunc func,
97 GstClock* gst_audio_clock_new_full (const gchar *name, GstAudioClockGetTimeFunc func,
98 gpointer user_data, GDestroyNotify destroy_notify);
99 void gst_audio_clock_reset (GstAudioClock *clock, GstClockTime time);
101 GstClockTime gst_audio_clock_get_time (GstClock * clock);
102 GstClockTime gst_audio_clock_adjust (GstClock * clock, GstClockTime time);
104 void gst_audio_clock_invalidate (GstClock * clock);
108 #endif /* __GST_AUDIO_CLOCK_H__ */