UnwiredtecDocumentation : RingtoneCreatorServerSoundEngine

Appendix A. Installation of Unwiredtec Sound Engine and External Codecs

This chapter describes use of Unwiredtec Sound Engine and external audio codecs with Ringtone Creator Server. You will need to install and use the Sound Engine in order to synthesize sound or to create ringtone previews. You will need external codecs if you want to support MP3, AMR NB, AMR WB, AAC or QCP ringtones. Here's how your web.xml file looks like (you need to edit certain parameters in order to make the whole thing work):

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
  <servlet>
    <servlet-name>conversionservlet</servlet-name>
    <servlet-class>com.unwiredtec.rtcreator.servlet.ConversionServlet</servlet-class>
        <!-- MP3 codec parameters -->
        <init-param>
                <param-name>rtc.parser.mp3.path</param-name>
                <param-value>c:\lame\lame.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.mp3.path</param-name>
                <param-value>c:\lame\lame.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.parser.mp3.name</param-name>
                <param-value>lame</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.mp3.name</param-name>
                <param-value>lame</param-value>
        </init-param>
 
        <!-- AMR NB codec parameters -->
        <init-param>
                <param-name>rtc.parser.amr.path</param-name>
                <param-value>c:\amrnb\decoder.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.amr.path</param-name>
                <param-value>c:\amrnb\encoder.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.parser.amr.name</param-name>
                <param-value>3gpp</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.amr.name</param-name>
                <param-value>3gpp</param-value>
        </init-param>
 
        <!-- AMR WB codec parameters -->
        <init-param>
                <param-name>rtc.parser.amrwb.path</param-name>
                <param-value>c:\amrwb\decoder.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.amrwb.path</param-name>
                <param-value>c:\amrwb\encoder.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.parser.amrwb.name</param-name>
                <param-value>3gpp</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.amrwb.name</param-name>
                <param-value>3gpp</param-value>
        </init-param>
 
        <!-- QCP codec parameters -->
        <init-param>
                <param-name>rtc.parser.qcp.path</param-name>
                <param-value>c:\qcp\pvconv.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.qcp.path</param-name>
                <param-value>c:\qcp\pvconv.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.parser.qcp.name</param-name>
                <param-value>QUALCOMM</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.qcp.name</param-name>
                <param-value>QUALCOMM</param-value>
        </init-param>
 
        <!-- AAC codec parameters -->
        <init-param>
                <param-name>rtc.parser.aac.path</param-name>
                <param-value>c:\aac\faad.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.aac.path</param-name>
                <param-value>c:\aac\faac.exe</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.parser.aac.name</param-name>
                <param-value>faad</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.converter.aac.name</param-name>
                <param-value>faac</param-value>
        </init-param>
 
        <!--
                Sound Engine plugin config. If the plugin is installed, it'd read this variable and use it.
        -->
        <init-param>
                <param-name>rtc.dls.bank.path</param-name>
                <param-value>c:/windows/system32/drivers/gm.dls</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.synthesis.frequency</param-name>
                <param-value>22050</param-value>
        </init-param>
        <init-param>
                <param-name>rtc.plugins.path</param-name>
                <param-value>c:/tomcat/webapps/rtcreator/WEB-INF/lib/</param-value>
        </init-param>
        <!-- end of Sound Engine config -->
  </servlet>
 
  <servlet-mapping>
    <servlet-name>conversionservlet</servlet-name>
    <url-pattern>/convert</url-pattern>
  </servlet-mapping>
</web-app>

To configure the Sound Engine, you need to update values of tags located between corresponding comments. Here's the meanings of these values:

rtc.dls.bank.path	Location of your DLS or SF2 sound bank used for synthesis. This bank must be present for synthesis; its absence will limit conversion capabilities of your server.
rtc.synthesis.frequency	Synthesis frequency. The default value is 22 KHz (22050) and we don't recommend changing this value, as it'll result in slower performance without any tangible benefit for sound quality.
rtc.plugins.path	Full path to the Sound Engine plugin `.jar` file. To avoid problems, please use the full path (i.e. c:/folder1/folder2/folder3 instead of folder2/folder3).

To configure external codecs, you need to update values of tags located between corresponding comments.
Please refer to codecs configuration page for more information on obtaining and configuring codecs.

Once you've done making changes to your web.xml configuration file, please restart your server in order to apply changes. (Your web container may restart itself automatically if you configure it to do this; since this feature is usually turned off in production environments, we've put this notice.)