source: multimedia/libdriv/gstreamer.xml@ 86af98a

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY gstreamer-download-http "http://ftp.gnome.org/pub/GNOME/sources/gstreamer/0.8/gstreamer-&gstreamer-version;.tar.bz2">
<!ENTITY gstreamer-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gstreamer/0.8/gstreamer-&gstreamer-version;.tar.bz2">
<!ENTITY gstreamer-md5sum "6cbfa914cd577d2623bf7e16cf1f6510">
<!ENTITY gstreamer-size "1.4 MB">
<!ENTITY gstreamer-buildsize "74 MB">
<!ENTITY gstreamer-time "2.30 SBU">
]>

<sect1 id="gstreamer" xreflabel="GStreamer-&gstreamer-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="gstreamer.html"?>
<title>GStreamer-&gstreamer-version;</title>

<sect2>
<title>Introduction to <application>GStreamer</application></title>

<para>The <application>GStreamer</application> package contains a streaming 
media framework that enables applications to share a common set of plugins for 
things like video decoding and encoding, audio encoding and decoding, audio 
and video filters, audio visualisation, Web streaming and anything else that 
streams in real-time or otherwise. It is modelled after research software 
worked on at the Oregon Graduate Institute.</para>
 
<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&gstreamer-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&gstreamer-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: &gstreamer-md5sum;</para></listitem>
<listitem><para>Download size: &gstreamer-size;</para></listitem>
<listitem><para>Estimated disk space required:
&gstreamer-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&gstreamer-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>GStreamer</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="glib2"/>, 
<xref linkend="libxml2"/>, 
<xref linkend="popt"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="libgnomeui"/>, 
<xref linkend="python"/> and 
<ulink url="http://valgrind.kde.org/">Valgrind</ulink></para>
</sect4>

<sect4><title>Optional (to build documentation)</title>
<para><xref linkend="libxslt"/>, 
<xref linkend="gtk-doc"/>, 
<xref linkend="tex"/>, 
<xref linkend="gs"/> or 
<xref linkend="espgs"/>, 
<xref linkend="docbook-utils"/>, 
<ulink url="http://www.xfig.org/">Transfig</ulink> and 
<ulink url="http://netpbm.sourceforge.net/">Netpbm</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>GStreamer</application></title>

<para>Install <application>GStreamer</application> by running the following 
commands:</para>

<screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
    --localstatedir=/var --disable-docs-build &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
chown -R root:root /usr/share/doc/gstreamer-&gstreamer-version; &amp;&amp;
gst-register</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--localstatedir=/var</parameter>: This switch puts 
<command>gst-register</command>'s cache in 
<filename class="directory">/var/cache/gstreamer-0.8</filename> 
instead of 
<filename class="directory">/usr/cache/gstreamer-0.8</filename>.</para>

<para><parameter>--sysconfdir=/etc</parameter>: This switch puts configuration 
files in <filename class="directory">/etc</filename> 
instead of <filename class="directory">/usr/etc</filename>.</para>

<para><option>--disable-docs-build</option>: This switch prevents
the rebuilding of documentation during the <command>make</command>
command.</para>

<para><command>chown -R root:root ...</command>: The documentation is 
installed with ownerships of the user who untarred and built the package. 
This command changes the ownerships of the installed documentation files to
root:root.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>GStreamer</application> package contains 
<command>gst-complete</command>, 
<command>gst-compprep</command>, 
<command>gst-feedback</command>, 
<command>gst-inspect</command>, 
<command>gst-launch</command>, 
<command>gst-md5sum</command>, 
<command>gst-register</command>, 
<command>gst-typefind</command>, 
<command>gst-xmlinspect</command>, 
<command>gst-xmllaunch</command>, 
the <filename class="libraryfile">libgstreamer</filename>, 
<filename class='libraryfile'>libgstcontrol</filename> and 
<filename class="libraryfile">libgst</filename> libraries.</para>

</sect2>

<sect2>
<title>Description</title>

<sect3><title>gst-complete</title>
<para><command>gst-complete</command> is a utility enabling 
<command>bash</command> to provide context sensitive tab completion for 
<command>gst-launch</command> command lines.</para>
</sect3>

<sect3><title>gst-compprep</title>
<para><command>gst-compprep</command> builds a registry of 
<application>GStreamer</application> elements and their features that is used 
by <command>gst-complete</command>.</para>
</sect3>

<sect3><title>gst-feedback</title>
<para><command>gst-feedback</command> generates debug info for 
<application>GStreamer</application> bug reports.</para>
</sect3>

<sect3><title>gst-inspect</title>
<para><command>gst-inspect</command> prints information about a 
<application>GStreamer</application> plugin or element.</para>
</sect3>

<sect3><title>gst-launch</title>
<para><command>gst-launch</command> is a tool that builds and runs basic 
<application>GStreamer</application> pipelines.</para>
</sect3>

<sect3><title>gst-md5sum</title>
<para><command>gst-md5sum</command> generates MD5 checksums of the data 
generated by a <application>GStreamer</application> pipeline.</para>
</sect3>

<sect3><title>gst-register</title>
<para><command>gst-register</command> is used to register all the 
<application>GStreamer</application> plugins on the system. It creates a 
listing of their properties so that when a 
<application>GStreamer</application> based application is started, it does not 
need to load plugins until it needs them.</para>
</sect3>

<sect3><title>gst-typefind</title>
<para><command>gst-typefind</command> uses the 
<application>GStreamer</application> type finding system to determine the 
relevant <application>GStreamer</application> plugin to parse or decode a file, 
and determine the corresponding MIME type.</para>
</sect3>

<sect3><title>gst-xmlinspect</title>
<para><command>gst-xmlinspect</command> prints information about a 
<application>GStreamer</application> plugin or element in 
<acronym>XML</acronym> document format.</para>
</sect3>

<sect3><title>gst-xmllaunch</title>
<para><command>gst-xmllaunch</command> is used to build and run a basic 
<application>GStreamer</application> pipeline, loading it from an 
<acronym>XML</acronym> description.</para>
</sect3>

</sect2>

</sect1>