Summary of the content on the page No. 1
®
Intel IXP400 Digital Signal
Processing (DSP) Software
Version 2.5
API Reference Manual
December 2004
Document Number: 273811-007a
Summary of the content on the page No. 2
® INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER, AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY RELATING TO SALE AND/OR USE OF INTEL PRODUCTS, INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT, OR OTHER INTELLECTUAL PROPERTY RIGHT. Intel Corporation may hav
Summary of the content on the page No. 3
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Contents 1.0 Introduction ............................................................................................................ 7 1.1 General............................................................................................................ 7 1.2 Scope .............................................................................................................. 7 1.3 Audience .....................................
Summary of the content on the page No. 4
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 6.8 Tone Detector Receive-FSK Message...........................................................32 6.9 Tone Detector FSK-Receive-Completed Message ........................................33 6.10 Player-Start Message.....................................................................................33 6.11 Player Play-Completed Message...................................................................34 6.12 Get-Jitter-Buffer-St
Summary of the content on the page No. 5
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Revision History Date Revision Description December 2004 008 Updated product branding. ® Further updates for the release of Intel IXP400 DSP Software September 2004 007 v2.5. Change bars indicate areas of change. ® June 2004 006 Updates for the release of Intel IXP400 DSP Software v2.5. ® Updates for the release of Intel IXP400 DSP Software January 2004 005 Version 2.4. Clarified input for XStatus_t xMsgReceive message Septem
Summary of the content on the page No. 6
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 This page intentionally left blank. 6 API Reference Manual
Summary of the content on the page No. 7
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Introduction 1.0 Introduction ® The Intel IXP400 DSP Software v2.5 is a software module that provides the basic voice processing functionalities for VoIP residential gateway applications. It can be viewed as a completed media pro- cessing layer with control and data interfaces as its API. This document defines the API specifications. 1.1 General ® The Intel IXP400 DSP Software is a software module for media processing, targete
Summary of the content on the page No. 8
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Introduction NLP Non-linear Processing (for EC) SP Signal Processing VAD Voice Activity Detection 8 API Reference Manual
Summary of the content on the page No. 9
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Architectural Overview 2.0 Architectural Overview ® Intel IXP400 DSP Software is implemented as an independent module having its own tasks and runtime environment. The software architecture is of a two-layer hierarchy – a control layer that pro- vides the control interface and control logic, and a data processing layer where the media data streams are processed by appropriate algorithms. Figure 1 shows the architecture of the
Summary of the content on the page No. 10
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components 3.0 Media Processing Resource Components ® As shown in Figure 1, the addressable control entities of Intel IXP400 DSP Software are media processing resource (MPR) components similar to those defined in many Intel Dialogic compute te- lephony system architecture. There are nine resource components, working together to provide all the media processing needed by a gateway or server channel. E
Summary of the content on the page No. 11
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components Parameters Direct Identifier Description, Values Attr. Write XPARMID_RES_STATE Current state (0: idle, 1: active) R N The L-Port stream ID. Default: the stream assigned to the IP termination’s T- XPARMID_NET_LP_STREAM R/W N Port of the same channel if exist, otherwise –1. PCM data format on HSS TDM bus. XPARM_NET_ALAW or XPARM_NET_MULAW. XPARMID_NET_LAW R/W N Default: XPARM_NET_MULAW EC en
Summary of the content on the page No. 12
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components Media Processing Functions • Decoding • Automatic level control and/or volume control • Comfort noise generation • Jitter compensation Resource-Specific Control Messages • XMSG_CODER_START (inbound) • XMSG_CODER_STOP_ACK (outbound) Parameters Direct Identifier Description and Values Attr. Write XPARMID_RES_STATE Current state (0: idle, 1: active) R N Decoder volume adjustment; +15 ~ -40 in 1-
Summary of the content on the page No. 13
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components Direct Identifier Description and Values Attr. Write RTP payload type for G.726 40-Kbps coder. The payload type is negotiated and set by the call stack. The range of values is 96 to XPARMID_DEC_G726_40_RTP_PLD R/W Y 127. Default: 96 RTP payload type for G.726 32-Kkbps coder, The payload type is negotiated and set by the call stack. The range of values is 96 to XPARMID_DEC_G726_32_RTP_PLD
Summary of the content on the page No. 14
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components Parameters Direct Identifier Description and values Attr. Write XPARMID_RES_STATE Current state (0: idle, 1: active) R N L-Port stream ID. Default: the stream assigned to the TDM termination’s XPARMID_ENC_LP_STREAM R/W N T-Port of the same channel if exist, otherwise –1. AGC enable flag. XPARM_ON or XPARM_OFF. XPARMID_ENC_AGC R/W N Default: XPARM_OFF VAD enable flag. XPARM_ON or XPARM_OFF.
Summary of the content on the page No. 15
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components 3.4 Tone Generation Resource Component Resource Type: XMPR_TNGEN Media Processing Functions • Generating multiple frequency tone signals • Generating call progress tones Resource-Specific Control Messages • XMSG_TG_PLAY (inbound) • XMSG_TG_PLAY_FSK (inbound) • XMSG_TG_PLAY_CMPLT (outbound) Parameters Direct Identifier Description and values Attr. Write XPARMID_RES_STATE Current state (0: idl
Summary of the content on the page No. 16
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components 3.5 Tone Detection Resource Component Resource Type: XMPR_TNDET Media Processing Functions • Receiving DTMF digits • Detecting individual tone event Resource-Specific Control Messages • XMSG_TD_RCV (inbound) • XMSG_TD_RCV_FSK (inbound) • XMSG_TD_RCV_CMPLT (outbound) • XMSG_TD_RCV_FSK_CMPLT (outbound) Parameters Direct Identifier Description and values Attr. Write XPARMID_RES_STATE Curren
Summary of the content on the page No. 17
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components Direct Identifier Description and values Attr. Write Minimum CS-bit length required by FSK receiver. Default: 200 XPARMID_TD_FSK_CS if country code set to COUNTRY_CODE_US or R/W Y COUNTRY_CODE_PRC, otherwise 0. Minimum mark-bit length required by FSK receiver. Default: XPARMID_TD_FSK_MARK 100 if country code set to COUNTRY_CODE_US or R/W Y COUNTRY_CODE_PRC, otherwise 60. Extra stop bits al
Summary of the content on the page No. 18
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components Media Processing Functions Mixing multiple audio streams for three-way call or small audio conference. The maximum number of parties to the mixer is currently five. Resource-Specific Control Messages None. Parameters Direct Identifier Description and values Attr. Write XPARMID_RES_STATE Current state (0: idle, 1: active) R N XPARMID_MIX_LP_STREAM The first L-Port stream ID. Default: –1 R/W
Summary of the content on the page No. 19
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Media Processing Resource Components Direct Identifier Description and Values Attr. Write Method of modem rate negotiation. XPARM_T38_RATE_NEG_LOCAL or XPARM_T38_RATE_NEG_REMOTE. XPARMID_T38_RATE_NEG R/W N Default:XPARM_T38_RATE_NEG_REMOTE if packet transferred over UDP, otherwise XPARM_T38_RATE_NEG_LOCAL TCF error threshold (in percentage). XPARAID_T38_TCF_THRSHLD R/W N Default: 5 Protocol used to transfer T.38 packets ov
Summary of the content on the page No. 20
® Intel IXP400 Digital Signal Processing (DSP) Software Version 2.5 Message Format and Delivery Mechanism 4.0 Message Format and Delivery Mechanism There are two message queues (in-bound and out-bound) for the user application to send control messages and to receive response and event messages, respectively. The message queues are created from pre-allocated memory buffers in consideration of maximum message size and total number of messages. The entire message header and content are copied to
