HowTo Newsletter 8/2012 (Verbio en Asterisk)

Documento técnico completo en español de todos los pasos de la instalación y configuración de los motores de síntesis y reconocimiento de voz de Verbio sobre plataformas Asterisk.

A continuación os incluimos los pasos que deben seguir los usuarios que quieran instalar Verbio sobre entornos Linux – Asterisk

1. Visión general

   • README_FIRST

2. Instalación del motor de ASR + TTS

   • README-INSTALL-VERBIO

3. Integración con Asterisk

   • INSTALL – Cómo instalar las aplicaciones de Verbio para Asterisk

   • README – Aplicaciones disponibles de Verbio para Asterisk  (documentación y ejemplo de las aplicaciones)

En los documentos vienen todos los pasos de la instalación-configuración en español

README_FIRST

Verbio-Asterisk integracion

Introducción Verbio - Asterisk

Para poder poner en marcha el sistema Verbio - Asterisk, deberemos disponer de

los siguientes componentes:

1. Servidor Verbio voxserver.

2. Servidor Asterisk con las aplicaciones Verbio instaladas.

      _____
     |         |    _ Servidor Asterisk _
     |   *    |   
     |   ---  |    Mediante las aplicaciones (dialplan) Verbio,se realizan
     |_____|    peticiones de síntesis y reconocimiento al voxserver.

        ^

        |
        |
        v
      _____
     |        |    _ Servidor Verbio voxserver _
     | vox  |   
     | srv   |    Proporciona recursos de síntesis y reconocimiento.
     |_____|

Nota: Ambos componentes pueden estar instalados en el mismo equipo.

Para realizar la instalación del servidor Verbio voxserver, deberemos seguir los pasos que se detallan en el documento de instalación[1] de Verbio. Hay que tener en cuenta que, a la hora de realizar la instalación de los  locutores (TTS) de Verbio, deberemos usar la versión a 8Khz de los mismos.

Para instalar las aplicaciones Verbio en asterisk, seguir los pasos que se indican en el documento 'INSTALL' del paquete 'verbio-asterisk'. Una vez completada la fase de instalación de dichas aplicaciones, leer detenidamente el documento 'README' (incluido en el paquete 'verbio-asterisk'), para aprender sobre el funcionamiento y configuración, de las aplicaciones Verbio en Asterisk.

Si nos encontramos con algún problema durante la instalación y/o puesta en marcha,
podemos consultar el documento 'FAQ' que encontraremos en el paquete 'verbio-asterisk'.

Toda la documentación y paquetes necesarios los podemos encontrar (una vez
registrados) en la zona de descargas de la web de Verbio Technologies  (www.verbio.com).

README-INSTALL-VERBIO

• Verbio ASR/TTS installation instructions.
• Guía de instalación de los motores ASR/TTS de Verbio.
• Verbio Technologies S.L.
• www.verbio.com
• support@verbio.com

Instalación de Verbio en plataformas GNU/Linux

Este documento es una pequeña guía sobre la instalación de los motores de síntesis y reconocimiento de voz de Verbio sobre plataformas GNU/Linux.

Índice

1. Introducción y consideraciones previas.
2. Listado de paquetes disponibles.
3. Instalación sobre distribuciones que hacen uso del sistema de paquetes 'rpm' (redhat, centos, suse...)
4. Instalación sobre distribuciones que hacen uso del sistema de paquetes 'deb' (debian, ubuntu,...)
5. Configuración y puesta en marcha del sevidor voxserver (verbiod).
6. Preguntas frecuentes (FAQ)

1.- Introducción y consideracions previas 

Introducción:

Verbio es un sistema de reconocimiento y síntesis de voz basado en arquitectura cliente - servidor:

 _______________________________________________________________
|     _____                              |
|    |         |            _ Cliente Verbio _            |
|    |  V     |                            |
|    | ---    |        Realiza peticiones de síntesis y/o        |
|    |_____|       reconocimiento al servidor voxserver.    |
|                                           |
|            ^                            |
|             |                            |
|             |                            |
|            v                            |
|     _____                            |
|    |        |        _ Servidor Verbio voxserver _        |
|    | vox  |                            |
|    | srv   |           Proporciona recursos .        |
|    |_____|     de síntesis y reconocimiento        |
|                                |
| Nota: Cliente y servidor pueden estar en el mismo equipo.    |
|___________________________________________________|

Consideraciones previas:

• Los paquetes verbio se pueden descargar de la sección de soporte, en la página web de Verbio Technologies (ww.verbio.com).

