Blame doc/speexdsp.txt

Packit Service cd2a00
Speex Preprocessing Plugin
Packit Service cd2a00
==========================
Packit Service cd2a00
Packit Service cd2a00
This plugin provides a pre-processing of a mono stream like denoise
Packit Service cd2a00
using libspeex DSP API.  You can use the plugin with the plugin type
Packit Service cd2a00
"speex" like below:
Packit Service cd2a00
Packit Service cd2a00
	pcm.my_pcm {
Packit Service cd2a00
		type speex
Packit Service cd2a00
		slave.pcm "default"
Packit Service cd2a00
	}
Packit Service cd2a00
Packit Service cd2a00
Then record like
Packit Service cd2a00
Packit Service cd2a00
	% arecord -fdat -c1 -Dplug:my_pcm foo.wav
Packit Service cd2a00
Packit Service cd2a00
so that you'll get 48kHz mono stream with the denoising effect.
Packit Service cd2a00
Packit Service cd2a00
Right now, the plugin supports only a mono stream.
Packit Service cd2a00
The accepted format is only S16.
Packit Service cd2a00
Packit Service cd2a00
The following parameters can be set optionally:
Packit Service cd2a00
Packit Service cd2a00
* frames
Packit Service cd2a00
Packit Service cd2a00
  This controls the frames of the intermediate buffer.  This
Packit Service cd2a00
  corresponds to the latency of the filter.  As default it's 64.
Packit Service cd2a00
Packit Service cd2a00
* denoise
Packit Service cd2a00
Packit Service cd2a00
  A boolean value to enable/disable the denoise function.  Default is
Packit Service cd2a00
  yes.
Packit Service cd2a00
Packit Service cd2a00
* agc
Packit Service cd2a00
   
Packit Service cd2a00
  A boolean value to enable/disable the auto-gain control function.
Packit Service cd2a00
  Default is no.
Packit Service cd2a00
Packit Service cd2a00
* agc_level
Packit Service cd2a00
Packit Service cd2a00
  A float value for the automatic gain-control level.  Default is 8000.
Packit Service cd2a00
Packit Service cd2a00
* dereverb
Packit Service cd2a00
Packit Service cd2a00
  A boolean value to enable/disable dereverb function.  Default is no.
Packit Service cd2a00
Packit Service cd2a00
* echo
Packit Service cd2a00
Packit Service cd2a00
  A boolean value to enable/disable echo-cancellation function.
Packit Service cd2a00
  Default is no.
Packit Service cd2a00
Packit Service cd2a00
* filter_length
Packit Service cd2a00
Packit Service cd2a00
  Number of samples of echo to cancel.  As default it's 256.
Packit Service cd2a00
Packit Service cd2a00
For example, you can enable agc like
Packit Service cd2a00
Packit Service cd2a00
	pcm.my_pcm {
Packit Service cd2a00
		type speex
Packit Service cd2a00
		slave.pcm "default"
Packit Service cd2a00
		agc 1
Packit Service cd2a00
		agc_level 8000
Packit Service cd2a00
	}