source: multimedia/libdriv/gstreamer10.xml@ 8f1fc267

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

  <!ENTITY gstreamer10-download-http "&gstreamer-dl;/gstreamer/gstreamer-&gstreamer10-version;.tar.xz">
  <!ENTITY gstreamer10-download-ftp  " ">
  <!ENTITY gstreamer10-md5sum        "bd0938d680d657249b885162f310702d">
  <!ENTITY gstreamer10-size          "3.2 MB">
  <!ENTITY gstreamer10-buildsize     "77 MB (additional 19 MB to run the test suite)">
  <!ENTITY gstreamer10-time          "0.7 SBU (additional 0.8 SBU to run the test suite)">
]>

<sect1 id="gstreamer10" xreflabel="GStreamer-&gstreamer10-version;">
  <?dbhtml filename="gstreamer10.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>GStreamer-&gstreamer10-version;</title>

  <indexterm zone="gstreamer10">
    <primary sortas="a-GStreamer">GStreamer</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GStreamer</title>

    <para>
      <application>GStreamer</application> is a streaming media framework that enables
      applications to share a common set of plugins for things like video encoding and
      decoding, audio encoding and decoding, audio and video filters, audio visualisation,
      web streaming and anything else that streams in real-time or otherwise. This package
      only provides base functionality and libraries. You may need at least
      <xref linkend="gst10-plugins-base"/> and one of Good, Bad, Ugly or Libav plugins.
    </para>

    &lfs75_checked;

    &gst-compat;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&gstreamer10-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&gstreamer10-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &gstreamer10-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &gstreamer10-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &gstreamer10-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &gstreamer10-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">GStreamer Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>
    </para>

    <!-- Required for GNOME -->
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gsl"/>,
      <xref linkend="gtk-doc"/>, and
      <xref linkend="valgrind"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/gstreamer10"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of GStreamer</title>

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

<screen><userinput>./configure --prefix=/usr \
            --with-package-name="GStreamer &gstreamer10-version; BLFS" \
            --with-package-origin="http://www.linuxfromscratch.org/blfs/view/svn/" &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          gst-inspect-1.0, gst-launch-1.0 and gst-typefind-1.0
        </seg>
        <seg>
          libgstbase-1.0.so, libgstcheck-1.0.so, libgstcontroller-1.0.so,
          libgstnet-1.0.so, libgstreamer-1.0.so 
          and /usr/lib/gstreamer-1.0/libgstcoreelements.so
        </seg>
        <seg>
          /usr/include/gstreamer-1.0,
          /usr/lib/gstreamer-1.0,
          /usr/libexec/gstreamer-1.0, and
          /usr/share/gtk-doc/html/gstreamer{,-{libs,plugins}}-1.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gst-inspect-1">
        <term><command>gst-inspect-1.0</command></term>
        <listitem>
          <para>
            is a tool that prints out information on available
            <application>GStreamer</application> plugins,
            information about a particular plugin, or information
            about a particular element.
          </para>
          <indexterm zone="gstreamer10 gst-inspect-1">
            <primary sortas="b-gst-inspect-1">gst-inspect-1.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="gst-typefind-1">
        <term><command>gst-typefind-1.0</command></term>
        <listitem>
          <para>
            uses the <application>GStreamer</application> type finding system
            to determine the relevant <application>GStreamer</application>
            plugin to parse or decode file, and the corresponding MIME type.
          </para>
          <indexterm zone="gstreamer10 gst-typefind-1">
            <primary sortas="b-gst-typefind-1">gst-typefind-1.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgstbase-1">
        <term><filename class="libraryfile">libgstbase-1.0.so</filename></term>
        <listitem>
          <para>
            provides some base classes to be extended by elements and utillity
            classes that are most useful for plugin developers.
          </para>
          <indexterm zone="gstreamer10 libgstbase-1">
            <primary sortas="c-libgstbase-1">libgstbase-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgstcheck-1">
        <term><filename class="libraryfile">libgstcheck-1.0.so</filename></term>
        <listitem>
          <para>
            provides functionality for writing unit tests that use the check
            framework.
          </para>
          <indexterm zone="gstreamer10 libgstcheck-1">
            <primary sortas="c-libgstcheck-1">libgstcheck-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgstcontroller-1">
        <term><filename class="libraryfile">libgstcontroller-1.0.so</filename></term>
        <listitem>
          <para>
            provides functionality to animate element properties over time.
          </para>
          <indexterm zone="gstreamer10 libgstcontroller-1">
            <primary sortas="c-libgstcontroller-1">libgstcontroller-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgstnet-1">
        <term><filename class="libraryfile">libgstnet-1.0.so</filename></term>
        <listitem>
          <para>
            provides network elements and objects.
          </para>
          <indexterm zone="gstreamer10 libgstnet-1">
            <primary sortas="c-libgstnet-1">libgstnet-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgstreamer-1">
        <term><filename class="libraryfile">libgstreamer-1.0.so</filename></term>
        <listitem>
          <para>
            provides all the core <application>GStreamer</application> services,
            including initialization, plugin management and types, as well as
            the object hierarchy that defines elements and bins, along with
            some more specialized elements.
          </para>
          <indexterm zone="gstreamer10 libgstreamer-1">
            <primary sortas="c-libgstreamer-1">libgstreamer-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>