Intel IP Media Server manual

IP Media Server f or Host Media Pr ocessing Demo Guide Ju ly 2005 05-2389-00 3[...]

IP Media Server for HMP D emo Guide – July 2005 INFORMA TION IN THIS DO CUMENT IS PRO VIDED IN CONNECTION WITH INTEL® PRODUCTS. NO LICENSE, EX PRESS OR IMPLIED , BY EST OPPEL OR O THER WISE, T O ANY INTELLECTU AL PR OPER TY RIGHTS IS GRANTED BY THIS DOCUMENT . EXCEPT AS PR O VIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, I[...]

IP Media Server for HMP De mo Guide – July 2005 3 Contents Revision H istory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 1 Demo D[...]

4 IP Media Server for HMP D emo Guide – July 2005 Contents Figures 1 Demo Voice M enu Flowchar t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 2 IP Media S erver Demo Ar chitecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 3 EventRouter[...]

IP Media Server for HMP De mo Guide – July 2005 5 Contents Ta b l e s 1 Command Line Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 2 Runtime Key board Com mands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 3 Files in I[...]

6 IP Media Server for HMP D emo Guide – July 2005 Contents[...]

IP Media Server for HMP Demo Gu ide — July 2005 7 Re vision Histor y This re vision history summarizes the changes made in each published vers ion of this document. Document No. Publication Date Description of Revisions 05-2389-003 July 2005 Added updated Linux information. 05-2389-002 April 2005 Globally c hanged file paths to use installation d[...]

8 IP Media Server for HMP Demo Guide — July 2005 Revisi on History[...]

IP Media Server for HMP Demo Gu ide — July 2005 9 About This Pub lication This section describes the purpose of the guide, th e intended audience, and provides references to other documents that may be useful to the user . • Purpose • Intended Audience • How to Use This Publication • Related Information Purpose This guide provides informa[...]

10 IP Media Server for HMP Demo Guide — July 2005 About This Public ation How to Use This Pub lication Refer to this publication after you have installed the hardware and the system software. This publication assumes that you are familiar with the W i ndows or Linux operating system and the C++ programming language. The information in this guide [...]

IP Media Server for HMP Demo Gu ide — July 2005 11 1 1 . Demo Description This chapter describes the basic features of the IP Media Serv er for HMP demo. The IP Media Server for HMP demo is an object-o riented host-based application that demonstrates using the Global Call API to build an IP media server , providing voice and f ax services via IP [...]

12 IP Media Server for HMP Demo Guide — July 2005 Demo Description[...]

IP Media Server for HMP Demo Gu ide — July 2005 13 2 2 . System Requirements This chapter discusses the system requirements fo r running the IP Media Server for HMP demo. It contains the following topics: • Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 • Software Requi[...]

14 IP Media Server for HMP Demo Guide — July 2005 System Requireme nts 2.2 Software Requirements T o run the IP Media Serv er for HMP demo as documented in this guide, you need one of the following software releases: • Intel NetStruc ture Host Media Processi ng Softw are 1.3 for W indo ws (or later) • Intel NetStructure Host Media Processing [...]

IP Media Server for HMP Demo Gu ide — July 2005 15 3 3 . Preparing to Run the Demo This chapter discusses the prepar ations necessary to run the IP Media Server for HMP demo. It provides information about the following topics: • Editing Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .[...]

16 IP Media Server for HMP Demo Guide — July 2005 Preparing to Run the Demo • InBand – usually used with G.711 coders • RFC2833 Capability Describes the transmit and recei ve coders. See the Global Call IP T echnology Guide for specific information about coder suppor t. The parameters are as follows: • TxT ype – the transmit voice coder[...]

IP Media Server for HMP Demo Gu ide — July 2005 17 Preparing to Run th e Demo Sample Confi guration File ############## ########### ############## ########### ############## ########### ########### ########## # IP Protocol : # The IP Pr otocol used for opening the IP Line devices, valu es: H323, S IP, both # # DTMFmode # possib le options: # OutO[...]

