¶ 1 Overview
This guide describes how to obtain and install binary packages for the Google Speech Synthesis (GSS) plugin to the UniMRCP server on Red Hat-based Linux distributions. The document is intended for system administrators and developers.
¶ 1.1 Applicable Versions
Instructions provided in this guide are applicable to the following versions.
UniMRCP 1.5.0 and above
UniMRCP GSS Plugin 1.0.0 and above
¶ 1.2 Supported Distributions
UniMRCP RPMs are currently available for x86_64 (64-bit) architecture only.
| Operating System | Released | End of Support |
|---|---|---|
| Red Hat / Cent OS 7 | May 2018 | July 2024 |
| Red Hat / Cent OS 8 | January 2021 | TBA |
| Red Hat / Cent OS 9 | August 2024 | TBA |
Packages for other distributions can be developed and made available in the scope of an annual maintenance agreement.
Contact Form Submit an inquiry¶ 1.3 Authentication
UniMRCP binary packages are available to authenticated users only. In order to register a free account with UniMRCP, please visit the following page.
Profile Registration Open an account at unispeech.ioA newly registered account needs to be verified by the user and then activated by the administrator prior further proceeding.
Account verification and activation.
The account credentials can be used to log in to the following websites.
¶ 2 Installing RPMs Using YUM
Using the Yellowdog Updater, Modifier (yum), a command-line package management utility for Red Hat-based distributions, is recommended for installation of UniMRCP binary packages.
¶ 2.1 Repository Configuration
Configure a repository by creating a file /etc/yum.repos.d/unimrcp.repo with the following content.
[unimrcp]
name=UniMRCP Packages for Red Hat / Cent OS-$releasever $basearch
baseurl=https://username:password@unimrcp.org/repo/yum/main/rhel$releasever/$basearch/
enabled=1
sslverify=1
gpgcheck=1
gpgkey=https://unimrcp.org/keys/unimrcp-gpg-key.public
[unimrcp-noarch]
name=UniMRCP Packages for Red Hat / Cent OS-$releasever noarch
baseurl=https://username:password@unimrcp.org/repo/yum/main/rhel$releasever/noarch/
enabled=1
sslverify=1
gpgcheck=1
gpgkey=https://unimrcp.org/keys/unimrcp-gpg-key.public
The username and password fields included in the HTTPS URI must be replaced with the corresponding account credentials.
Account credentials.
¶ 2.2 Repository Verification
In order to verify that yum can properly connect and access the UniMRCP repository, the following command can be used.
yum repolist unimrcp
yum repolist unimrcp-noarch
where unimrcp and unimrcp-noarch are names of the sections set in the yum configuration file above.
In order to retrieve a list of packages the UniMRCP repository provides, the following command can be used.
yum --disablerepo="*" --enablerepo="unimrcp" list available
yum --disablerepo="*" --enablerepo="unimrcp-noarch" list available
¶ 2.3 GSS Plugin Installation
In order to install the GSS plugin, including all the dependencies, use the following command.
yum install unimrcp-gss
In order to install the additional data files for the sample client application umc, the following command can be used.
yum install umc-addons
This package is optional and provides additional data which can be used for validation of basic setup.
¶ 3 Installing RPMs Manually
UniMRCP RPM packages can be installed manually using the rpm utility. Note, however, that the system administrator should take care of package dependencies and install all the packages in appropriate order.
The RPM packages have the following naming convention:
$packagename-$universion-$packageversion.el$rhelversion.$arch.rpm
where
-
packagename is the name of a package
-
universion is the UniMRCP version
-
packageversion is the RPM release version
-
rhelversion is the Red Hat version
-
arch is the architecture (x86_64, i686, …)
¶ 3.1 Package List
The following is a list of UniMRCP RPM packages required for the installation of the GSS plugin.
| Package Name | Description |
|---|---|
| unimrcp-gss | GSS plugin to the server. |
| unigrpc | UniMRCP edition of the gRPC library. |
| umc-addons | Sample en-US data files used with umc. [Optional] |
| unilicnodegen | Node information retrieval tool, required for license deployment. |
| unimrcp-server | Shared library and application of the server. |
| unimrcp-client | Shared libraries and sample applications of the client. [Optional] |
| unimrcp-demo-plugins | Set of demo plugins to the server. [Optional] |
| unimrcp-common | Data common for the client and the server. |
| uniapr | UniMRCP edition of the Apache Portable Runtime (APR) library. |
| uniapr-util | UniMRCP edition of the Apache Portable Runtime Utility (APR-Util) library. |
| unisofia-sip | UniMRCP edition of the Sofia SIP library. |
¶ 3.2 Package Installation Order
Note that all the RPM packages provided by UniMRCP are signed by a GNU Privacy Guard (GPG) key. Before starting the installation, you may need to import the public key in order to allow the rpm utility to verify the packages.
rpm --import https://unimrcp.org/keys/unimrcp-gpg-key.public
Packages for the APR, APR-Util and Sofia-SIP libraries must be installed first.
rpm -ivh uniapr-$aprversion-$packageversion.el$rhelversion.$arch.rpm
rpm -ivh uniapr-util-$apuversion-$packageversion.el$rhelversion.$arch.rpm
rpm -ivh unisofia-sip-$sofiaversion-$packageversion.el$rhelversion.$arch.rpm
Then, a package containing common data for the client and the server, and a package for the server should follow.
rpm -ivh unimrcp-common-$universion-$packageversion.el$rhelversion.$arch.rpm
rpm -ivh unimrcp-server-$universion-$packageversion.el$rhelversion.$arch.rpm
Next, a package containing the utility tool unilicnodegen, required for license deployment.
rpm -ivh unilicnodegen-$toolversion-$packageversion.el$rhelversion.$arch.rpm
Next, a package containing the gRPC library.
rpm -ivh unigrpc-$grpcversion-$packageversion.el$rhelversion.$arch.rpm
Finally, a package containing the GSS plugin should follow.
rpm -ivh unimrcp-gss-$universion-$packageversion.el$rhelversion.$arch.rpm
¶ 4 Obtaining License
The GSS plugin to the UniMRCP server is a licensed software.
Licensing Model Check out the licensing termsIn order to obtain a trial license, node information must be retrieved and submitted for license generation.
¶ 4.1 Node Information Retrieval
Use the installed tool unilicnodegen to retrieve the node information.
/opt/unimrcp/bin/unilicnodegen
As a result, a text file uninode.info will be saved in the current directory.
¶ 4.2 Order Placement
Consider the following procedure to place an order.
- Navigate to https://unispeech.io/gss.
- Under the section Obtain License, select
- License Variation: Trial
- License Term: 30-day
- License Type: Node-bound
- License Quantity: 2
- Click Add to cart and then View cart.
- Click Proceed to checkout and then Place order.
- Attach the retrieved uninode.info file to the placed order.
Ther orders are normally processed within one business day. A license file will be provided as a result.
¶ 4.3 License Installation
The license file needs to be placed into the directory /opt/unimrcp/data.
cp umsgss_*.lic /opt/unimrcp/data
¶ 5 Obtaining Service Credentials
In order to utilize the Google Cloud Text-to-Speech API, a corresponding service account credentials file needs to be retrieved from the Google Cloud Platform Console and further installed to the UniMRCP server.
¶ 5.1 Project Creation
Create a project in the Google Cloud Platform Console, if not already created. Projects allow to manage all Google Cloud Platform resources, including deployment, access control, billing, and services.
- Open the Cloud Platform Console
- In the drop-down menu at the top, select a project My First Project created by default or create a new project.
¶ 5.2 Project Billing
Enable billing for your project, if not already enabled. Enabling billing allows the application to consume billable resources such as Dialogflow API calls. See Cloud Platform Console Help for more information about billing settings.
¶ 5.3 Text-to-Speech API
In the Google Cloud Platform Console, navigate to API & Services and enable the Text-to-Speech API.
¶ 5.4 Credentials Retrieval
Download a service account credentials file.
- In the Google Cloud Platform Console, navigate to API & Services > Credentials > Create credentials > Service account key
- Under Service account, select New service account.
- Under Service account name, enter a service account name of your choice. For example, accessor.
- Under Role, select Project > Owner. To better understand the Cloud IAM roles that you can grant to your service account to access Cloud Platform resources, check out the following page.
- Under Key type, leave JSON selected.
- Click Create to create a new service account and download the json credentials file.
¶ 5.5 Credentials Installation
The downloaded json credentials file needs to be placed into the directory /opt/unimrcp/data.
cp *.json /opt/unimrcp/data
¶ 6 Configuring Server and Plugin
¶ 6.1 Plugin Factory Configuration
In order to load the GSS plugin into the UniMRCP server, open the file unimrcpserver.xml, located in the directory /opt/unimrcp/conf, and add the following entry under the XML element <plugin-factory>. Disable other synthesizer plugins, if available. The demo plugins for other resources can also be disabled.
<!-- Factory of plugins (MRCP engines) -->
<plugin-factory>
<engine id="Demo-Synth-1" name="demosynth" enable="false"/>
<engine id="GSS-1" name="umsgss" enable="true"/>
</plugin-factory>
¶ 6.2 Logger Configuration
In order to enable log output from the plugin and set filtering rules, open the configuration file logger.xml, located in the directory /opt/unimrcp/conf, and add the following entry under the element <sources>.
<source name="GSS-PLUGIN" priority="INFO" masking="NONE"/>
¶ 6.3 GSS Plugin Configuration
The configuration file of the plugin is located in /opt/unimrcp/conf/umsgss.xml. Default settings should be sufficient for general use.
Usage Guide Refer to the Usage Guide for more information¶ 7 Validating Setup
Validate your setup by using the sample UniMRCP client and server applications on the same host. The default configuration and data files should be sufficient for a basic test.
¶ 7.1 Launching Server
Launch the UniMRCP server application.
cd /opt/unimrcp/bin
./unimrcpserver
In the server log output, check whether the plugin is normally loaded.
[INFO] Load Plugin [GSS-1] [/opt/unimrcp/plugin/umsgss.so]
Next, check for the license information.
[NOTICE] UniMRCP GSS License
-product name: umsgss
-product version: 1.0.0
-license owner: Name
-license type: trial
-issue date: 2018-05-11
-exp date: 2018-06-10
-channel count: 2
-feature set: 0
Next, check for the service account credentials.
[NOTICE] Set Google App Credentials /opt/unimrcp/data/My First Project-a78…c15.json
¶ 7.2 Launching Client
Note: the optional package umc-addons must be installed for this test to work.
Launch the sample UniMRCP client application umc.
cd /opt/unimrcp/bin
./umc
Run a typical speech synthesis scenario by issuing the command run bss1 from the console of the umc client application.
run bss1
This command sends a SPEAK request to the server and then records synthesized stream into a PCM file stored in the directory /opt/unimrcp/var.
Visually inspect the log output for any possible warnings or errors.