Skip to content

Latest commit

 

History

History

README.md

Offline Audio Processor

This project is the step 1 of the main project Real-time audio processing. Please refer to the README of main project for more information.


Author

Thomas Hézard - Audio scientist and developer
www.thomashezard.com
thomas.hezard [at] thz.fr


License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Licence Creative Commons


🎯 Objectives

This directory contains a self-sufficient Python script audio_processor.py, and a notebook version of the same script audio_processor.ipynb. The present version of the code does nothing but copying audio data from an input audio file into an output audio file.

Your goal is to implement modify this script to replace the data copy with the audio processing algorithm you chose. All you have to do is to replace line 42 with your code.


⚙️ How to run

Run on Google Colab (recommended)

The notebook can be run on Google Colab: Run on Google Colab.

Run on Github Codespace

This project can be run in a pre-configured environment on Github Codespace:

  1. Fork this repository to your own Github account,
  2. On your fork's page, click the green Code button → Codespaces tab → Create codespace.

Once in the Codespace, open a terminal and follow the instructions below to run the Python script.

Run the script

This project has been written for Python >= 3.7, necessary packages are detailed in requirements.txt. After having installed and setup Python, you can install all necessary packages and run the script with uv:

uv run audio_processor.py

or install the packages manually with pip:

pip install -r requirements.txt

or conda:

conda install --file requirements.txt

Once your environment is ready, you can execute the Python script with the command

python audio_processor.py

Alternatively, you can open this directory in your favourite Python IDE and work from there.