source: multimedia/libdriv/opal.xml@ 40cf782

<?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 opal-download-http "&gnome-download-http;/opal/3.10/opal-&opal-version;.tar.xz">
  <!ENTITY opal-download-ftp  "&gnome-download-ftp;/opal/3.10/opal-&opal-version;.tar.xz">
  <!ENTITY opal-md5sum        "6efa1b4c5e0ad6460019b4c6df0898d7">
  <!ENTITY opal-size          "5.7 MB">
  <!ENTITY opal-buildsize     "305 MB">
  <!ENTITY opal-time          "2.0 SBU">
]>

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

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

  <title>Opal-&opal-version;</title>

  <indexterm zone="opal">
    <primary sortas="a-Opal">Opal</primary>
  </indexterm>

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

    <para>
      The <application>Opal</application> package contains a C++ class library for
      normalising the numerous telephony protocols into a single integrated call
      model.
    </para>

    &lfs78_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/opal-&opal-version;-ffmpeg2-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://www.celt-codec.org/">Celt</ulink>,
      <xref linkend="ffmpeg"/>,
      <ulink url="http://www.quut.com/gsm/">GSM</ulink>,
      <ulink url="http://www.isdn4linux.de/">ISDN4Linux</ulink>,
      <xref linkend="libtheora"/>,
      <xref linkend="openjdk"/>,
      <xref linkend="ruby"/>,
      <ulink url="www.soft-switch.org/">Spandsp</ulink>,
      <xref linkend="speex"/>, and
      <xref linkend="x264"/>
    </para>

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

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

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

<screen><userinput>patch -Np1 -i ../opal-&opal-version;-ffmpeg2-1.patch &amp;&amp;

./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

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

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

<screen role="root"><userinput>make install &amp;&amp;
chmod -v 644 /usr/lib/libopal_s.a</userinput></screen>

  </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>
          libopal.so and libopal_s.a
        </seg>
        <seg>
          /usr/include/opal and
          /usr/lib/opal-&opal-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libopal">
        <term><filename class="libraryfile">libopal.so</filename></term>
        <listitem>
          <para>
            contains the <application>Opal</application> API functions.
          </para>
          <indexterm zone="opal libopal">
            <primary sortas="c-libopal">libopal.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>