kttsd/libkttsd/testplayer.cpp

   1 /***************************************************** vim:set ts=4 sw=4 sts=4:
   2   Player Object for playing synthesized audio files.  Plays them
   3   synchronously.
   4   -------------------
   5   Copyright:
   6   (C) 2004 by Gary Cramblitt <garycramblitt@comcast.net>
   7   -------------------
   8   Original author: Gary Cramblitt <garycramblitt@comcast.net>
   9
  10   This program is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU General Public License as published by
  12   the Free Software Foundation; either version 2 of the License, or
  13   (at your option) any later version.
  14
  15   This program is distributed in the hope that it will be useful,
  16   but WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18   GNU General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License
  21   along with this program; if not, write to the Free Software
  22   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  23  ******************************************************************************/
  24
  25 // TestPlayer includes.
  26 #include "testplayer.h"
  27
  28 // Qt includes.
  29 #include <QtCore/QFile>
  30 #include <QtGui/QApplication>
  31
  32 // KDE includes.
  33 #include <ktemporaryfile.h>
  34 #include <kstandarddirs.h>
  35 #include <kparts/componentfactory.h>
  36 #include <kdebug.h>
  37 #include <kservicetypetrader.h>
  38
  39 // KTTS includes.
  40 #include "player.h"
  41 #include "stretcher.h"
  42 #include "pluginconf.h"
  43
  44 /**
  45  * Constructor.
  46  */
  47 TestPlayer::TestPlayer(QObject *parent, const char *name,
  48     const int playerOption, const float audioStretchFactor, const QString &sinkName) :
  49     QObject(parent)
  50 {
  51     setObjectName(name);
  52     m_playerOption = playerOption;
  53     m_audioStretchFactor = audioStretchFactor;
  54     m_stretcher = 0;
  55     m_player = 0;
  56     m_sinkName = sinkName;
  57 }
  58
  59 /**
  60  * Destructor.
  61  */
  62 TestPlayer::~TestPlayer()
  63 {
  64     delete m_stretcher;
  65     delete m_player;
  66 }
  67
  68 /**
  69  * Sets which audio player to use.
  70  *  0 = Phonon
  71  *  2 = ALSA
  72  */
  73 void TestPlayer::setPlayerOption(const int playerOption) { m_playerOption = playerOption; }
  74
  75 /**
  76  * Sets the audio stretch factor (Speed adjustment).
  77  * 1.0 = normal
  78  * 0.5 = twice as fast
  79  * 2.0 = twice as slow
  80  */
  81 void TestPlayer::setAudioStretchFactor(const float audioStretchFactor)
  82     { m_audioStretchFactor = audioStretchFactor; }
  83
  84 void TestPlayer::setSinkName(const QString &sinkName) { m_sinkName = sinkName; }
  85
  86 /**
  87  * Plays the specifified audio file and waits for completion.
  88  * The audio file speed is adjusted according to the stretch factor.
  89  * @param waveFile              Name of the audio file to play.
  90  */
  91 void TestPlayer::play(const QString &waveFile)
  92 {
  93     // kDebug() << "TestPlayer::play: running";
  94     // Create a Stretcher object to adjust the audio Speed.
  95     QString playFile = waveFile;
  96     QString tmpFile;
  97     if (m_audioStretchFactor != 1.0)
  98     {
  99         tmpFile = makeSuggestedFilename();
 100         // kDebug() << "TestPlayer::play: stretching file " << playFile << " by " << m_audioStretchFactor
 101         //     << " to file " << tmpFile << endl;
 102         m_stretcher = new Stretcher();
 103         if (m_stretcher->stretch(playFile, tmpFile, m_audioStretchFactor))
 104         {
 105             while (m_stretcher->getState() != Stretcher::ssFinished) qApp->processEvents();
 106             playFile = m_stretcher->getOutFilename();
 107         }
 108         delete m_stretcher;
 109         m_stretcher = 0;
 110     }
 111
 112     // Create player object based on player option.
 113     // kDebug() << "TestPlayer::play: creating Player object with playerOption " << m_playerOption;
 114     m_player = createPlayerObject(m_playerOption);
 115     // If player object could not be created, avoid crash is the best we can do!
 116     if (!m_player) return;
 117     // kDebug() << "TestPlayer::play: starting playback.";
 118     m_player->startPlay(playFile);
 119
 120     // TODO: The following hunk of code would ideally be unnecessary.  We would just
 121     // return at this point and let take care of
 122     // cleaning up the play object.  However, because we've been called from DCOP,
 123     // this seems to be necessary.  The call to processEvents is problematic because
 124     // it can cause re-entrancy.
 125     while (m_player->playing()) qApp->processEvents();
 126     // kDebug() << "TestPlayer::play: stopping playback.";
 127     m_player->stop();
 128     delete m_player;
 129     m_player = 0;
 130     if (!tmpFile.isEmpty()) QFile::remove(tmpFile);
 131 }
 132
 133 /**
 134  * Creates and returns a player object based on user option.
 135  */
 136 Player* TestPlayer::createPlayerObject(int playerOption)
 137 {
 138     Player* player = 0;
 139     QString plugInName;
 140     switch(playerOption)
 141     {
 142         case 0 :
 143         {
 144             plugInName = "kttsd_phononplugin";
 145             break;
 146         }
 147         case 2 :
 148         {
 149             plugInName = "kttsd_alsaplugin";
 150             break;
 151         }
 152         default:
 153         {
 154             // Default to Phonon.
 155             plugInName = "kttsd_phononplugin";
 156             break;
 157         }
 158     }
 159         KService::List offers = KServiceTypeTrader::self()->query(
 160             "KTTSD/AudioPlugin", QString("DesktopEntryName == '%1'").arg(plugInName));
 161
 162     if(offers.count() == 1)
 163     {
 164         // kDebug() << "TestPlayer::createPlayerObject: Loading " << offers[0]->library();
 165         KLibFactory *factory = KLibLoader::self()->factory(offers[0]->library().toLatin1());
 166         if (factory)
 167             player =
 168                 KLibLoader::createInstance<Player>(
 169                     offers[0]->library().toLatin1(), this, QStringList(offers[0]->library().toLatin1()));
 170         else
 171             kDebug() << "TestPlayer::createPlayerObject: Could not create factory.";
 172     }
 173     if (player == 0)
 174         kDebug() << "TestPlayer::createPlayerObject: Could not load " + plugInName +
 175             ".  Is KDEDIRS set correctly?" << endl;
 176     if (player) player->setSinkName(m_sinkName);
 177     return player;
 178 }
 179
 180 /**
 181  * Constructs a temporary filename for plugins to use as a suggested filename
 182  * for synthesis to write to.
 183  * @return                        Full pathname of suggested file.
 184  */
 185 QString TestPlayer::makeSuggestedFilename()
 186 {
 187     KTemporaryFile *tempFile = new KTemporaryFile();
 188     tempFile->setPrefix("kttsmgr-");
 189     tempFile->setSuffix(".wav");
 190     tempFile->open();
 191     QString waveFile = tempFile->fileName();
 192     delete tempFile;
 193     // kDebug() << "TestPlayer::makeSuggestedFilename: Suggesting filename: " << waveFile;
 194     return PlugInConf::realFilePath(waveFile);
 195 }
 196