GAudioOutput.cc 8.94 KB
Newer Older
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
/*=====================================================================

QGroundControl Open Source Ground Control Station

(c) 2009, 2010 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>

This file is part of the QGROUNDCONTROL project

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

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

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

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

#include <QApplication>
33
#include <QSettings>
34 35 36 37 38 39 40 41 42 43 44
#include <QTemporaryFile>
#include "GAudioOutput.h"
#include "MG.h"

#include <QDebug>

#ifdef Q_OS_MAC
#include <ApplicationServices/ApplicationServices.h>
#endif

// Speech synthesis is only supported with MSVC compiler
pixhawk's avatar
pixhawk committed
45
#if _MSC_VER2
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
// Documentation: http://msdn.microsoft.com/en-us/library/ee125082%28v=VS.85%29.aspx
#define _ATL_APARTMENT_THREADED

#include <atlbase.h>
//You may derive a class from CComModule and use it if you want to override something,
//but do not change the name of _Module
extern CComModule _Module;
#include <atlcom.h>

#include <sapi.h>

//using System;
//using System.Speech.Synthesis;
#endif

#ifdef Q_OS_LINUX
extern "C" {
#include <flite/flite.h>
    cst_voice* register_cmu_us_kal(const char* voxdir);
};
#endif



/**
 * This class follows the singleton design pattern
 * @see http://en.wikipedia.org/wiki/Singleton_pattern
 * A call to this function thus returns the only instance of this object
 * the call can occur at any place in the code, no reference to the
 * GAudioOutput object has to be passed.
 */
GAudioOutput* GAudioOutput::instance()
{
    static GAudioOutput* _instance = 0;
    if(_instance == 0) {
        _instance = new GAudioOutput();
        // Set the application as parent to ensure that this object
        // will be destroyed when the main application exits
        _instance->setParent(qApp);
    }
    return _instance;
}

89 90
#define QGC_GAUDIOOUTPUT_KEY QString("QGC_AUDIOOUTPUT_")

91
GAudioOutput::GAudioOutput(QObject* parent) : QObject(parent),
92 93 94
    voiceIndex(0),
    emergency(false),
    muted(false)
95
{
96 97 98 99 100 101
    // Load settings
    QSettings settings;
    settings.sync();
    muted = settings.value(QGC_GAUDIOOUTPUT_KEY+"muted", muted).toBool();


102 103 104 105
#ifdef Q_OS_LINUX
    flite_init();
#endif

106 107 108 109 110 111 112 113 114 115 116 117 118
#if _MSC_VER2

    ISpVoice * pVoice = NULL;
    if (FAILED(::CoInitialize(NULL))) {
        qDebug("Creating COM object for audio output failed!");
    } else {

        HRESULT hr = CoCreateInstance(CLSID_SpVoice, NULL, CLSCTX_ALL, IID_ISpVoice, (void **)&pVoice;);
        if( SUCCEEDED( hr ) ) {
            hr = pVoice->Speak(L"Hello world", 0, NULL);
            pVoice->Release();
            pVoice = NULL;
        }
119 120 121
    }
#endif
    // Initialize audio output
122 123 124
    //m_media = new Phonon::MediaObject(this);
    //Phonon::AudioOutput *audioOutput = new Phonon::AudioOutput(Phonon::MusicCategory, this);
    //createPath(m_media, audioOutput);
125 126 127 128 129

    // Prepare regular emergency signal, will be fired off on calling startEmergency()
    emergencyTimer = new QTimer();
    connect(emergencyTimer, SIGNAL(timeout()), this, SLOT(beep()));

130
    switch (voiceIndex) {
131 132 133 134 135 136 137 138 139
    case 0:
        selectFemaleVoice();
        break;
    default:
        selectMaleVoice();
        break;
    }
}

pixhawk's avatar
pixhawk committed
140 141 142 143 144 145
//GAudioOutput::~GAudioOutput()
//{
//#ifdef _MSC_VER2
//    ::CoUninitialize();
//#endif
//}
146

147 148
void GAudioOutput::mute(bool mute)
{
149
    if (mute != muted) {
150 151 152 153 154 155
        this->muted = mute;
        QSettings settings;
        settings.setValue(QGC_GAUDIOOUTPUT_KEY+"muted", this->muted);
        settings.sync();
        emit mutedChanged(muted);
    }
156 157 158 159 160 161 162
}

bool GAudioOutput::isMuted()
{
    return this->muted;
}

