NeuronModule.py 6.7 KB

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