NeuronModule.py 7.0 KB

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