The SpeechMark Command Line Utility, Mac Edition

———————————————————————————
SpeechMark Product: The SpeechMark Command Line Utility, Mac Edition
Operating Systems Supported: Mac OSX (Lion or Mountain Lion versions)
Product Version: 0.1.4
Public Release Date : April 7, 2013
———————————————————————————

Installation Notes — PLEASE READ
===============================

    1. During operation, this SpeechMark product calls the MATLAB Compiler Runtime (MCR) product, a software module developed and released by The Mathworks. The installation process for this SpeechMark product searches the user’s file system. If it does NOT find an invocable copy of the MCR, it automatically downloads an MCR install image from the SpeechMark web site, and attempts to install it. Following MCR installation, the SpeechMark installation process guides the user to exit the install process, and begin the installation of this SpeechMark product a second time. Once the MCR has been successfully installed, the SpeechMark installation process should run to completion.
    2. We are currently requiring that Mac end users install the MCR in the default location, i.e. /Applications/Matlab/Matlab_Compiler_Runtime/v717/. Since Macs don’t have an analog of the Windows Path that is both readily accessible and reliable for installed software, we’re using this workaround until we come up with a more sophisticated solution. A better solution might be as simple as prompting the user for the MCR folder as part of the SpeechMark installation process.

 

———————————————————————————
Bug Fixes:

    1. Help option “-?” changed to “-h”
    2. Examples directory, e.g. “/Users/[user]/Documents/SpeechMark_Example_Files” given write permission.
    3. MATLAB path bug fixed for BUILD script.

———————————————————————————
Enhancements:
(None for this release)

———————————————————————————
Known Bugs:

  1. The input waveform checksum that is supposed to be calculated and output in the landmark file header is not in fact calculated or output.

 

The SpeechMark Command Line Utility, Windows Edition

———————————————————————————
SpeechMark Product: The SpeechMark Command Line Utility, Windows Edition
Operating Systems Supported: Windows XP, Windows 7
Product Version: 0.1.7
Public Release Date : April 7, 2013
———————————————————————————

Installation Notes — PLEASE READ
===============================

    1. During operation, this SpeechMark product calls the MATLAB Compiler Runtime (MCR) product, a software module developed and released by The Mathworks. The installation process for this SpeechMark product searches the user’s file system. If it does NOT find an invocable copy of the MCR, it automatically downloads an MCR install image from the SpeechMark web site, and attempts to install it. Following MCR installation, the SpeechMark installation process guides the user to exit the install process, and begin the installation of this SpeechMark product a second time. Once the MCR has been successfully installed, the SpeechMark installation process should run to completion.
    1. Both the SpeechMark and MCR installation processes MUST be run with administrative privileges. If the user’s account does not have administrative privileges active, The installation process must be invoked with administrative privileges. To do this, hold down the SHIFT key, and click on the installation icon or file name. Then select “Run as…” from the context menu that appears. Then enter the name and password of a user who has administrative privileges.

 

———————————————————————————
Bug Fixes:

    1. Workaround for MCR installation.
    1. Resolve administrator privileges issues.

 

———————————————————————————
Enhancements:
(None for this release)

———————————————————————————
Known Bugs:

    1. The input waveform checksum that is supposed to be calculated and output in the landmark file header is not in fact calculated or output.

 

  1. When the user includes the “/g” option on the command line, there MUST be a space between the “/g” and the speaker type character (e.g., “M”). If no space is included, the option is silently ignored.

The SpeechMark R Package, Windows Edition

