Skip to content

Latest commit

 

History

History
52 lines (29 loc) · 3.15 KB

sms-tools README.md

File metadata and controls

52 lines (29 loc) · 3.15 KB

sms-tools

Sound analysis/synthesis tools for music applications written in python (with a bit of C) plus complementary teaching materials.

How to use

In order to use these tools you have to install python 3.* (recommended 3.10) and the following modules: ipython, numpy, matplotlib, scipy, and cython.

In Ubuntu you can install these modules by typing in the Terminal:

$ sudo apt-get install python-dev ipython python-numpy python-matplotlib python-scipy cython

In OSX you can install these modules by typing in the Terminal:

$ pip install ipython numpy matplotlib scipy cython

then, to use the tools, after downloading the whole package, you need to compile some C functions. For that you should go to the directory software/models/utilFunctions_C and type:

$ python compileModule.py build_ext --inplace

The basic sound analysis/synthesis functions, or models, are in the directory software/models and there is a graphical interface and individual example functions in software/models_interface. To execute the models GUI you have to go to the directory software/models_interface and type:

$ python models_GUI.py

To execute the transformations GUI that calls various sound transformation functions go to the directory software/transformations_interface and type:

$ python transformations_GUI.py

To modify the existing code, or to create your own using some of the functions, we recommend to use the workspace directory. Typically you would copy a file from software/models_interface or from software/transformations_interface to that directory, modify the code, and execute it from there (you will have to change some of the paths inside the files).

Jupyter Notebooks

A number of teaching exercises are available as jupyter notebooks in the notebook directory. To do them you need to install Jupyter Notebook according to its instructions https://jupyter.org/install

Start up jupyter notebook by typing in the Terminal.

$ jupyter notebook

It will open a web browser, from which you can open the notebook directory.

Content

All the code is in the software directory, with subdirectories for the models, the transformations, and the interfaces. The lecture materials are in the lectures directory, the exercises related to the lectures are in the notebook directory, and the sounds used for the examples and coming from http://freesound.org are in the sounds directory.

License

All the software is distributed with the Affero GPL license (http://www.gnu.org/licenses/agpl-3.0.en.html), the lecture slides are distributed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 (CC BY-NC-SA 4.0) license (http://creativecommons.org/licenses/by-nc-sa/4.0/) and the sounds in this repository are released under Creative Commons Attribution 4.0 (CC BY 4.0) license (http://creativecommons.org/licenses/by/4.0/)