dsPIC® DSC Speex Speech Encoding/Decoding Library User’s Guide © 2008-2011 Microchip Technology Inc. DS70328C Note the following details of the code protection feature on Microchip devices: • Microchip products meet the specification contained in their particular Microchip Data Sheet. • Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the intended manner and under normal conditions. • There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip’s Data Sheets. Most likely, the person doing so is engaged in theft of intellectual property. • Microchip is willing to work with the customer who is concerned about the integrity of their code. • Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not mean that we are guaranteeing the product as “unbreakable.” Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our products. Attempts to break Microchip’s code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act. Information contained in this publication regarding device Trademarks applications and the like is provided only for your convenience The Microchip name and logo, the Microchip logo, dsPIC, and may be superseded by updates. It is your responsibility to KEELOQ, KEELOQ logo, MPLAB, PIC, PICmicro, PICSTART, ensure that your application meets with your specifications. PIC32 logo, rfPIC and UNI/O are registered trademarks of MICROCHIP MAKES NO REPRESENTATIONS OR Microchip Technology Incorporated in the U.S.A. and other WARRANTIES OF ANY KIND WHETHER EXPRESS OR countries. IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, FilterLab, Hampshire, HI-TECH C, Linear Active Thermistor, INCLUDING BUT NOT LIMITED TO ITS CONDITION, MXDEV, MXLAB, SEEVAL and The Embedded Control QUALITY, PERFORMANCE, MERCHANTABILITY OR Solutions Company are registered trademarks of Microchip FITNESS FOR PURPOSE. Microchip disclaims all liability Technology Incorporated in the U.S.A. arising from this information and its use. Use of Microchip Analog-for-the-Digital Age, Application Maestro, chipKIT, devices in life support and/or safety applications is entirely at chipKIT logo, CodeGuard, dsPICDEM, dsPICDEM.net, the buyer’s risk, and the buyer agrees to defend, indemnify and dsPICworks, dsSPEAK, ECAN, ECONOMONITOR, hold harmless Microchip from any and all damages, claims, FanSense, HI-TIDE, In-Circuit Serial Programming, ICSP, suits, or expenses resulting from such use. No licenses are Mindi, MiWi, MPASM, MPLAB Certified logo, MPLIB, conveyed, implicitly or otherwise, under any Microchip MPLINK, mTouch, Omniscient Code Generation, PICC, intellectual property rights. PICC-18, PICDEM, PICDEM.net, PICkit, PICtail, REAL ICE, rfLAB, Select Mode, Total Endurance, TSHARC, UniWinDriver, WiperLock and ZENA are trademarks of Microchip Technology Incorporated in the U.S.A. and other countries. SQTP is a service mark of Microchip Technology Incorporated in the U.S.A. All other trademarks mentioned herein are property of their respective companies. © 2008-2011, Microchip Technology Incorporated, Printed in the U.S.A., All Rights Reserved. Printed on recycled paper. ISBN: 978-1-61341-297-8 Microchip received ISO/TS-16949:2002 certification for its worldwide headquarters, design and wafer fabrication facilities in Chandler and Tempe, Arizona; Gresham, Oregon and design centers in California and India. The Company’s quality system processes and procedures are for its PIC® MCUs and dsPIC® DSCs, KEELOQ® code hopping devices, Serial EEPROMs, microperipherals, nonvolatile memory and analog products. In addition, Microchip’s quality system for the design and manufacture of development systems is ISO 9001:2000 certified. DS70328C-page 2 © 2008-2011 Microchip Technology Inc. dsPIC® DSC SPEEX SPEECH ENCODING/DECODING LIBRARY USER’S GUIDE Table of Contents Preface ........................................................................................................................... 5 Chapter 1. Introduction 1.1 Library Overview .......................................................................................... 11 1.2 Features ....................................................................................................... 14 1.3 System Requirements .................................................................................. 14 Chapter 2. Installation 2.1 Installation Procedure ................................................................................... 15 2.2 Library Files .................................................................................................. 16 Chapter 3. Quick Start Demonstration 3.1 Quick Start Demonstration for dsPIC33F Device Family ............................. 21 3.2 Quick Start Demonstration for dsPIC33E Device Family ............................. 30 Chapter 4. Application Programming Interface 4.1 Adding the Library to an Application ............................................................. 37 4.2 Memory Model Compile Options .................................................................. 38 4.3 Using the Library .......................................................................................... 40 4.4 Register Usage ............................................................................................. 43 4.5 Packet Loss and Corruption ......................................................................... 43 4.6 PC Encoder Utility (PCEU) Output Files ...................................................... 43 4.7 Resource Requirements ............................................................................... 44 4.8 API Functions ............................................................................................... 47 4.9 Application Tips ............................................................................................ 61 Index ............................................................................................................................. 63 Worldwide Sales and Service .................................................................................... 64 © 2008-2011 Microchip Technology Inc. DS70328C-page 3 dsPIC® DSC Speex Speech Encoding/Decoding Library User’s Guide NOTES: DS70328C-page 4 © 2008-2011 Microchip Technology Inc. dsPIC® DSC SPEEX SPEECH ENCODING/DECODING LIBRARY USER’S GUIDE Preface NOTICE TO CUSTOMERS All documentation becomes dated, and this manual is no exception. Microchip tools and documentation are constantly evolving to meet customer needs, so some actual dialogs and/or tool descriptions may differ from those in this document. Please refer to our web site (www.microchip.com) to obtain the latest documentation available. Documents are identified with a “DS” number. This number is located on the bottom of each page, in front of the page number. The numbering convention for the DS number is “DSXXXXXA”, where “XXXXX” is the document number and “A” is the revision level of the document. For the most up-to-date information on development tools, see the MPLAB® IDE on-line help. Select the Help menu, and then Topics to open a list of available on-line help files. INTRODUCTION This chapter contains general information that will be useful to know before using the dsPIC® DSC Speex Speech Encoding/Decoding Library User’s Guide. Items discussed in this preface include: • Document Layout • Conventions Used in this Guide • Warranty Registration • Recommended Reading • The Microchip Web Site • Development Systems Customer Change Notification Service • Customer Support • Document Revision History DOCUMENT LAYOUT This document describes how to use the dsPIC DSC Speex Speech Encoding/Decoding Library as a development tool to emulate and debug firmware on a target board. The document layout is as follows: • Chapter 1. “Introduction”– This chapter describes the dsPIC DSC Speex Speech Encoding/Decoding Library. • Chapter 2. “Installation” – This chapter provides detailed information needed to install the dsPIC DSC Speex Speech Encoding/Decoding Library on a PC. • Chapter 3. “Quick Start Demonstration” – This chapter describes the demonstrations available for the dsPIC DSC Speex Speech Encoding/Decoding Library. • Chapter 4. “Application Programming Interface” – This chapter outlines how the API functions provided in the dsPIC DSC Speex Speech Encoding/Decoding Library can be included in your application software through the Application Programming Interface. © 2008-2011 Microchip Technology Inc. DS70328C-page 5 dsPIC® DSC Speex Speech Encoding/Decoding Library User’s Guide CONVENTIONS USED IN THIS GUIDE This manual uses the following documentation conventions: DOCUMENTATION CONVENTIONS Description Represents Examples Arial font: Italic characters Referenced books MPLAB® IDE User’s Guide Emphasized text ...is the only compiler... Initial caps A window the Output window A dialog the Settings dialog A menu selection select Enable Programmer Quotes A field name in a window or “Save project before build” dialog Underlined, italic text with A menu path File>Save right angle