Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SuperKogito/pydiogment
:mega: Python library for audio augmentation
https://github.com/SuperKogito/pydiogment
audio audio-effects audio-processing augmentation deep-learning machine-learning python sound sound-processing
Last synced: 22 days ago
JSON representation
:mega: Python library for audio augmentation
- Host: GitHub
- URL: https://github.com/SuperKogito/pydiogment
- Owner: SuperKogito
- License: bsd-3-clause
- Created: 2019-12-09T10:34:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T21:48:22.000Z (over 1 year ago)
- Last Synced: 2024-10-02T17:37:12.877Z (2 months ago)
- Topics: audio, audio-effects, audio-processing, augmentation, deep-learning, machine-learning, python, sound, sound-processing
- Language: Python
- Homepage: https://superkogito.github.io/pydiogment/
- Size: 88.7 MB
- Stars: 83
- Watchers: 9
- Forks: 16
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- project-awesome - SuperKogito/pydiogment - :mega: Python library for audio augmentation (Python)
README
:bell: Pydiogment
==========
[](https://travis-ci.org/SuperKogito/pydiogment) [](https://ci.appveyor.com/project/SuperKogito/pydiogment) [](https://pydiogment.readthedocs.io/en/latest/?badge=latest) [%20-blue)](https://github.com/SuperKogito/pydiogment/blob/master/LICENSE) [](https://www.python.org/doc/versions/) [](https://codecov.io/gh/SuperKogito/pydiogment) [](https://coveralls.io/github/SuperKogito/pydiogment?branch=master) [](https://www.codefactor.io/repository/github/superkogito/pydiogment/overview/master)
**Pydiogment** aims to simplify audio augmentation. It generates multiple audio files based on a starting mono audio file. The library can generates files with higher speed, slower, and different tones etc.
:inbox_tray: Installation
============
Dependencies
------------
**Pydiogment** requires:
- [Python](https://www.python.org/download/releases/3.0/) (>= 3.5)
- [NumPy](https://numpy.org/) (>= 1.17.2)
- [SciPy](https://www.scipy.org/) (>= 1.3.1)
- [FFmpeg](https://www.ffmpeg.org/)
### On Linux
On Linux you can use the following commands to get the libraries:
- Numpy: `pip install numpy`
- Scipy: `pip install scipy`
- FFmpeg: `sudo apt install ffmpeg`
### On Windows
On Windows you can use the following installation binaries:
- Numpy: https://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy or if you have Python already installed you can use install it using `pip3 install numpy`
- Scipy: https://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy
- FFmpeg: https://ffmpeg.org/download.html#build-windows
### On MacOS
On MacOs, use homebrew to install the packages:
- Numpy: `brew install numpy --with-python3`
- Scipy: You need to first install a compilation tool like Gfortran using homebrew `brew install gfortran` when it's done, install Scipy `pip install scipy`
for more information and guidelines you can check this link: https://github.com/scipy/scipy/blob/master/INSTALL.rst.txt#mac-os-x
- FFmpeg: `brew install ffmpeg`
Installation
-------------
If you already have a working installation of [NumPy](https://numpy.org/) and [SciPy](https://www.scipy.org/) , you can simply install **Pydiogment** using pip:
```
pip install pydiogment
```
To update an existing version of **Pydiogment**, use:
```
pip install -U pydiogment
```
:bulb: How to use
==========
- ## Amplitude related augmentation
- ### Apply a fade in and fade out effect
```python3
from pydiogment.auga import fade_in_and_out
test_file = "path/test.wav"
fade_in_and_out(test_file)
```
- ### Apply gain to file
```python3
from pydiogment.auga import apply_gain
test_file = "path/test.wav"
apply_gain(test_file, -100)
apply_gain(test_file, -50)
```
- ### Add Random Gaussian Noise based on SNR to file
```python3
from pydiogment.auga import add_noise
test_file = "path/test.wav"
add_noise(test_file, 10)
```
- ## Frequency related augmentation
- ### Change file tone
```python3
from pydiogment.augf import change_tone
test_file = "path/test.wav"
change_tone(test_file, 0.9)
change_tone(test_file, 1.1)
```
- ## Time related augmentation
- #### Slow-down/ speed-up file
```python3
from pydiogment.augt import slowdown, speed
test_file = "path/test.wav"
slowdown(test_file, 0.8)
speed(test_file, 1.2)
```
- ### Apply random cropping to the file
```python3
from pydiogment.augt import random_cropping
test_file = "path/test.wav"
random_cropping(test_file, 1)
```
- ### Change shift data on the time axis in a certain direction
```python3
from pydiogment.augt import shift_time
test_file = "path/test.wav"
shift_time(test_file, 1, "right")
shift_time(test_file, 1, "left")
```
- ## Audio files format
This library currently supports mono WAV files only.
:bookmark_tabs: Documentation
==============
A thorough documentation of the library is available under [pydiogment.readthedocs.io](https://pydiogment.readthedocs.io/en/latest/index.html).
:construction_worker: Contributing and bugs report
============
Contributions are welcome and encouraged. To learn more about how to contribute to **Pydiogment** please refer to the [Contributing guidelines](https://github.com/SuperKogito/pydiogment/blob/master/CONTRIBUTING.md)
To report bugs, request a feature or just ask for help you can refer to the [issues](https://github.com/SuperKogito/pydiogment/issuesif) section.
Before reporting a bug please make sure it is not addressed by an older issue and make sure to add your operating system type, its version number and the versions of the dependencies used.
:tada: Acknowledgment and credits
============================
- The test file used in the pytests is [OSR_us_000_0060_8k.wav](https://www.voiptroubleshooter.com/open_speech/american/OSR_us_000_0060_8k.wav) from the [Open Speech Repository](https://www.voiptroubleshooter.com/open_speech/american.html).