Codec Entry - CLI

Created by Ribbon Communications, last modified on Aug 12, 2016

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Back to Table of Contents

Back to CLI Configure Mode

Back to Profiles - CLI

Back to Media - CLI

In this section:

Unable to render {include} The included page could not be found.

Audio codecs are associated with a Packet Service Profile. Some codecs are used in pass-through or direct media mode only (that is, special DSP treatments and transcoding are not applicable to the calls using these audio codecs).

All audio codecs used by video calls are also used only in pass-through or direct media mode. Audio codec relay is supported in SIP-SIP, H.323-H.323 as well as SIP-H.323 interworking calls.

For a list of supported audio codecs, see Audio Support page.

Command Syntax

The syntax is categorized into different groups according to applicable codecs.

Group 1 Syntax

% set profiles media codecEntry xxx codec <codec_type> 
    activeCodecSet <AMR-value-kbps>
	dtmf 
        relay <relay_type> 
        removeDigits <disable | enable> 
    fax 
        failureHandling <continue | disconnect>
        toneTreatment <treatment_type> 
    fecRedundancy <0 | 1 | 2>
	modeChangeNeighbor <disable | enable>
    modem 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    packetSize <packetSize> 
    preferredRtpPayloadType <0-128>
    silentSuppression <disable | enable>

The above syntax applies to following codecs:

amrBandwidthEfficient
amrCrc
amrCrcInterleaving
amrCrcRobustSorting
amrInterleaving
amrInterleavingRobustSorting
amrIuUp
amrOctetAligned
amrRobustSorting

Group 2 Syntax

% set profiles media codecEntry xxx	codec <codec_type> 
	dtmf 
		relay <relay_type> 
		removeDigits <disable | enable> 
	fax 
		failureHandling <continue | disconnect>
		toneTreatment <treatment_type> 
	modeChangeNeighbor <disable | enable>
	modeSet <AMR-modeSet#>
	modem 
		failureHandling <continue | disconnect> 
		toneTreatment <treatment_type> 
	packetSize <packetSize> 
	preferredRtpPayloadType <0-128>
	silentSuppression <disable | enable>

The above syntax applies to following codecs:

amrwbBandwidthEfficient
amrwbCrc
amrwbCrcInterleaving
amrwbCrcInterleavingRobustSorting
amrwbCrcRobustSorting
amrwbInterleaving
amrwbInterleavingRobustSorting
amrwbOctetAligned

Group 3 Syntax

% set profiles media codecEntry xxx codec <codec_type> 
    dtmf 
        relay <relay_type> 
        removeDigits <disable | enable> 
    fax 
        failureHandling <continue | disconnect>
        toneTreatment <treatment_type> 
    modem 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    packetSize <packetSize> 
    preferredRtpPayloadType <0-128>

The above syntax applies to following codecs:

bv16
bv32
bv32Fec
evrcb1Fr
g7221-32
g728
g7291
g729a
g729ab
gsm
isac
l16-16
msrta8
msrta16
silk8
silk12
silk16
silk24
speex8
speex8Fec
speex16
speex16Fec
speex32

Group 4 Syntax

% set profiles media codecEntry xxx codec <codec_type> 
    dtmf 
        relay <relay_type> 
        removeDigits <disable | enable> 
    fax 
        failureHandling <continue | disconnect>
        toneTreatment <treatment_type> 
    modem 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    packetSize <packetSize> 
    preferredRtpPayloadType <0-128>
	silenceSuppression <disable | enable>

The above syntax applies to following codecs:

efr
evrc
evrc0
evrc1
evrc1Fr
evrcb1

Group 5 Syntax

% set profiles media codecEntry xxx	codec <codec_type> 
	dtmf 
		relay <relay_type> 
		removeDigits <disable | enable> 
	fax 
		failureHandling <continue | disconnect> 
		toneTreatment <treatment_type> 
	law <ALaw | ULaw | deriveFromOtherLeg> 
	modem 
		failureHandling <continue | disconnect> 
		toneTreatment <treatment_type> 
	packetSize <packetSize>

The above syntax applies to following codecs:

g711

Group 6 Syntax

