source: multimedia/videoutils/transcode.xml@ 5db3785e

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY transcode-download-http "http://www.ligo.caltech.edu/~pehrens/transcode-&transcode-version;.tar.gz">
  <!ENTITY transcode-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/transcode-&transcode-version;.tar.gz">
  <!ENTITY transcode-md5sum        "9bfef83b7e0fe2c27d25d871fef75a92">
  <!ENTITY transcode-size          "2.6 MB">
  <!ENTITY transcode-buildsize     "60 MB">
  <!ENTITY transcode-time          "1.69 SBU">
]>

<sect1 id="transcode-package" xreflabel="Transcode-&transcode-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="transcode.html"?>
<title><application>Transcode</application>-&transcode-version;</title>
<indexterm zone="transcode-package">
<primary sortas="a-Transcode">Transcode</primary></indexterm>

<sect2>
<title>Introduction to <application>Transcode</application></title>

<para><application>Transcode</application> is a fast, versatile and 
command-line based audio/video everything to everything converter. For a 
rundown of the features and capabilities, along with usage examples, visit 
the Transcode Wiki at <ulink url="http://www.transcoding.org/"/>.</para>

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

<!-- 
<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Required Patch: <ulink 
url="&patch-root;/transcode-&transcode-version;-fix_largefile_split-1.patch"/></para>
</listitem>
<listitem><para>Required Patch (if 
<application>libdv</application> is installed): <ulink 
url="&patch-root;/transcode-&transcode-version;-fix_dv-1.patch"/></para>
</listitem>
<listitem><para>Required Patch (if compiled with
<application><acronym>GCC</acronym></application>-3.4.x): <ulink 
url="&patch-root;/transcode-&transcode-version;-gcc34-1.patch"/></para>
</listitem>
</itemizedlist>
</sect3>
 -->

<sect3><title><application>Transcode</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="ffmpeg-package"/></para>
</sect4>

<sect4><title>Recommended</title>
<para><xref linkend="NASM"/> and <xref linkend="lame"/></para>
</sect4>

<sect4><title>Optional</title>
<para>X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>), 
<xref linkend="freetype2"/>, 
<xref linkend="GTK"/>, 
<xref linkend="sdl"/>, 
<xref linkend="libxml2"/>, 
<xref linkend="imagemagick"/>, 
<xref linkend="libjpeg"/> or 
<ulink url="http://sourceforge.net/projects/mjpeg">MMX Jpeg</ulink>, 
<xref linkend="libdv"/>, 
<xref linkend="libdvdread"/>, 
<xref linkend="avifile"/>, 
<xref linkend="libfame"/>, 
<xref linkend="libmpeg3"/>, 
<xref linkend="xvid"/>, 
<xref linkend="LZO"/>, 
<xref linkend="liba52"/>, 
<xref linkend="libogg"/>, 
<xref linkend="libvorbis"/>, 
<ulink url="http://mjpeg.sourceforge.net/">MJPEG Tools</ulink>, 
<ulink url="http://libquicktime.sourceforge.net/">libquicktime</ulink>, 
<ulink url="http://www.theora.org/">Theora</ulink>, 
<ulink url="http://lvempeg.sourceforge.net/">LVE</ulink>, 
<ulink url="http://www.netlib.org/pvm3/">PVM3</ulink> and 
<ulink url="http://loci.cs.utk.edu/">LoRS/IBP</ulink></para>

<para>Though <application>Transcode</application> has no compile-time 
requirement for <xref linkend="mplayer-package"/>'s shared post-processing 
library, <application>Transcode</application> can use it at run-time.</para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Transcode</application></title>

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

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

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><option>--without-x</option>: Omit this parameter if you have an 
<application>X</application> Window System installed and you want to compile 
X11 dependent filter plugins.</para>

<para><option>--enable-netstream</option>: This parameter enables network 
streaming support.</para>