​(Si se tiene alguna duda sobre los paquetes a instalar, contactar con el departamento técnico de Verbio  support@verbio.com)

• Si no se usa ni 'rpm' ni 'deb', contactar con el departamento técnico de Verbio (también están disponibles paquetes 'tgz' y 'genéricos').

2.- Listado de paquetes disponibles

En esta sección, se presentan los paquetes Verbio disponibles, para ser instalados sobre plataformas GNU/Linux.

• Cliente verbio (Verbio Developer):

verbio-clients        contiene las librerías, ejemplos y documentación
            necesária, para el desarrollo de aplicaciones de voz.

• Motor de síntesis/recnocimiento (servidor voxserver -verbiod-):

verbio-engines        Este paquete es de obligada instalación
            cuando estemos montando el servidor de
            síntesis/reconocimiento.

• Configuraciones de reconocimiento (ASR):

Nota: instalaremos el/los paquete(s) que correspondan, según los idiomas que necesitemos.

• Text To Speech (síntesis):

Nota: instalaremos el/los paquete(s) que correspondan, según los locutores que necesitemos.

Contactar con Verbio Technologies (support@verbio.com), para consultar disponibilidad de otros idiomas (tanto de reconocimiento como síntesis).

3.- Instalación de Verbio en distribuciones que hacen uso de paquetes RPM

A) Desinstalar (si tenemos alguna instalación previa) todos los paquetes Verbio:

A.1) Encontrar los paquetes Verbio que tengamos instalados en nuestro sistema.

Ejemplo:
# rpm -qa | grep -i verbio
verbio-tts-*
verbio-engines
verbio-asr-*
verbio-clients
[...]

A.2) Desinstalar los paquetes encontrados (verbio-engines /deberá/ ser el último).

Ejemplo:
[...]
# rpm -e verbio-tts-*
# rpm -e verbio-asr-*
# rpm -e verbio-clients
# rpm -e verbio-engines

B) Instalar los nuevos paquetes Verbio (verbio-engines /deberá/ ser el primero)

Ejemplo:
# rpm -ivh verbio-engines-x.yy.i386.rpm
# rpm -ivh --force verbio-clients-x.yy.i386.rpm
# rpm -ivh --force verbio-tts-*-x.yy.i386.rpm
# rpm -ivh --force verbio-asr-*-x.yy.i386.rpm

C) Si disponemos de una mochila con licencia, deberemos instalar el paquete (que encontraremos
   en:'/usr/share/doc/verbio') que contiene el driver de dicho dispositivo:
    # rpm -ivh sntl-sud-x.y.z.i386.rpm

   Si disponemos de una licencia en fichero, copiarla en: '/opt/verbio/lic'

D) Copiar el directorio '/usr/share/doc/verbio/samples' a nuestra 'home' (por ejemplo),
para poder compilar y ejecutar algunos ejemplos que allí encontraremos.

E) La documentación de verbio la podemos encontrar en: '/usr/share/doc/verbio':
- library-sdk_es.pdf  (documentación sdk verbio).
- guide_es.pdf (capítulos 4 y 5 para aprender sobre reconocimiento y síntesis del habla)

Nota: En este punto se recomienda seguir con la lectura de la sección "Configuración y puesta en marcha del servidor voxserver", en este mismo documento.

4.- Instalación de Verbio en distribuciones que hacen uso de paquetes DEB 

A) Desinstalar (si tenemos alguna instalación previa) todos los paquetes Verbio:

A.1) Encontrar los paquetes Verbio que tengamos instalados en nuestro sistema.

Ejemplo:
# apt-cache search verbio | grep -i verbio
verbio-tts-*
verbio-asr-*
verbio-engines
verbio-clients
[...]

A.2) Desinstalar los paquetes encontrados (verbio-engines /deberá/ ser el último).

Ejemplo:
[...]
# apt-get remove --purge verbio-tts-*
# apt-get remove --purge verbio-asr-*
# apt-get remove --purge verbio-clients
# apt-get remove --purge verbio-engines

B) Instalar los paquetes Verbio (verbio-engines /deberá/ ser el primero)

Ejemplo:
# dpkg -i verbio-engines-x.yy.deb
# dpkg -i --force-overwrite verbio-clients-x.yy.deb
# dpkg -i --force-overwrite verbio-tts-*-x.yy.deb
# dpkg -i --force-overwrite verbio-asr-*-x.yy.deb

C) Si disponemos de una mochila con licencia, deberemos instalar el paquete (que encontraremos en:'/usr/share/doc/verbio') que contiene el driver de dicho dispositivo:
    # dpkg -i  sntl-sud_x.y.z-w_i386.deb

   Si disponemos de una licencia en fichero, copiarla en: '/opt/verbio/lic'

