YiSpeechSynthesizer.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2018. All rights reserved.
#ifndef _YI_SPEECH_SYNTHESIZER_H_
#define _YI_SPEECH_SYNTHESIZER_H_

#include "signal/YiSignal.h"
#include "utility/YiString.h"

#include <atomic>
#include <queue>

class CYISpeechSynthesizer
{
public:
    class Platform;

    struct ErrorInfo
    {
        ErrorInfo(CYIString text) :
            m_errorText(text) {}

        CYIString m_errorText;
    };

    class Utterance
    {
    public:
        Utterance(const CYIString &textToSpeak);

        virtual ~Utterance();

        const CYIString &GetText() const;

        ssize_t GetId() const;

    private:
        static std::atomic<ssize_t> s_nLastUsedId;

        ssize_t m_nId;
        CYIString m_textToSpeak;
    };

    virtual ~CYISpeechSynthesizer();

    void Speak(const std::shared_ptr<Utterance> &pUtterance, bool bSpeakImmediately = false);

    void StopSpeaking();

    bool IsSpeaking() const;

    CYISignal<const std::shared_ptr<Utterance> &> StartedSpeaking;

    CYISignal<const std::shared_ptr<Utterance> &, bool /*bWasCancelled*/> FinishedSpeaking;

    CYISignal<const std::shared_ptr<Utterance> &, ErrorInfo> ErrorSpeaking;

private:
    CYISpeechSynthesizer(std::unique_ptr<Platform> pPlatform);

    void SpeakNextInQueue(bool bClearCurrentUtterance = false);

    std::unique_ptr<Platform> m_pSpeechPlatform;

    std::shared_ptr<Utterance> m_CurrentUtterance;
    std::queue<std::shared_ptr<Utterance>> m_UtteranceQueue;

    mutable CYIRecursiveMutex m_UtteranceMutex;
};

#endif