Intel 05-2065-003 User Manual

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 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 the express written consent of 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

Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1 Demo Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.1 Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.2 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

3 Preparing to Run the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

3.1 Editing Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

3.1.1 Configuration File Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

3.1.2 Editing the IPMediaServer.cfg Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . 15

3.2 Compiling and Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4 Running the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.1 Starting the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.2 Demo Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.3 Using the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.3.1 Keyboard Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.3.2 Using the Media Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.4 Stopping the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

5Demo Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

5.1 Files Used by the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

5.1.1 Demo Source Code Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

5.1.2 PDL Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

5.2 Programming Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

5.2.1 Module Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

5.2.2 EventRouter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

5.2.3 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

5.2.4 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

5.3 Threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

5.4 Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

5.5 Event Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

5.5.1 Event Mechanism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

5.5.2 Handling Keyboard Input Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

5.5.3 Handling SRL Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

5.5.4 Handling Application Exit Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

5.5.5 TSUsrEvent Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

IP Media Server (Global Call) Demo Guide – August 2005 3

Contents

Figures

1 Demo Voice Menu Flowchart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2 IP Media Server (Global Call) Demo Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

3 EventRouter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

4 IP Media Server (Global Call) Demo Threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

5 System Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4 IP Media Server (Global Call) Demo Guide – August 2005

Contents

Tables

1 Quality of Service Parameter Defaults for DM/IP Series Boards . . . . . . . . . . . . . . . . . . . . . . . . 16

2 Quality of Service Parameter Defaults for IPT Series Boards . . . . . . . . . . . . . . . . . . . . . . . . . . 17

3 Command Line Switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4 Runtime Keyboard Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

5 Files in IPMediaServer Folder Used by the IP Media Server (Global Call) Demo . . . . . . . . . . . 27

6 Files in Modules Folder Used by the IP Media Server (Global Call) Demo . . . . . . . . . . . . . . . . 28

7 PDL Files Used by the IP Media Server (Global Call) Demo. . . . . . . . . . . . . . . . . . . . . . . . . . . 30

8 Application Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

9 IP Module Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

10 Voice Module Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

IP Media Server (Global Call) Demo Guide – August 2005 5

Contents

6 IP Media Server (Global Call) Demo Guide – August 2005

Revision History

This revision history summarizes the changes made in each published version of this document.

Document No. Publication Date Description 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 7

Revision History

8 IP Media Server (Global Call) Demo Guide — August 2005

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

• Intended 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.

Intended 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

• Independent 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 9

About This Publication

• 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

• Global 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)

DM/IP series or IPT series board

10 IP Media Server (Global Call) Demo Guide — August 2005

1.Demo Description

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.

Note: 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

Note: 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 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

12 IP Media Server (Global Call) Demo Guide — August 2005

2.System Requirements

This chapter discusses the system requirements for running the IP Media Server (Global Call) demo. It contains the following topics:

• Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

• Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.1 Hardware Requirements

To run the IP Media Server (Global Call) demo, you need:

• One of the following:

– Intel NetStructure

• also requires an Intel NetStructure

• IP network cable

For other hardware requirements, such as memory requirements, see the Release Guide for the system release you are using.

DM/IP Series board

IPT Series board

DM/V-A series board for PSTN connection

2.2 Software Requirements

To run the IP Media Server (Global Call) demo as documented in this guide, you need the Intel® Dialogic 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.

System Software 6.1 or later. For a list of operating system requirements see the Release

IP Media Server (Global Call) Demo Guide — August 2005 13

System Requirements

14 IP Media Server (Global Call) Demo Guide — August 2005

3.Preparing to Run the Demo

This chapter discusses the preparations necessary to run the IP Media Server (Global Call) demo. It provides information about the following topics:

• Editing Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

• Compiling and Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 IPMediaServer.cfg file to reflect your system environment. Use a text editor and open the file from the following location:

Windows

$(INTEL_DIALOGIC_DIR)\Demos\IPMediaServer\Release

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 IPMediaServer.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

+ 35 hidden pages