TTSModule.py 4.8 KB

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