Home > Articles > Programming > Java

Like this article? We recommend

Getting Up and Running with Java Speech Technology

The setup for speech software is a little more fiddly than usual for Java programs. To run the Java examples, you’ll need the following:

  • A speech engine (I used FreeTTS version 1.2.1)
  • Java TM 2 SDK, Standard Edition, v 1.4 or higher (I used version 1.5)
  • A pair of headphones or PC speakers

I had to do a few things to get the code to run:

  1. Download a copy of FreeTTS.
  2. Unzip the freetts-1.2.1 distribution into the required disk location.
  3. Copy the file speech.properties from the top-level freetts-1.2.1 folder into the lib folder of your Java Runtime Environment (JRE). On my PC, the folder is as follows:
    C:\Program Files\Java\jre1.5.0_06\lib

You should now be ready to run the FreeTTS Java examples. Let’s take a look at some simple speech synthesis. I always think that it’s a good practice to create a complete standalone example from scratch, rather than just modifying an example. To do this, I used the facilities included with FreeTTS, as described in the next section.

Payment Program with Speech Synthesis

To begin with, I’ll put my money where my mouth is (after criticizing that parking system earlier) and create a simple payment program. This is a modified version of one of the FreeTTS examples. Follow these steps to create, build, and run this program:

  1. Open the file demo.xml in the top-level FreeTTS folder.
  2. Modify demo.xml by pasting the contents of Listing 1 (below) between the following targets:
    compile_jsapi_mixedvoices
    compile_jsapi_player
  3. Under the folder FreeTTS\Code\freetts-1.2.1\demo\JSAPI, create a new folder called PaymentMachine.
  4. Copy the download files Manifest and PaymentMachine.java into the PaymentMachine folder.
  5. To build the code, run the following command from any FreeTTS folder:
    ant -find demo.xml
  6. Run the following command from the freetts-1.2.1 folder:
    java -jar bin/PaymentMachine.jar

Listing 2 shows the modifications needed in demo.xml.

Listing 2 A new target for the payment program.

<target name="compile_jsapi_paymentmachine"
 depends="compile_demo_util"
 if="jsapi_jar.isPresent">
<mkdir dir="${demo_classes_dir}/JSAPI/PaymentMachine"/>
<javac debug="true"
  source="1.4"
  deprecation="true"
  srcdir="${src_dir}/demo/JSAPI/PaymentMachine"
  destdir="${demo_classes_dir}/JSAPI/PaymentMachine">
 <classpath>
  <path refid="libs"/>
 </classpath>
</javac>
<mkdir dir="${bin_dir}"/>
 <jar destfile="${bin_dir}/PaymentMachine.jar"
  manifest="${src_dir}/demo/JSAPI/PaymentMachine/Manifest"
  basedir="${demo_classes_dir}/JSAPI/PaymentMachine"
  includes="*.class"
  filesonly="true"
  compress="true"/>
</target>

At this point, you should see program output similar to that in Listing 3.

Listing 3 Payment program output prompts.

C:\ FreeTTS\Code\freetts-1.2.1>java -jar bin/PaymentMachine.jar
 ** Payment Machine - JSAPI Demonstration program **
 Allocating synthesizers...Loading voices...Ready for payment.
Initial Greeting - requesting ticket
Validating ticket
Handle receipt request
Cleaning up and exiting.

If you run the program and watch the output from Listing 3, you’ll see that the output prompts follow the audio-driven flow of the program. This is pretty important in speech-enabled software—you don’t want to see a message concerning receipt handling when the customer ticket has only just been presented! This important requirement is implemented using the code in Listing 4.

Listing 4 Synchronizing speech and program prompts.

synthesizer1.speakPlainText("Welcome to speech-enabled payment.", null);
System.out.println("Initial Greeting - requesting ticket");
synthesizer1.speakPlainText("Please insert your ticket", null);
synthesizer1.speakPlainText("Thank you.", null);
synthesizer1.waitEngineState(Synthesizer.QUEUE_EMPTY);
synthesizer1.speakPlainText("I’m checking your ticket now. Please wait.", null);
synthesizer1.waitEngineState(Synthesizer.QUEUE_EMPTY);
System.out.println("Validating ticket");

Did you notice the calls to waitEngineState() in Listing 4? These calls are needed in order to synchronize the synthesis with the program output. If I omit these calls, then the output prompts appear out of sequence while the text is being spoken. Clearly, if this is my requirement for all program output, then it would be better to have a separate method call that incorporates the calls to both speakPlainText() and waitEngineState(). This method call would avoid the need for peppering the code with calls to waitEngineState(). But you get the idea.

As you can see, it’s not too difficult to produce some speech-enabled software.

Where Speech Is Different

One of the things I like about speech code is that it adds an interesting new dimension to software. In the code in Listing 5 (an excerpt from my payment program), I include information about how much time the customer has available to leave the car park.

Listing 5 Edgy information that can help customers.

synthesizer1.speakPlainText("To avoid further charges, you now have 15 minutes to leave the car park.", null);

In printed form, this message might be interpreted as rude, or it might be printed on the back of a ticket in microscopic writing and hence never get read by the customer. But in a speech-enabled program, such a message serves to inform the customer in a useful way—I know that it’s always a mystery to me how quickly I have to hurry along after paying for parking. (Five minutes? Ten?)

In other words, certain items of information are really quite well-suited to the medium of synthesized speech. If the message was printed on the screen of the payment machine, the customer might not see it.

Clearly, this type of issue is a matter of opinion/design—and possibly even culture—but it indicates that speech-enabled software is different from voiceless apps. Such software opens up new and intriguing information channels.

Tinny Voices

If you listened to the speech synthesized in my example program, you might have noticed a certain tinny quality to the voice. This can be changed easily. If you run the FreeTTS MixedVoices example (with the command java -jar bin/MixedVoices.jar), you can listen to a somewhat more mellifluous voice.

The next example uses another of the FreeTTS samples. This one provides a simple example of using the Java Speech API to speak the time, using the high-quality FreeTTS cluster unit selection voice. If you managed to get the first two examples working, then following command is all that’s required for this one. (As in the previous examples, run this command from the top-level freetts-1.2.1 folder.)

java -jar bin/JTime.jar

When you run this program, you should see the console output shown in Listing 6.

Listing 6 JSAPI Time Demo.

All time Mode JSAPI Synthesizers and Voices:
 FreeTTS en_US time synthesizer (mode=time, locale=en_US):
  alan

Using voice: alan
Enter time (HH:MM): 7:13
Bad time format. The format should be HH:MM
Enter time (HH:MM): 07:13
Enter time (HH:MM): 19:20
Enter time (HH:MM):

When you enter a time at one of the prompts (such as 07:13, as shown in Listing 6), the program responds by speaking that time in a distinctly non-tinny voice. To exit the program, just press Enter without typing a time.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020