summaryrefslogtreecommitdiffstats
path: root/src/asr/qspeechrecognition.h
blob: 6902dc684960b5e5cedf919ecbd2c867c718d12d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Speech module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QSPEECHRECOGNITION_H
#define QSPEECHRECOGNITION_H

#include "qspeechrecognition_global.h"
#include "qspeechrecognitiongrammar.h"
#include "qspeechrecognitionengine.h"
#include <QtCore/QObject>
#include <QtCore/QUrl>
#include <QtCore/QList>
#include <QtCore/QString>
#include <QtCore/QVariantMap>

QT_BEGIN_NAMESPACE

class QSpeechRecognitionPrivate;

class QSPEECHRECOGNITION_EXPORT QSpeechRecognition : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QSpeechRecognition)
    Q_PROPERTY(State state READ state NOTIFY stateChanged)
    Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY muteChanged)
    Q_PROPERTY(QSpeechRecognitionGrammar *activeGrammar READ activeGrammar WRITE setActiveGrammar)
    Q_PROPERTY(QList<QString> availablePlugins READ availablePlugins)

public:
    enum Error {
        NoError,
        EngineInitError,
        EngineParameterError,
        EngineError,
        GrammarInitError,
        GrammarError,
        AudioError,
        ConnectionError,
        NoGrammarError,
        NoResultError
    };
    Q_ENUM(Error)

    enum State {
        IdleState,
        ListeningStartingState,
        ListeningState,
        ListeningStoppingState,
        ProcessingState,
        MutedState,
    };
    Q_ENUM(State)

    QSpeechRecognition(QObject *parent = 0);
    ~QSpeechRecognition();
    State state() const;
    Q_INVOKABLE QSpeechRecognitionEngine *createEngine(const QString &name, const QString &pluginName, const QVariantMap &parameters = QVariantMap());
    Q_INVOKABLE QSpeechRecognitionEngine *engine(const QString &name) const;
    Q_INVOKABLE QSpeechRecognitionGrammar *createGrammar(QSpeechRecognitionEngine *engine, const QString &name, const QUrl &location);
    Q_INVOKABLE QSpeechRecognitionGrammar *grammar(const QString &name) const;
    Q_INVOKABLE void deleteGrammar(QSpeechRecognitionGrammar *grammar);
    void setActiveGrammar(QSpeechRecognitionGrammar *grammar);
    QSpeechRecognitionGrammar *activeGrammar() const;
    Q_INVOKABLE void startListening();
    Q_INVOKABLE void stopListening();
    Q_INVOKABLE void abortListening();
    void setMuted(bool muted);
    bool isMuted();
    Q_INVOKABLE void unmuteAfter(int millisec);
    Q_INVOKABLE void reset();
    Q_INVOKABLE void dispatchMessage(const QString &message, const QVariantMap &parameters = QVariantMap());

    static QList<QString> availablePlugins();

    // Common attribute keys:
    static const QString AudioLevel;

    // Common error parameter keys:
    static const QString Reason;
    static const QString Engine;
    static const QString Grammar;

    // Common result parameter keys:
    static const QString Transcription;

Q_SIGNALS:
    void stateChanged();
    void muteChanged();
    void error(QSpeechRecognition::Error errorCode, const QVariantMap &parameters);
    void result(const QString &grammarName, const QVariantMap &resultData);
    void listeningStarted(const QString &grammarName);
    void listeningStopped(bool expectResult);
    void attributeUpdated(const QString &key, const QVariant &value);
    void message(const QString &message, const QVariantMap &parameters);
};

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QSpeechRecognition::Error)

#endif