———————————————————————————
SpeechMark Product: The SpeechMark R Package, Windows Edition
Operating Systems Supported: Windows XP, Windows 7
Product Version: 0.1.5
Public Release Date : February 7, 2014
———————————————————————————
Installation Notes–PLEASE READ
===============================

  1. Verify that the MATLAB Compiler Runtime (“MCR”) 32 bit version 2013b (v82) has been installed on your computer. If it hasn’t, install this software first! The MCR install image can be downloaded from:http://www.mathworks.com/products/compiler/mcr/ See IMPORTANT MCR INSTALATION NOTES below.
  2. Verify that the 32 bit version of R has been installed on your computer (the latest version is R i386 3.0.2). The R install image can be downloaded from: http://www.r-project.org/
  3. Download the SpeechMark R Package install image from the SpeechMark web site. The install image is a zip file that contains installation instructions (basically, the text you are now reading) and another zip file named “SpeechMark.zip”. Extract these files from the download image.
  4. Install the SpeechMark R Package in your R environment by launching the R GUI, and clicking on the “Packages” menu on the menu bar. Select the “Install package from local zip file…” menu option. A “Select files” window will appear. Use it to find and select the SpeechMark.zip file that you extracted in the previous step.
  5. Load the SpeechMark R Package by clicking on the “Packages” menu again on the R Menu bar. This time select the “Load package …” menu option, and select the “SpeechMark” package from the list of installed packages that appears.
  6. You can view the SpeechMark Package documentation by typing the command “help(package=’SpeechMark’)” at the command line prompt in the R Console Window.

IMPORTANT MCR INSTALLATION NOTES
================================
Many of our users install the MATLAB Compiler Runtime without encountering any problems. Others are not so fortunate. These notes are intended to shed some light on potential MCR Installation issues and problems. Ideally you’ll read and comprehend these notes before attempting the MCR installation the first time. But at the very least, please read them over if you experience any problems.
For many users of the SpeechMark R Package who do run into trouble, their first hint that something has gone wrong is an error message when they attempt to LOAD the SpeechMark R Package. This is because a working MCR is not needed in order to install R or install the SpeechMark R Package, but it is needed in order to load that package. If Step 5 above fails, you need to read these instructions. Usually, when Step 5 fails, R displays an error box with a message like this:

    “This application has failed to start because mclmcrrt8_2.dll was not found. Re-installing the application may fix this problem.”

If you see this message, help is on the way. Keep reading!

  1. The SpeechMark R Package uses compiled MATLAB code. So may other applications you have installed. A number of different versions of the MCR are available from the MATLAB web site. In order to run this code, you need to install on your computer the *particular* version of the MCR required by the code. In order to run this package, you must download and install the MCR version that this package needs, even if you have installed other versions of the MCR required by other applications. You can have multiple versions of the MCR installed and in use on your computer simultaneously.
  2. The SpeechMark R Package requires the MATLAB Compiler Runtime (“MCR”) 32 bit version 2013b (v82). Other versions of the MCR will not work. Follow the link provided in Step 1 above, and be careful to choose, download, and install the correct version.
  3. It is not sufficient to install the correct version of the MCR–your PATH environment variable must also be updated to include the directory in which the MCR DLL is located. Some users find that the MCR installation process updates their PATH variable automatically. Other users find that they must update their PATH variable by hand.
  4. The directory (folder) that must appear in your PATH is the folder in which the MCR DLL file “mclmcrrt8_2.dll” resides. This should be a subfolder under the folder that you installed the MCR in, and by default ends with “…\v82\runtime\win32”. If necessary, you can find this folder by using the Windows Explorer Search function. Search for the file “mclmcrrt8_2.dll”.
  5. The filespec of this folder must be added to the PATH environment variable, either by the MCR install process or by you, manually. To check to see if this folder has been added to PATH by the MCR install process, open a Windows Command Window, and type “Path” and press Enter. The current PATH environment variable will be printed out.
  6. If the MCR DLL folder has not been added to the path, you must add it manually. Press the Start button, select the Control Panel, click on the System icon, select the Advanced tab, click on the Environment Variables button, and edit the System Variable named “path”.
  7. If you do not have the full MATLAB application installed (that is, if you are not a MATLAB user), append the MCR DLL directory to the end of your PATH string, separated by a “;” character from the previous folders. If you do have the MATLAB application installed, you must insert the MCR DLL before any of the MATLAB application directories that appear in the PATH string. Separate the MCR DLL from the other folders with “;” characters.
  8. For the revised PATH string to be visible to R, a new R GUI must be launched *after* the PATH variable has been updated and saved.

Please read the MCR Installer Documentation, available from the MATLAB web site by going to the URL shown in Step 1, and looking for the “MCCR Installer Documentation” link.

