/**************************************************************************** Main speaking functions for the FreeTTS Plug in ------------------- Copyright : (C) 2004 Paul Giannaros ------------------- Original author: Paul Giannaros Current Maintainer: Paul Giannaros ******************************************************************************/ /*************************************************************************** * * * This program 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; version 2 of the License. * * * ***************************************************************************/ #ifndef _FREETTSPROC_H_ #define _FREETTSPROC_H_ #include #include #include class KProcess; class FreeTTSProc : public PlugInProc{ Q_OBJECT public: /** * Constructor */ FreeTTSProc( TQObject* parent = 0, const char* name = 0, const TQStringList &args = TQStringList()); /** * Destructor */ virtual ~FreeTTSProc(); /** * Initializate the speech engine. * @param config Settings object. * @param configGroup Settings group. */ virtual bool init(KConfig *config, const TQString &configGroup); /** * Say a text string. * @param text The text to speak. */ virtual void sayText(const TQString &text); /** * Synthesize text into an audio file, but do not send to the audio device. * @param text The text to be synthesized. * @param suggestedFilename Full pathname of file to create. The plugin * may ignore this parameter and choose its own * filename. KTTSD will query the generated * filename using getFilename(). * * If the plugin supports asynchronous operation, it should return immediately. */ virtual void synthText(const TQString& text, const TQString& suggestedFilename); /** * Get the generated audio filename from synthText. * @return Name of the audio file the plugin generated. * Null if no such file. * * The plugin must not re-use the filename. */ virtual TQString getFilename(); /** * Stop current operation (saying or synthesizing text). * Important: This function may be called from a thread different from the * one that called sayText or synthText. * If the plugin cannot stop an in-progress @ref sayText or * @ref synthText operation, it must not block waiting for it to complete. * Instead, return immediately. * * If a plugin returns before the operation has actually been stopped, * the plugin must emit the @ref stopped signal when the operation has * actually stopped. * * The plugin should change to the psIdle state after stopping the * operation. */ virtual void stopText(); /** * Return the current state of the plugin. * This function only makes sense in asynchronous mode. * @return The pluginState of the plugin. * * @see pluginState */ virtual pluginState getState(); /** * Acknowledges a finished state and resets the plugin state to psIdle. * * If the plugin is not in state psFinished, nothing happens. * The plugin may use this call to do any post-processing cleanup, * for example, blanking the stored filename (but do not delete the file). * Calling program should call getFilename prior to ackFinished. */ virtual void ackFinished(); /** * Returns True if the plugin supports asynchronous processing, * i.e., returns immediately from sayText or synthText. * @return True if this plugin supports asynchronous processing. * * If the plugin returns True, it must also implement @ref getState . * It must also emit @ref sayFinished or @ref synthFinished signals when * saying or synthesis is completed. */ virtual bool supportsAsync(); /** * Returns True if the plugin supports synthText method, * i.e., is able to synthesize text to a sound file without * audibilizing the text. * @return True if this plugin supports synthText method. */ virtual bool supportsSynth(); /** * Say or Synthesize text. * @param text The text to be synthesized. * @param synthFilename If not Null, synthesize only to this filename, otherwise * synthesize and audibilize the text. * @param freettsJarPath Path to the freetts jar file. */ void synth( const TQString &text, const TQString &synthFilename, const TQString &freettsJarPath); private slots: void slotProcessExited(KProcess* proc); void slotReceivedStdout(KProcess* proc, char* buffer, int buflen); void slotReceivedStderr(KProcess* proc, char* buffer, int buflen); void slotWroteStdin(KProcess* proc); private: /** * Path to FreeTTS jar file (from config). */ TQString m_freettsJarPath; /** * FreeTTS process */ KProcess* m_freettsProc; /** * Synthesis filename. */ TQString m_synthFilename; /** * Plugin state. */ pluginState m_state; /** * True when stopText has been called. Used to force transition to psIdle when * FreeTTS exits. */ bool m_waitingStop; }; #endif // _FREETTSPROC_H_