NeuronModule.py 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. # coding: utf8
  2. import logging
  3. import os
  4. import random
  5. import sys
  6. from jinja2 import Template
  7. from core.Utils import Utils
  8. from core.ConfigurationManager import SettingLoader
  9. logging.basicConfig()
  10. logger = logging.getLogger("kalliope")
  11. class InvalidParameterException(Exception):
  12. pass
  13. class MissingParameterException(Exception):
  14. pass
  15. class NoTemplateException(Exception):
  16. pass
  17. class MultipleTemplateException(Exception):
  18. pass
  19. class TemplateFileNotFoundException(Exception):
  20. pass
  21. class TTSModuleNotFound(Exception):
  22. pass
  23. class TTSNotInstantiable(Exception):
  24. pass
  25. class NeuronModule(object):
  26. def __init__(self, **kwargs):
  27. """
  28. Class used by neuron for talking
  29. :param kwargs: Same parameter as the Child. Can contain info about the tts to use instead of the
  30. default one
  31. """
  32. # get the child who called the class
  33. child_name = self.__class__.__name__
  34. logger.debug("NeuronModule called from class %s with parameters: %s" % (child_name, str(kwargs)))
  35. self.settings = SettingLoader.get_settings()
  36. # check if the user has overrider the TTS
  37. tts = kwargs.get('tts', None)
  38. if tts is None:
  39. # No tts provided, we load the default one
  40. self.tts = self.settings.default_tts_name
  41. else:
  42. self.tts = tts
  43. # get if the cache settings is present
  44. self.override_cache = kwargs.get('cache', None)
  45. # get templates if provided
  46. # Check if there is a template associate to the output message
  47. self.say_template = kwargs.get('say_template', None)
  48. # check if there is a template file associate to the output message
  49. self.file_template = kwargs.get('file_template', None)
  50. def say(self, message):
  51. """
  52. USe TTS to speak out loud the Message.
  53. A message can be a string, a list or a dict
  54. If it's a string, simply use the TTS with the message
  55. If it's a list, we select randomly a string in the list and give it to the TTS
  56. If it's a dict, we use the template given in parameter to create a string that we give to the TTS
  57. :param message: Can be a String or a dict
  58. :return:
  59. """
  60. logger.debug("NeuronModule Say() called with message: %s" % message)
  61. tts_message = None
  62. if isinstance(message, str) or isinstance(message, unicode):
  63. logger.debug("message is string")
  64. tts_message = message
  65. if isinstance(message, list):
  66. logger.debug("message is list")
  67. tts_message = self._get_message_from_list(message)
  68. if isinstance(message, dict):
  69. logger.debug("message is dict")
  70. tts_message = self._get_message_from_dict(message)
  71. if tts_message is not None:
  72. # get an instance of the target TTS
  73. tts_instance = self._get_tts_instance(self.tts)
  74. tts_args = None
  75. for tts_object in self.settings.ttss:
  76. if tts_object.name == self.tts:
  77. tts_args = tts_object.parameters
  78. logger.debug("NeuronModule: tts_args: %s" % tts_args)
  79. logger.debug("tts_message to say: %s" % tts_message)
  80. # change the cache settings with the one precised for the current neuron
  81. if self.override_cache is not None:
  82. tts_args = self._update_cache_var(self.override_cache, tts_args)
  83. logger.debug("NeuroneModule: TTS args: %s" % tts_args)
  84. tts_instance.say(words=tts_message, **(tts_args if tts_args is not None else {}))
  85. @staticmethod
  86. def _get_message_from_list(message_list):
  87. """
  88. Return an element from the list randomly
  89. :param message_list:
  90. :return:
  91. """
  92. return random.choice(message_list)
  93. def _get_message_from_dict(self, message_dict):
  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 _get_tts_instance(tts_name):
  127. return Utils.get_dynamic_class_instantiation("tts", tts_name.capitalize())
  128. @staticmethod
  129. def _update_cache_var(new_override_cache, args_list):
  130. logger.debug("args for TTS plugin before update: %s" % str(args_list))
  131. args_list["cache"] = new_override_cache
  132. logger.debug("args for TTS plugin after update: %s" % str(args_list))
  133. return args_list