text-to-speech.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef BACKENDS_TEXT_TO_SPEECH_ABSTRACT_H
#define BACKENDS_TEXT_TO_SPEECH_ABSTRACT_H

#include "common/scummsys.h"
#include "common/str.h"

#include "common/array.h"
namespace Common {


class TTSVoice {
    friend class TextToSpeechManager;

    public:
        enum Gender {
            MALE,
            FEMALE,
            UNKNOWN_GENDER
        };

        enum Age {
            CHILD,
            ADULT,
            UNKNOWN_AGE
        };

    public:
        TTSVoice();

        TTSVoice(Gender gender, Age age, void *data, String description) ;

        TTSVoice(const TTSVoice& voice);

        ~TTSVoice();

        TTSVoice& operator=(const TTSVoice& voice);

        Gender getGender() { return _gender; };

        void setGender(Gender gender) { _gender = gender; };

        Age getAge() { return _age; };

        void setAge(Age age) { _age = age; };

        void *getData() { return _data; };

        void setData(void *data) { _data = data; };

        String getDescription() { return _description; };

    protected:
        Gender _gender; 
        Age _age; 
        void *_data; 
        String _description; 
        int *_refCount; 
};

struct TTSState {
    int _rate;
    int _pitch;
    int _volume;
    String _language;
    int _activeVoice;
    Array<TTSVoice> _availableVoices;
    bool _enabled;
    TTSState *_next;
};

class TextToSpeechManager {
public:
    enum Action {
        INTERRUPT,
        INTERRUPT_NO_REPEAT,
        QUEUE,
        QUEUE_NO_REPEAT,
        DROP
    };
    TextToSpeechManager();
    virtual ~TextToSpeechManager() {}

    virtual bool say(const U32String &str, Action action) { return false; }

    bool say(const String &str, Action action, CodePage charset = kUtf8) {
        U32String textToSpeak(str, charset);
        return say(textToSpeak, action);
    }

    bool say(const U32String &str) { return say(str, INTERRUPT_NO_REPEAT); }

    bool say(const String &str, CodePage charset = kUtf8) {
        return say(str, INTERRUPT_NO_REPEAT, charset);
    }

    virtual bool stop() { return false; }

    virtual bool pause() { return false; }

    virtual bool resume() { return false; }

    virtual bool isSpeaking() { return false; }

    virtual bool isPaused() { return false; }

    virtual bool isReady() { return false; }

    virtual void setVoice(unsigned index) {}

    TTSVoice getVoice();

    virtual void setRate(int rate) { _ttsState->_rate = rate; }

    int getRate() { return _ttsState->_rate; }

    virtual void setPitch(int pitch) { _ttsState->_pitch = pitch; }

    int getPitch() { return _ttsState->_pitch; }

    virtual void setVolume(unsigned volume) { _ttsState->_volume = volume; }

    int getVolume() { return _ttsState->_volume; }

    virtual void setLanguage(String language);

    String getLanguage() { return _ttsState->_language; }

    Array<TTSVoice> getVoicesArray() { return _ttsState->_availableVoices; }

    Array<int> getVoiceIndicesByGender (TTSVoice::Gender gender);

    virtual int getDefaultVoice() { return 0; }

    void pushState();

    bool popState();

    virtual void freeVoiceData(void *data) {}

    void enable(bool on);

protected:
    TTSState *_ttsState;

    void clearState();
    virtual void updateVoices() {};
};

} // End of namespace Common

#endif // BACKENDS_TEXT_TO_SPEECH_ABSTRACT_H