Commit 78022a6e authored by Thibault Saunier's avatar Thibault Saunier
Browse files

docs: Port all docstring to gtk-doc markdown

parent 90f766cc
......@@ -20,15 +20,15 @@
/**
* SECTION:element-assrender
* @title: assrender
*
* Renders timestamped SSA/ASS subtitles on top of a video stream.
*
* <refsect2>
* <title>Example launch line</title>
* ## Example launch line
* |[
* gst-launch-1.0 -v filesrc location=/path/to/mkv ! matroskademux name=d ! queue ! mpegaudioparse ! mpg123audiodec ! audioconvert ! autoaudiosink d. ! queue ! h264parse ! avdec_h264 ! videoconvert ! r. d. ! queue ! "application/x-ass" ! assrender name=r ! videoconvert ! autovideosink
* ]| This pipeline demuxes a Matroska file with h.264 video, MP3 audio and embedded ASS subtitles and renders the subtitles on top of the video.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,17 +20,17 @@
/**
* SECTION:element-bs2b
* @title: bs2b
*
* Improve headphone listening of stereo audio records using the bs2b library.
* Improve headphone listening of stereo audio records using the bs2b library.
* It does so by mixing the left and right channel in a way that simulates
* a stereo speaker setup while using headphones.
*
* <refsect2>
* <title>Example pipelines</title>
* ## Example pipelines
* |[
* gst-launch-1.0 audiotestsrc ! "audio/x-raw,channel-mask=(bitmask)0x1" ! interleave name=i ! bs2b ! autoaudiosink audiotestsrc freq=330 ! "audio/x-raw,channel-mask=(bitmask)0x2" ! i.
* ]| Play two independent sine test sources and crossfeed them.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -23,18 +23,18 @@
/**
* SECTION:element-chromaprint
* @title: chromaprint
*
* The chromaprint element calculates an acoustic fingerprint for an
* audio stream which can be used to identify a song and look up
* further metadata from the <ulink url="http://acoustid.org/">Acoustid</ulink>
* and Musicbrainz databases.
*
* <refsect2>
* <title>Example launch line</title>
* ## Example launch line
* |[
* gst-launch-1.0 -m uridecodebin uri=file:///path/to/song.ogg ! audioconvert ! chromaprint ! fakesink
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -19,14 +19,14 @@
/**
* SECTION:element-curlsink
* @title: curlsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* a server (e.g. a HTTP/FTP server).
*
* <refsect2>
* <title>Example launch line (upload a JPEG file to an HTTP server)</title>
* ## Example launch line (upload a JPEG file to an HTTP server)
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlsink \
* file-name=image.jpg \
......@@ -35,7 +35,7 @@
* content-type=image/jpeg \
* use-content-length=false
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -19,21 +19,20 @@
/**
* SECTION:element-curlfilesink
* @title: curlfilesink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* a local or network drive.
*
* <refsect2>
* <title>Example launch line (upload a JPEG file to /home/test/images
* directory)</title>
* ## Example launch line (upload a JPEG file to /home/test/images directory)
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlfilesink \
* file-name=image.jpg \
* location=file:///home/test/images/
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -19,21 +19,23 @@
/**
* SECTION:element-curlftpsink
* @title: curlftpsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* an FTP server.
*
* <refsect2>
* <title>Example launch line (upload a JPEG file to /home/test/images
* directory)</title>
* ## Example launch line
*
* Upload a JPEG file to /home/test/images * directory)
*
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlftpsink \
* file-name=image.jpg \
* location=ftp://192.168.0.1/images/
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -19,14 +19,17 @@
/**
* SECTION:element-curlhttpsink
* @title: curlhttpsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* an HTTP server.
*
* <refsect2>
* <title>Example launch line (upload a JPEG file to an HTTP server)</title>
* ## Example launch line
*
* Upload a JPEG file to an HTTP server.
*
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlhttpsink \
* file-name=image.jpg \
......@@ -35,7 +38,6 @@
* content-type=image/jpeg \
* use-content-length=false
* ]|
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
......
......@@ -19,14 +19,17 @@
/**
* SECTION:element-curlsftpsink
* @title: curlsftpsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* a SFTP (SSH File Transfer Protocol) server.
*
* <refsect2>
* <title>Example launch line (upload a file to /home/john/sftp_tests/)</title>
* ## Example launch line
*
* Upload a file to /home/john/sftp_tests/
*
* |[
* gst-launch-1.0 filesrc location=/home/jdoe/some.file ! curlsftpsink \
* file-name=some.file.backup \
......@@ -36,8 +39,6 @@
* ssh-priv-keyfile=/home/jdoe/.ssh/id_rsa \
* create-dirs=TRUE
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -19,14 +19,17 @@
/**
* SECTION:element-curlsink
* @title: curlsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* an SMTP server.
*
* <refsect2>
* <title>Example launch line (upload a JPEG file to an SMTP server)</title>
* ## Example launch line
*
* Upload a JPEG file to an SMTP server.
*
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlsmtpsink \
* file-name=image.jpg \
......@@ -38,7 +41,7 @@
* use-ssl=TRUE \
* insecure=TRUE
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -19,6 +19,7 @@
/**
* SECTION:element-curlsshsink
* @title: curlsshsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
......
......@@ -19,6 +19,7 @@
/**
* SECTION:element-curltlssink
* @title: curltlssink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
......
......@@ -23,6 +23,7 @@
/**
* SECTION:element-daaladec
* @title: daaladec
* @see_also: daalaenc, oggdemux
*
* This element decodes daala streams into raw video
......@@ -30,13 +31,12 @@
* video codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org
* Foundation</ulink>.
*
* <refsect2>
* <title>Example pipeline</title>
* ## Example pipeline
* |[
* gst-launch-1.0 -v filesrc location=videotestsrc.ogg ! oggdemux ! daaladec ! xvimagesink
* ]| This example pipeline will decode an ogg stream and decodes the daala video. Refer to
* the daalaenc example to create the ogg file.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -23,6 +23,7 @@
/**
* SECTION:element-daalaenc
* @title: daalaenc
* @see_also: daaladec, oggmux
*
* This element encodes raw video into a Daala stream.
......@@ -30,14 +31,13 @@
* video codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org
* Foundation</ulink>.
*
* <refsect2>
* <title>Example pipeline</title>
* ## Example pipeline
* |[
* gst-launch-1.0 -v videotestsrc num-buffers=1000 ! daalaenc ! oggmux ! filesink location=videotestsrc.ogg
* ]| This example pipeline will encode a test video source to daala muxed in an
* ogg container. Refer to the daaladec documentation to decode the create
* stream.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -29,9 +29,10 @@
*/
/**
* SECTION:element-dashdemux
* @title: dashdemux
*
* DASH demuxer element.
* <title>Example launch line</title>
* ## Example launch line
* |[
* gst-launch-1.0 playbin uri="http://www-itec.uni-klu.ac.at/ftp/datasets/mmsys12/RedBullPlayStreets/redbull_4s/RedBullPlayStreets_4s_isoffmain_DIS_23009_1_v_2_1c2_2011_08_30.mpd"
* ]|
......
......@@ -20,6 +20,7 @@
/**
* SECTION:element-dc1394src
* @title: dc1394src
*
* Source for IIDC (Instrumentation & Industrial Digital Camera) firewire
* cameras. If several cameras are connected to the system, the desired one
......@@ -31,8 +32,7 @@
* corresponding video formats are exposed in the capabilities.
* The Bayer pattern is left unspecified.
*
* <refsect2>
* <title>Example launch lines</title>
* ## Example launch lines
* |[
* gst-launch-1.0 -v dc1394src ! videoconvert ! autovideosink
* ]| Capture and display frames from the first camera available in the system.
......@@ -41,7 +41,7 @@
* ! "video/x-bayer,format=gbrg,width=1280,height=960,framerate=15/2" \
* ! bayer2rgb ! videoconvert ! autovideosink
* ]| Capture and display frames from a specific camera in the desired format.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,66 +20,52 @@
/**
* SECTION:element-dfbvideosink
* @title: dfbvideosink
*
* DfbVideoSink renders video frames using the
* <ulink url="http://www.directfb.org/">DirectFB</ulink> library.
* Rendering can happen in two different modes :
* <itemizedlist>
* <listitem>
* <para>
* Standalone: this mode will take complete control of the monitor forcing
*
* * Standalone: this mode will take complete control of the monitor forcing
* <ulink url="http://www.directfb.org/">DirectFB</ulink> to fullscreen layout.
* This is convenient to test using the gst-launch-1.0 command line tool or
* other simple applications. It is possible to interrupt playback while
* being in this mode by pressing the Escape key.
* </para>
* <para>
* This mode handles navigation events for every input device supported by
* the <ulink url="http://www.directfb.org/">DirectFB</ulink> library, it will
* look for available video modes in the fb.modes file and try to switch
* the framebuffer video mode to the most suitable one. Depending on
* the framebuffer video mode to the most suitable one. Depending on
* hardware acceleration capabilities the element will handle scaling or not.
* If no acceleration is available it will do clipping or centering of the
* video frames respecting the original aspect ratio.
* </para>
* </listitem>
* <listitem>
* <para>
* Embedded: this mode will render video frames in a
*
* * Embedded: this mode will render video frames in a
* #GstDfbVideoSink:surface provided by the
* application developer. This is a more advanced usage of the element and
* it is required to integrate video playback in existing
* it is required to integrate video playback in existing
* <ulink url="http://www.directfb.org/">DirectFB</ulink> applications.
* </para>
* <para>
* When using this mode the element just renders to the
* #GstDfbVideoSink:surface provided by the
* #GstDfbVideoSink:surface provided by the
* application, that means it won't handle navigation events and won't resize
* the #GstDfbVideoSink:surface to fit video
* frames geometry. Application has to implement the necessary code to grab
* informations about the negotiated geometry and resize there
* #GstDfbVideoSink:surface accordingly.
* </para>
* </listitem>
* </itemizedlist>
* For both modes the element implements a buffer pool allocation system to
* optimize memory allocation time and handle reverse negotiation. Indeed if
*
* For both modes the element implements a buffer pool allocation system to
* optimize memory allocation time and handle reverse negotiation. Indeed if
* you insert an element like videoscale in the pipeline the video sink will
* negotiate with it to try get a scaled video for either the fullscreen layout
* or the application provided external #GstDfbVideoSink:surface.
*
* <refsect2>
* <title>Example application</title>
* <para>
* ## Example application
*
* <include xmlns="http://www.w3.org/2003/XInclude" href="element-dfb-example.xml" />
* </para>
* </refsect2>
* <refsect2>
* <title>Example pipelines</title>
*
* ## Example pipelines
* |[
* gst-launch-1.0 -v videotestsrc ! dfbvideosink hue=20000 saturation=40000 brightness=25000
* ]| test the colorbalance interface implementation in dfbvideosink
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
......@@ -810,7 +796,7 @@ gst_dfbvideosink_setup (GstDfbVideoSink * dfbvideosink)
dfbvideosink->backbuffer = FALSE;
dfbvideosink->pixel_format = DSPF_UNKNOWN;
/* If we do it all by ourself we create the DirectFB context, get the
/* If we do it all by ourself we create the DirectFB context, get the
primary layer and use a fullscreen configuration */
if (!dfbvideosink->ext_surface) {
GST_DEBUG_OBJECT (dfbvideosink, "no external surface, taking over "
......
......@@ -20,18 +20,18 @@
/**
* SECTION:element-dtsdec
* @title: dtsdec
*
* Digital Theatre System (DTS) audio decoder
*
* <refsect2>
* <title>Example launch line</title>
*
* ## Example launch line
* |[
* gst-launch-1.0 dvdreadsrc title=1 ! mpegpsdemux ! dtsdec ! audioresample ! audioconvert ! alsasink
* ]| Play a DTS audio track from a dvd.
* |[
* gst-launch-1.0 filesrc location=abc.dts ! dtsdec ! audioresample ! audioconvert ! alsasink
* ]| Decode a standalone file and play it.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,16 +20,16 @@
/**
* SECTION:element-faac
* @title: faac
* @see_also: faad
*
* faac encodes raw audio to AAC (MPEG-4 part 3) streams.
*
* <refsect2>
* <title>Example launch line</title>
* ## Example launch line
* |[
* gst-launch-1.0 audiotestsrc wave=sine num-buffers=100 ! audioconvert ! faac ! matroskamux ! filesink location=sine.mkv
* ]| Encode a sine beep as aac and write to matroska container.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,19 +20,19 @@
/**
* SECTION:element-faad
* @title: faad
* @seealso: faac
*
* faad decodes AAC (MPEG-4 part 3) stream.
*
* <refsect2>
* <title>Example launch lines</title>
* ## Example launch lines
* |[
* gst-launch-1.0 filesrc location=example.mp4 ! qtdemux ! faad ! audioconvert ! audioresample ! autoaudiosink
* ]| Play aac from mp4 file.
* |[
* gst-launch-1.0 filesrc location=example.adts ! faad ! audioconvert ! audioresample ! autoaudiosink
* ]| Play standalone aac bitstream.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -21,19 +21,19 @@
/**
* SECTION:element-fluiddec
* @title: fluiddec
* @see_also: timidity, wildmidi
*
* This element renders midi-events as audio streams using
* <ulink url="http://fluidsynth.sourceforge.net//">Fluidsynth</ulink>.
* It offers better sound quality compared to the timidity or wildmidi element.
*
* <refsect2>
* <title>Example pipeline</title>
* ## Example pipeline
* |[
* gst-launch-1.0 filesrc location=song.mid ! midiparse ! fluiddec ! pulsesink
* ]| This example pipeline will parse the midi and render to raw audio which is
* played via pulseaudio.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment