festvoxtofreetts.sh

FreeTTS is a speech synthesis system written entirely in the Java programming language. It is based

            break
        elif [ "$REPLY" = "2" ]; then
            VP_GENDER="MALE"
            break
        elif [ "$REPLY" = "3" ]; then
            VP_GENDER="FEMALE"
            break
        elif [ "$REPLY" = "Q" ] || [ "$REPLY" = "q" ]; then
            exit 0
        fi
        #else try again
    done
}

setAge() {
    while true; do
	echo ""
	echo ""
	echo ""
        echo "Please enter the number corresponding to the age of this voice:"
        echo "     0 <Cancel>"
        echo "     1 Neutral:       Voice with an age that is indeterminate."
        echo "     2 Child:         Age roughly up to 12 years."
        echo "     3 Teenager:      Age roughly 13 to 19 years."
        echo "     4 Younger Adult: Age roughly 20 to 40 years."
        echo "     5 Middle Adult:  Age roughly 40 to 60 years."
        echo "     6 Older Adult:   Age roughly 60 years and up."
        echo "     Q <Quit>:        Abort the conversion process."
	echo ""
	echo ""

        read

        if [ "$REPLY" = "0" ]; then
            break
        elif [ "$REPLY" = "1" ]; then
            VP_AGE="NEUTRAL"
            break
        elif [ "$REPLY" = "2" ]; then
            VP_AGE="CHILD"
            break
        elif [ "$REPLY" = "3" ]; then
            VP_AGE="TEENAGER"
            break
        elif [ "$REPLY" = "4" ]; then
            VP_AGE="YOUNGER_ADULT"
            break
        elif [ "$REPLY" = "5" ]; then
            VP_AGE="MIDDLE_ADULT"
            break
        elif [ "$REPLY" = "6" ]; then
            VP_AGE="OLDER_ADULT"
            break
        elif [ "$REPLY" = "Q" ] || [ "$REPLY" = "q" ]; then
            exit 0
        fi
        # else try again
    done
}

