summaryrefslogtreecommitdiff
path: root/gst
diff options
context:
space:
mode:
authorWim Taymans <wim.taymans@gmail.com>2000-10-25 19:09:53 +0000
committerWim Taymans <wim.taymans@gmail.com>2000-10-25 19:09:53 +0000
commit9bae9d4b91cd2dbc16f3dad7775c55f1e3c74c1f (patch)
tree13ef723317322bbc333ec0b50761f09b5cd56f51 /gst
parent268bcbb89dc2974653f9db6e597076d03a980cc9 (diff)
More Docs updates.
Original commit message from CVS: More Docs updates. Added plugin documentation. I fear we need a gstdoc implementation that loads plugins and does introspection on them. I think we should automatically create the docs for the pads and mime types the plugins provide. Does anyone have enough perl knowledge to add these features? I allready changed the C code to output the pad definitions but my perl knowledge is too limited, for now, to implement the rest of the needed functionality...
Diffstat (limited to 'gst')
-rw-r--r--gst/elements/gstasyncdisksrc.c12
-rw-r--r--gst/elements/gstaudiosink.c3
-rw-r--r--gst/gstbufferpool.c39
-rw-r--r--gst/gstconnection.c6
-rw-r--r--gst/gstcpu.c2
-rw-r--r--gst/gstcpu.h8
-rw-r--r--gst/gstelement.c2
-rw-r--r--gst/gstelement.h2
-rw-r--r--gst/gstelementfactory.c2
-rw-r--r--gst/gstmeta.c30
-rw-r--r--gst/gstmeta.h4
-rw-r--r--gst/gstpad.c142
-rw-r--r--gst/gstplugin.c37
-rw-r--r--gst/gstthread.c3
-rw-r--r--gst/gstthread.h3
-rw-r--r--gst/gstutils.c71
-rw-r--r--gst/gstxml.c2
17 files changed, 341 insertions, 27 deletions
diff --git a/gst/elements/gstasyncdisksrc.c b/gst/elements/gstasyncdisksrc.c
index 36b9d010e..3bb7fab4b 100644
--- a/gst/elements/gstasyncdisksrc.c
+++ b/gst/elements/gstasyncdisksrc.c
@@ -46,8 +46,8 @@ enum {
ARG_0,
ARG_LOCATION,
ARG_BYTESPERREAD,
- ARG_LENGTH,
ARG_OFFSET,
+ ARG_SIZE,
};
@@ -101,10 +101,10 @@ gst_asyncdisksrc_class_init(GstAsyncDiskSrcClass *klass) {
GTK_ARG_READWRITE, ARG_LOCATION);
gtk_object_add_arg_type("GstAsyncDiskSrc::bytesperread", GTK_TYPE_INT,
GTK_ARG_READWRITE, ARG_BYTESPERREAD);
- gtk_object_add_arg_type("GstAsyncDiskSrc::length", GTK_TYPE_LONG,
- GTK_ARG_READABLE, ARG_LENGTH);
gtk_object_add_arg_type("GstAsyncDiskSrc::offset", GTK_TYPE_LONG,
GTK_ARG_READWRITE, ARG_OFFSET);
+ gtk_object_add_arg_type("GstAsyncDiskSrc::size", GTK_TYPE_LONG,
+ GTK_ARG_READABLE, ARG_SIZE);
gtkobject_class->set_arg = gst_asyncdisksrc_set_arg;
gtkobject_class->get_arg = gst_asyncdisksrc_get_arg;
@@ -178,12 +178,12 @@ static void gst_asyncdisksrc_get_arg(GtkObject *object,GtkArg *arg,guint id) {
case ARG_BYTESPERREAD:
GTK_VALUE_INT(*arg) = src->bytes_per_read;
break;
- case ARG_LENGTH:
- GTK_VALUE_LONG(*arg) = src->size;
- break;
case ARG_OFFSET:
GTK_VALUE_LONG(*arg) = src->curoffset;
break;
+ case ARG_SIZE:
+ GTK_VALUE_LONG(*arg) = src->size;
+ break;
default:
arg->type = GTK_TYPE_INVALID;
break;
diff --git a/gst/elements/gstaudiosink.c b/gst/elements/gstaudiosink.c
index fb53a8296..d3674b532 100644
--- a/gst/elements/gstaudiosink.c
+++ b/gst/elements/gstaudiosink.c
@@ -155,8 +155,7 @@ gst_audiosink_class_init(GstAudioSinkClass *klass) {
gst_audiosink_signals[SIGNAL_HANDOFF] =
gtk_signal_new("handoff",GTK_RUN_LAST,gtkobject_class->type,
GTK_SIGNAL_OFFSET(GstAudioSinkClass,handoff),
- gtk_marshal_NONE__POINTER,GTK_TYPE_NONE,1,
- GST_TYPE_AUDIOSINK);
+ gtk_marshal_NONE__NONE,GTK_TYPE_NONE,0);
gtk_object_class_add_signals(gtkobject_class,gst_audiosink_signals,
LAST_SIGNAL);
diff --git a/gst/gstbufferpool.c b/gst/gstbufferpool.c
index ca99a85eb..c5827aa50 100644
--- a/gst/gstbufferpool.c
+++ b/gst/gstbufferpool.c
@@ -42,6 +42,15 @@ GstBufferPool *gst_buffer_pool_new()
return pool;
}
+/**
+ * gst_buffer_pool_set_create_function:
+ * @pool: the pool to set the create function for
+ * @create: the create function
+ * @user_data: any user data to be passed in the create function
+ *
+ * Sets the function that will be called when a buffer is created
+ * from this pool.
+ */
void gst_buffer_pool_set_create_function(GstBufferPool *pool, GstBufferPoolCreateFunction create, gpointer user_data)
{
g_return_if_fail(pool != NULL);
@@ -50,6 +59,15 @@ void gst_buffer_pool_set_create_function(GstBufferPool *pool, GstBufferPoolCreat
pool->new_user_data = user_data;
}
+/**
+ * gst_buffer_pool_set_destroy_function:
+ * @pool: the pool to set the destroy function for
+ * @destroy: the destroy function
+ * @user_data: any user data to be passed in the create function
+ *
+ * Sets the function that will be called when a buffer is destroyed
+ * from this pool.
+ */
void gst_buffer_pool_set_destroy_function(GstBufferPool *pool, GstBufferPoolDestroyFunction destroy, gpointer user_data)
{
g_return_if_fail(pool != NULL);
@@ -58,6 +76,12 @@ void gst_buffer_pool_set_destroy_function(GstBufferPool *pool, GstBufferPoolDest
pool->destroy_user_data = user_data;
}
+/**
+ * gst_buffer_pool_destroy:
+ * @pool: the pool to destroy
+ *
+ * frees the memory for this bufferpool
+ */
void gst_buffer_pool_destroy(GstBufferPool *pool)
{
g_return_if_fail(pool != NULL);
@@ -65,6 +89,14 @@ void gst_buffer_pool_destroy(GstBufferPool *pool)
g_free(pool);
}
+/**
+ * gst_buffer_pool_new_buffer:
+ * @pool: the pool to create the buffer from
+ *
+ * uses the given pool to create a new buffer.
+ *
+ * Returns: The new buffer
+ */
GstBuffer *gst_buffer_pool_new_buffer(GstBufferPool *pool)
{
GstBuffer *buffer;
@@ -77,6 +109,13 @@ GstBuffer *gst_buffer_pool_new_buffer(GstBufferPool *pool)
return buffer;
}
+/**
+ * gst_buffer_pool_destroy_buffer:
+ * @pool: the pool to return the buffer to
+ * @buffer: the buffer to return to the pool
+ *
+ * Gives a buffer back to the given pool.
+ */
void gst_buffer_pool_destroy_buffer(GstBufferPool *pool, GstBuffer *buffer)
{
g_return_if_fail(pool != NULL);
diff --git a/gst/gstconnection.c b/gst/gstconnection.c
index 38be65cbc..1e026150b 100644
--- a/gst/gstconnection.c
+++ b/gst/gstconnection.c
@@ -85,6 +85,12 @@ GstElement *gst_connection_new(gchar *name) {
return connection;
}
+/**
+ * gst_connection_push:
+ * @connection: the connection to push
+ *
+ * Push a buffer along a connection
+ */
void gst_connection_push(GstConnection *connection) {
GstConnectionClass *oclass;
diff --git a/gst/gstcpu.c b/gst/gstcpu.c
index c2ee86c3e..23fcf7cd0 100644
--- a/gst/gstcpu.c
+++ b/gst/gstcpu.c
@@ -55,7 +55,7 @@ void _gst_cpu_initialize(void)
}
-guint32 gst_cpu_get_flags(void)
+GstCPUFlags gst_cpu_get_flags(void)
{
return _gst_cpu_flags;
}
diff --git a/gst/gstcpu.h b/gst/gstcpu.h
index e8ebd3ee5..c6ee4fb91 100644
--- a/gst/gstcpu.h
+++ b/gst/gstcpu.h
@@ -23,11 +23,13 @@
#include <glib.h>
-#define GST_CPU_FLAG_MMX (1 << 0)
-#define GST_CPU_FLAG_SSE (1 << 1)
+typedef enum {
+ GST_CPU_FLAG_MMX = (1<<0),
+ GST_CPU_FLAG_SSE = (1<<1),
+} GstCPUFlags;
void _gst_cpu_initialize();
-guint32 gst_cpu_get_flags();
+GstCPUFlags gst_cpu_get_flags();
#endif /* __GST_CPU_H__ */
diff --git a/gst/gstelement.c b/gst/gstelement.c
index 1a3d1ca7b..fa26e6617 100644
--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@@ -523,6 +523,8 @@ xmlNodePtr gst_element_save_thyself(GstElement *element,xmlNodePtr parent) {
/**
* gst_element_load_thyself:
* @parent: the xml parent node
+ * @elements: a hashtable to store the elements in. This is used
+ * to resolve inter element dependecies during the loading.
*
* load the element based on the XML description
*
diff --git a/gst/gstelement.h b/gst/gstelement.h
index a2df7842f..2f3361007 100644
--- a/gst/gstelement.h
+++ b/gst/gstelement.h
@@ -72,7 +72,7 @@ static inline char *_gst_print_statename(int state) {
(GTK_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT,GstElementClass))
#define GST_IS_ELEMENT(obj) \
(GTK_CHECK_TYPE((obj),GST_TYPE_ELEMENT))
-#define GST_IS_ELEMENT_CLASS(obj) \
+#define GST_IS_ELEMENT_CLASS(klass) \
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
typedef enum {
diff --git a/gst/gstelementfactory.c b/gst/gstelementfactory.c
index cc841d510..28afac369 100644
--- a/gst/gstelementfactory.c
+++ b/gst/gstelementfactory.c
@@ -77,7 +77,7 @@ GstElementFactory *gst_elementfactory_find(gchar *name) {
*
* Get the global list of elementfactories.
*
- * Returns: <type>GList</type> of type #GstElementFactory
+ * Returns: GList of type #GstElementFactory
*/
GList *gst_elementfactory_get_list() {
return _gst_elementfactories;
diff --git a/gst/gstmeta.c b/gst/gstmeta.c
index 4b9665fda..dd259cc0b 100644
--- a/gst/gstmeta.c
+++ b/gst/gstmeta.c
@@ -22,6 +22,14 @@
#include <gst/gsttrace.h>
+/**
+ * gst_meta_new_size:
+ * @size: the size of the new meta data
+ *
+ * Create a new metadata object with a given size
+ *
+ * Returns: new meta object
+ */
GstMeta *gst_meta_new_size(gint size) {
GstMeta *meta;
@@ -31,6 +39,12 @@ GstMeta *gst_meta_new_size(gint size) {
return meta;
}
+/**
+ * gst_meta_ref:
+ * @meta: the meta object to ref
+ *
+ * increases the refcount of a meta object
+ */
void gst_meta_ref(GstMeta *meta) {
g_return_if_fail(meta != NULL);
@@ -38,6 +52,13 @@ void gst_meta_ref(GstMeta *meta) {
meta->refcount++;
}
+/**
+ * gst_meta_unref:
+ * @meta: the meta object to unref
+ *
+ * decreases the refcount of a meta object. if the refcount is zero, the
+ * meta object is freed.
+ */
void gst_meta_unref(GstMeta *meta) {
g_return_if_fail(meta != NULL);
@@ -52,6 +73,15 @@ void gst_meta_unref(GstMeta *meta) {
}
+/**
+ * gst_meta_cow:
+ * @meta: the meta object prepare for write
+ *
+ * prepares a meta object for writing. A copy of the meta
+ * object is returned if needed.
+ *
+ * Returns: the meta object or a copy.
+ */
GstMeta *gst_meta_cow(GstMeta *meta) {
g_return_val_if_fail(meta != NULL, NULL);
return NULL;
diff --git a/gst/gstmeta.h b/gst/gstmeta.h
index 2ba8998af..47b33fb03 100644
--- a/gst/gstmeta.h
+++ b/gst/gstmeta.h
@@ -33,8 +33,8 @@ extern "C" {
#define GST_META(meta) ((GstMeta *)(meta))
-#define GST_META_FLAGS(buf) \
- (GST_META(buf)->flags)
+#define GST_META_FLAGS(meta) \
+ (GST_META(meta)->flags)
#define GST_META_FLAG_IS_SET(meta,flag) \
(GST_META_FLAGS(meta) & (flag))
#define GST_META_FLAG_SET(meta,flag) \
diff --git a/gst/gstpad.c b/gst/gstpad.c
index 063a44d2d..f02ae3764 100644
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -156,6 +156,13 @@ gchar *gst_pad_get_name(GstPad *pad) {
return pad->name;
}
+/**
+ * gst_pad_set_pull_function:
+ * @pad: the pad to set the pull function for
+ * @pull: the pull function
+ *
+ * Set the given pull function for the pad
+ */
void gst_pad_set_pull_function(GstPad *pad,GstPadPullFunction pull) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -165,6 +172,13 @@ void gst_pad_set_pull_function(GstPad *pad,GstPadPullFunction pull) {
pad->pullfunc = pull;
}
+/**
+ * gst_pad_set_chain_function:
+ * @pad: the pad to set the chain function for
+ * @chain: the chain function
+ *
+ * Set the given chain function for the pad
+ */
void gst_pad_set_chain_function(GstPad *pad,GstPadChainFunction chain) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -172,6 +186,13 @@ void gst_pad_set_chain_function(GstPad *pad,GstPadChainFunction chain) {
pad->chainfunc = chain;
}
+/**
+ * gst_pad_set_qos_function:
+ * @pad: the pad to set the qos function for
+ * @qos: the qos function
+ *
+ * Set the given qos function for the pad
+ */
void gst_pad_set_qos_function(GstPad *pad,GstPadQoSFunction qos) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -179,7 +200,13 @@ void gst_pad_set_qos_function(GstPad *pad,GstPadQoSFunction qos) {
pad->qosfunc = qos;
}
-/* gst_pad_push is handed the src pad and the buffer to push */
+/**
+ * gst_pad_push:
+ * @pad: the pad to push
+ * @buffer: the buffer to push
+ *
+ * pushes a buffer along a src pad
+ */
void gst_pad_push(GstPad *pad,GstBuffer *buffer) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -206,7 +233,14 @@ void gst_pad_push(GstPad *pad,GstBuffer *buffer) {
}
-/* gst_pad_pull() is given the sink pad */
+/**
+ * gst_pad_pull:
+ * @pad: the pad to pull
+ *
+ * pulls a buffer along a sink pad
+ *
+ * Returns: the buffer that was pulled
+ */
GstBuffer *gst_pad_pull(GstPad *pad) {
GstBuffer *buf;
// GstElement *peerparent;
@@ -246,6 +280,12 @@ GstBuffer *gst_pad_pull(GstPad *pad) {
return NULL;
}
+/**
+ * gst_pad_chain:
+ * @pad: the pad to chain
+ *
+ * call the chain function of the given pad
+ */
void gst_pad_chain(GstPad *pad) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -262,6 +302,7 @@ void gst_pad_chain(GstPad *pad) {
* @pad: the pad to handle the QoS message
* @qos_message: the QoS message to handle
*
+ * pass the qos message downstream
*/
void gst_pad_handle_qos(GstPad *pad,
glong qos_message)
@@ -292,6 +333,13 @@ void gst_pad_handle_qos(GstPad *pad,
return;
}
+/**
+ * gst_pad_disconnect:
+ * @srcpad: the source pad to disconnect
+ * @sinkpad: the sink pad to disconnect
+ *
+ * disconnects the source pad from the sink pad
+ */
void gst_pad_disconnect(GstPad *srcpad,GstPad *sinkpad) {
/* generic checks */
@@ -313,6 +361,13 @@ void gst_pad_disconnect(GstPad *srcpad,GstPad *sinkpad) {
srcpad->pullfunc = NULL;
}
+/**
+ * gst_pad_connect:
+ * @srcpad: the source pad to connect
+ * @sinkpad: the sink pad to connect
+ *
+ * connects the source pad to the sink pad
+ */
void gst_pad_connect(GstPad *srcpad,GstPad *sinkpad) {
GstPad *temppad;
@@ -348,6 +403,13 @@ void gst_pad_connect(GstPad *srcpad,GstPad *sinkpad) {
/* FIXME: set connected flag */
}
+/**
+ * gst_pad_set_parent:
+ * @pad: the pad to set the parent
+ * @parent: the object to set the parent to
+ *
+ * sets the parent object of a pad.
+ */
void gst_pad_set_parent(GstPad *pad,GstObject *parent) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -361,6 +423,13 @@ void gst_pad_set_parent(GstPad *pad,GstObject *parent) {
pad->parent = parent;
}
+/**
+ * gst_pad_add_ghost_parent:
+ * @pad: the pad to set the ghost parent
+ * @parent: the object to set the ghost parent to
+ *
+ * add a ghost parent object to a pad.
+ */
void gst_pad_add_ghost_parent(GstPad *pad,GstObject *parent) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -371,6 +440,13 @@ void gst_pad_add_ghost_parent(GstPad *pad,GstObject *parent) {
}
+/**
+ * gst_pad_remove_ghost_parent:
+ * @pad: the pad to remove the ghost parent
+ * @parent: the object to remove the ghost parent from
+ *
+ * remove a ghost parent object from a pad.
+ */
void gst_pad_remove_ghost_parent(GstPad *pad,GstObject *parent) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -380,6 +456,14 @@ void gst_pad_remove_ghost_parent(GstPad *pad,GstObject *parent) {
pad->ghostparents = g_list_remove(pad->ghostparents,parent);
}
+/**
+ * gst_pad_get_parent:
+ * @pad: the pad to get the parent from
+ *
+ * get the parent object of this pad
+ *
+ * Returns: the parent object
+ */
GstObject *gst_pad_get_parent(GstPad *pad) {
g_return_val_if_fail(pad != NULL, NULL);
g_return_val_if_fail(GST_IS_PAD(pad), NULL);
@@ -387,6 +471,14 @@ GstObject *gst_pad_get_parent(GstPad *pad) {
return pad->parent;
}
+/**
+ * gst_pad_get_ghost_parents:
+ * @pad: the pad to get the ghost parents from
+ *
+ * get the ghost parents of this pad
+ *
+ * Returns: a list of ghost parent objects
+ */
GList *gst_pad_get_ghost_parents(GstPad *pad) {
g_return_val_if_fail(pad != NULL, NULL);
g_return_val_if_fail(GST_IS_PAD(pad), NULL);
@@ -394,6 +486,14 @@ GList *gst_pad_get_ghost_parents(GstPad *pad) {
return pad->ghostparents;
}
+/**
+ * gst_pad_get_type_id:
+ * @pad: the pad to get the type id from
+ *
+ * get the type of this pad
+ *
+ * Returns: the type of this pad
+ */
guint16 gst_pad_get_type_id(GstPad *pad) {
g_return_val_if_fail(pad != NULL, 0);
g_return_val_if_fail(GST_IS_PAD(pad), 0);
@@ -401,6 +501,13 @@ guint16 gst_pad_get_type_id(GstPad *pad) {
return pad->type;
}
+/**
+ * gst_pad_set_type_id:
+ * @pad: the pad to set the type id to
+ * @id: the type id to set this pad to
+ *
+ * set the type of this pad
+ */
void gst_pad_set_type_id(GstPad *pad,guint16 id) {
g_return_if_fail(pad != NULL);
g_return_if_fail(GST_IS_PAD(pad));
@@ -409,6 +516,14 @@ void gst_pad_set_type_id(GstPad *pad,guint16 id) {
pad->type = id;
}
+/**
+ * gst_pad_get_peer:
+ * @pad: the pad to get the peer from
+ *
+ * Get the peer pad of this pad
+ *
+ * Returns: the peer pad
+ */
GstPad *gst_pad_get_peer(GstPad *pad) {
g_return_val_if_fail(pad != NULL, NULL);
g_return_val_if_fail(GST_IS_PAD(pad), NULL);
@@ -428,15 +543,13 @@ static void gst_pad_real_destroy(GtkObject *object) {
/**
- * gst_pad_handle_qos:
+ * gst_pad_load_and_connect:
* @parent: the parent XML node to read the description from
* @element: the element that has the source pad
* @elements: a hashtable with elements
*
* Read the pad definition from the XML node and connect the given pad
* in element to a pad of an element in the hashtable.
- *
- * Returns: the new Pad definition.
*/
void gst_pad_load_and_connect(xmlNodePtr parent, GstObject *element, GHashTable *elements) {
xmlNodePtr field = parent->childs;
@@ -477,6 +590,15 @@ cleanup:
}
+/**
+ * gst_pad_save_thyself:
+ * @pad: the pad to save
+ * @parent: the parent XML node to save the description in
+ *
+ * Saves the pad into an xml representation
+ *
+ * Returns: the xml representation of the pad
+ */
xmlNodePtr gst_pad_save_thyself(GstPad *pad,xmlNodePtr parent) {
GstPad *peer;
@@ -494,6 +616,16 @@ xmlNodePtr gst_pad_save_thyself(GstPad *pad,xmlNodePtr parent) {
return parent;
}
+/**
+ * gst_pad_ghost_save_thyself:
+ * @pad: the pad to save
+ * @bin: the bin
+ * @parent: the parent XML node to save the description in
+ *
+ * Saves the ghost pad into an xml representation
+ *
+ * Returns: the xml representation of the pad
+ */
xmlNodePtr gst_pad_ghost_save_thyself(GstPad *pad,GstElement *bin,xmlNodePtr parent) {
xmlNodePtr self;
diff --git a/gst/gstplugin.c b/gst/gstplugin.c
index 8ea28be4c..171bc5960 100644
--- a/gst/gstplugin.c
+++ b/gst/gstplugin.c
@@ -348,6 +348,14 @@ GstElementFactory *gst_plugin_find_elementfactory(gchar *name) {
return NULL;
}
+/**
+ * gst_plugin_load_elementfactory:
+ * @name: name of elementfactory to load
+ *
+ * Load a registered elementfactory by name.
+ *
+ * Returns: @GstElementFactory if loaded, NULL if not
+ */
GstElementFactory *gst_plugin_load_elementfactory(gchar *name) {
GList *plugins, *factories;
GstElementFactory *factory = NULL;
@@ -380,6 +388,12 @@ GstElementFactory *gst_plugin_load_elementfactory(gchar *name) {
return factory;
}
+/**
+ * gst_plugin_load_typefactory:
+ * @mime: name of typefactory to load
+ *
+ * Load a registered typefactory by mime type.
+ */
void gst_plugin_load_typefactory(gchar *mime) {
GList *plugins, *factories;
GstTypeFactory *factory;
@@ -416,7 +430,7 @@ void gst_plugin_load_typefactory(gchar *mime) {
* @plugin: plugin to add factory to
* @factory: factory to add
*
- * Add factory to the list of those provided by the element.
+ * Add factory to the list of those provided by the plugin.
*/
void gst_plugin_add_factory(GstPlugin *plugin,GstElementFactory *factory) {
g_return_if_fail(plugin != NULL);
@@ -426,6 +440,13 @@ void gst_plugin_add_factory(GstPlugin *plugin,GstElementFactory *factory) {
plugin->elements = g_list_append(plugin->elements,factory);
}
+/**
+ * gst_plugin_add_type:
+ * @plugin: plugin to add type to
+ * @factory: the typefactory to add
+ *
+ * Add a typefactory to the list of those provided by the plugin.
+ */
void gst_plugin_add_type(GstPlugin *plugin,GstTypeFactory *factory) {
g_return_if_fail(plugin != NULL);
g_return_if_fail(factory != NULL);
@@ -445,6 +466,14 @@ GList *gst_plugin_get_list() {
return _gst_plugins;
}
+/**
+ * gst_plugin_save_thyself:
+ * @parent: the parent node to save the plugin to
+ *
+ * saves the plugin into an XML representation
+ *
+ * Returns: the new XML node
+ */
xmlNodePtr gst_plugin_save_thyself(xmlNodePtr parent) {
xmlNodePtr tree, subtree;
GList *plugins = NULL, *elements = NULL, *types = NULL;
@@ -479,6 +508,12 @@ xmlNodePtr gst_plugin_save_thyself(xmlNodePtr parent) {
return parent;
}
+/**
+ * gst_plugin_load_thyself:
+ * @parent: the parent node to load the plugin from
+ *
+ * load the plugin from an XML representation
+ */
void gst_plugin_load_thyself(xmlNodePtr parent) {
xmlNodePtr kinderen;
gint elementcount = 0;
diff --git a/gst/gstthread.c b/gst/gstthread.c
index 2a2cf246b..6c2c2b444 100644
--- a/gst/gstthread.c
+++ b/gst/gstthread.c
@@ -57,6 +57,7 @@ static void gst_thread_restore_thyself(GstElement *element,xmlNodePtr parent, GH
static void gst_thread_signal_thread(GstThread *thread);
static void gst_thread_create_plan_dummy(GstBin *bin);
+static void *gst_thread_main_loop(void *arg);
static GstBin *parent_class = NULL;
//static guint gst_thread_signals[LAST_SIGNAL] = { 0 };
@@ -253,7 +254,7 @@ static GstElementStateReturn gst_thread_change_state(GstElement *element) {
* The main loop of the thread. The thread will iterate
* while the state is GST_THREAD_STATE_SPINNING
*/
-void *gst_thread_main_loop(void *arg) {
+static void *gst_thread_main_loop(void *arg) {
GstThread *thread = GST_THREAD(arg);
gst_info("gstthread: thread \"%s\" is running with PID %d\n",
diff --git a/gst/gstthread.h b/gst/gstthread.h
index ceac92dcd..bdecf353a 100644
--- a/gst/gstthread.h
+++ b/gst/gstthread.h
@@ -69,9 +69,6 @@ struct _GstThreadClass {
GtkType gst_thread_get_type(void);
GstElement *gst_thread_new(guchar *name);
-void *gst_thread_main_loop(void *arg);
-void gst_thread_iterate(GstThread *thread);
-
#ifdef __cplusplus
}
#endif /* __cplusplus */
diff --git a/gst/gstutils.c b/gst/gstutils.c
index cc631706f..2d2c32ea2 100644
--- a/gst/gstutils.c
+++ b/gst/gstutils.c
@@ -20,6 +20,15 @@
#include <gtk/gtk.h>
+/**
+ * gst_util_get_int_arg:
+ * @object: the object to query
+ * @argname: the name of the argument
+ *
+ * retrieves a property of an object as an integer
+ *
+ * Returns: the property of the object
+ */
gint gst_util_get_int_arg(GtkObject *object,guchar *argname) {
GtkArg arg;
@@ -28,6 +37,15 @@ gint gst_util_get_int_arg(GtkObject *object,guchar *argname) {
return GTK_VALUE_INT(arg);
}
+/**
+ * gst_util_get_long_arg:
+ * @object: the object to query
+ * @argname: the name of the argument
+ *
+ * retrieves a property of an object as a long
+ *
+ * Returns: the property of the object
+ */
glong gst_util_get_long_arg(GtkObject *object,guchar *argname) {
GtkArg arg;
@@ -36,6 +54,15 @@ glong gst_util_get_long_arg(GtkObject *object,guchar *argname) {
return GTK_VALUE_LONG(arg);
}
+/**
+ * gst_util_get_float_arg:
+ * @object: the object to query
+ * @argname: the name of the argument
+ *
+ * retrieves a property of an object as a float
+ *
+ * Returns: the property of the object
+ */
gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) {
GtkArg arg;
@@ -44,6 +71,15 @@ gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) {
return GTK_VALUE_FLOAT(arg);
}
+/**
+ * gst_util_get_double_arg:
+ * @object: the object to query
+ * @argname: the name of the argument
+ *
+ * retrieves a property of an object as a double
+ *
+ * Returns: the property of the object
+ */
gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) {
GtkArg arg;
@@ -52,6 +88,15 @@ gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) {
return GTK_VALUE_DOUBLE(arg);
}
+/**
+ * gst_util_get_string_arg:
+ * @object: the object to query
+ * @argname: the name of the argument
+ *
+ * retrieves a property of an object as a string
+ *
+ * Returns: the property of the object
+ */
guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) {
GtkArg arg;
@@ -60,6 +105,15 @@ guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) {
return GTK_VALUE_STRING(arg);
}
+/**
+ * gst_util_get_pointer_arg:
+ * @object: the object to query
+ * @argname: the name of the argument
+ *
+ * retrieves a property of an object as a pointer
+ *
+ * Returns: the property of the object
+ */
gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) {
GtkArg arg;
@@ -68,6 +122,15 @@ gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) {
return GTK_VALUE_POINTER(arg);
}
+/**
+ * gst_util_get_widget_arg:
+ * @object: the object to query
+ * @argname: the name of the argument
+ *
+ * retrieves a property of an object as a widget
+ *
+ * Returns: the property of the object
+ */
GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) {
GtkArg arg;
@@ -76,6 +139,14 @@ GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) {
return GTK_WIDGET(GTK_VALUE_OBJECT(arg));
}
+/**
+ * gst_util_dump_mem:
+ * @mem: a pointer to the memory to dump
+ * @size: the size of the memory block to dump
+ *
+ * dumps the memory block into a hex representation. usefull
+ * for debugging.
+ */
void gst_util_dump_mem(guchar *mem, guint size) {
guint i, j;
diff --git a/gst/gstxml.c b/gst/gstxml.c
index 9ad5d763c..4d702438d 100644
--- a/gst/gstxml.c
+++ b/gst/gstxml.c
@@ -124,7 +124,7 @@ GstXML *gst_xml_new(const guchar *fname, const guchar *root) {
* @xml: The GstXML to get the element from
* @name: The name of element to retreive
*
- * This function is used to get a pointer to the GStElement corresponding
+ * This function is used to get a pointer to the GstElement corresponding
* to name in the pipeline description. You would use this if you have
* to do anything to the element after loading.
*