SoundTrAD

A desktop application built using PyQt5 aimed to aid novice designers in building auditory displays. This is an open source project that encourages designers/developers to download and further contribute to the development of the application to help the wider community by contributing the ongoing development in research on auditory displays, which has been influenced by the people at the International Community for Auditory Displays.

The tools have been developed using Doon MacDonald's research: https://smartech.gatech.edu/handle/1853/60074
With the aid of Tony Stockman my supervisor and discussions with Doon, the application that I have developed in this short period of time have achieved the core goals I set at the start of this journey.

Note: A video demonstration can be watched following the website linked to this repo.

Files Submitted

• Source code folder: containing all the python files I wrote for the application.
• Mac and Windows folder: Contains the executable files for the respective OS systems. Below explains programs needed to run it and where to find the application itself in the folders. Windows executable made using pyinstaller and Mac executable made using py2app.
• Test notes folder: contains pdf files of the various testing done for the application. Majority of it are raw notes that have just been edited to add a better layout for easier viewing.
• Images folder: screenshots of my application and wireframes.
• test.cv: a test file that could be used for the application as an example as reference.
• text-mac.csv: a test file for mac OS.

Programs needed to run application

Python

Python Version 3.5 - it should work with any Python 3 version or later
Note: Make sure that it is in PATH
https://www.python.org/downloads/release/python-350/

MySQL

• MySQL Connector Python 8.0 for Python 3.5 = Simplifies installation by installing everything at once: https://dev.mysql.com/downloads/connector/python/
• MySQL Server 8.0: https://dev.mysql.com/downloads/mysql/
• MySQL Workbench 8.0 CE = used to view database and simplify user setup You will need to create a new user with all access granted this can be done in the workbench by going to Server > Users and Privileges > Add account. Once you have filled in the login detail, go to the Administrative Roles tab and check DBA to check all at once and then click apply to save: https://dev.mysql.com/downloads/workbench/

For Windows OS the application can be located in the folder:
Windows > dist > soundtrad
It is named soundtrad and should have a logo. Ensure you have sound files located locally, I have created a sound folder located in the same folder as the application, for where you can keep your sound files in.

For Mac OS the application can be located in the folder:
Mac > dist
It is named soundtrad. Ensure you have sound files located locally, I have created a sound folder located in the same folder as the application, for where you can keep your sound files in. Images folder just contains logo's for the application.

Libraries

The application has been made into an executable file, however I have listed the libraries you may need to pip/pip3 install or if you want to run it via the source code folder in terminal instead:

• PyQt5 Version 3.5
  pip install PyQt5
• PyDub
  pip install pydub
• Matplotlib
  pip install matplotlib
• MySQLdb
  pip install mysqlclient

If you are on MAC Install this globally:
brew install mysql

I use Qt creator to view the code, but it is obviously optional. Here is the link to download the opensource version:
https://www.qt.io/download

PyQt5 Errors

Downloading PyQt5 has been a bit buggy to download via terminal lately for on windows OS with the recent updates that have rolled out. So, if the above does not work try downloading the exe file from sourceforge: https://sourceforge.net/projects/pyqt/files/PyQt5/ \

Alternatively you could install using brew:
brew install pyqt5

MySQLdb Errors

The MySQLdb download may not work above as I am using a windows OS and had to find a different method, so possibly try these alternatives instead:

conda install mysqlclient

brew install mysql-connector-c  (will need to pip install homebrew first)

pip install mysql-python

When trying to install MySQLdb on my mac I had problems due to setup tools being out of date so make sure you run this line to check:
pip install --upgrade setuptools

You may get an error like this on a mac:

ImportError: dlopen(/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/MySQLdb/_mysql.cpython-37m-darwin.so, 2): Library not loaded: libssl.1.0.0.dylib
  Referenced from: /Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/MySQLdb/_mysql.cpython-37m-darwin.so
  Reason: image not found

This may mean you may not be able to use the executable. However if running via source code folder type export DYLD_LIBRARY_PATH=/usr/local/mysql/lib/ in your terminal and see if problem persists. You can add it to your .profile file to make this persistent so you don’t need to run it every time. After type python3 soundtrad.py to run like normal.

Instructions on using application

1. First login to the MySQL account you have created (or any account you are happy to store location of sound files)
2. Fill in the cue sheet (the table). At least the time and sound file column in the format:

• Time in 12hr format e.g. 1:02pm
• Sound file path stored in the cell (Not the soud file name!)
  The sound file can be chosen by clicking on the button saying "Upload Sound", which is next to the respective sound file cell for each row. The Cause and Associated Events determine the sound files suggested to the user. Extra: If you want to test each sound, you click on the sound file cell once for the sound you want to test and it will be loaded in the audio player on the seperate window.

3. Click generate timeline and your cuesheet will be transferred to the timeline, where you can listen to the combined sound created from the cuesheet.
   Note: You may need to use the pan button (4th button in the toolbar at the top) on a mac and interact with the timeline space by clicking/dragging it to generate the timeline
4. Save the cuesheet by clicking on the save cuesheet button or save under the file tab in the toolbar

Sound Files

The repository has sound files included in the folder "sound":
SounTrAD > dist > soundtrad > sound
All the sound files are either from FreeSound, which are all free to download and use or Ikson:
https://www.iksonmusic.com/

Summary

This has been a very interesting project to work on which combines my programming skills, with my new interest in interaction/ux design. It has made me discover a new world of interacting with technology. The project will now be passed back to Doon to look further into developing this research into something more concrete, so hopefully this has helped aid her in the next steps.