https://github.com/descriptinc/audiotools

Object-oriented handling of audio data, with GPU-powered augmentations, and more.
https://github.com/descriptinc/audiotools

Last synced: about 2 months ago
JSON representation

Object-oriented handling of audio data, with GPU-powered augmentations, and more.

• Host: GitHub
• URL: https://github.com/descriptinc/audiotools
• Owner: descriptinc
• License: mit
• Created: 2021-03-08T23:52:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-06T00:10:55.000Z (4 months ago)
• Last Synced: 2024-05-06T03:22:59.714Z (about 2 months ago)
• Language: Python
• Homepage: https://descriptinc.github.io/audiotools/
• Size: 12.8 MB
• Stars: 181
• Watchers: 26
• Forks: 31
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• project-awesome - descriptinc/audiotools - Object-oriented handling of audio data, with GPU-powered augmentations, and more. (Python)

README

        
# AudioTools

Object-oriented handling of audio signals, with fast augmentation routines, batching, padding, and more.

## Installation

```

pip install git+https://github.com/descriptinc/audiotools

```

OR

```bash

git clone https://github.com/descriptinc/audiotools

cd audiotools

pip install .

```

## Documentation

For documentation, see [the docs](https://descriptinc.github.io/audiotools/).

### Deploying documentation

To build the documentation, do:

```bash

cd docs/

make html

open _build/html/index.html

```

Once you're satisfied with your docs, push them to the gh-pages branch via

```bash

cd docs

bash publish_docs.sh

```

## Quickstart

```python

import audiotools

from audiotools import AudioSignal

signal = AudioSignal("tests/audio/spk/f10_script4_produced.wav", offset=5, duration=5)

signal.play() # Play back the signal in your terminal using ffplay

signal.low_pass(8000) # Low-pass the signal

signal.play() # Play back the low-passed version of the signal

```

For more, see the [documentation](##Documentation).

### Install hooks

First install the pre-commit util:

https://pre-commit.com/#install

    pip install pre-commit  # with pip

    brew install pre-commit  # on Mac

Then install the git hooks

    pre-commit install

    # check .pre-commit-config.yaml for details of hooks

Upon `git commit`, the pre-commit hooks will be run automatically on the stage files (i.e. added by `git add`)

**N.B. By default, pre-commit checks only run on staged files**

If you need to run it on all files:

    pre-commit run --all-files