source: multimedia/audioutils/audacious.xml@ 32bf905

<?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 audacious-download-http
           "https://distfiles.audacious-media-player.org/audacious-&audacious-version;.tar.bz2">
  <!ENTITY audacious-download-ftp         " ">
  <!ENTITY audacious-md5sum               "751a002964907c3a8fc2f571ffc00ec7">
  <!ENTITY audacious-size                 "620 KB">
  <!ENTITY audacious-buildsize            "16 MB (with Qt5 and GTK3 support)">
  <!ENTITY audacious-time                 "0.2 SBU (with Qt5 and GTK3 support)">

  <!ENTITY audacious-plugins-download
           "https://distfiles.audacious-media-player.org/audacious-plugins-&audacious-plugins-version;.tar.bz2">
  <!ENTITY audacious-plugins-md5sum       "3e233d8219407218244e684e096236ec">
  <!ENTITY audacious-plugins-size         "1.7 MB">
  <!ENTITY audacious-plugins-buildsize    "37 MB (with Qt5 and GTK3 support)">
  <!ENTITY audacious-plugins-time         "1.4 SBU (with Qt5 and GTK3 support)">
]>

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


  <title>Audacious-&audacious-version;</title>

  <indexterm zone="audacious">
    <primary sortas="a-Audacious">Audacious</primary>
  </indexterm>

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

    <para>
      <application>Audacious</application> is an audio player.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
    <title>Required Plugins</title>
      <listitem>
        <para>
          Download (HTTP): <ulink url="&audacious-plugins-download;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &audacious-plugins-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &audacious-plugins-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &audacious-plugins-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &audacious-plugins-time;
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk3"/> or
      (<xref linkend="qt5"/> or
       <xref role="nodep" linkend="qt5-components"/> with qtmultimedia)
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="optional">
      <xref linkend="libarchive"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="valgrind"/>
    </para>

    <bridgehead renderas="sect4">Recommended (for Plugins)</bridgehead>
    <para role="recommended">
      <xref linkend="mpg123"/>,
      <xref linkend="ffmpeg"/>, and
      <xref linkend="neon"/> (for online mp3 and ogg radio)
    </para>

    <bridgehead renderas="sect4">Optional (for Plugins)</bridgehead>
    <para role="optional">
      <xref linkend="alsa"/>,
      <xref linkend="curl"/>,
      <xref linkend="faad2"/>,
      <xref linkend="flac"/>,
      <xref linkend="lame"/>,
      <xref linkend="libxml2"/>,
      <xref linkend="libcdio"/> (to identify and play CDs),
      <xref linkend="libnotify"/>,
      <xref linkend="libsndfile"/>,
      <xref linkend="libvorbis"/>,
      <xref linkend="pipewire"/>,
      <xref linkend="pulseaudio"/>,
      <xref linkend="sdl2"/>,
      <ulink url="https://ampache-browser.org/">ampache-browser</ulink>,
      <ulink url="https://adplug.github.io/">adplug</ulink>,
      <ulink url="https://sourceforge.net/projects/bs2b/">The Bauer
        stereophonic-to-binaural DSP (bs2b) library</ulink>,
      <ulink url="https://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
      <ulink url="https://jackaudio.org/">JACK</ulink>
        (requires <xref linkend="libsamplerate"/>),
      <ulink url="https://sourceforge.net/projects/libcue/">libcue</ulink>,
      <ulink url="https://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
      <ulink url="https://sourceforge.net/projects/libmms">libmms</ulink>,
      <ulink url="https://lib.openmpt.org/libopenmpt/">libopenmpt</ulink>,
      <ulink url="https://www.sourceforge.net/projects/sidplay-residfp/">libsidplayfp</ulink>,
      <ulink url="https://www.lirc.org/">LIRC</ulink>,
      <ulink url="https://sndio.org/">sndio</ulink>,
      <ulink url="https://sourceforge.net/p/soxr/wiki/Home/">SoX</ulink>, and
      <ulink url="https://www.wavpack.com/">WavPack</ulink>
    </para>

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

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

    <sect3>
    <title>Installation of the Main Audacious Program</title>

      <para>
        Install <application>Audacious</application> by running the following
        commands (you may wish to change the buildstamp to another string):
      </para>

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

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dgtk3=true         \
            -Dbuildstamp=BLFS   \
            -Dlibarchive=true   \
            ..                  &amp;&amp;

ninja</userinput></screen>

      <para>
        This package does not come with a test suite.
      </para>

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

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

    </sect3>

    <sect3>
      <title>Installation of Audacious Plugins</title>

      <para>
        Install the required plugins package by issuing the following commands:
      </para>

<screen><userinput>tar -xf ../../audacious-plugins-&audacious-plugins-version;.tar.bz2 &amp;&amp;
cd audacious-plugins-&audacious-plugins-version;                    &amp;&amp;

sed -e '/libxml/a #include &lt;libxml/parser.h&gt;' \
    -i src/scrobbler2/scrobbler.h             &amp;&amp;

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

meson setup           \
  --prefix=/usr       \
  --buildtype=release \
  -Dgtk3=true         \
  ..                  &amp;&amp;

ninja</userinput></screen>

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

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

    </sect3>
  </sect2>

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

    <para>
      <parameter>-Dbuildstamp=BLFS</parameter>: This switch appends
      the given text to the version string.
    </para>

    <para>
      <parameter>-Dgtk3=true</parameter>: This option sets the default
      graphical user interface.
    </para>

    <para>
      <parameter>-Dlibarchive=true</parameter>: This adds libarchive support,
      for reading compressed module sets or skins.
    </para>

    <para>
      <command>sed -e '/libxml/a ...'</command>: This fixes building against
      libxml-2.12.x.
    </para>

    <para>
      <option>-Dvalgrind=true</option>: The option enables Valgrind analysis
      support.
    </para>

  </sect2>

<!-- None of this seems valid for audacios-4.3
  <sect2 role="configuration">
    <title>Configuring Audacious</title>

    <para>
      If you built with both Gtk and Qt user interfaces, the Qt version
      can be executed from a terminal, issuing <command>audacious
      - -qt</command>. If you wish a desktop menu entry to execute this Qt
      version, issue the following commands as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cp -v /usr/share/applications/audacious{,-qt}.desktop &amp;&amp;

sed -e '/^Name/ s/$/ Qt/' \
    -e '/Exec=/ s/audacious/&amp; - -qt/' \
    -i /usr/share/applications/audacious-qt.desktop</userinput></screen>

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

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

      <seglistitem>
        <seg>
          audacious and
          audtool
        </seg>
        <seg>
          libaudcore.so,
          libaudgui.so,
          libaudqt.so,
          libaudtag.so,
          and several plugin libraries under /usr/lib/audacious/ sub-directories
        </seg>
        <seg>
          /usr/include/{audacious,libaudcore,libaudgui,libaudqt},
          /usr/lib/audacious, and
          /usr/share/audacious
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="audacious-prog">
        <term><command>audacious</command></term>
        <listitem>
          <para>
            is an audio player and is a descendant of <application>XMMS</application>
          </para>
          <indexterm zone="audacious audacious-prog">
            <primary sortas="b-audacious">audacious</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="audtool">
        <term><command>audtool</command></term>
        <listitem>
          <para>
            is a small tool to modify the behavior of a running
            <command>audacious</command> instance
          </para>
          <indexterm zone="audacious audtool">
            <primary sortas="b-audtool">audtool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>