glfs/multimedia/libdriv/libmpeg2.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libmpeg2-download-http "http://libmpeg2.sourceforge.net/files/mpeg2dec-&libmpeg2-version;.tar.gz">
  <!ENTITY libmpeg2-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles//mpeg2dec-&libmpeg2-version;.tar.gz">
  <!ENTITY libmpeg2-md5sum        "52d10ea80595ec83d8557ba7ac6dc8e6">
  <!ENTITY libmpeg2-size          "473 KB">
  <!ENTITY libmpeg2-buildsize     "7.1 MB">
  <!ENTITY libmpeg2-time          "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">mpeg2dec-&libmpeg2-version;.tar</keyword>
      <keyword role="ftpdir">mpeg2dec</keyword>
    </keywordset>
  </sect1info>

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

  <indexterm zone="libmpeg2">
    <primary sortas="a-libmpeg2">libmpeg2</primary>
  </indexterm>

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

    <para>The <application>libmpeg2</application> package contains a library
    for decoding MPEG-2 and MPEG-1 video streams. The library is able to decode
    all MPEG streams that conform to certain restrictions: <quote>constrained
    parameters</quote> for MPEG-1, and <quote>main profile</quote> for MPEG-2.
    This is useful for programs and applications needing to decode MPEG-2 and
    MPEG-1 video streams.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">X (<xref linkend="xorg"/> or <xref linkend="xfree86"/>)
    and <xref linkend="sdl"/></para>

  </sect2>

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

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

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

    <para>To test the results, issue: <command>make check</command>. To
    perform a more comprehensive regression test, see the file
    <filename>test/README</filename> in the source tree.</para>

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

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/mpeg2dec-0.4.0b &amp;&amp;
install -v -m644 README doc/libmpeg2.txt \
    /usr/share/doc/mpeg2dec-0.4.0b &amp;&amp;
install -v -m755 doc/sample? /usr/share/doc/mpeg2dec-0.4.0b</userinput></screen>

  </sect2>

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

    <para><parameter>--enable-shared</parameter>: This parameter forces
    building shared versions of the libraries as well as the static
    versions.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>corrupt_mpeg2, extract_mpeg2 and mpeg2dec</seg>
        <seg>libmpeg2.[so,a] and libmpeg2convert.[so,a]</seg>
        <seg>/usr/include/mpeg2dec and
        /usr/share/doc/mpeg2dec-&libmpeg2-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="extract_mpeg2">
        <term><command>extract_mpeg2</command></term>
        <listitem>
          <para>extracts MPEG video streams from a multiplexed stream.</para>
          <indexterm zone="libmpeg2 extract_mpeg2">
            <primary sortas="b-extract_mpeg2">extract_mpeg2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mpeg2dec">
        <term><command>mpeg2dec</command></term>
        <listitem>
          <para>decodes MPEG1 and MPEG2 video streams.</para>
          <indexterm zone="libmpeg2 mpeg2dec">
            <primary sortas="b-mpeg2dec">mpeg2dec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmpeg2-lib">
        <term><filename class='libraryfile'>libmpeg2.[so,a]</filename></term>
        <listitem>
          <para>contains API functions used to decode MPEG video streams.</para>
          <indexterm zone="libmpeg2 libmpeg2-lib">
            <primary sortas="c-libmpeg2">libmpeg2.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmpeg2convert">
        <term><filename class='libraryfile'>libmpeg2convert.[so,a]</filename></term>
        <listitem>
          <para>contains API functions used for color conversions of MPEG
          video streams.</para>
          <indexterm zone="libmpeg2 libmpeg2convert">
            <primary sortas="c-libmpeg2convert">libmpeg2convert.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>