GAudioOutput.cc 9.37 KB
Newer Older
Lorenz Meier's avatar
Lorenz Meier 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 38 39
/*=====================================================================

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>
#include <QSettings>
#include <QTemporaryFile>
#include "GAudioOutput.h"
#include "MG.h"

#include <QDebug>

40
#if defined Q_OS_MAC && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
41 42 43 44
#include <ApplicationServices/ApplicationServices.h>
#endif

// Speech synthesis is only supported with MSVC compiler
45
#if defined _MSC_VER && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
46 47 48 49 50 51 52
// Documentation: http://msdn.microsoft.com/en-us/library/ee125082%28v=VS.85%29.aspx
#include <sapi.h>

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

53
#if defined Q_OS_LINUX && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
54 55 56 57 58 59
extern "C" {
#include <flite/flite.h>
    cst_voice *register_cmu_us_kal(const char *voxdir);
};
#endif

60
#if defined _MSC_VER && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
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
ISpVoice *GAudioOutput::pVoice = NULL;
#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;
}

#define QGC_GAUDIOOUTPUT_KEY QString("QGC_AUDIOOUTPUT_")

GAudioOutput::GAudioOutput(QObject *parent) : QObject(parent),
    voiceIndex(0),
    emergency(false),
    muted(false)
{
    // Load settings
    QSettings settings;
    settings.sync();
    muted = settings.value(QGC_GAUDIOOUTPUT_KEY + "muted", muted).toBool();


99
#if defined Q_OS_LINUX && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
100 101 102
    flite_init();
#endif

103
#if defined _MSC_VER && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117
    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))
        {
118
            //hr = pVoice->Speak(L"QGC audio output active!", 0, NULL);
Lorenz Meier's avatar
Lorenz Meier committed
119 120 121 122 123 124 125
            //pVoice->Release();
            //pVoice = NULL;
        }
    }

#endif
    // Initialize audio output
126 127 128
    m_media = new Phonon::MediaObject(this);
    Phonon::AudioOutput *audioOutput = new Phonon::AudioOutput(Phonon::MusicCategory, this);
    createPath(m_media, audioOutput);
Lorenz Meier's avatar
Lorenz Meier committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147

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

    switch (voiceIndex)
    {
    case 0:
        selectFemaleVoice();
        break;

    default:
        selectMaleVoice();
        break;
    }
}

GAudioOutput::~GAudioOutput()
{
148
#if defined _MSC_VER && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    pVoice->Release();
    pVoice = NULL;
    ::CoUninitialize();
#endif
}


void GAudioOutput::mute(bool mute)
{
    if (mute != muted)
    {
        this->muted = mute;
        QSettings settings;
        settings.setValue(QGC_GAUDIOOUTPUT_KEY + "muted", this->muted);
        settings.sync();
        emit mutedChanged(muted);
    }
}

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

bool GAudioOutput::say(QString text, int severity)
{
    if (!muted)
    {
        // TODO Add severity filter
        Q_UNUSED(severity);
        bool res = false;

        if (!emergency)
        {

            // Speech synthesis is only supported with MSVC compiler
185
#if defined _MSC_VER && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
            /*SpeechSynthesizer synth = new SpeechSynthesizer();
            synth.SelectVoice("Microsoft Anna");
            synth.SpeakText(text.toStdString().c_str());
            res = true;*/
            /*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(text.toStdWString().c_str(), SPF_ASYNC, NULL);
            /*pVoice->WaitUntilDone(5000);
            pVoice->Release();
            pVoice = NULL;
            }
            }*/
#endif

208
#if defined Q_OS_LINUX && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
209 210 211 212 213 214 215 216 217
            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");
218 219
                m_media->setCurrentSource(Phonon::MediaSource(QUrl::fromLocalFile(file.fileName().toStdString().c_str())));
                m_media->play();
Lorenz Meier's avatar
Lorenz Meier committed
220 221 222 223 224
                res = true;
            }

#endif

225
#if defined Q_OS_MAC && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 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 323 324 325 326 327 328 329 330 331
            // 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;
#endif
        }

        return res;
    }

    else
    {
        return false;
    }
}

/**
 * @param text This message will be played after the alert beep
 */
bool GAudioOutput::alert(QString text)
{
    if (!emergency || !muted)
    {
        // Play alert sound
        beep();
        // Say alert message
        say(text, 2);
        return true;
    }

    else
    {
        return false;
    }
}

void GAudioOutput::notifyPositive()
{
    if (!muted)
    {
        // Use QFile to transform path for all OS
        QFile f(QCoreApplication::applicationDirPath() + QString("/files/audio/double_notify.wav"));
        //m_media->setCurrentSource(Phonon::MediaSource(f.fileName().toStdString().c_str()));
        //m_media->play();
    }
}

void GAudioOutput::notifyNegative()
{
    if (!muted)
    {
        // Use QFile to transform path for all OS
        QFile f(QCoreApplication::applicationDirPath() + QString("/files/audio/flat_notify.wav"));
        //m_media->setCurrentSource(Phonon::MediaSource(f.fileName().toStdString().c_str()));
        //m_media->play();
    }
}

/**
 * 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()
{
    if (!emergency)
    {
        emergency = true;

        // Beep immediately and then start timer
        if (!muted) beep();

        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()
{
    if (emergency)
    {
        emergency = false;
        emergencyTimer->stop();
    }

    return true;
}

void GAudioOutput::beep()
{
    if (!muted)
    {
332
        // TODO: Re-enable audio beeps
Lorenz Meier's avatar
Lorenz Meier committed
333
        // Use QFile to transform path for all OS
334 335
        //QFile f(QCoreApplication::applicationDirPath() + QString("/files/audio/alert.wav"));
        //qDebug() << "FILE:" << f.fileName();
Lorenz Meier's avatar
Lorenz Meier committed
336 337 338 339 340 341 342
        //m_media->setCurrentSource(Phonon::MediaSource(f.fileName().toStdString().c_str()));
        //m_media->play();
    }
}

void GAudioOutput::selectFemaleVoice()
{
343
#if defined Q_OS_LINUX && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
344 345 346 347 348 349
    //this->voice = register_cmu_us_slt(NULL);
#endif
}

void GAudioOutput::selectMaleVoice()
{
350
#if defined Q_OS_LINUX && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
351 352 353 354 355 356 357
    //this->voice = register_cmu_us_rms(NULL);
#endif
}

/*
void GAudioOutput::selectNeutralVoice()
{
358
#if defined Q_OS_LINUX && defined QGC_SPEECH_ENABLED
Lorenz Meier's avatar
Lorenz Meier committed
359 360 361 362 363 364 365 366 367
    this->voice = register_cmu_us_awb(NULL);
#endif
}*/

QStringList GAudioOutput::listVoices(void)
{
    QStringList l;
    return l;
}