diff --git a/dev/thirdparty/speexdsp/README.md b/dev/thirdparty/speexdsp/README.md new file mode 100644 index 0000000000000000000000000000000000000000..61a5cd2ab82e842dd2770eb4be9bdf2615c95235 --- /dev/null +++ b/dev/thirdparty/speexdsp/README.md @@ -0,0 +1,62 @@ +## Introduction to Speex + +![speecdsp logo](media/speex.png) + +The Speex codec (http://www.speex.org/) exists because there is a need for a speech codec that is open-source and free from software patent royalties. These are essential conditions for being usable in any open-source software. In essence,Speex is to speech what Vorbis is to audio/music. + +Unlike many other speech codecs, Speex is not designed for mobile phonesbut rather for packet networks and voice over IP (VoIP) applications. File-based compression is of course also supported.The Speex codec is designed to be very flexible and support a wide range of speech quality and bit-rate. Support for very 12489good quality speech also means that Speex can encode wideband speech (16 kHz sampling rate) in addition to narrowband speech (telephone quality, 8 kHz sampling rate). + +Designing for VoIP instead of mobile phones means that Speex is robust to lost packets, but not to corrupted ones. This is based on the assumption that in VoIP, packets either arrive unaltered or don’t arrive at all. Because Speex is targeted at a wide range of devices, it has modest (adjustable) complexity and a small memory footprint.All the design goals led to the choice of CELP as the encoding technique. One of the main reasons is that CELP has long proved that it could work reliably and scale well to both low bit-rates (e.g. DoD CELP @ 4.8 kbps) and high bit-rates (e.g.G.728 @ 16 kbps). + +## The main characteristics of Speex + +The main characteristics of Speex can be summarized as follows: +- Free software/open-source, patent and royalty-free. +-Integration of narrowband and wideband using an embedded bit-stream. +- Wide range of bit-rates available (from 2.15 kbps to 44 kbps). +- Dynamic bit-rate switching (AMR) and Variable Bit-Rate (VBR) operation. +- Voice Activity Detection (VAD, integrated with VBR) and discontinuous transmission (DTX). +- Variable complexity. +- Embedded wideband structure (scalable sampling rate). +- Ultra-wideband sampling rate at 32 kHz. +- Intensity stereo encoding option. +- Fixed-point implementation. + +## Compiling and Porting + +Compiling Speex under UNIX/Linux or any other platform supported by autoconf (e.g. Win32/cygwin) is as easy as typing: + +``` +% ./configure [options] +% make +% make install +``` +The options supported by the Speex configure script are: + +–prefix= Specifies the base path for installing Speex (e.g. /usr) + +–enable-shared/–disable-shared Whether to compile shared libraries + +–enable-static/–disable-static Whether to compile static libraries + +–disable-wideband Disable the wideband part of Speex (typically to save space) + +–enable-valgrind Enable extra hits for valgrind for debugging purposes (do not use by default) + +–enable-sse Enable use of SSE instructions (x86/float only) + +–enable-fixed-point Compile Speex for a processor that does not have a floating point unit (FPU) + +–enable-arm4-asm Enable assembly specific to the ARMv4 architecture (gcc only) + +–enable-arm5e-asm Enable assembly specific to the ARMv5E architecture (gcc only) + +–enable-fixed-point-debug Use only for debugging the fixed-point code (very slow) + +–enable-epic-48k Enable a special (and non-compatible) 4.8 kbps narrowband mode (broken in 1.1.x and 1.2beta) + +–enable-ti-c55x Enable support for the TI C5x family + +–enable-blackfin-asm Enable assembly specific to the Blackfin DSP architecture (gcc only) + +–enable-vorbis-psycho Make the encoder use the V orbis psycho-acoustic model. This is very experimental and may be removed in the future. diff --git a/dev/thirdparty/speexdsp/media/speex.png b/dev/thirdparty/speexdsp/media/speex.png new file mode 100644 index 0000000000000000000000000000000000000000..4db28733e672a821351514567ed57c5850f6fbef Binary files /dev/null and b/dev/thirdparty/speexdsp/media/speex.png differ