Add mp3 encoder plugin to manual.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28977 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Andree Buschmann 2011-01-06 19:29:47 +00:00
parent ef70c9f32c
commit 707c46b152
2 changed files with 34 additions and 0 deletions

View File

@ -146,6 +146,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
Midiplay & \fname{.mid, .midi} & \\
MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\
}}
\opt{swcodec}{
MP3 Encoder & \fname{.wav} & x \\
}
\opt{masf}{
\opt{lcd_bitmap}{
Movie Player & \fname{.rvf} & \\
@ -187,6 +190,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
\opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}}
\opt{swcodec}{\nopt{lowmem}{\input{plugins/mp3_encoder.tex}}}
\opt{lcd_color}{\input{plugins/ppmviewer.tex}}
\opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}}

28
manual/plugins/mp3_encoder.tex Executable file
View File

@ -0,0 +1,28 @@
\subsection{MP3 Encoder}
This plugin allows to encode a \fname{.wav} file to MP3 format. Supported input
format is uncompressed, linear PCM with 16 bit per sample and maximum 2 channels.
Allowed sample rates are 16, 22.05, 24, 32, 44.1 and 48~kHz.
The user will be asked to select the desired output bitrate of the compressed
MP3 file.
\begin{description}
\item[Select Bitrate] The following bitrates can be selected: 64, 80, 96, 112,
128, 160, 192, 224, 256, 320~kbps.
Remark: Bitrates above 160~kbps cannot be used in MPEG~2 Layer~3 bitstreams.
The encoder plugin automatically limits the output bitrate to 160~kbps for
input files with a sample rate of 16, 22.05 or 24~kHz. The same limitation is
valid for mono files.
\end{description}
The output \fname{.mp3} file is written to the same path as the \fname{.wav}
file using the same filename. To use this plugin, open the \setting{Context Menu}
(see \reference{ref:Contextmenu}) upon a \fname{.wav} file and select
\setting{Open With\dots $\rightarrow$ mp3\_encoder}.
\note{
The encoder will choose the appropriate bitstream format from the sample rate
of the input file. Output bitstream format is MPEG~1 Layer~3 for 32, 44.1 and
48~kHz, and MPEG~2 Layer~3 for 16, 22.05 and 24~kHz. MPEG~2.5 Layer~3 is not
supported.
}