Version

Appendix D

DSP Files

: Introduction
: Summary of DSP Files

Introduction

This appendix describes the DSP files shipped with the ADI service and shows the associated ADI service functions.
DSP files are loaded onto the AG boards using the AG loader/monitor, agmon or OAM. The files to be loaded are specified in the configuration file. For more information, refer to the board-specific installation and developer's manual. Note: Some DSP files have mu-law and A-law versions. The names shown here are for the mu-law version. The A-law files have _a appended to the file name. For example, the A-law version of voice.dsp is voice_a.dsp. Some DSP files have Japanese versions which have _j appended to the file name. For example, the Japanese version of adsir.dsp is adsir_j.dsp.

Summary of DSP Files

The following table provides an overview of the DSP files needed for particular ADI service functions. For more information about DSP files, refer to the board-specific installation and developer's manual

DSP File
(General)

DSP File:
AG 2000/
AG 4000/C

DSP File: CG 6000C

Description

adsir.dsp

adsir.m54

adsir.f54

Contains the caller ID function which decodes the modem burst that occurs between the first and second rings on a loop start line. Use adsir.dsp if one of the loop start protocols is used and the parameter adilps.cidsupport is set to 1.
This file is also needed for adiStartReceivingFSK.

adsir(-j).dsp

adsir(-j).m54

adsir(_j).f54

Contains the caller ID function that decodes the modem burst that occurs between the first and second rings on a loop start line. In addition, it contains the FSK data receiver. (-j) is the Japanese variant.

adsix.dsp

adsix.m54

adsix.f54

Contains the FSK transmitter. It is needed for adiStartSendingFSK.

adsix(_j).dsp

adsix(_j).m54

adsix(_j).f54

Contains the FSK data transmitter. (-j) is the Japanese variant.

callp.dsp

callp.m54

callp.f54

Contains voice and tone detectors used for call progress detection and for general tone detection.
Use callp.dsp if any outgoing or two-way trunk protocol is in use and for adiStartCallProgress.
For all AG boards except AG 2000 and AG 4000/C, use adiStartToneDetector.

dtmf.dsp

dtmf.m54

dtmf.f54

Contains the DTMF receiver, energy/silence detector and a precise tone detector. Use dtmf.dsp for DTMF detection. The silence/energy detector is used by the record functions and by adiStartEnergyDetector. The precise tone detector is used as the cleardown detector by the loop start protocols when the parameter adilps.cleardownflag is set to 1. Otherwise, it is available as tone detector #1 to adiStartToneDetector.

dtmfe.dsp

dtmfe.m54

dtmfe.f54

Is a variation of dtmf.xxx, optimized for use with the echo canceller (echo.xxx). It yields better talk-off resistance but requires the echo canceller to achieve the best cut through performance.

echo.dsp

echo.m54

echo.f54

Contains the echo cancellation function. The echo canceller removes reflected energy from the incoming signal, which improves DTMF detection and voice recognition while playing.
Use echo.xxx if echo cancellation is enabled. See the adiStartProtocol function and the ADISTART_PARMS category.
Note: Substitute dtmfe.xxx for dtmf.xxx when using the echo canceller.

g726p.dsp (play)
g726r.dsp (record)

g726.m54

g726.f54

Contains ITU G.726 ADPCM play and record functions. G.726 is a standard for 32 kbs speech coding.
Note: These functions require considerably more DSP processing time than the functions in voice.xxx. You will not be able to run as many contexts actively playing or recording as you can with other speech codings.

gsm_ms.m54

gsm_ms.f54

Contains play and record functions for MS-GSM speech encoding at 13 kbs (CT Access 4.0 only).

gsm_m5pl.m54

gsm_m5pl.f54

This file is identical in operation to gsm_ms.m54 with the exception that maximum output of the play function is limited (CT Access 4.0 only).

imaply.dsp (play)
imarec.dsp (record)

ima.m54

ima.f54

Contains play and record functions for IMA ADPCM speech encoding, at 24 Kbps or 32 Kbps.

mf.dsp

mf.m54

mf.f54

