NeuronModule.py 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. # coding: utf8
  2. import logging
  3. import os
  4. import random
  5. import sys
  6. from jinja2 import Template
  7. from core import OrderListener
  8. from core.Utils import Utils
  9. from core.ConfigurationManager import SettingLoader
  10. logging.basicConfig()
  11. logger = logging.getLogger("kalliope")
  12. class InvalidParameterException(Exception):
  13. pass
  14. class MissingParameterException(Exception):
  15. pass
  16. class NoTemplateException(Exception):
  17. pass
  18. class MultipleTemplateException(Exception):
  19. pass
  20. class TemplateFileNotFoundException(Exception):
  21. pass
  22. class TTSModuleNotFound(Exception):
  23. pass
  24. class TTSNotInstantiable(Exception):
  25. pass
  26. class NeuronModule(object):
  27. def __init__(self, **kwargs):
  28. """
  29. Class used by neuron for talking
  30. :param kwargs: Same parameter as the Child. Can contain info about the tts to use instead of the
  31. default one
  32. """
  33. # get the child who called the class
  34. child_name = self.__class__.__name__
  35. logger.debug("NeuronModule called from class %s with parameters: %s" % (child_name, str(kwargs)))
  36. self.settings = SettingLoader.get_settings()
  37. # check if the user has overrider the TTS
  38. tts = kwargs.get('tts', None)
  39. if tts is None:
  40. # No tts provided, we load the default one
  41. self.tts = self.settings.default_tts_name
  42. else:
  43. self.tts = tts
  44. # get if the cache settings is present
  45. self.override_cache = kwargs.get('cache', None)
  46. # get templates if provided
  47. # Check if there is a template associate to the output message
  48. self.say_template = kwargs.get('say_template', None)
  49. # check if there is a template file associate to the output message
  50. self.file_template = kwargs.get('file_template', None)
  51. def say(self, message):
  52. """
  53. USe TTS to speak out loud the Message.
  54. A message can be a string, a list or a dict
  55. If it's a string, simply use the TTS with the message
  56. If it's a list, we select randomly a string in the list and give it to the TTS
  57. If it's a dict, we use the template given in parameter to create a string that we give to the TTS
  58. :param message: Can be a String or a dict
  59. :return:
  60. """
  61. logger.debug("NeuronModule Say() called with message: %s" % message)
  62. tts_message = None
  63. if isinstance(message, str) or isinstance(message, unicode):
  64. logger.debug("message is string")
  65. tts_message = message
  66. if isinstance(message, list):
  67. logger.debug("message is list")
  68. tts_message = random.choice(message)
  69. if isinstance(message, dict):
  70. logger.debug("message is dict")
  71. tts_message = self._get_message_from_dict(message)
  72. if tts_message is not None:
  73. # get an instance of the target TTS
  74. tts_instance = Utils.get_dynamic_class_instantiation("tts", self.tts.capitalize())
  75. tts_args = None
  76. for tts_object in self.settings.ttss:
  77. if tts_object.name == self.tts:
  78. tts_args = tts_object.parameters
  79. logger.debug("NeuronModule: tts_args: %s" % tts_args)
  80. logger.debug("tts_message to say: %s" % tts_message)
  81. # change the cache settings with the one precised for the current neuron
  82. if self.override_cache is not None:
  83. tts_args = self._update_cache_var(self.override_cache, tts_args)
  84. logger.debug("NeuroneModule: TTS args: %s" % tts_args)
  85. tts_instance.say(words=tts_message, **(tts_args if tts_args is not None else {}))
  86. def _get_message_from_dict(self, message_dict):
  87. """
  88. Generate a message taht can be played by a TTS engine from a dict of variable and the jinja template
  89. :param message_dict:
  90. :return:
  91. """
  92. returned_message = None
  93. if (self.say_template is not None and self.file_template is None) or \
  94. (self.say_template is None and self.file_template is not None):
  95. # the user choose a say_template option
  96. if self.say_template is not None:
  97. if isinstance(self.say_template, list):
  98. # then we pick randomly one template
  99. self.say_template = random.choice(self.say_template)
  100. t = Template(self.say_template)
  101. returned_message = t.render(**message_dict)
  102. # trick to remobe unicode problem when loading jinja template with non ascii char
  103. reload(sys)
  104. sys.setdefaultencoding('utf-8')
  105. # the user choose a file_template option
  106. if self.file_template is not None: # the user choose a file_template option
  107. real_file_template_path = "templates/%s" % self.file_template
  108. if os.path.isfile(real_file_template_path):
  109. # load the content of the file as template
  110. t = Template(self._get_content_of_file(real_file_template_path))
  111. returned_message = t.render(**message_dict)
  112. else:
  113. raise TemplateFileNotFoundException("Template file %s not found in templates folder"
  114. % real_file_template_path)
  115. return returned_message
  116. # we don't force the usage of a template. The user can choose to do nothing with returned value
  117. # else:
  118. # raise NoTemplateException("You must specify a say_template or a file_template")
  119. @staticmethod
  120. def _get_content_of_file(real_file_template_path):
  121. with open(real_file_template_path, 'r') as content_file:
  122. return content_file.read()
  123. @staticmethod
  124. def _update_cache_var(new_override_cache, args_list):
  125. logger.debug("args for TTS plugin before update: %s" % str(args_list))
  126. args_list["cache"] = new_override_cache
  127. logger.debug("args for TTS plugin after update: %s" % str(args_list))
  128. return args_list
  129. @staticmethod
  130. def get_audio_from_stt(callback):
  131. """
  132. Call the default STT to get an audio sample and return it into the callback method
  133. :param callback:
  134. :return:
  135. """
  136. # call the order listenner
  137. oa = OrderListener(callback=callback)
  138. oa.start()