News: Downloadable PDA Demos
Introduction
Technical Description
How To
Documents
Product Brief
White Paper
Supported Platforms
Consulting
License Terms
NFL Demo
Downloads
Secure Travel Demo
FAQ's for Users
&
Developers
Registration Form and License Agreement
SDK Access
Client Access
Feedback
Other Sprex Products/Services
Exit
|
Guide for TallyGram-1.5 Applications
Version: 040814a
Contact: Fred Kaudel, fred@sprex.com
Copyright (C) 2004, Sprex, Inc.
Abstract:
TallyGram-1.5 is the latest version of TallyGram, a system for using
your voice to record sequences of activities that occur at
certain kinds of events like sports contests, etc.
TallyGram uses the Active, Networked, Speech Recognition system, ANSR,
from Sprex, Inc. The TallyGram program you click on is a skin
on the ANSR client program named "face".
This guide is for users of any of any TallyGram-1.5 client
application. TallyGram-1.5 client applications connect to a
TallyGram-1.5 server across the Internet or (for faster performance)
any Intranet. TallyGram and ANSR are available on Windows CE and
Windows XP (operation of the Windows XP version under other Windows
versions is likely, but not tested). Updated releases of
TallyGram-1.5 client application demos are available several times
each month from:
http://cassandra.sprex.com/ops/omni.php?op=downloads&for=ansr
in either the Windows CE or Windows XP release formats. Extra
features and updates can be provided on request. Please let us know
of any comments, questions or suggestions. Additional available
documentation includes an FAQ (Frequently Asked Questions) for users,
a guide for developers to configure and enhance new and existing face
applications, and other help files for those applications. Source
code for some components is available with the ANSR developer's
toolkit.
Disclaimer:
Your contact and Sprex, Inc. have taken care in the preparation of
this guide, but make no expressed or implied warranty of any kind and
assume no responsibility for errors or omissions. No liability is
assumed for incidental or consequential damages in connection with or
arising out of the use of the information contained herein. Most of
these instructions are developed considering an iPAQ H5450 Pocket PC
2002 with 1.00.45 ENG firmware and for Windows XP Professional,
although the instructions should apply for other PDAs and versions of
Windows also. We have feedback that face applications (including
TallyGram) work on Pocket PC 2003 as well as on Pocket PC 2002
platforms. Consult your PDA's and/or computer's reference guide for
specific information on resets and operation.
Table of Contents:
1. GUI overview
1.1 status field
1.2 buttons
2. menu items
2.1 File menu items (exit)
2.2 Edit menu items (config)
2.3 Tools menu items (go)
2.4 Help menu items (about, commands, what to say)
3. using TallyGram
4. acronyms/abbreviations/terms
5. installation
5.1 PDA installation
5.2 Windows XP installation
1. GUI Overview:
------------
After installing the TallyGram program on your PDA (see section 5.1), there
will be a "TGtype" menu item on the start menu bar (where type is replaced
by the type of TallyGram program; e.g., tennis). After installing
the TallyGram program on your computer (see section 5.2) there will be a
"TGtype" menu item on the Start->All Programs menu bar.
To start the TallyGram program, open the start menu bar and select the TGtype
menu item. TallyGram is usually started from the start menu bar under
Windows CE. For Windows XP, TallyGram is usually started by
double-clicking on the TGtype.exe icon in the TallyGram distribution
directory (not on the XP desktop).
When TallyGram-1.5 starts to run, a splash screen is shown first. Click on
the OK button to continue to the main window. Then the main window is
displayed, as follows (TYPE is replaced by the current type of TallyGram;
e.g., 'TallyGram Tennis' represents the TallyGram for Tennis application;
section 2.4 lists the most common TallyGram types).
--------------------------------------
|START TallyGram TYPE TIME X|
--------------------------------------
| |
| MAIN field |
| |
| PROMPT field |
| |
| [What to Say] [{,Play}] |
| |
| [ Go ] [ Tally ] |
| |
| STATUS field |
| |
--------------------------------------
| File Edit Tools Help SIP|
--------------------------------------
Note 1: for Windows XP, the File, Edit, Tools and Help menu items are on the
top of the window, rather than the bottom of the window. Also,
the Go and Tally buttons are on the same row as the Exit and Play
buttons.
Note 2: for Windows CE, don't be surprised by the upper right "X" button.
This does not, as you might expect, close the application and
release its resources; rather the "X" button just hides the
main window, allowing it to be simply unhidden the next time
you start TallyGram. This is a handy way for you to do other
things and then return to TallyGram quickly.
Figure 1. TallyGram Main Display Window Elements
Figure 1 illustrates the locations and labels of the three types of
main window elements -- fields, buttons and menu items:
- the main, prompt and status fields contain text messages on the
current state of TallyGram. The status field is described in section 1.1.
- three or four buttons are displayed with the text messages show above, for
the user to select TallyGram actions. See
section 1.2 for the list of button names and their functions.
- the four menu items are either pop-up or pull-down (depending on the
host operating system). The File, Edit, Tools and Help menu items are
described in section 2.
1.1 Status Field:
The main window status field is described in detail in this section.
Usually, the main window's status field has the following format (note
that represents variable content described below):
STATUS Verbose:
Input: from mike
Play?:
Save?:
Init:
Go count:
Where:
- for Windows CE is ", 0x"
- for Windows XP is "debug=, trace=0x"
- is one of "off", "medium" and "hi".
- is an integer bit-vector displayed in hexadecimal format,
containing any combination (or none) of the following hexadecimal choices:
400 represents TRACE_PROFILE.
For the demo version, 0x400 is shown. Details on this setting and the
other settings are available with documentation for the full version of
TallyGram.
- is "ask", or "yes" or "no"; "ask" means to ask before
re-playing recorded audio samples (and to ask again after playing if the
answer is Yes), "yes" means to play recorded audio samples once, and "no"
means to not play recorded audio samples (note that Edit->Play can usually
re-play the most recently recorded audio sample, regardless of this setting).
- indicated which files are saved locally. One of the following values
is displayed: "none", "samples", "sent", "samples+sent", "params" or
"samples+params".
If "none" is displayed, then no files are saved for each utterance processed.
If "samples" is displayed, then the most recent live audio input utterance is
saved in a file. Further, for networked mode, "sent" and "samples+sent" save
the transmitted data ("sent"), without or with, respectively, also saving the
input utterance. For standalone mode, the settings "params" and
"samples+params" save MFCC parameters, without or with, respectively, also
saving the input utterance. See the Files description in Section 2.4 for
more details on the settings for these values and how to influence them.
- is either "done" or "not done", indicating whether or not the
application has been initialized for recognition (done).
- is a non-negative integer, showing the number of utterances
processed.
1.2 Buttons:
This section lists the currently available main button labels and their
meanings.
Label Meaning
----- -------
What to Say Example phrases for this TallyGram application
Go Listen to and Process the next utterance
Tally Report on the current status/summary of previous utterances
Play Re-Play the previous utterance. This is only visible after
the first Go has completed
2. Menu Items:
----------
File, Edit, Tools and Help pop-up menu items are displayed in the
lower left under Windows CE. For Windows XP, these menu items are
drop-down in the upper-left part of the window.
The following sections list and describe the available File, Edit,
Tools and Help menu items (menu bar choices) with descriptions of
their meanings and applications. Menu items are described
in paragraphs of the following format:
: ''\n +one-line summary.\n description.
To use accelerator-keys, ensure that SIP is in Keyboard
mode, then select the keyboard, then select Ctl (the control key on
the SIP keyboard -- note that it is not labelled Ctrl, for space
reasons), then select the key (e.g., Ctl+A, or ^A for TallyGram-1.5
information). Note that for Windows CE, some of the commands synopses
are shortened (e.g., "Version Info" becomes "Version"), to better fit
the display.
2.1 File Menu Items:
-Exit: exit TallyGram '^X'
+quit application, close window.
This option closes the TallyGram application (releasing any remaining HAPI
resources). Use this option instead of the "X" button in the upper right,
which will not close the application, but rather leave the application
running and just close the display window.
2.2 Edit Menu Items:
-Config: pick mode/details '^C'
+pick mode, config files, server IP add/port, sending grammar name/port.
This command is only available with the full version of TallyGram.
2.3 Tools Menu Items:
-Go: recognize input '^G'
+recognise an utterance.
This option is to record an utterance and to process it for recognition
by an ANSR sprecd server. After live mike input is recorded, it is saved
and can be replayed any number of times. After each such utterance is
processed, you are prompted to check if you want to have another utterance
processed.
2.4 Help Menu Items:
-About: version info '^A'
+displays TallyGram-1.5 information with Sprex logo and version/date.
This displays a window with TallyGram date information. Press OK to return
to the main display window (under Windows CE, the menu bars are not
available from this window).
-Commands: this message '^I'
+displays list of menu items (commands) and their information synopses.
This is a window listing the commands (menu items), with each item's info
synposis. For networked mode, if the debug level is not off, then a report
with the currently set options in more detail is also shown. For networked
mode, if the debug level is hi, then a report of both the face-1.5 and
sprecc-1.5 version strings and the start date is displayed.
Note: if debug is "hi" and flacemode is 3, FLACESPREXAUDIO (you may be able
to view/cycle this using Help->About), then you are able to record/playback
several seconds of audio as a demonstration, using either the example
SprexAudio.h functions or the bronze-level SprexAudio functions.
-What to Say: what to say '^W'
+displays example list of utterances for this TallyGram type.
This is a window listing a few illustrative example utterances for this
TallyGram Client application. More examples utterances are listed below
for the most widely used TallyGram types:
Baseball:
BALL
BREAKING BALL
COUNT IS THREE AND ONE
EARNED RUN
FLY BALL TO DEEP CENTER FIELD
GROUND BALL
HOME RUN
IN THE DIRT
KNUCKLE BALL
LOW AND OUTSIDE
NEXT BATTER
OUT AT THIRD
PICKOFF ATTEMPT
RIGHT FIELDER UP TO BAT
STRIKE THREE YOURE OUT
THREE AND ONE
WALK
Chess:
CASTLE TO THE RIGHT
QUEEN'S SIDE CASTLE
BLACK QUEEN'S PAWN TO QUEEN'S FOUR
WHITE KING'S BISHOP TO QUEEN'S BISHOP'S SIX TAKES KNIGHT
BLACK KING TO QUEEN'S BISHOP'S TWO TAKES PAWN
WHITE BISHOP TO KING'S ROOK'S THREE
BLACK QUEEN'S ROOK TO QUEEN'S ROOK'S SEVEN TAKES BISHOP
WHITE KING'S CASTLE'S PAWN TO KING'S CASTLE'S FIVE
CHECK
CHECK MATE
Golf:
ADDRESSING THE BALL
BIRDIE
CHIP SHOT
DOUBLE EAGLE
EIGHT IRON
FOUR WOOD
GROUND BALL
HIT A TREE
HOLE IN ONE
INTO A SAND TRAP
LOST BALL
MISSED THE GREEN
NUMBER THREE DRIVER
ON THE FAIRWAY
ONTO THE GREEN
PAR
STROKE
TEEING OFF
Ping Pong:
ACE
BACKHAND LOB
CHOP
DOUBLE BOUNCE NO SPIN SERVE
ERROR
FAST TOPSPIN SERVE
GOOD SHOT
HAND TOUCHED THE TABLE
INJURY TIMEOUT
LET
MISSED INTO THE NET
NO SPIN SERVE RETURNED LONG
OVERHEAD SMASH
PENALTY POINT
PUSH
RACKET TOUCHED THE TABLE
STRENGTH
TOP SPIN BACKHAND
UNFORCED ERROR
WEAKNESS
Produce:
ACORN SQUASH
BABY PEELED CARROTS
CELERY STICKS
DAIKON
ELEPHANT GARLIC
FUJI APPLES
GINGER ROOT
HASS AVOCADOES
ICEBERG LETTUCE
JALAPENO PEPPERS
KIWI FRUIT
LEMONS
MUSHROOMS
NECTARINES
ORANGE BELL PEPPERS
PINEAPPLE
ROMAINE LETTUCE
SCALLIONS
TOMATOES ON THE VINE
VALENCIA ORANGES
WATERMELON
YAMS
ZUCCHINI
Tennis:
ACE
BACKHAND
BASELINE
DOUBLE FAULT
ERROR
FAULT
HAND TOUCHED THE NET
INJURY TIMEOUT
KICK SERVE
LET
MISSED WIDE
ON THE LINE
PENALTY POINT
RETURN WINNER
SERVE MISSED INTO THE NET
TWO HANDED BACKHAND
UNFORCED ERROR
VOLLEY
WINNER
3. Using TallyGram:
---------------
There are two major modes of TallyGram operation: recording, and
reviewing. During a sporting event, you first start TallyGram, then
as events occur during the game, you verbally enter them into
TallyGram using the recording mode (described next). During
intermissions and at the end of the game, you can review the scores
and statistics by using the reviewing mode.
For the recording mode, press the Go button, wait about a second after
the first beep, speak your phrase into your microphone and then wait
for your recognition result to be returned (normally within a few
seconds). Repeat this operation during the game to record the
progress. When the game is over, or during a break, you can switch to
the reviewing mode by pressing the Tally button (with the full version
of TallyGram).
For the reviewing mode, press the Tally button. This will recall all
the scores and statistics for the current and previous events. These
statistics include totals for each type of event and the counts of
each event during each portion of the sporting event. The reviewing
mode is not available in the demo version of TallyGram.
To review this information on your PDA, use the .txt version and
Pocket Word, or the .html version and Internet Explorer. In either
case, copy the file to '\My Documents' on your PDA.
4. Acronyms/Abbreviations/Terms:
----------------------------
Ctl Control key on keyboard
FAQ Frequently Asked Question
$FACEDIR under Windows CE, this is '\My Documents',
under Windows XP, this is '..\TGdist'
MessageBox a message box dialog box of either the OK or Yes/No variety which
interrupts execution and is intended to prevent other inputs to
TallyGram until the user responds to this interaction
PDA Personal Digital Assistant
proc. process
SIP Secondary Input Panel (keyboard replacement for Pocket PC)
5. Installation:
------------
For the Windows CE release, follow section 5.1, while for the Windows
XP release, follow section 5.2.
5.1 PDA Installation:
To install TallyGram-1.5, use the following four steps to copy (using
ActiveSync) the distribution files to four directories on your PDA:
a. Copy (using Windows Explorer->right click) the files in
putInMyDocumentsOnPDA to '\My Documents' on your PDA
(using ActiveSync->Explore->Address bar->
Mobile Device->My Pocket PC->My Documents->right click on blank part of
lower right pane of My Documents window->Paste)
b. Copy (as above) the file(s) in putInRootOnPDA to My Pocket PC (root, or \)
on your PDA
c. Copy (as above) the file(s) in putInWindowsOnPDA to \Windows\ on your PDA
d. Copy (as above) the file TGtype.exe in ARMDbg to \Windows\Start Menu\ on
your PDA (this makes TallyGram available to run by clicking on Start and then
TGtype). NOTE: TGtype has 'type' replaced by the type of TallyGram
application; for example: TGtennis for the TallyGram for Tennis application.
Note: after and during copying the files for each of these steps, you may
often see ActiveSync messageboxes asking you to confirm replacing the file on
your PDA with the file in your distribution directory; answer Yes to these
questions (the files on your PDA will have a different date than the original
file in your distribution; this is because the copying does not preserve the
original file's date, just its other data).
5.2 Windows XP Installation:
-extract the files from your .zip file into a tree with four directories,
as follows:
-TGdist
-ansrc
-TG
-TG\Debug
-after extracting the files as directed above, there is no need to copy
the files to other directories (in particular, do not copy the file
TGtype.exe to the XP desktop). NOTE: TGtype has 'type' replaced by the type
of TallyGram application; for example: TGtennis for TallyGram's Tennis
application.
-run TallyGram by double-clicking (using File Explorer) on the TGtype.exe icon
in TG\Debug