
Speex Xmms plugin 0.6.0

(c) Jens Burkal

This program is licensed under the GNU GPL included in the file COPYING

New versions can be found at: http://jzb.rapanden.dk/speex


Requirements:
------------
Xmms development headers (libxmms1-devel)
Ogg development headers (libogg0-devel or libogg1-devel)
Speex 0.6.0 (and remember to compile it as shared libraries (./configure --enable-shared))
Gtk+ 1.2 development headers (libgtk+1.2-devel)


Installing:
-----------
 1. tar -zxf speex-xmms-0.1.1.tar.gz
 2. cd speex-xmms
 3. make
 4. su root -c make install


Chained streams:
----------------
The plugin supports chaining of speex-streams, including streams with different samplerate, bitrate etc.
	cat file1.spx file2.spx > file3.spx

(note that "cat file1.spx file1.spx > file2.spx" will not produce an valid bitstream)


Broken frames:
--------------
If something is broken in the stream and the crc fails, the plugin will detect the hole in the stream and ask
libspeex to interpolate over it.
Since an ogg page is rather large, the hole can be over 1 second, and it probably won't repair very well.


Known limitations:
-----------------
* Streaming (http/rtp/whatever) doesn't work.

* Seeking in other than the first logical bitstream (chained files) don't work.
* Seeking in the last few seconds of the stream, when it's only the buffer playing, doesn't work.

* Chaining streams with identical serial-no won't work.
* File info only includes the first bitstream.

Reporting bugs:
---------------
If you find a bug (and it's not listed under "Known limitations") please mail me information.
Please check:
	* Does the file play with speexdec?
	* What does ogginfo say? (you should use the ogginfo from version 1 of vorbis-tools)

Compile the plugin with #define DEBUG and include the console output in your report.
Finally send the report to <jzb@rapanden.dk>
(... or you can also send me a patch and a few words regarding what it does)


Acknowledgments:
---------------
While writing this plugin i have looked at, and been inspired by:
 * speexdec by Jean-Marc Valin
 * decoder_example from vorbis by Xiphophorus
 * vorbis-xmms-plugin by Tony Arcieri
 * wave-xmms-plugin by the XMMS team
 

