You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
181 lines
6.4 KiB
181 lines
6.4 KiB
/***************************************************** vim:set ts=4 sw=4 sts=4:
|
|
Filter Processing class.
|
|
This is the interface definition for text filters.
|
|
-------------------
|
|
Copyright:
|
|
(C) 2005 by Gary Cramblitt <garycramblitt@comcast.net>
|
|
-------------------
|
|
Original author: Gary Cramblitt <garycramblitt@comcast.net>
|
|
|
|
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; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program 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 this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
******************************************************************************/
|
|
|
|
#ifndef _FILTERPROC_H_
|
|
#define _FILTERPROC_H_
|
|
|
|
// TQt includes.
|
|
#include <tqobject.h>
|
|
#include <tqstringlist.h>
|
|
|
|
// KDE includes.
|
|
#include <kdemacros.h>
|
|
#include "kdeexportfix.h"
|
|
|
|
class TalkerCode;
|
|
class KConfig;
|
|
|
|
class KDE_EXPORT KttsFilterProc : virtual public TQObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
|
|
public:
|
|
enum FilterState {
|
|
fsIdle = 0, // Not doing anything. Ready to filter.
|
|
fsFiltering = 1, // Filtering.
|
|
fsStopping = 2, // Stop of filtering is in progress.
|
|
fsFinished = 3 // Filtering finished.
|
|
};
|
|
|
|
/**
|
|
* Constructor.
|
|
*/
|
|
KttsFilterProc( TQObject *parent, const char *name );
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~KttsFilterProc();
|
|
|
|
/**
|
|
* Initialize the filter.
|
|
* @param config Settings object.
|
|
* @param configGroup Settings Group.
|
|
* @return False if filter is not ready to filter.
|
|
*
|
|
* Note: The parameters are for reading from kttsdrc file. Plugins may wish to maintain
|
|
* separate configuration files of their own.
|
|
*/
|
|
virtual bool init(KConfig *config, const TQString &configGroup);
|
|
|
|
/**
|
|
* Returns True if this filter is a Sentence Boundary Detector.
|
|
* If so, the filter should implement @ref setSbRegExp() .
|
|
* @return True if this filter is a SBD.
|
|
*/
|
|
virtual bool isSBD();
|
|
|
|
/**
|
|
* Returns True if the plugin supports asynchronous processing,
|
|
* i.e., supports asyncConvert method.
|
|
* @return True if this plugin supports asynchronous processing.
|
|
*
|
|
* If the plugin returns True, it must also implement @ref getState .
|
|
* It must also emit @ref filteringFinished when filtering is completed.
|
|
* If the plugin returns True, it must also implement @ref stopFiltering .
|
|
* It must also emit @ref filteringStopped when filtering has been stopped.
|
|
*/
|
|
virtual bool supportsAsync();
|
|
|
|
/**
|
|
* Convert input, returning output. Runs synchronously.
|
|
* @param inputText Input text.
|
|
* @param talkerCode TalkerCode structure for the talker that KTTSD intends to
|
|
* use for synthing the text. Useful for extracting hints about
|
|
* how to filter the text. For example, languageCode.
|
|
* @param appId The DCOP appId of the application that queued the text.
|
|
* Also useful for hints about how to do the filtering.
|
|
*/
|
|
virtual TQString convert(const TQString& inputText, TalkerCode* talkerCode, const TQCString& appId);
|
|
|
|
/**
|
|
* Convert input. Runs asynchronously.
|
|
* @param inputText Input text.
|
|
* @param talkerCode TalkerCode structure for the talker that KTTSD intends to
|
|
* use for synthing the text. Useful for extracting hints about
|
|
* how to filter the text. For example, languageCode.
|
|
* @param appId The DCOP appId of the application that queued the text.
|
|
* Also useful for hints about how to do the filtering.
|
|
* @return False if the filter cannot perform the conversion.
|
|
*
|
|
* When conversion is completed, emits signal @ref filteringFinished. Calling
|
|
* program may then call @ref getOutput to retrieve converted text. Calling
|
|
* program must call @ref ackFinished to acknowledge the conversion.
|
|
*/
|
|
virtual bool asyncConvert(const TQString& inputText, TalkerCode* talkerCode, const TQCString& appId);
|
|
|
|
/**
|
|
* Waits for a previous call to asyncConvert to finish.
|
|
*/
|
|
virtual void waitForFinished();
|
|
|
|
/**
|
|
* Returns the state of the Filter.
|
|
*/
|
|
virtual int getState();
|
|
|
|
/**
|
|
* Returns the filtered output.
|
|
*/
|
|
virtual TQString getOutput();
|
|
|
|
/**
|
|
* Acknowledges the finished filtering.
|
|
*/
|
|
virtual void ackFinished();
|
|
|
|
/**
|
|
* Stops filtering. The filteringStopped signal will emit when filtering
|
|
* has in fact stopped and state returns to fsIdle;
|
|
*/
|
|
virtual void stopFiltering();
|
|
|
|
/**
|
|
* Did this filter do anything? If the filter returns the input as output
|
|
* unmolested, it should return False when this method is called.
|
|
*/
|
|
virtual bool wasModified();
|
|
|
|
/**
|
|
* Set Sentence Boundary Regular Expression.
|
|
* This method will only be called if the application overrode the default.
|
|
*
|
|
* @param re The sentence delimiter regular expression.
|
|
*/
|
|
virtual void setSbRegExp(const TQString& re);
|
|
|
|
signals:
|
|
/**
|
|
* Emitted when asynchronous filtering has completed.
|
|
*/
|
|
void filteringFinished();
|
|
|
|
/**
|
|
* Emitted when stopFiltering has been called and filtering has in fact stopped.
|
|
*/
|
|
void filteringStopped();
|
|
|
|
/**
|
|
* If an error occurs, Filter should signal the error and return input as output in
|
|
* convert method. If Filter should not be called in the future, perhaps because
|
|
* it could not find its configuration file, return False for keepGoing.
|
|
* @param keepGoing False if the filter should not be called in the future.
|
|
* @param msg Error message.
|
|
*/
|
|
void error(bool keepGoing, const TQString &msg);
|
|
};
|
|
|
|
#endif // _FILTERPROC_H_
|