glfs/multimedia/libdriv/libtheora.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 libtheora-download-http "https://downloads.xiph.org/releases/theora/libtheora-&libtheora-version;.tar.xz">
  <!ENTITY libtheora-download-ftp  " ">
  <!ENTITY libtheora-md5sum        "9eeabf1ad65b7f41533854a59f7a716d">
  <!ENTITY libtheora-size          "1.4 MB">
  <!ENTITY libtheora-buildsize     "13.4 MB (without static libs or API docs and without installing the examples)">
  <!ENTITY libtheora-time          "0.2 SBU">
]>

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


  <title>libtheora-&libtheora-version;</title>

  <indexterm zone="libtheora">
    <primary sortas="a-Libtheora">Libtheora</primary>
  </indexterm>

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

    <para>
      <application>libtheora</application> is a reference implementation of the
      Theora video compression format being developed by the Xiph.Org
      Foundation.
    </para>

    &lfs120_checked;

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

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="sdl"/> and
      <xref linkend="libpng"/> (both to build the example players),
      <xref linkend="doxygen"/>,
      <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
      <ulink url="https://bibtexml.sourceforge.net">BibTex</ulink>, and
      <ulink url="https://mcj.sourceforge.net/">Transfig</ulink>
      (all four to build the API documentation), and
      <xref linkend="valgrind"/>
    </para>

  </sect2>

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

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

<screen><userinput>sed -i 's/png_\(sizeof\)/\1/g' examples/png2theora.c &amp;&amp;
./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      If you wish to run the tests, 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>

    <para>
      If you wish to install the examples (so that you can hack on
      <literal>theora</literal>), install them as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cd examples/.libs &amp;&amp;
for E in *; do
  install -v -m755 $E /usr/bin/theora_${E}
done</userinput></screen>

  </sect2>

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

    <para>
      <command>sed -i 's/png_\(sizeof\)/\1/g' examples/png2theora.c</command>:
      This <command>sed</command> fixes build with
      <application>libpng</application> 1.6.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>None, unless you installed the examples</seg>
        <seg>libtheora.so, libtheoraenc.so, and
        libtheoradec.so</seg>
        <seg>/usr/include/theora and /usr/share/doc/libtheora-&libtheora-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libtheora-lib">
        <term><filename class="libraryfile">libtheora*.so</filename></term>
        <listitem>
          <para>
            contains the functions to read and write video files
          </para>
          <indexterm zone="libtheora libtheora-lib">
            <primary sortas="c-libtheora">libtheora*.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>