File: rubberband.sgml

package info (click to toggle)
rubberband 1.8.1-7
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 1,376 kB
  • ctags: 1,909
  • sloc: cpp: 13,156; ansic: 2,777; makefile: 244; java: 77
file content (305 lines) | stat: -rw-r--r-- 9,507 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
<!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:
-->