background image

40

IP Media Server for HMP Demo Guide — July 2005

Demo Details

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.

Figure 5. System Initialization

Application

Configuration

Event Router

1. Parse .cfg file

2. Start router

Voice Module

Voice Board

Voice State

Machine

Voice Device

7. Start Voice Module

8. Start Voice Board

9. Start VoiceDevice

10. Start Voice State

Machine

IP Module

IP Board

IP State Machine

IP Device

11. Start IP Module

12. Start IP Board

13. Start IP Device

14. Start IP State Machine

Fax Module

Fax Board

Fax State Machine

Fax Device

3. Start Fax Module

4. Start Fax Board

5. Start Fax Device

6. Start Fax State Machine

Summary of Contents for IP Media Server

Page 1: ...IP Media Server for Host Media Processing Demo Guide July 2005 05 2389 003...

Page 2: ...iation with this document 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 express written...

Page 3: ...arting the Demo 19 4 2 Demo Options 19 4 3 Using the Demo 20 4 3 1 Keyboard Commands 20 4 3 2 Using the Media Server 20 4 4 Stopping the Demo 24 5 Demo Details 25 5 1 Files Used by the Demo 25 5 1 1 D...

Page 4: ...dia Server Demo Threads 39 5 System Initialization 40 6 Typical Scenario Call Offered 43 7 Typical Scenario Play Prompts 44 8 Typical Scenario Fax Mailbox 45 9 Typical Scenario Establish Fax Session 4...

Page 5: ...e Keyboard Commands 20 3 Files in IPMediaServer Folder Used by the IP Media Server Demo 25 4 Files in Modules Folder Used by the IP Media Server Demo 26 5 PDL Files Used by the IP Media Server Demo 28...

Page 6: ...6 IP Media Server for HMP Demo Guide July 2005 Contents...

Page 7: ...e Requirements section Added HMP 1 2 Linux and HMP 1 1 Windows FP1 releases with description of differences Configuration File Location section Added location info for Linux Editing the IPMediaServer...

Page 8: ...8 IP Media Server for HMP Demo Guide July 2005 Revision History...

Page 9: ...plemented and supplied in the Host Media Processing Software 1 3 for Windows Host Media Processing Software 1 5 for Linux and later releases Note that the IP Media Server demo that is supplied with In...

Page 10: ...eparing 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 wor...

Page 11: ...supports the following features Voice service Fax service CSP barge in Configuration file Command line options Note The IP Media Server for HMP demo does not function as a gateway Therefore it can on...

Page 12: ...12 IP Media Server for HMP Demo Guide July 2005 Demo Description...

Page 13: ...are using CD ROM drive VGA display Pointing device e g mouse 100Base T network interface card NIC Note A 1000Base T NIC will yield better performance Memory Requirements For production purposes a mini...

Page 14: ...in this guide you need one of the following software releases Intel NetStructure Host Media Processing Software 1 3 for Windows or later Intel NetStructure Host Media Processing Software 1 5 for Linux...

Page 15: ...File Location Before running the IP Media Server for HMP demo modify the IPMediaServer cfg file to reflect your system environment Use a text editor and open the file from the following location Wind...

Page 16: ...ult 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...

Page 17: ...e packet size in milliseconds If capability is g723_5_3k 6_3k FramesPerPkt 1 2 3 FrameSize isn t needed default 30ms If capability is gsm FramesPerPkt 1 2 3 FrameSize isn t needed default 20ms If capa...

Page 18: ...centFail 40 Threshold Fail Percent MediaAlarmResetAlarmState 0 3 2 Compiling and Linking Compile the IP Media Server demo project within one of the following environments Windows To compile the IP Med...

Page 19: ...R Demos IPMediaServer Release Type IPMediaServer to run the IP Media Server for HMP demo using the default settings Linux Change to the directory INTEL_DIALOGIC_DIR demos IPMediaServer Release Type IP...

Page 20: ...ice menus using the telephone keypad to enter an option Basic operations include playing a pre recorded message recording a new message sending or receiving a fax and barge in for CSP Each menu prompt...

Page 21: ...t 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...

Page 22: ...n 101 299 Quit Fax Sent Prompt Fax_Sent_Menu Announces that fax was sent and repeats Fax Menu 1 Send fax 2 Receive fax Quit Receive Fax Menu Receive_Fax_Menu Dial fax number between 101 299 Quit Fax R...

Page 23: ...e and re record message to same mailbox 3 Confirm message 4 Replay message Quit Confirm Message Saved Prompt Confirm message Return to Voice Mail prompt 3 Replay Message Replay Stop Record Prompt 4 2...

Page 24: ...24 IP Media Server for HMP Demo Guide July 2005 Running the Demo 4 4 Stopping the Demo The IP Media Server demo runs until it is terminated Press q or Q to terminate the demo application...

Page 25: ...re located within INTEL_DIALOGIC_DIR Demos IPMediaServer In Linux the IP Media Server demo files listed in Table 3 are located within INTEL_DIALOGIC_DIR demos IPMediaServer Table 3 Files in IPMediaSer...

Page 26: ...file Release receivefaxMenu 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 V...

Page 27: ...tions 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 Fu...