% set profiles media codecEntry xxx    codec <codec_type> 
    dtmf 
        relay <relay_type> 
        removeDigits <disable | enable> 
    fax 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    law <ALaw | ULaw | deriveFromOtherLeg> 
    modem 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    packetSize <packetSize> 
	sendSid <disable | enable>

The above syntax applies to following codecs:

g711ss

Group 7 Syntax

% set profiles media codecEntry xxx codec <xxx> 
	codingRate <codingRate> 
	dtmf 
		relay <relay_type> 
		removeDigits <disable | enable> 
	fax 
		failureHandling <continue | disconnect> 
		toneTreatment <treatment_type> 
	modem 
		failureHandling <continue | disconnect> 
		toneTreatment <treatment_type> 
	packetSize <packetSize> 
	preferredRtpPayloadType <0-128>

The above syntax applies to following codecs:

evrcb
evrcb0
g722
g7221
g7221ss
g726
g726ss
g7231
g7231a
ilbc
ilbcss

Group 8 Syntax

% set profiles media codecEntry xxx codec <xxx> 
    dtmf 
        relay <relay_type> 
        removeDigits <disable | enable> 
    fax 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    modem 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    preferredRtpPayloadType <0-128>

The above syntax applies to following codecs:

g728ss

Group 9 Syntax

% set profiles media codecEntry <codec entry> codec opus 
    dtmf 
        relay <relay_type> 
        removeDigits <disable | enable> 
    fax 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    maxAverageBitRate (6000-510000 bits/sec)
    modem 
        failureHandling <continue | disconnect> 
        toneTreatment <treatment_type> 
    packetSize <packetSize> 
    preferredRtpPayloadType <0-128>
    useCbr (0 | 1)
    useDtx (0 | 1)
    useFec (0 | 1)

The above syntax applies to following codecs:

opus

Command Parameters

The Codec Parameters are as shown below:

Codec Parameters

Parameter

Length/Range

Description

codecEntry

N/A

Specifies the name of an entity consisting of a codec type along with the set of parameters to use with it. Select a default codec name or enter a custom name. Defaults are:

G711-DEFAULT
G711SS-DEFAULT
G723-DEFAULT
G723A-DEFAULT
G726-DEFAULT
G729A-DEFAULT
G729AB-DEFAULT

codec

N/A

Select a supported codec. (see

)

activeCodecSet

N/A

The active code set is applicable to certain AMR narrow-band codecs. Multiple rates may be selected using comma (,). Valid values are:

AMR-0-4.75kbps
AMR-1-5.15kbps
AMR-2-5.90kbps
AMR-3-6.70kbps
AMR-4-7.40kbps
AMR-5-7.950kbps
AMR-6-10.20kbps
AMR-7-12.20kbps

codingRate

N/A

Coding rate examples:

Codec	Coding Rates (kbps)
G.722, G.722ss	48, 56, 64
G.722.1, G.722.1ss	16, 24, 32
G.723.1, G.723.1a	5.3, 6.3
G.726, G.276ss	32
evrcb, evrcb0	4.8 5.8 6.2 6.6 7.0 7.5 8.5 9.3
ilbc, ilbcss	13.3, 15.2

dtmf

N/A

Use this parameter to describe how to handle DTMF digits in the media stream.

relay – Type of DTMF relay. Select any one of the relay:
- bothOobAnd2833 – Out-of-Band and RFC 2883 are equally received and both can be transmitted. This option would normally be used only in the case where the OOB DTMF signaling is absorbed and not regenerated. For example, the OOB DTMF might go to an application server that needs to detect the DTMF for control purposes but does not process RTP and the 2833 DTMF would go to the destination media address as part of the RTP stream.
- eitherOobOrRfc2833 – Out-of-Band and RFC 2833 are equally received and only one is transmitted. The one transmitted is the one preferred by the peer or RFC 2833 as the default.
- none – Leaves the DTMF tones in-band as encoded audio.
- outOfBand – Carries DTMF in the signaling protocol.
- rfc2833 – Encodes DTMF into RTP using format and payload type distinct from audio encoding.
removeDigits – Enables the removal of DTMF digits from the media stream. This applies only if DTMF relay is configured as outOfBand or rfc2833.
- disable
- enable (default)

