glfs/multimedia/libdriv/pulseaudio.xml

<?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 pulseaudio-download-http "http://freedesktop.org/software/pulseaudio/releases/pulseaudio-&pulseaudio-version;.tar.xz">
  <!ENTITY pulseaudio-download-ftp  " ">
  <!ENTITY pulseaudio-md5sum        "17d21df798cee407b769c6355fae397a">
  <!ENTITY pulseaudio-size          "1.2 MB">
  <!ENTITY pulseaudio-buildsize     "75 MB">
  <!ENTITY pulseaudio-time          "1.0 SBU">
]>

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

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

  <title>PulseAudio-&pulseaudio-version;</title>

  <indexterm zone="pulseaudio">
    <primary sortas="a-PulseAudio">PulseAudio</primary>
  </indexterm>

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

    <para>The <application>PulseAudio</application> package is a sound system
    for POSIX OSes, meaning that it is a proxy for your sound applications. It
    allows you to do advanced operations on your sound data as it passes between
    your application and your hardware. Things like transferring the audio to a
    different machine, changing the sample format or channel count and mixing
    several sounds into one are easily achieved using a sound server.</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="intltool"/>,
    <xref linkend="json-c"/>,
    <xref linkend="libsndfile"/>,
    <xref linkend="pkgconfig"/> and <!-- required to pick up json-c and libsndfile -->
    <xref linkend="speex"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="dbus"/></para>

    <bridgehead renderas="sect4">Recommended (If you are going to use it
    with GNOME)</bridgehead>
    <para role="recommended"><xref linkend="alsa-lib"/>,
    <xref linkend="GConf"/> and <xref linkend="xorg7-lib"/>
    </para>

    <!-- pkgconfig (needed to find libsndfile) pulls in glib -->
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <xref linkend="avahi"/>,
    <ulink url="http://www.bluez.org/">BlueZ</ulink>,
    <ulink url="http://www.fftw.org/">FFTW</ulink>,
    <xref linkend="gtk2"/>,
    <ulink url="http://jackit.sourceforge.net/">JACK</ulink>,
    <ulink url="http://0pointer.de/lennart/projects/libasyncns/">libasyncns</ulink>,
    <xref linkend="libsamplerate"/>,
    <ulink url="http://www.lirc.org/">LIRC</ulink>,
    <xref linkend="openssl"/>,
    <ulink url="http://code.entropywave.com/projects/orc/">ORC</ulink>,
    <ulink url="http://tdb.samba.org/">tdb</ulink> and
    <ulink url="http://valgrind.org/">Valgrind</ulink></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc \
            --localstatedir=/var \
            --libexecdir=/usr/lib \
            --with-module-dir=/usr/lib/pulse/modules &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="commands">
    <title>Command Explanations</title>

    <para><parameter>--libexecdir=/usr/lib</parameter>: This
    parameter ensures that internal <application>PulseAudio</application>
    helpers are installed in <filename class="directory">/usr/lib/pulse
    </filename> instead of <filename class="directory">/usr/libexec/pulse
    </filename>.</para>

    <para><parameter>---with-module-dir=/usr/lib/pulse/modules</parameter>:
    This parameter ensures that <application>PulseAudio</application>
    modules are installed in <filename class="directory">/usr/lib/pulse/modules
    </filename> instead of <filename class="directory">
    /usr/lib/pulse-&pulseaudio-version;/modules</filename>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>esdcompat, gconf-helper, pabrowse, pacat, pacmd, pactl, padsp,
        pamon, paplay, parec, parecord, pasuspender, pax11publish, proximity-helper,
        pulseaudio, qpaeq, start-pulseaudio-kde and start-pulseaudio-x11</seg>
        <seg>libalsa-util.so, libavahi-wrap.so, libcli.so, liboss-util.so,
        libprotocol-cli.so, libprotocol-esound.so, libprotocol-http.so,
        libprotocol-native.so, libprotocol-simple.so,libpulse-mainloop-glib.so, 
        libpulse-simple.so, libpulse.so, libpulsecommon-1.1.so, libpulsecore-1.1.so, 
        libpulsedsp.so, libraop.so, librtp.so, module-alsa-card.so, 
        module-alsa-sink.so, module-alsa-source.so, module-always-sink.so,
        module-augment-properties.so, module-card-restore.so,
        module-cli-protocol-tcp.so, module-cli-protocol-unix.so, module-cli.so,
        module-combine.so, module-console-kit.so, module-cork-music-on-phone.so,
        module-default-device-restore.so, module-detect.so,
        module-device-manager.so, module-device-restore.so,
        module-echo-cancel.so, module-esound-compat-spawnfd.so,
        module-esound-compat-spawnpid.so, module-esound-protocol-tcp.so,
        module-esound-protocol-unix.so, module-esound-sink.so, module-gconf.so,
        module-hal-detect.so, module-http-protocol-tcp.so,
        module-http-protocol-unix.so, module-intended-roles.so,
        module-ladspa-sink.so, module-loopback.so, module-match.so,
        module-mmkbd-evdev.so, module-native-protocol-fd.so,
        module-native-protocol-tcp.so, module-native-protocol-unix.so,
        module-null-sink.so, module-oss.so, module-pipe-sink.so,
        module-pipe-source.so, module-position-event-sounds.so,
        module-raop-discover.so, module-raop-sink.so, module-remap-sink.so,
        module-rescue-streams.so, module-rtp-recv.so, module-rtp-send.so,
        module-rygel-media-server.so, module-simple-protocol-tcp.so,
        module-simple-protocol-unix.so, module-sine-source.so, module-sine.so,
        module-stream-restore.so, module-suspend-on-idle.so,
        module-tunnel-sink.so, module-tunnel-source.so, module-udev-detect.so,
        module-volume-restore.so, module-x11-bell.so,
        module-x11-cork-request.so, module-x11-publish.so, module-x11-xsmp.so,
        module-zeroconf-discover.so, and module-zeroconf-publish.so</seg>
        <seg>/etc/{pulse,xdg/autostart}, /usr/{include/pulse,
        lib/pulse/modules,share/pulseaudio/alsa-mixer/{paths,profile-sets}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="esdcompat">
        <term><command>esdcompat</command></term>
        <listitem>
          <para>is a <application>PulseAudio</application> ESD wrapper
          script.</para>
          <indexterm zone="pulseaudio esdcompat">
            <primary sortas="b-esdcompat">esdcompat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gconf-helper">
        <term><command>gconf-helper</command></term>
        <listitem>
          <para>is helper for <application>PulseAudio
          </application> GConf module.</para>
          <indexterm zone="pulseaudio gconf-helper">
            <primary sortas="b-gconf-helper">gconf-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pacat">
        <term><command>pacat</command></term>
        <listitem>
          <para>Plays back or records raw or encoded audio streams on a
          <application>PulseAudio</application> sound server.</para>
          <indexterm zone="pulseaudio pacat">
            <primary sortas="b-pacat">pacat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pacmd">
        <term><command>pacmd</command></term>
        <listitem>
          <para>is a tool to reconfigure a <application>PulseAudio</application>
          sound server during runtime.</para>
          <indexterm zone="pulseaudio pacmd">
            <primary sortas="b-pacmd">pacmd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pactl">
        <term><command>pactl</command></term>
        <listitem>
          <para>controls a running <application>PulseAudio</application> sound
          server.</para>
          <indexterm zone="pulseaudio pactl">
            <primary sortas="b-pactl">pactl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="padsp">
        <term><command>padsp</command></term>
        <listitem>
          <para>is a <application>PulseAudio</application> OSS Wrapper.</para>
          <indexterm zone="pulseaudio padsp">
            <primary sortas="b-padsp">padsp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pamon">
        <term><command>pamon</command></term>
        <listitem>
          <para>is a symbolic link to pacat.</para>
          <indexterm zone="pulseaudio pamon">
            <primary sortas="b-pamon">pamon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="paplay">
        <term><command>paplay</command></term>
        <listitem>
          <para>plays audio files on <application>PulseAudio</application>
          sound server.</para>
          <indexterm zone="pulseaudio paplay">
            <primary sortas="b-paplay">paplay</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="parec">
        <term><command>parec</command></term>
        <listitem>
          <para>is a symbolic link to pacat.</para>
          <indexterm zone="pulseaudio parec">
            <primary sortas="b-parec">parec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="parecord">
        <term><command>parecord</command></term>
        <listitem>
          <para>is a symbolic link to pacat.</para>
          <indexterm zone="pulseaudio parecord">
            <primary sortas="b-parecord">parecord</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pasuspender">
        <term><command>pasuspender</command></term>
        <listitem>
          <para>is a tool that can be used to tell a local
          <application>PulseAudio</application> sound server to temporarily
          suspend access to the audio devices, to allow other applications
          access them directly.</para>
          <indexterm zone="pulseaudio pasuspender">
            <primary sortas="b-pasuspender">pasuspender</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pax11publish">
        <term><command>pax11publish</command></term>
        <listitem>
          <para>is <application>PulseAudio</application>
          X11 Credential Utility.</para>
          <indexterm zone="pulseaudio pax11publish">
            <primary sortas="b-pax11publish">pax11publish</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pulseaudio-prog">
        <term><command>pulseaudio</command></term>
        <listitem>
          <para>is a networked low-latency sound server for Linux.</para>
          <indexterm zone="pulseaudio pulseaudio-prog">
            <primary sortas="b-pulseaudio-prog">pulseaudio-prog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="qpaeq">
        <term><command>qpaeq</command></term>
        <listitem>
          <para>is a equalizer interface for
          <application>PulseAudio</application> equalizer sinks.</para>
          <indexterm zone="pulseaudio qpaeq">
            <primary sortas="b-qpaeq">qpaeq</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="start-pulseaudio-kde">
        <term><command>start-pulseaudio-kde</command></term>
        <listitem>
          <para>Starts <application>PulseAudio</application> and registers it to
          the X11 session manager.</para>
          <indexterm zone="pulseaudio start-pulseaudio-kde">
            <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="start-pulseaudio-x11">
        <term><command>start-pulseaudio-x11</command></term>
        <listitem>
          <para>Starts <application>PulseAudio</application> and loads 
          module-device-manager to use KDE routing policies.</para>
          <indexterm zone="pulseaudio start-pulseaudio-x11">
            <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="modules">
        <term><filename class='libraryfile'>module-*.so</filename></term>
        <listitem>
          <para>Various library modules.</para>
          <indexterm zone="pulseaudio modules">
            <primary sortas="c-modules">module-*.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>