From 4f15126b53a426a51c90b11cb2cef571a3f3afc0 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Wed, 4 Jan 2006 12:41:35 +0000 Subject: [PATCH] Small updates to various docs. Original commit message from CVS: * docs/manual/basics-pads.xml: * docs/plugins/Makefile.am: * docs/plugins/gstreamer-plugins-docs.sgml: * docs/plugins/gstreamer-plugins-sections.txt: * docs/pwg/advanced-clock.xml: * docs/pwg/advanced-scheduling.xml: * docs/pwg/advanced-types.xml: * plugins/elements/gstfdsink.c: * plugins/elements/gstfdsrc.c: * plugins/elements/gstfdsrc.h: * plugins/elements/gstidentity.c: (gst_identity_class_init): * plugins/elements/gstidentity.h: * plugins/elements/gstqueue.h: * plugins/elements/gsttee.c: * plugins/elements/gsttee.h: * plugins/elements/gsttypefindelement.c: (gst_type_find_element_class_init): * plugins/elements/gsttypefindelement.h: Small updates to various docs. Added core plugins to docs. --- ChangeLog | 23 +++++++++++ docs/manual/basics-pads.xml | 4 +- docs/plugins/Makefile.am | 6 ++- docs/plugins/gstreamer-plugins-docs.sgml | 4 ++ docs/plugins/gstreamer-plugins-sections.txt | 60 +++++++++++++++++++++++++++++ docs/pwg/advanced-clock.xml | 2 +- docs/pwg/advanced-scheduling.xml | 2 +- docs/pwg/advanced-types.xml | 25 ++---------- plugins/elements/gstfdsink.c | 8 ++++ plugins/elements/gstfdsrc.c | 8 ++++ plugins/elements/gstfdsrc.h | 6 +++ plugins/elements/gstidentity.c | 8 ++++ plugins/elements/gstidentity.h | 6 +++ plugins/elements/gstqueue.h | 3 +- plugins/elements/gsttee.c | 8 ++++ plugins/elements/gsttee.h | 6 +++ plugins/elements/gsttypefindelement.c | 10 ++++- plugins/elements/gsttypefindelement.h | 5 +++ 18 files changed, 164 insertions(+), 30 deletions(-) diff --git a/ChangeLog b/ChangeLog index a8b6ed7..2635f35 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,26 @@ +2006-01-04 Wim Taymans + + * docs/manual/basics-pads.xml: + * docs/plugins/Makefile.am: + * docs/plugins/gstreamer-plugins-docs.sgml: + * docs/plugins/gstreamer-plugins-sections.txt: + * docs/pwg/advanced-clock.xml: + * docs/pwg/advanced-scheduling.xml: + * docs/pwg/advanced-types.xml: + * plugins/elements/gstfdsink.c: + * plugins/elements/gstfdsrc.c: + * plugins/elements/gstfdsrc.h: + * plugins/elements/gstidentity.c: (gst_identity_class_init): + * plugins/elements/gstidentity.h: + * plugins/elements/gstqueue.h: + * plugins/elements/gsttee.c: + * plugins/elements/gsttee.h: + * plugins/elements/gsttypefindelement.c: + (gst_type_find_element_class_init): + * plugins/elements/gsttypefindelement.h: + Small updates to various docs. + Added core plugins to docs. + 2006-01-03 Thomas Vander Stichele * common/gst.supp: diff --git a/docs/manual/basics-pads.xml b/docs/manual/basics-pads.xml index 15cea0b..112fc15 100644 --- a/docs/manual/basics-pads.xml +++ b/docs/manual/basics-pads.xml @@ -195,7 +195,7 @@ link_to_multiplexer (GstPad *tolink_pad, Since the pads play a very important role in how the element is viewed by the outside world, a mechanism is implemented to describe the data that can flow or currently flows through the pad by using - capabilities. Here,w e will briefly describe what capabilities are + capabilities. Here, we will briefly describe what capabilities are and how to use them, enough to get an understanding of the concept. For an in-depth look into capabilities and a list of all capabilities defined in &GStreamer;, see the diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index b32ff68..8bfa8cf 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -76,9 +76,13 @@ IGNORE_CFILES = EXTRA_HFILES = \ $(top_srcdir)/plugins/elements/gstfakesrc.h \ $(top_srcdir)/plugins/elements/gstfakesink.h \ + $(top_srcdir)/plugins/elements/gstfdsrc.h \ $(top_srcdir)/plugins/elements/gstfilesrc.h \ $(top_srcdir)/plugins/elements/gstfilesink.h \ - $(top_srcdir)/plugins/elements/gstqueue.h + $(top_srcdir)/plugins/elements/gstidentity.h \ + $(top_srcdir)/plugins/elements/gstqueue.h \ + $(top_srcdir)/plugins/elements/gsttypefindelement.h \ + $(top_srcdir)/plugins/elements/gsttee.h # Images to copy into HTML directory. HTML_IMAGES = diff --git a/docs/plugins/gstreamer-plugins-docs.sgml b/docs/plugins/gstreamer-plugins-docs.sgml index 90a60d2..b34ba01 100644 --- a/docs/plugins/gstreamer-plugins-docs.sgml +++ b/docs/plugins/gstreamer-plugins-docs.sgml @@ -14,9 +14,13 @@ gstreamer Elements + + + + diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt index c0a8e5d..c750c93 100644 --- a/docs/plugins/gstreamer-plugins-sections.txt +++ b/docs/plugins/gstreamer-plugins-sections.txt @@ -34,6 +34,20 @@ GST_IS_FAKE_SINK_CLASS gst_fake_sink_get_type +
+element-fdsrc +fdsrc +GstFdSrc + +GstFdSrcClass +GST_FD_SRC +GST_IS_FD_SRC +GST_TYPE_FD_SRC +GST_FD_SRC_CLASS +GST_IS_FD_SRC_CLASS + +gst_fd_src_get_type +
element-filesrc @@ -67,6 +81,21 @@ gst_file_sink_get_type
+element-identity +identity +GstIdentity + +GstIdentityClass +GST_IDENTITY +GST_IS_IDENTITY +GST_TYPE_IDENTITY +GST_IDENTITY_CLASS +GST_IS_IDENTITY_CLASS + +gst_identity_get_type +
+ +
element-queue queue GstQueue @@ -81,4 +110,35 @@ GST_TYPE_QUEUE gst_queue_get_type
+ +
+element-typefind +typefind +GstTypeFindElement +GstTypeFindElementClass +GST_TYPE_FIND_ELEMENT +GST_IS_TYPE_FIND_ELEMENT +GST_TYPE_TYPE_FIND_ELEMENT +GST_TYPE_FIND_ELEMENT_CLASS +GST_IS_TYPE_FIND_ELEMENT_CLASS +GST_TYPE_FIND_ELEMENT_GET_CLASS + +gst_type_find_element_get_type +
+ +
+element-tee +tee +GstTee + +GstTeeClass +GST_TEE +GST_IS_TEE +GST_TYPE_TEE +GST_TEE_CLASS +GST_IS_TEE_CLASS + +gst_tee_get_type +
+ diff --git a/docs/pwg/advanced-clock.xml b/docs/pwg/advanced-clock.xml index 7b0ef56..d03699e 100644 --- a/docs/pwg/advanced-clock.xml +++ b/docs/pwg/advanced-clock.xml @@ -4,7 +4,7 @@ When playing complex media, each sound and video sample must be played in a specific order at a specific time. For this purpose, GStreamer provides a - syncrhonization mechanism. + synchronization mechanism. diff --git a/docs/pwg/advanced-scheduling.xml b/docs/pwg/advanced-scheduling.xml index f9b3b65..2aab690 100644 --- a/docs/pwg/advanced-scheduling.xml +++ b/docs/pwg/advanced-scheduling.xml @@ -47,7 +47,7 @@ If all pads of an element are assigned to do push-based scheduling, then this means that data will be pushed by upstream elements to this element using the - sinkpads _chain ()-function. Pprerequisites + sinkpads _chain ()-function. Prerequisites for this scheduling mode are that a chain-function was set for each sinkpad usinggst_pad_set_chain_function () and that all downstream elements operate in the same mode. Pads are diff --git a/docs/pwg/advanced-types.xml b/docs/pwg/advanced-types.xml index 8e179f9..b7225be 100644 --- a/docs/pwg/advanced-types.xml +++ b/docs/pwg/advanced-types.xml @@ -331,25 +331,6 @@ plugin_init (GstPlugin *plugin) The amount of bits used and allocated per sample. - - buffer-frames - integer - Any - - The number of frames per buffer. The reason for this property - is that the element does not need to reuse buffers or use data - spanned over multiple buffers, so this property - when used - rightly - will decrease latency. - - - - - Note that some people think that this property is very ugly, - whereas others think it is vital for the use of &GStreamer; in - professional audio applications. The special value zero is - reserved and implies that size is variable between buffers. - - @@ -750,14 +731,14 @@ plugin_init (GstPlugin *plugin) framerate - double - greater than 0 + fraction + greater or equal 0 The (average) framerate in frames per second. Note that this property does not guarantee in any way that it will actually come close to this value. If you need a fixed framerate, please use an element that provides that (such as - videodrop). + videodrop). 0 means a variable framerate. diff --git a/plugins/elements/gstfdsink.c b/plugins/elements/gstfdsink.c index 3652dce..da88c85 100644 --- a/plugins/elements/gstfdsink.c +++ b/plugins/elements/gstfdsink.c @@ -20,6 +20,14 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-fdsink + * @short_description: write to a unix file descriptor + * @see_also: #GstFdSrc + * + * Write data to a unix file descriptor. + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/plugins/elements/gstfdsrc.c b/plugins/elements/gstfdsrc.c index 1c9c8f9..bd02f57 100644 --- a/plugins/elements/gstfdsrc.c +++ b/plugins/elements/gstfdsrc.c @@ -20,6 +20,14 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-fdsrc + * @short_description: read from a unix file descriptor + * @see_also: #GstFdSink + * + * Read data from a unix file descriptor. + */ + #ifdef HAVE_CONFIG_H # include "config.h" diff --git a/plugins/elements/gstfdsrc.h b/plugins/elements/gstfdsrc.h index f780fa4..f330fc2 100644 --- a/plugins/elements/gstfdsrc.h +++ b/plugins/elements/gstfdsrc.h @@ -46,9 +46,15 @@ G_BEGIN_DECLS typedef struct _GstFdSrc GstFdSrc; typedef struct _GstFdSrcClass GstFdSrcClass; +/** + * GstFdSrc: + * + * Opaque #GstFdSrc data structure + */ struct _GstFdSrc { GstPushSrc element; + /*< private >*/ /* new_fd is copied to fd on READY->PAUSED */ gint new_fd; diff --git a/plugins/elements/gstidentity.c b/plugins/elements/gstidentity.c index 7b58076..2158cb9 100644 --- a/plugins/elements/gstidentity.c +++ b/plugins/elements/gstidentity.c @@ -208,6 +208,14 @@ gst_identity_class_init (GstIdentityClass * klass) "Verify that the stream is time- and data-contiguous", DEFAULT_CHECK_PERFECT, G_PARAM_READWRITE)); + /** + * GstIdentity::handoff: + * @identity: the identity instance + * @buffer: the buffer that just has been received + * @pad: the pad that received it + * + * This signal gets emitted before passing the buffer downstream. + */ gst_identity_signals[SIGNAL_HANDOFF] = g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstIdentityClass, handoff), NULL, NULL, diff --git a/plugins/elements/gstidentity.h b/plugins/elements/gstidentity.h index b92b473..b065898 100644 --- a/plugins/elements/gstidentity.h +++ b/plugins/elements/gstidentity.h @@ -45,9 +45,15 @@ G_BEGIN_DECLS typedef struct _GstIdentity GstIdentity; typedef struct _GstIdentityClass GstIdentityClass; +/** + * GstIdentity: + * + * Opaque #GstIdentity data structure + */ struct _GstIdentity { GstBaseTransform element; + /*< private >*/ GstClockID clock_id; gint error_after; gfloat drop_probability; diff --git a/plugins/elements/gstqueue.h b/plugins/elements/gstqueue.h index 22315b0..d121e4d 100644 --- a/plugins/elements/gstqueue.h +++ b/plugins/elements/gstqueue.h @@ -24,8 +24,7 @@ #ifndef __GST_QUEUE_H__ #define __GST_QUEUE_H__ - -#include +#include G_BEGIN_DECLS diff --git a/plugins/elements/gsttee.c b/plugins/elements/gsttee.c index e90b490..811ac15 100644 --- a/plugins/elements/gsttee.c +++ b/plugins/elements/gsttee.c @@ -21,6 +21,14 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-tee + * @short_description: 1-to-N pipe fitting + * @see_also: #GstIdentity + * + * Split data to multiple pads. + */ + #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/plugins/elements/gsttee.h b/plugins/elements/gsttee.h index f358ba4..fa88677 100644 --- a/plugins/elements/gsttee.h +++ b/plugins/elements/gsttee.h @@ -43,9 +43,15 @@ G_BEGIN_DECLS typedef struct _GstTee GstTee; typedef struct _GstTeeClass GstTeeClass; +/** + * GstTee: + * + * Opaque #GstTee data structure. + */ struct _GstTee { GstElement element; + /*< private >*/ GstPad *sinkpad; gboolean silent; diff --git a/plugins/elements/gsttypefindelement.c b/plugins/elements/gsttypefindelement.c index 30fa1b9..e7024cc 100644 --- a/plugins/elements/gsttypefindelement.c +++ b/plugins/elements/gsttypefindelement.c @@ -191,7 +191,15 @@ gst_type_find_element_class_init (GstTypeFindElementClass * typefind_class) g_param_spec_uint ("maximum", _("maximum"), "probability to stop typefinding", GST_TYPE_FIND_MINIMUM, GST_TYPE_FIND_MAXIMUM, GST_TYPE_FIND_MAXIMUM, G_PARAM_READWRITE)); - + /** + * GstTypeFindElement::have-type: + * @typefind: the typefind instance + * @probability: the probability of the type found + * @caps: the caps of the type found + * + * This signal gets emitted when the type and its probability has + * been found. + */ gst_type_find_element_signals[HAVE_TYPE] = g_signal_new ("have_type", G_TYPE_FROM_CLASS (typefind_class), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstTypeFindElementClass, have_type), NULL, NULL, diff --git a/plugins/elements/gsttypefindelement.h b/plugins/elements/gsttypefindelement.h index 751c488..3ef30cc 100644 --- a/plugins/elements/gsttypefindelement.h +++ b/plugins/elements/gsttypefindelement.h @@ -42,6 +42,11 @@ G_BEGIN_DECLS typedef struct _GstTypeFindElement GstTypeFindElement; typedef struct _GstTypeFindElementClass GstTypeFindElementClass; +/** + * GstTypeFindElement: + * + * Opaque #GstTypeFindElement data structure + */ struct _GstTypeFindElement { GstElement element; -- 2.7.4