Donate Share

SoundRuler

File Release Notes and Changelog

Release Name: 0.9.4.1

Notes:
==================  SOUND RULER ======================

     Contents:

    1- Sound Ruler release types.

    2- System requirements

    3- Installation / Uninstallation - Windows stand alone

    4- Installation / Uninstallation - Linux stand alone (.rpm or tar.gz)

    5- Installation / Uninstallation - M-file scripts

    6- Installation troubleshooting

---------------------------------------------------------------------------

    1- Sound Ruler release types:

	There are currently 4 resease types available:

	soundruler-x.x.x.windows.zip - Windows stand alone
		You do not need Matlab to run it.

	soundruler-x.x.x.windows.scripts.zip - Windows M-files script 
		Requires Matlab 6.x to run.
                It contains the Windows source files (m-files).

	soundruler-x.x.x.linux.rpm (for RedHat 9.0) - Linux stand alone 
        soundruler-x.x.x.linux.tar.gz - Linux generic install source.
		You do not need Matlab to run it.

	soundruler-x.x.x.linux.scripts.tar.gz - Linux M-files script 
		Requires Matlab 6.x to run.
                It contains the Linux source files (m-files).

---------------------------------------------------------------------------

     2- System requirements:

     Sound Ruler itself does not demand many resources, but sound
analysis is very processor intensive. The more extensive and detailed 
your analyses are, the more you will benefit from a fast computer.

     Although Sound Ruler runs well in a Pentium 2 at 233 MHz, even an 
upgrade from a Pentium 4 at 1.7 GHz to a Pentium 4 at 2.4 GHz can 
produce pronounced reduction in analysis time.

     Stand alone MSWindows version:

          Pentium 100 (486 not tested yet) 
          32 MB of RAM memory 
          50 MB of free hard disk space 
          Windows 95 or newer

     Stand alone Linux version:

          100 MHz processor 
          32 MB of RAM memory 
          50 MB of free hard disk space 
          X windows

     M-files script versions:
          Matlab version 6.x 
          5 MB of free hard disk space 

---------------------------------------------------------------------------

     3- Installation / Uninstallation - Windows stand alone

     Installation:

	1- Unzip the soundruler_windows_0.9xx.zip file to a temporary 
folder (you will need a decompression program installed such as Winzip).
        2- Run setup.exe (or setup) and follow the instructions on the 
screen.

     Uninstallation:

	1- Go to Start-Settings-Control Panel-Add/Remove Programs.
        2- Select SoundRuler from the list of programs.
	3- If you saved files into the SoundRuler folder, this folder will
not be deleted during the uninstall process.
	4- A call to SoundRuler's folder might have been left in your 
autoexec.bat file.

---------------------------------------------------------------------------

     4- Installation / Uninstallation - Linux stand alone

   For soundruler-x.x.x.linux.rpm

     Installation: 
        1- su
        2- cd folder_where_soundruler-x.x.x.linux.rpm_is
        3- rpm -Uvh soundruler-x.x.x.linux.rpm

     Uninstallation:
        1- su
        2- rpm -e soundruler

   For soundruler-x.x.x.linux.tar.gz

     Installation: 
        1- su
        2- tar -xvzf /path_where_it_is/soundruler-x.x.x.linux.tar.gz.
        3- cd soundruler-x.x.x.
        4- vi Makefile (to check if the paths in the file are ok for your 
system)
        5- make install
        6- type soundruler or sruler to run it as any user

     Uninstallation:
	1- Delete SoundRuler's folder (/usr/share/soundruler).
        2- Delete soundruler and sruler from /usr/bin.
	3- Delete /usr/share/man/man1/soundruler.1.gz.
	4- Delete /usr/share/man/pt_BR/man1/soundruler-pt_BR.1.gz.
	5- Delete the line export 
LD_LIBRARY_PATH=/matlablibspath/bin/glnx86 from the
            /home/yourusername/.bash_profile or /etc/profile file.

   NOTE: The spec file the the generation of RPMs is in 
soundruler-x.x.x.linux.tar.gz.

---------------------------------------------------------------------------
 
    5- Installation / Uninstallation - M-files script 

     Installation:

                       AUTOMATIC SETUP (Windows only)

	1- unzip the SoundRuler files into a folder
	2- open Matlab
	3- enter cd foldername, where foldername is the folder where you
		put the SoundRuler files 
           ex:  cd 'c:\program files\soundruler'
	4- enter Setupsruler

	When done, enter sruler at Matlab's prompt to run SoundRuler

                       MANUAL SETUP

	1- unzip the SoundRuler files into a folder
	2- open Matlab
	3- add the folder where you put the SoundRuler files and it's 
		\help folder to Matlab's path or cd into it
	4- run soundruler.m

                       What does the auto setup do?

	This is a clean installation.
	All it does is to place a sruler.m file in your matlab/work
folder. The /work folder is in Matlabs path by default.
	Every time you type sruler, it adds the SoundRuler folder to
Matlabs path and runs soundruler.

     Uninstallation:
	1- Back up the files that you might have saved into the folder where
you SoundRuler is installed.
	2- Delete SoundRuler's folder.

