source: multimedia/libdriv/opal.xml@ b00021d

<?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        "6bf7156ff212fcd5835416f297bd4a4f">
  <!ENTITY opal-size          "5.5 MB">
  <!ENTITY opal-buildsize     "227 MB">
  <!ENTITY opal-time          "2.1 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 is a C++ class library for
    normalising the numerous telephony protocols into a single integrated call
    model.</para>

    &lfs72_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 Download</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required Patch: <ulink
        url="&patch-root;/opal-&opal-version;-ffmpeg-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"/>,
    <xref linkend="libtheora"/>,
    <xref linkend="speex"/>, and
    <ulink url="http://www.videolan.org/developers/x264.html">x264</ulink></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;-ffmpeg-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</userinput></screen>

  </sect2>

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

    <para><command>patch -Np1 -i ...</command>: The patch allows opal to build
    with recent releases of <application>ffmpeg</application>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>libopal.so, libopal_s.a, g722_audio_pwplugin.so,
        g726_audio_pwplugin.so, gsm0610_audio_pwplugin.so,
        gsmamrcodec_pwplugin.so, ilbc_audio_pwplugin.so,
        ima_adpcm_audio_pwplugin.so, lpc10_audio_pwplugin.so,
        speex_audio_pwplugin.so, h261-vic_video_pwplugin.so, and
        vpb_lid_pwplugin.so</seg>
        <seg>/usr/{include/opal/{asn,codec,h323,h460,iax2,im,lids,opal,rtp,sip,
        t120,t38,zrtp},lib/opal-3.6.8/{codecs/{audio,video},lid}}</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>