Intel 05-2342-002 User Manual

Voice API for Linux

Demo Guide
June 2005
05-2342-002
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, or life sustaining applications.
Intel may make changes to specifications and product descriptions at any time, without notice.
This Voice API for Linux 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 express written consent of Intel Corporation.
Copyright © 2004-2005, Intel Corporation
BunnyPeople, Celeron, Chips, Dialogic, EtherExpress, ETOX, FlashFile, i386, i486, i960, iCOMP, InstantIP, Intel, Intel Centrino, Intel Centrino logo, Intel logo, Intel386, Intel486, Intel740, IntelDX2, IntelDX4, IntelSX2, Intel Inside, Intel Inside logo, Intel NetBurst, Intel NetMerge, Intel NetStructure, Intel SingleDriver, Intel SpeedStep, Intel StrataFlash, Intel Xeon, Intel XScale, IPLink, Itanium, MCS, MMX, MMX logo, Optimizer logo, OverDrive, Paragon, PDCharm, Pentium, Pentium II Xeon, Pentium III Xeon, Performance at Your Command, skoool, Sound Mark, The Computer Inside., The Journey Inside, VTune, and Xircom 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: June 2005
Document Number: 05-2342-002
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 Products website at:
http://www.intel.com/design/network/products/telecom
For Sales Offices and other contact information, visit the Where to Buy Intel Telecom Products page at:
http://www.intel.com/buy/networking/telecom.htm
Voice API for Linux Demo Guide – June 2005

Contents

Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Applicability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
How to Use This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1 Demo Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.1 Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.2 Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3 Preparing to Run the Demos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4 Running the Demos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.1 Starting the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.1.1 Starting the cbansr demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.1.2 Starting the pansr demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.1.3 Starting the custserv demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.1.4 Starting the dpddemo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.1.5 Starting the d40demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.2 Demo Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.3 Using the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.3.1 Using the cbansr demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.3.2 Using the pansr demo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.3.3 Using the custserv demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.3.4 Using the dpddemo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.3.5 Using the d40demo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.4 Stopping the Demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
5Demo Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5.1 Files Used by cbansr and pansr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5.2 Files Used by custserv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5.3 Files Used by dpddemo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
5.4 Files Used by d40demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
5.5 Supplementary Information for d40demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
5.5.1 Source Code Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
5.5.2 Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
5.5.3 Initialization Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
5.5.4 Menu System Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.5.5 Messaging System Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Voice API for Linux Demo Guide – June 2005 3

Revision History

This revision history summarizes the changes made in each published version of this document.
Document No. Publication Date Description of Revisions
05-2342-002 June 2005 Demo Descriptions chapter: Added custserv, dpddemo, and d40demo. Also added
information about the d4xtools.c toolkit.
Running the Demos chapter: Added sections for custserv, dpddemo, and d40demo.
Demo Details chapter: Added sections for custserv, dpddemo, and d40demo.
05-2342-001 November 2004 Initial version of document.
Voice API for Linux Demo Guide — June 2005 4

About This Publication

The following topics provide information about the Voice API for Linux Demo Guide:
Purpose
Applicability
Intended Audience
How to Use This Publication
Related Information
Purpose
This publication describes the voice demonstration programs and provides instructions for running the demos on the Linux* operating system.
Applicability
This document version (05-2342-002) is published for Intel® Dialogic® System Release 6.1 for Linux.
This document may also be applicable to later Intel Dialogic system releases on Linux. Check the Release Guide for your software release to determine whether this document is supported.
Intended Audience
This publication is written for users of the voice demonstration programs which may include the following:
Distributors
System Integrators
Toolkit Developers
Independent Software Vendors (ISVs)
Value Added Resellers (VARs)
Original Equipment Manufacturers (OEMs)
End Users
Voice API for Linux Demo Guide — June 2005 5
About This Publication
How to Use This Publication
This publication assumes that you understand computer telephony terms and concepts, and are familiar with the Linux operating system and the C programming language.
The information in this guide is organized as follows:
Chapter 1, “Demo Descriptions” provides a brief overview of the voice demos.
Chapter 2, “System Requirements” discusses the hardware and software required to run the
demos.
Chapter 3, “Preparing to Run the Demos” lists the procedures you must follow before running
the demos.
Chapter 4, “Running the Demos” describes the steps to run the demos, the demo options, and
how to stop the demo.
Chapter 5, “Demo Details” provides additional information about the demos, such as the files
used by the demos.
Related Information
See the following documents for more information:
For information about voice library features and guidelines for building applications using
Voice software, see the Voice API Programming Guide.
For details on all voice functions, parameters, and data structures in the voice library, see the
Voice API Library Reference.
For information about the SRL and programming models supported, see the Standard Runtime
Library API Programming Guide.
For information on the system release, system requirements, software and hardware features,
supported hardware, and release documentation, see the Release Guide for your system release.
For details on known problems and late-breaking updates or corrections to the release
documentation, see the Release Update. Be sure to check the Release Update for the software release you are using for any updates or corrections to this publication. Release Updates are available on the Telecom Support Resources website at
http://resource.intel.com/telecom/support/documentation/releases/index.htm
6 Voice API for Linux Demo Guide — June 2005

