source: multimedia/libdriv/libquicktime.xml@ dd3551e9

<?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 libquicktime-download-http "&sourceforge-repo;/libquicktime/libquicktime-&libquicktime-version;.tar.gz">
  <!ENTITY libquicktime-download-ftp  "&gentoo-ftp-repo;/libquicktime-&libquicktime-version;.tar.gz">
  <!ENTITY libquicktime-md5sum        "e4fcda219f1e0ca508d9baa3700e4a59">
  <!ENTITY libquicktime-size          "960 KB">
  <!ENTITY libquicktime-buildsize     "17 MB">
  <!ENTITY libquicktime-time          "0.7 SBU (includes building all codec modules)">
]>

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

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

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

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

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

    <para>The <application>libquicktime</application> package contains the
    <filename class='libraryfile'>libquicktime</filename> library, various
    plugins and codecs, along with graphical and command line utilities used
    for encoding and decoding Quicktime files. This is useful for reading and
    writing files in the Quicktime format. The goal of the project is to
    enhance, while providing compatibility with, the
    <application>Quicktime 4 Linux</application> library.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><!-- <xref linkend="pkgconfig"/>, -->
    <xref linkend="libpng"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="x-window-system"/>,
    <xref linkend="gtk2"/>,
    <xref linkend="alsa"/>,
    <xref linkend="libvorbis"/>,
    <xref linkend="lame"/>,
    <xref linkend="libdv"/>,
    <xref linkend="ffmpeg"/>,
    <ulink url="http://developers.videolan.org/x264.html">x264</ulink>,
    <xref linkend="faac"/>, 
    <xref linkend="faad2"/>, and
    <ulink url="http://www.diracvideo.org">Schroedinger</ulink></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --docdir=/usr/share/doc/libquicktime-&libquicktime-version; \
            --without-doxygen &amp;&amp;
make</userinput></screen>

    <!-- <para>If you have <xref linkend="doxygen"/> installed and wish to create
    the API documentation, issue: <command>doxygen</command>.</para> -->

    <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;
install -v -m755 -d /usr/share/doc/libquicktime-&libquicktime-version; &amp;&amp;
install -v -m644    README doc/{*.txt,*.html,mainpage.incl} \
                    /usr/share/doc/libquicktime-&libquicktime-version;</userinput></screen>

    <!-- This is now installed by default with make install.

    <para>If you created the API documentation, install it by issuing the
    following commands as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/libquicktime-&libquicktime-version;/api &amp;&amp;
install -v -m644    doc/apiref/* \
                    /usr/share/doc/libquicktime-&libquicktime-version;/api</userinput></screen>

    -->

  </sect2>

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

    <!--  <para><option>-with-avcodec=<replaceable>&lt;DIRECTORY
    NAME&gt;</replaceable></option>:
    This option can be used to force <application>libquicktime</application> to
    use a specified version of <application>FFmpeg</application> to build the
    <application>FFmpeg</application> plugin module.
    <emphasis role='strong'>Tip:</emphasis> build FFmpeg (don't use
    <option>-enable-shared</option>) and install it in a private directory.
    Then build <application>libquicktime</application>, substituting the
    private directory name for <replaceable>&lt;DIRECTORY
    NAME&gt;</replaceable>. You can now safely remove
    <replaceable>&lt;DIRECTORY_NAME&gt;</replaceable>, as the
    <application>FFmpeg</application>
    <filename class='libraryfile'>libavcodec</filename> library was statically
    linked into the <application>libquicktime</application>
    <application>FFmpeg</application> module.</para> -->

    <para><parameter>--without-doxygen</parameter>: This is necessary if you do
    not have Doxygen, omit this if installed.</para>

    <para><parameter>--enable-gpl</parameter>: Changes the licence to GPL. This
    enables some extra plugins, such as FAAC, FAAD2, and x264.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>libquicktime_config, lqt-config, lqt_transcode, lqtplay,
        qt2text, qtdechunk, qtdump, qtinfo, qtrechunk, qtstreamize and
        qtyuv4toyuv</seg>
        <seg>libquicktime.so and several plugin codec libraries</seg>
        <seg>/usr/include/lqt, /usr/lib/libquicktime and
        /usr/share/doc/libquicktime-&libquicktime-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libquicktime_config">
        <term><command>libquicktime_config</command></term>
        <listitem>
          <para>is a graphical front end to examine and configure the
          available <application>libquicktime</application> audio and
          video codecs.</para>
          <indexterm zone="libquicktime libquicktime_config">
            <primary sortas="b-libquicktime_config">libquicktime_config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lqt-config">
        <term><command>lqt-config</command></term>
        <listitem>
          <para>is a simple program used to query the
          <application>libquicktime</application> installation settings
          and plugin information.</para>
          <indexterm zone="libquicktime lqt-config">
            <primary sortas="b-lqt-config">lqt-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lqt_transcode">
        <term><command>lqt_transcode</command></term>
        <listitem>
          <para>is a command-line program used to encode video and/or audio
          files from one format to another.</para>
          <indexterm zone="libquicktime lqt_transcode">
            <primary sortas="b-lqt_transcode">lqt_transcode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lqtplay">
        <term><command>lqtplay</command></term>
        <listitem>
          <para>is a simple Quicktime movie player for X11.</para>
          <indexterm zone="libquicktime lqtplay">
            <primary sortas="b-lqtplay">lqtplay</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="qtdechunk">
        <term><command>qtdechunk</command></term>
        <listitem>
          <para>can take movies containing rgb frames and write them out as
          ppm images.</para>
          <indexterm zone="libquicktime qtdechunk">
            <primary sortas="b-qtdechunk">qtdechunk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="qtrechunk">
        <term><command>qtrechunk</command></term>
        <listitem>
          <para>concatenates input frames into a Quicktime movie.</para>
          <indexterm zone="libquicktime qtrechunk">
            <primary sortas="b-qtrechunk">qtrechunk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="qtyuv4toyuv">
        <term><command>qtyuv4toyuv</command></term>
        <listitem>
          <para>is used to write a YUV4 encoded movie as a planar YUV 4:2:0
          file.</para>
          <indexterm zone="libquicktime qtyuv4toyuv">
            <primary sortas="b-qtyuv4toyuv">qtyuv4toyuv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libquicktime-lib">
        <term><filename class='libraryfile'>libquicktime.so</filename></term>
        <listitem>
          <para>is a library for reading and writing Quicktime files. It
          provides convenient access to Quicktime files with a variety of
          supported codecs. The library contains new functions integrated with
          all the original Quicktime 4 Linux library functions used to encode
          and decode Quicktime files.</para>
          <indexterm zone="libquicktime libquicktime-lib">
            <primary sortas="c-libquicktime">libquicktime.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>