diff options
author | Timothy Gu <timothygu99@gmail.com> | 2013-10-27 07:26:34 +0400 |
---|---|---|
committer | Stefano Sabatini <stefasab@gmail.com> | 2013-10-27 16:02:32 +0400 |
commit | 43041a7b4aa26271721b6f483632090c5ee3ce40 (patch) | |
tree | 081d035b7108ae2e3e7cf8e75951e405532e4471 /doc/encoders.texi | |
parent | d3aa04b1500f61c07cb0812c98f85ef909f414df (diff) |
doc/encoders: add libshine doc
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
Diffstat (limited to 'doc/encoders.texi')
-rw-r--r-- | doc/encoders.texi | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/encoders.texi b/doc/encoders.texi index 0c01364a76..db48998a55 100644 --- a/doc/encoders.texi +++ b/doc/encoders.texi @@ -494,6 +494,7 @@ Selected by Encoder (default) @end table +@anchor{libmp3lame} @section libmp3lame LAME (Lame Ain't an MP3 Encoder) MP3 encoder wrapper. @@ -502,6 +503,8 @@ Requires the presence of the libmp3lame headers and library during configuration. You need to explicitly configure the build with @code{--enable-libmp3lame}. +@xref{libshine} for a fixed-point MP3 encoder, although with a lower quality. + @subsection Options The following options are supported by the libmp3lame wrapper. The @@ -570,6 +573,42 @@ default value is 0 (disabled). @end table +@anchor{libshine} +@section libshine + +Shine Fixed-Point MP3 encoder wrapper. + +Shine is a fixed-point MP3 encoder. It has a far better performance on +platforms without an FPU, e.g. armel CPUs, and some phones and tablets. +However, as it is more targeted on performance than quality, it is not on par +with LAME and other production-grade encoders quality-wise. Also, according to +the project's homepage, this encoder may not be free of bugs as the code was +written a long time ago and the project was dead for at least 5 years. + +This encoder only supports stereo and mono input. This is also CBR-only. + +The original project (last updated in early 2007) is at +@url{http://sourceforge.net/projects/libshine-fxp/}. We only support the +updated fork by the Savonet/Liquidsoap project at @url{https://github.com/savonet/shine}. + +Requires the presence of the libshine headers and library during +configuration. You need to explicitly configure the build with +@code{--enable-libshine}. + +See also @ref{libmp3lame}. + +@subsection Options + +The following options are supported by the libshine wrapper. The +@command{shineenc}-equivalent of the options are listed in parentheses. + +@table @option +@item b (@emph{-b}) +Set bitrate expressed in bits/s for CBR. @command{shineenc} @option{-b} option +is expressed in kilobits/s. + +@end table + @section libtwolame TwoLAME MP2 encoder wrapper. |