<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Szabolcs</firstname>">
  <!ENTITY dhsurname   "<surname>Székelyi</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>May 5, 2008</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>cc@mail.3d.hu</email>">
  <!ENTITY dhusername  "Székelyi Szabolcs">
  <!ENTITY dhucpackage "<refentrytitle>RUBBERBAND</refentrytitle>">
  <!ENTITY dhpackage   "rubberband">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2008</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>rubberband</refname>

    <refpurpose>an audio time-stretching and pitch-shifting utility program</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option><replaceable>options</replaceable></option></arg>
      <arg><option><replaceable>input file</replaceable></option></arg>
      <arg><option><replaceable>output file</replaceable></option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para>Rubber Band is a program that permits you to change the
          tempo and pitch of an audio recording independently of one
          another.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <para>You must specify at least one of the following time and
      pitch ratio options.</para>

    <variablelist>
      <varlistentry>
        <term><option>-t</option>, <option>--time</option> <replaceable>X</replaceable></term>
        <listitem>
          <para>Stretch to <replaceable>X</replaceable> times original
            duration, or</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-T</option>, <option>--tempo</option> <replaceable>X</replaceable></term>
        <listitem>
          <para>Change tempo by multiple <replaceable>X</replaceable> (equivalent to --time 1/X)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p</option>, <option>--pitch</option> <replaceable>X</replaceable></term>
        <listitem>
          <para>Raise pitch by <replaceable>X</replaceable> semitones, or</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f</option>, <option>--frequency</option> <replaceable>X</replaceable></term>
        <listitem>
          <para>Change frequency by multiple <replaceable>X</replaceable></para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para>The following option provides a simple way to adjust the
      sound.  See below for more details.</para>

    <variablelist>
      <varlistentry>
	<term><option>-n</option>, <option>--crisp</option> <replaceable>N</replaceable></term>
	<listitem>
	  <para>Crispness (N = 0,1,2,3,4,5); default 4 (see below)</para>
	</listitem>
      </varlistentry>
    </variablelist>

    <para>The remaining options fine-tune the processing mode and
      stretch algorithm.  These are mostly included for test purposes;
      the default settings and standard crispness parameter are
      intended to provide the best sounding set of options for most
      situations.</para>

    <variablelist>
      <varlistentry>
	<term><option>-P</option>, <option>--precise</option></term>
	<listitem>
	  <para>Aim for minimal time distortion (implied by -R)</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-R</option>, <option>--realtime</option></term>
	<listitem>
	  <para>Select realtime mode (implies -P --no-threads)</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--no-threads</option></term>
	<listitem>
	  <para>No extra threads regardless of CPU and channel count</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--threads</option></term>
	<listitem>
	  <para>Assume multi-CPU even if only one CPU is identified</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--no-transients</option></term>
	<listitem>
	  <para>Disable phase resynchronisation at transients</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--bl-transients</option></term>
	<listitem>
	  <para>Band-limit phase resync to extreme frequencies</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--no-peaklock</option></term>
	<listitem>
	  <para>Disable phase locking to peak frequencies</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--no-softening</option></term>
	<listitem>
	  <para>Disable large-ratio softening of phase locking</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--window-long</option></term>
	<listitem>
	  <para>Use longer processing window (actual size may vary)</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--window-short</option></term>
	<listitem>
	  <para>Use shorter processing window</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--thresh</option> <replaceable>N</replaceable> <replaceable>F</replaceable></term>
	<listitem>
	  <para>Set internal freq threshold <replaceable>N</replaceable> (N = 0,1,2) to <replaceable>F</replaceable> Hz</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-d</option>, <option>--debug</option> <replaceable>N</replaceable></term>
	<listitem>
	  <para>Select debug level (N = 0,1,2,3); default 0, full 3
            (N.B. debug level 3 includes audible ticks in output)</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-q</option>, <option>--quiet</option></term>
	<listitem>
	  <para>Suppress progress output</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-h</option>, <option>--help</option></term>
	<listitem>
	  <para>Show a list of available options</para>
	</listitem>
      </varlistentry>
    </variablelist>

    <para>&quot;Crispness&quot; levels:</para>

    <variablelist>
      <varlistentry>
	<term>0</term>
	<listitem>
	  <para>equivalent to --no-transients --no-peaklock --window-long</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>1</term>
	<listitem>
	  <para>equivalent to --no-transients --no-peaklock</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>2</term>
	<listitem>
	  <para>equivalent to --no-transients</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>3</term>
	<listitem>
	  <para>equivalent to --bl-transients</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>4</term>
	<listitem>
	  <para>default processing options</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>5</term>
	<listitem>
	  <para>equivalent to --no-peaklock --window-short (may be suitable for drums)</para>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>Rubber Band was written by Chris Cannam &lt;cannam@all-day-breakfast.com&gt;.</para>

    <para>This manual page was written by &dhusername; &lt;&dhemail;&gt; for
      the &debian; system (but may be used by others), because the
      original program does not have a manual page.  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any
      later version published by the Free Software Foundation.</para>

    <para>On Debian systems, the complete text of the GNU General
      Public License can be found in
      /usr/share/common-licenses/GPL.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


