GAudioOutput.h 3.45 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);
62
    cst_voice* register_cmu_us_kal16(const char *voxdir);
lm's avatar
lm committed
63 64 65
}
#endif

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

84 85 86
    /** @brief Get the mute state */
    bool isMuted();

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

signals:
    void mutedChanged(bool);
pixhawk's avatar
pixhawk committed
111 112

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

#endif // AUDIOOUTPUT_H