if [ "$2" = "install" ]; then
    VP_DOMAIN=$FV_LANG
    VP_ORGANIZATION=$FV_INST
    if [ "$FV_TYPE" = "diphone" ]; then
        if ! [ "$FV_LANG" = "us" ]; then
            echo
            echo "This script can only install US/English voices."
            echo "Please refer to your documentation for instructions on"
            echo "how to procede."
            exit -1;
        fi
        VP_DOMAIN="general"
    elif [ "$FV_TYPE" = "ldom" ] || [ "$FV_TYPE" = "clunits" ]; then
        if [ "$FV_TYPE" = "clunits" ]; then
            VP_DOMAIN="general"
        fi
        echo
        echo "Warning: For US/English voices, this script will default to a full"
        echo "lexicon. For non US/English voices, no lexicon will be set;"
        echo "manual work will be required to make the voice usable."
	echo "If you need to adapt the lexicon settings, you can change"
        echo "that in the java voice directory after the install"
        echo "phase is finished."
        echo
        echo "Press <Enter> to continue, or <Ctrl-C> to cancel"
        read
    else
        echo
        echo "Only diphone, clunits, and ldom types are supported by this operation."
        echo "Aborting."
        exit -1;
    fi

    echo
    echo "Do you want to import the festival phoneset into FreeTTS (y/n)?"
    read

    if [ "$REPLY" = "Y" ] || [ "$REPLY" = "y" ] ; then
	(cd $VOICEDIR
	echo Creating $OUTDIR/phoneset.txt
	festival -b \
	    festvox/$FV_FULLVOICENAME.scm \
	    $ARCTICDIR/scheme/dump_phoneset.scm \
	    "(begin (voice_${FV_FULLVOICENAME}) (dump_phoneset))" > \
	    $OUTDIR/phoneset.txt
	)
    fi


    while true; do
        echo
        echo
        echo
        echo
        echo "Current properties of this voice:"
        echo "     0 <continue with installation>"
        echo "     1 Name:         '$VP_NAME'"
        echo "     2 Gender:       '$VP_GENDER'"
        echo "     3 Age:          '$VP_AGE'"
        echo "     4 Description:  '$VP_DESCRIPTION'"
        echo "     5 Full Name:    '$VP_FULL_NAME'"
        echo "     6 Domain:       '$VP_DOMAIN'"
        echo "     7 Organization: '$VP_ORGANIZATION'"
	echo "     8 Language:     '$VP_LOCALE'"
	echo "     9 Voice base path: '$VOICETARGETBASE'"
        echo "     H <Help>"
        echo "     Q <Quit>:       Abort the conversion process."
        echo
        echo
        echo "Enter the number for the property you would like to change,"
        echo "'0' if everything looks correct, or 'Q' to exit:"
        read

        if [ "$REPLY" = "Q" ] || [ "$REPLY" = "q" ]; then
            exit 0
        elif [ "$REPLY" = "H" ] || [ "$REPLY" = "h" ]; then
            echo
            echo
            echo
            echo
            echo
            echo
            echo "  Name: generally a one-word name by which you want this"
            echo "    voice to be known, such as \"kevin\", \"alan\","
            echo "    or \"dave\"."
            echo "  Description: a sentence or so that describes this voice."
            echo "  Gender: male, female, or neutral"
            echo "  Age: one of: Neutral, Child, Teenager, Younger Adult,"
            echo "    Middle Adult, Older Adult"
            echo "  Full Name: the name that will be used for the FreeTTS"
            echo "    files for this voice.  The Full Name must be unique"
            echo "    name from all other voices in FreeTTS.  It is HIGHLY"
            echo "    recommended that you do NOT change this property unless"
            echo "    it conflicts with an existing voice."
            echo "  Domain: the domain for limited domain voices (such as"
            echo "    \"time\" or \"weather\"), otherwise \"general\"."
            echo "  Organization: the organization which recorded the voice,"
            echo "    such as \"sun\" or \"cmu\"."
            echo "  All properties can be changed manually after the conversion"
            echo "    process, but it is easiest to do it now."
            echo
            echo "Press <Enter> to return to the menu."
            read UNUSED
        elif [ "$REPLY" = "0" ]; then  # only way to exit while loop
	    LOCALEPATH=`echo $VP_LOCALE | sed "s|_|/|g" | tr A-Z a-z`

	    # OK, user agreed to these settings -- let's remember them
            # for the future (i.e., compile).
            (
              echo "# Description of this voice for FreeTTS"
              echo "VP_NAME=\"$VP_NAME\""
              echo "VP_GENDER=\"$VP_GENDER\""
              echo "VP_AGE=\"$VP_AGE\""
              echo "VP_DESCRIPTION=\"$VP_DESCRIPTION\""
              echo "VP_FULL_NAME=\"$VP_FULL_NAME\""
              echo "VP_LOCALE=\"$VP_LOCALE\""
              echo "LOCALEPATH=\"$LOCALEPATH\""
              echo "VOICETARGETBASE=\"$VOICETARGETBASE\""

            ) > $VOICEDIR/etc/freetts.properties

	    VOICETARGETDIR=$FREETTSDIR/$VOICETARGETBASE/$LOCALEPATH
            if [ -d "$VOICETARGETDIR/$VP_FULL_NAME" ]; then
                echo
                echo "Warning: the voice '$FV_VOICENAME' is already installed"
                echo "in this version of FreeTTS (in $VOICETARGETDIR)."
                echo "Please enter the number corresponding to the action you would like to take: "
                echo "     0 Cancel conversion process"
                echo "     1 Over-write existing voice"
                echo "     2 Change your voice's Full Name"
                echo "        (it is recommended to follow a convention similar"
                echo "         to <institution>_<lang/domain>_<name>)"
                read REPLY2

                if [ "$REPLY2" = "0" ]; then
                    exit 0
                elif [ "$REPLY2" = "1" ]; then
                    echo
                    echo "Are you sure you want to over-write the existing"
                    echo "voice?  WARNING: May cause permanent loss of"
                    echo "existing voice!  (Yes/No/Cancel):"
                    read REPLY3

                    if [ "$REPLY3" = "Y" ] || [ "$REPLY3" = "y" ] \
                        || [ "$REPLY3" = "yes" ] || [ "$REPLY3" = "Yes" ] \
                        || [ "$REPLY3" = "YES" ]; then
                        echo
                        echo "***** Over-writing existing voice *****"
                        break # exit while loop
                    fi
                fi
            else
                break # exit while loop
            fi
        elif [ "$REPLY" = "1" ]; then
            echo
            echo "Enter a new name: "
            read VP_NAME
        elif [ "$REPLY" = "2" ]; then
            setGender
        elif [ "$REPLY" = "3" ]; then
            setAge
        elif [ "$REPLY" = "4" ]; then
            echo
            echo "Enter a new Description: "
            read VP_DESCRIPTION
        elif [ "$REPLY" = "5" ]; then
            echo
            echo "Enter a new Full Name: "
            read VP_FULL_NAME
        elif [ "$REPLY" = "6" ]; then
            echo
            echo "Enter a new domain (\"general\" for unlimited domains) : "
            read VP_DOMAIN
        elif [ "$REPLY" = "7" ]; then
            echo
            echo "Enter the organization which created this voice: "
            read VP_ORGANIZATION
	elif [ "$REPLY" = "8" ]; then
	    echo
	    echo "Enter the ISO Locale code for the language you are using,"
            echo "e.g., 'en_US' or 'de': "
	    read VP_LOCALE
	elif [ "$REPLY" = "9" ]; then
	    echo
	    echo "Enter the path where to install the voice:"
	    read VOICETARGETBASE
        fi
    done

    # start from a clean slate
    rm -rf "$VOICETARGETDIR/$VP_FULL_NAME" 2>/dev/null
    mkdir -p "$VOICETARGETDIR/$VP_FULL_NAME" 2>/dev/null

    if ! [ -d "$VOICETARGETDIR/$VP_FULL_NAME" ]; then
        echo
        echo "ERROR: Unable to create $VOICETARGETDIR/$VP_FULL_NAME."
        echo "Aborting."
    fi
    
    # java class names should begin with a capital letter
    VOICEDIRECTORY_CLASS=`echo $VP_NAME | awk '{ print(toupper(substr($0,1,1)) substr($0,2)) }'`"VoiceDirectory"
	FULL_VOICEDIRECTORY_CLASS=`echo $VOICETARGETBASE/$LOCALEPATH/$VP_FULL_NAME/$VOICEDIRECTORY_CLASS | tr / .`
	(
        echo "Copyright 2003 Sun Microsystems, Inc."
        echo 
        echo "See the file "license.terms" for information on usage and redistribution of"
        echo "this file, and for a DISCLAIMER OF ALL WARRANTIES."
        echo
        echo
        echo "This directory contains a voice imported from FestVox."
        echo "$VP_FULL_NAME.txt is the text version of the voice data."
        echo ".bin and .idx files are compiled versions of this file."
        echo "$VOICEDIRECTORY_CLASS.java is the voice directory which"
        echo "contains information about the voices (or variations on"
        echo "voices) that are provided in this directory.  By default"
        echo "the FestVox to FreeTTS conversion utility only puts one"
        echo "voice in this directory."
        echo
        echo "$VP_FULL_NAME.jar is the file that is created when FreeTTS"
        echo "is compiled.  This jar file will be put in the same directory"
        echo "as the other FreeTTS jar files.  (Generally '<FreeTTS>/lib/')"
        echo "voice.Manifest is used as the Manifest for the jar file."
        echo
        echo "Please confirm that $VOICEDIRECTORY_CLASS.java and"
        echo "voice.Manifest contain the correct information."
        echo "(If you created a ldom voice, it is still configured to use"
        echo "a full US/English lexicon.  You may wish to change that)."
    ) > "$VOICETARGETDIR/$VP_FULL_NAME/README"


    cp -f "$OUTDIR/phoneset.txt" "$VOICETARGETDIR/$VP_FULL_NAME/phoneset.txt"
    cp -f "$OUTDIR/$FV_VOICENAME.txt" "$VOICETARGETDIR/$VP_FULL_NAME/$VP_FULL_NAME.txt"
    echo "Main-Class: $FULL_VOICEDIRECTORY_CLASS" > "$VOICETARGETDIR/$VP_FULL_NAME/voice.Manifest"
    echo "FreeTTSVoiceDefinition: true" >> "$VOICETARGETDIR/$VP_FULL_NAME/voice.Manifest"
    if [ "$VP_LOCALE" = "en_US" ]; then
	echo "ClassPath: cmulex.jar" >> "$VOICETARGETDIR/$VP_FULL_NAME/voice.Manifest"
    fi
    if [ "$FV_TYPE" = "diphone" ]; then
        VD_TEMPLATE="$HELPERDIR/CMU_USDiphoneTemplate.java.template"
        UNIT_DATABASE_CLASS="com.sun.speech.freetts.diphone.DiphoneUnitDatabase"
        MAKEFILE_EXCLUDE="CLUNITS_ONLY"
    else #clunit
	if [ "$VP_LOCALE" = "en_US" ]; then
	    VD_TEMPLATE="$HELPERDIR/CMU_USClunitTemplate.java.template"
	elif [ "$FV_TYPE" = "ldom" ]; then
	    VD_TEMPLATE="$HELPERDIR/BaseLdomTemplate.java.template"
	else
	    VD_TEMPLATE="$HELPERDIR/BaseClunitTemplate.java.template"
	fi
        UNIT_DATABASE_CLASS="com.sun.speech.freetts.clunits.ClusterUnitDatabase"
        MAKEFILE_EXCLUDE="DIPHONE_ONLY"
    fi

    JAVALOCALE=`echo $VP_LOCALE | sed "s/_/\", \"/g"`
    PACKAGEPATH=`echo $VOICETARGETBASE/$LOCALEPATH | tr / .`
    # create the voice directory class
    cat $VD_TEMPLATE | sed "s/%CLASSNAME%/$VOICEDIRECTORY_CLASS/g" \
	| sed "s/%PATH%/$PACKAGEPATH/g" \
        | sed "s/%VOICENAME%/$VP_FULL_NAME/g" \
        | sed "s/%NAME%/$VP_NAME/g" \
        | sed "s/%GENDER%/$VP_GENDER/g" \
        | sed "s/%AGE%/$VP_AGE/g" \
        | sed "s/%DESCRIPTION%/$VP_DESCRIPTION/g" \
        | sed "s/%DOMAIN%/$VP_DOMAIN/g" \
        | sed "s/%ORGANIZATION%/$VP_ORGANIZATION/g" \
	| sed "s/%LOCALE%/$JAVALOCALE/g" \
        > "$VOICETARGETDIR/$VP_FULL_NAME/$VOICEDIRECTORY_CLASS.java"

    echo "The voice has been successfully installed in"
    echo "$VOICETARGETDIR/$VP_FULL_NAME/"
fi