———————————————————————————
Bug Fixes:
None

———————————————————————————
Enhancements:
Renamed the package from “starlm” to “SpeechMark”

———————————————————————————
Known Bugs:
None

The SpeechMark WaveSurfer Plug-In, Mac Edition

———————————————————————————
SpeechMark Product: The SpeechMark WaveSurfer Plug-In, Mac Edition
Product Version: 0.1.23
Public Release Date : January 14, 2013
———————————————————————————

Installation Notes — PLEASE READ
===============================

    1. During operation, this SpeechMark product calls the MATLAB Compiler Runtime (MCR) product, a software module developed and released by The Mathworks. The installation process for this SpeechMark product searches the user’s file system. If it does NOT find an invocable copy of the MCR, it automatically downloads an MCR install image from the SpeechMark web site, and attempts to install it. Following MCR installation, the SpeechMark installation process guides the user to exit the install process, and begin the installation of this SpeechMark product a second time. Once the MCR has been successfully installed, the SpeechMark installation process should run to completion.

 

    1. We are currently requiring that Mac end users install the MCR in the default location, i.e. /Applications/Matlab/Matlab_Compiler_Runtime/v84/. Since Macs don’t have an analog of the Windows Path that is both readily accessible and reliable for installed software, we’re using this workaround until we come up with a more sophisticated solution. A better solution might be as simple as prompting the user for the MCR folder as part of the SpeechMark installation process.

 

———————————————————————————
Bug Fixes:

    1. We eliminated the excessive plotting time previously required for “Band Energies” plot.

 

———————————————————————————
Enhancements:

    1. We now display MATLAB and MATLAB conversion layer errors in the command window.
    2. We now provide helpful feedback when an attempt is made to find acoustic landmarks in multi-channel signals. (The SpeechMark WaveSurfer Plugin only handles single channel data.)
    3. We now provide helpful feedback when an attempt is made to find acoustic landmarks in a signal larger that 10MB (~5 minutes at 16 bit, 16kHz sampling rate). (This is the upper limit on the size of signal files that The SpeechMark WaveSurfer Plugin can handle.)
    4. The User can customize the display of landmark “flags” via the “Landmark Configuration” popup window.
    5. Custom landmark “flag” display settings can be saved and applied via configuration files, e.g. “Save Configuration” and “Apply Configuration”.
    6. Frequency band information is now displayed as labels on the Band Energy plots.
    7. Landmark “flags” automatically resize when the landmark pane is resized.

 

———————————————————————————
Known Bugs:

  1. During installation, if the MCR has just been downloaded and installed, system path to MCR may not be updated, and installer will abort (cleanly). WORKAROUND: Rerun installer.
  2. Configuration files should not be saved while Band Energy panes are open. Configurations saved with Band Energy panes open will produce blank panes upon application.

———————————————————————————

The SpeechMark WaveSurfer Plug-In, Windows Edition

———————————————————————————
SpeechMark Product: The SpeechMark WaveSurfer Plug-In, Windows Edition
Operating Systems Supported: Windows 7
Product Version: 0.1.36
Public Release Date : October 17, 2014
———————————————————————————

Installation Notes — PLEASE READ
===============================

    1. During operation, this SpeechMark product calls the MATLAB Compiler Runtime (MCR) product, a software module developed and released by The Mathworks. The installation process for this SpeechMark product searches the user’s file system. If it does NOT find an invocable copy of the MCR, it automatically downloads an MCR install image from the SpeechMark web site, and attempts to install it. Following MCR installation, the SpeechMark installation process guides the user to exit the install process, and begin the installation of this SpeechMark product a second time. Once the MCR has been successfully installed, the SpeechMark installation process should run to completion.

 

    1. Both the SpeechMark and MCR installation processes MUST be run with administrative privileges. If the user’s account does not normally have administrative privileges, it must temporarily be given administrative privileges to install the SpeechMark Plug-In.

