source: kde/phonon-backend-gstreamer.xml@ ade6157

<?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 phonon-backend-gstreamer-download-http "&kde-download-http;phonon/phonon-backend-gstreamer/&phonon-backend-gstreamer-version;/src/phonon-backend-gstreamer-&phonon-backend-gstreamer-version;.tar.xz">
  <!ENTITY phonon-backend-gstreamer-download-ftp  "&kde-download-ftp;phonon/phonon-backend-gstreamer/&phonon-backend-gstreamer-version;/src/phonon-backend-gstreamer-&phonon-backend-gstreamer-version;.tar.xz">
  <!ENTITY phonon-backend-gstreamer-md5sum        "ce441035dc5a00ffaac9a64518ab5c62">
  <!ENTITY phonon-backend-gstreamer-size          "76 KB">
  <!ENTITY phonon-backend-gstreamer-buildsize     "4.1 MB">
  <!ENTITY phonon-backend-gstreamer-time          "0.2 SBU">
]>

<sect1 id="phonon-backend-gstreamer" xreflabel="phonon-backend-gstreamer-&phonon-backend-gstreamer-version;">
  <?dbhtml filename="phonon-backend-gstreamer.html"?>

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

  <title>Phonon-backend-gstreamer-&phonon-backend-gstreamer-version;</title>

  <indexterm zone="phonon-backend-gstreamer">
    <primary sortas="a-phonon-backend-gstreamer">phonon-backend-gstreamer</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to the Phonon-backend-gstreamer</title>

    <para>This package provides a <application>Phonon</application> backend
    which utilizes the <application>GStreamer</application> media framework.
    Its library is used by both KDE4 and KF5, but they must be linked to <xref
    linkend="qt4"/> and  <xref linkend="qt5"/> respectively. The two versions
    do not conflict with each other. </para>

    &lfs79_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required download:
          <ulink url="&patch-root;/phonon-backend-gstreamer-&phonon-backend-gstreamer-version;-compatibility-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Phonon-backend-gstreamer Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
    <xref linkend="gstreamer10"/>,
    <xref linkend="libxml2"/>, and
    <xref linkend="phonon"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
    <xref linkend="gst10-plugins-base"/> (needed for output to ALSA),
    <xref linkend="gst10-plugins-good"/> (needed for output to PulseAudio),
    <xref linkend="gst10-plugins-bad"/>  (needed for AAC/M4A support), and
    <xref linkend="gst10-plugins-ugly"/> (needed for MP3 support)
    </para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Phonon-backend-gstreamer</title>

    <para>For both build variants, fix the package to work with the
    latest gstreamer:</para>

<screen><userinput>patch -Np1 -i ../phonon-backend-gstreamer-&phonon-backend-gstreamer-version;-compatibility-1.patch</userinput></screen>

    <para>Install the qt4 based version of
    <application>Phonon-backend-gstreamer</application> by running the
    following commands:</para>

<screen><userinput>source /usr/bin/setqt4 &amp;&amp;

mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_INSTALL_LIBDIR=lib  \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev .. &amp;&amp;
make</userinput></screen>

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

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

    <para>Install the qt5 based version of
    <application>Phonon-backend-gstreamer</application> by running the
    following commands:</para>

<screen><userinput>source /usr/bin/setqt5 &amp;&amp;

mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr    \
      -DCMAKE_INSTALL_LIBDIR=lib     \
      -DCMAKE_BUILD_TYPE=Release     \
      -DPHONON_BUILD_PHONON4QT5=ON   \
      -D__KDE_HAVE_GCC_VISIBILITY=NO \
      -Wno-dev .. &amp;&amp;
make</userinput></screen>

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

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

  </sect2>

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

    <para><option>-DCMAKE_BUILD_TYPE=Release</option>: This switch is used to
    apply higher level of compiler optimizations.</para>

    <para><option>-DCMAKE_INSTALL_LIBDIR=lib</option>: This switch is used to
     get libraries to install to /usr/lib instead of /usr/lib64 on a 64 bit
     system.</para>

    <para><option>-DPHONON_BUILD_PHONON4QT5=ON</option>: This switch is used to
    ensure that Qt5 version of the backend is built even if Qt4 is present.</para>

    <para><option>-D__KDE_HAVE_GCC_VISIBILITY=NO</option>: This switch is used to
    disable a check that would cause cmake to fail when using Qt-5.4.2 or later.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>none</seg>
        <seg>phonon_gstreamer.so (two versions in different directories)</seg>
        <seg>/usr/lib/kde4/plugins/phonon_backend,
             /usr/lib/qt5/plugins/phonon4qt5_backend, and
             /usr/share/kde4/services/phononbackends</seg>
      </seglistitem>
    </segmentedlist>
<!--
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="a-phonon">
        <term><command>phonon</command></term>
        <listitem>
          <para>is a testing utility for phonon-backend-gstreamer-generated build trees.</para>
          <indexterm zone="a-phonon phonon">
            <primary sortas="b-phonon">phonon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
-->
  </sect2>

</sect1>