Intel IP Media Server Demo Manual

Ip media server for host media processing

Advertisement

Quick Links

IP Media Server for Host Media
Processing
Demo Guide
July 2005
05-2389-003

Advertisement

Table of Contents
loading

Summary of Contents for Intel IP Media Server

  • Page 1 IP Media Server for Host Media Processing Demo Guide July 2005 05-2389-003...
  • Page 2 Intel may make changes to specifications and product descriptions at any time, without notice. This IP Media Server for Host Media Processing 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.
  • Page 3: Table Of Contents

    Index ..............55 IP Media Server for HMP Demo Guide – July 2005...
  • Page 4 IP Media Server Demo Architecture ........
  • Page 5 Files in IPMediaServer Folder Used by the IP Media Server Demo ..... 25 Files in Modules Folder Used by the IP Media Server Demo ......26 PDL Files Used by the IP Media Server Demo .
  • Page 6 Contents IP Media Server for HMP Demo Guide – July 2005...
  • Page 7: Revision History

    05-2389-002 April 2005 05-2389-001 September 2004 IP Media Server for HMP Demo Guide — July 2005 Description of Revisions Added updated Linux information. Globally changed file paths to use installation directory environment variable, and to reflect latest Windows directory hierarchy Globally removed Linux-specific information and references to pre-1.3 HMP releases...
  • Page 8 Revision History IP Media Server for HMP Demo Guide — July 2005...
  • Page 9: About This Publication

    • • Related Information Purpose This guide provides information on the IP Media Server for HMP demo that is available with the ® Intel NetStructure its requirements, and provides details on how it works. This guide specifically documents the IP Media Server for HMP demo as it is implemented and supplied in the Host Media Processing Software 1.3 for Windows*, Host Media Processing...
  • Page 10 (for technical support) (for product information) IP Media Server for HMP Demo Guide — July 2005...
  • Page 11: Demo Description

    • Command line options Note: The IP Media Server for HMP 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 module that will allow it to make outgoing calls to the IP network, and connecting a gateway to interface with the PSTN.
  • Page 12 Demo Description IP Media Server for HMP Demo Guide — July 2005...
  • Page 13: System Requirements

    System Requirements This chapter discusses the system requirements for running the IP Media Server for HMP demo. It contains the following topics: • Hardware Requirements ..........13 •...
  • Page 14: Software Requirements

    System Requirements Software Requirements To run the IP Media Server for HMP demo as documented 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 (or later) For operating system requirements, see the release documentation (Release Guide or Release Notes) that accompanies your specific HMP release.
  • Page 15: Preparing To Run The Demo

    Preparing to Run the Demo This chapter discusses the preparations necessary to run the IP Media Server for HMP demo. It provides information about the following topics: • Editing Configuration Files ..........15 •...
  • Page 16 The default values are as follows: QoS Type Threshold Lost packets Jitter Sample Configuration DebounceOn DebounceOff Interval 10000 10000 1000 20000 60000 5000 IP Media Server for HMP Demo Guide — July 2005 TxType = t38UDPFax File, below, for the Percent_ Percent_ Fail Success...
  • Page 17 RxType = g711Mulaw RxFramesPerPkt = 20 RxVAD = 0 TxType = t38UDPFax IP Media Server for HMP Demo Guide — July 2005 Preparing to Run the Demo opening the IP Line devices, values: H323, SIP, both ==> FramesPerPkt = 10,20,30.
  • Page 18: Compiling And Linking

    Compile the IP Media Server demo project within one of the following environments: Windows To compile the IP Media Server demo on a Windows system, use Microsoft* Visual Studio* 6.0 with Service Pack 5. Set IPMediaServer as the active project and build.
  • Page 19: Running The Demo

    Running the Demo This chapter discusses how to run the IP Media Server for HMP demo. It contains the following topics: • Starting the Demo ........... . . 19 •...
  • Page 20: Using The Demo

    4.3.2 Using the Media Server The IP Media Server for HMP 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, sending or receiving a fax, and barge-in for CSP. Each menu prompts the caller to select an action by pushing a key.
  • Page 21 Enter Mailbox Number - between 101 - 299 (Recorded message is played) * - Quit Stop Listen Prompt [Listening] 2 - Discard message and quit * - Save message and quit IP Media Server for HMP Demo Guide — July 2005...
  • Page 22 Running the Demo Fax Menu [Fax_Menu] 1 - Send fax (to the IP Media Server demo) 2 - Receive fax (sent from the IP Media Server demo) * - Quit Send Fax Prompt [Send_Fax_Menu] Dial fax number - between 101 - 299...
  • Page 23: Demo Voice Menu Flowchart

    * - Quit Fax Sent Prompt Announces fax sent Repeat Fax menu IP Media Server for HMP Demo Guide — July 2005 Main Menu Select one of the following: 1 - Voice Mail 2 - Fax...
  • Page 24: Stopping The Demo

    Running the Demo Stopping the Demo The IP Media Server demo runs until it is terminated. Press “q” or “Q” to terminate the demo application. IP Media Server for HMP Demo Guide — July 2005...
  • Page 25: Demo Details

    Demo Details This chapter discusses the IP Media Server for HMP demo in more detail. It contains the following topics: • Files Used by the Demo..........25 •...
  • Page 26: Files In Modules Folder Used By The Ip Media Server Demo

    Release Release Release Release In Windows, the IP Media Server demo files listed in Table 4 are located within: $(INTEL_DIALOGIC_DIR)\Demos\IPMediaServer\Modules In Linux, the IP Media Server demo files listed in Table 4 are located within: $(INTEL_DIALOGIC_DIR)/demos/IPMediaServer/Modules Table 4. Files in Modules Folder Used by the IP Media Server Demo...
  • Page 27 Table 4. Files in Modules Folder Used by the IP Media Server Demo (Continued) Sub-Directory FaxModule FaxModule FaxModule FaxModule FaxModule FaxModule FaxModule FaxModule\Release or FaxModule/Release IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule IPModule\Release or...
  • Page 28: Pdl Files

    In Linux, the PDL files listed in Table 5 are located within the directory: $(INTEL_DIALOGIC_DIR)/demos/Shared/pdl_Linux Table 5. PDL Files Used by the IP Media Server Demo Sub-Directory (if any) release Programming Model This section describes the IP Media Server for HMP demo architecture in the following topics: • Module Structure • EventRouter Interfaces •...
  • Page 29: Module Structure

    5.2.1 Module Structure The IP Media Server for HMP demo uses a modular architecture, in which each technology (IP, voice, fax, CSP)) is wrapped inside a module so that a particular technology can be easily added or removed. The system contains three modules: •...
  • Page 30: Eventrouter

    Figure 3. EventRouter IP Module Retrieve event data from GC library For which technology? Voice Voice Module result result result.destination = NONE ? IP Media Server for HMP Demo Guide — July 2005 Forward result to destination Fax Module result...
  • Page 31: Interfaces

    Table 6. Application Classes Class Name CConfig • Responsible for parsing configuration file and populating configuration variables in the program. IP Media Server for HMP Demo Guide — July 2005 Demo Details Interface ParseConfigFile( ) • Parses configuration file ChannelNumber( ) •...
  • Page 32: Ip Module Classes

    Class Name CEventRouter. be accessed by classes outside the IP module. IP Media Server for HMP Demo Guide — July 2005 Interface Interface Init( ) • Starts host based IP protocol • Creates and initializes IPT (virtual) board objects •...
  • Page 33 Note: The public function in this class CIPMBoard • Interacts with the Global Call library to Note: The public functions in this class IP Media Server for HMP Demo Guide — July 2005 Class Name handle IP virtual boards should only be accessed by classes inside the IP module.
  • Page 34 IP module. state machine(s) should only be accessed by the classes inside the IP module. IP Media Server for HMP Demo Guide — July 2005 Interface Init( ) • Opens an IP device. If successful, creates an IP state machine. If QoS is enabled, creates a media alarm object.
  • Page 35: Voice Module Classes

    CVoiceBoard • Interacts with the voice library to handle voice boards Note: The public function in this class IP Media Server for HMP Demo Guide — July 2005 Class Name be accessed by classes outside the Voice module. should only be accessed by classes inside the Voice module.
  • Page 36 Note: The public functions in this class Class Name should only be accessed by classes inside the Voice module. IP Media Server for HMP Demo Guide — July 2005 Interface Init( ) • Opens the voice device. If successful, creates voice state machine.
  • Page 37: Fax Module Classes

    • Interacts with CFaxDevice. • Exports Fax module functions to Note: The public functions in this class can IP Media Server for HMP Demo Guide — July 2005 Class Name should only be accessed by the classes inside the voice module.
  • Page 38 Fax module sending fax, receiving fax, etc. should only be accessed by classes inside the Fax module. IP Media Server for HMP Demo Guide — July 2005 Interface Init( ) • Open fax board. Exit( ) •...
  • Page 39: Threads

    • Handles fax events and maintains fax Note: The public functions in this class Threads The IP Media Server for HMP demo operates with two threads, as shown in Figure 4. Figure 4. IP Media Server Demo Threads Keyboard Main Thread The threads are created as follows: 1.
  • Page 40: System Initialization

    9. Start VoiceDevice 11. Start IP Module 12. Start IP Board IP Module 13. Start IP Device IP Media Server for HMP Demo Guide — July 2005 Fax Board Fax Device 6. Start Fax State Machine Fax State Machine Voice Board Voice Device 10.
  • Page 41: Event Handling

    5.5.1 Event Mechanism The IP Media Server 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.
  • Page 42: Tsusrevent Structure

    DTMF dialing string Typical Scenario This section describes a typical scenario for sending a fax, which involves all the IP Media Server demo modules. Call Offered When an incoming call is received by the server, the IP module answers the call until the call is connected.
  • Page 43: Typical Scenario: Call Offered

    Figure 6. Typical Scenario: Call Offered CEventRouter CIPModule GCEV_OFFERED GCEV_EXTENSIONCMPLT GCEV_CONNECTED IP Media Server for HMP Demo Guide — July 2005 CIPState CIPDevice Machine GCEV_OFFERED GCEV_OFFERED call gc_extension( ) to get call related GCEV_EXTENSIONCMPLT information GCEV_EXTENSIONCMPLT Call gc_AnswerCall( ) GCEV_CONNECTED...
  • Page 44: Typical Scenario: Play Prompts

    CIPState CIPDevice Machine USR_CONNECTED TDX_PLAY (finish playing main menu) TDX_GETDIG (press "2" to play fax menu) TDX_GETDIG (press "1" to play send fax menu) IP Media Server for HMP Demo Guide — July 2005 CVoiceState CVoiceModule CVoiceDevice Machine USR_CONNECTED USR_CONNECTED 1.
  • Page 45: Typical Scenario: Fax Mailbox

    The user selects to send a fax to mailbox “101”. The Fax module is requested to send a fax. Figure 8. Typical Scenario: Fax Mailbox CEventRouter CIPModule IP Media Server for HMP Demo Guide — July 2005 CFaxModule USR_SENDFAX "101" USR_SENDFAX...
  • Page 46: Typical Scenario: Establish Fax Session

    3. Call gc_setUserInfo( ) to set T.38 info. 4. Call gc_extension( ) to start T.38 session GCEV_EXTENSION Format TSUserEvent to reply to fax module that T.38 session is established source=IP destination=FAX event= USR_ESTABLISHF AXSESSIONCONF IP Media Server for HMP Demo Guide — July 2005...
  • Page 47: Typical Scenario: Fax Session Established

    The Fax module gets a reply from the front end that the fax session has been established. Figure 10. Typical Scenario: Fax Session Established CEventRouter CIPModule IP Media Server for HMP Demo Guide — July 2005 CFaxModule USR_ESTABLISHFAXSESSIONCONF TFX_FAXSEND Demo Details...
  • Page 48: Typical Scenario: Fax Sent

    2. Call gc_extension ( ) to start audio session 3. Call gc_listen( ) listen to voice prompts GCEV_EXTENSION Format TSUserEvent to reply to fax module that T.38 session is closed source=IP destination=FAX event= USR_CLOSEFAX SESSIONCONF IP Media Server for HMP Demo Guide — July 2005...
  • Page 49: Typical Scenario: Fax Session Closed

    Fax Complete The Voice module gets a reply from the Fax module that a fax has been sent. Figure 13. Typical Scenario: Fax Complete CEventRouter CIPModule IP Media Server for HMP Demo Guide — July 2005 CFaxModule USR_CLOSEFAXSESSIONCONF USR_CLOSEFAXSESSIONCONF CIPState...
  • Page 50 Demo Details IP Media Server for HMP Demo Guide — July 2005...
  • Page 51: Glossary

    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 Facsimile Transfer IP Media Server for HMP Demo Guide — July 2005...
  • Page 52 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. IP Media Server for HMP Demo Guide — July 2005...
  • Page 53 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. VAD: Voice Activity Detection IP Media Server for HMP Demo Guide — July 2005...
  • Page 54 IP Media Server for HMP Demo Guide — July 2005...
  • Page 55: Index

    EventRouter 30 Exit( ) 31 Fax module classes 37 FaxParms( ) 31 files, used by demo 25 IP Media Server for HMP Demo Guide — July 2005 FreeMailBox( ) 37 gc_GetMetaEvent( ) 41 GetDeviceXmitSlot( ) 31 GetDigitCount( ) 36 GetDigits( ) 36...
  • Page 56 39 ToLower_String( ) 38 TSUserEventProcessEvent( ) 37 TSUsrEvent structure 42 using the media server 20 voice menu flowchart 23 Voice Module classes 35 VoiceParms( ) 31 waitForKey( ) 41 IP Media Server for HMP Demo Guide — July 2005...

Table of Contents