IMPORTANT NOTE:

      Because of the way WaveSurfer is configured, the SpeechMark WaveSurfer Plug-In *MUST be installed by the user who will be using the Plug-In*. Therefore, that user *MUST* have, or be given, administrative privileges during the SpeechMark WaveSurfer Plug-In process (if only temporarily). It is *not* necessary for this user to have administrative privileges in order to run the Plug-In once it is installed.

 

      This requirement CAN NOT BE SATISFIED by running the installer “as an adminstrator” or by running the installer an another user–that will only install the Plug-in for the administrator’s use, or the use of the other user. Rather, the user who will want to use the Plug-in *must* be given administrative privileges long enough to run the install program.

 

      If it is impossible for the prospective user to acquire administrative privleges even temporarily in order to install this software, please contact SpeechMark customer support for more information.

 

———————————————————————————
Bug Fixes:

  1. Plotting the Band Energies pane took an excessive amount of time (often several minutes)..
    Resolution: Band Energies pane now plots quickly (a few seconds or less).
  2. Problem: Landmarks are not detected in multi-channel (e.g. stereo) audio files, but rather than generating an error message, the SpeechMark Plug-In appears to be opperating normally, but detects no landmarks.
    Resolution: An error message is displayed when an attempt is made to open a landmark pane for a multi-channel audio file.
  3. Problem: Many errors that occurred in the MATLAB and MATLAB conversion layer of the Plug-In were discarded without a trace.
    Resolution: MATLAB and MATLAB conversion layer errors are not displayed in the WaveSurfer console window.
  4. Problem: Landmark detection silently failed for “long” audio files (longer than ~5 minutes @ 16kHz sampling rate).
    Resolution: An error message is displayed when an attempt is made to open a landmark pane for a audio file larger than 10 MBytes.

———————————————————————————
Enhancements:

  1. Users can now customize the visual appearance of landmarks, including landmark label font size and color, and the direction, color, length, width, and line type of the landmark “flagpoles”.
  2. Landmark “flags” are now automatically adjusted when the height of a landmark pane changes.
  3. Frequency band information is now displayed in the Band Energy pane.

———————————————————————————
Known Bugs:

  1. During installation, if the MCR has just been downloaded and installed, system path to MCR may not be updated, and installer will abort (cleanly).
    WORKAROUND: Rerun installer.
  2. Conflicts occur when 64-bit Matlab 2010b and the Matlab Compiler are installed before the 32-bit MCR 7.14.
  3. If WaveSurfer configuration files are created or updated while a Band Energy pane is open, when that configuration is loaded, and EMPTY Band Energy pane will be displayed.
    WORKAROUND:

    1. Delete any open Band Energy panes before creating a new WaveSurfer configuration file or updating an existing one
    2. Delete any empty Band Energy pane that is created when a configuration file is loaded.

———————————————————————————
Known Limitations:

  1. WaveSurfer version 1.8.5 is no longer supported. Since this version has never been publicly available from SourceForge, this should not be a problem for most users. The only version of WaveSurfer currently support is version 1.8.8
  2. As of the end of March, 2014, Windows XP will no longer be officially supported. However, it is quite possible that this product will continue to work on Windows XP for some time.
  3. Windows 10 (for now, the “Technical Preview” edition) is not officially supported, but preliminary testing indicates that WaveSurfer and the SpeechMark Plug-In works properly under this new version of Windows.

———————————————————————————

The SpeechMark MATLAB Toolbox, Cross-Platform Edition

———————————————————————————
SpeechMark Product: The SpeechMark MATLAB Toolbox, Cross-Platform Edition
Operating Systems Supported: Windows XP, Windows 7, OS X Version 10.7 (“Lion”), OS X Version 10.8 (“Mountain Lion”)
Product Version: 0.1.8
Public Release Date : February 28, 2014
———————————————————————————
Installation Notes–PLEASE READ
===============================

  1. This product is a standard MATLAB toolbox. To use it, a valid instance of MATLAB (version R2010b or newer) must be installed, as well as a valid version of the MATLAB Signal Processing Toolbox.

———————————————————————————
Bug Fixes:
N/A
———————————————————————————
Enhancements:

  1. Periodic voicing landmarks (+/-p) added.
  2. Function returning SpeechMark Core version and date added.
  3. MATLAB inbuilt ‘ver’ command compatible Contents.m file added.

———————————————————————————
Known Bugs:
None