fax

N/A

The treatment taken when the fax tone is detected.

failureHandling –The behavior when a fax tone is detected but treatment fails for any reason:
- continue – (default) Continue to process the call.
- disconnect – Release the call.
toneTreatment –Treatment taken when the fax tone is detected. Configuration options are:
- disconnect – Disconnect the call when the fax tone is detected.
- fallbackToG711 – Fall back to G.711 when the fax tone is detected.
- fallbackToG711AllowPeerToNegotiateFaxRelay – Upon detecting a fax tone, SBC transitions call to G.711 if current codec is not already G.711. After transiting to G.711, SBC accepts any T.38 reINVITE from the peer.
- faxRelay – Switch to fax relay (T.38) when the fax tone is detected.
- faxRelayOrFallbackToG711 – Switch to fax relay (T.38) if supported or fall back to G.711 when fax tone is detected.
- ignoreDetectionAllowPeerToNegotiateFaxRelay – Accept a T.38 reINVITE (either from a calling party or a called party) and ignore own fax tone detection event..
- none – (default) Do nothing when the fax tone is detected.
- notifyPeer – For SIP signaling, notify the peer when the fax tone is detected and let the peer decide the next action.

For G.711 calls, Notify Peer, Disconnect, Fax Relay, and Fax Relay or Fallback to G.711 require allocation of a compression resource.

fecRedundancy

0, 1, 2

Sets the level for Forward-Error-Correction (FEC) Redundancy [AMR only]. The default value of "0" means FEC redundancy is disabled.

law

N/A

Specifies the G.711 law to use. Values are::

ALaw
ULaw
deriveFromOtherLeg (default)

maxAverageBitRate 6000-510000 Maximum Average Bit Rate For OPUS Codec in bits/second. Default = 20000

maxInterleaveDepth

0-7

Use this parameter to specify the maximum interleave depth value to apply to an endpoint (default = 0).

This parameter only applies to EVRC and EVRCB calls.

maxInterleaveDepth is only visible under following conditions:

codec is set to "evrc" or "evrcb"
packetSize is set to "40" or "60"

modeChangeNeighbor

N/A

Enable to force mode change to neighboring modes in active codec set as per RFC4867 (applies to AMR and AMRWB).

disable (default)
enable

modem

N/A

Specifies the treatment taken when the modem tone is detected, which can be:

failureHandling – The behavior when a modem tone is detected but the treatment fails for any reason. The behavior can be:
- continue (default) – Continue to process the call.
- disconnect – Release the call.
toneTreatment – Treatment taken when the modem tone is detected, which can be:
- applyFaxTreatment – Treat the modem tone as a fax tone, and apply the fax treatment for the selected codec.
- disconnect – Disconnect the call when the modem tone is detected.
- fallbackToG711 – Fall back to G.711 when the modem tone is detected.
- none (default) – Do nothing when the modem tone is detected.
- notifyPeer – Notify the peer when the modem tone is detected and let the peer decide the next action.

applyFaxTreatment is not supported for Gateway Links.

modeSet

N/A

The AMR mode set is applicable to certain AMR wide-band codecs. The possible values are:

AMR-0-6.6
AMR-1-8.85
AMR-2-12.65
AMR-3-14.25
AMR-4-15.85
AMR-5-18.25
AMR-6-19.85
AMR-7-23.05
AMR-8-23.85

packetSize

N/A

The packet size in milliseconds (ms). Options are based on the type of codec chosen. (See Packet Sizes per Codec table below for details)

preferredRtpPayloadType

0-128

Specifies the preferred Real Time Protocol (RTP) payload type to be included in the RTP header of the data packet. Enter a value in the range 0-128. Default is 128.

sendSid

N/A

Enable or disable for sending SIDs.

silenceSuppression

N/A

Enable/disable Silence Suppression mode.

disable (default)
enable

useCbr

0, 1

Use this flag to specify either Constant Bit Rate (CBR) or Variable Bit Rate (VBR) for OPUS codec (default = 0).

