TTSModule.py 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. # coding: utf8
  2. import hashlib
  3. import logging
  4. import os
  5. from core.FileManager import FileManager
  6. from core.ConfigurationManager import SettingLoader
  7. from core.Players import Mplayer
  8. logging.basicConfig()
  9. logger = logging.getLogger("kalliope")
  10. class TtsGenerateAudioFunctionNotFound(Exception):
  11. pass
  12. class TTSModule(object):
  13. def __init__(self, **kwargs):
  14. """
  15. Mother class of TTS module. Handle:
  16. - Cache: call cache object to create file, delete file, check if file exist
  17. - Player: call the default player to play the generated file
  18. """
  19. # set parameter from what we receive from the settings
  20. self.cache = kwargs.get('cache', False)
  21. self.language = kwargs.get('language', None)
  22. self.voice = kwargs.get('voice', "default")
  23. # the name of the TSS is the name of the Tss module that have instantiated TTSModule
  24. self.tts_caller_name = self.__class__.__name__
  25. # we don't know yet the words that will be converted to an audio and so we don't have the audio path yet too
  26. self.words = None
  27. self.file_path = None
  28. self.base_cache_path = None
  29. # load settings
  30. self.settings = SettingLoader.get_settings()
  31. print "Class TTSModule called from module %s, cache: %s, language: %s, voice: %s" % (self.tts_caller_name,
  32. self.cache,
  33. self.language,
  34. self.voice)
  35. def play_audio(self):
  36. """
  37. Play the audio file
  38. :return:
  39. """
  40. Mplayer.play(self.file_path)
  41. def generate_and_play(self, words, generate_audio_function_from_child=None):
  42. """
  43. Generate an audio file from <words> if not already in cache and call the Player to play it
  44. :param words: Sentence text from which we want to generate an audio file
  45. :param generate_audio_function_from_child: The child function to generate a file if necessary
  46. :return:
  47. """
  48. if generate_audio_function_from_child is None:
  49. raise TtsGenerateAudioFunctionNotFound
  50. self.words = words
  51. # we can generate the file path from info we have
  52. self.file_path = self._get_path_to_store_audio()
  53. if not self.cache:
  54. # no cache, we need to generate the file
  55. generate_audio_function_from_child()
  56. else:
  57. # we check if the file already exist. If not we generate it with the TTS engine
  58. if not self.is_file_already_in_cache():
  59. generate_audio_function_from_child()
  60. # then play the generated audio file
  61. self.play_audio()
  62. def _get_path_to_store_audio(self):
  63. """
  64. Get a sentence (a text) an return the full path of the file
  65. Path syntax:
  66. </path/in/settings>/<tts.name>/tts.parameter["language"]/tts.parameter["voice"]/<md5_of_sentence.tts
  67. E.g:
  68. /tmp/kalliope/voxygene/fr/abcd12345.tts
  69. :return: path String
  70. """
  71. md5 = self.generate_md5_from_words(self.words)+".tts"
  72. self.base_cache_path = os.path.join(self.settings.cache_path, self.tts_caller_name, self.language, self.voice)
  73. returned_path = os.path.join(self.base_cache_path, md5)
  74. logger.debug("get_path_to_store_audio return: %s" % returned_path)
  75. return returned_path
  76. @staticmethod
  77. def generate_md5_from_words(words):
  78. """
  79. Generate a md5 hash from received text
  80. :param words: Text to convert into md5 hash
  81. :return: String md5 hash from the received words
  82. """
  83. if isinstance(words, unicode):
  84. words = words.encode('utf-8')
  85. return hashlib.md5(words).hexdigest()
  86. def is_file_already_in_cache(self):
  87. """
  88. Return true if the file to generate has already been generated before
  89. :return:
  90. """
  91. # generate sub folder
  92. FileManager.create_directory(self.base_cache_path)
  93. # check if the audio file exist
  94. exist_in_cache = os.path.exists(self.file_path)
  95. if exist_in_cache:
  96. logger.debug("TTSModule, File already in cache: %s" % self.file_path)
  97. else:
  98. logger.debug("TTSModule, File not yet in cache: %s" % self.file_path)
  99. return exist_in_cache