source: multimedia/libdriv/gst10-plugins-base.xml@ a0ad432

<?xml version="1.0" encoding="UTF-8"?>
<!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 gst10-plugins-base-download-http
           "&gstreamer-dl;/gst-plugins-base/gst-plugins-base-&gst10-plugins-base-version;.tar.xz">
  <!ENTITY gst10-plugins-base-download-ftp  " ">
  <!ENTITY gst10-plugins-base-md5sum        "8a7f8668418d0c8c917bb92218047f9f">
  <!ENTITY gst10-plugins-base-size          "2.3 MB">
  <!ENTITY gst10-plugins-base-buildsize     "88 MB (with tests)">
  <!ENTITY gst10-plugins-base-time          "1.0 SBU (Using parallelism=4; with tests)">
]>

<sect1 id="gst10-plugins-base" xreflabel="gst-plugins-base-&gst10-plugins-base-version;">
  <?dbhtml filename="gst10-plugins-base.html"?>


  <title>gst-plugins-base-&gst10-plugins-base-version;</title>

  <indexterm zone="gst10-plugins-base">
    <primary sortas="a-gst-plugins-base">gst-plugins-base</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GStreamer Base Plug-ins</title>

    <para>
      The <application>GStreamer Base Plug-ins</application> is a well-groomed and
      well-maintained collection of <application>GStreamer</application> plug-ins
      and elements, spanning the range of possible types of elements one would want
      to write for <application>GStreamer</application>. You will need at least one
      of Good, Bad, Ugly or Libav plugins for <application>GStreamer</application>
      applications to function properly.
    </para>

    &lfs122_checked;

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

    <bridgehead renderas="sect3">GStreamer Base Plug-ins Dependencies</bridgehead>

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

    <!-- Common formats, output and input codecs and requirements
    for GNOME apps. What's a multimedia framework useful if it
    can't be used to play anything (common)? -->
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/>,
      <xref linkend="cdparanoia"/> (for building the CDDA plugin),
      &gobject-introspection;,
      <xref linkend="iso-codes"/>,
      <xref linkend="libgudev"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libogg"/>,
      <xref linkend="libpng"/>,
      <xref linkend="libvorbis"/>,
      <xref linkend="mesa"/>,
      <xref linkend="pango"/>,
      <xref linkend="wayland-protocols"/>, and
      <xref linkend="xorg7-lib"/>
   </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="graphene"/>,
      <xref linkend="gtk3"/> (for examples),
      <!--<xref linkend="libtheora"/>,-->
      <xref linkend="opus"/>,
      <xref linkend="sdl2"/>,
      <xref linkend="valgrind"/>,
      <ulink url="https://pypi.org/project/hotdoc">hotdoc</ulink>,
      <ulink url="http://www.theora.org">libtheora</ulink>,
      <ulink url="http://libvisual.org/">libvisual</ulink>,
      <ulink url="https://gstreamer.freedesktop.org/src/orc/">Orc</ulink>, and
      <ulink url="https://wiki.xiph.org/Tremor">Tremor</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GStreamer Base Plug-ins</title>
    <!--
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gst10-objc-error.xml"/>
    -->
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gst10-plugins.xml"/>

    <para>
      Install <application>GStreamer Base Plug-ins</application> by running the
      following commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup ..               \
      --prefix=/usr          \
      --buildtype=release    \
      --wrap-mode=nodownload &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>. The tests
      require an X terminal running, or all of the GL tests will fail. Five
      tests may produce timeouts on some systems depending on their graphics
      hardware and speed. One test, <filename>elements_appsrc</filename>, is
      known to fail on some systems.
    </para>

    <note>
      <para>
        When installing, the build process does some additional
        linking.  If you do not have Xorg in /usr, the LIBRARY_PATH
        variable needs to be defined for the root user.  If
        using sudo to assume root, use the -E option to pass
        your current environment variables for the install process.
      </para>
    </note>

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

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-wrap-nodownload.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gst-device-monitor-1.0,
          gst-discoverer-1.0, and
          gst-play-1.0
        </seg>
        <seg>
          libgstallocators-1.0.so,
          libgstapp-1.0.so,
          libgstaudio-1.0.so,
          libgstfft-1.0.so,
          libgstgl-1.0.so,
          libgstpbutils-1.0.so,
          libgstriff-1.0.so,
          libgstrtp-1.0.so,
          libgstrtsp-1.0.so,
          libgstsdp-1.0.so,
          libgsttag-1.0.so,
          libgstvideo-1.0.so,
          and several plugins under /usr/lib/gstreamer-1.0
        </seg>
        <seg>
          /usr/include/gstreamer-1.0/gst/{allocators,app,audio,fft,gl,pbutils},
          /usr/include/gstreamer-1.0/gst/{riff,rtp,rtsp,sdp,tag,video}, and
          /usr/share/gst-plugins-base
        </seg>
      </seglistitem>
    </segmentedlist>

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

     <varlistentry id="gst-device-monitor-1.0">
        <term><command>gst-device-monitor-1.0</command></term>
        <listitem>
          <para>
            is a command line tool that can be used to test
            GStreamer's device monitoring functionality
          </para>
          <indexterm zone="gst10-plugins-base gst-device-monitor-1.0">
            <primary sortas="b-gst-device-monitor-1.0">gst-device-monitor-1.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="gst-discoverer-1.0">
        <term><command>gst-discoverer-1.0</command></term>
        <listitem>
          <para>
            is a tool that can be used to print basic metadata and
            stream information about a media file
          </para>
          <indexterm zone="gst10-plugins-base gst-discoverer-1.0">
            <primary sortas="b-gst-discoverer-1.0">gst-discoverer-1.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="gst-play-1.0">
        <term><command>gst-play-1.0</command></term>
        <listitem>
          <para>
            is a command line tool that can be used to test basic
            playback using the playbin element
          </para>
          <indexterm zone="gst10-plugins-base gst-play-1.0">
            <primary sortas="b-gst-play-1.0">gst-play-1.0</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>