Intel Computer Hardware 05-2065-003 User's Manual
Contents
1. OnPlayComplete 38 waitForKey 42 P ParseConfigFile 33 PDL files 29 PDLSetApplicationExitPath 42 PDLsr enbhdlr 42 PDLsr enblhdlr 40 Play 38 ProcessEvent 33 programming model 30 R Record 38 requirements hardware 13 runtime commands keyboard 22 S SetDeviceReceiveSlot 33 34 36 SetFaxHandle 36 SetReceiveSlot 38 source code files 27 SRL events handling 42 starting the demo 21 stopping the demo 25 switches command line 21 system initialization 41 system requirements 13 T threads 39 TSUsrEvent structure 43 U using the media server 22 V voice menu flowchart 24 Voice Module classes 37 VoiceParms 33 50 IP Media Server Global Call Demo Guide August 20052. exits a module Classes This section describes the classes contained in the demo and within each module Each module contains three classes board device and state machine Table 8 Application Classes Class Name CConfig Responsible for parsing configuration file and Interface ParseConfigFile Parses configuration file populating configuration variables in the program ChannelNumber Gets the number of channels that are the minimum of the number of voice lines and the number of IP lines IPParms Returns configured IP parameters VoiceParms Returns configured voice parameters CEventRouter Responsible for connecting all the modules It does the following Maintains routing tables Retrieves event data from the SRL and routes them to modules Gets event process results from the modules and routes them to other modules if the destination is not NONE Init nitializes the IP module and voice module Builds event routing tables Exit Terminates the voice module and IP module ProcessEvent Retrieves event data from Global Call and routes them to a module for processing Routes processing result to other module s for further processing IP Media Server Global Call Demo Guide August 2005 33 Demo Details 34 Table 9 IP Module Classes Category Class Name Interface Module CIPModule Interacts with
3. Main Thread IP Media Server Global Call Demo Guide August 2005 Sub Thread 39 Demo Details 5 4 40 intel 1 The first main thread is created by the demo application to get the keyboard input The threads are created as follows 2 The second thread is an SRL thread created as a result of the demo application calling PDLsr enblhdlr All Global Call events are received through the SRL Initialization This section describes the IP Media Server Global Call demo initialization as shown in Figure 5 A system is started in the following sequence 1 The application creates CConfig to parse the configuration file 2 The application creates CEventRouter to start the Event Router which in turn starts the IP module and the Voice module When a module is started it initializes its boards devices and state machines After all the modules are started the EventRouter starts to build a static routing table that maps voice devices to IP devices It is important that each IP device has a dedicated voice resource so that when an IP channel is connected an incoming call is answered the user can get a voice prompt immediately If the initialization should fails the application shuts down The shutdown sequence is the reverse of the initialization sequence IP Media Server Global Call Demo Guide August 2005 Intel Figure 5 System Initialization 1 Parse cfg file Application
4. Quit 1 2 Send Message Listen Message Prompt Prompt Enter Mailbox Enter Mailbox Number Messa Number ge _ Quit is played Quit Mailbox Mailbox number number Stop Listen Prompt Start Record Prompt 2 Discard message 2 Start Stop Record and quit Quit Save message and quit 2 2 Stop Record Prompt 2 Discard message and re record message to same mailbox 4 3 3 Confirm message 4 Replay message Quit 4 Confirm Message Saved Prompt Confirm message Return to Voice Mail prompt Replay Message Replay Stop Record Prompt IP Media Server Global Call Demo Guide August 2005 4 4 Stopping the Demo The IP Media Server Global Call demo runs until it is terminated Press the demo application IP Media Server Global Call Demo Guide August 2005 Running the Demo 66 99 q or Q to terminate 25 Running the Demo 26 IP Media Server Global Call Demo Guide August 2005 intel Demo Details This chapter discusses the IP Media Server Global Call demo in more detail It contains the following topics Piles Used by the Demo iae e RR KA DEE ORO l b SCORE REOR ER OR 27 Prosmmmmeg Model ss REKE HER BARE BE ices BEE DO N HEES SE RE DEUM REEN 30 QE T cM 39 Mundi is eT 40 e Eyent Hande iocos OCCORRE ER N EE OE EE REES
5. 3 4 3 1 n n Sets the number of channels The lesser of Voice Devices or IP devices q Activates Quality of Service Disabled Example The following example shows how to launch the demo from a command line with options IPMediaServer n64 cmyconfig cfg ea This command launches the demo with 64 channels using the myconfig cfg configuration file and A law encoding Using the Demo This section describes how to use the IP Media Server Global Call demo and contains the following topics Keyboard Commands Using the Media Server Keyboard Commands The demo always waits for input from the keyboard While the demo is running you may enter any of the commands listed in Table 4 Table 4 Runtime Keyboard Commands 4 3 2 22 Command Function q or Q or Ctrl c Terminates the application Using the Media Server The IP Media Server Global Call demo allows the caller to interact with a series of voice menus using the telephone keypad to enter an option Basic operations include playing a pre recorded message recording a new message and barge in for CSP Each menu prompts the caller to select an action by pushing a key The call state within which the menu is called is indicated by the square brackets Figure 1 shows the voice prompt flow grouping the prompts by feature voice CSP Main Menu Main Menu 1 Voice Mail 3 Conferencing not supported in HMP 1 x 4 CSP Barg
6. Call IP Technology Guide Voice API Programming Guide Voice API Library Reference Standard Runtime Library API Programming Guide Standard Runtime Library API Library Reference http developer intel com design telecom support for technical support http www intel com design network products telecom for product information IP Media Server Global Call Demo Guide August 2005 intel Demo Description 1 Note Note This chapter describes the basic features of the IP Media Server Global Call demo The IP Media Server Global Call demo is an object oriented host based application that demonstrates using the Global Call API to build an IP media server providing voice and fax services via IP technology The demo source code can be used as sample code for those who want to begin developing an application from a working application The IP Media Server Global Call demo is limited to a maximum of four simultaneous channels Additionally the channel numbers used must be below 120 the demo will fail to run if you attempt to use a channel number higher than 120 The IP Media Server Global Call demo supports the following features Voice service CSP barge in Configuration file Command line options The IP Media Server Global Call demo does not function as a gateway Therefore it can only answer calls from the IP network Gateway functionality can be added by writing additional software code within the IP
7. Configuration co 2 Start router Start IP Module 4 Start IP Board Event Router IP Module IP Board 5 Start IP Device 7 Start Voice Module IP Device Demo Details 6 Start IP State Machine 8 Start Voice Board Voice Module IP State Machine Voice Board IP Media Server Global Call Demo Guide August 2005 9 Start VoiceDevice Voice Device 10 Start Voice State Machine Voice State Machine 41 Demo Details ntel 5 5 Event Handling This section describes how the IP Media Server Global Call demo handles events It contains the following topics Event Mechanism Handling Keyboard Input Events Handling SRL Events Handling Application Exit Events TSUsrEvent Structure 5 5 1 Event Mechanism The IP Media Server Global Call demo uses the SRL mechanism to retrieve events When an event occurs SRL calls event handlers automatically All events are received by the SRL and then passed to the CallbackHdlr function for handling In the initialization phase of the demo the main function sets up the call back handler by calling PDLsr enbhdlr 5 5 2 Handling Keyboard Input Events There is an endless loop while 0 in the main function in the Main cpp file In that loop the application waits forever for a
8. module that will allow it to make outgoing calls to the IP network and connecting a gateway to interface with the PSTN The IP Media Server Global Call demo is a cross OS demo designed to run under both the Windows and Linux environments Most of the differences in the environments are handled directly by the programming interface and are transparent to the user Other differences due to inherent differences in the operating systems are handled by the Platform Dependency Library PDL For more information about the PDL refer to the source code in the pdl win or pdl linux directories directory IP Media Server Global Call Demo Guide August 2005 11 Demo Description i ntel 12 IP Media Server Global Call Demo Guide August 2005 intel System Requirements 2 This chapter discusses the system requirements for running the IP Media Server Global Call demo It contains the following topics Hardware Requirements ns i k na kbk nan KA Ra RO RR RR RR RR EROR RO OR 13 Software LE N oe is s5 sx OE W n na h EE aa 13 2 1 Hardware Requirements To run the IP Media Server Global Call demo you need One of the following Intel NetStructure DM IP Series board ntel NetStructure IPT Series board also requires an Intel NetStructure DM V A series board for PSTN connection P network cable For other hardware requirements such as memory requirements see the Release Guide for the System
9. the IP Media Server Global Call demo It contains the following topics Stare Me Demo i i a amp KA A l WA QER Re ur e RARE S RR dead 21 Dew ODONIS ustedes ierra Ekra kiy AW EPA EE OD Le N ES Ee RERA zl Usine Wie DER s sa su kon pene yp RP OE RE RE DEE EG ER ME CEN EE 22 Soppe ike DRO osse bek he phe didn ei San Sd RE EER DE DRR EER ido d 25 4 1 Starting the Demo The demo executable file for the IP Media Server Global Call demo can be started as follows Windows From a command prompt window change to the directory INTEL_DIALOGIC_DIR Demos IP MediaServer Release Type IPMediaServer to run the IP Media Server Global Call demo using the default settings Linux Change to the directory INTEL DIALOGIC DIR demos IPMediaServer Release Type IPMediaServer to run the IP Media Server Global Call demo using the default settings 4 2 Demo Options To specify certain options at run time launch the demo from a command line using any of the switches listed in Table 3 Table 3 Command Line Switches Switch Action Default c lt filename gt Configuration file name clPMediaServer cfg e lt encoding type gt Sets the encoding type em e m mu law a A law hor Prints the command syntax to the screen Off IP Media Server Global Call Demo Guide August 2005 Running the Demo ntel amp Table 3 Command Line Switches Continued 4
10. 27 542 PDLEFiles xe ghe duerme bg gg 29 5 2 Programming Model 2da kala a kalan anal lala n dl er rn 30 5 2 1 Module Structure ii kk kk kk kk KK KK KK KK KK KK KK KK KK KK KK KK KK KK KK k 30 5 2 2 EventRouter i cis sa ky kk kla a beue aed a al aa alarak ea ah al eedem iR ues dns 31 523 InterfaCeS ss Wa Xa de ced k eae ceed d a o OE OE EE d ay ab EE 32 5 2 4 Glasses sos cere a del ede e An ea x an Axa a K j n kk a OE ad s 33 6 3 Threads CC Tm 39 5 4 nitialization i s ku Ed kk a la kk a a ja te d la ee Rr RP dad Pon eee dn aes 40 5 5 Event Handling pur emma eem Ue a al wi xa ala glk ana l dol ala ER RR 42 5 5 1 EventMechanisM xa ka a a awa dk kanala alika kia ka ala ar ak nh 42 5 5 2 Handling Keyboard Input Events kk kk KK KK KK eee 42 5 5 3 Handling SRL Events iese kK kK KK KK KK KK KK tae 42 5 5 4 Handling Application Exit Events lille 42 5 5 5 TSUsrEventStructure se Ed Ge Ge ree 43 GIOSSANY AR EE RES EE dene N RE EO ER A PEE ede OES 45 gt gt gt gt 37 gt gt 7 o o e g7nmnnmmmede m mm mb 49 IP Media Server Global Call Demo Guide August 2005 3 Contents ntel Figures oc1 0nm Demo Voice Menu Flowchart kk kk kk kk kk k kk kK kk KK kK KK kk n 24 IP Media Server Global Call Demo Architecture llli 31 Alie DC Se Hj hb OE eee 32 IP Media Server Global Call D
11. 6 3k g729a g729ab t38UDPFax Note if you want to run the demo with coder g729 use g729a for running with VAD disable and 729ab for running with VAD enable Caution f capability is g711Alaw Mulaw gt FramesPerPkt 10 20 30 G711 frame per packet defines milliseconds f capability is g723 5 3k 6 3k gt FramesPerPkt 1 2 3 FrameSize isn t needed defau f capability is gsm gt FramesPerPkt 1 2 3 FrameSize isn t needed defaul f capability is gsmEFR FramesPerPkt 1 2 3 FrameSize isn t needed defau f capability is g729a gt FramesPerPkt 3 4 FrameSize isn t needed defau VAD disable f capability is g729ab gt FramesPerPkt 3 4 FrameSize isn t needed defau VAD enable the VAD parameter HARE AE AEE AE EE AP a EE AE EE AR E AB a AR A AR DB WHD AE AE AEE EE Ea EEE EA EE EEA EA EA EE ABA H ipProtocolName H323 DTMFmode inBand Channel 1 120 Capability TxType g711Alaw TxFramesPerPkt 30 IP Media Server Global Call Demo Guide August 2005 17 Preparing to Run the Demo TxVAD 0 RxType g711Alaw RxFramesPerPkt 30 RxVAD 0 TxType g711Mulaw TxFramesPerPkt 20 TxVAD 0 RxType g711Mulaw RxFramesPerPkt 20 RxVAD 0 TxType t38UDPFax MediaAlarmLostPackets Threshold 20 Threshold value DebounceOn 10000 Threshold debounce ON DebounceOff 10000 Threshold debounce OFF Interval 1000 Threshold Time Interval ms PercentSuccess 60
12. AD Voice Activity Detection IP Media Server Global Call Demo Guide August 2005 47 48 IP Media Server Global Call Demo Guide August 2005 intel Index application classes 33 application exit events 42 C CallbackHdlr 42 CConfig 40 CEventRouter 40 ChannelNumber 33 CheckAndConvertDigits 39 classes 33 application classes 33 IP module classes 34 command line switches 21 commands keyboard 22 compiling and linking 18 configuration files editing 15 Connect 36 38 CreateMailBoxFileName 39 D Disconnect 36 38 E editing configuration files 15 event handling 42 application exit events 42 keyboard input events 42 SRL events 42 TSUsrEvent structure 43 event mechanism 42 EventRouter 31 32 Exit 33 F files used by demo 27 FreeMailBox 39 G gc GetMetaEvent 42 GetDeviceXmitSlot 33 34 GetDigitCount 38 GetDigits 38 GetDigitString 38 GetFaxHandle 36 GetMailBox 39 GetNumOfDevices 33 34 35 GetNumOfDevicesOnBoard 35 GetStoppedReason 38 GetXmitSlot 36 38 H hardware requirements 13 Init 32 initialization 40 InitMailBoxes 39 interfaces 32 IP module classes 34 ipmediaserver cfg configuration file 15 IPParms 33 K keyboard commands 22 keyboard input events handling 42 L linking 18 M main 42 module structure 30 IP Media Server Global Call Demo Guide August 2005 49 O W
13. CIPBoard and ClPDevice Exports IP module functions to CEventRouter Note The public functions in this class can be accessed by classes outside the IP module Init Starts host based IP protocol Creates and initializes IPT virtual board objects Creates and initializes IPM media board objects Creates and initializes IP device objects Exit Terminates and closes IPT boards Terminates and closes IPM boards Terminates and closes IP devices ProcessEvent Receives event data from the event router and distributes them based on handles to IPT boards IPM boards or IP devices GetNumOfDevices Returns number of IP devices engaging in the communication GetDeviceHandle Returns an IP device handle GetDeviceXmitSlot Returns the transmit timeslot of an IP device SetDeviceReceiveSlot Sets the receiving timeslot of an IP device IP Media Server Global Call Demo Guide August 2005 Table 9 IP Module Classes Continued Demo Details Category Class Name Interface Board CIPTBoard Interacts with the Global Call library to handle IP virtual boards Note The public function in this class should only be accessed by classes inside the IP module Init Opens IPT virtual board and sets board parameters Exit Closes IPT virtual board ProcessEvent Processes IPT virtual board events GetNumOfDevicesOnB
14. DeviceReceiveSlot Sets IP device receiving timeslot SetFaxHandle Gets fax device handle associated with the device GetFaxHandle Returns fax device handle associated with the device State Machine CIPStateMachine Handles IP events and maintains IP state machine s Note The public functions in this class should only be accessed by the classes inside the IP module Init Initializes the IP state machine Exit Terminates the IP state machine ProcessEvent Processes IP call events IP Media Server Global Call Demo Guide August 2005 Table 10 Voice Module Classes Demo Details Category Class Name Interface Module Board CVoiceModule Interacts with CVoiceBoard and CVoiceDevice Exports Voice module functions to CEventRouter Note The public functions in this class can be accessed by classes outside the Voice module CVoiceBoard Interacts with the voice library to handle voice boards Note The public function in this class should only be accessed by classes inside the Voice module Init Opens and initializes voice board objects Opens and initializes voice device objects Exit Terminates and closes voice boards Terminates and closes voice devices ProcessEvent Receives event data from the event router and distributes them based on devicehandles to voice boards or voice devices for processi
15. E 42 5 1 Files Used by the Demo This section lists the files used by the IP Media Server Global Call demo It contains the following information Demo Source Code Files PDL Files 5 1 1 Demo Source Code Files In Windows the IP Media Server Global Call demo files listed in Table 5 are located within INTEL DIALOGIC DIRNDemosMPMediaServer In Linux the IP Media Server Global Call demo files listed in Table 5 are located within INTEL_DIALOGIC_DIR demos IP MediaServer Table 5 Files in IPMediaServer Folder Used by the IP Media Server Global Call Demo Sub Directory if any File Name Purpose CConfig cpp Implements the operations of the Configuration class CConfig h Function prototype for config cpp CEventRouter cpp Implements the operations of the EventRouter class CEventRouter h Function prototype for ceventrouter cpp IPMediaServer dsp Visual C project file IPMediaServer dsw Visual C project workspace main cpp Contains the main function and the WaitForKey main h Function prototype for main cpp makefile Top level make file Linux only IP Media Server Global Call Demo Guide August 2005 27 Demo Details 28 intel Table 5 Files in IPMediaServer Folder Used by the IP Media Server Global Call Demo Sub Directory if any File Name Purpose Release unavConf vox Voice file Release cspPro
16. PDL Visual C project workspace makefile PDL make file Linux only release psl win lib Compiled PDL library 5 2 Programming Model This section describes the IP Media Server Global Call demo architecture in the following topics Module Structure EventRouter Interfaces Classes 5 2 1 Module Structure The IP Media Server Global Call demo uses a modular architecture in which each technology IP voice CSP is wrapped inside a module so that a particular technology can be easily added or removed The system contains two modules P module that serves as the front end to communicate with the IP network Voice module to provide voice service The system also contains a software component the EventRouter to connect the modules The basic architecture of the system is illustrated in Figure 2 30 IP Media Server Global Call Demo Guide August 2005 Figure 2 IP Media Server Global Call Demo Architecture IP Module Voice Module Board Device State Machine Board Device State Machine EventRouter User Module Board Device State Machine Each module is composed of four elements Board Device State Machine call control Wrapper Demo Details The Wrapper acts like a manager receiving requests from the EventRouter and distributin
17. RNDemosMPMediaServerNRelease Linux INTEL DIALOGIC DIR demos IPMediaServer Release where INTEL DIALOGIC DIR identifies the base installation directory for the software 3 1 2 Editing the IPMediaServer cfg Configuration File Below is an example of the PMediaServer cfg file Update the following information ipProtocolName The IP protocol for opening IP line devices Possible vlues are H323 SIP both DTMFmode Specifies how DTMF tones are transmitted Possible values are OutofBand usually used with low bandwith coders such as GSM Note OutofBand is used for H 323 only IP Media Server Global Call Demo Guide August 2005 15 Preparing to Run the Demo intel InBand usually used with G 711 coders RFC2833 Capability Describes the transmit and receive coders See the Global Call IP Technology Guide for specific information about coder support The parameters are as follows TxType the transmit voice coder TxFramesPerPkt the number of frames per packet for the selected Tx coder e TxVAD specifies if VAD is active for the selected Tx coder RxType the receive voice coder RxFramesPerPkt the number of frames per packet for the selected Rx coder Note The G 711 coder defines frames per packet using the packet size in milliseconds i e 10 20 or 30 milliseconds Refer to the Sample Configuration File below for the correct syntax for all the parameters RxVAD specifies if VAD is act
18. Threshold Success Percent PercentFail 40 Threshold Fail Percent MediaAlarmJitter Threshold 60 Threshold value DebounceOn 20000 Threshold debounce ON DebounceOff 60000 Threshold debounce OFF Interval 5000 Threshold Time Interval ms PercentSuccess 60 Threshold Success Percent PercentFail 40 Threshold Fail Percent MediaAlarmResetAlarmState 0 3 2 Compiling and Linking Compile the IP Media Server Global Call demo project within one of the following environments Windows To compile the IP Media Server Global Call demo on a Windows system use Microsoft Visual Studio 6 0 with Service Pack 5 Set IPMediaServer as the active project and build 18 IP Media Server Global Call Demo Guide August 2005 n ntel Preparing to Run the Demo Linux To compile the IP Media Server Global Call demo on a Linux system use gcc version 3 2 3 To compile the entire project go to the directory INTEL_DIALOGIC_DIR demos IPMediaServer and issue the commands make clean make To compile an individual module go to the specific module directory for example NTEL DIALOGIC DIR ydemos IPMediaServer Modules FaxModule for the fax module and issue the commands make clean make IP Media Server Global Call Demo Guide August 2005 Preparing to Run the Demo 20 IP Media Server Global Call Demo Guide August 2005 intel Running the Demo This chapter discusses how to run
19. e in Quit IP Media Server Global Call Demo Guide August 2005 Running the Demo Voice Mail Menu Voicemail Menu Record Message 2 Listen to message from a mailbox Quit Send Message Prompt SendMsg Menu Enter Mailbox Number between 101 299 Quit Start Record Prompt Record Menu 2 Start Record Press 2 at end of message to stop recording at end Stop Record Prompt is played Quit Stop Record Prompt StopRec Menu 2 Discard Message and re record message to same mailbox 3 Confirm Message Save Confirm 4 Listen to Message and replay Stop Record Prompt Quit without saving Confirm Message Saved StopRec Menu Record a message 2 Listen to a message from a mailbox Quit Listen to Message Prompt ListenMsg Menu Enter Mailbox Number between 101 299 Recorded message is played Quit Stop Listen Prompt Listening 2 Discard message and quit Save message and quit CSP Prompt CSP Menu Say something to barge in new file will be created with barged in message or press any DTMF IP Media Server Global Call Demo Guide August 2005 23 Running the Demo 24 Figure 1 Demo Voice Menu Flowchart 4 CSP Prompt Say something to barge in Quit Main Menu Select one of the following 1 Voice Mail __ 4 CSP Quit Voice Mail Prompt 1 Record Message 2 Listen to message n from a mailbox
20. ed Audience This guide is intended for application developers who will be developing a media server application using the Global Call API Developers should be familiar with the C programming language and either the Windows or Linux programming environment This information is intended for Distributors Toolkit Developers ndependent Software Vendors ISVs Value Added Resellers VARs Original Equipment Manufacturers OEMs How to Use This Publication Refer to this publication after you have installed the hardware and the system software This publication assumes that you are familiar with the Windows or Linux operating system and the C programming language The information in this guide is organized as follows Chapter 1 Demo Description introduces you to the demo and its features IP Media Server Global Call Demo Guide August 2005 n About This Publication ntel Chapter 2 System Requirements outlines the hardware and software required to run the demo Chapter 3 Preparing to Run the Demo describes the preparations required before running the demo Chapter 4 Running the Demo describes how to run the demo Chapter 5 Demo Details provides details on how the demo works Related Information See the following for more information the Release Guide for your Intel Dialogic System Release the Configuration Guide for your Intel NetStructure DM IP series or IPT series board Global
21. emo Threads kk kk kK KK KK KK KK KK KK KK KRI KK ee 39 System Initialization i kk kk kk kK kK KK KK KK KK mm KK KK k 41 IP Media Server Global Call Demo Guide August 2005 ntel Contents Tables O Q0 N 9 OI HOND IP Media Server Global Call Demo Guide August 2005 Quality of Service Parameter Defaults for DM IP Series Boards 000 0 eae 16 Quality of Service Parameter Defaults for IPT Series Boards kK REKE 17 Command Line Switches 0 0 0 0 kk kk kk kk kk KK KK KK kk KK kK KK kK kK kk KK kK kk KK ee se 21 Runtime Keyboard Commands kk kk kk kk kk KK KK KK KK KK KK KK KK KK KK kK KK kk kK kk k 22 Files in IPMediaServer Folder Used by the IP Media Server Global Call Demo 27 Files in Modules Folder Used by the IP Media Server Global Call Demo 28 PDL Files Used by the IP Media Server Global Call Demo lille KRA 30 Application Classes al k ka d ka lh a lk en AME kk emere 33 IP Module ClaASS6 S cases kk kk kik eed EX RS ERA ae Race KOR OK OR pd Race PEG xa ed kk KUR N 34 0 Voice Module Classes kk kk kk kk kk kk KK kk KK kK KK KK kK kK kK kK kK kK kK KK kK kk KK KK KK ke 37 Contents ntel 6 IP Media Server Global Call Demo Guide August 2005 intel Revision History This revision history summarizes the changes made in each published version of this document Document No Publication Date Descript
22. etXmitSlot Returns voice device transmit timeslot SetReceiveSlot Sets voice device receiving timeslot IP Media Server Global Call Demo Guide August 2005 Table 10 Voice Module Classes Continued Demo Details Category Class Name Interface State Machine CVoiceStateMachine Handles voice events and maintains voice state machine s Note The public functions in this class should only be accessed by the classes inside the voice module Init Opens vox files Creates mailbox utility object that manages mailboxes Exit Closes vox files Deletes mailbox utility object that manages mailboxes ProcessEvent Processes voice events Misc CMailBoxUtil Provides utility function to manage mailboxes Note The public functions in this class should only be accessed by the classes inside the voice module InitMailBoxes Initializes mailboxes CheckAndConvertDigits Checks if the extension number is in allowed range If it is converts it into an integer GetMailBox Checks if the mailbox is ready to be used If it is gets the mailbox CreateMailBoxFileName Creates a filename for the mailbox FreeMailBox Frees the mailbox for future use 5 3 Threads The IP Media Server Global Call demo operates with two threads as shown in Figure 4 Figure 4 IP Media Server Global Call Demo Threads Keyboard
23. g the request to the boards or devices A device can have one or multiple state machines attached to it Each state machine represents one call 5 2 2 EventRouter The EventRouter is responsible for communicating with the modules It does the following Maintains routing tables Retrieves event data from the SRL and routes it to a module for processing Forwards event process result to another module if so requested IP Media Server Global Call Demo Guide August 2005 31 Demo Details ntel Figure 3 EventRouter Retrieve event data from GC library Forward result to destination For which technology IP Module Voice Module result Yes result No result destination 5 2 3 Interfaces The modular architecture implements a unified interface that allows replacement of modules by including new header files and adjusting routing statements A module is treated by the EventRouter as a block box It has three types of APIs Initialization e Init for initializing a module 32 IP Media Server Global Call Demo Guide August 2005 5 2 4 Demo Details e GetNumOfDevices returns the number of devices available to the application GetDeviceHandle returns a device handle GetDeviceXmitSlot returns a device transmit timeslot SetDeviceReceiveSlot sets a device receive timeslot Runtime ProcessEvent processes event data Termination Exit
24. intel IP Media Server Global Call Demo Guide August 2005 05 2065 003 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS NO LICENSE EXPRESS OR IMPLIED BY ESTOPPEL OR OTHERWISE TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT 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 products are not intended for use in medical life saving life sustaining critical control or safety systems or nuclear facility applications Intel may make changes to specifications and product descriptions at any time without notice This IP Media Server Global Call Demo Guide as well as the software described in it is furnished under license and may only be used or copied in accordance with the terms of the license The information in this manual is furnished for informational use only is subject to change without notice and should not be construed as a commitment by Intel Corporation Intel Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software that may be provided in association with this docume
25. ion of Revisions 05 2065 003 August 2005 Globally added Linux specific filenames paths and commands Globally updated paths to use environment variables for installation base directory Demo Description chapter Added note about channel density and numbering restrictions Editing the IPMediaServer cfg Configuration File section Updated descriptions of QoS attributes to match IPML API Reference Updated sample config file Using the Media Server section Added CSP Barge in to Main Menu listing Corrected description of CSP Prompt Demo Voice Menu Flowchart figure Corrected description of CSP Prompt 05 2065 002 November 2003 Removed all references to fax which is not supported in System Release version of demo 05 2065 001 September 2003 Initial version of document IP Media Server Global Call Demo Guide August 2005 Revision History ntel 8 IP Media Server Global Call Demo Guide August 2005 intel About This Publication This section describes the purpose of the guide the intended audience and provides references to other documents that may be useful to the user Purpose ntended Audience How to Use This Publication Related Information Purpose This guide provides information on the IP Media Server Global Call demo that is provided with Intel Dialogic System Release 6 1 The guide describes the demo its requirements and provides details on how it works Intend
26. ive for the selected Rx coder Quality of Service The application can set threshold values to monitor the quality of service during calls A fault occurs when the result of a measurement of a QoS parameter crosses a predefined threshold A success occurs when the result of a measurement of a QoS parameter dis not cross a predefined threshold The QoS parameters are measured during time intervals starting when a call is established The following parameters are supported MediaAlarmLostPackets monitors the number of lost IP packets during a call supported for IPT series boards only e MediaAlarmJitter monitors the jitter as defined in RFC 1889 during IP transmission QoS Attributes The threshold for each QoS parameter is measured with the following six attributes Threshold defines when a QoS parameter is in a fault condition A fault occurs when the result of a measurement of a QoS parameter crossed the Threshold value DebounceOn the time during which faults are measured in msec must be multiple of Interval DebounceOff the time during which successes are measured in msec must be multiple of Interval Interval the amount of time between two QoS parameter measurements in multiples of 100 msec Percent Fail used to detect failure condition together with DebounceOn expressed as a percentage of failures Percent Success used to detect failure recovery together with DebounceOff expressed as a percentage of
27. keyboard event by calling the waitForKey function The event must be handled immediately and event specific information should be retrieved before the next call to waitForKey 5 5 3 Handling SRL Events When the R4 Global Call event is received the application performs the following 1 Get METAEVENT by calling gc GetMetaEvent 2 Get channel ID through device handle to channel mapping 3 Get device type through device handle to type mapping 4 Route meta event to the module specified by device type 5 5 4 Handling Application Exit Events Normal application exit events such as pressing either q or Q don t enter the SRL The main function calls PDLSetA pplicationExitPath before initialization In Linux this function sets the signals SIGINT SIGTERM SIGABRT for making the appropriate exit from the application In Windows this function enables the detection of CTRL CLOSE EVENT closing the window 42 IP Media Server Global Call Demo Guide August 2005 In 5 5 5 Demo Details TSUsrEvent Structure The TSUsrEvent structure is used by the demo modules to return event processing results to the event router The TSUserEvt structure is defined as follows typedef struct int event TDeviceType destination int lineDevice long xmitSlot long neighborDevice char dialString MAX STRING LENGTH TSUserEvent The fields of the TSUserEvt structure are described as follows event the na
28. me of a user defined event such as USR CONNECTED etc destination the name of the module that this event is destined for Possible vavues are IP VOICE or NONE lineDevice the device handle in this module It will be later used by the Event Router as an index to find its counterpart in the destination module xmitSlot an integer that normally indicates a time slot number neighborDevice the neighbor device handle dialString a char string that is normally filled with a DTMF dialing string IP Media Server Global Call Demo Guide August 2005 43 Demo Details 44 IP Media Server Global Call Demo Guide August 2005 intel Glossary Codec see COder DECoder COder DECoder A circuit used to convert analog voice data to digital and digital voice data to analog audio Computer Telephony CT Adding computer intelligence to the making receiving and managing of telephone calls DTMF Dual Tone Multi Frequency Dual Tone Multi Frequency A way of signaling consisting of a push button or touch tone dial that sends out a sound consisting of two discrete tones that are picked up and interpreted by telephone switches either PBXs or central offices Emitting Gateway called by a G3FE It initiates IFT service for the calling G3FE and connects to a Receiving Gateway E1 The 2 048 Mbps digital carrier system common in Europe FCD file An ASCII file that lists any non default parameter settings that are necessary to co
29. merica Typically channeled into 24 digital subscriber level zeros DSOs each capable of carrying a single voice conversation or data stream T1 uses two pairs of twisted pair wires TCP see Transmission Control Protocol Terminal An H 323 Terminal is an endpoint on the local area network which provides for real time two way communications with another H 323 terminal Gateway or Multipoint Control Unit This communication consists of control indications audio moving color video pictures and or data between the two terminals A terminal may provide speech only speech and data speech and video or speech data and video Transmission Control Protocol The TCP IP standard transport level protocol that provides the reliable full duplex stream service on which many application protocols depend TCP allows a process on one machine to send a stream of data to a process on another It is connection oriented in the sense that before transmitting data participants must establish a connection UDP see User Datagram Protocol UDPTL Facsimile UDP Transport Layer protocol User Datagram Protocol The TCP IP standard protocol that allows an application program on one machine to send a datagram to an application program on another machine Conceptually the important difference between UDP datagrams and IP datagrams is that UDP includes a protocol port number allowing the sender to distinguish among multiple destinations on the remote machine V
30. mile Transfer IP Media Server Global Call Demo Guide August 2005 45 intel International Telecommunications Union ITU An organization established by the United Nations to set telecommunications standards allocate frequencies to various uses and hold trade shows every four years Internet An inter network of networks interconnected by bridges or routers LANs described in H 323 may be considered part of such inter networks Internet Protocol IP The network layer protocol of the transmission control protocol Internet protocol TCP IP suite Defined in STD 5 Request for Comments RFC 791 It is a connectionless best effort packet switching protocol Internet Service Provider ISP A vendor who provides direct access to the Internet Internet Telephony The transmission of voice over an Internet Protocol IP network Also called Voice over IP VoIP IP telephony enables users to make telephone calls over the Internet intranets or private Local Area Networks LANs and Wide Area Networks WANs that use the Transmission Control Protocol Internet Protocol TCP IP ITU See International Telecommunications Union Jitter The deviation of a transmission signal in time or phase It can introduce errors and loss of synchronization in high speed synchronous communications NIC Network Interface Card Adapter card inserted into computer that contains necessary software and electronics to enable a station to communicate ove
31. mpt vox Voice file Release errorinput vox Voice file Release IPMediaServer cfg Demo configuration file Release IPMediaServer exe Demo executable Release listenMenu vox Voice file Release mainMenu vox Voice file Release savecCnfirm vox Voice file Release sendfaxMenu vox Voice file Release sendMsg vox Voice file Release startRec vox Voice file Release stopListen vox Voice file Release stopRec vox Voice file Release thankYou vox Voice file Release unavCsp vox Voice file Release unavFax vox Voice file Release unavMenu vox Voice file Release voicemailMenu vox Voice file In Windows the IP Media Server Global Call demo files listed in Table 6 are located within INTEL DIALOGIC DIRNDemosMPMediaServerNModules In Linux the IP Media Server Global Call demo files listed in Table 6 are located within INTEL DIALOGIC DIR demos IPMediaServer Modules Table 6 Files in Modules Folder Used by the IP Media Server Global Call Demo Sub Directory File Name Purpose common Defines h Definitions and structures for the demo common Interfaces h Interfaces used in the demo common Parameters h Parameters used in the demo common makefile Module make file Linux only IPModule CIPDevice cpp Implements the operations of the CIPDevice class IPModule CIPDevice h Function prototype for cipdevice cpp IPModule CIPMBoard cpp Implements the operations of the CIPMBoard class IPModule CIPMBoard h Function pro
32. nction prototype for cvoiceboard cpp VoiceModule CVoiceDevice cpp Implements the operations of the CVoiceDevice class VoiceModule CVoiceDevice h Function prototype for cvoicedevice cpp VoiceModule CVoiceModule cpp Implements the operations of the CVoiceModule class VoiceModule CVoiceModule h Function prototype for cvoicemodule cpp VoiceModule CVoiceStateMachine cpp Implements the operations of the CVoiceStateMachine class VoiceModule CVoiceStateMachine h Function prototype for cvoicestatemachine cpp VoiceModule VoiceModule dsp Visual C project file VoiceModule makefile Module level make file Linux only VoiceModule Release or VoiceModule Release VoiceModule lib Compiled Voice Module library PDL Files In Windows the PDL files listed in Table 7 are located within the directory INTEL_DIALOGIC_DIR Demos Shared pdl_win In Linux the PDL files listed in Table 7 are located within the directory INTEL_DIALOGIC_DIR demos Shared pdl_Linux IP Media Server Global Call Demo Guide August 2005 29 Demo Details n Table 7 PDL Files Used by the IP Media Server Global Call Demo Sub Directory if any File Name Purpose iptransport cpp PDL IP transport functions iptransport h Function prototype for iptransport cpp pdl c Platform dependency functions pdl h Function prototype for pdl c pdl ver PDL version information pdl win dsp PDL Visual C project file pdl win dsw
33. nfigure a DM3 hardware firmware product for a particular feature set The downloader utility reads this file and for each parameter listed generates and sends the DM3 message necessary to set that parameter value Frame A set of SCbus CT Bus timeslots which are grouped together for synchronization purposes The period of a frame is fixed at 125 usec so that the number of time slots per frame depends on the SCbus CT Bus data rate G3FE Group 3 Fax Equipment A traditional fax machine with analog PSTN interface Gatekeeper An H 323 entity on the Internet that provides address translation and control access to the network for H 323 Terminals and Gateways The Gatekeeper may also provide other services to the H 323 terminals and Gateways such as bandwidth management and locating Gateways Gateway A device that converts data into the IP protocol It often refers to a voice to IP device that converts an analog voice stream or a digitized version of the voice into IP packets H 323 A set of International Telecommunication Union ITU standards that define a framework for the transmission of real time voice communications through Internet protocol IP based packet switched networks The H 323 standards define a gateway and a gatekeeper for customers who need their existing IP networks to support voice communications IAF Internet Aware Fax The combination of a G3FE and a T 38 gateway IFP Internet Facsimile Protocol IFT Internet Facsi
34. ng Init Opens voice board Exit Closes voice board ProcessEvent Processes voice board events IP Media Server Global Call Demo Guide August 2005 37 Demo Details 38 Table 10 Voice Module Classes Continued Category Class Name Interface Device CVoiceDevice Handles voice device operations such as playing recording tone detection and tone generation Holds CVoiceStateMachine Note The public functions in this class should only be accessed by classes inside the Voice module Init Opens the voice device If successful creates voice state machine Exit Deletes the voice state machine from the voice device Closes voice device ProcessEvent Processes voice device events Connect Allows IP device to listen to its receiving timeslot Play Plays a vox file OnPlayComplete Replays a vox file when it has finished playing Record Records voice to a vox file GetDigits Retrieves DTMF digits GetDigitCount Returns the number of retrieved DTMF digits GetDigitString Returns retrieved DTMF string Connect Allows the voice device to listen to its receiving timeslot Disconnect Allows voice device to unlisten to its receiving timeslot GetStoppedReason Tells why a played voice file stops GetDeviceHandle Returns voice device handle G
35. nt Except as permitted by such license no part of this document may be reproduced stored in a retrieval system or transmitted in any form or by any means without the express written consent of Intel Corporation Copyright O 2003 Intel Corporation Celeron Dialogic Intel Intel logo Intel NetStructure Intel Xeon IPLink and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries Other names and brands may be claimed as the property of others Publication Date August 2005 Document Number 05 2065 003 Intel Converged Communications Inc 1515 Route 10 Parsippany NJ 07054 For Technical Support visit the Intel Telecom Support Resources website at http developer intel com design telecom support For Products and Services Information visit the Intel Telecom and Compute Products website at http www intel com design network products telecom For Sales Offices and other contact information visit the Buy Telecom Products page at http www intel com buy networking telecom htm IP Media Server Global Call Demo Guide August 2005 intel Contents Revision History i255 sk sk Reo a a a k don kk ak ea e a OR UA RR A RADAR an De aa 7 About This Publication kk kk kk kk kK kK KK kk KK KK KK KK KK kK KK KK kK kk kk e 9 1 Demo Description 2 2 0 05 neu kk kk EER e kk KK KK KK kk KK RA kk kk kk kk kk lk kk kk kk kk ka 11 2 System Req
36. oard Returns the number of IPT devices signaling devices on the board CIPMBoard Interacts with the Global Call library to handle IP media boards Note The public functions in this class should only be accessed by classes inside the IP module Init Opens IP media boards Exit Closes IP media boards ProcessEvent Processes IP media board events GetNumOfDevices Returns number of IPM devices on the board IP Media Server Global Call Demo Guide August 2005 35 Demo Details 36 Table 9 IP Module Classes Continued Category Class Name Interface Device CIPDevice Handles IP device operations such as making dropping calls sending H 323 messages making timeslot connections etc Holds CIPStateMachine or call control Note The public functions in this class should only be accessed by classes inside the IP module Init Opens an IP device If successful creates an IP state machine If QoS is enabled creates a media alarm object Exit Deletes IP state machine Deletes media alarm object Closes IP devices ProcessEvent Processes IP device events Connect Allows IP device to listen to its receiving timeslot Disconnect Allows IP device to unlisten to its receiving timeslot GetDeviceHandle Returns IP device handle GetXmitSlot Returns IP device transmit timeslot Set
37. r network PCD file An ASCII text file that contains product or platform configuration description information that is used by the DM3 downloader utility program Each of these files identifies the hardware configuration and firmware modules that make up a specific hardware firmware product Each type of DM3 based product used in a system requires a product specific PCD file PSTN see Public Switched Telephone Network Public Switched Telephone Network The telecommunications network commonly accessed by standard telephones key systems Private Branch Exchange PBX trunks and data equipment Reliable Channel A transport connection used for reliable transmission of an information stream from its source to one or more destinations Reliable Transmission Transmission of messages from a sender to a receiver using connection mode data transmission The transmission service guarantees sequenced error free flow controlled transmission of messages to the receiver for the duration of the transport connection RTCP Real Time Control Protocol RTP Real Time Protocol SIP Session Initiation Protocol an Internet standard specified by the Internet Engineering Task Force IETF in RFC 3261 SIP is used to initiate manage and terminate interactive sessions between one or more users on the Internet 46 IP Media Server Global Call Demo Guide August 2005 intel T1 A digital transmission link with a capacity of 1 544 Mbps used in North A
38. release you are using 2 2 Software Requirements To run the IP Media Server Global Call demo as documented in this guide you need the Intel Dialogic System Software 6 1 or later For a list of operating system requirements see the Release Guide for the system release you are using See Section 3 2 Compiling and Linking on page 18 for a list of compilers that may be used with this demo Using a non supported compiler may cause unforeseen problems in running the demo IP Media Server Global Call Demo Guide August 2005 13 n System Requirements ntel 14 IP Media Server Global Call Demo Guide August 2005 intel Preparing to Run the Demo 3 This chapter discusses the preparations necessary to run the IP Media Server Global Call demo It provides information about the following topics Editing Configuration PIS s wa ka ha RR d e ed s ala 15 Vompilias and LIKING Louisa N OE EO e FERRE 18 3 1 Editing Configuration Files This section discusses how to configure the demo for your system It contains the following topics Configuration File Location Editing the IPMediaServer cfg Configuration File 3 1 1 Configuration File Location Before running the IP Media Server Global Call demo modify the PMediaServer cfg file to reflect your system environment Use a text editor and open the file from the following location Windows INTEL DIALOGIC DI
39. successes The default values are as follows Table 1 Quality of Service Parameter Defaults for DM IP Series Boards QoS Type Fault Threshold Time Debounce Debounce Success Fail yp Interval ms On ms Off ms Threshold Threshold Jitter 60 ms 5000 20000 60000 40 40 IP Media Server Global Call Demo Guide August 2005 Preparing to Run the Demo Table 2 Quality of Service Parameter Defaults for IPT Series Boards QoS T Fault Time Debounce Debounce Success Fail Threshold 1 Interval ms On ms Off ms Threshold Threshold Jitter 30 ms 0 n a 0 n a 0 n a 0 n a 0 n a Lost Packets 100 96 0 n a 0 n a 0 n a 0 n a 0 n a Notes 1 Units for Fault Threshold are different for different QoS Types See unit indications in table cells Sample Configuration File SIP both the packet size in lt 30ms t 20ms lt 20ms lt 10ms the VAD parameter is ignored lt 10ms is ignored B U AT AAT ARE AE AE AP AE AEAEE HE RA HARE AE AEE AEE AE FE AE AE AE AE AEA AB AEE EAR AE AE AEE APA EEE AE AE E EB EE A EE EE EA EAE EE HA HA DWA EEE EEA EE HA D EE EEA EE ERA RA IP Protocol The IP Protocol used for opening the IP Line devices values H323 DTMFmode possible options OutOfBand inband rfc2833 Capability posiblities g711Alaw g711Mulaw gsm gsmEFR g723 5 3k g723
40. totype for cipmboard cpp IPModule CIPModule cpp Implements the operations of the CIPModule class IPModule CIPModule h Function prototype for cipmodule cpp IP Media Server Global Call Demo Guide August 2005 Demo Details Table 6 Files in Modules Folder Used by the IP Media Server Global Call Demo Continued 5 1 2 Sub Directory File Name Purpose IPModule CIPStateMachine cpp Implements the operations of the CIPStateMachine class IPModule CIPStateMachine h Function prototype for cipstatemachine cpp IPModule CIPTBoard cpp Implements the operations of the CIPTBoard class IPModule CIPTBoard h Function prototype for ciptboard cpp IPModule CMediaAlarms cpp Implements the operations of the CMediaAlarms class IPModule CMediaAlarms h Function prototype for cmediaalarms cpp IPModule IPModule dsp Visual C project file IPModule makefile Module level make file Linux only IPModuleWelease or IPModule lib Compiled IP Module library IPModule Release VoiceModule CCSPDevice cpp Implements the operations of the CCSPDevice class VoiceModule CCSPDevice h Function prototype for ccdspdevice cpp VoiceModule CMailBoxBtil cpp Implements the operations of the CMailBoxUtil class VoiceModule CMailBoxUtil h Function prototype for cmailboxutil cpp VoiceModule CVoiceBoard cpp Implements the operations of the voiceBoard class VoiceModule CVoiceBoard h Fu
41. uirements kk kk kk kK kK kK KK KK KK KK rre 13 2 1 Hardware Requirements i s kk kk kK kk KK kK KI kk kk kk kk kk kk kk kk kk kk kk ka 13 2 2 Software Requirements kk kk kk kk kK KK KK KK KK KK KK KK KK KK KK KK KK KK kK kk kk 13 3 Preparing to Run the Demo kk kk kk kK kk KK KK KK KK KK KK KK KK s 15 3 1 Editing Configuration Files kk kK kk KK KK KK KK KK meh 15 3 1 1 Configuration File Location i e kK KK KK KK KK KK ae 15 3 1 2 Editing the IPMediaServer cfg Configuration File llle 15 3 2 Compiling and Linking kk kk kk KK KK KK KK KK KI KK KK Im 18 4 Running th Demo ERENS kal kk l k al ewes peed kk k n kk es EE dee ed 21 4 1 Startingthe Demo ii kk kk kk kK KK KK KK KK KK KK KK KK KK KK kK kK kK kK KK kK kk kk 21 4 2 DemoOptions sescca loue kk aa mr an ue av a X G a lk ai al al eee li su lt d rin On 21 43 Usingthe DEMO a wa k Aks kalk xalek la kd arda RR ren 22 4 3 1 Keyboard CommandsS ie kk kk kK KK KK KK KK KK KK KK KK KK KK KK k 22 4 3 2 Using the Media Server ii kk kK KK KK KK KK KI KK KK KK KK K KK KK KK KK K 22 4 4 Stopping the Demo slsssssesssse seme 25 5 Demo Details ctos ER RR dne aux d Kekan E e ada l Peed Kl gis bed GER Kad 27 5 1 Files Used by the Demo a a ll kak lk kelk ik tee eee 27 5 1 1 Demo Source Code Files kK kk KK KK KK KK KK KK ae
Download Pdf Manuals
Related Search