element: Enforce that elements created by gst_element_factory_create/make() are floating

[platform/upstream/gstreamer.git] / gst / gstclock.h

diff --git a/gst/gstclock.h b/gst/gstclock.h
index 505b8b2..f34c97d 100644 (file)
--- a/gst/gstclock.h
+++ b/gst/gstclock.h
@@ -213,7 +213,7 @@ G_STMT_START {                                                    \
 
 /* timestamp debugging macros */
 /**
- * GST_TIME_FORMAT:
+ * GST_TIME_FORMAT: (skip):
  *
  * A string that can be used in printf-like format strings to display a
  * #GstClockTime value in h:m:s format.  Use GST_TIME_ARGS() to construct
@@ -226,7 +226,7 @@ G_STMT_START {                                                    \
  */
 #define GST_TIME_FORMAT "u:%02u:%02u.%09u"
 /**
- * GST_TIME_ARGS:
+ * GST_TIME_ARGS: (skip):
  * @t: a #GstClockTime
  *
  * Format @t for the #GST_TIME_FORMAT format string. Note: @t will be
@@ -242,7 +242,7 @@ G_STMT_START {                                                    \
         GST_CLOCK_TIME_IS_VALID (t) ? \
         (guint) (((GstClockTime)(t)) % GST_SECOND) : 999999999
 /**
- * GST_STIME_FORMAT:
+ * GST_STIME_FORMAT: (skip):
  *
  * A string that can be used in printf-like format strings to display a signed
  * #GstClockTimeDiff or #gint64 value in h:m:s format.  Use GST_TIME_ARGS() to
@@ -257,7 +257,7 @@ G_STMT_START {                                                    \
  */
 #define GST_STIME_FORMAT "c%" GST_TIME_FORMAT
 /**
- * GST_STIME_ARGS:
+ * GST_STIME_ARGS: (skip):
  * @t: a #GstClockTimeDiff or #gint64
  *
  * Format @t for the #GST_STIME_FORMAT format string. Note: @t will be
@@ -339,13 +339,18 @@ typedef enum {
  * Cast to a clock entry
  */
 #define GST_CLOCK_ENTRY(entry)          ((GstClockEntry *)(entry))
+
+#ifndef GST_DISABLE_DEPRECATED
 /**
  * GST_CLOCK_ENTRY_CLOCK:
  * @entry: the entry to query
  *
  * Get the owner clock of the entry
+ *
+ * Deprecated: Use gst_clock_id_get_clock() instead.
  */
 #define GST_CLOCK_ENTRY_CLOCK(entry)    ((entry)->clock)
+#endif
 /**
  * GST_CLOCK_ENTRY_TYPE:
  * @entry: the entry to query
@@ -387,7 +392,13 @@ typedef enum {
 struct _GstClockEntry {
   gint                  refcount;
   /*< protected >*/
+#ifndef GST_REMOVE_DEPRECATED
+#ifndef GST_DISABLE_DEPRECATED
   GstClock              *clock;
+#else
+  gpointer               _clock;
+#endif
+#endif
   GstClockEntryType      type;
   GstClockTime           time;
   GstClockTime           interval;
@@ -413,7 +424,7 @@ struct _GstClockEntry {
  * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed
  * @GST_CLOCK_FLAG_CAN_SET_MASTER: clock can be slaved to a master clock
  * @GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC: clock needs to be synced before it can be used
- *     (Since 1.6)
+ *     (Since: 1.6)
  * @GST_CLOCK_FLAG_LAST: subclasses can add additional flags starting from this flag
  *
  * The capabilities of this clock
@@ -491,24 +502,24 @@ struct _GstClockClass {
   gpointer _gst_reserved[GST_PADDING];
 };
 
-GST_EXPORT
+GST_API
 GType                   gst_clock_get_type              (void);
 
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_set_resolution        (GstClock *clock,
                                                          GstClockTime resolution);
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_get_resolution        (GstClock *clock);
 
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_get_time              (GstClock *clock);
 
-GST_EXPORT
+GST_API
 void                    gst_clock_set_calibration       (GstClock *clock, GstClockTime internal,
                                                          GstClockTime external,
                                                          GstClockTime rate_num,
                                                          GstClockTime rate_denom);
-GST_EXPORT
+GST_API
 void                    gst_clock_get_calibration       (GstClock *clock, GstClockTime *internal,
                                                          GstClockTime *external,
                                                          GstClockTime *rate_num,
@@ -516,22 +527,22 @@ void                    gst_clock_get_calibration       (GstClock *clock, GstClo
 
 /* master/slave clocks */
 
-GST_EXPORT
+GST_API
 gboolean                gst_clock_set_master            (GstClock *clock, GstClock *master);
 
-GST_EXPORT
+GST_API
 GstClock*               gst_clock_get_master            (GstClock *clock);
 
-GST_EXPORT
+GST_API
 void                    gst_clock_set_timeout           (GstClock *clock,
                                                          GstClockTime timeout);
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_get_timeout           (GstClock *clock);
 
-GST_EXPORT
+GST_API
 gboolean                gst_clock_add_observation       (GstClock *clock, GstClockTime slave,
                                                          GstClockTime master, gdouble *r_squared);
-GST_EXPORT
+GST_API
 gboolean                gst_clock_add_observation_unapplied (GstClock *clock, GstClockTime slave,
                                                          GstClockTime master, gdouble *r_squared,
                                                          GstClockTime *internal,
@@ -541,84 +552,90 @@ gboolean                gst_clock_add_observation_unapplied (GstClock *clock, Gs
 
 /* getting and adjusting internal/external time */
 
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_get_internal_time     (GstClock *clock);
 
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_adjust_unlocked       (GstClock *clock, GstClockTime internal);
 
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_adjust_with_calibration (GstClock *clock,
                                                          GstClockTime internal_target,
                                                          GstClockTime cinternal,
                                                          GstClockTime cexternal,
                                                          GstClockTime cnum,
                                                          GstClockTime cdenom);
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_unadjust_with_calibration (GstClock *clock,
                                                          GstClockTime external_target,
                                                          GstClockTime cinternal,
                                                          GstClockTime cexternal,
                                                          GstClockTime cnum,
                                                          GstClockTime cdenom);
-GST_EXPORT
+GST_API
 GstClockTime            gst_clock_unadjust_unlocked     (GstClock * clock, GstClockTime external);
 
 /* waiting for, signalling and checking for synchronization */
 
-GST_EXPORT
+GST_API
 gboolean                gst_clock_wait_for_sync         (GstClock * clock, GstClockTime timeout);
 
-GST_EXPORT
+GST_API
 gboolean                gst_clock_is_synced             (GstClock * clock);
 
 /* to be used by subclasses only */
 
-GST_EXPORT
+GST_API
 void                    gst_clock_set_synced            (GstClock * clock, gboolean synced);
 
 /* creating IDs that can be used to get notifications */
 
-GST_EXPORT
+GST_API
 GstClockID              gst_clock_new_single_shot_id    (GstClock *clock,
                                                          GstClockTime time);
-GST_EXPORT
+GST_API
 GstClockID              gst_clock_new_periodic_id       (GstClock *clock,
                                                          GstClockTime start_time,
                                                          GstClockTime interval);
 
 /* reference counting */
 
-GST_EXPORT
+GST_API
 GstClockID              gst_clock_id_ref                (GstClockID id);
 
-GST_EXPORT
+GST_API
 void                    gst_clock_id_unref              (GstClockID id);
 
 /* operations on IDs */
 
-GST_EXPORT
+GST_API
 gint                    gst_clock_id_compare_func       (gconstpointer id1, gconstpointer id2);
 
-GST_EXPORT
+GST_API
+GstClock *              gst_clock_id_get_clock          (GstClockID id);
+
+GST_API
+gboolean                gst_clock_id_uses_clock         (GstClockID id, GstClock * clock);
+
+GST_API
 GstClockTime            gst_clock_id_get_time           (GstClockID id);
 
-GST_EXPORT
+GST_API
 GstClockReturn          gst_clock_id_wait               (GstClockID id,
                                                          GstClockTimeDiff *jitter);
-GST_EXPORT
+GST_API
 GstClockReturn          gst_clock_id_wait_async         (GstClockID id,
                                                          GstClockCallback func,
                                                          gpointer user_data,
                                                          GDestroyNotify destroy_data);
-GST_EXPORT
+GST_API
 void                    gst_clock_id_unschedule         (GstClockID id);
 
-GST_EXPORT
+GST_API
 gboolean                gst_clock_single_shot_id_reinit (GstClock * clock,
                                                          GstClockID id,
                                                          GstClockTime time);
-GST_EXPORT
+GST_API
 gboolean                gst_clock_periodic_id_reinit    (GstClock * clock,
                                                          GstClockID id,
                                                          GstClockTime start_time,