GAudioOutput.h 3.63 KB
Newer Older
pixhawk's avatar
pixhawk committed
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
/*=====================================================================

PIXHAWK Micro Air Vehicle Flying Robotics Toolkit

(c) 2009, 2010 PIXHAWK PROJECT  <http://pixhawk.ethz.ch>

This file is part of the PIXHAWK project

    PIXHAWK 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.

    PIXHAWK 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 PIXHAWK. If not, see <http://www.gnu.org/licenses/>.

======================================================================*/

/**
 * @file
 *   @brief Definition of audio output
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

#ifndef GAUDIOOUTPUT_H
#define GAUDIOOUTPUT_H

#include <QObject>
#include <QTimer>
#include <QStringList>
38
#ifdef Q_OS_MAC
lm's avatar
lm committed
39 40
#include <MediaObject>
#include <AudioOutput>
41 42
#endif
#ifdef Q_OS_LINUX
43
//#include <flite/flite.h>
44 45
#include <phonon/MediaObject>
#include <phonon/AudioOutput>
46 47
#endif
#ifdef Q_OS_WIN
pixhawk's avatar
pixhawk committed
48 49
#include <Phonon/MediaObject>
#include <Phonon/AudioOutput>
50
#endif
pixhawk's avatar
pixhawk committed
51

52 53 54 55 56 57
/* For Snow leopard and later
#ifdef Q_OS_MAC
#include <NSSpeechSynthesizer.h>
#endif
   */

58
#ifdef Q_OS_LINUX2
lm's avatar
lm committed
59 60 61
extern "C" {
    cst_voice *REGISTER_VOX(const char *voxdir);
    void UNREGISTER_VOX(cst_voice *vox);
Lorenz Meier's avatar
Lorenz Meier committed
62
    cst_voice *register_cmu_us_kal16(const char *voxdir);
lm's avatar
lm committed
63 64 65
}
#endif

Lorenz Meier's avatar
Lorenz Meier committed
66 67 68 69 70
#if _MSC_VER
// Documentation: http://msdn.microsoft.com/en-us/library/ee125082%28v=VS.85%29.aspx
#include <sapi.h>
#endif

pixhawk's avatar
pixhawk committed
71 72 73 74 75 76 77 78 79 80
/**
 * @brief Audio Output (speech synthesizer and "beep" output)
 * This class follows the singleton design pattern
 * @see http://en.wikipedia.org/wiki/Singleton_pattern
 */
class GAudioOutput : public QObject
{
    Q_OBJECT
public:
    /** @brief Get the singleton instance */
Lorenz Meier's avatar
Lorenz Meier committed
81
    static GAudioOutput *instance();
pixhawk's avatar
pixhawk committed
82 83
    /** @brief List available voices */
    QStringList listVoices(void);
Lorenz Meier's avatar
Lorenz Meier committed
84 85
    enum
    {
86 87 88
        VOICE_MALE = 0,
        VOICE_FEMALE
    } QGVoice;
pixhawk's avatar
pixhawk committed
89

90 91 92
    /** @brief Get the mute state */
    bool isMuted();

pixhawk's avatar
pixhawk committed
93 94
public slots:
    /** @brief Say this text if current output priority matches */
Lorenz Meier's avatar
Lorenz Meier committed
95
    bool say(QString text, int severity = 1);
96
    /** @brief Play alert sound and say notification message */
pixhawk's avatar
pixhawk committed
97 98 99 100 101 102 103 104 105
    bool alert(QString text);
    /** @brief Start emergency sound */
    bool startEmergency();
    /** @brief Stop emergency sound */
    bool stopEmergency();
    /** @brief Select female voice */
    void selectFemaleVoice();
    /** @brief Select male voice */
    void selectMaleVoice();
106
    /** @brief Play emergency sound once */
pixhawk's avatar
pixhawk committed
107
    void beep();
108 109 110 111
    /** @brief Notify about positive event */
    void notifyPositive();
    /** @brief Notify about negative event */
    void notifyNegative();
112 113
    /** @brief Mute/unmute sound */
    void mute(bool mute);
114 115 116

signals:
    void mutedChanged(bool);
pixhawk's avatar
pixhawk committed
117 118

protected:
119
#ifdef Q_OS_MAC
120 121
    //NSSpeechSynthesizer
#endif
122
#ifdef Q_OS_LINUX
lm's avatar
lm committed
123
    //cst_voice* voice; ///< The flite voice object
Lorenz Meier's avatar
Lorenz Meier committed
124 125 126
#endif
#ifdef _MSC_VER
    static ISpVoice *pVoice;
127
#endif
pixhawk's avatar
pixhawk committed
128
    int voiceIndex;   ///< The index of the flite voice to use (awb, slt, rms)
Lorenz Meier's avatar
Lorenz Meier committed
129 130
    Phonon::MediaObject *m_media; ///< The output object for audio
    Phonon::AudioOutput *m_audioOutput;
pixhawk's avatar
pixhawk committed
131
    bool emergency;   ///< Emergency status flag
Lorenz Meier's avatar
Lorenz Meier committed
132
    QTimer *emergencyTimer;
133
    bool muted;
pixhawk's avatar
pixhawk committed
134
private:
Lorenz Meier's avatar
Lorenz Meier committed
135 136
    GAudioOutput(QObject *parent = NULL);
    ~GAudioOutput();
pixhawk's avatar
pixhawk committed
137 138 139
};

#endif // AUDIOOUTPUT_H
Lorenz Meier's avatar
Lorenz Meier committed
140