2005-09-11 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/gstreamer-sections.txt:
+ * docs/gst/gstreamer.types:
+ * docs/gst/tmpl/gstpad.sgml:
+ * docs/gst/tmpl/gsttypes.sgml:
+ * gst/base/gstadapter.h:
+ * gst/base/gstbasesink.h:
+ * gst/base/gstbasesrc.h:
+ * gst/gstbin.h:
+ * gst/gstbuffer.h:
+ * gst/gstbus.h:
+ * gst/gstcaps.h:
+ * gst/gstclock.h:
+ * gst/gstelement.h:
+ * gst/gstevent.h:
+ * gst/gstmessage.h:
+ * gst/gstpad.h:
+ * gst/gststructure.c:
+ * gst/registries/gstlibxmlregistry.h:
+ various documentation fixes
+
+2005-09-11 Thomas Vander Stichele <thomas at apestaart dot org>
+
+ * docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstvalue.sgml:
rearrange gstvalue section
* gst/gstutils.c: (gst_element_state_get_name):
GstElement
GstElementClass
GstElementFlags
-GST_NUM_STATES
GST_STATE
GST_STATE_PENDING
-GST_STATE_TRANSITION
GST_STATE_CHANGE_NULL_TO_READY
GST_STATE_CHANGE_READY_TO_PAUSED
GST_STATE_CHANGE_PAUSED_TO_PLAYING
<FILE>gsttypes</FILE>
<TITLE>GstTypes</TITLE>
GstState
+GstStateChange
GstStateChangeReturn
GstRank
<SUBSECTION Standard>
-GST_TYPE_ELEMENT_STATE
-GST_TYPE_ELEMENT_STATE_RETURN
+GST_TYPE_STATE
+GST_TYPE_STATE_CHANGE
+GST_TYPE_STATE_CHANGE_RETURN
GST_TYPE_RANK
<SUBSECTION Private>
GST_PADDING
GST_PADDING_INIT
-gst_element_state_get_type
-gst_element_state_return_get_type
+gst_state_get_type
+gst_state_change_get_type
+gst_state_change_return_get_type
gst_rank_get_type
</SECTION>
gst_xml_registry_get_type
</SECTION>
-
<SECTION>
<FILE>gstenumtypes</FILE>
<TITLE>GstEnumTypes</TITLE>
%registries
-#include <gst/registries/gstxmlregistry.h>
+#include <gst/registries/gstlibxmlregistry.h>
gst_xml_registry_get_type
@GST_PAD_FLAG_LAST:
<!-- ##### ENUM GstPadLinkReturn ##### -->
-<para>
-The result of a pad link.
-</para>
-@GST_PAD_LINK_OK: the link succeeded.
+
+@GST_PAD_LINK_OK:
@GST_PAD_LINK_WRONG_HIERARCHY:
@GST_PAD_LINK_WAS_LINKED:
@GST_PAD_LINK_WRONG_DIRECTION:
@GST_PAD_LINK_NOFORMAT:
@GST_PAD_LINK_NOSCHED:
-@GST_PAD_LINK_REFUSED: the link was refused.
+@GST_PAD_LINK_REFUSED:
<!-- ##### ENUM GstPadPresence ##### -->
<para>
@GST_STATE_PAUSED:
@GST_STATE_PLAYING:
+<!-- ##### ENUM GstStateChange ##### -->
+<para>
+
+</para>
+
+@GST_STATE_CHANGE_NULL_TO_READY:
+@GST_STATE_CHANGE_READY_TO_PAUSED:
+@GST_STATE_CHANGE_PAUSED_TO_PLAYING:
+@GST_STATE_CHANGE_PLAYING_TO_PAUSED:
+@GST_STATE_CHANGE_PAUSED_TO_READY:
+@GST_STATE_CHANGE_READY_TO_NULL:
+
<!-- ##### ENUM GstStateChangeReturn ##### -->
<para>
#define GST_TYPE_ADAPTER \
(gst_adapter_get_type())
#define GST_ADAPTER(obj) \
- (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ADAPTER,GstAdapter))
+ (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_ADAPTER, GstAdapter))
#define GST_ADAPTER_CLASS(klass) \
- (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ADAPTER,GstAdapterClass))
+ (G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_ADAPTER, GstAdapterClass))
+#define GST_ADAPTER_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ADAPTER, GstAdapterClass))
+
#define GST_IS_ADAPTER(obj) \
- (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ADAPTER))
+ (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_ADAPTER))
#define GST_IS_ADAPTER_CLASS(obj) \
- (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ADAPTER))
+ (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_ADAPTER))
typedef struct _GstAdapter GstAdapter;
typedef struct _GstAdapterClass GstAdapterClass;
* GST_BASE_SINK_CLOCK:
* @obj: base sink instance
*
- * Returns the pointer to the #GstClock object of the element.
+ * Gives the pointer to the #GstClock object of the element.
*/
#define GST_BASE_SINK_CLOCK(obj) (GST_BASE_SINK (obj)->clock)
/**
* GST_BASE_SINK_PAD:
* @obj: base sink instance
*
- * Returns the pointer to the #GstPad object of the element.
+ * Gives the pointer to the #GstPad object of the element.
*/
#define GST_BASE_SINK_PAD(obj) (GST_BASE_SINK (obj)->sinkpad)
* GST_BASE_SRC_PAD:
* @obj: base source instance
*
- * Returns the pointer to the #GstPad object of the element.
+ * Gives the pointer to the #GstPad object of the element.
*/
#define GST_BASE_SRC_PAD(obj) (GST_BASE_SRC (obj)->srcpad)
GST_BIN_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 5
} GstBinFlags;
-typedef struct _GstBin GstBin;
-typedef struct _GstBinClass GstBinClass;
+typedef struct _GstBin GstBin;
+typedef struct _GstBinClass GstBinClass;
/**
* GST_BIN_NUMCHILDREN:
* @bin: the bin to get the number of children from
*
* Gets the number of children a bin manages.
- *
- * Returns: the number of child objects
*/
#define GST_BIN_NUMCHILDREN(bin) (GST_BIN_CAST(bin)->numchildren)
/**
* @bin: the bin to get the list with children from
*
* Gets the list with children a bin manages.
- *
- * Returns: the children list
*/
#define GST_BIN_CHILDREN(bin) (GST_BIN_CAST(bin)->children)
/**
* GST_BIN_CHILDREN_COOKIE:
- * @bin: the bin to get the children cookie from
+ * @bin: the bin to get the children cookie from
*
* Gets the children cookie that watches the children list.
- *
- * Returns: the children cookie
*/
#define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie)
* GST_BUFFER_FLAGS:
* @buf: a #GstBuffer to retrieve the flags from.
*
- * Gets the flags from this buffer.
- *
- * Returns: the set of #GstBufferFlag items
+ * Gets the #GstBufferFlag flags from this buffer.
*/
#define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
/**
* @flag: the #GstBufferFlag to check.
*
* Gives the status of a given flag of a buffer.
- *
- * Returns: %TRUE if flag is set.
*/
#define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
/**
* @buf: a #GstBuffer to get data pointer of.
*
* Retrieves a pointer to the data element of this buffer.
- *
- * Returns: the pointer to the actual data contents of the buffer.
*/
#define GST_BUFFER_DATA(buf) (GST_BUFFER_CAST(buf)->data)
/**
* @buf: a #GstBuffer to get data size of.
*
* Gets the size of the data in this buffer.
- *
- * Returns: the buffer size in bytes
*/
#define GST_BUFFER_SIZE(buf) (GST_BUFFER_CAST(buf)->size)
/**
* @buf: a #GstBuffer to get the timestamp of.:
*
* Gets the timestamp for this buffer.
- *
- * Returns: the timestamp for this buffer
*/
#define GST_BUFFER_TIMESTAMP(buf) (GST_BUFFER_CAST(buf)->timestamp)
/**
*
* Gets the duration in nanoseconds of the data in the buffer.
* Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
- *
- * Returns: the duration of the buffer
*/
#define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
/**
* @buf: a #GstBuffer to get the caps of.
*
* Gets the caps for this buffer.
- *
- * Returns: the #GstCaps for this buffer
*/
#define GST_BUFFER_CAPS(buf) (GST_BUFFER_CAST(buf)->caps)
/**
* @buf: a #GstBuffer to get the offset of.
*
* Gets the offset in the source file of the beginning of this buffer.
- *
- * Returns: the start offset for this buffer
*/
#define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
/**
* @buf: a #GstBuffer to get the offset of.
*
* Gets the offset in the source file of the end of this buffer.
- *
- * Returns: the end offset for this buffer
*/
#define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
/**
/**
* GST_BUFFER_DURATION_IS_VALID:
* @buffer: the #GstBuffer to check for the duration
- *
- * Tests if the duration is known.
*
- * Returns: %TRUE for success
+ * Tests if the duration is known.
*/
#define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
/**
* @buffer: the #GstBuffer to check for the timestamp
*
* Tests if the timestamp is known.
- *
- * Returns: %TRUE for success
*/
#define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
/**
* @buffer: the #GstBuffer to check for the start offset
*
* Tests if the start offset is known.
- *
- * Returns: %TRUE for success
*/
#define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
/**
* @buffer: the #GstBuffer to check for the end offset
*
* Tests if the end offset is known.
- *
- * Returns: %TRUE for success
*/
#define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
*
* Copies the given buffer using the copy function of the parent #GstData
* structure.
- *
- * Returns: a new #GstBuffer copy of the buffer.
*/
#define gst_buffer_copy(buf) GST_BUFFER_CAST (gst_mini_object_copy (GST_MINI_OBJECT (buf)))
/**
* @buf: a #GstBuffer to check
*
* Tests if you can safely write data into a buffer's data array.
- *
- * Returns: %TRUE if buffer is writable
*/
#define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT (buf))
/**
* gst_buffer_make_writable:
* @buf: a #GstBuffer to make writable
*
- * Makes a buffer writable.
- *
- * Returns: a #GstBuffer that is writable
+ * Makes a writable buffer from the given buffer.
*/
#define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT (buf)))
/**
* GstBusSyncHandler:
* @bus: the #GstBus that sent the message
- * @messages: the #GstMessage
+ * @message: the #GstMessage
* @data: user data that has been given, when registering the handler
*
* Handler will be invoked synchronously, when a new message has been injected
*
* Returns: #GstBusSyncReply stating what to do with the message
*/
-typedef GstBusSyncReply (*GstBusSyncHandler) (GstBus * bus, GstMessage * message, gpointer data);
+typedef GstBusSyncReply (*GstBusSyncHandler) (GstBus * bus, GstMessage * message, gpointer data);
/**
* GstBusHandler:
* @bus: the #GstBus that sent the message
- * @messages: the #GstMessage
+ * @message: the #GstMessage
* @data: user data that has been given, when registering the handler
*
* Handler will be invoked asynchronously, after a new message has been injected
/**
* GST_STATIC_CAPS_ANY:
*
- * Creates a static caps that matches anything. This can be used in pad
- * templates.
- *
- * Returns: a new #GstCaps instance
+ * Creates a new #GstCaps static caps that matches anything.
+ * This can be used in pad templates.
*/
#define GST_STATIC_CAPS_ANY GST_STATIC_CAPS("ANY")
/**
* GST_STATIC_CAPS_NONE:
*
- * Creates a static caps that matches nothing. This can be used in pad
- * templates.
- *
- * Returns: a new #GstCaps instance
+ * Creates a new #GstCaps static caps that matches nothing.
+ * This can be used in pad templates.
*/
#define GST_STATIC_CAPS_NONE GST_STATIC_CAPS("NONE")
* GST_CAPS_IS_SIMPLE:
* @caps: the #GstCaps instance to check
*
- * Convinience macro that checks if the number of structures in the gives caps
+ * Convenience macro that checks if the number of structures in the given caps
* is exactly one.
- *
- * Returns: %TRUE if caps has exactly one structure
*/
#define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1)
#ifndef GST_DISABLE_DEPRECATED
/**
* GST_DEBUG_CAPS:
- * @string: a string the should be prepend to the caps data.
+ * @string: a string that should be prepended to the caps data.
* @caps: the #GstCaps instance to print
*
- * Convinience macro for prining out the contents of caps with GST_DEBUG().
+ * Convenience macro for printing out the contents of caps with GST_DEBUG().
*
* Deprecated: do not use anymore
*/
/**
* GST_STATIC_CAPS:
- * @caps: the string describing the caps.
- *
- * Creates a static caps from an input string. This can be used in pad
- * templates.
+ * @string: the string describing the caps
*
- * Returns: a new #GstCaps instance
+ * Creates a new #GstCaps static caps from an input string.
+ * This can be used in pad templates.
*/
#define GST_STATIC_CAPS(string) \
{ \
G_BEGIN_DECLS
/* --- standard type macros --- */
-#define GST_TYPE_CLOCK (gst_clock_get_type ())
-#define GST_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_CAST ((clock), GST_TYPE_CLOCK, GstClock))
-#define GST_IS_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_TYPE ((clock), GST_TYPE_CLOCK))
-#define GST_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_CAST ((cclass), GST_TYPE_CLOCK, GstClockClass))
-#define GST_IS_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_TYPE ((cclass), GST_TYPE_CLOCK))
-#define GST_CLOCK_GET_CLASS(clock) (G_TYPE_INSTANCE_GET_CLASS ((clock), GST_TYPE_CLOCK, GstClockClass))
-#define GST_CLOCK_CAST(clock) ((GstClock*)(clock))
+#define GST_TYPE_CLOCK (gst_clock_get_type ())
+#define GST_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_CAST ((clock), GST_TYPE_CLOCK, GstClock))
+#define GST_IS_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_TYPE ((clock), GST_TYPE_CLOCK))
+#define GST_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_CAST ((cclass), GST_TYPE_CLOCK, GstClockClass))
+#define GST_IS_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_TYPE ((cclass), GST_TYPE_CLOCK))
+#define GST_CLOCK_GET_CLASS(clock) (G_TYPE_INSTANCE_GET_CLASS ((clock), GST_TYPE_CLOCK, GstClockClass))
+#define GST_CLOCK_CAST(clock) ((GstClock*)(clock))
/**
* GstClockTime:
*
* A datatype to hold a time, measured in nanoseconds.
*/
-typedef guint64 GstClockTime;
+typedef guint64 GstClockTime;
/**
* GstClockTimeDiff:
*
* A datatype to hold a timedifference, measured in nanoseconds.
*/
-typedef gint64 GstClockTimeDiff;
+typedef gint64 GstClockTimeDiff;
/**
* GstClockID:
*
* A detatype to hold the handle to an outstanding async clock callback
*/
-typedef gpointer GstClockID;
+typedef gpointer GstClockID;
/**
* GST_CLOCK_TIME_NONE:
*
* Constant to define an undefined clock time
*/
-#define GST_CLOCK_TIME_NONE ((GstClockTime)-1)
+#define GST_CLOCK_TIME_NONE ((GstClockTime) -1)
/**
* GST_CLOCK_TIME_IS_VALID:
* @time: clock time to validate
*
- * Tests if a clock-time is defined.
- *
- * Returns: %TRUE if clocktime is safe to use.
+ * Tests if a given #GstClockTime represents a valid defined time.
*/
#define GST_CLOCK_TIME_IS_VALID(time) ((time) != GST_CLOCK_TIME_NONE)
* @s: the first time
* @e: the second time
*
- * Calculate a difference between two clock times.
- *
- * Returns: the difference as #GstClockTimeDiff
+ * Calculate a difference between two clock times as a #GstClockTimeDiff.
*/
-#define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((s) - (e))
+#define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((s) - (e))
/**
* GST_TIMEVAL_TO_TIME:
* @tv: the timeval to convert
*
- * Convert a GTimeVal to a GstClockTime
- *
- * Returns: the result as #GstClockTime
+ * Convert a GTimeVal to a #GstClockTime.
*/
#define GST_TIMEVAL_TO_TIME(tv) ((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
/**
* Convert a GstClockTime to a GTimeVal
*/
#define GST_TIME_TO_TIMEVAL(t,tv) \
-G_STMT_START { \
+G_STMT_START { \
(tv).tv_sec = (t) / GST_SECOND; \
(tv).tv_usec = ((t) - (tv).tv_sec * GST_SECOND) / GST_USECOND; \
} G_STMT_END
* GST_TIMESPEC_TO_TIME:
* @ts: the timespec to convert
*
- * Convert a struct timespec (see man pselect) to a GstClockTime
- *
- * Returns: the result as #GstClockTime
+ * Convert a struct timespec (see man pselect) to a #GstClockTime.
*/
#define GST_TIMESPEC_TO_TIME(ts) ((ts).tv_sec * GST_SECOND + (ts).tv_nsec * GST_NSECOND)
/**
* @t: The GstClockTime to convert
* @ts: The target timespec
*
- * Convert a GstClockTime to a struct timespec (see man pselect)
+ * Convert a #GstClockTime to a struct timespec (see man pselect)
*/
#define GST_TIME_TO_TIMESPEC(t,ts) \
-G_STMT_START { \
+G_STMT_START { \
(ts).tv_sec = (t) / GST_SECOND; \
(ts).tv_nsec = ((t) - (ts).tv_sec * GST_SECOND) / GST_NSECOND; \
} G_STMT_END
*/
#define GST_CLOCK_ENTRY_TRACE_NAME "GstClockEntry"
-typedef struct _GstClockEntry GstClockEntry;
-typedef struct _GstClock GstClock;
-typedef struct _GstClockClass GstClockClass;
+typedef struct _GstClockEntry GstClockEntry;
+typedef struct _GstClock GstClock;
+typedef struct _GstClockClass GstClockClass;
/* --- prototype for async callbacks --- */
/**
*
* Returns: %TRUE or %FALSE (currently unused)
*/
-typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
+typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
GstClockID id, gpointer user_data);
/**
* GstClockReturn:
typedef enum
{
GST_CLOCK_OK = 0,
- GST_CLOCK_EARLY = 1,
+ GST_CLOCK_EARLY = 1,
GST_CLOCK_UNSCHEDULED = 2,
GST_CLOCK_BUSY = 3,
- GST_CLOCK_BADTIME = 4,
- GST_CLOCK_ERROR = 5,
+ GST_CLOCK_BADTIME = 4,
+ GST_CLOCK_ERROR = 5,
GST_CLOCK_UNSUPPORTED = 6,
} GstClockReturn;
* an entry.
*/
struct _GstClockEntry {
- gint refcount;
+ gint refcount;
/*< protected >*/
- GstClock *clock;
- GstClockEntryType type;
- GstClockTime time;
- GstClockTime interval;
- GstClockReturn status;
- GstClockCallback func;
+ GstClock *clock;
+ GstClockEntryType type;
+ GstClockTime time;
+ GstClockTime interval;
+ GstClockReturn status;
+ GstClockCallback func;
gpointer user_data;
};
/**
* GstClockFlags:
- * @GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: This clock can do a single sync timeut request
- * @GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: This clock can do a single async timeout request
- * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: This clock can do sync periodic timeout requests
- * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: This clock can do async periodic timeout callbacks
- * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: The resolution of this clock can be changed
+ * @GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: clock can do a single sync timeout request
+ * @GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: clock can do a single async timeout request
+ * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: clock can do sync periodic timeout requests
+ * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: clock can do async periodic timeout callbacks
+ * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed
*
* The capabilities of this clock
*/
/**
* GST_CLOCK_FLAGS:
- * @entry: the entry to query
+ * @clock: the clock to query
*
- * Get the clock flags
+ * Gets the #GstClockFlags clock flags.
*/
#define GST_CLOCK_FLAGS(clock) (GST_CLOCK(clock)->flags)
#define GST_CLOCK_TIMED_WAIT(clock,tv) g_cond_timed_wait(GST_CLOCK_COND(clock),GST_GET_LOCK(clock),tv)
#define GST_CLOCK_BROADCAST(clock) g_cond_broadcast(GST_CLOCK_COND(clock))
-/**
- * GstClock:
- * @stats: Boolean property to activate stat generation on the clock.
- *
- */
struct _GstClock {
- GstObject object;
+ GstObject object;
/*< public >*/
GstClockFlags flags;
GstClockTime adjust;
GstClockTime last_time;
GList *entries;
- GCond *entries_changed;
+ GCond *entries_changed;
/*< private >*/
guint64 resolution;
/*< protected >*/
/* vtable */
guint64 (*change_resolution) (GstClock *clock, guint64 old_resolution,
- guint64 new_resolution);
+ guint64 new_resolution);
guint64 (*get_resolution) (GstClock *clock);
- GstClockTime (*get_internal_time) (GstClock *clock);
+ GstClockTime (*get_internal_time) (GstClock *clock);
/* waiting on an ID */
- GstClockReturn (*wait) (GstClock *clock, GstClockEntry *entry);
+ GstClockReturn (*wait) (GstClock *clock, GstClockEntry *entry);
GstClockReturn (*wait_async) (GstClock *clock, GstClockEntry *entry);
- void (*unschedule) (GstClock *clock, GstClockEntry *entry);
-
+ void (*unschedule) (GstClock *clock, GstClockEntry *entry);
+
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
-GType gst_clock_get_type (void);
+GType gst_clock_get_type (void);
guint64 gst_clock_set_resolution (GstClock *clock, guint64 resolution);
guint64 gst_clock_get_resolution (GstClock *clock);
/* creating IDs that can be used to get notifications */
-GstClockID gst_clock_new_single_shot_id (GstClock *clock,
- GstClockTime time);
-GstClockID gst_clock_new_periodic_id (GstClock *clock,
+GstClockID gst_clock_new_single_shot_id (GstClock *clock,
+ GstClockTime time);
+GstClockID gst_clock_new_periodic_id (GstClock *clock,
GstClockTime start_time,
- GstClockTime interval);
+ GstClockTime interval);
/* reference counting */
GstClockID gst_clock_id_ref (GstClockID id);
void gst_clock_id_unref (GstClockID id);
/* operations on IDs */
-gint gst_clock_id_compare_func (gconstpointer id1, gconstpointer id2);
+gint gst_clock_id_compare_func (gconstpointer id1, gconstpointer id2);
GstClockTime gst_clock_id_get_time (GstClockID id);
-GstClockReturn gst_clock_id_wait (GstClockID id,
+GstClockReturn gst_clock_id_wait (GstClockID id,
GstClockTimeDiff *jitter);
-GstClockReturn gst_clock_id_wait_async (GstClockID id,
- GstClockCallback func,
+GstClockReturn gst_clock_id_wait_async (GstClockID id,
+ GstClockCallback func,
gpointer user_data);
-void gst_clock_id_unschedule (GstClockID id);
+void gst_clock_id_unschedule (GstClockID id);
G_END_DECLS
#define GST_ELEMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
#define GST_ELEMENT_CAST(obj) ((GstElement*)(obj))
+/**
+ * GstStateChangeReturn:
+ * @GST_STATE_CHANGE_FAILURE : the state change failed
+ * @GST_STATE_CHANGE_SUCCESS : the state change succeeded
+ * @GST_STATE_CHANGE_ASYNC : the state change will happen asynchronously
+ * @GST_STATE_CHANGE_NO_PREROLL: the state change cannot be prerolled
+ */
typedef enum {
GST_STATE_CHANGE_FAILURE = 0,
GST_STATE_CHANGE_SUCCESS = 1,
#endif
/* FIXME: How to deal with lost_state ? */
+/**
+ * GstStateChange:
+ * @GST_STATE_CHANGE_NULL_TO_READY : state change from NULL to READY
+ * @GST_STATE_CHANGE_READY_TO_PAUSED : state change from READY to PAUSED
+ * @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING
+ * @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED
+ * @GST_STATE_CHANGE_PAUSED_TO_READY : state change from PAUSED to READY
+ * @GST_STATE_CHANGE_READY_TO_NULL : state change from READY to NULL
+ */
typedef enum /*< flags=0 >*/
{
GST_STATE_CHANGE_NULL_TO_READY = 1<<(GST_STATE_NULL+8) | 1<<GST_STATE_READY,
* GST_EVENT_TYPE:
* @event: the event to query
*
- * Get the event type.
- *
- * Returns: the #GstEventType of the given event
+ * Get the #GstEventType of the event.
*/
#define GST_EVENT_TYPE(event) (GST_EVENT(event)->type)
+
/**
* GST_EVENT_TIMESTAMP:
* @event: the event to query
*
- * Get the timestamp of the event.
- *
- * Returns: the timestamp of the given event
+ * Get the #GstClockTime timestamp of the event.
*/
#define GST_EVENT_TIMESTAMP(event) (GST_EVENT(event)->timestamp)
+
/**
* GST_EVENT_SRC:
* @event: the event to query
*
- * The source object that generated this event.
- *
- * Returns: the source #GstObject for the given event
+ * The source #GstObject that generated this event.
*/
#define GST_EVENT_SRC(event) (GST_EVENT(event)->src)
* @ev: The event to copy
*
* Copy the event using the event specific copy function.
- *
- * Returns: A new event that is a copy of the given input event
*/
#define gst_event_copy(ev) GST_EVENT (gst_mini_object_copy (GST_MINI_OBJECT (ev)))
* handled by other message-specific functions to pass a message to the
* app. The structure field can be NULL.
*
- * Returns: The new message.
- *
* MT safe.
*/
#define gst_message_new_application(src, str) \
/**
* GstPadLinkReturn:
- * @GST_PAD_LINK_OK : link ok
- * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
- * @GST_PAD_LINK_WAS_LINKED : pad was already linked
- * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
- * @GST_PAD_LINK_NOFORMAT : pads do not have common format
- * @GST_PAD_LINK_NOSCHED : pads cannot cooperate in scheduling
- * @GST_PAD_LINK_REFUSED : refused for some reason
+ * @GST_PAD_LINK_OK : link succeeded
+ * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
+ * @GST_PAD_LINK_WAS_LINKED : pad was already linked
+ * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
+ * @GST_PAD_LINK_NOFORMAT : pads do not have common format
+ * @GST_PAD_LINK_NOSCHED : pads cannot cooperate in scheduling
+ * @GST_PAD_LINK_REFUSED : refused for some reason
*/
typedef enum {
GST_PAD_LINK_OK = 0,
* determine whether a structure is mutable or not. This function should only be
* called by code implementing parent objects of GstStructure, as described in
* the MT Refcounting section of the design documents.
- *
- * Returns: a new #GstStructure.
*/
void
gst_structure_set_parent_refcount (GstStructure * structure, int *refcount)
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_XML_REGISTRY,GstXMLRegistry))
#define GST_XML_REGISTRY_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_XML_REGISTRY,GstXMLRegistryClass))
+#define GST_XML_REGISTRY_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_XML_REGISTRY, GstXMLRegistryClass))
#define GST_IS_XML_REGISTRY(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_XML_REGISTRY))
#define GST_IS_XML_REGISTRY_CLASS(obj) \
/* normal GObject stuff */
GType gst_xml_registry_get_type (void);
-GstRegistry* gst_xml_registry_new (const gchar *name, const gchar *location);
+GstRegistry* gst_xml_registry_new (const gchar *name, const gchar *location);
G_END_DECLS
#define GST_TYPE_ADAPTER \
(gst_adapter_get_type())
#define GST_ADAPTER(obj) \
- (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ADAPTER,GstAdapter))
+ (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_ADAPTER, GstAdapter))
#define GST_ADAPTER_CLASS(klass) \
- (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ADAPTER,GstAdapterClass))
+ (G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_ADAPTER, GstAdapterClass))
+#define GST_ADAPTER_GET_CLASS(obj) \
+ (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ADAPTER, GstAdapterClass))
+
#define GST_IS_ADAPTER(obj) \
- (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ADAPTER))
+ (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_ADAPTER))
#define GST_IS_ADAPTER_CLASS(obj) \
- (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ADAPTER))
+ (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_ADAPTER))
typedef struct _GstAdapter GstAdapter;
typedef struct _GstAdapterClass GstAdapterClass;
* GST_BASE_SINK_CLOCK:
* @obj: base sink instance
*
- * Returns the pointer to the #GstClock object of the element.
+ * Gives the pointer to the #GstClock object of the element.
*/
#define GST_BASE_SINK_CLOCK(obj) (GST_BASE_SINK (obj)->clock)
/**
* GST_BASE_SINK_PAD:
* @obj: base sink instance
*
- * Returns the pointer to the #GstPad object of the element.
+ * Gives the pointer to the #GstPad object of the element.
*/
#define GST_BASE_SINK_PAD(obj) (GST_BASE_SINK (obj)->sinkpad)
* GST_BASE_SRC_PAD:
* @obj: base source instance
*
- * Returns the pointer to the #GstPad object of the element.
+ * Gives the pointer to the #GstPad object of the element.
*/
#define GST_BASE_SRC_PAD(obj) (GST_BASE_SRC (obj)->srcpad)
projects / platform / upstream / gstreamer.git / commitdiff