D) Copiar el directorio '/usr/share/doc/verbio/samples' a nuestra home (por ejemplo),
   para poder compilar y ejecutar algunos ejemplos que allí encontraremos.

E) La documentación de verbio la podemos encontrar en: '/usr/share/doc/verbio':
   -library-sdk_es.pdf  (documentación sdk verbio).
   -guide_es.pdf (capítulos 4 y 5 para aprender sobre reconocimiento y síntesis del habla)

Nota: En este punto se recomienda seguir con la lectura de la sección "Configuración y puesta en marcha del servidor voxserver", en este mismo documento.

5.- Configuración y puesta en marcha del sevidor voxserver (verbiod)

ATENCIÓN: si, después de seguir detalladamente los pasos de esta sección, tenemos problemas con nuestra instalación, se recomienda leer la sección FAQ de este documento.

Configuración:

La configuración del servidor voxserver, reside en el fichero '/etc/software-verbio-server'. Los parámetros más importantes de dicho fichero son:

VERBIO_ASR_CONF      : debe contener todas las configuraciones de ASR instaladas.
VERBIO_START_CONF    : debe contener todas las configuraciones ASR que queremos arrancar.
VERBIO_START_LANG     : lenguaje por defecto.
VERBIO_TTS_SPK        : debe contener todos los locutores TTS instalados.
VERBIO_START_SPK      : debe contener los locutores TTS que queremos tener disponibles.
VERBIO_IN_MEMORY      : 1 --> cargar todo el locutor en memoria, 0 --> carga parcial.
FREQUENCY             : 8000 o 16000 (según la version que hayamos instalado)

Nota: podemos usar la aplicación 'verbioconf' (como root desde un terminal) para llevar
a cabo la configuración del fichero '/etc/software-verbio-server'. Cada vez que instalemos o eliminemos un paquete de síntesis y/o reconocimiento, deberemos ejecutar 'verbioconf' para reflejar los cambios en el fichero '/etc/software-verbio-server'.

Puesta en marcha:

Comprobamos el correcto funcionamiento del servidor verbio ejecutando (como 'root'):

    # verbiod -d (con -d indicamos modo debug)

Si todo está correctamente instalado deberemos obtener una salida similar a:

       verbiod-6: StartUp TTS Speakers: esEB,esAO
       verbiod-3: Serial number = H9D1CCE7
       verbiod-3: ERROR mc_libinit(, , 262144) failed: NO LICENSE FILE WAS FOUND

Si disponemos de licencia, y el servidor está correctamente instalado y configurado, el
mensaje "NO LICENSE FILE WAS FOUND" no aparecerá y 'verbiod' quedará arrancado.

Si no tenemos licencia, una vez comprobada la correcta instalación de 'verbiod', podemos arrancar en modo evaluación, para realizar las pruebas que consideremos oportunas. Para ello ejecutaremos (como 'root'):

    # verbiod -e

El servidor quedará arrancado (ejecutar 'pgrep verbiod' para comprobar).
También podemos comprobar el estado del servidor 'verbiod' ejecutando (como 'root'):

    # grep verbiod /var/log/syslog

    o

    # grep verbiod /var/log/messages

Nota: en modo evaluación, 'verbiod' permanecerá arrancado durante, únicamente, 30/60 minutos. Esta opción de evaluación únicamente es válida para comprobar el correcto funcionamiento del sistema. Se  recomienda adquirir una licencia de evaluación una vez comprobado el correcto funcionamiento de verbio. Los parámetros que acepta verbiod son: -d (modo debug), -e (modo evaluación) o ningún parámetro para iniciar
en modo 'normal'.

En la carpeta 'samples' (ver punto D en la sección de instalación) encontraremos ejemplos de programación con la librería 'voxlib' de Verbio. Como ejemplo, vemos como ejecutar la demostración para TTS (síntesis):

        g++ ttsdemo.c -o ttsdemo -lvoxlib
        ./ttsdemo

       Obtendremos una salida como la que sigue:

       Inicializando ...
       TTSVOLUME = 16384
       TTSSPEED = 170
       TTSPITCH = 220
       FILENAME = default.esa <-- corresponde al locutor por defecto.
       TTSVOLUME = 20000
       TTSSPEED = 170
       TTSPITCH = 220
       [..]

Errores del tipo:

       *** ERROR: vox_setparm failed. INVALID PARAMETER IN FUNCTION CALL ***

