summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/gst/gstreamer-docs.sgml3
-rw-r--r--docs/gst/gstreamer-sections.txt41
-rw-r--r--docs/gst/gstreamer.hierarchy1
-rw-r--r--docs/gst/tmpl/gst.sgml21
-rw-r--r--docs/gst/tmpl/gstautoplug.sgml86
-rw-r--r--docs/gst/tmpl/gstbin.sgml30
-rw-r--r--docs/gst/tmpl/gstbuffer.sgml98
-rw-r--r--docs/gst/tmpl/gstbufferpool.sgml27
-rw-r--r--docs/gst/tmpl/gstcaps.sgml136
-rw-r--r--docs/gst/tmpl/gstcpu.sgml4
-rw-r--r--docs/gst/tmpl/gstdisksink.sgml36
-rw-r--r--docs/gst/tmpl/gstfakesink.sgml5
-rw-r--r--docs/gst/tmpl/gstidentity.sgml5
-rw-r--r--docs/gst/tmpl/gstpad.sgml175
-rw-r--r--docs/gst/tmpl/gstparse.sgml31
-rw-r--r--docs/gst/tmpl/gstpipeline.sgml6
-rw-r--r--docs/gst/tmpl/gstplugin.sgml63
-rw-r--r--docs/gst/tmpl/gstprops.sgml51
-rw-r--r--docs/gst/tmpl/gstreamer-unused.sgml19
-rw-r--r--docs/libs/Makefile.am2
20 files changed, 733 insertions, 107 deletions
diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index 5d4f9574ed..50ddbc9f84 100644
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -32,6 +32,7 @@
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
+<!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
@@ -122,6 +123,8 @@ with some more specialized elements.</para>
&GstFakeSink;
&GstDiskSrc;
+ &GstDiskSink;
+
&GstHttpSrc;
&GstSineSrc;
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index ca9923f14c..6962909f91 100644
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -27,6 +27,9 @@ cothread_get_data
gst_init
gst_main
gst_main_quit
+GST_VERSION_MICRO
+GST_VERSION_MAJOR
+GST_VERSION_MINOR
<SUBSECTION Standard>
</SECTION>
@@ -130,19 +133,25 @@ GST_BUFFER_FLAGS
GST_BUFFER_FLAG_IS_SET
GST_BUFFER_FLAG_SET
GST_BUFFER_FLAG_UNSET
-GST_BUFFER_TYPE
GST_BUFFER_DATA
GST_BUFFER_SIZE
GST_BUFFER_OFFSET
GST_BUFFER_MAXSIZE
GST_BUFFER_TIMESTAMP
+GST_BUFFER_BUFFERPOOL
+GST_BUFFER_POOL_PRIVATE
GST_BUFFER_LOCK
GST_BUFFER_TRYLOCK
GST_BUFFER_UNLOCK
+GST_BUFFER_PARENT
+GST_BUFFER_MAXAGE
+
+
GstBufferFlags
GstBuffer
gst_buffer_new
gst_buffer_new_from_pool
+gst_buffer_copy
gst_buffer_create_sub
gst_buffer_append
gst_buffer_ref
@@ -367,12 +376,11 @@ GstPadGetRegionFunction
GstPadQoSFunction
GstPadEOSFunction
GstPadNewCapsFunction
-
+GstPadBufferPoolFunction
GstPadNegotiateReturn
GstPadNegotiateFunction
-
GstPadPushFunction
GstPadPullFunction
GstRegionType
@@ -391,6 +399,7 @@ gst_pad_set_negotiate_function
gst_pad_set_qos_function
gst_pad_set_eos_function
gst_pad_set_newcaps_function
+gst_pad_set_bufferpool_function
gst_pad_set_caps
gst_pad_get_caps
gst_pad_check_compatibility
@@ -410,6 +419,7 @@ gst_pad_disconnect
gst_pad_push
gst_pad_pull
gst_pad_pullregion
+gst_pad_get_bufferpool
gst_pad_set_eos
gst_pad_handle_qos
gst_pad_eos
@@ -439,6 +449,7 @@ GST_RPAD_QOSFUNC
GST_RPAD_EOSFUNC
GST_RPAD_NEGOTIATEFUNC
GST_RPAD_NEWCAPSFUNC
+GST_RPAD_BUFFERPOOLFUNC
GST_GPAD_REALPAD
GstGhostPad
@@ -450,6 +461,9 @@ GST_PADTEMPLATE_CAPS
GST_PADTEMPLATE_DIRECTION
GST_PADTEMPLATE_NAME_TEMPLATE
GST_PADTEMPLATE_PRESENCE
+GST_PADTEMPLATE_NEW
+GST_PADTEMPLATE_FACTORY
+GST_PADTEMPLATE_GET
gst_padtemplate_new
gst_padtemplate_load_thyself
gst_padtemplate_save_thyself
@@ -512,8 +526,8 @@ gst_pipeline_details
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
GstPlugin
-GstPluginElement
GstPluginInitFunc
+GstPluginDesc
gst_plugin_new
gst_plugin_set_name
gst_plugin_get_name
@@ -615,6 +629,9 @@ gst_typefactory_save_thyself
GST_CAPS_LOCK
GST_CAPS_TRYLOCK
GST_CAPS_UNLOCK
+GST_CAPS_NEW
+GST_CAPS_FACTORY
+GST_CAPS_GET
GstCaps
gst_caps_new
gst_caps_destroy
@@ -622,6 +639,7 @@ gst_caps_ref
gst_caps_unref
gst_caps_copy
gst_caps_copy_on_write
+gst_caps_chain
gst_caps_append
gst_caps_prepend
gst_caps_set_name
@@ -652,6 +670,7 @@ GST_CAPS
<TITLE>GstProps</TITLE>
GstProps
GST_MAKE_FOURCC
+GST_STR_FOURCC
GST_PROPS_LIST
GST_PROPS_INT
GST_PROPS_INT_RANGE
@@ -912,6 +931,20 @@ GST_IS_TYPEFIND_CLASS
</SECTION>
<SECTION>
+<FILE>gstdisksink</FILE>
+<TITLE>GstDiskSink</TITLE>
+GstDiskSinkFlags
+<SUBSECTION Standard>
+GstDiskSink
+GST_DISKSINK
+GST_IS_DISKSINK
+GST_TYPE_DISKSINK
+gst_disksink_get_type
+GST_DISKSINK_CLASS
+GST_IS_DISKSINK_CLASS
+</SECTION>
+
+<SECTION>
<FILE>gstmultidisksrc</FILE>
<TITLE>GstMultiDiskSrc</TITLE>
GstMultiDiskSrcFlags
diff --git a/docs/gst/gstreamer.hierarchy b/docs/gst/gstreamer.hierarchy
index 3fcebbbbf3..758dabba47 100644
--- a/docs/gst/gstreamer.hierarchy
+++ b/docs/gst/gstreamer.hierarchy
@@ -9,6 +9,7 @@ GtkObject
GstFakeSrc
GstFakeSink
GstDiskSrc
+ GstDiskSink
GstHttpSrc
GstFdSrc
GstSineSrc
diff --git a/docs/gst/tmpl/gst.sgml b/docs/gst/tmpl/gst.sgml
index c254b7790a..546b49c682 100644
--- a/docs/gst/tmpl/gst.sgml
+++ b/docs/gst/tmpl/gst.sgml
@@ -53,3 +53,24 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
+<!-- ##### MACRO GST_VERSION_MICRO ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_VERSION_MAJOR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_VERSION_MINOR ##### -->
+<para>
+
+</para>
+
+
+
diff --git a/docs/gst/tmpl/gstautoplug.sgml b/docs/gst/tmpl/gstautoplug.sgml
index 528b68724e..ff407eac19 100644
--- a/docs/gst/tmpl/gstautoplug.sgml
+++ b/docs/gst/tmpl/gstautoplug.sgml
@@ -7,12 +7,92 @@ Automatically create and connect elements
<!-- ##### SECTION Long_Description ##### -->
<para>
GstAutoplug is an abstract class that is used for constructing and
-connecting elements.
+connecting elements. Two types og autopluggers exist: renderer ones and non
+renderer ones. the renderer autopluggers will not have any src pads while the
+non renderer ones do.
+</para>
+
+<para>
+You first need to create a suitable autoplugger with gst_autoplugfactory_make().
+The name of the autoplugger must be one of the registered autopluggers
+(see #GstStaticAutoplug and #GstStaticAutoplugRender).
+</para>
+<para>
+A list of all available autopluggers can be obtained with gst_autoplugfactory_get_list().
+</para>
+<para>
+If the autoplugger supports the RENDERER API, use gst_autoplug_to_renderers() call to
+create a bin that connectes the src caps to the specified rendrer elements. You can
+then add the bin to a pipeline and run it.
+
+ <programlisting>
+ GstAutoplug *autoplug;
+ GstElement *element;
+ GstElement *sink;
+
+ /* create a static autoplugger */
+ autoplug = gst_autoplugfactory_make ("staticrender");
+
+ /* create an osssink */
+ sink = gst_elementfactory_make ("osssink", "our_sink");
+
+ /* create an element that can play audio/mp3 through osssink */
+ element = gst_autoplug_to_renderers (autoplug,
+ gst_caps_new (
+ "sink_audio_caps",
+ "audio/mp3",
+ NULL
+ ),
+ sink,
+ NULL);
+
+ /* add the element to a bin and connect the sink pad */
+ ...
+ </programlisting>
+</para>
+<para>
+If the autoplugger supports the CAPS API, use gst_autoplug_to_caps() call to
+connect the src caps to the destination caps. The created bin will have src pads
+compatible with the provided sink caps.
+
+ <programlisting>
+ GstAutoplug *autoplug;
+ GstElement *element;
+
+ /* create a static autoplugger */
+ autoplug = gst_autoplugfactory_make ("static");
+
+ /* create an element that converts audio/mp3 to audio/raw */
+ element = gst_autoplug_to_caps (autoplug,
+ gst_caps_new (
+ "sink_audio_caps",
+ "audio/mp3",
+ NULL
+ ),
+ gst_caps_new (
+ "src_audio_caps",
+ "audio/raw",
+ NULL
+ ),
+ NULL);
+
+ /* add the element to a bin and connect the src/sink pads */
+ ...
+ </programlisting>
</para>
-<!-- ##### SECTION See_Also ##### -->
<para>
+Optionally you can get a notification when a new object is added to the created
+pipeline with a gtk_signal_connect to the "new_object" signal.
+</para>
+<para>
+Use the regular gst_object_destroy() call to destroy the autoplugger.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+GstStaticAutoplug, GstStaticAutoplugRender
</para>
<!-- ##### STRUCT GstAutoplug ##### -->
@@ -24,7 +104,7 @@ connecting elements.
<!-- ##### ENUM GstAutoplugFlags ##### -->
<para>
-
+The type of the autoplugger.
</para>
@GST_AUTOPLUG_TO_CAPS:
diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml
index f4840c4968..780ad46c77 100644
--- a/docs/gst/tmpl/gstbin.sgml
+++ b/docs/gst/tmpl/gstbin.sgml
@@ -11,6 +11,32 @@ become children of itself. Pads from the child elements can be ghosted to
the bin, making the bin itself look transparently like any other element,
allowing for deep nesting of predefined sub-pipelines.
</para>
+<para>
+A new GstBin is created with gst_bin_new()
+</para>
+<para>
+After the bin has been created you will typically add elements to it with
+gst_bin_add(). You can remove elements with gst_bin_remove().
+</para>
+<para>
+An element can be retrieved from a bin with gst_bin_get_by_name(), using the
+elements name. gst_bin_get_by_name_recurse_up() is mainly used for internal
+purposes and will query the parent bins when the element is not found in the
+current bin.
+</para>
+<para>
+The list of elements in a bin can be retrieved with gst_bin_get_list().
+</para>
+<para>
+After the bin has been set to the PLAYING state (with gst_element_set_state()),
+gst_bin_iterate() is used to process the elements in the bin.
+</para>
+<para>
+The "object_added" signal is fired whenever a new object is added to the bin.
+</para>
+<para>
+gst_bin_destroy() is used to destroy the bin.
+</para>
<!-- ##### SECTION See_Also ##### -->
<para>
@@ -43,10 +69,10 @@ Flags for a bin.
<!-- ##### MACRO gst_bin_destroy ##### -->
<para>
-
+Free the memory allocated by this bin
</para>
-@bin:
+@bin: the bin to free
<!-- ##### FUNCTION gst_bin_add ##### -->
diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml
index 9e6f6a2913..c57caf70fd 100644
--- a/docs/gst/tmpl/gstbuffer.sgml
+++ b/docs/gst/tmpl/gstbuffer.sgml
@@ -10,13 +10,54 @@ Buffers are the basic unit of data transfer in GST. The GstBuffer type
provides all the state necessary to define a region of memory as part of a
stream. Sub-buffer are also supported, allowing a smaller region of a
buffer to become its own buffer, with mechanisms in place to ensure that
-nither memory space goes away. Metadata is supported as a list of
+neither memory space goes away. Metadata is supported as a list of
pointers to arbitrary metadata.
</para>
+<para>
+Buffers are usually created with gst_buffer_new(). After a buffer has been
+created one will typically allocate memory for it and set the size of the
+buffer data.
+<programlisting>
+ GstBuffer *buffer;
+ gint size, widht, height, bpp;
+
+ size = width * height * bpp;
+
+ buffer = gst_buffer_new ();
+ GST_BUFFER_SIZE (buffer) = size;
+ GST_BUFFER_DATA (buffer) = g_alloc (size);
+ ...
+
+</programlisting>
+</para>
+<para>
+GstBuffers can also be created from a GstBufferPool with
+gst_buffer_new_from_pool(). The bufferpool can be obtained from a
+peer element with gst_pad_get_bufferpool().
+</para>
+<para>
+gst_buffer_ref() is used to increase the refcount of a buffer. This must be
+done when you want to keep a handle to the buffer after pushing it to the
+next element.
+</para>
+<para>
+To efficiently create a smaller buffer out of an existing one, you can
+use gst_buffer_create_sub().
+</para>
+<para>
+Several flags of the buffer can be set and unset with the GST_BUFFER_FLAG_SET()
+and GST_BUFFER_FLAG_UNSET() macros. Use GST_BUFFER_FLAG_IS_SET() to test it
+a certain flag is set.
+</para>
+<para>
+Buffers usually are freed by unreffing them with gst_buffer_unref().
+gst_buffer_destroy() can also be used to effectively destroy the buffer
+regardless of the refcount (dangerous).
+</para>
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GstBufferPool, #GstPad
</para>
<!-- ##### MACRO GST_BUFFER_FLAGS ##### -->
@@ -54,14 +95,6 @@ Clear a flag in a buffer.
@flag: the flag to clear
-<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
-<para>
-Retrieves the type id of the data in the buffer.
-</para>
-
-@buf: GstBuffer
-
-
<!-- ##### MACRO GST_BUFFER_DATA ##### -->
<para>
Retrieves a pointer to the data element of this buffer
@@ -88,7 +121,7 @@ Get the offset in the source file of this buffer.
<!-- ##### MACRO GST_BUFFER_MAXSIZE ##### -->
<para>
-
+Gets the maximun size of this buffer.
</para>
@buf: GstBuffer
@@ -102,6 +135,22 @@ Get the timestamp for this buffer.
@buf: GstBuffer
+<!-- ##### MACRO GST_BUFFER_BUFFERPOOL ##### -->
+<para>
+Get the bufferpool for this buffer.
+</para>
+
+@buf: GstBuffer
+
+
+<!-- ##### MACRO GST_BUFFER_POOL_PRIVATE ##### -->
+<para>
+Get the bufferpool private data.
+</para>
+
+@buf: GstBuffer
+
+
<!-- ##### MACRO GST_BUFFER_LOCK ##### -->
<para>
This macro will obtain a lock on the object, making serialization
@@ -131,6 +180,22 @@ This macro releases a lock on the object.
@buf: GstBuffer to unlock.
+<!-- ##### MACRO GST_BUFFER_PARENT ##### -->
+<para>
+Get the parent of this buffer. The parent is set on subbuffers.
+</para>
+
+@buf: GstBuffer to get the parent of.
+
+
+<!-- ##### MACRO GST_BUFFER_MAXAGE ##### -->
+<para>
+Get the maximun age of a buffer.
+</para>
+
+@buf: GstBuffer to get the maxage of.
+
+
<!-- ##### ENUM GstBufferFlags ##### -->
<para>
@@ -150,7 +215,6 @@ used when data in a stream has been skipped
</para>
@lock:
-@flags:
@data:
@size:
@maxsize:
@@ -160,6 +224,7 @@ used when data in a stream has been skipped
@metas:
@parent:
@pool:
+@pool_private:
<!-- ##### FUNCTION gst_buffer_new ##### -->
<para>
@@ -178,6 +243,15 @@ used when data in a stream has been skipped
@Returns:
+<!-- ##### FUNCTION gst_buffer_copy ##### -->
+<para>
+
+</para>
+
+@buffer:
+@Returns:
+
+
<!-- ##### FUNCTION gst_buffer_create_sub ##### -->
<para>
diff --git a/docs/gst/tmpl/gstbufferpool.sgml b/docs/gst/tmpl/gstbufferpool.sgml
index 24243edbae..075f996f9a 100644
--- a/docs/gst/tmpl/gstbufferpool.sgml
+++ b/docs/gst/tmpl/gstbufferpool.sgml
@@ -10,17 +10,40 @@ A bufferpool is used to create buffers in an efficient way. En element
can maintain a bufferpool with a fixed number of buffers. This will reduce
the g_malloc and g_free overhead.
</para>
-
<para>
A bufferpool can also be used to implement direct access. A bufferpool can be
sent from one element to another so that the latter can directly write into
the memory of the element that maintains the bufferpool. This can greatly reduce
the number of memcpy operations.
</para>
+<para>
+A bufferpool is created with gst_buffer_pool_new(). You'll have to set the
+buffer allocation and destroy function afterwards with gst_buffer_pool_set_create_function() and
+gst_buffer_pool_set_destroy_function().
+</para>
+<para>
+To create a buffer from the bufferpool use gst_buffer_pool_new_buffer(), which is
+functionally equivalent to gst_buffer_new_from_pool().
+</para>
+<para>
+When the buffer is unreffed and has reached a refcount of 0, the bufferpools destroy
+function is called with the buffer as an argument.
+</para>
+<para>
+A bufferpool can store private data in the buffer it creates with the GST_BUFFER_POOL_PRIVATE()
+macro. To check it a buffer was made by a specific bufferpool, use the GST_BUFFER_BUFFERPOOL()
+macro to get it's bufferpool.
+</para>
+<para>
+Destroy the bufferpool with gst_buffer_pool_destroy().
+</para>
+<para>
+A bufferpool can be requested from a pad with the gst_pad_get_bufferpool() function.
+</para>
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GstBuffer, #GstPad
</para>
<!-- ##### STRUCT GstBufferPool ##### -->
diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml
index 9f1e9f3fc4..b3e9fb9b4d 100644
--- a/docs/gst/tmpl/gstcaps.sgml
+++ b/docs/gst/tmpl/gstcaps.sgml
@@ -7,12 +7,72 @@ Capabilities of pads
<!-- ##### SECTION Long_Description ##### -->
<para>
GstCaps is used to attach capabilities to a pad. Capabilities are made of
-a mime-type and a set of properties.
+a mime-type and a set of properties. GstCaps can be named and chained into
+a list, which is then a GstCaps on its own.
</para>
+<para>
+GstCaps are created with gst_caps_new(), which takes a name, a mime type and
+a pointer to a #GstProps. A convenience macro with a cleaner syntax is
+available to create a caps with GST_CAPS_NEW(). The following example shows how
+to create a GstCaps.
+<programlisting>
+ GstCaps *caps;
+
+ caps = gst_caps_new (
+ "my_caps", /* capability name */
+ "audio/raw", /* mime type */
+ gst_props_new ( /* properties */
+ "format", GST_PROPS_STRING ("float"),
+ "layout", GST_PROPS_INT (5),
+ NULL));
+</programlisting>
+
+The following code example is equivalent to the above example:
+<programlisting>
+ GstCaps *caps;
+
+ caps = GST_CAPS_NEW (
+ "my_caps", /* capability name */
+ "audio/raw", /* mime type */
+ "format", GST_PROPS_STRING ("float"),
+ "channels", GST_PROPS_INT (5)
+ );
+</programlisting>
+</para>
+<para>
+GstCaps are refcounted with gst_caps_ref() and gst_caps_unref().
+</para>
+<para>
+GstCaps can be chained with the gst_caps_append(), gst_caps_prepend() and
+gst_caps_chain() functions. Use gst_caps_get_by_name() to get a named caps
+structure from a chained list.
+</para>
+<para>
+To get the properties of a caps structure the functions
+gst_caps_get_boolean(), gst_caps_get_fourcc_int(), gst_caps_get_int(),
+gst_caps_get_string(), which all take a property name as an argument.
+</para>
+<para>
+The properties of the caps structure can be modified with gst_caps_set, which
+takes a list of key value pairs in the #GstProps syntax as shown by this example:
-<!-- ##### SECTION See_Also ##### -->
+<programlisting>
+ GstCaps *caps;
+ ....
+
+ gst_caps_set (caps, "format", GST_PROPS_STRING ("int"), NULL);
+ gst_caps_set (caps, "channels", GST_PROPS_INT (20), NULL);
+
+</programlisting>
+</para>
<para>
+before modifying a GstCaps, it is a good idea to make a copy if it first with
+gst_caps_copy_on_write(). This will copy thr GstCaps if the refcount is &gt;1.
+</para>
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#GstProps, #GstPad
</para>
<!-- ##### MACRO GST_CAPS_LOCK ##### -->
@@ -39,6 +99,34 @@ Unlock the caps structure
@caps: The caps structure to unlock
+<!-- ##### MACRO GST_CAPS_NEW ##### -->
+<para>
+A convenience macro to create a new GstCaps structure.
+</para>
+
+@name: the name of the caps structure
+@type: the mime type of the caps structure
+@a...: the properties of this caps stucture.
+
+
+<!-- ##### MACRO GST_CAPS_FACTORY ##### -->
+<para>
+A convenience macro to create a GstCaps factory.
+</para>
+
+@factoryname: the name of the factory
+@a...: the caps to create with this factory, usualy specified
+with GST_CAPS_NEW()
+
+
+<!-- ##### MACRO GST_CAPS_GET ##### -->
+<para>
+A convenience macro to get a GstCaps from the given capsfactory.
+</para>
+
+@fact: the factory to use.
+
+
<!-- ##### STRUCT GstCaps ##### -->
<para>
@@ -76,6 +164,7 @@ Unlock the caps structure
</para>
@caps:
+@Returns:
<!-- ##### FUNCTION gst_caps_unref ##### -->
@@ -84,6 +173,7 @@ Unlock the caps structure
</para>
@caps:
+@Returns:
<!-- ##### FUNCTION gst_caps_copy ##### -->
@@ -104,6 +194,16 @@ Unlock the caps structure
@Returns:
+<!-- ##### FUNCTION gst_caps_chain ##### -->
+<para>
+
+</para>
+
+@caps:
+@Varargs:
+@Returns:
+
+
<!-- ##### FUNCTION gst_caps_append ##### -->
<para>
@@ -212,21 +312,21 @@ Unlock the caps structure
<!-- ##### MACRO gst_caps_set ##### -->
<para>
-
+Set a property of a caps structure.
</para>
-@caps:
-@name:
-@args...:
+@caps: the caps structure to modify
+@name: the name of the property to change
+@args...: the new value of the property
<!-- ##### MACRO gst_caps_get_boolean ##### -->
<para>
-
+Get the value of the named property as a boolean.
</para>
-@caps:
-@name:
+@caps: the caps to query
+@name: the name of the property to get
<!-- ##### FUNCTION gst_caps_get_by_name ##### -->
@@ -241,29 +341,29 @@ Unlock the caps structure
<!-- ##### MACRO gst_caps_get_fourcc_int ##### -->
<para>
-
+Get the value of the named property as a fourcc.
</para>
-@caps:
-@name:
+@caps: the caps to query
+@name: the name of the property to get
<!-- ##### MACRO gst_caps_get_int ##### -->
<para>
-
+Get the value of the named property as an int.
</para>
-@caps:
-@name:
+@caps: the caps to query
+@name: the name of the property to get
<!-- ##### MACRO gst_caps_get_string ##### -->
<para>
-
+Get the value of the named property as a string.
</para>
-@caps:
-@name:
+@caps: the caps to query
+@name: the name of the property to get
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
diff --git a/docs/gst/tmpl/gstcpu.sgml b/docs/gst/tmpl/gstcpu.sgml
index cbf398b4a3..0c3c2e5f89 100644
--- a/docs/gst/tmpl/gstcpu.sgml
+++ b/docs/gst/tmpl/gstcpu.sgml
@@ -10,7 +10,9 @@ Request the features of the CPU.
This module can be used when developing plugins. It is
typically used to enable special optimisations based on the
features of the CPU.
-
+</para>
+<para>
+You'll get a bitmask of flags with gst_cpu_get_flags().
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/docs/gst/tmpl/gstdisksink.sgml b/docs/gst/tmpl/gstdisksink.sgml
new file mode 100644
index 0000000000..1f446df0a3
--- /dev/null
+++ b/docs/gst/tmpl/gstdisksink.sgml
@@ -0,0 +1,36 @@
+<!-- ##### SECTION Title ##### -->
+GstDiskSink
+
+<!-- ##### SECTION Short_Description ##### -->
+Write to a file
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The disksink write to a file. The filename can be given as an argument.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#GstFdSink
+</para>
+
+<!-- ##### ENUM GstDiskSinkFlags ##### -->
+<para>
+
+</para>
+
+@GST_DISKSINK_OPEN:
+@GST_DISKSINK_FLAG_LAST:
+
+<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
+<para>
+Is emited after the buffer has been written to the disk.
+</para>
+
+@gstdisksink: the object which received the signal.
+
+<!-- ##### ARG GstDiskSink:location ##### -->
+<para>
+The filename to write to.
+</para>
+
diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml
index 9d405d62f4..091729ef4a 100644
--- a/docs/gst/tmpl/gstfakesink.sgml
+++ b/docs/gst/tmpl/gstfakesink.sgml
@@ -28,3 +28,8 @@ with the buffer. (fakesink)
</para>
+<!-- ##### ARG GstFakeSink:silent ##### -->
+<para>
+
+</para>
+
diff --git a/docs/gst/tmpl/gstidentity.sgml b/docs/gst/tmpl/gstidentity.sgml
index 996a7a7041..0a059cf432 100644
--- a/docs/gst/tmpl/gstidentity.sgml
+++ b/docs/gst/tmpl/gstidentity.sgml
@@ -24,3 +24,8 @@ Pass data without modification.
</para>
+<!-- ##### ARG GstIdentity:silent ##### -->
+<para>
+
+</para>
+
diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml
index bc51b8eb22..d4ba520522 100644
--- a/docs/gst/tmpl/gstpad.sgml
+++ b/docs/gst/tmpl/gstpad.sgml
@@ -6,14 +6,66 @@ The connection between Elements
<!-- ##### SECTION Long_Description ##### -->
<para>
-Elements are connected to each other via "pads", which are extremely light-weight generic
-connections.
+#GstElement are connected to each other via "pads", which are extremely light-weight generic
+connections. After two pad are retrieved from an element with gst_element_get_pad(), the pads
+can be connected with gst_pad_connect().
+</para>
+<para>
+PedTemplates are use to describe the runtime behaviour of an element and what pads it
+will have during its lifetime. Pads are typically created from a padtemplate with
+GST_PADTEMPLATE_NEW() or with the factory macro GST_PADTEMPLATE_FACTORY().
+</para>
+<para>
+Pad and PadTemplates have #GstCaps attached to it to describe the media type they
+are capable of dealing with. gst_pad_get_caps() and gst_pad_set_caps() are used to
+manipulate the caps of the pads. gst_padtemplate_get_caps() is used to get the
+caps of a padtemplate. It's not possible to modify the caps of a padtemplate after
+creation. The following code example shows the code to create a pad from a padtemplate.
+<programlisting>
+GST_PADTEMPLATE_FACTORY (my_factory,
+ "sink", /* the name of the pad */
+ GST_PAD_SINK, /* the direction of the pad */
+ GST_PAD_ALWAYS, /* when this pad will be present */
+ GST_CAPS_NEW ( /* the capabilities of the padtemplate */
+ "my_caps",
+ "audio/raw",
+ "format", GST_PROPS_STRING ("int"),
+ "channels", GST_PROPS_INT_RANGE (1, 6)
+ )
+)
+void
+my_method (void)
+{
+ GstPad *pad;
+
+ pad = gst_pad_new_from_template (GST_PADTEMPLATE_GET (my_factory), "sink");
+ ...
+}
+</programlisting>
+Pads created from a padtemplate cannot set capabilities that are incompatible with
+the padtemplates capabilities.
+</para>
+<para>
+Pads without padtemplates can be created with gst_pad_new() which takes a direction and
+a name as an argument.
+</para>
+<para>
+gst_pad_get_parent() will retrieve the GstElement that owns the pad.
+</para>
+<para>
+GstElements creating a pad will typicilally use the various gst_pad_set_*_function() calls
+to register callbacks for various events on the pads.
+</para>
+<para>
+GstElements will use gst_pad_push() and gst_pad_pull() to push out or pull a buffer in. The
+gst_pad_pullregion() function can be used to request for a buffer with a specific offset (in
+time or in bytes).
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GstCaps, #GstElement
</para>
<!-- ##### MACRO GST_PAD_NAME ##### -->
@@ -157,11 +209,22 @@ The function that will be called in an EOS case.
<!-- ##### USER_FUNCTION GstPadNewCapsFunction ##### -->
<para>
+The function that will be called when the caps of the pad has
+changed.
+</para>
+
+@pad: The pad that has its caps changed
+@caps: the new caps of the pad
+
+<!-- ##### USER_FUNCTION GstPadBufferPoolFunction ##### -->
+<para>
+The function that will be called when a bufferpool is requested
+from this pad.
</para>
-@pad:
-@caps:
+@pad: the pad with the bufferpool
+@Returns: the GstBufferPool associated with this pad.
<!-- ##### ENUM GstPadNegotiateReturn ##### -->
@@ -180,10 +243,8 @@ The function that will be called when negotiating.
@pad: The pad that is being negotiated
@caps: The current caps that are being negotiated
-@data:
+@data: A generic gpointer that can be used to store user_data
@Returns: The result of the negotiation process
-<!-- # Unused Parameters # -->
-@count: A counter to keep track of the negotiation process
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
@@ -349,6 +410,15 @@ Destroy the pad.
@newcaps:
+<!-- ##### FUNCTION gst_pad_set_bufferpool_function ##### -->
+<para>
+
+</para>
+
+@pad:
+@bufpool:
+
+
<!-- ##### FUNCTION gst_pad_set_caps ##### -->
<para>
@@ -530,6 +600,15 @@ Destroy the pad.
@size:
+<!-- ##### FUNCTION gst_pad_get_bufferpool ##### -->
+<para>
+
+</para>
+
+@pad:
+@Returns:
+
+
<!-- ##### FUNCTION gst_pad_set_eos ##### -->
<para>
@@ -611,26 +690,26 @@ Call the EOS function of the pad
<!-- ##### MACRO GST_RPAD_LEN ##### -->
<para>
-
+Get the length of the region that is being pulled.
</para>
-@pad:
+@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_OFFSET ##### -->
<para>
-
+Get the offset of the region that is being pulled.
</para>
-@pad:
+@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
<para>
-
+Get the type of the region that is being pulled.
</para>
-@pad:
+@pad: the real pad to query.
<!-- ##### STRUCT GstRealPad ##### -->
@@ -657,6 +736,7 @@ Call the EOS function of the pad
@pullregionfunc:
@negotiatefunc:
@newcapsfunc:
+@bufferpoolfunc:
@ghostpads:
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
@@ -757,18 +837,26 @@ Get the EOS function of the real pad.
<!-- ##### MACRO GST_RPAD_NEGOTIATEFUNC ##### -->
<para>
-
+Get the negotiate function from the real pad.
</para>
-@pad:
+@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_NEWCAPSFUNC ##### -->
<para>
+Get the newcaps function from the real pad.
+</para>
+
+@pad: the real pad to query.
+
+<!-- ##### MACRO GST_RPAD_BUFFERPOOLFUNC ##### -->
+<para>
+Get the bufferpoolfunction from the real pad.
</para>
-@pad:
+@pad: the real pad to query.
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
@@ -804,7 +892,8 @@ Indicates when this pad will become available.
@GST_PAD_ALWAYS: the pad is always available
@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
-@GST_PAD_REQUEST:
+@GST_PAD_REQUEST: th pad is only available on request with
+gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
@@ -819,34 +908,66 @@ Indicates when this pad will become available.
<!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### -->
<para>
-
+Get a handle to the padtemplate #GstCaps
</para>
-@templ:
+@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_DIRECTION ##### -->
<para>
-
+Get the direction of the padtemplate.
</para>
-@templ:
+@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_NAME_TEMPLATE ##### -->
<para>
-
+Get the nametemplate of the padtemplate.
</para>
-@templ:
+@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_PRESENCE ##### -->
<para>
+Get the presence of the padtemplate.
+</para>
+
+@templ: the template to query
+
+<!-- ##### MACRO GST_PADTEMPLATE_NEW ##### -->
+<para>
+Create a new padtemplate.
</para>
-@templ:
+@padname: the nametemplate for the pads that will be created with this template
+@dir: the direction of the pads.
+@pres: the presence of the pads.
+@a...: the capabilities of this padtemplate usually created with GST_CAPS_NEW()
+
+
+<!-- ##### MACRO GST_PADTEMPLATE_FACTORY ##### -->
+<para>
+Create a factory for a padtemplate. This can be used if you only want one instance
+of the padtemplate. Use GST_PADTEMPLATE_GET() to get the unique padtemplate.
+</para>
+
+@name: th name of the factory
+@padname: the nametemplate of the pads
+@dir: the direction of the pads.
+@pres: the presence of the pads.
+@a...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW()
+
+
+<!-- ##### MACRO GST_PADTEMPLATE_GET ##### -->
+<para>
+Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY()
+</para>
+
+@fact: the factory name to get the padtemplate from.
<!-- ##### FUNCTION gst_padtemplate_new ##### -->
@@ -860,8 +981,6 @@ Indicates when this pad will become available.
@caps:
@Varargs:
@Returns:
-<!-- # Unused Parameters # -->
-@factory:
<!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
@@ -881,8 +1000,6 @@ Indicates when this pad will become available.
@templ:
@parent:
@Returns:
-<!-- # Unused Parameters # -->
-@pad:
<!-- ##### FUNCTION gst_padtemplate_get_caps ##### -->
diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml
index 5cd6fc2996..44961a548f 100644
--- a/docs/gst/tmpl/gstparse.sgml
+++ b/docs/gst/tmpl/gstparse.sgml
@@ -7,7 +7,36 @@ Parses commandline syntax into a pipeline.
<!-- ##### SECTION Long_Description ##### -->
<para>
This method allows you to create a pipeline from a command
-line syntax description.
+line syntax description. The following example creates a simple
+mp3 player.
+<programlisting>
+ GstElement *pipeline;
+
+ /* create a pipeline to hold our elements */
+ pipeline = gst_pipeline_new ("launch");
+
+ /* build a pipeline in the pipeline */
+ gst_parse_launch ("disksrc location=some.mp3 ! mad ! osssink", GST_BIN (pipeline));
+
+ /* play the thing */
+ gst_element_set_state (pipeline, GST_STATE_PLAYING);
+
+ while (gst_bin_iterate (GST_BIN (pipeline)));
+
+ gst_element_set_state (pipeline, GST_STATE_NULL);
+
+</programlisting>
+</para>
+
+<para>
+Elements are separated with a <option>!</option>, properties are set with
+<replaceable>property</replaceable>=<replaceable>value</replaceable>, specific pads
+of an element are selected by replacing the <option>!</option> with
+<replaceable>padname</replaceable><option>!</option>.
+</para>
+<para>
+Elements can be added to a bin by embracing them with <option>()</option>. Threads
+can be made with <option>{}</option>.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/docs/gst/tmpl/gstpipeline.sgml b/docs/gst/tmpl/gstpipeline.sgml
index f486cfb193..05c2302598 100644
--- a/docs/gst/tmpl/gstpipeline.sgml
+++ b/docs/gst/tmpl/gstpipeline.sgml
@@ -12,12 +12,6 @@ including threading, as well as provide simple interfaces to common
functions, like 'Play'.
</para>
-<para>
-The pipeline also has the capability to autoplug. This feature
-allows you to only define the input/output plugins and let the
-pipeline figure out what plugins to use.
-</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml
index ff213c9327..1b67696aa1 100644
--- a/docs/gst/tmpl/gstplugin.sgml
+++ b/docs/gst/tmpl/gstplugin.sgml
@@ -6,13 +6,51 @@ Dynamically loadable Elements
<!-- ##### SECTION Long_Description ##### -->
<para>
-GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime.
-
+GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime. A plugin
+system can provide one or more of the following basic <application>GStreamer</application>
+objects factories:
+ <itemizedlist>
+ <listitem>
+ <para>
+ A #GstElementFactory: the components to build a pipeline.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A #GstTypeFactory: A MIME type and an optional typefind function.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A #GstAutoplugFactory: An object used to automatically construct pipelines.
+ </para>
+ </listitem>
+ </itemizedlist>
+</para>
+<para>
+A new plugin is created with gst_plugin_new(). this function will return a handle
+to the GstPlugin or NULL if the plugin could not be created.
+</para>
+<para>
+Once a GstPlugin element has been created, you can add the different types of factories
+to it with gst_plugin_add_factory(), gst_plugin_add_type(), gst_plugin_add_autoplugger().
+</para>
+<para>
+<application>Gstreamer</application> plugins should have a method plugin_init that is called
+by the loader.
+</para>
+<para>
+use gst_plugin_find(), gst_plugin_get_list(), gst_plugin_get_factory_list(), gst_plugin_get_type_list() and
+gst_plugin_get_autoplug_list() to query the plugin repository.
+</para>
+<para>
+Plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly
+to bring it into memory.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GstElement, #GstType, #GstAutoplug
</para>
<!-- ##### STRUCT GstPlugin ##### -->
@@ -31,12 +69,6 @@ GStreamer is extensible so <classname>GstElements</classname> can be loaded at r
@numautopluggers:
@loaded:
-<!-- ##### STRUCT GstPluginElement ##### -->
-<para>
-
-</para>
-
-
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<para>
A plugin should implement this function called plugin_init. It will be called
@@ -44,15 +76,28 @@ by the loader at statup.
</para>
@module: The <classname>GModule</classname> it was loaded from
+@plugin:
@Returns: The plugin or NULL is an error was detected.
+<!-- ##### STRUCT GstPluginDesc ##### -->
+<para>
+
+</para>
+
+@major_version:
+@minor_version:
+@name:
+@plugin_init:
+
<!-- ##### FUNCTION gst_plugin_new ##### -->
<para>
</para>
@name:
+@major:
+@minor:
@Returns:
diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml
index 2c5f0eaf16..7b318cbd04 100644
--- a/docs/gst/tmpl/gstprops.sgml
+++ b/docs/gst/tmpl/gstprops.sgml
@@ -12,7 +12,7 @@ are usually used in conjunction with GstCaps.
<!-- ##### SECTION See_Also ##### -->
<para>
-GstCaps
+#GstCaps
</para>
<!-- ##### STRUCT GstProps ##### -->
@@ -26,13 +26,32 @@ GstCaps
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
<para>
+Create a FOURCC value that can easily be used to construct
+a fourcc property.
+<programlisting>
+ ...
+ "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('Y','U','Y','2')),
+ ...
+</programlisting>
+</para>
+
+@a: first fourcc byte
+@b: second fourcc byte
+@c: third fourcc byte
+@d: fourth fourcc byte
+
+<!-- ##### MACRO GST_STR_FOURCC ##### -->
+<para>
+Create a FOURCC value from a string. example:
+<programlisting>
+ ...
+ "format", GST_PROPS_FOURCC (GST_STR_FOURCC ("YUY2")),
+ ...
+</programlisting>
</para>
-@a:
-@b:
-@c:
-@d:
+@f: the string describing the fourcc value.
<!-- ##### MACRO GST_PROPS_LIST ##### -->
@@ -65,11 +84,7 @@ Create an integer range property.
Construct a fourcc property out of four bytes.
</para>
-@a: first byte
-<!-- # Unused Parameters # -->
-@b: second byte
-@c: third byte
-@d: fourth byte
+@a: a fourcc value usualy created with GST_FOURCC_MAKE ()
<!-- ##### MACRO GST_PROPS_BOOLEAN ##### -->
@@ -82,27 +97,27 @@ Create a boolean property.
<!-- ##### MACRO GST_PROPS_STRING ##### -->
<para>
-
+Create a string value.
</para>
-@a:
+@a: the string value.
<!-- ##### MACRO GST_PROPS_FLOAT ##### -->
<para>
-
+Create a floating point value.
</para>
-@a:
+@a: the float value
<!-- ##### MACRO GST_PROPS_FLOAT_RANGE ##### -->
<para>
-
+Create a float range value.
</para>
-@a:
-@b:
+@a: lower float bounds
+@b: upper float bounds
<!-- ##### FUNCTION gst_props_new ##### -->
@@ -113,8 +128,6 @@ Create a boolean property.
@firstname:
@Varargs:
@Returns:
-<!-- # Unused Parameters # -->
-@entry:
<!-- ##### FUNCTION gst_props_newv ##### -->
diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml
index c750b5e1da..fe8813185c 100644
--- a/docs/gst/tmpl/gstreamer-unused.sgml
+++ b/docs/gst/tmpl/gstreamer-unused.sgml
@@ -1421,6 +1421,13 @@ This macro sets the given flags.
@flag: Flag to set, can by any number of bits in guint32.
@obj: GstSrc to set flag in.
+<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
+<para>
+Retrieves the type id of the data in the buffer.
+</para>
+
+@buf: GstBuffer
+
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
@@ -1508,6 +1515,12 @@ Indicates a srcpad for the padfactory.
</para>
+<!-- ##### ARG GstDiskSink:closed ##### -->
+<para>
+
+</para>
+
+
<!-- ##### MACRO GST_IS_SINK_CLASS ##### -->
<para>
@@ -2541,6 +2554,12 @@ This macro checks to see if the GST_SRC_ASYNC flag is set.
</para>
+<!-- ##### STRUCT GstPluginElement ##### -->
+<para>
+
+</para>
+
+
<!-- ##### TYPEDEF GstCapsFactory ##### -->
<para>
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 765237b7ad..953e67606f 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -41,7 +41,7 @@ sgml/$(DOC_MODULE)-doc.bottom: tmpl/$(DOC_MODULE)-unused.sgml
all-local: html
clean-local:
- $(RM) -rf *~ *.bak *.signals *-unused.txt *.args tmpl html sgml tmpl/*.bak $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
+ $(RM) -rf *~ *.bak *.signals *-unused.txt *.args html sgml tmpl/*.bak $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local: html
@$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-18 06:01:28 +0000