diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 17:46:06 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 18:05:09 +0200 |
| commit | 9cf73bdd8f18505269fa4b6d1d80127945e735b1 (patch) | |
| tree | 799b0f7efa6d37844173fbd636bc58254cbccd78 /ext | |
| parent | 1f32369451bd5ddf7a59defef7900d508ee144da (diff) | |
Update and add documentation for plugins with deps (ext).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out.
Diffstat (limited to 'ext')
39 files changed, 330 insertions, 323 deletions
diff --git a/ext/aalib/gstaasink.c b/ext/aalib/gstaasink.c index 8ecc90b7..8e07568f 100644 --- a/ext/aalib/gstaasink.c +++ b/ext/aalib/gstaasink.c @@ -20,23 +20,16 @@ * SECTION:element-aasink * @see_also: #GstCACASink * - * <refsect2> - * <para> * Displays video as b/w ascii art. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink - * </programlisting> - * This pipeline renders a video to ascii art into a separate window. - * </para> - * <para> - * <programlisting> + * ]| This pipeline renders a video to ascii art into a separate window. + * |[ * gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink driver=curses - * </programlisting> - * This pipeline renders a video to ascii art into the current terminal. - * </para> + * ]| This pipeline renders a video to ascii art into the current terminal. * </refsect2> */ diff --git a/ext/annodex/gstcmmldec.c b/ext/annodex/gstcmmldec.c index 75038c61..765a0a12 100644 --- a/ext/annodex/gstcmmldec.c +++ b/ext/annodex/gstcmmldec.c @@ -25,17 +25,16 @@ * SECTION:element-cmmldec * @see_also: cmmlenc, oggdemux * - * <refsect2> - * <para> * Cmmldec extracts a CMML document from a CMML bitstream.<ulink * url="http://www.annodex.net/TR/draft-pfeiffer-cmml-02.html">CMML</ulink> is * an XML markup language for time-continuous data maintained by the <ulink * url="http:/www.annodex.org/">Annodex Foundation</ulink>. - * </para> + * + * <refsect2> * <title>Example pipeline</title> - * <programlisting> + * |[ * gst-launch -v filesrc location=annotated.ogg ! oggdemux ! cmmldec ! filesink location=annotations.cmml - * </programlisting> + * ]| * </refsect2> */ diff --git a/ext/annodex/gstcmmlenc.c b/ext/annodex/gstcmmlenc.c index 9b2c03c6..f3b65e55 100644 --- a/ext/annodex/gstcmmlenc.c +++ b/ext/annodex/gstcmmlenc.c @@ -25,16 +25,16 @@ * SECTION:element-cmmlenc * @see_also: cmmldec, oggmux * - * <refsect2> - * <para> Cmmlenc encodes a CMML document into a CMML stream. <ulink + * Cmmlenc encodes a CMML document into a CMML stream. <ulink * url="http://www.annodex.net/TR/draft-pfeiffer-cmml-02.html">CMML</ulink> is * an XML markup language for time-continuous data maintained by the <ulink * url="http:/www.annodex.org/">Annodex Foundation</ulink>. - * </para> + * + * <refsect2> * <title>Example pipeline</title> - * <programlisting> + * |[ * gst-launch -v filesrc location=annotations.cmml ! cmmlenc ! oggmux name=mux ! filesink location=annotated.ogg - * </programlisting> + * ]| * </refsect2> */ diff --git a/ext/cairo/gsttextoverlay.c b/ext/cairo/gsttextoverlay.c index 6ac993f1..6bdd6fd9 100644 --- a/ext/cairo/gsttextoverlay.c +++ b/ext/cairo/gsttextoverlay.c @@ -17,6 +17,18 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-cairotextoverlay + * + * cairotextoverlay renders the text on top of the video frames. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch videotestsrc ! cairotextoverlay text="hello" ! autovideosink + * ]| + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include <config.h> diff --git a/ext/cairo/gsttimeoverlay.c b/ext/cairo/gsttimeoverlay.c index 8f1d03d1..5a2f016f 100644 --- a/ext/cairo/gsttimeoverlay.c +++ b/ext/cairo/gsttimeoverlay.c @@ -21,17 +21,14 @@ /** * SECTION:element-cairotimeoverlay * - * <refsect2> - * <para> * cairotimeoverlay renders the buffer timestamp for each frame on top of * the frame. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> - * gst-launch -v -m videotestsrc ! cairotimeoverlay ! autovideosink - * </programlisting> - * </para> + * |[ + * gst-launch videotestsrc ! cairotimeoverlay ! autovideosink + * ]| * </refsect2> */ diff --git a/ext/dv/gstdvdec.c b/ext/dv/gstdvdec.c index 958aa518..ade97966 100644 --- a/ext/dv/gstdvdec.c +++ b/ext/dv/gstdvdec.c @@ -21,25 +21,21 @@ /** * SECTION:element-dvdec * - * <refsect2> - * <para> * dvdec decodes DV video into raw video. The element expects a full DV frame * as input, which is 120000 bytes for NTSC and 144000 for PAL video. - * </para> - * <para> - * This element can perform simple frame dropping with the drop-factor + * + * This element can perform simple frame dropping with the #GstDVDec:drop-factor * property. Setting this property to a value N > 1 will only decode every * Nth frame. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=test.dv ! dvdemux name=demux ! dvdec ! xvimagesink - * </programlisting> - * This pipeline decodes and renders the raw DV stream to a videosink. - * </para> - * Last reviewed on 2006-02-28 (0.10.3) + * ]| This pipeline decodes and renders the raw DV stream to a videosink. * </refsect2> + * + * Last reviewed on 2006-02-28 (0.10.3) */ #ifdef HAVE_CONFIG_H diff --git a/ext/dv/gstdvdemux.c b/ext/dv/gstdvdemux.c index 39340116..7c7509fe 100644 --- a/ext/dv/gstdvdemux.c +++ b/ext/dv/gstdvdemux.c @@ -30,24 +30,20 @@ /** * SECTION:element-dvdemux * - * <refsect2> - * <para> * dvdemux splits raw DV into its audio and video components. The audio will be * decoded raw samples and the video will be encoded DV video. - * </para> - * <para> - * This element can operate in both push and pull mode depending on the capabilities - * of the upstream peer. - * </para> + * + * This element can operate in both push and pull mode depending on the + * capabilities of the upstream peer. + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=test.dv ! dvdemux name=demux ! queue ! audioconvert ! alsasink demux. ! queue ! dvdec ! xvimagesink - * </programlisting> - * This pipeline decodes and renders the raw DV stream to an audio and a videosink. - * </para> - * Last reviewed on 2006-02-27 (0.10.3) + * ]| This pipeline decodes and renders the raw DV stream to an audio and a videosink. * </refsect2> + * + * Last reviewed on 2006-02-27 (0.10.3) */ /* DV output has two modes, normal and wide. The resolution is the same in both diff --git a/ext/esd/esdmon.c b/ext/esd/esdmon.c index 880af9d8..25b1201e 100644 --- a/ext/esd/esdmon.c +++ b/ext/esd/esdmon.c @@ -20,9 +20,10 @@ * Boston, MA 02111-1307, USA. */ /** - * SECTION:element-esdmod + * SECTION:element-esdmon + * @see_also: #GstAlsaSrc, #GstAutoAudioSrc * - * This element outputs sound to an already-running Enlightened Sound Daemon + * This element records sound from an already-running Enlightened Sound Daemon * (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned * through this element (regardless of the system configuration), since this * is actively prevented by the element. If you must use esd, you need to @@ -38,6 +39,7 @@ * ]| Record from audioinput * </refsect2> */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/ext/esd/esdsink.c b/ext/esd/esdsink.c index ed34d793..ddc84e6a 100644 --- a/ext/esd/esdsink.c +++ b/ext/esd/esdsink.c @@ -26,24 +26,20 @@ * SECTION:element-esdsink * @see_also: #GstAlsaSink, #GstAutoAudioSink * - * <refsect2> - * <para> * This element outputs sound to an already-running Enlightened Sound Daemon * (ESound Daemon, esd). Note that a sound daemon will never be auto-spawned * through this element (regardless of the system configuration), since this * is actively prevented by the element. If you must use esd, you need to * make sure it is started automatically with your session or otherwise. - * </para> - * <para> + * * TODO: insert some comments about how sucky esd is and that all the cool * kids use pulseaudio or whatever these days. - * </para> - * <para> - * Simple example pipeline that plays an Ogg/Vorbis file via esd: - * <programlisting> + * + * <refsect2> + * <title>Example launch line</title> + * |[ * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! audioresample ! esdsink - * </programlisting> - * </para> + * ]| play an Ogg/Vorbis audio file via esd * </refsect2> */ diff --git a/ext/flac/gstflacdec.c b/ext/flac/gstflacdec.c index 8244e79a..dedbd617 100644 --- a/ext/flac/gstflacdec.c +++ b/ext/flac/gstflacdec.c @@ -21,26 +21,20 @@ /** * SECTION:element-flacdec - * @seealso: flacenc + * @see_also: #GstFlacEnc * - * <refsect2> - * <para> * flacdec decodes FLAC streams. * <ulink url="http://flac.sourceforge.net/">FLAC</ulink> * is a Free Lossless Audio Codec. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=media/small/dark.441-16-s.flac ! flacdec ! audioconvert ! audioresample ! autoaudiosink - * </programlisting> - * </para> - * <title>Another example launch line</title> - * <para> - * <programlisting> + * ]| + * |[ * gst-launch gnomevfssrc location=http://gstreamer.freedesktop.org/media/small/dark.441-16-s.flac ! flacdec ! audioconvert ! audioresample ! queue min-threshold-buffers=10 ! autoaudiosink - * </programlisting> - * </para> + * ]| * </refsect2> */ diff --git a/ext/flac/gstflacenc.c b/ext/flac/gstflacenc.c index e5a7804b..3fade910 100644 --- a/ext/flac/gstflacenc.c +++ b/ext/flac/gstflacenc.c @@ -16,6 +16,21 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-flacenc + * @see_also: #GstFlacDec + * + * flacenc encodes FLAC streams. + * <ulink url="http://flac.sourceforge.net/">FLAC</ulink> + * is a Free Lossless Audio Codec. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch audiotestsrc num-buffers=100 ! flacenc ! filesink location=beep.flac + * ]| + * </refsect2> + */ /* TODO: - We currently don't handle discontinuities in the stream in a useful * way and instead rely on the developer plugging in audiorate if diff --git a/ext/gconf/gstgconfaudiosink.c b/ext/gconf/gstgconfaudiosink.c index a8bf3305..19dee86c 100644 --- a/ext/gconf/gstgconfaudiosink.c +++ b/ext/gconf/gstgconfaudiosink.c @@ -17,6 +17,19 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-gconfaudiosink + * + * This element outputs sound to the audiosink that has been configured in + * GConf by the user. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch filesrc location=foo.ogg ! decodebin ! audioconvert ! audioresample ! gconfaudiosink + * ]| Play on configured audiosink + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/gconf/gstgconfaudiosrc.c b/ext/gconf/gstgconfaudiosrc.c index babd653d..77c37305 100644 --- a/ext/gconf/gstgconfaudiosrc.c +++ b/ext/gconf/gstgconfaudiosrc.c @@ -17,6 +17,20 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-gconfaudiosrc + * @see_also: #GstAlsaSrc, #GstAutoAudioSrc + * + * This element records sound from the audiosink that has been configured in + * GConf by the user. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch gconfaudiosrc ! audioconvert ! wavenc ! filesink location=record.wav + * ]| Record from configured audioinput + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/gconf/gstgconfvideosink.c b/ext/gconf/gstgconfvideosink.c index ec04cd86..4090cc91 100644 --- a/ext/gconf/gstgconfvideosink.c +++ b/ext/gconf/gstgconfvideosink.c @@ -16,6 +16,19 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-gconfvideosink + * + * This element outputs video to the videosink that has been configured in + * GConf by the user. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch filesrc location=foo.ogg ! decodebin ! ffmpegcolorspace ! gconfvideosink + * ]| Play on configured videosink + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/gconf/gstgconfvideosrc.c b/ext/gconf/gstgconfvideosrc.c index f56f43a2..fe177d86 100644 --- a/ext/gconf/gstgconfvideosrc.c +++ b/ext/gconf/gstgconfvideosrc.c @@ -17,6 +17,20 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-gconfvideosrc + * @see_also: #GstAlsaSrc, #GstAutoVideoSrc + * + * This element records video from the videosink that has been configured in + * GConf by the user. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch gconfvideosrc ! theoraenc ! oggmux ! filesink location=record.ogg + * ]| Record from configured videoinput + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/gdk_pixbuf/gstgdkpixbufsink.c b/ext/gdk_pixbuf/gstgdkpixbufsink.c index f4d318a1..3c988f92 100644 --- a/ext/gdk_pixbuf/gstgdkpixbufsink.c +++ b/ext/gdk_pixbuf/gstgdkpixbufsink.c @@ -19,20 +19,14 @@ /** * SECTION:element-gdkpixbufsink - * @short_description: video sink that converts RGB images to GdkPixbufs. - * @see_also: + * @Since: 0.10.8 * - * <refsect2> - * <para> * This sink element takes RGB or RGBA images as input and wraps them into - * GdkPixbuf objects, for easy saving to file via the - * <ulink url="http://library.gnome.org/devel/gdk-pixbuf/unstable/index.html"> - * GdkPixbuf library API</ulink> or displaying in Gtk+ applications (e.g. using - * the <ulink url="http://library.gnome.org/devel/gtk/unstable/GtkImage.html"> - * GtkImage widget</ulink>). - * </para> - * <para> - * There are two ways to use this element and obtain the GdkPixbuf objects + * #GdkPixbuf objects, for easy saving to file via the + * GdkPixbuf library API or displaying in Gtk+ applications (e.g. using + * the #GtkImage widget). + * + * There are two ways to use this element and obtain the #GdkPixbuf objects * created: * <itemizedlist> * <listitem> @@ -43,34 +37,30 @@ * contained in them. * </listitem> * <listitem> - * Retrieving the current pixbuf via the <classname>"last-pixbuf" - * </classname> property when needed. + * Retrieving the current pixbuf via the #GstGdkPixbufSink:last-pixbuf property + * when needed. * </listitem> * </itemizedlist> - * </para> - * <para> - * The primary purpose of this element is to abstract away the GstBuffer to - * GdkPixbuf conversion. Other than that it's very similar to the fakesink + * + * The primary purpose of this element is to abstract away the #GstBuffer to + * #GdkPixbuf conversion. Other than that it's very similar to the fakesink * element. - * </para> - * <para> + * * This element is meant for easy no-hassle video snapshotting. It is not * suitable for video playback or video display at high framerates. Use * ximagesink, xvimagesink or some other suitable video sink in connection - * with the GstXOverlay interface instead if you want to do video playback. - * </para> + * with the #GstXOverlay interface instead if you want to do video playback. + * + * <refsect2> * <title>Message details</title> - * <para> * As mentioned above, this element will by default post element messages * containing structures named <classname>"preroll-pixbuf" * </classname> or <classname>"pixbuf"</classname> on the bus (this - * can be disabled by setting the - * <link linkend="GstGdkPixbufSink--send-messages">"send-messages" - * property</link> to #FALSE though). The element message's structure - * will have the following fields: + * can be disabled by setting the #GstGdkPixbufSink:send-messages property + * to #FALSE though). The element message structure has the following fields: * <itemizedlist> * <listitem> - * <classname>"pixbuf"</classname>: the GdkPixbuf object + * <classname>"pixbuf"</classname>: the #GdkPixbuf object * </listitem> * <listitem> * <classname>"pixel-aspect-ratio"</classname>: the pixel aspect @@ -78,30 +68,25 @@ * PAR is usually 1:1 for images, but is often something non-1:1 in the case * of video input. In this case the image may be distorted and you may need * to rescale it accordingly before saving it to file or displaying it. This - * can easily be done using the - * <ulink url="http://library.gnome.org/devel/gdk-pixbuf/unstable/index.html"> - * GdkPixbuf library API</ulink> (the reason this is not done automatically - * is that the application will often scale the image anyway according to the - * size of the output window, in which case it is much more efficient to only - * scale once rather than twice). You can put a videoscale element and a - * capsfilter element with + * can easily be done using gdk_pixbuf_scale() (the reason this is not done + * automatically is that the application will often scale the image anyway + * according to the size of the output window, in which case it is much more + * efficient to only scale once rather than twice). You can put a videoscale + * element and a capsfilter element with * <literal>video/x-raw-rgb,pixel-aspect-ratio=(fraction)1/1</literal> caps * in front of this element to make sure the pixbufs always have a 1:1 PAR. * </listitem> * </itemizedlist> - * </para> + * </refsect2> + * + * <refsect2> * <title>Example pipeline</title> - * <para> - * <programlisting> + * |[ * gst-launch -m -v videotestsrc num-buffers=1 ! gdkpixbufsink - * </programlisting> - * Process one single test image as pixbuf (note that the output you see will + * ]| Process one single test image as pixbuf (note that the output you see will * be slightly misleading. The message structure does contain a valid pixbuf * object even if the structure string says '(NULL)'). - * </para> * </refsect2> - * - * Since: 0.10.8 */ #ifdef HAVE_CONFIG_H diff --git a/ext/hal/gsthalaudiosink.c b/ext/hal/gsthalaudiosink.c index de4d8844..e010ea4e 100644 --- a/ext/hal/gsthalaudiosink.c +++ b/ext/hal/gsthalaudiosink.c @@ -21,27 +21,21 @@ /** * SECTION:element-halaudiosink * - * <refsect2> - * <para> * HalAudioSink allows access to output of sound devices by specifying the * corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction - * Layer (HAL) in the <link linkend="GstHalAudioSrc--udi">udi</link> property. + * Layer (HAL) in the #GstHalAudioSink:udi property. * It currently always embeds alsasink or osssink as HAL doesn't support other * sound systems yet. You can also specify the UDI of a device that has ALSA or * OSS subdevices. If both are present ALSA is preferred. - * </para> + * + * <refsect2> * <title>Examples</title> - * <para> - * To list the UDIs of all your ALSA output devices : - * <programlisting> + * |[ * hal-find-by-property --key alsa.type --string playback - * </programlisting> - * Here is a pipeline to test your sound output : - * <programlisting> + * ]| list the UDIs of all your ALSA output devices + * |[ * gst-launch -v audiotestsrc ! halaudiosink udi=/org/freedesktop/Hal/devices/pci_8086_27d8_alsa_playback_0 - * </programlisting> - * This pipeline produces a test signal on the specified sound device. - * </para> + * ]| test your soundcard by playing a test signal on the specified sound device. * </refsect2> */ diff --git a/ext/hal/gsthalaudiosrc.c b/ext/hal/gsthalaudiosrc.c index 626e9d35..bd0a70b5 100644 --- a/ext/hal/gsthalaudiosrc.c +++ b/ext/hal/gsthalaudiosrc.c @@ -22,28 +22,22 @@ /** * SECTION:element-halaudiosrc * - * <refsect2> - * <para> * HalAudioSrc allows access to input of sound devices by specifying the * corresponding persistent Unique Device Id (UDI) from the Hardware Abstraction - * Layer (HAL) in the <link linkend="GstHalAudioSrc--udi">udi</link> property. + * Layer (HAL) in the #GstHalAudioSrc:udi property. * It currently always embeds alsasrc or osssrc as HAL doesn't support other * sound systems yet. You can also specify the UDI of a device that has ALSA or * OSS subdevices. If both are present ALSA is preferred. - * </para> + * + * <refsect2> * <title>Examples</title> - * <para> - * To list the UDIs of all your ALSA input devices : - * <programlisting> + * |[ * hal-find-by-property --key alsa.type --string capture - * </programlisting> - * Here is a pipeline to test your sound input : - * <programlisting> + * ]| list the UDIs of all your ALSA input devices + * |[ * gst-launch -v halaudiosrc udi=/org/freedesktop/Hal/devices/pci_8086_27d8_alsa_capture_0 ! autoaudiosink - * </programlisting> - * You should now hear yourself with a small delay if you have a microphone + * ]| You should now hear yourself with a small delay if you have a microphone * connected to the specified sound device. - * </para> * </refsect2> */ diff --git a/ext/hal/hal.c b/ext/hal/hal.c index d23a91a6..b0e1d823 100644 --- a/ext/hal/hal.c +++ b/ext/hal/hal.c @@ -40,7 +40,7 @@ GST_DEBUG_CATEGORY_EXTERN (hal_debug); #define LIBHAL_FREE_DBUS_ERROR(e) dbus_error_free (e) #endif -/** +/* * gst_hal_get_alsa_element: * @ctx: a #LibHalContext which should be used for querying HAL. * @udi: a #gchar corresponding to the UDI you want to get. @@ -130,7 +130,7 @@ gst_hal_get_alsa_element (LibHalContext * ctx, const gchar * udi, return string; } -/** +/* * gst_hal_get_oss_element: * @ctx: a #LibHalContext which should be used for querying HAL. * @udi: a #gchar corresponding to the UDI you want to get. @@ -203,7 +203,7 @@ gst_hal_get_oss_element (LibHalContext * ctx, const gchar * udi, return string; } -/** +/* * gst_hal_get_string: * @udi: a #gchar corresponding to the UDI you want to get. * @device_type: a #GstHalDeviceType specifying the wanted device type. diff --git a/ext/jpeg/gstjpegenc.c b/ext/jpeg/gstjpegenc.c index 1161c075..b1aae3a5 100644 --- a/ext/jpeg/gstjpegenc.c +++ b/ext/jpeg/gstjpegenc.c @@ -16,7 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:element-jpegenc + * + * Encodes jpeg images. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/jpeg/gstsmokedec.c b/ext/jpeg/gstsmokedec.c index 665de92d..b66a2308 100644 --- a/ext/jpeg/gstsmokedec.c +++ b/ext/jpeg/gstsmokedec.c @@ -17,6 +17,11 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-smokedec + * + * Decodes images in smoke format. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/jpeg/gstsmokeenc.c b/ext/jpeg/gstsmokeenc.c index bb3d89e6..31f7ed28 100644 --- a/ext/jpeg/gstsmokeenc.c +++ b/ext/jpeg/gstsmokeenc.c @@ -16,7 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:element-smokeenc + * + * Encodes images in smoke format. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/libcaca/gstcacasink.c b/ext/libcaca/gstcacasink.c index 1f6f4c20..c0a6f49f 100644 --- a/ext/libcaca/gstcacasink.c +++ b/ext/libcaca/gstcacasink.c @@ -20,24 +20,17 @@ * SECTION:element-cacasink * @see_also: #GstAASink * - * <refsect2> - * <para> * Displays video as color ascii art. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * CACA_GEOMETRY=160x60 CACA_FONT=5x7 gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! cacasink - * </programlisting> - * This pipeline renders a video to ascii art into a separate window using a + * ]| This pipeline renders a video to ascii art into a separate window using a * small font and specifying the ascii resolution. - * </para> - * <para> - * <programlisting> + * |[ * CACA_DRIVER=ncurses gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! cacasink - * </programlisting> - * This pipeline renders a video to ascii art into the current terminal. - * </para> + * ]| This pipeline renders a video to ascii art into the current terminal. * </refsect2> */ @@ -50,6 +43,17 @@ #include "gstcacasink.h" +#define GST_CACA_DEFAULT_SCREEN_WIDTH 80 +#define GST_CACA_DEFAULT_SCREEN_HEIGHT 25 +#define GST_CACA_DEFAULT_BPP 24 +#define GST_CACA_DEFAULT_RED_MASK GST_VIDEO_BYTE1_MASK_32_INT +#define GST_CACA_DEFAULT_GREEN_MASK GST_VIDEO_BYTE2_MASK_32_INT +#define GST_CACA_DEFAULT_BLUE_MASK GST_VIDEO_BYTE3_MASK_32_INT + +//#define GST_CACA_DEFAULT_RED_MASK R_MASK_32_REVERSE_INT +//#define GST_CACA_DEFAULT_GREEN_MASK G_MASK_32_REVERSE_INT +//#define GST_CACA_DEFAULT_BLUE_MASK B_MASK_32_REVERSE_INT + /* elementfactory information */ static const GstElementDetails gst_cacasink_details = GST_ELEMENT_DETAILS ("A colored ASCII art video sink", diff --git a/ext/libcaca/gstcacasink.h b/ext/libcaca/gstcacasink.h index f955f63d..548ca5da 100644 --- a/ext/libcaca/gstcacasink.h +++ b/ext/libcaca/gstcacasink.h @@ -34,17 +34,6 @@ extern "C" { #endif /* __cplusplus */ -#define GST_CACA_DEFAULT_SCREEN_WIDTH 80 -#define GST_CACA_DEFAULT_SCREEN_HEIGHT 25 -#define GST_CACA_DEFAULT_BPP 24 -#define GST_CACA_DEFAULT_RED_MASK GST_VIDEO_BYTE1_MASK_32_INT -#define GST_CACA_DEFAULT_GREEN_MASK GST_VIDEO_BYTE2_MASK_32_INT -#define GST_CACA_DEFAULT_BLUE_MASK GST_VIDEO_BYTE3_MASK_32_INT - -//#define GST_CACA_DEFAULT_RED_MASK R_MASK_32_REVERSE_INT -//#define GST_CACA_DEFAULT_GREEN_MASK G_MASK_32_REVERSE_INT -//#define GST_CACA_DEFAULT_BLUE_MASK B_MASK_32_REVERSE_INT - #define GST_TYPE_CACASINK \ (gst_cacasink_get_type()) #define GST_CACASINK(obj) \ diff --git a/ext/libpng/gstpngdec.c b/ext/libpng/gstpngdec.c index 8932e88b..d0f9d0d5 100644 --- a/ext/libpng/gstpngdec.c +++ b/ext/libpng/gstpngdec.c @@ -12,7 +12,6 @@ * Boston, MA 02111-1307, USA. * */ - /** * SECTION:element-pngdec * diff --git a/ext/libpng/gstpngenc.c b/ext/libpng/gstpngenc.c index 160958c1..1d1de33d 100644 --- a/ext/libpng/gstpngenc.c +++ b/ext/libpng/gstpngenc.c @@ -15,6 +15,11 @@ * Boston, MA 02111-1307, USA. * */ +/** + * SECTION:element-pngenc + * + * Encodes png images. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/pulse/pulsemixer.c b/ext/pulse/pulsemixer.c index 3a0de9da..5ced971b 100644 --- a/ext/pulse/pulsemixer.c +++ b/ext/pulse/pulsemixer.c @@ -21,16 +21,14 @@ /** * SECTION:element-pulsemixer - * @short_description: Element to control sound input and output levels for the PulseAudio sound server * @see_also: pulsesrc, pulsesink * - * <refsect2> - * <para> * This element lets you adjust sound input and output levels for the * PulseAudio sound server. It supports the GstMixer interface, which can be * used to obtain a list of available mixer tracks. Set the mixer element to * READY state before using the GstMixer interface on it. - * </para> + * + * <refsect2> * <title>Example pipelines</title> * <para> * pulsemixer can't be used in a sensible way in gst-launch. diff --git a/ext/pulse/pulsesink.c b/ext/pulse/pulsesink.c index df774990..b41dba50 100644 --- a/ext/pulse/pulsesink.c +++ b/ext/pulse/pulsesink.c @@ -21,28 +21,20 @@ /** * SECTION:element-pulsesink - * @short_description: Output audio to a PulseAudio sound server * @see_also: pulsesrc, pulsemixer * + * This element outputs audio to a + * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>. + * * <refsect2> - * <para> - * This element outputs audio to a PulseAudio sound server. - * </para> * <title>Example pipelines</title> - * <para> - * <programlisting> + * |[ * gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink - * </programlisting> - * Play an Ogg/Vorbis file. - * </para> - * <para> - * <programlisting> + * ]| Play an Ogg/Vorbis file. + * |[ * gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.4 ! pulsesink - * </programlisting> - * Play a 440Hz sine wave. - * </para> + * ]| Play a 440Hz sine wave. * </refsect2> - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/pulse/pulsesrc.c b/ext/pulse/pulsesrc.c index 0e1ca20e..08fec595 100644 --- a/ext/pulse/pulsesrc.c +++ b/ext/pulse/pulsesrc.c @@ -21,20 +21,16 @@ /** * SECTION:element-pulsesrc - * @short_description: Capture audio from a PulseAudio sound server * @see_also: pulsesink, pulsemixer * + * This element captures audio from a + * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>. + * * <refsect2> - * <para> - * This element captures audio from a PulseAudio sound server. - * </para> * <title>Example pipelines</title> - * <para> - * <programlisting> + * |[ * gst-launch -v pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=alsasrc.ogg - * </programlisting> - * Record from a sound card using ALSA and encode to Ogg/Vorbis. - * </para> + * ]| Record from a sound card using ALSA and encode to Ogg/Vorbis. * </refsect2> */ diff --git a/ext/raw1394/gstdv1394src.c b/ext/raw1394/gstdv1394src.c index 5db691aa..af7b0454 100644 --- a/ext/raw1394/gstdv1394src.c +++ b/ext/raw1394/gstdv1394src.c @@ -22,18 +22,14 @@ /** * SECTION:element-dv1394src * - * <refsect2> - * <para> * Read DV (digital video) data from firewire port. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> - * gst-launch dv1394src ! dvdemux name=d ! queue ! dvdec ! xvimagesink d. ! queue ! alsasink - * </programlisting> - * This pipeline captures from the firewire port and displays it (might need + * |[ + * gst-launch dv1394src ! queue ! dvdemux name=d ! queue ! dvdec ! xvimagesink d. ! queue ! alsasink + * ]| This pipeline captures from the firewire port and displays it (might need * format converters for audio/video). - * </para> * </refsect2> */ diff --git a/ext/raw1394/gsthdv1394src.c b/ext/raw1394/gsthdv1394src.c index 8293b4a0..cbb02136 100644 --- a/ext/raw1394/gsthdv1394src.c +++ b/ext/raw1394/gsthdv1394src.c @@ -16,6 +16,21 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-hdv1394src + * + * Read MPEG-TS data from firewire port. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch hdv1394src ! queue ! decodebin name=d ! queue ! xvimagesink d. ! queue ! alsasink + * ]| captures from the firewire port and plays the streams. + * |[ + * gst-launch hdv1394src ! queue ! filesink location=mydump.ts + * ]| capture to a disk file + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" @@ -776,6 +791,7 @@ gst_hdv1394src_uri_get_type (void) { return GST_URI_SRC; } + static gchar ** gst_hdv1394src_uri_get_protocols (void) { @@ -783,6 +799,7 @@ gst_hdv1394src_uri_get_protocols (void) return protocols; } + static const gchar * gst_hdv1394src_uri_get_uri (GstURIHandler * handler) { diff --git a/ext/soup/gstsouphttpsrc.c b/ext/soup/gstsouphttpsrc.c index ad7433c1..580d06b6 100644 --- a/ext/soup/gstsouphttpsrc.c +++ b/ext/soup/gstsouphttpsrc.c @@ -14,65 +14,48 @@ /** * SECTION:element-souphttpsrc - * @short_description: Read from an HTTP/HTTPS/WebDAV/Icecast/Shoutcast - * location. * - * <refsect2> - * <para> * This plugin reads data from a remote location specified by a URI. * Supported protocols are 'http', 'https'. - * </para> - * <para> + * * An HTTP proxy must be specified by its URL. * If the "http_proxy" environment variable is set, its value is used. * If built with libsoup's GNOME integration features, the GNOME proxy * configuration will be used, or failing that, proxy autodetection. - * The element-souphttpsrc::proxy property can be used to override the - * default. - * </para> - * <para> - * In case the element-souphttpsrc::iradio-mode property is set and the - * location is an HTTP resource, souphttpsrc will send special Icecast HTTP - * headers to the server to request additional Icecast meta-information. If - * the server is not an Icecast server, it will behave as if the - * element-souphttpsrc::iradio-mode property were not set. If it is, - * souphttpsrc will output data with a media type of application/x-icy, - * in which case you will need to use the #ICYDemux element as follow-up - * element to extract the Icecast metadata and to determine the underlying - * media type. - * </para> - * <para> - * Example pipeline: - * <programlisting> + * The #GstSoupHTTPSrc:proxy property can be used to override the default. + * + * In case the #GstSoupHTTPSrc:iradio-mode property is set and the location is + * an HTTP resource, souphttpsrc will send special Icecast HTTP headers to the + * server to request additional Icecast meta-information. + * If the server is not an Icecast server, it will behave as if the + * #GstSoupHTTPSrc:iradio-mode property were not set. If it is, souphttpsrc will + * output data with a media type of application/x-icy, in which case you will + * need to use the #ICYDemux element as follow-up element to extract the Icecast + * metadata and to determine the underlying media type. + * + * <refsect2> + * <title>Example launch line</title> + * |[ * gst-launch -v souphttpsrc location=https://some.server.org/index.html * ! filesink location=/home/joe/server.html - * </programlisting> - * The above pipeline reads a web page from a server using the HTTPS protocol + * ]| The above pipeline reads a web page from a server using the HTTPS protocol * and writes it to a local file. - * </para> - * <para> - * Another example pipeline: - * <programlisting> + * |[ * gst-launch -v souphttpsrc user-agent="FooPlayer 0.99 beta" * automatic-redirect=false proxy=http://proxy.intranet.local:8080 * location=http://music.foobar.com/demo.mp3 ! mad ! audioconvert * ! audioresample ! alsasink - * </programlisting> - * The above pipeline will read and decode and play an mp3 file from a + * ]| The above pipeline will read and decode and play an mp3 file from a * web server using the HTTP protocol. If the server sends redirects, * the request fails instead of following the redirect. The specified * HTTP proxy server is used. The User-Agent HTTP request header * is set to a custom string instead of "GStreamer souphttpsrc." - * </para> - * <para> - * Yet another example pipeline: - * <programlisting> + * |[ * gst-launch -v souphttpsrc location=http://10.11.12.13/mjpeg * do-timestamp=true ! multipartdemux * ! image/jpeg,width=640,height=480 ! matroskamux * ! filesink location=mjpeg.mkv - * </programlisting> - * The above pipeline reads a motion JPEG stream from an IP camera + * ]| The above pipeline reads a motion JPEG stream from an IP camera * using the HTTP protocol, encoded as mime/multipart image/jpeg * parts, and writes a Matroska motion JPEG file. The width and * height properties are set in the caps to provide the Matroska @@ -81,9 +64,7 @@ * These are used by the mime/multipart demultiplexer to emit timestamps * on the JPEG-encoded video frame buffers. This allows the Matroska * multiplexer to timestamp the frames in the resulting file. - * </para> * </refsect2> - * */ #ifdef HAVE_CONFIG_H diff --git a/ext/speex/gstspeexdec.c b/ext/speex/gstspeexdec.c index 0987d865..b70c45c6 100644 --- a/ext/speex/gstspeexdec.c +++ b/ext/speex/gstspeexdec.c @@ -20,23 +20,19 @@ /** * SECTION:element-speexdec - * @short_description: a decoder that decodes Speex to raw audio * @see_also: speexenc, oggdemux * - * <refsect2> - * <para> * This element decodes a Speex stream to raw integer audio. * <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free * audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org * Foundation</ulink>. - * </para> + * + * <refsect2> * <title>Example pipelines</title> - * <para> - * <programlisting> + * |[ * gst-launch -v filesrc location=speex.ogg ! oggdemux ! speexdec ! audioconvert ! audioresample ! alsasink - * </programlisting> - * Decode an Ogg/Speex file. To create an Ogg/Speex file refer to the documentation of speexenc. - * </para> + * ]| Decode an Ogg/Speex file. To create an Ogg/Speex file refer to the + * documentation of speexenc. * </refsect2> * * Last reviewed on 2006-04-05 (0.10.2) diff --git a/ext/speex/gstspeexenc.c b/ext/speex/gstspeexenc.c index 963d5607..631d90b9 100644 --- a/ext/speex/gstspeexenc.c +++ b/ext/speex/gstspeexenc.c @@ -17,6 +17,22 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-speexenc + * @see_also: speexdec, oggmux + * + * This element encodes audio as a Speex stream. + * <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free + * audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org + * Foundation</ulink>. + * + * <refsect2> + * <title>Example pipelines</title> + * |[ + * gst-launch audiotestsrc num-buffers=100 ! speexenc ! oggmux ! filesink location=beep.ogg + * ]| Encode an Ogg/Speex file. + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/taglib/gstapev2mux.cc b/ext/taglib/gstapev2mux.cc index b7a61bff..6857e253 100644 --- a/ext/taglib/gstapev2mux.cc +++ b/ext/taglib/gstapev2mux.cc @@ -23,28 +23,23 @@ * SECTION:element-apev2mux * @see_also: #GstTagSetter * - * <refsect2> - * <para> * This element adds APEv2 tags to the beginning of a stream using the taglib * library. - * </para> - * <para> + * * Applications can set the tags to write using the #GstTagSetter interface. * Tags sent by upstream elements will be picked up automatically (and merged * according to the merge mode set via the tag setter interface). - * </para> - * <para> - * Here is a simple pipeline that transcodes a file from Ogg/Vorbis to mp3 - * format with an APEv2 that contains the same as the the Ogg/Vorbis file: - * <programlisting> + * + * <refsect2> + * <title>Example pipelines</title> + * |[ * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! lame ! apev2mux ! filesink location=foo.mp3 - * </programlisting> - * Make sure the Ogg/Vorbis file actually has comments to preserve. - * You can verify the tags were written using: - * <programlisting> + * ]| A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with an + * APEv2 that contains the same as the the Ogg/Vorbis file. Make sure the + * Ogg/Vorbis file actually has comments to preserve. + * |[ * gst-launch -m filesrc location=foo.mp3 ! apedemux ! fakesink silent=TRUE 2> /dev/null | grep taglist - * </programlisting> - * </para> + * ]| Verify that tags have been written. * </refsect2> */ diff --git a/ext/taglib/gstid3v2mux.cc b/ext/taglib/gstid3v2mux.cc index cf176279..fd15836e 100644 --- a/ext/taglib/gstid3v2mux.cc +++ b/ext/taglib/gstid3v2mux.cc @@ -22,30 +22,25 @@ * SECTION:element-id3v2mux * @see_also: #GstID3Demux, #GstTagSetter * - * <refsect2> - * <para> * This element adds ID3v2 tags to the beginning of a stream using the taglib * library. More precisely, the tags written are ID3 version 2.4.0 tags (which * means in practice that some hardware players or outdated programs might not * be able to read them properly). - * </para> - * <para> + * * Applications can set the tags to write using the #GstTagSetter interface. * Tags sent by upstream elements will be picked up automatically (and merged * according to the merge mode set via the tag setter interface). - * </para> - * <para> - * Here is a simple pipeline that transcodes a file from Ogg/Vorbis to mp3 - * format with an ID3v2 that contains the same as the the Ogg/Vorbis file: - * <programlisting> + * + * <refsect2> + * <title>Example pipelines</title> + * |[ * gst-launch -v filesrc location=foo.ogg ! decodebin ! audioconvert ! lame ! id3v2mux ! filesink location=foo.mp3 - * </programlisting> - * Make sure the Ogg/Vorbis file actually has comments to preserve. - * You can verify the tags were written using: - * <programlisting> + * ]| A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with an + * ID3v2 that contains the same as the the Ogg/Vorbis file. Make sure the + * Ogg/Vorbis file actually has comments to preserve. + * |[ * gst-launch -m filesrc location=foo.mp3 ! id3demux ! fakesink silent=TRUE 2> /dev/null | grep taglist - * </programlisting> - * </para> + * ]| Verify that tags have been written. * </refsect2> */ diff --git a/ext/wavpack/gstwavpackdec.c b/ext/wavpack/gstwavpackdec.c index 70c80f0b..41000273 100644 --- a/ext/wavpack/gstwavpackdec.c +++ b/ext/wavpack/gstwavpackdec.c @@ -24,19 +24,17 @@ /** * SECTION:element-wavpackdec * - * <refsect2> * WavpackDec decodes framed (for example by the WavpackParse element) * Wavpack streams and decodes them to raw audio. * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source * audio codec that features both lossless and lossy encoding. + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! audioconvert ! audioresample ! autoaudiosink - * </programlisting> - * This pipeline decodes the Wavpack file test.wv into raw audio buffers and + * ]| This pipeline decodes the Wavpack file test.wv into raw audio buffers and * tries to play it back using an automatically found audio sink. - * </para> * </refsect2> */ diff --git a/ext/wavpack/gstwavpackenc.c b/ext/wavpack/gstwavpackenc.c index 80337647..647800c5 100644 --- a/ext/wavpack/gstwavpackenc.c +++ b/ext/wavpack/gstwavpackenc.c @@ -22,32 +22,24 @@ /** * SECTION:element-wavpackenc * - * <refsect2> * WavpackEnc encodes raw audio into a framed Wavpack stream. * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source * audio codec that features both lossless and lossy encoding. + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch audiotestsrc num-buffers=500 ! audioconvert ! wavpackenc ! filesink location=sinewave.wv - * </programlisting> - * This pipeline encodes audio from audiotestsrc into a Wavpack file. The audioconvert element is needed + * ]| This pipeline encodes audio from audiotestsrc into a Wavpack file. The audioconvert element is needed * as the Wavpack encoder only accepts input with 32 bit width (and every depth between 1 and 32 bits). - * </para> - * <para> - * <programlisting> + * |[ * gst-launch cdda://1 ! audioconvert ! wavpackenc ! filesink location=track1.wv - * </programlisting> - * This pipeline encodes audio from an audio CD into a Wavpack file using + * ]| This pipeline encodes audio from an audio CD into a Wavpack file using * lossless encoding (the file output will be fairly large). - * </para> - * <para> - * <programlisting> + * |[ * gst-launch cdda://1 ! audioconvert ! wavpackenc bitrate=128000 ! filesink location=track1.wv - * </programlisting> - * This pipeline encodes audio from an audio CD into a Wavpack file using + * ]| This pipeline encodes audio from an audio CD into a Wavpack file using * lossy encoding at a certain bitrate (the file will be fairly small). - * </para> * </refsect2> */ diff --git a/ext/wavpack/gstwavpackparse.c b/ext/wavpack/gstwavpackparse.c index 3f85205d..8fea90b0 100644 --- a/ext/wavpack/gstwavpackparse.c +++ b/ext/wavpack/gstwavpackparse.c @@ -24,19 +24,17 @@ /** * SECTION:element-wavpackparse * - * <refsect2> * WavpackParse takes raw, unframed Wavpack streams and splits them into * single Wavpack chunks with information like bit depth and the position * in the stream. * <ulink url="http://www.wavpack.com/">Wavpack</ulink> is an open-source * audio codec that features both lossless and lossy encoding. + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! fakesink - * </programlisting> - * This pipeline decodes the Wavpack file test.wv into raw audio buffers. - * </para> + * ]| This pipeline decodes the Wavpack file test.wv into raw audio buffers. * </refsect2> */ |