1.Demo Descriptions

This chapter provides a brief description of the voice demonstration programs.
The following demonstration programs are provided with the voice software. These demos are supported on Springware boards only.
cbansr
Voice application that uses the asynchronous callback programming model. This demo is state­driven but uses event handlers that can be enabled or disabled for specific events on specific devices. The demo illustrates the voice recording and playback feature. You can listen to a prompt, record a message, and play back that message.
pansr
A multithreaded, multi-channel voice application that uses the asynchronous polled programming model. This demo is state-driven and uses polling to get event information without the use of event handlers or device handlers. The demo illustrates the voice recording and playback feature. You can listen to a prompt, record a message, and play back that message.
custserv
Synchronous mode, customer service application that transfers calls to the proper service representative based on the caller’s input.
1
dpddemo
A multi-channel voice application that uses the asynchronous polled programming model. The demo illustrates the voice recording and playback feature. It is similar to the pansr demo, but can accept both dial pulses and DTMF tones.
d40demo
Synchronous mode, simple order entry application built on a menu system.
The purpose of the demo programs is to show how to use the voice library functions in a voice application. They provide a framework on which to base your applications; they are not intended to be used as real voice applications.
Source code and an executable version of the demo programs are provided, as well as a makefile to compile the source. The source is written in C.
A toolkit of general purpose C routines is also included with the demo programs. This toolkit aids in the development of voice applications. The toolkit source is contained in d4xtools.c.
Note: The synchronous programming model is not recommended for production applications; however, it
can be used for demo or proof of concept applications. For detailed information on programming models, including advantages and disadvantages of each model, see the Standard Runtime Library API Programming Guide.
Voice API for Linux Demo Guide — June 2005 7
Demo Descriptions
8 Voice API for Linux Demo Guide — June 2005

2.System Requirements

The requirements for running the voice demos are described in the following sections:
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.1 Hardware Requirements

To run a voice demo, you need the following:
A Springware board that supports the R4 voice API library installed in a computer system (for
a list of supported Springware boards, see the release guide for the system release)
A central office simulator OR a connection to a telephone switch or public telephone network
For boards with a digital network interface, a T1 or an E1 line connected to your system.
For boards with an analog interface, an analog line such as a connection to a PBX.
A telephone
For other system configuration requirements, such as memory requirements, see the release guide for your system release.
2
The following is an example of a hardware setup for use with cbansr or pansr demo:
One D/41JCT-LS board
One central office simulator
One analog phone
Connect the phone to Line 1A of the simulator and connect Line 2 of the simulator to the desired channel on the back of the board.

2.2 Software Requirements

To run a voice demo, you need the Intel® Dialogic® System Release. Be sure to select the package for Intel Dialogic Boards (Springware boards) when installing the system release. For details on installing the system release, see the software installation guide for your system release.
For a list of operating system requirements and supported compilers, see the release notes for your system release.
Voice API for Linux Demo Guide — June 2005 9
System Requirements
10 Voice API for Linux Demo Guide — June 2005

3.Preparing to Run the Demos

This chapter provides information on preparations to follow before running a voice demo.
Before you run a voice demo program, ensure that you have performed the following:
1. Adhered to the hardware and software requirements described in Chapter 2, “System
Requirements”.
2. Installed a Springware board in your computer system. This product should support the R4 API libraries.
3. Started System Services for the board.
4. Connected the board to a central office simulator, telephone switch or the public telephone network.
5. Installed a telephone extension near your computer through which you can dial extensions assigned to the board.
3
Voice API for Linux Demo Guide — June 2005 11
Loading...
+ 25 hidden pages