es normal que aparezcan ( debido a que pueden haber locutores no instalados)

Una vez ejecutado 'ttsdemo', se habrán creado diversos ficheros (uno por cada locutor) en formato a-law, con el contenido de áudio, fruto de la síntesis de un texto de ejemplo. Como mínimo (siempre que tengamos un locutor instalado), se deberá haber creado el fichero 'default.esa'.

Para abrir un fichero en formato "esa" (ley A),puede usarse un editor de audio (audacity por ejemplo). Para abrir un determinado fichero usando audacity seguir estos pasos:

1. ejecutar audacity
2. seleccionar Project > import Raw data
3. seleccionar el archivo "esa" que ha generado 'ttsdemo'
4. Elegir codificación: A-Law
5. Cambiar sample rate a: 8000 (o 16000 según configuración de verbiod)
6. Import

Para compilar y ejecutar el emjemplo de reconocimiento (vdemo) deberemos hacer lo siguiente:

    g++ vdemo.c -o vdemo -lvoxlib
    ./vdemo

Este ejemplo lee una serie de ficheros de audio en formato ulaw (DEMO*.esu) y aplica un reconocimiento según la gramática 'vdemo.txt'. La transcripción de dichos ficheros de audio se encuentra en: 'vdemo.gui'.
    
Una vez ejecutado el ejemplo, los resultados se guardarán en el fichero 'vdemo.dat'. El número entre paréntesis indica el score (confianza) del resultado.

Nota sobre la gestión del estado del servidor verbiod:

Si disponemos de licencia, el servidor voxserver ('verbiod') arrancará automáticamente
durante la ejecución de los scripts de inicio del sistema. Podemos controlar el estado
del servidor mediante los siguientes comandos (ejecutados como usuario 'root'):

Debian/Ubuntu/Suse/...:

# /etc/init.d/verbiod start
# /etc/init.d/verbiod stop
# /etc/init.d/verbiod restart

Redhat/Fedora/Centos/...:

# service verbiod start
# service verbiod stop
# service verbiod restart

NOTA: al iniciar Verbio en modo licenciado y disponer de los drivers de la llave USB instalados, éstos serán iniciados de forma automática.

6.- Preguntas frecuentes (FAQ)

P1.- El servidor verbiod no arranca y /no/ tengo una licencia Verbio.

R1.- Configurar correctamente el servidor verbiod (archivo /etc/software-verbio-server) ejecutando 'verbioconf'. Ejecutar verbiod en modo evaluación: verbiod -e  (como root)

P2.- El servidor verbiod no arranca y /si/ tengo una licencia Verbio.

R2.- Configurar correctamente el servidor verbiod (archivo /etc/software-verbio-server) ejecutando 'verbioconf'
     Comprobar que tenemos instalado el paquete que proporciona el driver para las mochilas sentinel, y que el proceso 'usbdaemon' (driver mochila usb) está arrancado.
     En el supuesto de que tengamos una licencia por fichero, comprobar que hemos copiado dicho fichero en: '/opt/verbio/lic'.

P3.- Obtengo (en mi aplicación cliente) errores del tipo:

    *** NETWORK ERROR ***

R3.- Este error viene dado por la imposibilidad de la aplicación cliente de conectar con el servidor voxserver.
     Deberemos comprobar que:
    1- No tengamos ningun firewall que esté bloqueando los puertos 8764 y 8765 entre cliente y servidor.
    2- La IP a la cual hacemos peticiones desde la aplicación cliente, tiene un voxserver 'escuchando'.
    3- El servidor verbiod esté arrancado (si no es así, revisar las preguntas P1/P2 de esta FAQ).

P4.- En mi aplicación cliente obtengo errores del tipo:

    *** INVALID PARAMETER IN FUNCTION CALL ***

R4.- Generalmente, este tipo de errores vienen dados por el uso de parámetros incorrectos en nuestras funciones.
     Ejemplos: estamos indicando un idioma de reconocimiento que no tenemos instalado.

P5.- En mi aplicación cliente obtengo errores del tipo:

    *** INVALID FILE NAME ***

R5.- Deberemos comprobar que el path al fichero de gramática es correcto.
     Comprobaremos que el fichero de gramática esté en formato ISO-8859.
     Eliminar la carpeta /tmp/vs y volver a ejecutar nuestra aplicación.

P6.- Al ejecutar 'vdemo' obtengo el siguiente error:

    "vox_libinit failed"

