summaryrefslogtreecommitdiffstats
path: root/doc/speexdsp.txt
blob: 5b5e5a018a2bb2c74c318f876dafc99f30b4bbd9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Speex Preprocessing Plugin
==========================

This plugin provides a pre-processing of a mono stream like denoise
using libspeex DSP API.  You can use the plugin with the plugin type
"speex" like below:

	pcm.my_pcm {
		type speex
		slave.pcm "default"
	}

Then record like

	% arecord -fdat -c1 -Dplug:my_pcm foo.wav

so that you'll get 48kHz mono stream with the denoising effect.

Right now, the plugin supports only a mono stream.
The accepted format is only S16.

The following parameters can be set optionally:

* frames

  This controls the frames of the intermediate buffer.  This
  corresponds to the latency of the filter.  As default it's 64.

* denoise

  A boolean value to enable/disable the denoise function.  Default is
  yes.

* agc
   
  A boolean value to enable/disable the auto-gain control function.
  Default is no.

* agc_level

  A float value for the automatic gain-control level.  Default is 8000.

* dereverb

  A boolean value to enable/disable dereverb function.  Default is no.

* echo

  A boolean value to enable/disable echo-cancellation function.
  Default is no.

* filter_length

  Number of samples of echo to cancel.  As default it's 256.

For example, you can enable agc like

	pcm.my_pcm {
		type speex
		slave.pcm "default"
		agc 1
		agc_level 8000
	}