Content complete, some external links missing.
authorAndre Noll <maan@systemlinux.org>
Mon, 3 May 2010 06:57:10 +0000 (08:57 +0200)
committerAndre Noll <maan@systemlinux.org>
Tue, 13 Jul 2010 12:40:41 +0000 (14:40 +0200)
web/manual.m4

index 0ff7e9b..f9b5344 100644 (file)
@@ -77,11 +77,11 @@ The paraslash executables
 
 *para_server*
 
-para_server streams binary audio data (MP3, OGG/Vorbis, M4A, WMA
-files) over local and/or remote networks. It listens on a TCP port and
-accepts commands such as play, stop, pause, next from authenticated
-clients. There are many more commands though, see the man page of
-para_server for a description of all commands.
+para_server streams binary audio data (MP3, OGG/Vorbis, OGG/Speex,
+M4A, WMA files) over local and/or remote networks. It listens on a
+TCP port and accepts commands such as play, stop, pause, next from
+authenticated clients. There are many more commands though, see the
+man page of para_server for a description of all commands.
 
 It supports three built-in network streaming protocols
 (senders/receivers): HTTP, DCCP, or UDP. This is explained in more
@@ -145,11 +145,11 @@ compatible with arbitrary HTTP streaming sources (e.g. icecast).
 *para_filter*
 
 A filter program that reads from STDIN and writes to STDOUT.
-Like para_recv, this is an atomic building block which can be used
-to assemble higher-level audio receiving facilities. It combines
-several different functionalities in one tool: decoders for multiple
-audio formats (MP3, OGG/Vorbis, AAC, WMA) and a number of processing
-filters, among these a normalizer for audio volume.
+Like para_recv, this is an atomic building block which can be used to
+assemble higher-level audio receiving facilities. It combines several
+different functionalities in one tool: decoders for multiple audio
+formats and a number of processing filters, among these a normalizer
+for audio volume.
 
 *para_afh*
 
@@ -255,10 +255,10 @@ First make sure all non-optional packages listed in the section on
 REFERENCE(Requirements, required software) are installed on your
 system.
 
-You don't need everything listed there. In particular, MP3, OGG/Vorbis
-and AAC support are all optional. The configure script will detect
-what is installed on your system and will only try to build those
-executables that can be built with your setup.
+You don't need everything listed there. In particular, MP3, OGG/Vorbis,
+OGG/Speex and AAC support are all optional. The configure script will
+detect what is installed on your system and will only try to build
+those executables that can be built with your setup.
 
 Note that no special decoder library (not even the MP3 decoding library
 libmad) is needed for para_server if you only want to stream MP3 or WMA
@@ -665,7 +665,7 @@ file. In particular the following data is stored for each audio file.
        - The lyrics id which describes the lyrics associated with
        this audio file.
 
-       - The audio format id (MP3, OGG, AAC, WMA).
+       - The audio format id (MP3, OGG, ...).
 
        - An amplification value that can be used by the amplification
        filter to pre-amplify the decoded audio stream.
@@ -1076,6 +1076,15 @@ chunks called OGG pages. A typical OGG page is about 4KB large. The
 Vorbis codec creates variable-bitrate (VBR) data, where the bitrate
 may vary considerably.
 
+*OGG/Speex*
+
+Speex is an open-source speech codec that is based on CELP (Code
+Excited Linear Prediction) coding. It is designed for voice
+over IP applications, has modest complexity and a small memory
+footprint. Wideband and narrowband (telephone quality) speech are
+supported. As for Vorbis audio, Speex bit-streams are often stored
+in OGG files.
+
 *AAC*
 
 Advanced Audio Coding (AAC) is a standardized, lossy compression
@@ -1122,11 +1131,11 @@ and stored in the audio file table.
 Chunks and chunk tables
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-paraslash uses the word "chunk" as common term for the building
-blocks of an audio file. For MP3 files, a chunk is the same as an
-MP3 frame, while for OGG/Vorbis files, a chunk is an OGG page, etc.
-Therefore the chunk size varies considerably between audio formats,
-from a few hundred bytes (MP3) up to 8K (WMA).
+paraslash uses the word "chunk" as common term for the building blocks
+of an audio file. For MP3 files, a chunk is the same as an MP3 frame,
+while for OGG files a chunk is an OGG page, etc.  Therefore the chunk
+size varies considerably between audio formats, from a few hundred
+bytes (MP3) up to 8K (WMA).
 
 The chunk table contains the offsets within the audio file that
 correspond to the chunk boundaries of the file. Like the meta data,