indications.conf: add stutter tone; end properly
[asterisk/asterisk.git] / configs / codecs.conf.sample
1 [speex]
2 ; CBR encoding quality [0..10]
3 ; used only when vbr = false
4 quality => 3
5
6 ; codec complexity [0..10]
7 ; tradeoff between cpu/quality
8 complexity => 2
9
10 ; perceptual enhancement [true / false]
11 ; improves clarity of decoded speech
12 enhancement => true
13
14 ; voice activity detection [true / false]
15 ; reduces bitrate when no voice detected, used only for CBR
16 ; (implicit in VBR/ABR)
17 vad => true
18
19 ; variable bit rate [true / false]
20 ; uses bit rate proportionate to voice complexity
21 vbr => true
22
23 ; available bit rate [bps, 0 = off]
24 ; encoding quality modulated to match this target bit rate
25 ; not recommended with dtx or pp_vad - may cause bandwidth spikes
26 abr => 0
27
28 ; VBR encoding quality [0-10]
29 ; floating-point values allowed
30 vbr_quality => 4
31
32 ; discontinuous transmission [true / false]
33 ; stops transmitting completely when silence is detected
34 ; pp_vad is far more effective but more CPU intensive
35 dtx => false
36
37 ; preprocessor configuration
38 ; these options only affect Speex v1.1.8 or newer
39
40 ; enable preprocessor [true / false]
41 ; allows dsp functionality below but incurs CPU overhead
42 preprocess => false
43
44 ; preproc voice activity detection [true / false]
45 ; more advanced equivalent of DTX, based on voice frequencies
46 pp_vad => false
47
48 ; preproc automatic gain control [true / false]
49 pp_agc => false
50 pp_agc_level => 8000
51
52 ; preproc denoiser [true / false]
53 pp_denoise => false
54
55 ; preproc dereverb [true / false]
56 pp_dereverb => false
57 pp_dereverb_decay => 0.4
58 pp_dereverb_level => 0.3
59
60
61 [plc]
62 ; for all codecs which do not support native PLC
63 ; this determines whether to perform generic PLC
64 ; there is a minor performance penalty for this
65 genericplc => true
66
67 ; Generate custom formats for formats requiring attributes.
68 ; After defining the custom format, the name used in defining
69 ; the format can be used throughout Asterisk in the format 'allow'
70 ; and 'disallow' options.
71 ;
72 ; Example: silk8 is a predefined custom format in this config file.
73 ; Once this config file is loaded, silk8 can be used anywhere a
74 ; peer's codec capabilities are defined.
75 ;
76 ; In sip.conf 'silk8' can be defined as a capability for a peer.
77 ; [peer1]
78 ; type=peer
79 ; host=dynamic
80 ; disallow=all
81 ; allow=silk8 ;custom codec defined in codecs.conf
82 ;
83 ; LIMITATIONS
84 ; Custom formats can only be defined at startup.  Any changes to this
85 ; file made after startup will not take into effect until after Asterisk
86 ; is restarted.
87 ;
88
89 ; Default Custom SILK format definitions, only one custom SILK format per
90 ; sample rate is allowed.
91 [silk8]
92 type=silk
93 samprate=8000
94 fec=true           ; turn on or off encoding with forward error correction.
95                    ; On recommended, off by default.
96 packetloss_percentage=10   ; Estimated packet loss percentage in uplink direction.  This
97                            ; affects how much redundancy is built in when using fec.
98                            ; The higher the percentage, the larger amount of bandwidth is
99                            ; used. Default is 0%, 10% is recommended when fec is in use.
100
101 maxbitrate=10000    ; Use the table below to make sure a useful bitrate is choosen
102                     ; for maxbitrate.  If not set or value is not within the bounds
103                     ; of the encoder, a default value is chosen.
104                     ;
105                     ;  sample rate | bitrate range
106                     ;  8khz        | 5000 - 20000 bps
107                     ;  12khz       | 7000 - 25000 bps
108                     ;  16khz       | 8000 - 30000 bps
109                     ;  24khz       | 20000- 40000 bps
110                     ;
111 ;dtx=true       ; Encode using discontinuous transmission mode or not. Turning this
112                 ; on will save bandwidth during periods of silence at the cost of
113                 ; increased computational complexity.  Off by default.
114
115 [silk12]
116 type=silk
117 samprate=12000
118 maxbitrate=12000
119 fec=true
120 packetloss_percentage=10;
121
122 [silk16]
123 type=silk
124 samprate=16000
125 maxbitrate=20000
126 fec=true
127 packetloss_percentage=10;
128
129 [silk24]
130 type=silk
131 samprate=24000
132 maxbitrate=30000
133 fec=true
134 packetloss_percentage=10;
135
136
137 ; Default custom CELT codec definitions. Only one custom CELT definition is allowed
138 ; per a sample rate.
139 ;[celt44]
140 ;type=celt
141 ;samprate=44100  ; The samplerate in hz. This option is required.
142 ;framesize=480   ; The framesize option represents the duration of each frame in samples.
143                  ; This must be a factor of 2.  This option is only advertised in an SDP
144                  ; when it is set.  Otherwise a default of framesize of 480 is assumed
145                  ; internally
146
147 ;[celt48]
148 ;type=celt
149 ;samprate=48000
150
151 ;[celt32]
152 ;type=celt
153 ;samprate=32000