# Contributing: Create a TTS

[TTS](../tts.md) are independent projects so they can be developed under a github project. 
Anyone can clone them and place them under the TTS repository and reuse them or directly [install](../tts.md) them

Creating a new TTS must follow some rules:

## Repository Structure
1. The TTS repository name is in __lowercase__.
1. Under the TTS repository, the TTS has a __README.md file__ describing the TTS following this structure. You can get a [template here](tts_template.md):
    - TTS name:
    - Installation:     The CLI command used to install the TTS
    - Synopsis:         Description of the TTS
    - Options:          A table of the incoming parameters managed by the TTS.
    - Notes:            Something which needs to be add.
    - Licence:          The licence you want to use
1. Under the TTS repository, a [dna.yml file](dna.md) must be added that contains information about the TTS. type = "tts"
1. Under the TTS repository, a [install.yml file](installation_file.md) must be added that contains the installation process.


## Code
1. Under the TTS repository, the TTS file name .py is also in __lowercase__.
1. The TTS must be coded in __Python 2.7__.
1. Under the TTS repository, include the __init__.py file which contains: *from tts import TTS* (/!\ respect the Case)
1. Inside the TTS file, the TTS Class name is in __uppercase__.
1. The TTS __inherits from the TTSModule__ coming from the Core.

    ```python
    from kalliope.core.TTS.TTSModule import TTSModule
    class Pico2wave(TTSModule):
    ```


1. The TTS has a constructor __init__ which is the entry point.
The constructor has a __**kwargs argument__ which is corresponding to the Dict of incoming variables:values defined either in the settings file.
1. The TTS must refer to its __parent structure__ in the init by calling the super of TTSModule.

    ```python
    def __init__(self, **kwargs):
        super(Pico2wave, self).__init__(**kwargs)
    ```

1. The TTS __must__ implements a method _say(self, words) which must run call a method coming from the mother Class self.generate_and_play(words, callback).
1. Implement a callback in a separate method to run the audio. 
This callback is in charge to get the sound and save it on the disk. You can use our lib "FileManager.write_in_file(file_path, content)"
1. The module must use `self.file_path` from the mother class to know the full path where to save the generated audio file. The file path is handled by the core in order to allow caching.
1. The generated audio file must be supported by Mplayer. Try to play a generated file with `mplayer /path/to/the/generated_audio_file`

## Code example

Example of TTS structure
```
mytts/
├── __init__.py
├── mytts.py
├── dna.yml
├── install.yml
└── README.md
```

Example of TTS code
```python
class Mytts(TTSModule):
def __init__(self, **kwargs):
    super(Mytts, self).__init__(**kwargs)
    # the args from the tts configuration
    self.arg1 = kwargs.get('arg1', None)
    self.arg2 = kwargs.get('arg2', None)

    def say(self, words):
        """
        :param words: The sentence to say
        """

        self.generate_and_play(words, self._generate_audio_file)
        
    def _generate_audio_file(self):
    """
    Generic method used as a Callback in TTSModule
        - must provided the audio file and write it on the disk in self.file_path

    .. raises:: FailToLoadSoundFile
    """
    # -------------------
    # - do amazing code to get the sound 
    # - save it to the disk using self.file_path
    # - Attach the sound file path to the attribute : self.file_path = audio_file_path !
    # -------------------
    
```