/usr/share/doc/libtwolame-dev/html/twolame.1.html is in libtwolame-dev 0.3.13-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.3" />
<title>TWOLAME(1)</title>
<link rel="stylesheet" href="./twolame.css" type="text/css" />
<link rel="stylesheet" href="./twolame-manpage.css" type="text/css" />
<script type="text/javascript">
/*<![CDATA[*/
window.onload = function(){asciidoc.footnotes();}
/*]]>*/
</script>
<script type="text/javascript" src="./asciidoc-xhtml11.js"></script>
</head>
<body class="manpage">
<div id="header">
<h1>
TWOLAME(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>twolame -
an optimised MPEG Audio Layer 2 (MP2) encoder
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>twolame</em> [options] <infile> [outfile]</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>TwoLAME is an optimised MPEG Audio Layer 2 (MP2) encoder based on tooLAME by
Mike Cheng, which in turn is based upon the ISO dist10 code and portions of
LAME. Encoding is performed by the libtwolame library backend.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_input_file">Input File</h3>
<div class="paragraph"><p>twolame uses libsndfile for reading the input sound file, so
the input file can be in any format supported by libsndfile.
To read raw PCM audio from STDIN, then use - as the input filename.</p></div>
</div>
<div class="sect2">
<h3 id="_output_file">Output File</h3>
<div class="paragraph"><p>If no output filename is specified, then suffix of the input filename
is automatically changed to .mp2. To write the encoded audio to STDOUT
then use - as the output filename.</p></div>
</div>
<div class="sect2">
<h3 id="_input_options">Input Options</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
-r, --raw-input
</dt>
<dd>
<p>
Specifies that input is raw signed PCM audio.
If audio is stereo, than audio samples are interleaved
between the two channels.
</p>
</dd>
<dt class="hdlist1">
-x, --byte-swap
</dt>
<dd>
<p>
Force byte-swapping of the input. Endian detection is performed
automatically by libsndfile, so this option shouldn’t
normally be needed.
</p>
</dd>
<dt class="hdlist1">
-s, --samplerate <int>
</dt>
<dd>
<p>
If inputting raw PCM sound, you must specify the sample rate of
the audio in Hz.
Valid sample rates: 16000, 22050, 24000, 32000, 44100, 48000Hz.
Default sample rate is 44100Hz.
</p>
</dd>
<dt class="hdlist1">
--samplesize <int>
</dt>
<dd>
<p>
Specifies the sample size (in bits) of the raw PCM audio.
Valid sample sizes: 8, 16, 24, 32.
Default sample size is 16-bit.
</p>
</dd>
<dt class="hdlist1">
-N, --channels <int>
</dt>
<dd>
<p>
If inputting raw PCM sound, you must specify the number of channels
in the input audio. Default number of channels is 2.
</p>
</dd>
<dt class="hdlist1">
-g, --swap-channels
</dt>
<dd>
<p>
Swap the Left and Right channels of a stereo input file.
</p>
</dd>
<dt class="hdlist1">
--scale <float>
</dt>
<dd>
<p>
Scale the input audio prior to encoding.
All of the input audio is multiplied by specified value.
Value between 0 and 1 will reduce the audio gain, and a value
above 1 will increase the gain of the audio.
</p>
</dd>
<dt class="hdlist1">
--scale-l <float>
</dt>
<dd>
<p>
Same as --scale, but only affects the left channel.
</p>
</dd>
<dt class="hdlist1">
--scale-r <float>
</dt>
<dd>
<p>
Same as --scale, but only affects the right channel.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_output_options">Output Options</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
-m, --mode <char>
</dt>
<dd>
<p>
Choose the mode of the resulting audio. Default is auto.
</p>
<div class="ulist"><ul>
<li>
<p>
"a" auto - choose mode automatically based on the input
</p>
</li>
<li>
<p>
"s" stereo
</p>
</li>
<li>
<p>
"d" dual channel
</p>
</li>
<li>
<p>
"j" joint stereo
</p>
</li>
<li>
<p>
"m" mono
</p>
</li>
</ul></div>
</dd>
<dt class="hdlist1">
-a, --downmix
</dt>
<dd>
<p>
If the input file is stereo then, downmix the left and right
input channels into a single mono channel.
</p>
</dd>
<dt class="hdlist1">
-b, --bitrate <int>
</dt>
<dd>
<p>
Sets the total bitrate (in kbps) for the output file.
The default bitrate depends on the number of
input channels and samplerate.
</p>
<div class="literalblock">
<div class="content">
<pre><tt>------------------------------
Sample Rate Mono Stereo
------------------------------
48000 96 192
44100 96 192
32000 80 160
24000 48 96
22050 48 96
16000 32 64
------------------------------</tt></pre>
</div></div>
</dd>
<dt class="hdlist1">
-P, --psyc-mode <int>
</dt>
<dd>
<p>
Choose the psycho-acoustic model to use (-1 to 4).
Model number -1 is turns off psycho-acoustic modelling and
uses fixed default values instead.
Please see the file <em>psycho</em> for a full description of
each of the models available.
Default model is 3.
</p>
</dd>
<dt class="hdlist1">
-v, --vbr
</dt>
<dd>
<p>
Enable VBR mode. See <em>vbr</em> documentation file for details.
Default VBR level is 5.0.
</p>
</dd>
<dt class="hdlist1">
-V, --vbr-level <float>
</dt>
<dd>
<p>
Enable VBR mode and set quality level.
The higher the number the better the quality.
Maximum range is -50 to 50 but useful range is -10 to 10.
See <em>vbr</em> documentation file for details.
</p>
</dd>
<dt class="hdlist1">
-l, --ath <float>
</dt>
<dd>
<p>
Set the ATH level. Default level is 0.0.
</p>
</dd>
<dt class="hdlist1">
-q, --quick <int>
</dt>
<dd>
<p>
Enable quick mode. Only re-calculate psycho-acoustic
model every specified number of frames.
</p>
</dd>
<dt class="hdlist1">
-S, --single-frame
</dt>
<dd>
<p>
Enables single frame mode: only a single frame of MPEG audio
is output and then the program terminates.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_miscellaneous_options">Miscellaneous Options</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
-c, --copyright
</dt>
<dd>
<p>
Turn on Copyright flag in output bitstream.
</p>
</dd>
<dt class="hdlist1">
-o, --non-original
</dt>
<dd>
<p>
Turn off Original flag in output bitstream.
</p>
</dd>
<dt class="hdlist1">
--original
</dt>
<dd>
<p>
Turn on Original flag in output bitstream.
</p>
</dd>
<dt class="hdlist1">
-p, --protect
</dt>
<dd>
<p>
Enable CRC error protection in output bitstream.
An extra 16-bit checksum is added to frames.
</p>
</dd>
<dt class="hdlist1">
-d, --padding
</dt>
<dd>
<p>
Turn on padding in output bitstream.
</p>
</dd>
<dt class="hdlist1">
-R, --reserve <int>
</dt>
<dd>
<p>
Reserve specified number of bits in the each from of the
output bitstream.
</p>
</dd>
<dt class="hdlist1">
-e, --deemphasis <char>
</dt>
<dd>
<p>
Set the de-emphasis type (n/c/5). Default is none.
</p>
</dd>
<dt class="hdlist1">
-E, --energy
</dt>
<dd>
<p>
Turn on energy level extensions.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_verbosity_options">Verbosity Options</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
-t, --talkativity <int>
</dt>
<dd>
<p>
Set the amount of information to be displayed on stderr (0 to 10).
Default is 2.
</p>
</dd>
<dt class="hdlist1">
--quiet
</dt>
<dd>
<p>
Don’t send any messages to stderr, unless there is an error.
(Same as --talkativity=0)
</p>
</dd>
<dt class="hdlist1">
--brief
</dt>
<dd>
<p>
Only display a minimal number of messages while encoding.
This setting is quieter than the default talkativity setting.
(Same as --talkativity=1)
</p>
</dd>
<dt class="hdlist1">
--verbose
</dt>
<dd>
<p>
Display an increased number of messages on stderr.
This setting is useful to diagnose problems.
(Same as --talkativity=4)
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_codes">Return Codes</h2>
<div class="sectionbody">
<div class="paragraph"><p>If encoding completes successfully, then twolame will return 0.
However if encoding is not successful, then it will return one of the following codes.</p></div>
<div class="ulist"><ul>
<li>
<p>
1 (No encoding performed)
</p>
</li>
<li>
<p>
2 (Error opening input file)
</p>
</li>
<li>
<p>
4 (Error opening output file)
</p>
</li>
<li>
<p>
6 (Error allocating memory)
</p>
</li>
<li>
<p>
8 (Error in chosen encoding parameters)
</p>
</li>
<li>
<p>
10 (Error reading input audio)
</p>
</li>
<li>
<p>
12 (Error occured while encoding)
</p>
</li>
<li>
<p>
14 (Error writing output audio)
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="paragraph"><p>This will encode sound.wav to sound.mp2 using the default constant bitrate of 192 kbps
and using the default psycho-acoustic model (model 3):</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>twolame sound.wav</tt></pre>
</div></div>
<div class="paragraph"><p>Constant bitrate of 160kbps and joint stereo encoding, saved to file sound_160.mp2:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>twolame -b 160 -m j sound.aiff sound_160.mp2</tt></pre>
</div></div>
<div class="paragraph"><p>Encode sound.wav to newfile.mp2 using psycho-acoustic model 2 and encoding
with variable bitrate:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>twolame -P 2 -v sound.wav newfile.mp2</tt></pre>
</div></div>
<div class="paragraph"><p>Same as example above, except that the negative value of the "-V" argument
means that the lower bitrates will be favoured over the higher ones:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>twolame -P 2 -V -5 sound.wav newfile.mp2</tt></pre>
</div></div>
<div class="paragraph"><p>Resample audio file using sox and pipe straight through twolame:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>sox sound_11025.aiff -t raw -r 16000 | twolame -r -s 16000 - - > out.mp2</tt></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_authors">AUTHORS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The twolame frontend was (re)written by Nicholas J Humfrey.
The libtwolame library is based on toolame by Mike Cheng.
For a full list of authors, please see the AUTHORS file.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_resources">RESOURCES</h2>
<div class="sectionbody">
<div class="paragraph"><p>TwoLAME web site: <a href="http://www.twolame.org/">http://www.twolame.org/</a></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph"><p>lame(1), mpg123(1), madplay(1), sox(1)</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_copying">COPYING</h2>
<div class="sectionbody">
<div class="paragraph"><p>Copyright © 2004-2006 The TwoLAME Project. Free use of this software is
granted under the terms of the GNU Lesser General Public License (LGPL).</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 0.3.13<br />
Last updated 2011-01-02 12:18:34 GMT
</div>
</div>
</body>
</html>
|