Contains the Multi-Frequency Receiver function. This function is required for any trunk protocol that uses MF signaling and also by adiStartMFDetector.

okiply.dsp (play)
okirec.dsp (record)

oki.m54

oki.f54

Contains play and record functions for OKI ADPCM speech encoding, at 24 kbs or 32 kbs.

ptf.m54

ptf.f54

Contains precise tone filters. Used as the cleardown detector by loop start protocols. On AG 2000, AG 4000/C, and CG 6000C boards, use it for adiStartToneDetector and adiStartCallProgress.

rvoice.dsp

rvoice.m54

rvoice.f54

Contains PCM play and record functions.
rvoice.xxx is required to play or record with an encoding of ADI_ENCODE_MULAW, ADI_ENCODE_ALAW, or ADI_ENCODE_PCM8M16.

signal.dsp (not required on AG Dual/Quad)

signal.m54 (not required on AG 4000/C)

None

Contains signaling, ring detector and pulse functions. These are out of band functions which typically operate on the MVIP signaling stream.
This file is required for any trunk protocol except NOCC. It is also required for adiStartSignalDetector, adiQuerySignalState, and adiStartPulse.

tone.dsp

tone.m54

tone.f54

Contains the tone generation function.
This file is required for any trunk protocol except NOCC. It is also required for adiStartTones, adiStartDTMF and adiStartDial, and for any record function to generate the beep.

voice.dsp

voice.m54

voice.f54

Contains NMS ADPCM play and record functions. The compressed speech is in a framed format with 20 milliseconds of data per frame. Speech is compressed to 16, 24, or 32 Kbps or stored as uncompressed mu-law or A-law (64 Kbps). This file is required to play or record with encoding values of ADI_ENCODE_NMS_16, ADI_ENCODE_NMS_24, ADI_ENCODE_NMS_32, or ADI_ENCODE_NMS_64.

voxp.dsp voxr.dsp

These files should be substituted for voice.dsp in order to apply speed up to NMS ADPCM encoded speech. voxp.dsp supports speed-up.

wavply.dsp (play)
wavrec.dsp (record)

wave.m54

wave.f54

Contains play and record functions for PCM speech in formats commonly used in WAVE files, including 8 and 16 bit 11 kHz sampling.

.

DSP File (General)	DSP File: AG 2000/ AG 4000/C	DSP File: CG 6000C	Description
`adsir.dsp`	`adsir.m54`	`adsir.f54`	Contains the caller ID function which decodes the modem burst that occurs between the first and second rings on a loop start line. Use `adsir.dsp` if one of the loop start protocols is used and the parameter adilps.cidsupport is set to 1. This file is also needed for adiStartReceivingFSK.
`adsir(-j).dsp`	`adsir(-j).m54`	`adsir(_j).f54`	Contains the caller ID function that decodes the modem burst that occurs between the first and second rings on a loop start line. In addition, it contains the FSK data receiver. (`-j`) is the Japanese variant.
`adsix.dsp`	`adsix.m54`	`adsix.f54`	Contains the FSK transmitter. It is needed for adiStartSendingFSK.
`adsix(_j).dsp`	`adsix(_j).m54`	`adsix(_j).f54`	Contains the FSK data transmitter. (`-j`) is the Japanese variant.
`callp.dsp`	`callp.m54`	`callp.f54`	Contains voice and tone detectors used for call progress detection and for general tone detection. Use `callp.dsp` if any outgoing or two-way trunk protocol is in use and for adiStartCallProgress. For all AG boards except AG 2000 and AG 4000/C, use adiStartToneDetector.
`dtmf.dsp`	`dtmf.m54`	`dtmf.f54`	Contains the DTMF receiver, energy/silence detector and a precise tone detector. Use `dtmf.dsp` for DTMF detection. The silence/energy detector is used by the record functions and by adiStartEnergyDetector. The precise tone detector is used as the cleardown detector by the loop start protocols when the parameter adilps.cleardownflag is set to 1. Otherwise, it is available as tone detector #1 to adiStartToneDetector.
`dtmfe.dsp`	`dtmfe.m54`	`dtmfe.f54`	Is a variation of `dtmf.`*xxx, optimized for use with the echo canceller (`echo.`xxx*). It yields better talk-off resistance but requires the echo canceller to achieve the best cut through performance.
`echo.dsp`	`echo.m54`	`echo.f54`	Contains the echo cancellation function. The echo canceller removes reflected energy from the incoming signal, which improves DTMF detection and voice recognition while playing. Use `echo.`*xxx* if echo cancellation is enabled. See the adiStartProtocol function and the ADISTART_PARMS category. Note: Substitute `dtmfe.`*xxx* for `dtmf.`*xxx* when using the echo canceller.
`g726p.dsp` (play) `g726r.dsp` (record)	`g726.m54`	`g726.f54`	Contains ITU G.726 ADPCM play and record functions. G.726 is a standard for 32 kbs speech coding. Note: These functions require considerably more DSP processing time than the functions in `voice.`*xxx*`.` You will not be able to run as many contexts actively playing or recording as you can with other speech codings.
	`gsm_ms.m54`	`gsm_ms.f54`	Contains play and record functions for MS-GSM speech encoding at 13 kbs (CT Access 4.0 only).
	`gsm_m5pl.m54`	`gsm_m5pl.f54`	This file is identical in operation to gsm_ms.m54 with the exception that maximum output of the play function is limited (CT Access 4.0 only).