0 – Variable Bit Rate
1 – Constant Bit Rate

Configuring an Opus profile using a very low maxAverageBitRate with useCbr set to "1" may result in degraded voice quality.

useDtx

0, 1

Set flag to "1" to use Discontinuous Transmission (DTX) For OPUS codec (default = 0).

0 – Do not use DTX
1 – Use DTX

useFec

0, 1

Set flag to "1" to use Forward Error Correction (FEC) for OPUS codec (default = 0).

0 – Do not use FEC
1 – Use FEC

Packet Sizes per Codec

Codecs	Packet Sizes
amr*, efr, evrc, evrc1, evrc1Fr, evrcb, evrcb1, evrcb1Fr	20, 40, 60
amrwb*	20, 40, 60, 80, 100
bv16, bv32, bv32Fec, dvc-2, g7221-32, g7291, gsm, Isac, l16-16, msrta8, msrta16, silk8, silk12, silk16, silk24, speex8, speex8Fec, speex16, speex16Fec, speex32	5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 80, 100
evrc0, evrcb0	20
g711, g711ss	10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60
g722 , g722ss, g726, g726ss	10, 20, 30, 40
g728, g728ss	10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150
g729a, g729ab, opus	10, 20, 30, 40, 50, 60
g7221, g7221ss	20, 40, 60, 80
g7231, g7231a	30, 60, 90, 120, 150
Ilbc, ilbcss	30, 60

Command Examples

 % show profiles media
	 codecEntry G711-DEFAULT { 
		codec g711; 
		packetSize 10; 
		preferredRtpPayloadType 128; 
			fax { 
				failureHandling continue; 
				toneTreatment none; 
			} 
			modem { 
				failureHandling continue; 
				toneTreatment none; 
			} 
			law deriveFromOtherLeg; 
			dtmf { 
				relay none; 
				removeDigits enable; 
			}
	 }

Perform the following commands to set up configuration for a transcoded call between G.711 ulaw and G.729.

% set profiles media codecEntry codec_in codec g711 law ULaw 
% set profiles media codecEntry codec_in packetSize 20
% commit
% set profiles media packetServiceProfile profile_in 
% set profiles media packetServiceProfile profile_in codec codecEntry1 codec_in 
% set profiles media packetServiceProfile profile_in packetToPacketControl codecsAllowedForTranscoding thisLeg g711u 
% set profiles media packetServiceProfile profile_in packetToPacketControl codecsAllowedForTranscoding otherLeg g729 
% commit
% set profiles media codecEntry codec_out codec g729a 
% set profiles media codecEntry codec_out packetSize 20 
% commit
% set profiles media packetServiceProfile profile_out_1 
% set profiles media packetServiceProfile profile_outcodec codecEntry1 codec_out 
% set profiles media packetServiceProfile profile_outpacketToPacketControl codecsAllowedForTranscoding thisLeg g729 
% set profiles media packetServiceProfile profile_outpacketToPacketControl codecsAllowedForTranscoding otherLeg g711u

Assign the ingress profile to ingress trunk group and egress profile on Egress IP peer:

% set addressContext a1 zone INTERNAL sipTrunkGroup EAST_INT policy media packetServiceProfile profile_in  
% set addressContext a1 zone EXTERNAL ipPeer EAST_ext_peer policy packetServiceProfile profile_out
% commit

Get statistics of ongoing calls by executing the following commands. The GCID (Global Call Identifier) for calls are listed.

% show table global callSummaryStatus

Provide GCID for the following command; output shows media type (pass-through or transcode):

% show table global callDetailStatus <GCID>

Output of the following command gives codec details:

% show table global callMediaStatus <GCID>

Output of the following command gives PxPad utilization:

 % show table global callResourceDetailStatus <GCID>

Configure Opus codec:

% set profiles media codecEntry Opus_entry codec opus maxAverageBitRate 10000 useCbr 1 useDtx 1 useFec 0
% commit
 
% show profiles media codecEntry Opus_entry
codec             opus;
maxAverageBitRate 10000;
useCbr            1;
useFec            0;
useDtx            1;

No labels