NeuronModule.py 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  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.SynapseLauncher import SynapseLauncher
  9. from core.Utils import Utils
  10. from core.ConfigurationManager import SettingLoader, BrainLoader
  11. logging.basicConfig()
  12. logger = logging.getLogger("kalliope")
  13. class InvalidParameterException(Exception):
  14. """
  15. Some Neuron parameters are invalid.
  16. """
  17. pass
  18. class MissingParameterException(Exception):
  19. """
  20. Some Neuron parameters are missing.
  21. """
  22. pass
  23. class NoTemplateException(Exception):
  24. """
  25. You must specify a say_template or a file_template
  26. """
  27. pass
  28. class TemplateFileNotFoundException(Exception):
  29. """
  30. Template file can not be found. Check the provided path.
  31. """
  32. pass
  33. class TTSModuleNotFound(Exception):
  34. """
  35. TTS module can not be find. It must be configured in the settings file.
  36. """
  37. pass
  38. class NeuronModule(object):
  39. """
  40. This Abstract Class is representing main Class for Neuron.
  41. Each Neuron must implement this Class.
  42. """
  43. def __init__(self, **kwargs):
  44. """
  45. Class used by neuron for talking
  46. :param kwargs: Same parameter as the Child. Can contain info about the tts to use instead of the
  47. default one
  48. """
  49. # get the child who called the class
  50. child_name = self.__class__.__name__
  51. logger.debug("NeuronModule called from class %s with parameters: %s" % (child_name, str(kwargs)))
  52. self.settings = SettingLoader.get_settings()
  53. brain_loader = BrainLoader.Intance()
  54. self.brain = brain_loader.brain
  55. # check if the user has overrider the TTS
  56. tts = kwargs.get('tts', None)
  57. if tts is None:
  58. # No tts provided, we load the default one
  59. self.tts = self.settings.default_tts_name
  60. else:
  61. self.tts = tts
  62. # get if the cache settings is present
  63. self.override_cache = kwargs.get('cache', None)
  64. # get templates if provided
  65. # Check if there is a template associate to the output message
  66. self.say_template = kwargs.get('say_template', None)
  67. # check if there is a template file associate to the output message
  68. self.file_template = kwargs.get('file_template', None)
  69. def say(self, message):
  70. """
  71. USe TTS to speak out loud the Message.
  72. A message can be a string, a list or a dict
  73. If it's a string, simply use the TTS with the message
  74. If it's a list, we select randomly a string in the list and give it to the TTS
  75. If it's a dict, we use the template given in parameter to create a string that we give to the TTS
  76. :param message: Can be a String or a dict or a list
  77. .. raises:: TTSModuleNotFound
  78. """
  79. logger.debug("NeuronModule Say() called with message: %s" % message)
  80. tts_message = None
  81. if isinstance(message, str) or isinstance(message, unicode):
  82. logger.debug("message is string")
  83. tts_message = message
  84. if isinstance(message, list):
  85. logger.debug("message is list")
  86. tts_message = random.choice(message)
  87. if isinstance(message, dict):
  88. logger.debug("message is dict")
  89. tts_message = self._get_message_from_dict(message)
  90. if tts_message is not None:
  91. logger.debug("tts_message to say: %s" % tts_message)
  92. # create a tts object from the tts the user want to user
  93. tts_object = next((x for x in self.settings.ttss if x.name == self.tts), None)
  94. if tts_object is None:
  95. raise TTSModuleNotFound("The tts module name %s does not exist in settings file" % self.tts)
  96. # change the cache settings with the one precised for the current neuron
  97. if self.override_cache is not None:
  98. tts_object.parameters = self._update_cache_var(self.override_cache, tts_object.parameters)
  99. logger.debug("NeuroneModule: TTS args: %s" % tts_object)
  100. # get the instance of the TTS module
  101. tts_module_instance = Utils.get_dynamic_class_instantiation("tts", tts_object.name.capitalize(),
  102. tts_object.parameters)
  103. # generate the audio file and play it
  104. tts_module_instance.say(tts_message)
  105. def _get_message_from_dict(self, message_dict):
  106. """
  107. Generate a message that can be played by a TTS engine from a dict of variable and the jinja template
  108. :param message_dict: the dict of message
  109. :return: The message to say
  110. .. raises:: TemplateFileNotFoundException
  111. """
  112. returned_message = None
  113. if (self.say_template is not None and self.file_template is None) or \
  114. (self.say_template is None and self.file_template is not None):
  115. # the user choose a say_template option
  116. if self.say_template is not None:
  117. if isinstance(self.say_template, list):
  118. # then we pick randomly one template
  119. self.say_template = random.choice(self.say_template)
  120. t = Template(self.say_template)
  121. returned_message = t.render(**message_dict)
  122. # trick to remobe unicode problem when loading jinja template with non ascii char
  123. reload(sys)
  124. sys.setdefaultencoding('utf-8')
  125. # the user choose a file_template option
  126. if self.file_template is not None: # the user choose a file_template option
  127. if not os.path.isabs(self.file_template): # os.path.isabs returns True if the path is absolute
  128. # here we are
  129. dir_we_are = os.path.dirname(os.path.realpath(__file__))
  130. # root directory
  131. root_dir = os.path.normpath(dir_we_are + os.sep + os.pardir)
  132. # real path of the template
  133. real_file_template_path = os.path.join(root_dir, self.file_template)
  134. else:
  135. real_file_template_path = self.file_template
  136. if os.path.isfile(real_file_template_path):
  137. # load the content of the file as template
  138. t = Template(self._get_content_of_file(real_file_template_path))
  139. returned_message = t.render(**message_dict)
  140. else:
  141. raise TemplateFileNotFoundException("Template file %s not found in templates folder"
  142. % real_file_template_path)
  143. return returned_message
  144. # we don't force the usage of a template. The user can choose to do nothing with returned value
  145. # else:
  146. # raise NoTemplateException("You must specify a say_template or a file_template")
  147. def run_synapse_ny_name(self, name):
  148. SynapseLauncher.start_synapse(name=name, brain=self.brain)
  149. @staticmethod
  150. def _get_content_of_file(real_file_template_path):
  151. """
  152. Return the content of a file in path <real_file_template_path>
  153. :param real_file_template_path: path of the file to return the content
  154. :return: file content str
  155. """
  156. with open(real_file_template_path, 'r') as content_file:
  157. return content_file.read()
  158. @staticmethod
  159. def _update_cache_var(new_override_cache, args_list):
  160. """
  161. update the value for the key "cache" in the dict args_list
  162. :param new_override_cache: cache bolean to set in place of the current one in args_list
  163. :param args_list: arg list that contain "cache" to update
  164. :return:
  165. """
  166. logger.debug("args for TTS plugin before update: %s" % str(args_list))
  167. args_list["cache"] = new_override_cache
  168. logger.debug("args for TTS plugin after update: %s" % str(args_list))
  169. return args_list
  170. @staticmethod
  171. def get_audio_from_stt(callback):
  172. """
  173. Call the default STT to get an audio sample and return it into the callback method
  174. :param callback: A callback function
  175. """
  176. # call the order listener
  177. oa = OrderListener(callback=callback)
  178. oa.start()