`imaply.dsp` (play) `imarec.dsp` (record)	`ima.m54`	`ima.f54`	Contains play and record functions for IMA ADPCM speech encoding, at 24 Kbps or 32 Kbps.
`mf.dsp`	`mf.m54`	`mf.f54`	Contains the Multi-Frequency Receiver function. This function is required for any trunk protocol that uses MF signaling and also by adiStartMFDetector.
`okiply.dsp` (play) `okirec.dsp` (record)	`oki.m54`	`oki.f54`	Contains play and record functions for OKI ADPCM speech encoding, at 24 kbs or 32 kbs.
	`ptf.m54`	`ptf.f54`	Contains precise tone filters. Used as the cleardown detector by loop start protocols. On AG 2000, AG 4000/C, and CG 6000C boards, use it for adiStartToneDetector and adiStartCallProgress.
`rvoice.dsp`	`rvoice.m54`	`rvoice.f54`	Contains PCM play and record functions. `rvoice.`*xxx* is required to play or record with an encoding of ADI_ENCODE_MULAW, ADI_ENCODE_ALAW, or ADI_ENCODE_PCM8M16.
`signal.dsp` (not required on AG Dual/Quad)	`signal.m54` (not required on AG 4000/C)	None	Contains signaling, ring detector and pulse functions. These are out of band functions which typically operate on the MVIP signaling stream. This file is required for any trunk protocol except NOCC. It is also required for adiStartSignalDetector, adiQuerySignalState, and adiStartPulse.
`tone.dsp`	`tone.m54`	`tone.f54`	Contains the tone generation function. This file is required for any trunk protocol except NOCC. It is also required for adiStartTones, adiStartDTMF and adiStartDial, and for any record function to generate the beep.
`voice.dsp`	`voice.m54`	`voice.f54`	Contains NMS ADPCM play and record functions. The compressed speech is in a framed format with 20 milliseconds of data per frame. Speech is compressed to 16, 24, or 32 Kbps or stored as uncompressed mu-law or A-law (64 Kbps). This file is required to play or record with encoding values of ADI_ENCODE_NMS_16, ADI_ENCODE_NMS_24, ADI_ENCODE_NMS_32, or ADI_ENCODE_NMS_64.
`voxp.dsp voxr.dsp`			These files should be substituted for `voice.dsp` in order to apply speed up to NMS ADPCM encoded speech. `voxp.dsp` supports speed-up.
`wavply.dsp` (play) `wavrec.dsp` (record)	`wave.m54`	`wave.f54`	Contains play and record functions for PCM speech in formats commonly used in WAVE files, including 8 and 16 bit 11 kHz sampling.

Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com