163 164
bool GAudioOutput::say(QString text, int severity)
{
165 166 167 168 169 170 171
    if (!muted) {
        // TODO Add severity filter
        Q_UNUSED(severity);
        bool res = false;
        if (!emergency) {

            // Speech synthesis is only supported with MSVC compiler
172
#ifdef _MSC_VER2
173 174 175 176
            SpeechSynthesizer synth = new SpeechSynthesizer();
            synth.SelectVoice("Microsoft Anna");
            synth.SpeakText(text.toStdString().c_str());
            res = true;
177 178 179
#endif

#ifdef Q_OS_LINUX
180 181 182 183 184 185 186
            QTemporaryFile file;
            file.setFileTemplate("XXXXXX.wav");
            if (file.open()) {
                cst_voice* v = register_cmu_us_kal(NULL);
                cst_wave* wav = flite_text_to_wave(text.toStdString().c_str(), v);
                // file.fileName() returns the unique file name
                cst_wave_save(wav, file.fileName().toStdString().c_str(), "riff");
187 188
                //m_media->setCurrentSource(Phonon::MediaSource(file.fileName().toStdString().c_str()));
                //m_media->play();
189 190
                res = true;
            }
191 192 193
#endif

#ifdef Q_OS_MAC
194 195 196 197 198 199 200 201
            // Slashes necessary to have the right start to the sentence
            // copying data prevents SpeakString from reading additional chars
            text = "\\" + text;
            QStdWString str = text.toStdWString();
            unsigned char str2[1024] = {};
            memcpy(str2, text.toAscii().data(), str.length());
            SpeakString(str2);
            res = true;
202
#endif
203 204 205
        }
        return res;
    } else {
206 207 208
        return false;
    }
}
209 210 211 212 213 214

/**
 * @param text This message will be played after the alert beep
 */
bool GAudioOutput::alert(QString text)
{
215
    if (!emergency || !muted) {
216 217 218 219 220
        // Play alert sound
        beep();
        // Say alert message
        say(text, 2);
        return true;
221
    } else {
222 223 224 225 226 227
        return false;
    }
}

void GAudioOutput::notifyPositive()
{
228 229 230
    if (!muted) {
        // Use QFile to transform path for all OS
        QFile f(QCoreApplication::applicationDirPath()+QString("/audio/double_notify.wav"));
231 232
        //m_media->setCurrentSource(Phonon::MediaSource(f.fileName().toStdString().c_str()));
        //m_media->play();
233
    }
234
}
235 236 237

void GAudioOutput::notifyNegative()
{
238 239 240
    if (!muted) {
        // Use QFile to transform path for all OS
        QFile f(QCoreApplication::applicationDirPath()+QString("/audio/flat_notify.wav"));
241 242
        //m_media->setCurrentSource(Phonon::MediaSource(f.fileName().toStdString().c_str()));
        //m_media->play();
243
    }
244
}
245 246 247 248 249 250 251 252 253 254

/**
 * The emergency sound will be played continously during the emergency.
 * call stopEmergency() to disable it again. No speech synthesis or other
 * audio output is available during the emergency.
 *
 * @return true if the emergency could be started, false else
 */
bool GAudioOutput::startEmergency()
{
255
    if (!emergency) {
256 257
        emergency = true;
        // Beep immediately and then start timer
258
        if (!muted) beep();
259 260 261 262 263 264 265 266 267 268 269 270 271 272
        emergencyTimer->start(1500);
        QTimer::singleShot(5000, this, SLOT(stopEmergency()));
    }
    return true;
}

/**
 * Stops the continous emergency sound. Use startEmergency() to start
 * the emergency sound.
 *
 * @return true if the emergency could be stopped, false else
 */
bool GAudioOutput::stopEmergency()
{
273
    if (emergency) {
274 275 276 277 278 279 280 281
        emergency = false;
        emergencyTimer->stop();
    }
    return true;
}

void GAudioOutput::beep()
{
282
    if (!muted) {
283 284 285
        // Use QFile to transform path for all OS
        QFile f(QCoreApplication::applicationDirPath()+QString("/audio/alert.wav"));
        qDebug() << "FILE:" << f.fileName();
286 287
        //m_media->setCurrentSource(Phonon::MediaSource(f.fileName().toStdString().c_str()));
        //m_media->play();
288
    }
289
}
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322

void GAudioOutput::selectFemaleVoice()
{
#ifdef Q_OS_LINUX
    //this->voice = register_cmu_us_slt(NULL);
#endif
}

void GAudioOutput::selectMaleVoice()
{
#ifdef Q_OS_LINUX
    //this->voice = register_cmu_us_rms(NULL);
#endif
}

/*
void GAudioOutput::selectNeutralVoice()
{
#ifdef Q_OS_LINUX
    this->voice = register_cmu_us_awb(NULL);
#endif
}*/

QStringList GAudioOutput::listVoices(void)
{
    QStringList l;
#ifdef Q_OS_LINUX2
    cst_voice *voice;
    const cst_val *v;



    printf("Voices available: ");
323
    for (v=flite_voice_list; v; v=val_cdr(v)) {
324 325 326 327 328 329 330 331 332 333 334 335
        voice = val_voice(val_car(v));
        QString s;
        s.sprintf("%s",voice->name);
        printf("%s",voice->name);
        l.append(s);
    }
    printf("\n");

#endif
    return l;

}