diff options
author | Andree Buschmann <AndreeBuschmann@t-online.de> | 2011-01-06 19:29:47 +0000 |
---|---|---|
committer | Andree Buschmann <AndreeBuschmann@t-online.de> | 2011-01-06 19:29:47 +0000 |
commit | 707c46b15296d3f64310f6165a7fa6665b2c46d3 (patch) | |
tree | eddb04a65cb6498b6378cc51442b2c5b705d9272 | |
parent | ef70c9f32c4d38a77b830d0a9f72e1188e97cc16 (diff) | |
download | rockbox-707c46b15296d3f64310f6165a7fa6665b2c46d3.tar.gz rockbox-707c46b15296d3f64310f6165a7fa6665b2c46d3.zip |
Add mp3 encoder plugin to manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28977 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/plugins/main.tex | 6 | ||||
-rwxr-xr-x | manual/plugins/mp3_encoder.tex | 28 |
2 files changed, 34 insertions, 0 deletions
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index b847c15b51..bc48bd229f 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex | |||
@@ -146,6 +146,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).} | |||
146 | Midiplay & \fname{.mid, .midi} & \\ | 146 | Midiplay & \fname{.mid, .midi} & \\ |
147 | MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\ | 147 | MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\ |
148 | }} | 148 | }} |
149 | \opt{swcodec}{ | ||
150 | MP3 Encoder & \fname{.wav} & x \\ | ||
151 | } | ||
149 | \opt{masf}{ | 152 | \opt{masf}{ |
150 | \opt{lcd_bitmap}{ | 153 | \opt{lcd_bitmap}{ |
151 | Movie Player & \fname{.rvf} & \\ | 154 | Movie Player & \fname{.rvf} & \\ |
@@ -187,6 +190,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).} | |||
187 | 190 | ||
188 | \opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}} | 191 | \opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}} |
189 | 192 | ||
193 | \opt{swcodec}{\nopt{lowmem}{\input{plugins/mp3_encoder.tex}}} | ||
194 | |||
195 | |||
190 | \opt{lcd_color}{\input{plugins/ppmviewer.tex}} | 196 | \opt{lcd_color}{\input{plugins/ppmviewer.tex}} |
191 | 197 | ||
192 | \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}} | 198 | \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}} |
diff --git a/manual/plugins/mp3_encoder.tex b/manual/plugins/mp3_encoder.tex new file mode 100755 index 0000000000..c83deb4fb3 --- /dev/null +++ b/manual/plugins/mp3_encoder.tex | |||
@@ -0,0 +1,28 @@ | |||
1 | \subsection{MP3 Encoder} | ||
2 | This plugin allows to encode a \fname{.wav} file to MP3 format. Supported input | ||
3 | format is uncompressed, linear PCM with 16 bit per sample and maximum 2 channels. | ||
4 | Allowed sample rates are 16, 22.05, 24, 32, 44.1 and 48~kHz. | ||
5 | The user will be asked to select the desired output bitrate of the compressed | ||
6 | MP3 file. | ||
7 | |||
8 | \begin{description} | ||
9 | \item[Select Bitrate] The following bitrates can be selected: 64, 80, 96, 112, | ||
10 | 128, 160, 192, 224, 256, 320~kbps. | ||
11 | |||
12 | Remark: Bitrates above 160~kbps cannot be used in MPEG~2 Layer~3 bitstreams. | ||
13 | The encoder plugin automatically limits the output bitrate to 160~kbps for | ||
14 | input files with a sample rate of 16, 22.05 or 24~kHz. The same limitation is | ||
15 | valid for mono files. | ||
16 | \end{description} | ||
17 | |||
18 | The output \fname{.mp3} file is written to the same path as the \fname{.wav} | ||
19 | file using the same filename. To use this plugin, open the \setting{Context Menu} | ||
20 | (see \reference{ref:Contextmenu}) upon a \fname{.wav} file and select | ||
21 | \setting{Open With\dots $\rightarrow$ mp3\_encoder}. | ||
22 | |||
23 | \note{ | ||
24 | The encoder will choose the appropriate bitstream format from the sample rate | ||
25 | of the input file. Output bitstream format is MPEG~1 Layer~3 for 32, 44.1 and | ||
26 | 48~kHz, and MPEG~2 Layer~3 for 16, 22.05 and 24~kHz. MPEG~2.5 Layer~3 is not | ||
27 | supported. | ||
28 | } | ||