Files
freqsplit/README.md
T
Joel Mathew Thomas 404150c834 Update README.md
2025-02-25 03:45:13 +05:30

49 lines
2.3 KiB
Markdown

# freqsplit
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.
---
🚀 Current Features
- **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
freqsplit/
├── api/ # API implementation (future work)
├── client/ # Client-side interactions (future work)
├── LICENSE # License file
├── pyproject.toml # Project metadata and dependencies
├── pytest.ini # Pytest configuration
├── README.md # Project documentation
├── requirements.txt # Python dependencies
├── src/ # Core processing modules
│ ├── freqsplit/ # Main package directory
│ │ ├── __init__.py # Package initialization
│ │ ├── input/ # Audio input handling
│ │ ├── preprocessing/ # Normalization, resampling, trimming
│ │ ├── separation/ # Source separation with Demucs
│ │ ├── postprocessing/ # Post-processing and saving results
│ │ ├── refinement/ # Spectrogram-based enhancement
│ │ ├── spectogram/ # Spectrogram generation and analysis
├── tests/ # Unit and integration tests
└── venv/ # Virtual environment (should be excluded from version control)
```
### 📝 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).
## 🛡️ License
This project is licensed under the Apache License 2.0.