espeak.h

Go to the documentation of this file.

#pragma once
#include "config-espk.h"
#include "speak_lib.h"
#include "pcaudiolib/audio_object.h"
#include "espeak-ng-data.h"
 
#if USE_CPP_API
#include "FileSystems.h" // https://github.com/pschatzmann/arduino-posix-fs
#include "Print.h"
#define GUARD_VALUE 23
class ESpeakFiles {
public:
    ESpeakFiles(Print &out, const char* path="../../../espeak-ng-data"){
        // setup min file system
        espeak_set_audio_output(&out);
        if (path!=nullptr){
            this->path = path;
        }
    }
 
    audio_info audioInfo() { return espeak_get_audio_info();}
 
    bool begin(int buflength=5) {
        int sample_rate = espeak_Initialize(output, buflength, path, options);
        return sample_rate!=-1;
    }
 
    // defines a callback which is executed at the begin of the audio output
    void setOutputBeginCallback(void(*cb)()){
        audio_stream_start_callback=cb;
    }
 
    // defines a callback which is executed at the end of the audio output
    void setOutputEndCallback(void(*cb)()){
        audio_stream_stop_callback=cb;
    }
 
    bool setVoice(const char *voiceName){
        espeak_ERROR rc = espeak_SetVoiceByName(voiceName);
        return rc==EE_OK;
    }
 
    bool setVoice(espeak_VOICE *voice_spec){
        espeak_ERROR rc = espeak_SetVoiceByProperties (voice_spec);
        return rc==EE_OK;
    }
 
    espeak_VOICE *voice() {
        return espeak_GetCurrentVoice ();
    }
 
    void end() {
        espeak_Terminate();
    }
 
    bool say(const char* str){
        if (str==nullptr) return false;
        assert(memory_guard==GUARD_VALUE);
        espeak_ERROR rc = espeak_Synth(str, strlen(str)+1, position, position_type, end_position, flags,
                    identifier, user_data);
        assert(memory_guard==GUARD_VALUE);
        return rc==EE_OK;
    }
 
    bool setRate(int rate) {
        return setParameter(espeakRATE, rate);
    }
 
    bool setVolume(int vol){
        return setParameter(espeakVOLUME, vol);
    }
 
    bool setPitch(int pitch){
        return setParameter(espeakPITCH, pitch);
    }
 
    bool setPitchRange(int range){
        return setParameter(espeakRANGE, range);
    }
 
    bool setPunctuation(espeak_PUNCT_TYPE punct){
        return setParameter(espeakPUNCTUATION, punct);
    }
 
    bool setAnnounceCapitals(int caps){
        return setParameter(espeakCAPITALS, caps);
    }
 
    bool setWordGap(int gap){
        return setParameter(espeakWORDGAP, gap);
    }
 
    bool setParameter(espeak_PARAMETER parameter, int value, int relative=0){
        return espeak_SetParameter(parameter, value, relative)==EE_OK;
    }
 
    bool setFlags(int flag){
        flags = flag;
        return true;
    }
 
protected:
    const short memory_guard = GUARD_VALUE; // check that memory was not overwritten by stack overflow
    const espeak_AUDIO_OUTPUT output = AUDIO_OUTPUT_SYNCH_PLAYBACK;
    const char* path = "../../../espeak-ng-data-min"; 
    void *user_data = nullptr;
    int options = 0;
    unsigned int *identifier = nullptr;
    unsigned int position = 0;
    unsigned int  end_position = 0;
    unsigned int  flags = espeakCHARS_AUTO;
    espeak_POSITION_TYPE position_type = POS_CHARACTER;
};
class ESpeak :  public ESpeakFiles {
public:
    ESpeak(Print &out, bool setupEnglish=true) : ESpeakFiles(out, "/mem/data"){
        // setup min file system
        is_setup_english = setupEnglish;
    }
    void add(const char* fileName, const void* fileContent, size_t len){
        fsm.add(fileName, fileContent, len);
    }
 
    bool begin(int buflength=500) {
        if (!is_fs_setup){
            add("/mem/data/phontab", espeak_ng_data_phontab,espeak_ng_data_phontab_len);
            add("/mem/data/phonindex", espeak_ng_data_phonindex,espeak_ng_data_phonindex_len);
            add("/mem/data/phondata", espeak_ng_data_phondata,espeak_ng_data_phondata_len);
            add("/mem/data/intonations", espeak_ng_data_intonations,espeak_ng_data_intonations_len);
            if (is_setup_english){
                add("/mem/data/en_dict", espeak_ng_data_en_dict,espeak_ng_data_en_dict_len);
                add("/mem/data/lang/en", espeak_ng_data_lang_gmw_en, espeak_ng_data_lang_gmw_en_len);
            }
            is_fs_setup = true;
        }
        return ESpeakFiles::begin(buflength);
    }
 
protected:
    file_systems::FileSystemMemory fsm{"/mem"}; // File system data in PROGMEM
    bool is_setup_english;
    bool is_fs_setup = false;
};
 
#endif