source: multimedia/libdriv/gstreamer.xml@ 42a04581

<?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.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY gstreamer-download-http "http://gstreamer.freedesktop.org/src/gstreamer/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 "3de474d993e23c901e9dfdd1fea486e0">
<!ENTITY gstreamer-size "1.4 MB">
<!ENTITY gstreamer-buildsize "78 MB">
<!ENTITY gstreamer-time "3.0 SBU (includes building docs, additional 1.0 SBU to run the test suite)">
]>

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

<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</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install &amp;&amp;
chown -v -R root:root /usr/share/doc/gstreamer-&gstreamer-version;/*/html &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
building documentation during the <command>make</command> command. Remove 
this switch if you have the listed dependencies installed.</para>

<para><command>chown -v -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>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>

<seglistitem>
<seg>gst-complete, gst-complete-0.8, gst-compprep, gst-compprep-0.8, 
gst-feedback, gst-feedback-0.8, gst-inspect, gst-inspect-0.8, gst-launch, 
gst-launch-0.8, gst-md5sum, gst-md5sum-0.8, gst-register, gst-register-0.8, 
gst-typefind, gst-typefind-0.8, gst-xmllaunch, gst-xmllaunch-0.8, 
gst-xmlinspect, gst-xmlinspect-0.8</seg>
<seg>libgstcontrol-0.8.[so,a], libgstreamer-0.8.[so,a] and 
libgst*.[so,a] plugin modules</seg>
<seg>/usr/include/gstreamer-0.8, /usr/lib/gstreamer-0.8, 
/usr/share/doc/gstreamer-&gstreamer-version;, 
/usr/share/gtk-doc/html/gstreamer-0.8, 
/usr/share/gtk-doc/html/gstreamer-libs-0.8 and /var/cache/gstreamer-0.8</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry id="gst-complete">
<term><command>gst-complete-0.8</command></term>
<listitem><para>is a utility enabling <command>bash</command> to provide 
context sensitive tab completion for <command>gst-launch</command> command 
lines.</para>
<indexterm zone="gstreamer gst-complete">
<primary sortas="b-gst-complete">gst-complete-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-compprep">
<term><command>gst-compprep-0.8</command></term>
<listitem><para>builds a registry of <application>GStreamer</application> 
elements and their features that is used by 
<command>gst-complete</command>.</para>
<indexterm zone="gstreamer gst-compprep">
<primary sortas="b-gst-compprep">gst-compprep-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-feedback">
<term><command>gst-feedback-0.8</command></term>
<listitem><para>generates debug info for <application>GStreamer</application> 
bug reports.</para>
<indexterm zone="gstreamer gst-feedback">
<primary sortas="b-gst-feedback">gst-feedback-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-inspect">
<term><command>gst-inspect-0.8</command></term>
<listitem><para>prints information about a 
<application>GStreamer</application> plugin or element.</para>
<indexterm zone="gstreamer gst-inspect">
<primary sortas="b-gst-inspect">gst-inspect-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-launch">
<term><command>gst-launch-0.8</command></term>
<listitem><para>is a tool that builds and runs basic 
<application>GStreamer</application> pipelines.</para>
<indexterm zone="gstreamer gst-launch">
<primary sortas="b-gst-launch">gst-launch-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-md5sum">
<term><command>gst-md5sum-0.8</command></term>
<listitem><para>generates MD5 checksums of the data generated by a 
<application>GStreamer</application> pipeline.</para>
<indexterm zone="gstreamer gst-md5sum">
<primary sortas="b-gst-md5sum">gst-md5sum-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-register">
<term><command>gst-register-0.8</command></term>
<listitem><para>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>
<indexterm zone="gstreamer gst-register">
<primary sortas="b-gst-register">gst-register-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-typefind">
<term><command>gst-typefind-0.8</command></term>
<listitem><para>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 
<acronym>MIME</acronym> type.</para>
<indexterm zone="gstreamer gst-typefind">
<primary sortas="b-gst-typefind">gst-typefind-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-xmlinspect">
<term><command>gst-xmlinspect-0.8</command></term>
<listitem><para>prints information about a 
<application>GStreamer</application> plugin or element in 
<acronym>XML</acronym> document format.</para>
<indexterm zone="gstreamer gst-xmlinspect">
<primary sortas="b-gst-xmlinspect">gst-xmlinspect-0.8</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="gst-xmllaunch">
<term><command>gst-xmllaunch-0.8</command></term>
<listitem><para>is used to build and run a basic 
<application>GStreamer</application> pipeline, loading it from an 
<acronym>XML</acronym> description.</para>
<indexterm zone="gstreamer gst-xmllaunch">
<primary sortas="b-gst-xmllaunch">gst-xmllaunch-0.8</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>