R6.- Revisar los parámetros de entrada de 'vdemo'. Son los siguientes:
 
    ./vdemo
    
    gram    : fichero de gramática.
    files    : lista de ficheros a reconocer.
    log    : fichero de log (donde se escribirá el resultado).
    lang    : lenguaje de reconocimiento
    conf    : configuración de reconocimiento.
    server    : ip del servidor voxserver
    mode    : cualquier valor indicará que vamos a usar una gramática ABNF
    
    ./vdemo vdemo.txt vdemo.gui vdemo.log es es_ca_eu_ga 127.0.0.1
    
    Nota: este ejemplo supone que hemos instalado la configuración 'es_ca_eu_ga' de
    reconocimiento y que queremos usar el lenguaje 'es'. Además, supone que el servidor corre en la misma máquina donde ejecutamos 'vdemo'.
    Deberemos ajustar estos parámetros según nuestra instalación.
    Tener en cuenta que, tanto 'vdemo.c' como 'ttsdemo.c', tienen como objetivo ser un ejemplo de programación/uso de la librería 'voxlib'. Dichos ejemplos, si bien pueden ser tomados como 'punto de partida' para la realización de aplicaciones más complejas, deberán ser modificados/reescritos, para que se adapten a las necesidades que demande nuestra aplicación.

P7.- Ninguna de las anteriores preguntas han resuelto mi problema.

R7.- Remitir un mail a support@verbio.com con la siguiente información:

    Descripción detallada del problema que estamos experimentando.

    Salida de los siguientes comandos:
     1  - cat /etc/issue
     2  - uname -a
     3a - apt-cache -fn search verbio (si usamos deb)
     3b - rpm -qa | grep verbio       (si usamos rpm)
     3c - listado y versión de los paquetes Verbio instalado (si no usamos ni deb ni rpm)
     4  - ls -lR /opt/verbio (si la salida es demasiado grande, redireccionar a un fichero)
     5  - ls -l /opt
     6  - verbiod -d (ejecutado como root)
     7  - cat /etc/software-verbio-server
     8  - grep verbiod /var/log/messages

INSTALL.DAT

Instalación de las aplicaciones Verbio en Asterisk

Para instalar las aplicaciones Asterisk de Verbio, hay que seguir los siguientes pasos:

1 - Copiar el fichero 'app_verbio_speech.c' a la carpeta 'apps' de las fuentes de Asterisk.

2 - Editar el fichero 'Makefile' de dicha ubicación (carpeta 'apps') y añadir:

    2a - Si usamos Asterisk 1.2

    APPS+=app_verbio_speech.so
   
    y
   
    app_verbio_speech.so : app_verbio_speech.o
        $(CC) $(SOLINK) -o $@ ${CYGSOLINK} $< ${CYGSOLIB} -lvoxlib

    --------------

    2b - Si usamos Asterisk 1.4, 1.6 o 1.8, añadir justo antes de la etiqueta 'all:'
   
    MENUSELECT_DEPENDS_app_verbio_speech+=VOX
    VOX_LIB=-lvoxlib

Nota: para que la aplicación compile y linke correctamente deberemos  tener, como mínimo, el paquete 'verbio-clients' (marcado como 'Developer' en la zona de descargas de la web de verbio -www.verbio.com-) instalado.

3 - Ejecutar 'make install' (desde el directorio principal de nuestras fuentes de Asterisk)

4 - Crear las siguientes carpetas (si conviene):

/var/lib/asterisk/verbio/text
/var/lib/asterisk/verbio/gram
/var/lib/asterisk/verbio/audio

5 - Copiar el fichero 'verbio.conf' (que encontramos en el paquete verbio-asterisk) a:

/etc/asterisk

6 - Leer detenidamente el documento 'README' (dentro del paquete verbio-asterisk), para la configuración, documentación y ejemplos de uso de las aplicaciones Verbio.

README.DAT

Verbio dialplan applications for Asterisk.

Aplicaciones Verbio sobre Asterisk.

Índice

1. Fichero de configuración 'verbio.conf'.
2. Descripción de las diferentes aplicaciones.
   1. VerbioLoadVcb
   2. VerbioUnloadVcb
   3. VerbioRec
   4. VerbioPrompt
   5. VerbioPromptAndRec
   6. VerbioStreamAndRec
   7. VerbioLastErr
   8. VerbioInfo
   9. VerbioFreeChannel
3. Ejemplo de uso de las aplicaciones Verbio en Asterisk.
4. Carga y descarga de las aplicaciones Verbio en Asterisk.

Nota: si todavía no ha realizado la instalación de las aplicaciones Verbio,
es recomendable que se lea el documento INSTALL.DAT