<para>Building support for most of the dependency packages requires using 
options passed to the <command>configure</command> script. View the 
<filename>INSTALL</filename> file and the output from 
<command>./configure --help</command> for complete information about 
enabling dependency packages.</para>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>avicodec, avidump, avifix, aviindex, avimerge, avisplit, avisync, tccat, 
tcdecode, tcdemux, tcextract, tcframe, tcmodinfo, tcmp3cut, tcmplex, tcprobe, 
tcrequant, tcscan, tcxmlcheck, tcxpm2rgb and transcode</seg>
<seg>a52_decore.so, af6_decore.so, export*.so, filter*.so and import*.so 
output/filter/input modules</seg>
<seg>/usr/lib/transcode and /usr/share/doc/transcode</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="avicodec">
<term><command>avicodec</command></term>
<listitem><para>indicates or changes the <acronym>FOURCC</acronym> 
<acronym>CODEC</acronym> flag in an <acronym>AVI</acronym> file.</para>
<indexterm zone="transcode-package avicodec">
<primary sortas="b-avicodec">avicodec</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avidump">
<term><command>avidump</command></term>
<listitem><para>dumps audio or video stream of a given <acronym>AVI</acronym> 
file to stdout (for <acronym>AVI</acronym> conversion or extraction of audio 
streams).</para>
<indexterm zone="transcode-package avidump">
<primary sortas="b-avidump">avidump</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avifix">
<term><command>avifix</command></term>
<listitem><para>fixes the header of an <acronym>AVI</acronym> file.</para>
<indexterm zone="transcode-package avifix">
<primary sortas="b-avifix">avifix</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="aviindex">
<term><command>aviindex</command></term>
<listitem><para>writes a text file describing the index of an 
<acronym>AVI</acronym> file.</para>
<indexterm zone="transcode-package aviindex">
<primary sortas="b-aviindex">aviindex</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avimerge">
<term><command>avimerge</command></term>
<listitem><para> merges <acronym>AVI</acronym> files of the same format. Do 
not try to merge <acronym>AVI</acronym> files of different formats, it will 
most likely result in errors (and format means same bitrates, too!).</para>
<indexterm zone="transcode-package avimerge">
<primary sortas="b-avimerge">avimerge</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avisplit">
<term><command>avisplit</command></term>
<listitem><para>splits <acronym>AVI</acronym> files into multiple files.</para>
<indexterm zone="transcode-package avisplit">
<primary sortas="b-avisplit">avisplit</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avisync">
<term><command>avisync</command></term>
<listitem><para>can shift audio in <acronym>AVI</acronym> files for better 
synchronizing of the audio and video data signal.</para>
<indexterm zone="transcode-package avisync">
<primary sortas="b-avisync">avisync</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tccat">
<term><command>tccat</command></term>
<listitem><para>concatenates input files using the input plugins of 
<application>Transcode</application>.</para>
<indexterm zone="transcode-package tccat">
<primary sortas="b-tccat">tccat</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcdecode">
<term><command>tcdecode</command></term>
<listitem><para>is used to decode input files to raw video and 
<acronym>PCM</acronym> audio streams.</para>
<indexterm zone="transcode-package tcdecode">
<primary sortas="b-tcdecode">tcdecode</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcdemux">
<term><command>tcdemux</command></term>
<listitem><para>demultiplexes (separates) audio/video input that contains 
multiple streams, e.g., <acronym>VOB</acronym> files.</para>
<indexterm zone="transcode-package tcdemux">
<primary sortas="b-tcdemux">tcdemux</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcextract">
<term><command>tcextract</command></term>
<listitem><para>grabs single streams from a file containing multiple 
streams.</para>
<indexterm zone="transcode-package tcextract">
<primary sortas="b-tcextract">tcextract</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcframe">
<term><command>tcframe</command></term>
<listitem><para>processes single video frames for different color encodings 
(<acronym>RGB</acronym> &gt;-&lt; <acronym>YUV</acronym> or similar).</para>
<indexterm zone="transcode-package tcframe">
<primary sortas="b-tcframe">tcframe</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcmodinfo">
<term><command>tcmodinfo</command></term>
<listitem><para>loads a supplied <application>Transcode</application> filter 
module and prints its parameters.</para>
<indexterm zone="transcode-package tcmodinfo">
<primary sortas="b-tcmodinfo">tcmodinfo</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcmp3cut">
<term><command>tcmp3cut</command></term>
<listitem><para>is a tool which can cut <acronym>MP3</acronym> streams at 
milliseconds positions.</para>
<indexterm zone="transcode-package tcmp3cut">
<primary sortas="b-tcmp3cut">tcmp3cut</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcprobe">
<term><command>tcprobe</command></term>
<listitem><para>prints information about the input file format.</para>
<indexterm zone="transcode-package tcprobe">
<primary sortas="b-tcprobe">tcprobe</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcrequant">
<term><command>tcrequant</command></term>
<listitem><para>is a tool which can requantize an <acronym>MPEG</acronym>-2 
elementary stream.</para>
<indexterm zone="transcode-package tcrequant">
<primary sortas="b-tcrequant">tcrequant</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcscan">
<term><command>tcscan</command></term>
<listitem><para> performs several measurements on the given input data.</para>
<indexterm zone="transcode-package tcscan">
<primary sortas="b-tcscan">tcscan</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="tcxmlcheck">
<term><command>tcxmlcheck</command></term>
<listitem><para> checks information in a <acronym>SMIL</acronym> input 
file.</para>
<indexterm zone="transcode-package tcxmlcheck">
<primary sortas="b-tcxmlcheck">tcxmlcheck</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="transcode">
<term><command>transcode</command></term>
<listitem><para>is the encoder's user interface that handles the plugins and 
other programs, being the glue between the modules. There are several well 
documented usage examples on both the homepage and the documentation included 
in the package.</para>
<indexterm zone="transcode-package transcode">
<primary sortas="b-transcode">transcode</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry>
<term><filename class='libraryfile'>a52_decore.so</filename></term>
<listitem><para>is used to interface with the 
<filename class='libraryfile'>liba52</filename> library for decoding 
<acronym>AC</acronym>-3 streams.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><filename class='libraryfile'>af6_decore.so</filename></term>
<listitem><para>is a support module used to decode 
<filename class='libraryfile'>libaviplay</filename> library supported codecs 
and file formats</para></listitem>
</varlistentry>

<varlistentry>
<term><filename class='libraryfile'>export/filter/import_*.so</filename></term>
<listitem><para>&mdash; depending on the external libraries that are used, 
there are a great number of plugins to convert audio and video input to raw 
format, process raw video and audio and convert raw audio and video to other
formats to be written into a file type of choice. Read the documentation for 
complete information.</para></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>