3 # SpeakGoodChinese: toneScript.praat generates synthetic tone contours
5 # Copyright (C) 2007 R.J.J.H. van Son
6 # The SpeakGoodChinese team are:
7 # Guangqin Chen, Zhonyan Chen, Stefan de Konink, Eveline van Hagen,
8 # Rob van Son, Dennis Vierkant, David Weenink
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.
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.
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
24 # form Enter pinyin and tone 1 frequency
25 # word toneScript.inputWord ba1ba1
26 # positive toneScript.upperRegister_(Hz) 300
27 # real toneScript.range_Factor 1
28 # real toneScript.durationScale 1
29 # optionmenu toneScript.generate 1
36 # Get the rules of the tones
37 # include ToneRules.praat
39 #call toneScript 'toneScript.inputWord$' 'toneScript.upperRegister' 'toneScript.range_Factor' 'toneScript.durationScale' 'toneScript.generate$'
41 procedure toneScript toneScript.inputWord$ toneScript.upperRegister toneScript.range_Factor toneScript.durationScale toneScript.generate$
42 # To supress the ToneList, change to 0
43 toneScript.createToneList = 1
44 if rindex_regex(toneScript.generate$, "Correct") > 0
45 toneScript.createToneList = 0
51 if index_regex(toneScript.generate$, "_[\d]+$") > 0
52 .pos = index_regex(toneScript.generate$, "_[\d]+$")
53 .left$ = left$(toneScript.generate$, .pos)
54 .startSyll = extractNumber(toneScript.generate$, .left$) - 1
55 if .startSyll <> undefined and .startSyll > 0
56 .skipSyll$ = "([^\d]+[\d]+){'.startSyll'}"
63 toneScript.absoluteMinimum = 80
65 toneScript.prevTone = -1
66 toneScript.nextTone = -1
69 toneScript.lastFrequency = 0
72 if toneScript.inputWord$ <> ""
73 toneScript.inputWord$ = replace_regex$(toneScript.inputWord$, "^\s*(.+)\s*$", "\1", 1)
76 # Add a tone movement. The current time toneScript.point is 'toneScript.point'
77 toneScript.delta = 0.0000001
78 if toneScript.durationScale <= 0
79 toneScript.durationScale = 1.0
81 toneScript.segmentDuration = 0.150
82 toneScript.fixedDuration = 0.12
86 # start * ?Semit is a fall
87 # start / ?Semit is a rise
89 toneScript.octave = 0.5
91 toneScript.nineSemit = 0.594603557501361
93 toneScript.sixSemit = 0.707106781186547
94 # 1/(3 semitones) down
95 toneScript.threeSemit = 0.840896415253715
96 # 1/(2 semitones) down
97 toneScript.twoSemit = 0.890898718140339
98 # 1/(1 semitones) down
99 toneScript.oneSemit = 0.943874313
100 # 1/(4 semitones) down
101 toneScript.fourSemit = toneScript.twoSemit * toneScript.twoSemit
102 # 1/(5 semitones) down
103 toneScript.fiveSemit = toneScript.threeSemit * toneScript.twoSemit
105 toneScript.frequency_Range = toneScript.octave
106 if toneScript.range_Factor > 0
107 toneScript.frequency_Range = toneScript.frequency_Range * toneScript.range_Factor
110 # Previous end frequency
111 toneScript.lastFrequency = 0
112 # Split input into syllables
113 toneScript.margin = 0.25
115 # Get a list of items
116 if toneScript.createToneList = 1
117 Create Table with column names... ToneList 36 Word
120 select Table ToneList
121 Set string value... '.i' Word ------EMPTY
125 toneScript.syllableCount = length(replace_regex$(toneScript.inputWord$, "[^\d]+([\d]+)", "1", 0))
126 if toneScript.syllableCount < .startSyll + 1
129 toneScript.wordNumber = 0
130 toneScript.lowerBound = 0
131 if rindex(toneScript.generate$, "Correct") <= 0
132 for toneScript.first from toneScript.lowerBound to 4
133 toneScript.currentWord$ = replace_regex$(toneScript.inputWord$, "^('.skipSyll$')([^\d]+)([\d]+)(.*)$", "\1\3'toneScript.first'\5", 1)
134 for toneScript.second from 0 to 4
135 if (toneScript.first <> 5 and toneScript.second <> 5) and (toneScript.syllableCount > 1 or toneScript.second == 1)
136 toneScript.currentWord$ = replace_regex$(toneScript.currentWord$, "^('.skipSyll$')([^\d]+)([\d]+)([^\d]+)([\d]+)(.*)$", "\1\3'toneScript.first'\5'toneScript.second'\7", 1)
138 toneScript.wordNumber = toneScript.wordNumber+1
139 if toneScript.createToneList = 1
140 select Table ToneList
141 toneScript.listLength = Get number of rows
142 toneScript.listLength = toneScript.listLength + 1
143 for toneScript.currLength from toneScript.listLength to toneScript.wordNumber
145 Set string value... 'toneScript.currLength' Word ------EMPTY
147 Set string value... 'toneScript.wordNumber' Word 'toneScript.currentWord$'
149 # Actually, generate something
150 call generateWord 'toneScript.generate$' 'toneScript.currentWord$' 'toneScript.upperRegister'
156 #toneScript.first = 6
157 #toneScript.currentWord$ = replace_regex$(toneScript.inputWord$, "^('.skipSyll$')([^\d]+)([\d]+)(.*)$", "\1\3'toneScript.first'\5", 1)
158 #toneScript.second = 6
159 #if toneScript.syllableCount > 1
160 # toneScript.currentWord$ = replace_regex$(toneScript.currentWord$, "^('.skipSyll$')([^\d]+)([\d]+)([^\d]+)([\d]+)(.*)$", "\1\3'toneScript.first'\5'toneScript.second'\7", 1)
161 # # Write name in list
162 # toneScript.wordNumber = toneScript.wordNumber+1
163 # if toneScript.createToneList = 1
164 # select Table ToneList
165 # toneScript.listLength = Get number of rows
166 # toneScript.listLength = toneScript.listLength + 1
167 # for toneScript.currLength from toneScript.listLength to toneScript.wordNumber
169 # Set string value... 'toneScript.currLength' Word ------EMPTY
171 # Set string value... 'toneScript.wordNumber' Word 'toneScript.currentWord$'
175 # "broken" third tones
176 if index_regex(toneScript.inputWord$, "3") > 0
177 toneScript.currentWord$ = replace$(toneScript.inputWord$, "3", "9", 0)
179 toneScript.wordNumber = toneScript.wordNumber+1
180 if toneScript.createToneList = 1
181 select Table ToneList
182 toneScript.listLength = Get number of rows
183 toneScript.listLength = toneScript.listLength + 1
184 Set string value... 'toneScript.wordNumber' Word 'toneScript.currentWord$'
186 # Actually, generate something
187 call generateWord 'toneScript.generate$' 'toneScript.currentWord$' 'toneScript.upperRegister'
191 if toneScript.syllableCount > 1
192 toneScript.currentWord$ = replace_regex$(toneScript.inputWord$, "[\d+]", "6", 0)
194 toneScript.wordNumber = toneScript.wordNumber+1
195 if toneScript.createToneList = 1
196 select Table ToneList
197 toneScript.listLength = Get number of rows
198 toneScript.listLength = toneScript.listLength + 1
199 Set string value... 'toneScript.wordNumber' Word 'toneScript.currentWord$'
201 # Actually, generate something
202 call generateWord 'toneScript.generate$' 'toneScript.currentWord$' 'toneScript.upperRegister'
205 call generateWord 'toneScript.generate$' 'toneScript.inputWord$' 'toneScript.upperRegister'
209 procedure extractTone .syllable$
210 toneScript.toneSyllable = -1
211 .toneScript.currentToneText$ = replace_regex$(.syllable$, "^[^\d]+([\d]+)(.*)$", "\1", 0)
212 toneScript.toneSyllable = extractNumber(.toneScript.currentToneText$, "")
215 procedure convertVoicing toneScript.voicingSyllable$
217 toneScript.voicingSyllable$ = replace_regex$(toneScript.voicingSyllable$, "^([^\d]+)[\d]+", "\1", 0)
218 # Convert voiced consonants
219 toneScript.voicingSyllable$ = replace_regex$(toneScript.voicingSyllable$, "(ng|[wrlmny])", "C", 0)
220 # Convert unvoiced consonants
221 toneScript.voicingSyllable$ = replace_regex$(toneScript.voicingSyllable$, "(sh|ch|zh|[fsxhktpgqdbzcj])", "U", 0)
223 toneScript.voicingSyllable$ = replace_regex$(toneScript.voicingSyllable$, "([aiuoe\XFC])", "V", 0)
226 procedure addToneMovement .syllable$ toneScript.topLine toneScript.prevTone toneScript.nextTone
228 toneScript.toneSyllable = -1
229 call extractTone '.syllable$'
230 if toneScript.toneSyllable = 3 and toneScript.nextTone = 3
231 toneScript.toneSyllable = 2
234 # Get voicing pattern
235 toneScript.voicingSyllable$ = ""
236 call convertVoicing '.syllable$'
238 # Account for tones in duration
239 toneScript.toneFactor = 1
240 # Scale the duration of the current syllable
242 toneScript.toneFactor = toneScript.toneFactor * toneScript.durationScale
245 if rindex_regex(toneScript.voicingSyllable$, "U") = 1
246 toneScript.point = toneScript.point + toneScript.delta
247 Add point... 'toneScript.point' 0
248 toneScript.point = toneScript.point + toneScript.segmentDuration * toneScript.toneFactor
249 Add point... 'toneScript.point' 0
252 toneScript.voiceLength$ = replace_regex$(toneScript.voicingSyllable$, "U*([CV]+)U*", "\1", 0)
253 toneScript.voicedLength = length(toneScript.voiceLength$)
254 toneScript.voicedDuration = toneScript.toneFactor * (toneScript.segmentDuration*toneScript.voicedLength + toneScript.fixedDuration)
255 toneScript.point = toneScript.point + toneScript.delta
257 # Write contour of each tone
258 # Note that tones are influenced by the previous (tone 0) and next (tone 3)
259 # tones. Tone 6 is the Dutch intonation
260 # sqrt(toneScript.frequency_Range) is the mid toneScript.point
261 if toneScript.topLine * toneScript.frequency_Range < toneScript.absoluteMinimum
262 toneScript.frequency_Range = toneScript.absoluteMinimum / toneScript.topLine
267 toneScript.lastFrequency = toneScript.endPoint
271 procedure wordToTones .wordInput$ toneScript.highPitch
272 .currentRest$ = .wordInput$;
273 toneScript.syllableCount = 0
274 .length = 2 * toneScript.margin
277 while rindex_regex(.currentRest$, "^[^\d]+[\d]+") > 0
278 toneScript.syllableCount += 1
279 syllable'toneScript.syllableCount'$ = replace_regex$(.currentRest$, "^([^\d]+[\d]+)(.*)$", "\1", 1)
280 toneScript.currentSyllable$ = syllable'toneScript.syllableCount'$
283 call extractTone 'toneScript.currentSyllable$'
284 toneScript.toneSyllable'toneScript.syllableCount' = toneScript.toneSyllable
285 toneScript.currentTone = toneScript.toneSyllable'toneScript.syllableCount'
287 # Get the Voicing pattern
288 call convertVoicing 'toneScript.currentSyllable$'
289 voicingSyllable'toneScript.syllableCount'$ = toneScript.voicingSyllable$
290 currentVoicing$ = voicingSyllable'toneScript.syllableCount'$
292 # Calculate new .length
293 # Account for tones in duration
294 toneScript.toneFactor = 1
295 # Scale the duration of the current syllable
297 toneScript.toneFactor = toneScript.toneFactor * toneScript.durationScale
299 .length = .length + toneScript.toneFactor * (length(voicingSyllable'toneScript.syllableCount'$) * (toneScript.segmentDuration + toneScript.delta) + toneScript.fixedDuration)
302 .currentRest$ = replace_regex$(.currentRest$, "^([^\d]+[\d]+)(.*)$", "\2", 1)
305 if toneScript.syllableCount > 2000
310 # Create tone pattern
311 Create PitchTier... '.wordInput$' 0 '.length'
313 # Add start toneScript.margin
314 toneScript.lastFrequency = 0
316 Add point... 'toneScript.point' 0
317 toneScript.point = toneScript.margin
318 Add point... 'toneScript.point' 0
320 toneScript.lastTone = -1
321 toneScript.followTone = -1
322 for .i from 1 to toneScript.syllableCount
323 toneScript.currentSyllable$ = syllable'.i'$
324 toneScript.currentTone = toneScript.toneSyllable'.i'
325 toneScript.followTone = -1
326 if .i < toneScript.syllableCount
328 toneScript.followTone = toneScript.toneSyllable'.j'
331 call addToneMovement 'toneScript.currentSyllable$' 'toneScript.highPitch' 'toneScript.lastTone' 'toneScript.followTone'
333 toneScript.lastTone = toneScript.currentTone
336 # Add end toneScript.margin
337 toneScript.point = toneScript.point + toneScript.delta
338 Add point... 'toneScript.point' 0
339 toneScript.point = toneScript.point + toneScript.margin
340 Add point... 'toneScript.point' 0
343 procedure generateWord toneScript.whatToGenerate$ toneScript.theWord$ toneScript.upperRegister
345 # First generate model contour
346 call wordToTones 'toneScript.theWord$' 'toneScript.upperRegister'
348 select PitchTier 'toneScript.theWord$'
349 noprogress To Pitch... 0.0125 60.0 600.0
350 Rename... theOrigWord
352 Rename... 'toneScript.theWord$'
353 select Pitch theOrigWord
356 # Then look if "real" model exists, and use that
357 if index_regex(config.strict$, "[^0-9]") > 0
360 .userLevel = 'config.strict$'
361 if 0 and .userLevel >= sgc.highestLevel
362 ... and (fileReadable("'preferencesAppDir$'/pitchmodels/'toneScript.theWord$'.Pitch")
363 ... or fileReadable("'preferencesAppDir$'/pitchmodels/'toneScript.theWord$'.wav"))
364 # Get mean of generated contour
365 select Pitch 'toneScript.theWord$'
366 Rename... GeneratedContour
367 toneScript.generatedMean = do ("Get mean...", 0, 0, "Hertz")
368 toneScript.generatedMaximum = do ("Get maximum...", 0, 0, "Hertz", "Parabolic")
370 if fileReadable("'preferencesAppDir$'/pitchmodels/'toneScript.theWord$'.Pitch")
371 Read from file... 'preferencesAppDir$'/pitchmodels/'toneScript.theWord$'.Pitch
373 .modelSound = Read from file... 'preferencesAppDir$'/pitchmodels/'toneScript.theWord$'.wav
375 # Third tones get really low
376 if index(toneScript.theWord$, "3") > 0
377 call convert2Pitch 15 600
379 call convert2Pitch 60 600
381 .modelPitch = convert2Pitch.object
387 Rename... 'toneScript.theWord$'
388 toneScript.mean = do ("Get mean...", 0, 0, "Hertz")
389 toneScript.maximum = do ("Get maximum...", 0, 0, "Hertz", "Parabolic")
390 toneScript.shiftFreq = toneScript.generatedMean - toneScript.mean
391 # toneScript.shiftFreq = toneScript.generatedMaximum - toneScript.maximum
392 Formula... self + toneScript.shiftFreq
395 # Generate sound if wanted
396 select Pitch 'toneScript.theWord$'
397 if rindex_regex(toneScript.whatToGenerate$, "Sound") > 0
398 noprogress To Sound (hum)
402 select PitchTier 'toneScript.theWord$'
403 if rindex_regex(toneScript.whatToGenerate$, "Sound") > 0
404 plus Pitch 'toneScript.theWord$'
409 procedure convert2Pitch .minimumPitch .maximumPitch
410 #.object = noprogress To Pitch (ac)... 0 '.minimumPitch' 25 yes 0.05 0.3 0.01 0.6 0.14 '.maximumPitch'
411 .object = noprogress To Pitch (cc)... 0 '.minimumPitch' 15 yes 0.03 0.50 0.045 0.35 0.14 '.maximumPitch'
414 # Not everyone add all the zeros for the neutral tones. Here we try to guess where
416 procedure add_missing_neutral_tones .pinyin$
417 # Missing neutral tones
419 .pinyin$ = replace_regex$(.pinyin$, "([^0-9])$", "\10", 0)
421 .pinyin$ = replace_regex$(.pinyin$, "([euioa]+)([^0-9neuioa])", "\10\2", 0)
423 .pinyin$ = replace_regex$(.pinyin$, "([euioa]+ng)([^0-9])", "\10\2", 0)
425 .pinyin$ = replace_regex$(.pinyin$, "([euioa]+n)([^0-9geuioa])", "\10\2", 0)
426 # VnV cases -> Maximal onset
427 .pinyin$ = replace_regex$(.pinyin$, "([euioa])(n[euioa])", "\10\2", 0)