18 IP Media Server for HMP Demo Guide — July 2005 Preparing to Run the Demo MediaAlar mLostPacket s { Thres hold = 20 # Thre shold value Debou nceOn = 10000 # Thre shold debou nce ON Debou nceOff = 10000 # Thre shold debou nce OFF Inter val = 1000 # Thre shold Time Interval (ms) Perce ntSuccess = 60 # Thre shold Succe ss Percent Perce ntFail = 40[...]

IP Media Server for HMP Demo Gu ide — July 2005 19 4 4 . Running the Demo This chapter discusses how to run the IP Media Server for HMP dem o. It contains the fo llowing topics: • Starting the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 • Demo Options . . . . . . . . . . . [...]

20 IP Media Server for HMP Demo Guide — July 2005 Running the Demo Example The follo wing example sho ws 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 th e myconfig.cfg configuration f ile and A-law encoding. 4.3 Using the Demo This section des[...]

IP Media Server for HMP Demo Gu ide — July 2005 21 Running the Demo Main Menu [Main_Men u] 1 - V oice Mail 2 - Fax 3 - Conferencing (not supported in HMP 1.x) 4 - CSP Bar ge-in * - Quit V oice Mail Menu [V oicemail_Menu] 1 - Record Message 2 - Listen to message from a mailbox * - Quit Send Message Prompt [SendMsg_Men u] Enter Mailbox Number - bet[...]

22 IP Media Server for HMP Demo Guide — July 2005 Running the Demo Fa x Menu [F ax_Menu] 1 - Send fax (to the IP Media Server demo) 2 - Recei ve fax (sent from the IP Media Serv er demo) * - Quit Send Fax Pr ompt [Send_Fax_Menu] Dial fax number - between 101 - 299 * - Quit F ax Sent Prompt [F ax_Sent_Menu] Announces that fax was sent and repeats [...]

IP Media Server for HMP Demo Gu ide — July 2005 23 Running the Demo Figure 1. Demo V oice Menu Flowc har t Main Menu Select one of the follo wing: 1 - V oice Mail 2 - F ax 4 - CSP * - Quit V oice Mail Prompt 1 - Record Message 2 - Listen to message from a mailbox * - Quit 1 Listen Message Prompt Enter Mailbox Number (Message is play ed) * - Quit [...]

24 IP Media Server for HMP Demo Guide — July 2005 Running the Demo 4.4 Stopping the Demo The IP Media Serv er demo runs until it is term inated. Press “q” or “Q” to terminate the demo application.[...]

IP Media Server for HMP Demo Gu ide — July 2005 25 5 5 . Demo Details This chapter discusses the IP Medi a Server for HMP demo in more detail. It contain s the following topics: • Files Used b y the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 • Programming Model . . . . . . . . . .[...]

26 IP Media Server for HMP Demo Guide — July 2005 Demo Details In W indows, the IP Media Server demo f iles listed in T able 4 are located within: $(INTEL_DI ALOGIC_DIR) DemosIPMediaServer Modules In Linux, the IP Media Server demo file s lis t ed in T able 4 are located within: $(INTEL_DI ALOGIC_DIR )/de mos/IPMediaServer/ Modules Release 200[...]

IP Media Server for HMP Demo Gu ide — July 2005 27 Demo Details F axModule CFaxDe vice.h Function prototype for cf axdevice.cpp F axModule CFaxModule.cpp Implements the operations of the CF axModule class F axModule CFaxModule.h Function prototype for cf axmodule.cpp F axModule CFaxStateMachine.cpp Implements the operations of the CF axStateMachi[...]

28 IP Media Server for HMP Demo Guide — July 2005 Demo Details 5.1.2 PDL Files In W indows, the PDL f iles listed in T a ble 5 are located within the directory: $(INTEL_DIALOGIC_DIR )DemosSharedpdl_win In Linux, the PDL files listed in T able 5 are located within the direct ory: $(INTEL_DI ALOGIC_DIR )/ demos/Shared /pdl_Linux 5.2 Pr ogramming[...]

IP Media Server for HMP Demo Gu ide — July 2005 29 Demo Details 5.2.1 Module Structure The IP Media Server for HMP demo uses a modular architecture, in which each technology (IP , voice, f ax, CSP)) is wrapped inside a modu le so that a particular technology can be easily added or remov ed. The system contains three modules: • IP module that se[...]

30 IP Media Server for HMP Demo Guide — July 2005 Demo Details 5.2.2 EventRouter The EventRouter is responsible for communicating with the modu les. It does the following: • Maintains routing tab les • Retrie ves ev ent data from the SRL and routes it to a module for processing • Forwards e vent process result to another modu le if so reque[...]

