FreeSWITCH          




Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following information came from Anthony Minessale in a freeswitch-users thread:

If the jitterbuffer is already on, calling it again will just resize
it, so setting it to the same is redundant but harmless.

If you are surprised by why the jitterbuffer is paused during bridge:

If both sides of a bridge are RTP and both sides have a jb, its fairly
useless.  In fact if anything, it can worsen call quality.

You should only run jitterbuffers at points of termination change of
protocol.  Examples, if FS was hosting a conference or IVR, if you are
bridging the call to a phone for instance, you want to not use a
jitterbuffer because you want to preserve the original timestamps so
your phone can use its own jitterbuffer.

For special examples where you are using FS jitterbuffer in front of
something else that may not have one or some other special
circumstance you can use the setting chris mentioned to leave it
running.

Activation instructions

The jitter buffer can be activated via channel variable, dialplan app, or sofia param.

The jitter buffer has three params that control its behavior: length, max length, and max drift. Length is the initial size of the jitter buffer in milliseconds. Max length is the upper bound for how big the jitter buffer can grow. Max drift controls how much delay the jitter buffer will tolerate before dropping frames to make up ground.

Dialplan app

Enable 60 ms jitter buffer:

Code Block
<action application="jitterbuffer" data="60"/>

Enable 60 ms jitter buffer with 200ms max length and 20 ms max drift:

Code Block
<action application="jitterbuffer" data="60:200:20"/>

Sofia profile param

This param is the initial size of the jitter buffer in milliseconds. The max length and max drift values can't be set with this param.

Code Block
<param name="auto-jitterbuffer-msec" value="60"/>

jitterbuffer_msec

Activates the jitter buffer. The jitter buffer has three params: length, max length, and max drift.

Usage:

Code Block
<action application="set" data="jitterbuffer_msec=60:200:20"/>
<action application="answer"/>

Or to set it on the subsequent outbound call: export sets a variable on both the current channel and on any channels it creates, the 'nolocal:' disables setting it on the current channel and only sets it on the subsequent outbound channels.

Code Block
<action application="export" data="nolocal:jitterbuffer_msec=60"/>
<action application="bridge" data="sofia/default/888@conference.freeswitch.org"/>

You can also activate the Jitter Buffer in the bridge as follows:

Code Block
<action application="bridge" data="{jitterbuffer_msec=60}sofia/gateway/$1@gateway.com"/>

This will add a jitter buffer to packets flowing from a remote gateway towards a local freeswitch user. The network would look like this:

(local sip user) -----> FreeSWITCH -----> (remote gateway)

Where the link between the freeswitch and the remote gateway has a bad, jitter causing connection, and say the local sip user has no jitter buffering on their IP-phone. This will help the voice quality for the incoming audio.

Other usage

rtp

sip_jitter_buffer_plc

Enables/disables packet loss concealment (PLC) when using the jitter buffer. PLC is enabled by default when the jitter buffer is enabled. Set this variable before enabling the jitter buffer for it to have an effect.

Usage:

Code Block
<action application="set" data="rtp_jitter_buffer_plc=true"/>

or:

Code Block
<action application="set" data="rtp_jitter_buffer_plc=false"/>

rtp_jitter_buffer_during_bridge

Enables/disables the jitter buffer during bridge.

Usage:

Code Block
<action application="set" data="rtp_jitter_buffer_during_bridge=true"/>

or,

Code Block
<action application="set" data="rtp_jitter_buffer_during_bridge=false"/>

To enable jitter buffer on only the B-leg of the call, issue these example commands in this sequence:

<action application="export" data="rtp_jitter_buffer_during_bridge=true"/>
<action application="export" data="nolocal:jitterbuffer_msec=30:120:20"/>


Pause

The jitter buffer can be paused mid-call

Code Block
<action application="jitterbuffer" data="pause"/>

Resume

The jitter buffer can be resumed mid-call

Code Block
<action application="jitterbuffer" data="resume"/>

Debug

Jitter buffer debugging can be enabled/disabled.

Code Block
<action application="jitterbuffer" data="debug:${uuid}"/>
<action application="jitterbuffer" data="debug:off"/>

 

Lookahead

If using the Opus codec (popular with WebRTC) and the far end is sending F.E.C. (Forward Error Correction) information, you can enable a look-ahead jitter buffer in the codec configuration:

Code Block
titleautoload_configs/opus.conf.xml
<param name="use-jb-lookahead" value="1"/> 

On FreeSWITCH version 1.6 and later this greatly improves the audio performance even with heavy packet loss.