[xiph-cvs] cvs commit: speex/doc manual.lyx
Jean-Marc Valin
jm at xiph.org
Wed Nov 5 21:13:55 PST 2003
jm 03/11/06 00:13:55
Modified: doc manual.lyx
Log:
manual update
Revision Changes Path
1.68 +77 -14 speex/doc/manual.lyx
Index: manual.lyx
===================================================================
RCS file: /usr/local/cvsroot/speex/doc/manual.lyx,v
retrieving revision 1.67
retrieving revision 1.68
diff -u -r1.67 -r1.68
--- manual.lyx 1 May 2003 20:22:48 -0000 1.67
+++ manual.lyx 6 Nov 2003 05:13:55 -0000 1.68
@@ -28,7 +28,7 @@
The Speex Codec Manual
\newline
-(version 1.0)
+(version 1.0.2)
\layout Author
Jean-Marc Valin
@@ -1143,7 +1143,10 @@
\end_inset
.
-
+ Note that as of version 1.0.2, calling speex_bits_write automatically inserts
+ the terminator so as to fill the last byte.
+ This doesn't involves any overhead and makes sure Speex can always detect
+ when there is no more frame in a packet.
\layout Standard
It is also possible to send in-band
@@ -1745,7 +1748,7 @@
MIME Type
\layout Standard
-For now, you should use the MIME type audio/x-speex for Speex.
+For now, you should use the MIME type audio/x-speex for Speex-in-Ogg.
We will apply for type
\family typewriter
audio/speex
@@ -1786,10 +1789,10 @@
\SpecialChar ~
\SpecialChar ~
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
- (with 3 training spaces), which identifies the bit-stream.
+ (with 3 trailing spaces), which identifies the bit-stream.
The next field,
\family typewriter
speex_version
@@ -5460,10 +5463,31 @@
Under what license is Speex released?
\layout Standard
-As of version 1.0 beta 1, Speex is released under Xiph's BSD-like license.
+As of version 1.0 beta 1, Speex is released under Xiph's version of the (revised)
+ BSD license (see Appendix
+\begin_inset LatexCommand \ref{sec:Speex-License}
+
+\end_inset
+
+).
This license is the most permissive of the open-source licenses.
\layout Subsection*
+Am I allowed to use Speex in commercial software?
+\layout Standard
+
+Yes.
+ As long as you comply with the license.
+ This basically means you have to keep the copyright notice and you can't
+ use our name to promote your product without authorization.
+ For more details, see license in Appendix
+\begin_inset LatexCommand \ref{sec:Speex-License}
+
+\end_inset
+
+.
+\layout Subsection*
+
Ogg
\begin_inset LatexCommand \index{Ogg}
@@ -5491,7 +5515,7 @@
files (I prefer to call them just Speex files).
One difference with Vorbis however, is that Speex is less tied with Ogg.
- Actually, if what you do is Voice of IP (VoIP), you don't need Ogg at all.
+ Actually, if you just do Voice of IP (VoIP), you don't need Ogg at all.
\layout Subsection*
What's the extension for Speex?
@@ -5515,7 +5539,7 @@
In most cases, you'll be better of with Vorbis when it comes to music.
\layout Subsection*
-I converted some MP3's to Speex and the quality is bad.
+I converted some MP3s to Speex and the quality is bad.
What's wrong?
\layout Standard
@@ -5611,8 +5635,8 @@
as well as stereo support.
Of course, another area where Speex is really hard to beat is the quality/price
ratio.
- Unlike many very expensive codecs, Speex is free and anyone may distribute/modi
-fy it at will.
+ Unlike many very expensive codecs, Speex is free and anyone may distribute
+ or modify it at will.
\layout Subsection*
Can Speex pass DTMF
@@ -5624,9 +5648,8 @@
\layout Standard
I guess it all depends on the bit-rate used.
- Though no formal testing has yet been performed, I'd say don't go below
- the 15 kbps mode if you want DTMF to be transmitted correctly.
- DTMF at 8 kbps may work but your mileage may vary.
+ Though no formal testing has yet been performed, I'd say is correctly at
+ 8 kbps and above (15 kbps for version < 1.1.1).
Also, make sure you don't use the lowest complexity (see SPEEX_SET_COMPLEXITY
or --comp option), as it causes significant noise.
\layout Subsection*
@@ -5757,7 +5780,7 @@
\layout Standard
-\begin_inset Include \verbatiminput{draft-herlein-speex-rtp-profile-00.txt}
+\begin_inset Include \verbatiminput{draft-herlein-speex-rtp-profile-01.txt}
preview false
\end_inset
@@ -5765,6 +5788,46 @@
\layout Section
\pagebreak_top
+Speex License
+\begin_inset LatexCommand \label{sec:Speex-License}
+
+\end_inset
+
+
+\layout Standard
+
+Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+\layout Itemize
+
+Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+\layout Itemize
+
+Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+\layout Itemize
+
+Neither the name of the Xiph.org Foundation nor the names of its contributors
+ may be used to endorse or promote products derived from this software without
+ specific prior written permission.
+\layout Standard
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
+ IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED.
+ IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+\layout Section
+\pagebreak_top
GNU Free Documentation License
\layout Standard
<p><p>--- >8 ----
List archives: http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body. No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.
More information about the commits
mailing list