IP Media Server for HMP Demo Gu ide — July 2005 31 Demo Details 5.2.3 Interfaces The modular architect ure implements a unified interf ace that allo ws replacement of modules by including new header f iles and adjusting routing statem ents. A module is treated by the EventRouter as a block box. It has three types of APIs: Initialization • Init([...]

32 IP Media Server for HMP Demo Guide — July 2005 Demo Details CEventRouter Responsible f or connecting all the modules. It does the follo wing: • Maintains routing tables • Retriev es ev ent data from the SRL and routes them to modules • Gets e vent process results from the modules and routes them to other modul es if the destination is no[...]

IP Media Server for HMP Demo Gu ide — July 2005 33 Demo Details Board CIPTBoard • Interacts with the Global Call library to handle IP vir tual boards Note: The public function in this class should only be accessed by classes inside the IP module. Init( ) • Opens IPT (vir tual) board and sets board parameters Exit( ) • Closes IPT (vir tual) [...]

34 IP Media Server for HMP Demo Guide — July 2005 Demo Details Device CIPDevice • Handles IP device oper ations, such as making/dropping call s, 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. I[...]

IP Media Server for HMP Demo Gu ide — July 2005 35 Demo Details T able 8. V oice Module Classes Category Class Name Interface Module CV oice Module • Interacts with CV oiceBoard and CV oiceDevice. • Expor ts V oice mod ule functions to CEventRouter . Note: The public functions in this class can be accessed by classes outside the Voice module.[...]

36 IP Media Server for HMP Demo Guide — July 2005 Demo Details Device CV oiceDevice • Handles voice de vice operations, such as play ing, recording, tone detection, and tone generation • Holds CV oiceStateMachine Note: The public functions in this class should only be accessed by classes inside the Voice module. Init( ) • Opens the voice de[...]

IP Media Server for HMP Demo Gu ide — July 2005 37 Demo Details State Machine CV oiceStateMachine • Handles voice e vents 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 vo x files • Creates mailbo x utility object that manages mail[...]

38 IP Media Server for HMP Demo Guide — July 2005 Demo Details Board CF axBoa rd • Interacts with the f ax librar y to handle fax boards • The public function in this class should only be accessed by classes inside the Fax module Init( ) • Open fax board. Exit( ) • Close fax board. ProcessEvent( ) • Processes fax board e vents. Device C[...]

IP Media Server for HMP Demo Gu ide — July 2005 39 Demo Details 5.3 Threads The IP Media Serv er for HMP demo operates with two threads, as shown in Figure 4. Figure 4. IP Media Server Demo Threads The threads are created as follo ws: 1. The f irst (main) thread is created by the demo application to get the ke yboard input. 2. The second thread i[...]

40 IP Media Server for HMP Demo Guide — July 2005 Demo Details After all the modules are started, the Ev entRouter starts to build a static routing table that maps voice de vices to IP devices. It is important that each IP device has a dedicated v oice resource, so that when an IP channel is co nnected (an incoming call is answered) the user can [...]

IP Media Server for HMP Demo Gu ide — July 2005 41 Demo Details 5.5 Event Handling This section describes how the IP Media Serv er for HMP demo handles ev ents. It co ntains the following topics: • Event Mechanism • Handling Keyboard Input Events • Handling SRL Events • Handling Application Ex it Events • TSUsrEvent Structure 5.5.1 Even[...]

42 IP Media Server for HMP Demo Guide — July 2005 Demo Details 5.5.5 TSUsrEvent Structure The TSUsrEvent structure is used b y the demo mo dules to return event processing results to the ev ent router . The TSUserEvt structure is def i ned as follo ws: typedef stru ct { int event; TDeviceTyp e destinati on; int lineDevic e; long xmitSlot; long ne[...]

IP Media Server for HMP Demo Gu ide — July 2005 43 Demo Details Figure 6. T ypical Scenario: Call Offered CEventRouter CIPModule CIPDevice CIPState Machine CV oiceModule GCEV_OFFERED GCEV_OFFERED GCEV_OFFERED GCEV_EXTENSIONCMPL T GCEV_EXTENSIONCMPL T GCEV_EXTENSIONCMPL T GCEV_CONNECTED GCEV_CONNECTED GCEV_CONNECTED call gc_extension( ) to get cal[...]

44 IP Media Server for HMP Demo Guide — July 2005 Demo Details Pla y Prompts After the call is connected, th e V oice module is notified to play prompts and accept DTMF . Figure 7. T ypical Scenario: Pla y Prompts CEventRouter CIPModule CIPDevice CIPState Machine CV oiceModule USR_CONNECTED TDX_PLA Y (finish playing main menu) TDX_GETDIG (press &[...]

IP Media Server for HMP Demo Gu ide — July 2005 45 Demo Details Fax Mailbo x The user selects to send a fax to mailbox “101”. The Fax module is requested to send a fax. Figure 8. T ypical Scenario: Fax Mailbox CEventRouter CIPModule CF axModule USR_SENDF AX "101" CF axDevice CFaxState Machine USR_SENDF AX "101" ... source=[...]

46 IP Media Server for HMP Demo Guide — July 2005 Demo Details Establish Fax Session The Fax module requests the front end to g et ready to send a fax. If the front end is IP , it shoul d first mov e from an R TP port to a UDP port in order to send a fax. Figure 9. T ypical Scenario: Estab lish Fax Sess ion CEventRouter CIPModule CIPDevice CIPSta[...]

IP Media Server for HMP Demo Gu ide — July 2005 47 Demo Details Fax Session Estab lished The Fax module gets a reply from the front end that the fax session has been established. Figure 10. T ypical Scenario: F ax Session Established CEventRouter CIPModule CF axModule CF axDevice CFaxState Machine ... source=F AX destination=IP ev ent= USR_CLOSEF[...]

48 IP Media Server for HMP Demo Guide — July 2005 Demo Details F ax Sent The fax is sent. The front end is requested to close the fax session. Figure 11. T ypical Scenario: F ax Sent CEventRouter CIPModule CIPDevice CIPState Machine 1. Call gc_stop( ) to stop T .38 session 2. Call gc_extension ( ) to start audio session 3. Call gc_listen( ) liste[...]

IP Media Server for HMP Demo Gu ide — July 2005 49 Demo Details Fax Session Closed The Fax module gets a reply from the front end that the fax session has been closed. Figure 12. T ypical Scenario: F ax Session Closed Fax Complete The V oice module gets a reply from the Fax module that a f ax has been sent. Figure 13. T ypical Scenario: Fa x Comp[...]

50 IP Media Server for HMP Demo Guide — July 2005 Demo Details[...]

IP Media Server for HMP Demo Gu ide — July 2005 51 Glossar y Codec: see COder/DECoder COder/DECoder: A circuit used to con vert analog v oi ce data to digital and digital voice data to analog audio. Computer T elephony (CT): Adding computer intellig ence to the making, recei ving, and managing of telephone calls. DTMF: Dual-T one Multi-Frequency [...]

52 IP Media Server for HMP Demo Guide — July 2005 International T elecommunications Union (ITU): An organization established by the United Nations to set telecommunications stan dards, allocat e frequencies to various uses, and hold trade sho ws ev ery four years. Internet: An inter -netw ork of netwo rks inter connected b y bridges or routers. L[...]

IP Media Server for HMP Demo Gu ide — July 2005 53 T1: A digital transm ission link with a capacity o f 1.544 Mbps used in North America. T ypically channeled into 24 digital subscriber lev el zeros (DS0s), each capable of carry ing a single voice con versatio n or data strea m. T1 uses two pairs of twisted pair wires. TCP: see T ransmissi on Con[...]

54 IP Media Server for HMP Demo Guide — July 2005[...]

IP Media Server for HMP Demo Gu ide — July 2005 55 Inde x A application classes 31 application exit eve nts 41 C CallbackHdlr( ) 41 CConfig( ) 39 CEventRouter( ) 39 ChannelNumber( ) 31 CheckAndConvertDigits( ) 37 classes 31 application classes 31 Fax module classes 37 IP module classes 3 2 CloseFaxFile( ) 38 command-line switches 19 commands, key[...]

56 IP Media Server for HMP Demo Guide — July 2005 M main( ) 41 module structure 29 O OnPlayComplete( ) 36 OpenFaxFile( ) 38 P ParseConfigFile( ) 31 PDL files 28 PDLSetApplicationExitPath( ) 41 PDLsr_enbhdlr( ) 41 PDLsr_enblhdlr( ) 39 Play( ) 36 ProcessEvent( ) 31 programming model 28 R Record( ) 36 RecvFax( ) 38 requirements hardware 13 software [...]