AudioOutput.h

Go to the documentation of this file.

#pragma once
 
#include <chrono>
 
#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QSet>
#include <QtCore/QString>
 
class QTextToSpeech;
class Fact;
class AudioOutputTest;
 
class AudioOutput : public QObject
{
    Q_OBJECT
 
    friend AudioOutputTest;
 
public:
    enum class TextMod {
        None = 0,
        Translate = 1 << 0,
    };
    Q_FLAG(TextMod)
    Q_DECLARE_FLAGS(TextMods, TextMod)
 
    
    explicit AudioOutput(QObject *parent = nullptr);
 
    ~AudioOutput();
 
    static AudioOutput *instance();
 
    void init(Fact *volumeFact, Fact *mutedFact);
 
    void say(const QString &text, TextMods textMods = TextMod::None);
 
    void testAudioOutput();
 
private:
    QTextToSpeech *_engine = nullptr;
    qsizetype _textQueueSize = 0;
    bool _initialized = false;
    bool _speakCapable = false;
    Fact *_volumeFact = nullptr;
    Fact *_mutedFact = nullptr;
    double _lastVolume = -1.0;
 
    double _volumeSetting() const;
 
    bool _mutedSetting() const;
 
    void _setVolume();
 
    void _applyEngineSettings();
 
    void _finishInit();
 
    static const QHash<QString, QString> _textHash;
    static const QSet<QString> _spelledAcronyms;
 
    static constexpr qsizetype kMaxTextQueueSize = 20;
 
    static constexpr std::chrono::seconds kEngineInitWarnTimeout{10};
 
    static QString _fixTextMessageForAudio(const QString &string);
 
    static QString _replaceAbbreviations(const QString &input);
 
    static QString _spokenAbbreviation(const QString& token);
 
    static QString _replaceNegativeSigns(const QString &input);
 
    static QString _replaceDecimalPoints(const QString &input);
 
    static QString _replaceMeters(const QString &input);
 
    static QString _convertMilliseconds(const QString &input);
 
    static bool _getMillisecondString(const QString &string, QString &match, int &number);
 
};
Q_DECLARE_OPERATORS_FOR_FLAGS(AudioOutput::TextMods)