From 030eb4710ea39e38a8ddd56945a5bca19cfea3c9 Mon Sep 17 00:00:00 2001 From: Joel Mathew Thomas <90510078+joelmathewthomas@users.noreply.github.com> Date: Tue, 25 Feb 2025 01:42:39 +0530 Subject: [PATCH] Update README.md --- README.md | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9e71acf..9284d1c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,40 @@ # freq-split-enhance -An advanced **audio processing pipeline** designed to separate and enhance audio components using cutting-edge open-source tools. With **freq-split-enhance**, you can isolate vocals, instruments, background noise, and more from raw audio files with precision. +An evolving **audio processing pipeline** designed to separate and enhance audio components using open-source tools. The project aims to provide a modular framework for working with raw audio files, enabling separation, refinement, and post-processing. --- -## 🚀 Key Features +🚀 Current Features -- **Source Separation**: Leverages tools like Demucs, Spleeter, and nussl for powerful audio separation. -- **Noise Reduction**: Advanced filtering with noise reduction libraries like `noisereduce`. -- **Spectrogram Analysis**: Generate and refine audio using spectrogram-based techniques. -- **Fully Modular Pipeline**: Flexible structure to integrate and customize various audio processing tools. -- **Python-First**: Written in Python with easy-to-read modular code. +- **Audio Input Handling**: Uses librosa for reading and handling audio files. +- **Preprocessing**: Includes resampling, normalization, and trimming using librosa. +- **Audio Classification**: Utilizes Google's YAMNet model to classify audio content. +- **Source Separation**: Implements Demucs for music source separation. +- **Noise Reduction**: Enhances audio by removing background noise using DeepFilterNet. +- **Post-Processing**: Uses librosa to save processed audio files. +- **Modular Architecture**: Designed for easy extension and customization. --- +📁 Project Structure + +```bash +freq-split-enhance/ +├── api/ # API implementation (future work) +├── client/ # Client-side interactions (future work) +├── src/ # Core processing modules +│ ├── input/ # Audio input handling +│ ├── preprocessing/ # Normalization, resampling, trimming +│ ├── separation/ # Source separation with Demucs +│ ├── postprocessing/ # Post-processing and saving results +│ ├── refinement/ # Noise reduction and enhancement +│ ├── spectogram/ # Spectrogram generation and analysis +├── tests/ # Unit tests +├── requirements.txt # Dependencies +├── README.md # Project documentation +├── LICENSE # License information +└── pytest.ini # Pytest configuration +``` -## 📖 Documentation ### 📝 Wiki For detailed instructions on installing dependencies, setting up Python environments, and configuring the project, visit the [Wiki](https://github.com/joelmathewthomas/freq-split-enhance/wiki).