sgc2.praat

   1 #
   2 # SpeakGoodChinese 2.0
   3 #
   4 # Master Praat script
   5 #
   6 #     SpeakGoodChinese: sgc2.praat is the master GUI of SpeakGoodChinese
   7 #     It is written in Praat script for the Demo window
   8 #
   9 #     Copyright (C) 2007-2010  R.J.J.H. van Son and 2010 the Netherlands Cancer Institute
  10 #     The SpeakGoodChinese team are:
  11 #     Guangqin Chen, Zhonyan Chen, Stefan de Koning, Eveline van Hagen,
  12 #     Rob van Son, Dennis Vierkant, David Weenink
  13 #
  14 #     This program is free software; you can redistribute it and/or modify
  15 #     it under the terms of the GNU General Public License as published by
  16 #     the Free Software Foundation; either version 2 of the License, or
  17 #     (at your option) any later version.
  18 #
  19 #     This program is distributed in the hope that it will be useful,
  20 #     but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 #     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 #     GNU General Public License for more details.
  23 #
  24 #     You should have received a copy of the GNU General Public License
  25 #     along with this program; if not, write to the Free Software
  26 #     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  27 #
  28 # The real application name
  29 sgc2.demoAppName$ = "SpeakGoodChinese2"
  30
  31 # Define variable that might be reset in Initialise*.praat
  32 if not variableExists("build_SHA$")
  33         build_SHA$ = "-"
  34 endif
  35
  36 # These are simply "useful" defaults
  37 localTableDir$ = "Data"
  38 buttonsTableName$ = "MainPage"
  39 configTableName$ = "Config"
  40 buttons$ = ""
  41 config$ = ""
  42 recordedSound$ = ""
  43 sgc.recordedSound = 0
  44 te.recordedPitch = 0
  45 te.buttonPressValue = 0
  46 samplingFrequency = 44100
  47 recordingTime = 2
  48
  49 # Pop-Up window colors
  50 sgc2.popUp_bordercolor$ = "{0.5,0.5,1}"
  51 sgc2.popUp_backgroundcolor$ = "{0.9,0.9,1}"
  52
  53 # If running in a packed script binary
  54 if index_regex(preferencesDirectory$, "(?i'sgc2.demoAppName$')$")
  55         preferencesAppDir$ = preferencesDirectory$
  56 elsif index_regex(preferencesDirectory$, "[pP]raat(\-dir| Prefs)?$")
  57         # If running as a Praat script, create a new preferences directory
  58         if unix
  59                 preferencesAppDir$ = "'preferencesDirectory$'/../.'sgc2.demoAppName$'"
  60         else
  61                 preferencesAppDir$ = "'preferencesDirectory$'/../'sgc2.demoAppName$'"
  62         endif
  63 else
  64         # It has to go somewhere. Make a subdirectory in the current preferences directory
  65         preferencesAppDir$ = "'preferencesDirectory$'/'sgc2.demoAppName$'"
  66 endif
  67
  68
  69 # Parameters for isolating recorded speech from noise
  70 # Should be mostly left alone unless you are using ultra clean
  71 # or very noisy recordings
  72 noiseThresshold = -30
  73 minimumPitch = 60
  74 soundMargin = 0.25
  75 minimumIntensity = 30
  76
  77 # Set up button height
  78 buttonbevel = 0
  79
  80 # Define canvas
  81 viewportMargin = 5
  82 defaultFontSize = 12
  83 defaultFont$ = "Helvetica"
  84 defaultLineWidth = 1
  85
  86 # Set up system
  87 call reset_viewport
  88
  89 # Load supporting scripts
  90 # Load tables in script format
  91 include CreateTables.praat
  92 include CreateWordlists.praat
  93 # Set up system and load preferences
  94 include InitialiseSGC2.praat
  95 # Include the main page buttons and procedures
  96 include MainPage.praat
  97 # Include the configuration page buttons and procedures
  98 include Config.praat
  99
 100 # Start instruction loop
 101 while demoWaitForInput()
 102         .label$ = ""
 103         .clickX = -1
 104         .clickY = -1
 105         .pressed$ = ""
 106         if demoClicked()
 107                 .clickX = demoX()
 108                 .clickY = demoY()
 109                 call buttonClicked 'buttons$' '.clickX' '.clickY'
 110                 .label$ = buttonClicked.label$
 111         elsif demoKeyPressed()
 112                 .pressed$ = demoKey$()
 113                 call keyPressed 'buttons$' '.pressed$'
 114                 .label$ = keyPressed.label$
 115         endif
 116
 117         # You cannot select a text field
 118         if startsWith(.label$, "$")
 119                 .label$ = ""
 120         endif
 121
 122         # Do things
 123         if .label$ != ""
 124                 te.buttonPressValue = 0
 125                 # Push button down
 126                 call Draw_button 'buttons$' '.label$' 1
 127                 call process_label '.label$' '.clickX' '.clickY' '.pressed$'
 128                 # push button up
 129                 call Draw_button 'buttons$' '.label$' 'te.buttonPressValue'
 130         endif
 131 endwhile
 132
 133 call end_program
 134
 135
 136 ########################################################
 137 #
 138 # Definitions of procedures
 139 #
 140 ########################################################
 141 #
 142 # Do what is asked
 143 procedure process_label .label$ .clickX .clickY .pressed$
 144         # Prcoess the command
 145         if .label$ <> "" and not startsWith(.label$,"!")
 146                 .label$ = replace_regex$(.label$, "^[#]", "", 0)
 147                 .label$ = replace$(.label$, "_", " ", 0)
 148                 call process'buttons$''.label$' '.clickX' '.clickY' '.pressed$'
 149         endif
 150 endproc
 151
 152 # Intialize buttons
 153 procedure init_buttons
 154         noerase = 1
 155         call Draw_all_buttons 'buttons$'
 156         noerase = 0
 157 endproc
 158
 159 # Draw all buttons
 160 noerase = 0
 161 procedure Draw_all_buttons .table$
 162         .varPrefix$ = replace_regex$(.table$, "^(.)", "\l\1", 0)
 163         select Table '.table$'
 164         .numRows = Get number of rows
 165
 166         for .row to .numRows
 167                 .label$ = Get value... '.row' Label
 168         if not startsWith(.label$, "!")
 169                         .pressed = 0
 170                         # Determine the "pressed" state of a button
 171                         # A variable with the same name as the button will act as a
 172                         # "pressed state"
 173                         .variableName$ = .varPrefix$+"."+(replace_regex$(.label$, "^(.)", "\l\1", 0))
 174                         # Simple boolean variables
 175                         if index(.variableName$, "_") <= 0 and variableExists(.variableName$)
 176                                 # True: Pressed
 177                                 if '.variableName$' > 0
 178                                         .pressed = 2
 179                                 # <0: Grayed out
 180                                 elsif '.variableName$' < 0
 181                                         .pressed = -1
 182                                 endif
 183                         elsif index(.variableName$, "_") <= 0 and variableExists("'.variableName$'$")
 184                                 # Non zero: Pressed
 185                                 if '.variableName$'$ <> "" and '.variableName$'$ <> "0"
 186                                         .pressed = 2
 187                                 endif
 188                         # Complex buttons with an variableName+'_'+value structure
 189                         # varableName$ -> name of button, e.g., "language"
 190                         elsif index(.variableName$, "_")
 191                                 .generalVar$ = left$(.variableName$, rindex(.variableName$, "_") - 1)
 192                                 .currentVariableName$ = .generalVar$
 193                                 # Is it a string?
 194                                 if variableExists(.generalVar$+"$")
 195                                         .currentVariableName$ = .generalVar$ + "$"
 196                                 endif
 197                                 # Remove one level of indirection
 198                                 if variableExists(.currentVariableName$)
 199                                         if index(.currentVariableName$, "$")
 200                                                 .currentVariableName$ = '.currentVariableName$'
 201                                         else
 202                                                 .currentValue = '.currentVariableName$'
 203                                                 .currentVariableName$ = "'.currentValue'"
 204                                         endif
 205                                         # Remove next level of indirection
 206                                         .currentContent$ = "'.currentVariableName$'"
 207                                         if .currentContent$ = "_DISABLED_"
 208                                                 .pressed = -1
 209                                         endif
 210                                         # Reconstruct label from current values
 211                                         .currentLabelValue$ = .generalVar$ + "_" + .currentContent$
 212                                         # Set PRESSED from label
 213                                         if .variableName$ = .currentLabelValue$
 214                                                 .pressed = 2
 215                                         endif
 216                                 endif
 217                         endif
 218                         # You did erase everything before you started here? So do not do that again
 219                     call Draw_button_internal 0 '.table$' '.label$' '.pressed'
 220         endif
 221         endfor
 222 endproc
 223
 224 # Draw a button from a predefined button table
 225 # Normally, erase the area around a button
 226 procedure Draw_button .table$ .label$ .push
 227         call Draw_button_internal 1 '.table$' '.label$' '.push'
 228 endproc
 229
 230 # Use this function if you want to control erasing
 231 procedure Draw_button_internal .erase_button_area .table$ .label$ .push
 232         # Do not draw invisible buttons starting with #
 233         goto NOBUTTON startsWith(.label$, "#")
 234
 235         # Scale rounding of rounded rectangles
 236         .wc = 1
 237         .mm = demo Horizontal wc to mm... '.wc'
 238     # Allow to overide ! skip directive
 239     .forceDraw = 0
 240     if startsWith(.label$, "+")
 241         .label$ = right$(.label$, length(.label$)-1)
 242         .forceDraw = 1
 243     endif
 244
 245     select Table '.table$'
 246     .row = Search column... Label '.label$'
 247         if .row < 1
 248                 call emergency_table_exit Button Table '.table$' does not have a row with label '.label$'
 249         endif
 250
 251         # Perspective shift sizes
 252         .shiftDown = 0
 253         .shiftX = 0
 254         .shiftY = 0
 255         if buttonbevel <> 0
 256                 .shiftDown = 0.1*buttonbevel
 257         .shiftX = -0.2*buttonbevel
 258         .shiftY = 0.40*buttonbevel
 259         endif
 260
 261         # Set drawing parameters
 262         .topBackGroundColorUp$ = "{0.93,0.93,0.93}"
 263         .topLineColorUp$ = "Black"
 264         .topLineWidthUp = 1.5
 265         .topBackGroundColorDown$ = "{0.89,0.89,0.94}"
 266         .topLineColorDown$ = "{0.2,0.2,0.2}"
 267         .topLineWidthDown = 2.0
 268         .topBackGroundColorDisabled$ = "{0.85,0.85,0.85}"
 269         .topLineColorDisabled$ = "{0.70,0.70,0.70}"
 270         .topLineWidthDisabled = 1.5
 271         .flankBackGroundColorUp$ = "{0.6,0.6,0.6}"
 272         .flankLineColorUp$ = "{0.2,0.2,0.2}"
 273         .flankLineWidthUp = 1.5
 274         .flankBackGroundColorDown$ = "{0.75,0.75,0.75}"
 275         .flankLineColorDown$ = .flankLineColorUp$
 276         .flankLineWidthDown = 1.5
 277         .buttonFontSize = defaultFontSize
 278
 279         # Get button values
 280     .leftX = Get value... '.row' LeftX
 281     .rightX = Get value... '.row' RightX
 282     .lowY = Get value... '.row' LowY
 283     .highY = Get value... '.row' HighY
 284     .buttonText$ = Get value... '.row' Text
 285     .buttonColor$ = Get value... '.row' Color
 286     .buttonDraw$ = Get value... '.row' Draw
 287     .buttonKey$ = Get value... '.row' Key
 288
 289     .noDraw = startsWith(.label$, "!") or (.leftX < 0) or (.rightX < 0) or (.lowY < 0) or (.highY < 0)
 290
 291         .rotation = 0
 292         if index_regex(.buttonText$, "^![0-9\.]+!")
 293                 .rotation = extractNumber(.buttonText$, "!")
 294                 .buttonText$ = replace_regex$(.buttonText$, "^![0-9\.]+!", "", 0)
 295         endif
 296
 297     goto NOBUTTON .noDraw and not .forceDraw
 298
 299     # Replace button text with ALERT
 300     if .push = 3
 301         .buttonText$ = alertText$
 302     endif
 303
 304         # Adapt font size to button size
 305         .maxWidth = (.rightX - .leftX) - 2
 306         .maxHeight = (.highY - .lowY) - 1
 307         if .rotation = 0
 308                 # Adapt size of button to length of text if necessary
 309                 call adjustFontSizeOnWidth 'defaultFont$' '.buttonFontSize' '.maxWidth' '.buttonText$'
 310                 .buttonFontSize = adjustFontSizeOnWidth.newFontSize
 311                 if adjustFontSizeOnWidth.diff > 0
 312                         .rightX += adjustFontSizeOnWidth.diff/2
 313                         .leftX -= adjustFontSizeOnWidth.diff/2
 314                 endif
 315                 call set_font_size '.buttonFontSize'
 316
 317                 # Adapt size of button to length of text
 318                 call adjustFontSizeOnHeight 'defaultFont$' '.buttonFontSize' '.maxHeight'
 319                 if adjustFontSizeOnHeight.diff > 0
 320                         .lowY -= adjustFontSizeOnHeight.diff/2
 321                         .highY += adjustFontSizeOnHeight.diff/2
 322                 endif
 323                 .buttonFontSize = adjustFontSizeOnHeight.newFontSize
 324         else
 325                 # With non-horizontal text, only change font size
 326                 call adjustRotatedFontSizeOnBox 'defaultFont$' '.buttonFontSize' '.maxWidth' '.maxHeight' '.rotation' '.buttonText$'
 327                 .buttonFontSize = adjustRotatedFontSizeOnBox.newFontSize
 328         endif
 329
 330         # Reset and erase button area
 331         call reset_viewport
 332     demo Line width... 'defaultLineWidth'
 333     .shiftLeftX = .leftX
 334     .shiftRightX = .rightX - .shiftX
 335     .shiftLowY = .lowY - .shiftY
 336     .shiftHighY = .highY
 337         if .erase_button_area
 338                 # Make erase area minutely larger
 339                 .eraseLeft = .shiftLeftX - 0.01
 340                 .eraseRight = .shiftRightX + 0.01
 341                 .eraseBottom = .shiftLowY - 0.01
 342                 .eraseTop = .shiftHighY + 0.01
 343                 demo Paint rectangle... White .eraseLeft .eraseRight .eraseBottom .eraseTop
 344         endif
 345
 346     # If label starts with "$", it is a text field. Then do not draw the button
 347         if not startsWith(.label$, "$")
 348         # Give some depth to button: Draw flank outline
 349                 if .shiftDown or .shiftX or .shiftY
 350                         if .push <= 0
 351                         demo Paint rounded rectangle... '.flankBackGroundColorUp$' .shiftLeftX .shiftRightX .shiftLowY .shiftHighY '.mm'
 352                                 demo Colour... '.flankLineColorUp$'
 353                         demo Line width... '.flankLineWidthUp'
 354                         else
 355                         demo Paint rounded rectangle... '.flankBackGroundColorDown$' .shiftLeftX .shiftRightX .shiftLowY .shiftHighY '.mm'
 356                                 demo Colour... '.flankLineColorDown$'
 357                         demo Line width... '.flankLineWidthDown'
 358                         endif
 359                 demo Draw rounded rectangle... .shiftLeftX .shiftRightX .shiftLowY .shiftHighY '.mm'
 360                 endif
 361
 362                 # Button Down will shift the top perspective
 363
 364         # Draw the button top
 365                 if .push = 0
 366                 demo Paint rounded rectangle... '.topBackGroundColorUp$' '.leftX' '.rightX' '.lowY' '.highY' '.mm'
 367                         demo Colour... '.topLineColorUp$'
 368                 demo Line width... '.topLineWidthUp'
 369                 elsif .push < 0
 370                 demo Paint rounded rectangle... '.topBackGroundColorDisabled$' '.leftX' '.rightX' '.lowY' '.highY' '.mm'
 371                         demo Colour... '.topLineColorDisabled$'
 372                 demo Line width... '.topLineWidthDisabled'
 373                 else
 374                         # Button Down
 375                         .leftX += .shiftDown
 376                         .rightX += .shiftDown
 377                         .lowY -= .shiftDown
 378                         .highY -= .shiftDown
 379
 380                 demo Paint rounded rectangle... '.topBackGroundColorDown$' .leftX .rightX .lowY .highY '.mm'
 381                         demo Colour... '.topLineColorDown$'
 382                 demo Line width... '.topLineWidthDown'
 383                 endif
 384         demo Draw rounded rectangle... '.leftX' '.rightX' '.lowY' '.highY' '.mm'
 385         endif
 386
 387     # The button text and symbol
 388         .horWC = demo Horizontal mm to wc... 10.0
 389         .verWC = demo Vertical mm to wc... 10.0
 390         if .verWC > 0
 391                 .verCoeff = .horWC / .verWC
 392         else
 393                 .verCoeff = 1
 394         endif
 395
 396     .centerX = (.leftX + .rightX)/2
 397     .centerY = .lowY + 0.6*(.highY-.lowY)
 398     .radius = min(.verCoeff * (.highY - .lowY ), (.rightX - .leftX))/3
 399         .buttonKey$ = replace$(.buttonKey$, "\", "\\", 0)
 400         .buttonKey$ = replace$(.buttonKey$, """", "\""""", 0)
 401         .newText$ = replace_regex$(.buttonText$, "['.buttonKey$']", "#%&", 1)
 402         if .newText$ = ""
 403                 .newText$ = .buttonText$
 404         endif
 405         # Variable text field, read corresponding variable
 406         if index(.newText$, "$$$")
 407                 .fieldName$ = replace_regex$(.label$, "^[!$#]", "", 0)
 408                 .fieldName$ = replace_regex$(.fieldName$, "^(.)", "\l\1", 0)
 409                 .varPrefix$ = replace_regex$(.table$, "^(.)", "\l\1", 0)
 410                 .newText$ = replace$(.newText$, "$$$", '.varPrefix$'.'.fieldName$'$, 0)
 411         endif
 412         if .push = 1 or .push = -1
 413                 demo Grey
 414                 if .buttonColor$ = "Red"
 415                         .buttonColor$ = "Pink"
 416                 elsif .buttonColor$ = "Blue"
 417                         .buttonColor$ = "{0.5,0.5,1}"
 418                 else
 419                         .buttonColor$ = "Grey"
 420                 endif
 421     elsif .push >= 2
 422         .buttonColor$ = "Maroon"
 423         else
 424         demo Colour... Black
 425         endif
 426
 427     call '.buttonDraw$' '.buttonColor$' '.centerX' '.centerY' '.radius'
 428         call set_font_size '.buttonFontSize'
 429     demo Colour... '.buttonColor$'
 430         if .rotation = 0
 431                 .anchorY = .lowY
 432                 .verticalAlignment$ = "Bottom"
 433         else
 434                 .anchorY = .lowY + 0.5*(.highY-.lowY)
 435                 .verticalAlignment$ = "Half"
 436         endif
 437     demo Text special... '.centerX' Centre '.anchorY' '.verticalAlignment$' 'defaultFont$' '.buttonFontSize' '.rotation' '.newText$'
 438         demoShow()
 439
 440         # Reset
 441         call set_font_size 'defaultFontSize'
 442     demo Black
 443     demo Line width... 'defaultLineWidth'
 444
 445     label NOBUTTON
 446 endproc
 447
 448 procedure set_window_title .table$ .addedText$
 449     select Table '.table$'
 450     .row = Search column... Label !WindowTitle
 451         if .row < 1
 452                 call emergency_table_exit Button Table '.table$' does not have a row with label !WindowTitle
 453         endif
 454         .windowText$ = Get value... '.row' Text
 455         call convert_praat_to_latin1 '.windowText$'
 456         .windowText$ = convert_praat_to_latin1.text$
 457
 458     demoWindowTitle(.windowText$+ .addedText$)
 459 endproc
 460
 461 # Handle language setting
 462 procedure processLanguageCodes .table$ .label$
 463         .table$ = "Config"
 464     call Draw_button 'config$' Language_'config.language$' 0
 465     call Draw_button 'config$' '.label$' 2
 466     # Someone might have to use more than 2 chars for the language code
 467     .numChars = length(.label$) - length("Language_")
 468         .lang$ = right$(.label$, .numChars)
 469     # Load new tables
 470     call set_language '.lang$'
 471 endproc
 472
 473 # Set the language
 474 procedure set_language .lang$
 475         .redraw_config = 0
 476     # Remove old tables
 477     if buttons$ <> ""
 478         select Table 'buttons$'
 479         Remove
 480                 .redraw_config = 1
 481     endif
 482     if config$ <> ""
 483         select Table 'config$'
 484         Remove
 485                 .redraw_config = 1
 486     endif
 487
 488     # Set language
 489         call checkTable 'buttonsTableName$'_'.lang$'
 490         if checkTable.available
 491                 config.language$ = .lang$
 492         else
 493                 config.language$ = "EN"
 494         endif
 495
 496     # Load buttons tables
 497     call loadTable 'buttonsTableName$'
 498     buttons$ = selected$("Table")
 499     Append column... Text
 500     Append column... Key
 501     Append column... Helptext
 502     .numLabels = Get number of rows
 503     call loadTable 'buttonsTableName$'_'config.language$'
 504     .buttonsLang$ = selected$("Table")
 505     for .row to .numLabels
 506                 select Table 'buttons$'
 507                 .label$ = Get value... '.row' Label
 508         call findLabel '.buttonsLang$' '.label$'
 509             if findLabel.row > 0
 510             select Table '.buttonsLang$'
 511                 .valueText$ = Get value... 'findLabel.row' Text
 512                 .valueKey$ = Get value... 'findLabel.row' Key
 513                 .valueHelp$ = Get value... 'findLabel.row' Helptext
 514                 select Table 'buttons$'
 515                 Set string value... '.row' Text '.valueText$'
 516                 Set string value... '.row' Key '.valueKey$'
 517                 Set string value... '.row' Helptext '.valueHelp$'
 518                 elsif index(.label$, "_")
 519                         # Load alternative language table
 520                         .startChar = rindex(.label$, "_")
 521                         .otherLanguage$ = right$(.label$, length(.label$) - .startChar)
 522                         call loadTable 'buttonsTableName$'_'.otherLanguage$'
 523                 .otherbuttonsLang$ = selected$("Table")
 524                 call findLabel '.otherbuttonsLang$' '.label$'
 525                 if findLabel.row > 0
 526                 select Table '.buttonsLang$'
 527                         .valueText$ = Get value... 'findLabel.row' Text
 528                         .valueKey$ = Get value... 'findLabel.row' Key
 529                         .valueHelp$ = Get value... 'findLabel.row' Helptext
 530                         select Table 'buttons$'
 531                         Set string value... '.row' Text '.valueText$'
 532                         Set string value... '.row' Key '.valueKey$'
 533                         Set string value... '.row' Helptext '.valueHelp$'
 534                 else
 535                 call emergency_table_exit Cannot find Label: '.otherbuttonsLang$' '.label$'
 536                 endif
 537                         select Table '.otherbuttonsLang$'
 538                         Remove
 539         else
 540             call emergency_table_exit Cannot find Label: '.buttonsLang$' '.label$'
 541         endif
 542     endfor
 543     select Table '.buttonsLang$'
 544     Remove
 545
 546     # Load configuration table
 547     call loadTable 'configTableName$'
 548     config$ = selected$("Table")
 549     Append column... Text
 550     Append column... Key
 551     Append column... Helptext
 552     .numLabels = Get number of rows
 553     call loadTable 'configTableName$'_'config.language$'
 554     .configLang$ = selected$("Table")
 555     for .row to .numLabels
 556                 select Table 'config$'
 557                 .label$ = Get value... '.row' Label
 558         call findLabel '.configLang$' '.label$'
 559             if findLabel.row > 0
 560             select Table '.configLang$'
 561                 .valueText$ = Get value... 'findLabel.row' Text
 562                 .valueKey$ = Get value... 'findLabel.row' Key
 563                 .valueHelp$ = Get value... 'findLabel.row' Helptext
 564                 select Table 'config$'
 565                 Set string value... '.row' Text '.valueText$'
 566                 Set string value... '.row' Key '.valueKey$'
 567                 Set string value... '.row' Helptext '.valueHelp$'
 568                 elsif index(.label$, "_")
 569                         .startChar = rindex(.label$, "_")
 570                         .otherLanguage$ = right$(.label$, length(.label$) - .startChar)
 571                         call loadTable 'configTableName$'_'.otherLanguage$'
 572                 .otherconfigLang$ = selected$("Table")
 573                 call findLabel '.otherconfigLang$' '.label$'
 574                 if findLabel.row > 0
 575                 select Table '.otherconfigLang$'
 576                         .valueText$ = Get value... 'findLabel.row' Text
 577                         .valueKey$ = Get value... 'findLabel.row' Key
 578                         .valueHelp$ = Get value... 'findLabel.row' Helptext
 579                         select Table 'config$'
 580                         Set string value... '.row' Text '.valueText$'
 581                         Set string value... '.row' Key '.valueKey$'
 582                         Set string value... '.row' Helptext '.valueHelp$'
 583                 else
 584                 call emergency_table_exit Cannot find Label: '.otherconfigLang$' '.label$'
 585                 endif
 586                         select Table '.otherconfigLang$'
 587                         Remove
 588         else
 589             call emergency_table_exit Cannot find Label: '.configLang$' '.label$'
 590         endif
 591     endfor
 592     select Table '.configLang$'
 593     Remove
 594
 595         # Make language change visible
 596         if .redraw_config
 597                 call Draw_config_page
 598         endif
 599
 600 endproc
 601
 602 ###############################################################
 603 #
 604 # Button Drawing Routines
 605 #
 606 ###############################################################
 607
 608 # A stub for buttons that do not have a drawing routine (yet)
 609 procedure DrawNull .color$ .x .y .size
 610 endproc
 611
 612 procedure DrawHelp .color$ .x .y .size
 613         .currentFontSize = 24
 614         .y -= .size
 615         .maxHeight = 2*.size
 616         call adjustFontSizeOnHeight 'defaultFont$' '.currentFontSize' '.maxHeight'
 617         .currentFontSize = adjustFontSizeOnHeight.currentFontSize
 618         call set_font_size '.currentFontSize'
 619         demo Colour... '.color$'
 620         demo Text... '.x' Centre '.y' Bottom ?
 621         call set_font_size 'defaultFontSize'
 622 endproc
 623
 624 ###############################################################
 625 #
 626 # Button Processing Routines
 627 #
 628 ###############################################################
 629
 630 # Search row in table on label
 631 procedure findKey .table$ .label$
 632         .row = 0
 633         select Table '.table$'
 634         .to$ = selected$("Table")
 635         .to$ = "Table_"+.to$
 636         .numRows = Get number of rows
 637         for .i to .numRows
 638                 .currentKey$ = '.to$'$[.i, "Key"]
 639                 if .label$ = .currentKey$
 640                         .row = .i
 641                         goto KEYFOUND
 642                 endif
 643         endfor
 644         label KEYFOUND
 645         if .row <= 0 and index(.label$, "_") <= 0
 646                 printline "'.label$'" is not a key in '.table$'
 647         endif
 648 endproc
 649
 650 procedure findLabel .table$ .label$
 651         .row = 0
 652         select Table '.table$'
 653         .to$ = selected$("Table")
 654         .to$ = "Table_"+.to$
 655         .numRows = Get number of rows
 656         for .i to .numRows
 657                 .currentKey$ = '.to$'$[.i, "Label"]
 658                 if .label$ = .currentKey$
 659                         .row = .i
 660                         goto LABELFOUND
 661                 endif
 662         endfor
 663         label LABELFOUND
 664         if .row <= 0 and index(.label$, "_") <= 0
 665                 call emergency_table_exit "'.label$'" is not a key in '.table$'
 666         endif
 667 endproc
 668
 669 # Get the label
 670 procedure buttonClicked table$ .x .y
 671         .label$ = ""
 672         select Table 'table$'
 673         .bo$ = selected$("Table")
 674         .bo$ = "Table_"+.bo$
 675         .numRows = Get number of rows
 676         for .i to .numRows
 677                 if .label$ = ""
 678                         .leftX = '.bo$'[.i, "LeftX"]
 679                         .rightX = '.bo$'[.i, "RightX"]
 680                         .lowY = '.bo$'[.i, "LowY"]
 681                         .highY = '.bo$'[.i, "HighY"]
 682                         if .x > .leftX and .x < .rightX and .y > .lowY and .y < .highY
 683                                 .label$ = '.bo$'$[.i, "Label"]
 684                         endif
 685                 endif
 686         endfor
 687 endproc
 688
 689 procedure keyPressed table$ .pressed$
 690         .label$ = ""
 691         # Magic
 692         if .pressed$ = "" and not demoShiftKeyPressed()
 693                 .label$ = "Refresh"
 694         endif
 695         .lowerPressed$ = replace_regex$(.pressed$, ".", "\L&", 0)
 696         .upperPressed$ = replace_regex$(.pressed$, ".", "\U&", 0)
 697         select Table 'table$'
 698         .bo$ = selected$("Table")
 699         .bo$ = "Table_"+.bo$
 700         .numRows = Get number of rows
 701         for .i to .numRows
 702                 if .label$ = ""
 703                         .key$ = '.bo$'$[.i, "Key"]
 704                         if index(.key$, .lowerPressed$) or index(.key$, .upperPressed$)
 705                                 .label$ = '.bo$'$[.i, "Label"]
 706                         endif
 707                 endif
 708         endfor
 709 endproc
 710
 711 procedure count_syllables
 712         .number = 0
 713         .pinyin$ = ""
 714         select Table 'wordlist$'
 715         if sgc.currentWord > 0 and sgc.currentWord <= sgc.numberOfWords
 716                 .sound$ = Get value... 'sgc.currentWord' Sound
 717                 .pinyin$ = Get value... 'sgc.currentWord' Pinyin
 718         endif
 719         call add_missing_neutral_tones '.pinyin$'
 720         .pinyin$ = add_missing_neutral_tones.pinyin$
 721         if index_regex(.pinyin$, "[0-9]") > 0
 722                 .number = length(replace_regex$(.pinyin$, "[^\d]+([\d]+)", "1", 0))
 723         elsif .pinyin$ <> ""
 724                 .number = 1
 725         endif
 726 endproc
 727
 728 procedure play_sound .sound
 729     if .sound > 0
 730                 if sgc.useAlternativePlayer and fileReadable(sgc.playCommandFile$)
 731                         .scratchFile$ = "'sgc.scratchAudioDir$'SCRATCH.wav"
 732                         select .sound
 733                         Save as WAV file: .scratchFile$
 734                         .command$ < 'sgc.playCommandFile$'
 735                         .command$ = replace$(.command$, "[']", """", 0)
 736                         .command$ = replace$(.command$, "'newline$'", " ", 0)
 737                         if unix or macintosh
 738                                 system_nocheck bash -c -- ''.command$' "'.scratchFile$'"'
 739                         elsif windows
 740                                 system_nocheck call '.command$' "'.scratchFile$'"
 741                         endif
 742                         deleteFile(.scratchFile$)
 743                 else
 744                         select .sound
 745                         Play
 746         endif
 747     endif
 748 endproc
 749
 750 procedure record_sound .recordingTime
 751         if .recordingTime <= 0
 752                 .recordingTime = recordingTime
 753         endif
 754         call clean_up_sound
 755
 756         # There is a very nasty delay before the first recording starts, do a dummy record
 757         if not variableExists("recordingInitialized") and not sgc.useAlternativeRecorder
 758         noprogress nowarn Record Sound (fixed time)... 'config.input$' 0.99 0.5 'samplingFrequency' 0.1
 759                 Remove
 760                 recordingInitialized = 1
 761         endif
 762         # Recording light
 763     demo Paint circle... Red 5 95 2
 764     demoShow()
 765     if sgc.useAlternativeRecorder and fileReadable(sgc.recordCommandFile$)
 766                 .scratchFile$ = "'sgc.scratchAudioDir$'SCRATCH.wav"
 767                 .command$ < 'sgc.recordCommandFile$'
 768                 .command$ = replace$(.command$, "[']", """", 0)
 769                 .command$ = replace$(.command$, "'newline$'", " ", 0)
 770                 if unix or macintosh
 771                         system_nocheck bash -c -- ''.command$' '.recordingTime''
 772                 elsif windows
 773                         system_nocheck call '.command$' '.recordingTime'
 774                 endif
 775                 Read from file: .scratchFile$
 776                 deleteFile(.scratchFile$)
 777         else
 778                 noprogress nowarn Record Sound (fixed time)... 'config.input$' 0.99 0.5 'samplingFrequency' '.recordingTime'
 779         endif
 780     demo Paint circle... White 5 95 2.5
 781     call wipeArea 'wipeFeedbackArea$'
 782
 783     # Feedback on recording level
 784     .extremum = Get absolute extremum... 0 0 None
 785     .radius = 2 * .extremum
 786     if .radius <= 0
 787                 .radius = 0.02
 788     endif
 789     .blue = 0
 790     .green = 0
 791     .red = 0
 792     if .extremum >= 0.95
 793             .red = 1
 794     elsif .extremum >= 0.49
 795             .green = 1
 796     else
 797             .green = .extremum / 0.5
 798     endif
 799     .color$ = "{'.red','.green','.blue'}"
 800     demo Colour... '.color$'
 801     demo Line width... 1
 802     demo Draw circle... 5 95 '.radius'
 803     # Reset
 804     demoShow()
 805     demo Colour... Black
 806     demo Line width... 'defaultLineWidth'
 807     # Process sound
 808     Rename... Tmp
 809     Resample... 10000 50
 810     Rename... Pronunciation
 811     recordedSound$ = selected$("Sound")
 812     sgc.recordedSound = selected("Sound")
 813     select Sound Tmp
 814     Remove
 815     select Sound 'recordedSound$'
 816     sgc.recordedSound = selected("Sound")
 817
 818     # Cut out real sound from silences/noise
 819     call sound_detection 'recordedSound$' 'soundMargin'
 820     select Sound 'recordedSound$'
 821     sgc.recordedSound = selected("Sound")
 822
 823     # Store audio if requested
 824     if sgc.saveAudioOn and sgc.saveAudio$ <> ""
 825                 if sgc.savePerf$ <> "" and fileReadable(sgc.savePerf$)
 826                         .pinyin$ = ""
 827                         select Table 'wordlist$'
 828                         if sgc.currentWord > 0 and sgc.currentWord <= sgc.numberOfWords
 829                                 .pinyin$ = Get value... 'sgc.currentWord' Pinyin
 830                                 .outputName$ = "'sgc.saveAudio$'/'.pinyin$'.wav"
 831                                 select sgc.recordedSound
 832                                 Save as WAV file: .outputName$
 833                         endif
 834                 else
 835                         # The Audio directory disappeared
 836                         sgc.savePerf$ = ""
 837                         sgc.saveAudioOn = 0
 838                         sgc.saveAudio$ = ""
 839                         config.savePerf = 0
 840                         config.openPerf = 0
 841                         config.clearSummary = 0
 842                         config.audioName$ = ""
 843                 endif
 844     endif
 845
 846 endproc
 847
 848
 849 # Select real sound from recording
 850 # Uses some global variable
 851 procedure sound_detection .sound$ .margin
 852         select Sound '.sound$'
 853         .soundlength = Get total duration
 854         .internalSilence = 2*.margin
 855
 856         # Silence and remove noise, DANGEROUS
 857         To TextGrid (silences)... 'minimumPitch' 0 'noiseThresshold' '.internalSilence' 0.1 silent sounding
 858         Rename... Input'.sound$'
 859
 860         select TextGrid Input'.sound$'
 861         .numberofIntervals = Get number of intervals... 1
 862         if .numberofIntervals < 2
 863                 .numberofIntervals = 0
 864         endif
 865
 866         # AAARRRRHHHH this should not be activated!
 867         # Remove buzzing and other obnoxious sounds (if switched on)
 868         if 0
 869                 for .i from 1 to .numberofIntervals
 870                    select TextGrid Input'.sound$'
 871                    .value$ = Get label of interval... 1 '.i'
 872                    .begintime = Get starting point... 1 '.i'
 873                    .endtime = Get end point... 1 '.i'
 874
 875                         # Remove noise
 876                         if .value$ = "silent"
 877                                 select Sound '.sound$'
 878                                 Set part to zero... '.begintime' '.endtime' at nearest zero crossing
 879                         endif
 880                 endfor
 881         endif
 882
 883         # Select target sound
 884         .maximumIntensity = -1
 885         .counter = 1
 886         for i from 1 to .numberofIntervals
 887            select TextGrid Input'.sound$'
 888
 889            .value$ = Get label of interval... 1 'i'
 890            .begintime = Get starting point... 1 'i'
 891            .endtime = Get end point... 1 'i'
 892
 893            if .value$ != "silent"
 894            if .begintime > .margin
 895                   .begintime -= .margin
 896            else
 897                    .begintime = 0
 898            endif
 899            if .endtime + .margin < .soundlength
 900                    .endtime += .margin
 901            else
 902                    .endtime = .soundlength
 903            endif
 904
 905            select Sound '.sound$'
 906            Extract part... '.begintime' '.endtime' Rectangular 1.0 no
 907            Rename... Tmp'.sound$'
 908            Subtract mean
 909            .newIntensity = Get intensity (dB)
 910            if .newIntensity > .maximumIntensity
 911                    if .maximumIntensity > 0
 912                    select Sound New'.sound$'
 913                    Remove
 914                    endif
 915                    select Sound Tmp'.sound$'
 916                    Rename... New'.sound$'
 917                    .maximumIntensity = .newIntensity
 918            else
 919                    select Sound Tmp'.sound$'
 920                    Remove
 921            endif
 922            #
 923            endif
 924         endfor
 925         if .maximumIntensity > minimumIntensity
 926                 select Sound '.sound$'
 927                 Remove
 928                 select Sound New'.sound$'
 929                 Rename... '.sound$'
 930         elsif .maximumIntensity > -1
 931                 select Sound New'.sound$'
 932                 Remove
 933         endif
 934         select TextGrid Input'.sound$'
 935         Remove
 936
 937         select Sound '.sound$'
 938 endproc
 939
 940 procedure end_program
 941         call write_preferences ""
 942         demo Erase all
 943         select all
 944         Remove
 945         exit
 946 endproc
 947
 948 ######################################################
 949 #
 950 # Configuration Page
 951 #
 952 ######################################################
 953 procedure config_page
 954     demo Erase all
 955     demoWindowTitle("Speak Good Chinese: Change settings")
 956     .label$ = ""
 957     call Draw_config_page
 958
 959     while (.label$ <> "Return") and demoWaitForInput()
 960                 .clickX = -1
 961                 .clickY = -1
 962                 .pressed$ = ""
 963             .label$ = ""
 964             if demoClicked()
 965                     .clickX = demoX()
 966                     .clickY = demoY()
 967                     call buttonClicked 'config$' '.clickX' '.clickY'
 968                     .label$ = buttonClicked.label$
 969             elsif demoKeyPressed()
 970                     .pressed$ = demoKey$()
 971                     call keyPressed 'config$' '.pressed$'
 972                     .label$ = keyPressed.label$
 973             endif
 974
 975                 # You cannot select a text field
 976                 if startsWith(.label$, "$")
 977                         .label$ = ""
 978                 endif
 979
 980             # Do things
 981             if .label$ != ""
 982                     # Handle push button in process_config
 983                     call process_config '.label$' '.clickX' '.clickY' '.pressed$'
 984             endif
 985
 986         if .label$ = "Return"
 987             goto GOBACK
 988         endif
 989     endwhile
 990
 991     # Go back
 992     label GOBACK
 993     call init_window
 994 endproc
 995
 996 procedure Draw_config_page
 997         demo Erase all
 998         # Draw background
 999         if config.showBackground
1000                 call draw_background Background
1001         endif
1002         # Draw buttons
1003     call Draw_all_buttons 'config$'
1004         call set_window_title 'config$'
1005     # Set correct buttons (alert)
1006         call setConfigMainPage
1007 endproc
1008
1009 # Do what is asked
1010 procedure process_config .label$ .clickX .clickY .pressed$
1011         if .label$ <> "" and not startsWith(.label$,"!")
1012                 .label$ = replace_regex$(.label$, "^[#]", "", 0)
1013                 .label$ = replace$(.label$, "_", " ", 0)
1014                 call process'config$''.label$' '.clickX' '.clickY' '.pressed$'
1015         endif
1016 endproc
1017
1018 ###############################################################
1019 #
1020 # Presenting help texts
1021 #
1022 ###############################################################
1023
1024 # Process Help
1025 procedure help_loop .table$ .redrawProc$
1026         # General Help text
1027         call  write_help_title '.table$'
1028
1029     .label$ = ""
1030     call Draw_button '.table$' Help 2
1031     .redrawScreen = 0
1032     while (.label$ <> "Help") and demoWaitForInput()
1033             .label$ = ""
1034             if demoClicked()
1035                     .clickX = demoX()
1036                     .clickY = demoY()
1037                     call buttonClicked '.table$' '.clickX' '.clickY'
1038                     .label$ = buttonClicked.label$
1039             elsif demoKeyPressed()
1040                     .pressed$ = demoKey$()
1041                     call keyPressed '.table$' '.pressed$'
1042                     .label$ = keyPressed.label$
1043             endif
1044
1045             if .label$ != "" and .label$ <> "Help"
1046                         # Redraw screen
1047                         if .redrawScreen
1048                                 demo Erase all
1049                                 call '.redrawProc$'
1050                         else
1051                         .redrawScreen = 1
1052                         endif
1053                         call Draw_button '.table$' Help 2
1054                         call  write_help_title '.table$'
1055
1056                     # Handle push button in process_config
1057                     call write_help_text '.table$' '.label$'
1058             endif
1059
1060     endwhile
1061
1062         # Reset button
1063     call Draw_button '.table$' Help 0
1064         demo Erase all
1065         call '.redrawProc$'
1066 endproc
1067
1068 # Write help text
1069 procedure write_help_text .table$ .label$
1070         call findLabel '.table$' '.label$'
1071         .row = findLabel.row
1072         select Table '.table$'
1073         # Get text
1074         if .row <= 0
1075                 call findLabel '.table$' Help
1076                 .row = findLabel.row
1077                 select Table '.table$'
1078         endif
1079         .helpText$ = Get value... '.row' Helptext
1080         .helpKey$ = Get value... '.row' Key
1081         .helpKey$ = replace$(.helpKey$, "\", "", 0)
1082         .helpKey$ = replace$(.helpKey$, "_", "\_ ", 0)
1083         if index_regex(.helpKey$, "\S")
1084                 .helpText$ = .helpText$+" ("+.helpKey$+")"
1085         endif
1086         # Get button values
1087     .leftX = Get value... '.row' LeftX
1088     .rightX = Get value... '.row' RightX
1089     .lowY = Get value... '.row' LowY
1090     .highY = Get value... '.row' HighY
1091
1092         # PopUp dimensions
1093         .currentHelpFontSize = defaultFontSize
1094     call set_font_size '.currentHelpFontSize'
1095         .helpTextSize = demo Text width (wc)... '.helpText$'
1096         .helpTextSize += 4
1097         if .leftX > 50
1098                 .htXleft = 20
1099                 .htXright = .htXleft + .helpTextSize + 5
1100                 .xstart = .leftX
1101         else
1102                 .htXright = 80
1103                 .htXleft = .htXright - .helpTextSize - 5
1104                 .xstart = .rightX
1105         endif
1106         if .lowY > 50
1107                 .htYlow = 40
1108                 .htYhigh = .htYlow + 7
1109                 .ystart = .lowY
1110                 .yend = .htYhigh
1111         else
1112                 .htYhigh = 60
1113                 .htYlow = .htYhigh - 7
1114                 .ystart = .highY
1115                 .yend = .htYlow
1116         endif
1117
1118         # Adapt font size to horizontal dimensions
1119         .maxWidth = 90
1120         call adjustFontSizeOnWidth 'defaultFont$' '.currentHelpFontSize' '.maxWidth' '.helpText$'
1121         .currentHelpFontSize = adjustFontSizeOnWidth.newFontSize
1122         if .htXleft < 0 or .htXright > 100
1123                 .htXleft = 0
1124                 .htXright = .htXleft + adjustFontSizeOnWidth.textWidth + 5
1125         endif
1126         call set_font_size '.currentHelpFontSize'
1127
1128         # Adapt vertical dimensions to font height
1129         call points_to_wc '.currentHelpFontSize'
1130         .lineHeight = points_to_wc.wc
1131         if .lineHeight > .htYhigh - .htYlow - 4
1132                 .htYhigh = .htYlow + .lineHeight + 4
1133         endif
1134
1135         # Determine arrow endpoints
1136         .xend = .htXleft
1137         if abs(.htXleft - .xstart) > abs(.htXright - .xstart)
1138                 .xend = .htXright
1139         endif
1140         if abs((.htXleft+.htXright)/2 - .xstart) < min(abs(.htXright - .xstart),abs(.htXleft - .xstart))
1141                 .xend = (.htXleft+.htXright)/2
1142         endif
1143
1144         .xtext = .htXleft + 2
1145         .ytext = .htYlow + 1
1146
1147         # Draw pop-up
1148         .mm2wc = demo Horizontal mm to wc... 1
1149         .lineWidth = 2/.mm2wc
1150         demo Line width... '.lineWidth'
1151         demo Arrow size... '.lineWidth'
1152         demo Colour... 'sgc2.popUp_bordercolor$'
1153         demo Paint rectangle... 'sgc2.popUp_backgroundcolor$' '.htXleft' '.htXright' '.htYlow' '.htYhigh'
1154         demo Draw rectangle... '.htXleft' '.htXright' '.htYlow' '.htYhigh'
1155         demo Draw arrow... '.xstart' '.ystart' '.xend' '.yend'
1156         demo Line width... 'defaultLineWidth'
1157         demo Arrow size... 1
1158         demo Black
1159         demo Text... '.xtext' Left '.ytext' Bottom '.helpText$'
1160         demoShow()
1161         call set_font_size 'defaultFontSize'
1162
1163 endproc
1164
1165 procedure write_help_title .table$
1166         # Set help text title
1167         # General Help text
1168         call findLabel '.table$' Help
1169         .row = findLabel.row
1170         select Table '.table$'
1171         .helpTitle$ = Get value... '.row' Helptext
1172         .helpKey$ = Get value... '.row' Key
1173         .helpKey$ = replace$(.helpKey$, "\", "", 0)
1174         .helpKey$ = replace$(.helpKey$, "_", "\_ ", 0)
1175         .helpTitle$ = .helpTitle$+" ("+.helpKey$+")"
1176
1177         call reset_viewport
1178         .helpTitleFontSize = 14
1179         # Adapt size of button to length of text
1180         .maxWidth = 80
1181         call adjustFontSizeOnWidth 'defaultFont$' '.helpTitleFontSize' '.maxWidth' '.helpTitle$'
1182         .helpTitleFontSize = adjustFontSizeOnWidth.newFontSize
1183         call set_font_size '.helpTitleFontSize'
1184         .helpTop = 100
1185
1186         demo Select inner viewport... 0 100 0 100
1187         demo Axes... 0 100 0 100
1188         demo Text... 50 Centre '.helpTop' Top '.helpTitle$'
1189     call set_font_size 'defaultFontSize'
1190         call reset_viewport
1191 endproc
1192
1193 ###############################################################
1194 #
1195 # Miscelaneous procedures
1196 #
1197 ###############################################################
1198 procedure printPageToPrinter
1199         call print_window
1200         demo Print... 'printerName$' 'printerPresets$'
1201         call init_window
1202 endproc
1203
1204 procedure getOpenFile .openDialogue$
1205         call clean_up_sound
1206
1207         call convert_praat_to_latin1 '.openDialogue$'
1208         .openDialogue$ = convert_praat_to_latin1.text$
1209         .filename$ = chooseReadFile$ (.openDialogue$)
1210         .tmp = -1
1211         if .filename$ <> "" and fileReadable(.filename$)
1212                 .tmp = nocheck Read from file... '.filename$'
1213                 if .tmp !- undefined and .tmp > 0
1214                         call log_fileOpen '.filename$'
1215
1216                         # Get only the filename
1217                         .startName = rindex_regex(.filename$, "[/\\:]") + 1
1218                         .nameLength = rindex(.filename$, ".") - .startName
1219                         currentSoundName$ = mid$(.filename$, .startName, .nameLength)
1220                 else
1221                         .tmp = -1
1222                 endif
1223         endif
1224         if .tmp <= 0
1225                 Create Sound from formula... Speech Mono 0 1 44100 0
1226         endif
1227         recordedSound$ = selected$("Sound")
1228         sgc.recordedSound = selected("Sound")
1229         currentStartTime = 0
1230         currentEndTime = Get total duration
1231         # Reset selected window
1232         selectedStartTime = currentStartTime
1233         selectedEndTime = currentEndTime
1234 endproc
1235
1236 procedure points_to_wc .points
1237         .mm = .points * 0.3527777778
1238         .wc = demo Vertical mm to wc... '.mm'
1239 endproc
1240
1241 procedure reset_viewport
1242         .low = viewportMargin
1243         .high = 100 - viewportMargin
1244         demo Select inner viewport... '.low' '.high' '.low' '.high'
1245         demo Axes... 0 100 0 100
1246 endproc
1247
1248 procedure set_font_size .fontSize
1249         call reset_viewport
1250         demo Font size... '.fontSize'
1251         call reset_viewport
1252 endproc
1253
1254 procedure wipeArea .areaCommand$
1255         call reset_viewport
1256         '.areaCommand$'
1257 endproc
1258
1259 procedure adjustFontSizeOnWidth .font$ .currentFontSize .maxWidth .text$
1260         demo '.font$'
1261         call set_font_size '.currentFontSize'
1262         .textWidth = demo Text width (wc)... '.text$'
1263         while .textWidth > .maxWidth and .currentFontSize > 2
1264                 .currentFontSize -= 0.5
1265                 call set_font_size '.currentFontSize'
1266                 .textWidth = demo Text width (wc)... '.text$'
1267         endwhile
1268         .diff = .textWidth - .maxWidth
1269         .newFontSize = .currentFontSize
1270         demo 'defaultFont$'
1271 endproc
1272
1273 procedure adjustRotatedFontSizeOnBox .font$ .currentFontSize .maxWidth .maxHeight .rotation .text$
1274         demo '.font$'
1275         .radians = .rotation/360 * 2 * pi
1276         .horWC = demo Horizontal mm to wc... 10.0
1277         .verWC = demo Vertical mm to wc... 10.0
1278         if .horWC > 0
1279                 .verCoeff = .verWC / .horWC
1280         else
1281                 .verCoeff = 1
1282         endif
1283         call set_font_size '.currentFontSize'
1284         .textLength = demo Text width (wc)... '.text$'
1285         while (.textLength * .verCoeff * sin(.radians) > .maxHeight or .textLength * cos(.radians) > .maxWidth) and .currentFontSize > 2
1286                 .currentFontSize -= 0.5
1287                 call set_font_size '.currentFontSize'
1288                 .textLength = demo Text width (wc)... '.text$'
1289         endwhile
1290         .diff = .textLength - .maxHeight
1291         .newFontSize = .currentFontSize
1292         demo 'defaultFont$'
1293 endproc
1294
1295 procedure adjustFontSizeOnHeight .font$ .currentFontSize .maxHeight
1296         demo '.font$'
1297         call points_to_wc '.currentFontSize'
1298         .lineHeight = points_to_wc.wc
1299         while .lineHeight > .maxHeight and .currentFontSize > 2
1300                 .currentFontSize -= 0.5
1301                 call points_to_wc '.currentFontSize'
1302                 .lineHeight = points_to_wc.wc
1303         endwhile
1304         .diff = .lineHeight - .maxHeight
1305         .newFontSize = .currentFontSize
1306         demo 'defaultFont$'
1307 endproc
1308
1309 # Load a table with button info etc.
1310 # Load local tables if present. Else load
1311 # build-in scripted tables
1312 procedure loadTable .tableName$
1313         .tableVariableName$ = replace_regex$(.tableName$, "[^\w]", "_", 0);
1314         # Search for the table in local, preference, and global directories
1315         if fileReadable("'localTableDir$'/'.tableName$'.Table")
1316         Read from file... 'localTableDir$'/'.tableName$'.Table
1317         elsif fileReadable("'preferencesTableDir$'/'.tableName$'.Table")
1318         Read from file... 'preferencesTableDir$'/'.tableName$'.Table
1319         elsif fileReadable("'globaltablelists$'/'.tableName$'.Table")
1320         Read from file... 'globaltablelists$'/'.tableName$'.Table
1321         # Load them from script
1322         elsif variableExists("procCreate'.tableVariableName$'$")
1323                 call Create'.tableVariableName$'
1324         else
1325                 call write_text_popup 'defaultFont$' 14 '.tableName$' cannot be found
1326                 demoWaitForInput()
1327                 exit '.tableName$' cannot be found
1328         endif
1329 endproc
1330
1331 procedure testLoadTable .tableName$
1332         .table = 0
1333         .tableVariableName$ = replace_regex$(.tableName$, "[^\w]", "_", 0);
1334         # Search for the table in local, preference, and global directories
1335         if fileReadable("'localTableDir$'/'.tableName$'.Table")
1336         .table = 1
1337         elsif fileReadable("'preferencesTableDir$'/'.tableName$'.Table")
1338         .table = 2
1339         elsif fileReadable("'globaltablelists$'/'.tableName$'.Table")
1340         .table = 3
1341         # Load them from script
1342         elsif variableExists("procCreate'.tableVariableName$'$")
1343                 .table = 4
1344         else
1345                 .table = 0
1346         endif
1347 endproc
1348
1349 procedure checkTable .tableName$
1350         .available = 0
1351         if fileReadable("'localTableDir$'/'.tableName$'.Table")
1352         .available = 1
1353         elsif fileReadable("'preferencesTableDir$'/'.tableName$'.Table")
1354         .available = 1
1355         elsif fileReadable("'globaltablelists$'/'.tableName$'.Table")
1356         .available = 1
1357         # Load them from script
1358         elsif variableExists("procCreate'.tableName$'$")
1359         .available = 1
1360         else
1361         .available = 0
1362     endif
1363 endproc
1364
1365 # Create a pop-up window with text from a Text Table
1366 procedure write_text_table .table$
1367         .xleft = 10
1368         .xright = 90
1369         .ylow = 20
1370         .yhigh = 85
1371         .lineHeight = 2.5
1372
1373         # Get table with text and longest line
1374         .numLines = 0
1375         call testLoadTable '.table$'
1376         if testLoadTable.table > 0
1377                 call loadTable '.table$'
1378                 .instructionText = selected()
1379                 .numLines = Get number of rows
1380         endif
1381         .instructionFontSize = 14
1382         .referenceText$ = ""
1383         .maxlenght = 0
1384         .maxLine = 0
1385         .maxFontSize = 0
1386         .maxWidth = 0
1387         for .l to .numLines
1388                 select '.instructionText'
1389                 .currentText$ = Get value... '.l' text
1390                 # Expand variables, eg, 'praatVersion$'
1391                 call expand_praat_variables '.currentText$'
1392                 .currentText$ = expand_praat_variables.text$
1393
1394                 .font$ = Get value... '.l' font
1395                 .fontSize = Get value... '.l' size
1396                 call set_font_size '.fontSize'
1397                 .textWidth = demo Text width (wc)... '.currentText$'
1398                 if .fontSize > .maxFontSize
1399                         .maxFontSize = .fontSize
1400                 endif
1401                 if .textWidth > .maxWidth
1402                         .maxWidth = .textWidth
1403                         .instructionFontSize = .fontSize
1404                         .maxLine = .l
1405                 endif
1406         endfor
1407         select '.instructionText'
1408         .referenceText$ = Get value... '.maxLine' text
1409         .maxLineFont$ = Get value... '.maxLine' font
1410         .instructionFontSize = Get value... '.maxLine' size
1411         call set_font_size '.maxFontSize'
1412
1413         # Adapt size of button to length of text
1414         .maxWidth = (.xright - .xleft) - 4
1415         .origFontSize = .instructionFontSize
1416         call adjustFontSizeOnWidth 'defaultFont$' '.instructionFontSize' '.maxWidth' '.referenceText$'
1417         call adjustFontSizeOnHeight 'defaultFont$' '.maxFontSize' '.lineHeight'
1418         .instructionFontSize = min(adjustFontSizeOnWidth.newFontSize, adjustFontSizeOnHeight.newFontSize)
1419         if adjustFontSizeOnWidth.diff > 0
1420                 .xright += adjustFontSizeOnWidth.diff/4
1421                 .xleft -= 3*adjustFontSizeOnWidth.diff/4
1422         endif
1423         call set_font_size '.instructionFontSize'
1424         .fontSizeFactor = .instructionFontSize / .origFontSize
1425
1426         .numRows = Get number of rows
1427         # Calculate length from number of lines.
1428         .dy = .lineHeight
1429         .midY = .yhigh - (.yhigh - .ylow)/2
1430         .yhigh = .midY + (.numRows+1) * .dy / 2
1431         .ylow = .yhigh - (.numRows+1) * .dy
1432         .textleft = .xleft + 2
1433
1434         demo Line width... 8
1435         demo Colour... 'sgc2.popUp_bordercolor$'
1436         demo Paint rectangle... 'sgc2.popUp_backgroundcolor$' '.xleft' '.xright' '.ylow' '.yhigh'
1437         demo Draw rectangle... '.xleft' '.xright' '.ylow' '.yhigh'
1438         demo Line width... 'defaultLineWidth'
1439         demo Black
1440         .ytext = .yhigh - 2 - .dy
1441         for .i to .numRows
1442                 select '.instructionText'
1443                 .font$ = Get value... '.i' font
1444                 .fontSize = Get value... '.i' size
1445                 .font$ = extractWord$(.font$, "")
1446                 # Scale font
1447                 .fontSize = floor(.fontSize*.fontSizeFactor)
1448                 if .fontSize < 4
1449                         .fontSize = 4
1450                 endif
1451                 .line$ = Get value... '.i' text
1452                 # Expand variables, eg, 'praatVersion$'
1453                 call expand_praat_variables '.line$'
1454                 .line$ = expand_praat_variables.text$
1455
1456                 # Display text
1457                 demo Text special... '.textleft' Left '.ytext' Bottom '.font$' '.fontSize' 0 '.line$'
1458                 .ytext -= .dy
1459         endfor
1460         demoShow()
1461         call set_font_size 'defaultFontSize'
1462
1463         select '.instructionText'
1464         Remove
1465
1466         label ESCAPEwrite_text_table
1467 endproc
1468
1469
1470 # Create a pop-up window with text from an existing Table object
1471 procedure write_tabbed_table .table$ .labelTextTable$
1472         .xleft = 0
1473         .xright = 100
1474         .ylow = 20
1475         .yhigh = 85
1476         .lineHeight = 2.5
1477
1478         # Get table with text and longest line
1479         call testLoadTable '.table$'
1480         if testLoadTable.table <= 0
1481                 call loadTable '.labelTextTable$'
1482                 .labelText$ = selected$("Table")
1483         endif
1484
1485         select Table '.table$'
1486         .tabbedText = selected()
1487         .numLines = Get number of rows
1488         .numCols = Get number of columns
1489         .font$ = defaultFont$
1490         .fontSize = defaultFontSize
1491         # Standard width
1492         .widthCanvas = .xright - .xleft
1493         .dx = (.widthCanvas - 4) / (.numCols)
1494
1495         # Get longest entry
1496         demo '.font$'
1497         call set_font_size '.fontSize'
1498         .maxWidth = 0
1499         for .i from 0 to .numLines
1500                 .xtext = .xleft + .dx / 2
1501                 for .j to .numCols
1502                         select '.tabbedText'
1503                         .currentLabel$ = Get column label... '.j'
1504                         if .i > 0
1505                                 .line$ = Get value... '.i' '.currentLabel$'
1506                         else
1507                                 .line$ = .currentLabel$
1508                                 select Table '.labelText$'
1509                         call findLabel '.labelText$' '.line$'
1510                         select Table '.labelText$'
1511                         .line$ = Get value... 'findLabel.row' Text
1512                         endif
1513                         # Expand variables, eg, 'praatVersion$'
1514                         call expand_praat_variables '.line$'
1515                         .line$ = expand_praat_variables.text$
1516                         .textWidth = demo Text width (wc)... '.line$'
1517                         if .textWidth > .maxWidth
1518                                 .maxWidth = .textWidth
1519                         endif
1520                 endfor
1521         endfor
1522         if .dx > 1.2 * .maxWidth
1523                 .widthCanvas =  1.2 * .maxWidth * .numCols + 4
1524                 .xleft = 50 - .widthCanvas / 2
1525                 .xright = 50 + .widthCanvas / 2
1526                 .dx = (.widthCanvas - 4) / (.numCols)
1527         else
1528                 .maxWidth = .dx - 1
1529         endif
1530
1531         # Calculate length from number of lines.
1532         .dy = .lineHeight + 0.5
1533         .midY = .yhigh - (.yhigh - .ylow)/2
1534         .yhigh = .midY + (.numLines+2) * .dy / 2
1535         .ylow = .yhigh - (.numLines+2) * .dy
1536         .textleft = .xleft + 2
1537
1538         demo Line width... 8
1539         demo Colour... 'sgc2.popUp_bordercolor$'
1540         demo Paint rectangle... 'sgc2.popUp_backgroundcolor$' '.xleft' '.xright' '.ylow' '.yhigh'
1541         demo Draw rectangle... '.xleft' '.xright' '.ylow' '.yhigh'
1542         demo Line width... 'defaultLineWidth'
1543         demo Black
1544         .ytext = .yhigh - 2 - .dy
1545         # First the column names, then the items
1546         for .i from 0 to .numLines
1547                 .xtext = .textleft + .dx / 2
1548                 for .j to .numCols
1549                         select '.tabbedText'
1550                         .currentLabel$ = Get column label... '.j'
1551                         if .i > 0
1552                                 .line$ = Get value... '.i' '.currentLabel$'
1553                         else
1554                                 .line$ = .currentLabel$
1555                                 select Table '.labelText$'
1556                         call findLabel '.labelText$' '.line$'
1557                         select Table '.labelText$'
1558                         .line$ = Get value... 'findLabel.row' Text
1559                         endif
1560                         # Expand variables, eg, 'praatVersion$'
1561                         call expand_praat_variables '.line$'
1562                         .line$ = expand_praat_variables.text$
1563                         call adjustFontSizeOnWidth '.font$' '.fontSize' '.maxWidth' '.line$'
1564                         .currentFontSize = adjustFontSizeOnWidth.newFontSize
1565
1566                         # Display text
1567                         demo Text special... '.xtext' Centre '.ytext' Bottom '.font$' '.currentFontSize' 0 '.line$'
1568                         .xtext += .dx
1569                 endfor
1570                 .ytext -= .dy
1571         endfor
1572         demoShow()
1573         call set_font_size 'defaultFontSize'
1574         select Table '.labelText$'
1575         Remove
1576
1577         label ESCAPEwrite_tabbed_table
1578 endproc
1579
1580 # Create a pop-up window with a given text
1581 procedure write_text_popup .font$ .size .text$
1582         .xleft = 10
1583         .xright = 90
1584         .ylow = 20
1585         .yhigh = 85
1586         .lineHeight = 3
1587
1588         # Adapt size of button to length of text
1589         .maxWidth = (.xright - .xleft) - 4
1590         call adjustFontSizeOnWidth 'defaultFont$' '.size' '.maxWidth' '.text$'
1591         call adjustFontSizeOnHeight 'defaultFont$' '.size' '.lineHeight'
1592         .popupFontSize = min(adjustFontSizeOnWidth.newFontSize, adjustFontSizeOnHeight.newFontSize)
1593         if adjustFontSizeOnWidth.diff > 0
1594                 .xright += adjustFontSizeOnWidth.diff/4
1595                 .xleft -= 3*adjustFontSizeOnWidth.diff/4
1596         else
1597                 .xleft = ((.xright + .xleft) - adjustFontSizeOnWidth.textWidth)/2 - 2
1598                 .xright = ((.xright + .xleft) + adjustFontSizeOnWidth.textWidth)/2 + 2
1599         endif
1600
1601         .numRows = 1
1602         # Calculate length from number of lines.
1603         .dy = .lineHeight
1604         .midY = .yhigh - (.yhigh - .ylow)/2
1605         .yhigh = .midY + (.numRows+1) * .dy / 2
1606         .ylow = .yhigh - (.numRows+1) * .dy
1607         .textleft = .xleft + 2
1608         .xmid = (.textleft + .xright - 2)/2
1609
1610         demo Line width... 8
1611         demo Colour... 'sgc2.popUp_bordercolor$'
1612         demo Paint rectangle... 'sgc2.popUp_backgroundcolor$' '.xleft' '.xright' '.ylow' '.yhigh'
1613         demo Draw rectangle... '.xleft' '.xright' '.ylow' '.yhigh'
1614         demo Line width... 'defaultLineWidth'
1615         demo Black
1616         .ytext = .yhigh - 2 - .dy
1617         # Write text
1618         demo Text special... '.xmid' Centre '.ytext' Bottom '.font$' '.popupFontSize' 0 '.text$'
1619
1620         demoShow()
1621         demo 'defaultFont$'
1622         call set_font_size 'defaultFontSize'
1623 endproc
1624
1625 # Write the background from a Text Table
1626 procedure draw_background .table$
1627         .xleft = 0
1628         .xright = 100
1629         .ylow = 0
1630         .yhigh = 100
1631         .lineHeight = 5
1632         .defaultColour$ = "{0.9,0.9,0.9}"
1633         .defaultAlign$ = "centre"
1634
1635         # Get table with text and longest line
1636         call loadTable '.table$'
1637         .backgroundText = selected()
1638         .numLines = Get number of rows
1639         .backgroundFontSize = 28
1640         .referenceText$ = ""
1641         .maxlenght = 0
1642         .maxLine = 0
1643         .maxFontSize = 0
1644         .maxWidth = 0
1645         .textLines = 0
1646         for .l to .numLines
1647                 select '.backgroundText'
1648                 .currentText$ = Get value... '.l' text
1649                 # Expand variables, eg, 'praatVersion$'
1650                 call expand_praat_variables '.currentText$'
1651                 .currentText$ = expand_praat_variables.text$
1652
1653                 .font$ = Get value... '.l' font
1654                 .fontSize = Get value... '.l' size
1655                 if .fontSize > .maxFontSize
1656                         .maxFontSize = .fontSize
1657                 endif
1658                 if not startsWith(.font$, "!")
1659                         call set_font_size '.fontSize'
1660                         .textWidth = demo Text width (wc)... '.currentText$'
1661                         if .textWidth > .maxWidth
1662                                 .maxWidth = .textWidth
1663                                 .backgroundFontSize = .fontSize
1664                                 .maxLine = .l
1665                         endif
1666
1667                         .textLines += 1
1668                 endif
1669         endfor
1670         if .maxLine > 0
1671                 select '.backgroundText'
1672                 .referenceText$ = Get value... '.maxLine' text
1673                 .maxLineFont$ = Get value... '.maxLine' font
1674                 .backgroundFontSize = Get value... '.maxLine' size
1675                 .backgroundFontColour$ = Get value... '.maxLine' colour
1676                 call set_font_size '.maxFontSize'
1677         else
1678                 .maxFontSize = .backgroundFontSize
1679         endif
1680
1681         # Adapt size of button to length of text
1682         .maxWidth = (.xright - .xleft) - 4
1683         .origFontSize = .backgroundFontSize
1684         call adjustFontSizeOnWidth 'defaultFont$' '.backgroundFontSize' '.maxWidth' '.referenceText$'
1685         .fontSizeFactor = adjustFontSizeOnWidth.newFontSize / .backgroundFontSize
1686         .backgroundFontSize = adjustFontSizeOnWidth.newFontSize
1687         call set_font_size '.backgroundFontSize'
1688
1689         call adjustFontSizeOnHeight 'defaultFont$' '.backgroundFontSize' '.lineHeight'
1690         .lineHeight /= adjustFontSizeOnHeight.newFontSize / .backgroundFontSize
1691         if adjustFontSizeOnHeight.newFontSize >= .origFontSize and (.textLines+1) * .lineHeight > (.yhigh - .ylow - 4)
1692                 .lineHeight = (.yhigh - .ylow - 4)/(.textLines + 1)
1693                 call adjustFontSizeOnHeight 'defaultFont$' '.maxFontSize' '.lineHeight'
1694                 .fontSizeFactor = adjustFontSizeOnHeight.newFontSize / .backgroundFontSize
1695         endif
1696
1697         .numRows = Get number of rows
1698         # Calculate length from number of lines.
1699         .dy = .lineHeight
1700         .midY = .yhigh - (.yhigh - .ylow)/2
1701         .yhigh = .midY + (.textLines+1) * .dy / 2
1702         .ylow = .yhigh - (.textLines+1) * .dy
1703         .textleft = .xleft + 2
1704         .textright = .xright - 2
1705         .textmid = (.xright - .xleft)/2
1706
1707         demo Black
1708         .ytext = .yhigh - 2 - .dy
1709         for .i to .numRows
1710                 select '.backgroundText'
1711                 .font$ = Get value... '.i' font
1712                 .fontSize = Get value... '.i' size
1713                 .fontColour$ = Get value... '.i' colour
1714                 .fontColour$ = replace_regex$(.fontColour$, "^[\- ]$", ".defaultColour$", 1)
1715                 .fontAlign$ = Get value... '.i' align
1716                 .fontAlign$ = replace_regex$(.fontAlign$, "^[\- ]$", ".defaultAlign$", 1)
1717                 .line$ = Get value... '.i' text
1718                 # Expand variables, eg, 'praatVersion$'
1719                 call expand_praat_variables '.line$'
1720                 .line$ = expand_praat_variables.text$
1721
1722                  # Scale font
1723                  .fontSize = floor(.fontSize*.fontSizeFactor)
1724                 if not startsWith(.font$, "!")
1725                         .font$ = extractWord$(.font$, "")
1726
1727                         if .fontAlign$ = "centre"
1728                                 .xtext = .textmid
1729                         elsif .fontAlign$ = "right"
1730                                 .xtext = .textright
1731                         else
1732                                 .xtext = .textleft
1733                         endif
1734                         if .fontSize < 4
1735                                 .fontSize = 4
1736                         endif
1737                         # Clean up text
1738                         demo Colour... '.fontColour$'
1739                         demo Text special... '.xtext' '.fontAlign$' '.ytext' Bottom '.font$' '.fontSize' 0 '.line$'
1740                         .ytext -= .dy
1741                 elsif .font$ = "!demo command"
1742                         demo Colour... '.fontColour$'
1743                         .line$ = replace_regex$(.line$, "\{FONTSIZE\$\}", "'.fontSize'", 0)
1744                         .line$ = replace_regex$(.line$, "\{XTEXT\$\}", "'.xtext'", 0)
1745                         .line$ = replace_regex$(.line$, "\{YTEXT\$\}", "'.ytext'", 0)
1746                         .line$ = replace_regex$(.line$, "\{DY\$\}", "'.dy'", 0)
1747                         .line$ = replace_regex$(.line$, "\{[^\}]*\}", "", 0)
1748                         while index(.line$, "[[")
1749                                 .nextBracketOpen = index(.line$, "[[")
1750                                 .nextBracketOpen += 2
1751                                 .nextBracketClose = index(.line$, "]]")
1752                                 .bracketLength = .nextBracketClose - .nextBracketOpen
1753                                 .result$ = ""
1754                                 if .bracketLength > 0
1755                                         .expression$ = mid$(.line$, .nextBracketOpen, .bracketLength)
1756                                         .expression$ = replace_regex$(.expression$, "\s", "", 0)
1757                                         if length(.expression$) > 0
1758                                                 # Test expression for security, only allow explicitely defined functions
1759                                                 .allowedStrings$ = "e|pi|not|and|or|div|mod|abs|round|floor|ceiling"
1760                                                 .allowedStrings$ = .allowedStrings$ + "|sqrt|min|max|imin|imax|sin|cos|tan|arcsin|arccos|arctan|arctan2|sinc|sincpi"
1761                                                 .allowedStrings$ = .allowedStrings$ + "|exp|ln|log10|log2|sinh|cosh|tanh|arcsinh|arccosh|arctanh"
1762                                                 .allowedStrings$ = .allowedStrings$ + "|sigmoid|invSigmoid|erf|erfc|randomUniform|randomInteger|randomGauss|randomPoisson"
1763                                                 .allowedStrings$ = .allowedStrings$ + "|lnGamma|gaussP|gaussQ|invGaussQ|chiSquareP|chiSquareQ"
1764                                                 .allowedStrings$ = .allowedStrings$ + "|invChiSquareP|invChiSquareQ|studentP|studentQ|invStudentP|invStudentQ"
1765                                                 .allowedStrings$ = .allowedStrings$ + "|beta|besselI|besselK"
1766                                                 .testExpression$ = replace_regex$(.expression$, "(^|\W)('.allowedStrings$')(?=$|\W)", "\1\3", 0)
1767                                                 .testExpression$ = replace_regex$(.testExpression$, "[0-9\.,\-+/*^()<>= ]", "", 0)
1768                                                 if .testExpression$ = ""
1769                                                         .calc = '.expression$'
1770                                                         .result$ = "'.calc'"
1771                                                 endif
1772                                         endif
1773                                 endif
1774
1775                                 # Replace expression by result
1776                                 .lastLeft = .nextBracketOpen - 3
1777                                 .newLine$ = left$(.line$, .lastLeft)
1778                                 .newLine$ =  .newLine$ + .result$
1779                                 .numCopy = length(.line$) - .nextBracketClose - 1
1780                                 .newLine$ =  .newLine$ + right$(.line$, .numCopy)
1781                                 .line$ = .newLine$
1782                         endwhile
1783                         demo '.line$'
1784                 endif
1785         endfor
1786         demo Black
1787         demoShow()
1788         call set_font_size 'defaultFontSize'
1789
1790         select '.backgroundText'
1791         Remove
1792 endproc
1793
1794 procedure convert_praat_to_utf8 .text$
1795         .text$ = replace_regex$(.text$, "\\a""", "\xc3\xa4", 0)
1796         .text$ = replace_regex$(.text$, "\\A""", "\xc3\x84", 0)
1797         .text$ = replace_regex$(.text$, "\\o""", "\xc3\xb6", 0)
1798         .text$ = replace_regex$(.text$, "\\O""", "\xc3\x96", 0)
1799         .text$ = replace_regex$(.text$, "\\u""", "\xc3\xbc", 0)
1800         .text$ = replace_regex$(.text$, "\\U""", "\xc3\x9c", 0)
1801         .text$ = replace_regex$(.text$, "\\i""", "\xc3\xaf", 0)
1802         .text$ = replace_regex$(.text$, "\\I""", "\xc3\x8f", 0)
1803         .text$ = replace_regex$(.text$, "\\e""", "\xc3\xab", 0)
1804         .text$ = replace_regex$(.text$, "\\E""", "\xc3\x8b", 0)
1805         .text$ = replace_regex$(.text$, "\\y""", "\xc3\xbf", 0)
1806         .text$ = replace_regex$(.text$, "\\e'", "\xc3\xa9", 0)
1807         .text$ = replace_regex$(.text$, "\\E'", "\xc3\x89", 0)
1808         .text$ = replace_regex$(.text$, "\\ss", "\xc3\x9f", 0)
1809 endproc
1810
1811 procedure convert_praat_to_latin1 .text$
1812         .text$ = replace_regex$(.text$, "\\a""", "\xe4", 0)
1813         .text$ = replace_regex$(.text$, "\\A""", "\xc4", 0)
1814         .text$ = replace_regex$(.text$, "\\o""", "\xf6", 0)
1815         .text$ = replace_regex$(.text$, "\\O""", "\xd6", 0)
1816         .text$ = replace_regex$(.text$, "\\u""", "\xfc", 0)
1817         .text$ = replace_regex$(.text$, "\\U""", "\xdc", 0)
1818         .text$ = replace_regex$(.text$, "\\i""", "\xef", 0)
1819         .text$ = replace_regex$(.text$, "\\I""", "\xcf", 0)
1820         .text$ = replace_regex$(.text$, "\\e""", "\xeb", 0)
1821         .text$ = replace_regex$(.text$, "\\E""", "\xcb", 0)
1822         .text$ = replace_regex$(.text$, "\\y""", "\xff", 0)
1823         .text$ = replace_regex$(.text$, "\\Y""", "Y", 0)
1824         .text$ = replace_regex$(.text$, "\\e'", "\xe9", 0)
1825         .text$ = replace_regex$(.text$, "\\E'", "\xc9", 0)
1826         .text$ = replace_regex$(.text$, "\\ss", "\xdf", 0)
1827 endproc
1828
1829 # Expand 'variable$' into the value of variable$.
1830 # Eg, 'praatVersion$' becomes 5.1.45 or whatever is the current version
1831 # Single quotes can be protected by \'
1832 procedure expand_praat_variables .text$
1833         if index(.text$, "'")
1834                 .tempText$ = replace_regex$(.text$, "(^|[^\\])'([\w\$\.]+)'", "\1""+\2+""", 0)
1835                 .tempText$ = replace_regex$(.tempText$, "[\\]'", "'", 0)
1836                 .tempText$ = """"+.tempText$+""""
1837                 # Check whether all the variables actually exist. Ignore any variable that does not exist
1838                 .checkVars$ = .tempText$
1839                 while length(.checkVars$) > 0 and index(.checkVars$, "+")
1840                         .start = index(.checkVars$, "+")
1841                         .checkVars$ = right$(.checkVars$, length(.checkVars$) - .start)
1842                         .end = index(.checkVars$, "+")
1843                         if .end
1844                                 .variable$ = left$(.checkVars$, .end - 1)
1845                                 if not variableExists(.variable$)
1846                                         .tempText$ = replace$(.tempText$, """+'.variable$'+""", "'"+.variable$+"'", 0)
1847                                 endif
1848                                 .checkVars$ = right$(.checkVars$, length(.checkVars$) - .end)
1849                         else
1850                                 .checkVars$ = ""
1851                         endif
1852                 endwhile
1853                 .text$ = '.tempText$'
1854         endif
1855 endproc
1856
1857 # Get a time stamp in normalized format
1858 procedure getTimeStamp
1859         .currentDateTime$ = date$()
1860         .string$ = replace_regex$(.currentDateTime$, "[A-Z][a-z]+\s+([A-Z][a-z]+)\s+(\d+)\s+(\d+)\W(\d+)\W(\d+)\s+(\d+)$", "\6-\1-\2T\3-\4-\5", 0)
1861 endproc
1862
1863 # A table error, can be insiduously caused by an outdate preferences file!
1864 procedure emergency_table_exit .message$
1865         # If you come here as a user, your preferences file is borked
1866         if preferencesAppFile$ <> "" and fileReadable(preferencesAppFile$)
1867                 deleteFile(preferencesAppFile$)
1868         endif
1869         exit '.message$'
1870 endproc
1871
1872 # Remove previous files from system
1873 procedure clean_up_sound
1874         if recordedSound$ = ""
1875                 sgc.recordedSound = 0
1876         endif
1877     if sgc.recordedSound > 0
1878         select sgc.recordedSound
1879         Remove
1880         recordedSound$ = ""
1881         sgc.recordedSound = 0
1882     endif
1883     if te.recordedPitch > 0
1884         select te.recordedPitch
1885         Remove
1886                 te.recordedPitch = 0
1887     endif
1888         if sgc.alignedTextGrid > 0
1889                 select sgc.alignedTextGrid
1890                 Remove
1891                 sgc.alignedTextGrid = -1
1892         endif
1893 endproc
1894
1895 # Safely read a table
1896 procedure readTable .filename$
1897         .tableID = -1
1898         if .filename$ <> "" and fileReadable(.filename$) and index_regex(.filename$, "(?i\.(tsv|table|csv))$") > 0
1899                 .tableID = nocheck Read from file... '.filename$'
1900                 if .tableID = undefined or .tableID <= 0
1901                         .tableID = -1
1902                 else
1903                         .fullName$ = selected$ ()
1904                         .type$ = extractWord$(.fullName$, "")
1905                         if .type$ <> "Table"
1906                                 Remove
1907                                 .tableID = -1
1908                         endif
1909                 endif
1910         endif
1911 endproc
1912
1913 # Read feedback table and get keyed text
1914 procedure get_feedback_text .language$ .key$
1915         if not endsWith(feedbackTableName$, "_'.language$'")
1916                 if feedbackTableName$ <> ""
1917                         select Table 'feedbackTableName$'
1918                         Remove
1919                 endif
1920                 call loadTable 'feedbackTablePrefix$'_'.language$'
1921                 feedbackTableName$ = selected$("Table")
1922         endif
1923         call findKey 'feedbackTableName$' '.key$'
1924         .row = findKey.row
1925         select Table 'feedbackTableName$'
1926         .text$ = Get value... '.row' Text
1927         # Expand variables, eg, 'praatVersion$'
1928         call expand_praat_variables '.text$'
1929         .text$ = expand_praat_variables.text$
1930 endproc
1931