Page 28: ...operations of the CVoiceStateMachine class VoiceModule CVoiceStateMachine h Function prototype for cvoicestatemachine cpp VoiceModule VoiceModule dsp Visual C project file VoiceModule makefile Module...

Page 29: ...m also contains a software component the EventRouter to connect the modules The basic architecture of the system is illustrated in Figure 2 Figure 2 IP Media Server Demo Architecture Each module is co...

Page 30: ...intains 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 Figure 3 EventRouter Retrieve event da...

Page 31: ...tDeviceReceiveSlot sets a device receive timeslot Runtime ProcessEvent processes event data Termination Exit exits a module 5 2 4 Classes This section describes the classes contained in the demo and w...

Page 32: ...le 7 IP Module Classes Category Class Name Interface Module CIPModule Interacts with CIPBoard and CIPDevice Exports IP module functions to CEventRouter Note The public functions in this class can be a...

Page 33: ...essEvent Processes IPT virtual board events GetNumOfDevicesOnBoard Returns the number of IPT devices signaling devices on the board CIPMBoard Interacts with the Global Call library to handle IP media...

Page 34: ...nect 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 trans...

Page 35: ...s 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...

Page 36: ...P 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 Get...

Page 37: ...ts 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...

Page 38: ...ate machine from the fax device Closes fax device SetIott Sets up iott for the fax file SetFaxState Sets initial fax state before fax transmission SendFax Starts to send a fax file RecvFax Starts to r...

Page 39: ...ation 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 Rou...

Page 40: ...he application shuts down The shutdown sequence is the reverse of the initialization sequence Figure 5 System Initialization Application Configuration Event Router 1 Parse cfg file 2 Start router Voic...

Page 41: ...the Main cpp file In that loop the application waits forever for a keyboard event by calling the waitForKey function The event must be handled immediately and event specific information should be retr...

Page 42: ...D USR_SENDFAX etc destination the name of the module that this event is destined for Possible vavues are IP VOICE FAX or NONE lineDevice the device handle in this module It will be later used by the E...

Page 43: ...e GCEV_OFFERED GCEV_OFFERED GCEV_OFFERED GCEV_EXTENSIONCMPLT GCEV_EXTENSIONCMPLT GCEV_EXTENSIONCMPLT GCEV_CONNECTED GCEV_CONNECTED GCEV_CONNECTED call gc_extension to get call related information Call...

Page 44: ...nu CVoiceDevice CVoiceState Machine USR_CONNECTED USR_CONNECTED 1 Call dx_listen to listen to IP device 2 Call dx_play to play Main_Menu TDX_PLAY TDX_PLAY Call dx_getdig to detect digits TDX_GETDIG 2...

Page 45: ...s requested to send a fax Figure 8 Typical Scenario Fax Mailbox CEventRouter CIPModule CFaxModule USR_SENDFAX 101 CFaxDevice CFaxState Machine USR_SENDFAX 101 source FAX destination IP event USR_ESTAB...

Page 46: ...ion CEventRouter CIPModule CIPDevice CIPState Machine 1 Call gc_setConfigData to set to manual fax mode 2 Call gc_unlisten to disconnect from voice 3 Call gc_setUserInfo to set T 38 info 4 Call gc_ext...

Page 47: ...stablished Figure 10 Typical Scenario Fax Session Established CEventRouter CIPModule CFaxModule CFaxDevice CFaxState Machine source FAX destination IP event USR_CLOSEFAX SESSIONREQ Format TSUserEvent...

Page 48: ...dule CIPDevice CIPState Machine 1 Call gc_stop to stop T 38 session 2 Call gc_extension to start audio session 3 Call gc_listen listen to voice prompts USR_CLOSEFAXSESSIONREQ USR_CLOSEFAXSESSIONREQ US...

Page 49: ...hat a fax has been sent Figure 13 Typical Scenario Fax Complete CEventRouter CIPModule CFaxModule CFaxDevice CFaxState Machine USR_CLOSEFAXSESSIONCONF USR_CLOSEFAXSESSIONCONF source FAX destination VO...

Page 50: ...50 IP Media Server for HMP Demo Guide July 2005 Demo Details...

Page 51: ...lue Frame A set of SCbus CT Bus timeslots which are grouped together for synchronization purposes The period of a frame is fixed at 125 sec so that the number of time slots per frame depends on the SC...

Page 52: ...Network Interface Card Adapter card inserted into computer that contains necessary software and electronics to enable a station to communicate over network PCD file An ASCII text file that contains p...

Page 53: ...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 applicati...

Page 54: ...54 IP Media Server for HMP Demo Guide July 2005...

Page 55: ...on exit events 41 keyboard input events 41 SRL events 41 TSUsrEvent structure 42 event mechanism 41 EventRouter 30 Exit 31 F Fax module classes 37 FaxParms 31 files used by demo 25 FreeMailBox 37 G gc...

Page 56: ...te 49 fax mailbox 45 fax sent 48 fax session closed 49 fax session established 47 play prompts 44 SendFax 38 SetDeviceReceiveSlot 31 32 34 SetFaxFileName 38 SetFaxHandle 34 SetFaxState 38 SetIott 38 S...

Reviews: