Speech_DialogManager.py

# MIT License

# Copyright (c) 2017 Luca Angioloni and Francesco Pegoraro

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

from PyQt5.QtCore import (Qt, QObject, pyqtSignal, QThread)
import time
import speech_recognition as sr
from subprocess import call


from Bot import Bot

class Speech_DialogManager(QThread):
    """
    Class that provides an interface for the dialog and actions components.

    Attributes:
        rec_on      Qt signal emitted when the system is ready to listen and starts listening
        rec_off     Qt signal emitted when the system stops listening
        updated     Qt signal emitted when a new dialog line needs to be redered
        finished    Qt signal emitted when the transaction with the user is over
        active      Boolean status of the dialog process
        recognizer  Recogniser object (from speech_recognition package)
        username    current user username
        products    vending machine products data
        bot         Bot class object that manages the conversation
    """
    rec_on = pyqtSignal()  # in order to work it has to be defined out of the contructor
    rec_off = pyqtSignal()  # in order to work it has to be defined out of the contructor
    updated = pyqtSignal(object, object)  # in order to work it has to be defined out of the contructor
    finished = pyqtSignal()  # in order to work it has to be defined out of the contructor

    def __init__(self):
        super().__init__()
        self.active = False

        self.recognizer = sr.Recognizer()
        self.recognizer.energy_threshold = 2000
        self.username = ''


    def setProdData(self, products_data):
        """
        Method to set the products data

        Args:
            products_data     the data
        """
        self.products = products_data

    def set_username(self, name):
        """
        Method to set the current user name

        Args:
            name    the user name
        """
        self.username = name
        self.bot = Bot(self.products)

        self.bot.set_user_name(self.username)

    def record_and_understand(self):
        """Method called to listen, record and understand what users say"""
        with sr.Microphone() as source:
            print("Say something!")
            call(["python3", "bip.py"])
            self.rec_on.emit()
            audio = self.recognizer.listen(source, timeout=6.0)
        print("stopped recording")
        self.rec_off.emit()

        # Speech recognition using Google Speech Recognition
        try:
        # for testing purposes, we're just using the default API key
        # to use another API key, use `r.recognize_google(audio, key="GOOGLE_SPEECH_RECOGNITION_API_KEY")`
        # instead of `r.recognize_google(audio)`
            said = self.recognizer.recognize_google(audio, language='it')
            print("You said: " + said)
            return said
        except sr.UnknownValueError:
            print("Google Speech Recognition could not understand audio")
            return 'impossibile capire'
        except sr.RequestError as e:
            print("Could not request results from Google Speech Recognition service; {0}".format(e))
            return 'richieste speech-to-text terminate'

    def write(self):
        """Method called to input dialog sentences via terminal input (used for debugging)"""
        usersays = input("Say something!")
        return usersays

    def loop(self):
        """Method called to initialize and start the dialog Thread"""
        self.start()

    def deactivate(self):
        """Method called to stop and deactivate this Thread"""
        self.active = False
        self.quit()
        if self.isRunning():
            self.quit()

    def sayhi(self, greetings):
        """
        Method that starts the speak script to perform text to speech.

        Args:
            greetings     the sentence to pass to the speak script
        """
        call(["python3", "speak.py", greetings])

    def run(self):
        """Main loop of this Thread"""
        self.active = True
        greetings = "Ciao "+str(self.username)+" cosa ti serve? Parla dopo il bip."

        self.updated.emit(greetings, 0)
        self.sayhi(greetings)

        while self.active:
            user_says = self.record_and_understand() # da sostituire con record_and_understand
            #user_says = self.write() # da sostituire con record_and_understand

            self.updated.emit(user_says.lower(), 0)
            val, reply, bill = self.bot.reply(user_says.lower())
            self.updated.emit(reply, bill)
            call(["python3", "speak.py", reply])

            if val is None:
                self.finished.emit()
                self.deactivate()
            else:
                if val:
                    print("Qui usare API e fare addebito")
                    self.finished.emit()
                    self.deactivate()