Intel® Integrated Performance Primitives
GSMAMR Sample for Linux*

Disclaimer
License Definitions
Overview

System Requirements
Package Contents
Installation
How to Build Source Code
Running the Software
Technical Support and Feedback
 

Disclaimer

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 in nuclear facility applications. Intel may make changes to specifications and product descriptions at any time, without notice.

License Definitions

By downloading and installing this sample, you hereby agree that the accompanying Materials are being provided to you under the terms and conditions of the End User License Agreement for the Intel® Integrated Performance Primitives product previously accepted by you. Please refer to the file ipplic.htm for more information.

GSMAMR is an international standard promoted by ETSI and other organizations. Implementations of these standards, or the standard enabled platforms may require licenses from various entities, including Intel Corporation.

Overview

The multi-thread encoder and decoder samples included are fully compliant with the ETSI GSM 06.90-06.94 recommendation and have been implemented using the Intel® Integrated Performance Primitives (Intel® IPP) Speech Coding functions.  

Additional information on this software as well as other Intel software performance products is available at http://developer.intel.com/software/products/.

To demonstrate that the codec implementation is thread-safe, the following procedure is performed: each thread processes its own copy of an input file independently, then the results are compared - if they are not identical an error is reported.

Note: this model differs from the model where many threads process the same stream in parallel, therefore it should not be expected that the given codec runs faster in the multi-threaded mode than it runs in the single-thread mode.

System Requirements

Recommended hardware:  

Hardware requirements: Software requirements: 

Package Contents

The Intel® IPP GSMAMR Sample for Linux* package contains the following:

./ipp_sample/speech-coding/
ipplic.htm End User License Agreement
support.txt Contains information for technical support
./ipp_sample/speech-coding/GSMAMR/
Makefile The main make-file to build the encoder and decoder

build.sh

Shell script to build the sample's executable files

readme.htm This file
./ipp_sample/speech-coding/GSMAMR/include/
gsmamr.h GSMAMR header file
gsmamr_types.h Coder type definition header file
gsmamrapi.h API header
./ipp_sample/speech-coding/GSMAMR/api/
bitpack.c Bitstream pack/unpack functions file
encgsmamr.c GSMAMR functions for encoding  speech file
decgsmamr.c GSMAMR functions for decoding  speech file
dtx_util.c DTX functions file
gain_util.h Gain functions file
tab_util.c Coder tables file
util.c Auxiliary functions
uscgsmamr.c USC interface implementation file
owngsmamr.h Coder constants, types and inner functions definition header file
./ipp_sample/speech-coding/GSMAMR/samples/

encoder.c

USC encoder main program file

encoder.h USC encoder main header file
decoder.c USC decoder main program file
decoder.h USC decoder main header file
util_d.c decoder utility program file
util_d.h decoder utility header file
util_e.c encoder utility program file
util_e.h encoder utility header file
./ipp_sample/speech-coding/GSMAMR/vm/include/
vm_thread.h Header file containing definition of cross platform functionality, which provides threading support
vm_types.h Header file containing definition of cross platform types, which are used in definitions of cross platform functionality
./ipp_sample/speech-coding/GSMAMR/vm/include/sys/
vm_types_linux32.h Header file containing definition of cross platform types for IA-32 platforms running Linux*
./ipp_sample/speech-coding/GSMAMR/vm/include/src/
vm_thread_linux32.c Source file containing implementation of threading support for IA-32 platforms running Linux*

Installation

Extract all files in l_ipp-sample-speech-coding_*.tgz to a desired folder. Please make sure to preserve the directory structure. The files for the GSMAMR sample will be found in the ./ipp_sample/speech-coding/GSMAMR/ folder.

How to Build Source Code

Verify that the IPPROOT environment variables contain the path where the IPP package is installed.

Evaluation Users: If you are using an Evaluation version of Intel(R) IPP, please make sure that IPPROOT is changed to: /opt/intel/ipp41_eval/ia32_itanium (using the default install directory).

Execute the file build.sh to build the GSMAMR coder sample.

Running the Software

After building, be sure that the LD_LIBRARY_PATH environment variable includes the directories of the .so files from the Intel® IPP installation. This can be accomplished by entering the following at the command prompt:    

export LD_LIBRARY_PATH=/opt/intel/ipp41/ia32_itanium/sharedlib:/opt/intel/ipp41/ia32_itanium/sharedlib/linux32:$LD_LIBRARY_PATH

