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
40
41
42
43
44
45
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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
|
/*
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 TDEConfig;
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(TDEConfig *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_
|