----------------------------------------------------------------------------

    6- Installation troubleshooting



     3.1- Can Sound Ruler coexist with Matlab installations?

     If the Matlab version is the same as the libraries that ship with 
SoundRuler, you do not need to install the libraries. If they are not the 
same version, you just have to make sure that the call to SoundRuler's 
folder in your path appears before the call to Matlab's folder and both 
should work fine.


     3.2- "The ordinal #### could not be located in the dynamic-link library 
dforrt.dll".

     This is a problem with the installation of Matlab's libraries. Here is the 
solution from the Mathworks: locate dforrt.dll or deformd.dll in your 
Windows system directory and replace them with the corresponding files 
in the <soundruler>\bin\win32 directory, where <soundruler> is the name 
of your SoundRuler installation directory.


     3.3- "Sorry, the configuration of the path failed". or
          "A required .dll file, libmmfile.dll, was not found".
      
     For some reason the installer failed to setup the path. All we need
to do is to inform Windows where the mathematical libraries are.

     In Windows98 or Windows95:
     Find the file c:\autoexec.bat. If it does not exist, create it. Edit
or add the line that starts with "SET PATH=" and include the call 
C:\MyFolder\soundruler\bin\win32; replacing C and MyFolder with the 
drive and folder where you installed SoundRuler. (see bottom - FOR ALL).

     In Windows2000/NT:
     Go to Start - Settings - Control_Panel - System. A window will open
with several tabs on top. Choose Advanced and at the bottom, click on
"Environmental Variables". A screen will open with two boxes. The lower
one, "System variables" , has an item called "Path".
     All that needs to be done is to click on "Path" and click the Edit
button to add the path to the mathematical libraries. However, the Edit
button might not be available, if your username does not have
administrative power. If that is the case, log off Windows and log back
on as Administrator.
     When you click the Edit button, a little window will open with two
fieds. The lower one "Variable value" is where you want to add
  c:\program files\soundruler\bin\win32;
     You might have to change "c:\program files\soundruler" to point
to the folder where you installed SoundRuler if you did not use the
default.

     FOR ALL: if you have Matlab installed, place the new call into your 
path BEFORE the call for Matlab's folder. This should not affect Matlab.
     Now reboot the computer and SoundRuler should work fine.
     In case it doesn't, there might be a typo in the path. You can
easily check on in by opening a DOS prompt (Start-Run and enter
"command" or "cmd") and entering "path". It will display something like:
    PATH=C:\Windows\system32;c:\program files\soundruler\bin\win32;

----------------------------------------------------------------------------
2004-03-24



Changes: -------------------------------------------------------------------------------------------- version 0.941 - 2004-08-06 Added templates for exporting graphs. Improved the Cross Correlation module: - ability to play and plot sounds - load calls from file - load whole folder with files for CCA - define extra sound or not around the call - fixed bugs in CCA of oscillograms and filtering Added control over playback rate, so that fast and high frequency sounds can be heard at slower tempo and lower frequency. Changed the method of compilation of the executable, turning it simpler, smaller and faster. Improved the precision of the measurements of energy in the harmonics. Minor bug fixes. -------------------------------------------------------------------------------------------- version 0.940 - 2004-03-16 Added documentation in Portuguese. Added extensive graph editing and template creation for batch graphing. Redesigned GUI and icon for Linux. Makefile and RPM packaging for Linux. Simplified and more powerful manual addition or deletion of automatically recognized pulses. Added the ability of recognizing pulses under reduced and variable amplitude modulation. Added the possibility of restricting dominant frequency tracking to a single harmonic when the dominant harmonic varies along the call. Minor bug fixes. -------------------------------------------------------------------------------------------- version 0.936 - 2003-06-10 Spectrogram figure exports: fixed problem of incorrect labels on the Y axis. Amplitude calibration: fixed problem and implemented RMS and Peak calibration. Minor bug fixes. -------------------------------------------------------------------------------------------- version 0.935 - 2003-04-09 Fixed problem with stereo files, that caused error in cross correlation analyses. Improved the user interface for cross correlation. Calculation effort is displayed before the analysis starts. It is monitored on the status bar during the analysis and the calculation time is reported in the result file. Minor bug fixes. -------------------------------------------------------------------------------------------- version 0.934 - 2003-04-06 Improved the tuning curve filter with bug fixes and more didactic filter and help files. Minor bug fixes. -------------------------------------------------------------------------------------------- version 0.933 - 2003-04-01 Separated unix from windows scripts, mostly to make figures display correctly. Improved the cross correlation algorithm and implemented 2D spectrogram CCA. Minor bug fixes. -------------------------------------------------------------------------------------------- version 0.932 - 2003-03-28 First release of the Unix binaries. Fixed the resource leak in the Windows binaries. Fixed a path problem in the Windows binaries. Minor bug fixes. -------------------------------------------------------------------------------------------- version 0.931 - 2003-03-25 First release at SourceForge. Matlab m-files and Windows binaries. Extensive changes for adjustment to the restrictions of the matlab compiler. Incorporated the Tuning Curve filters and Amplitude Calibration as tools in SoundRuler. Added the Textpad, SoundMath and CCA. -------------------------------------------------------------------------------------------- version 0.930 and back... M-file versions for internal use.