or by running the shell script ippvars32.sh from the Intel® IPP installation (located in /opt/intel/ipp41/ia32_itanium/tools/env/ by default).

To run one of the GSMAMR encoder sample, type: 

gsmamrencoder [options] <inPCMFile> <outBitstreamTestFile>

Encoder option list: 

     -r122|r102|r795|r74|r67|r59|r515|r475|r<filename>  bit rates 12.2, 10.2, 7.95, 7.4, 6.7, 5.9, 5.15 or 5.3 kbit/s or bit rates given by file on per frame basis.
     -v1|v2           VAD1 or VAD2 enabled. Default: VAD disabled. 

     -a                  input data is A-Law PCM.

     -u                  input data is Mu-Law PCM.

                          Default: input data is 16-bit linear PCM.

     -T                 don`t truncate input data to 13 bits.

     -n                  output additional information.
     -c                  write to codecspeed.csv file information about coder performance.
     -s  <rep>      repeater, how many times input file shall be encoded without reset of encoder,  default: <rep>=1
     -t  <num>      number of threads to perform the same encoding operation , default: <num>=1.

<inPCMFile> - input file contains 16-bit 8 KHz PCM to encode,

<outBitstreamTestFile> - output file, contains the encoded bit-stream in test vectors format.

To run one of the GSMAMR decoder sample, type: 

gsmamrdecoder [options] <inBitstreamTestFile> <outPCMFile>  

Decoder option list: 

     -a                  Write the output data in A-Law PCM format.

     -u                  Write the output data in Mu-Law PCM format.

                          Default: Write the output data in 16-bit linear PCM format.

     -T                 don`t truncate output data to 13 bits.

     -n                  output additional information.
     -c                  write to codecspeed.csv file information about coder performance.
     -s  <rep>      repeater, how many times input file shall be encoded without reset of encoder,  default: <rep>=1
     -t  <num>      number of threads to perform the same encoding operation , default: <num>=1.

<inBitstreamTestFile> - input file contains bit-stream to decode,

<outPCMFile> - output file, to write the decoded 16-bit 8 KHz PCM.

NOTE: The bit-stream and PCM files (after decode) are used in the format of the test files of  the GSMAMR simulation software which is available via  ITU-T official WEB site. To check the bit-to-bit exactness against them, correspondent bit-stream and PCM test files shall be used in pair. 

Technical Support and Feedback

Your feedback on the Intel IPP samples is very important to us and your input will be considered for future releases.

When building original sample code, let us know if you have any problems with:

  1. Installation
  2. Compiling errors
  3. Linking errors
  4. Runtime errors or incorrect output

To receive technical support and product updates for the tools provided in this product you need to register at the Intel® Registration Center and click on "Create New Account".

For information about the Intel® IPP's FAQ's, tips and tricks, and other support information, please visit: http://support.intel.com/support/performancetools/libraries/

Note:
If you are having trouble registering or unable to access your Premier Support account, contact developer.support@intel.com. Please do not email your technical issue to developer.support@intel.com as it is not a secure medium.

To submit an issue via the Intel® Premier Support website please perform the following steps:

  1. Ensure that Java* and JavaScript* are enabled in your browser.
  2. Go to https://premier.intel.com/.
  3. Type in your Login and Password.  Both are case-sensitive.
  4. Click the "Submit" button.
  5. Read the Confidentiality Statement and click the "I Accept" button.
  6. Click on the "Go" button next to the "Product" drop-down list.
  7. Click on the "Submit Issue" link in the left navigation bar.
  8. Choose "Development Environment (tools,SDV,EAP)" from the "Product Type" drop-down list.
  9. If this is a software or license-related issue choose "Intel® IPP Samples*" from the "Product Name" drop-down list.
  10. Enter your question and complete the fields in the windows that follow to successfully submit the issue.

Please follow these guidelines when you submit a technical issue to Intel Premier Support:
http://support.intel.com/support/performancetools/libraries/ipp/sb/cs-010663.htm

For product user forum, on-line help and other support information, please visit: http://support.intel.com/support/performancetools/libraries/ipp/

Celeron, Dialogic, i386, i486, iCOMP, Intel, Intel logo, Intel386, Intel486, Intel740, IntelDX2, IntelDX4, IntelSX2, Intel Inside, Intel Inside logo, Intel NetBurst, Intel NetStructure, Intel Xeon, Intel XScale, Itanium, MMX, MMX logo, Pentium, Pentium II Xeon, Pentium III Xeon, and VTune 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.
 
Copyright © 2003-2004 Intel Corporation.