GAudioOutput.h 3.6 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 44
//#include <phonon/MediaObject>
//#include <phonon/AudioOutput>
45 46
#endif
#ifdef Q_OS_WIN
47 48
//#include <Phonon/MediaObject>
//#include <Phonon/AudioOutput>
49
#endif
pixhawk's avatar
pixhawk committed
50

51
/* For Snow leopard and later
52
#if defined Q_OS_MAC & defined QGC_SPEECH_ENABLED
53 54 55 56
#include <NSSpeechSynthesizer.h>
#endif
   */

lm's avatar
lm committed
57

58
#if defined _MSC_VER && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
59 60 61 62
// Documentation: http://msdn.microsoft.com/en-us/library/ee125082%28v=VS.85%29.aspx
#include <sapi.h>
#endif

pixhawk's avatar
pixhawk committed
63 64 65 66 67 68 69 70 71 72
/**
 * @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
73
    static GAudioOutput *instance();
pixhawk's avatar
pixhawk committed
74 75
    /** @brief List available voices */
    QStringList listVoices(void);
Lorenz Meier's avatar
Lorenz Meier committed
76 77
    enum
    {
78 79 80
        VOICE_MALE = 0,
        VOICE_FEMALE
    } QGVoice;
pixhawk's avatar
pixhawk committed
81

82 83 84
    /** @brief Get the mute state */
    bool isMuted();

pixhawk's avatar
pixhawk committed
85 86
public slots:
    /** @brief Say this text if current output priority matches */
Lorenz Meier's avatar
Lorenz Meier committed
87
    bool say(QString text, int severity = 1);
88
    /** @brief Play alert sound and say notification message */
pixhawk's avatar
pixhawk committed
89 90 91 92 93 94 95 96 97
    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();
98
    /** @brief Play emergency sound once */
pixhawk's avatar
pixhawk committed
99
    void beep();
100 101 102 103
    /** @brief Notify about positive event */
    void notifyPositive();
    /** @brief Notify about negative event */
    void notifyNegative();
104 105
    /** @brief Mute/unmute sound */
    void mute(bool mute);
106 107 108

signals:
    void mutedChanged(bool);
pixhawk's avatar
pixhawk committed
109 110

protected:
111
#if defined Q_OS_MAC && defined QGC_SPEECH_ENABLED
112 113
    //NSSpeechSynthesizer
#endif
114
#if defined Q_OS_LINUX && defined QGC_SPEECH_ENABLED
lm's avatar
lm committed
115
    //cst_voice* voice; ///< The flite voice object
Lorenz Meier's avatar
Lorenz Meier committed
116
#endif
117
#if defined _MSC_VER && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
118
    static ISpVoice *pVoice;
119
#endif
pixhawk's avatar
pixhawk committed
120
    int voiceIndex;   ///< The index of the flite voice to use (awb, slt, rms)
121 122
    //Phonon::MediaObject *m_media; ///< The output object for audio
    //Phonon::AudioOutput *m_audioOutput;
pixhawk's avatar
pixhawk committed
123
    bool emergency;   ///< Emergency status flag
Lorenz Meier's avatar
Lorenz Meier committed
124
    QTimer *emergencyTimer;
125
    bool muted;
pixhawk's avatar
pixhawk committed
126
private:
Lorenz Meier's avatar
Lorenz Meier committed
127 128
    GAudioOutput(QObject *parent = NULL);
    ~GAudioOutput();
pixhawk's avatar
pixhawk committed
129 130 131
};

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