README.md

Load Audio files directly into PyTorch Tensors
================================================

Audio library for PyTorch
 * Support audio I/O (Load files)

Load the following formats into a torch Tensor
 * mp3, wav, aac, ogg, flac, avr, cdda, cvs/vms,
 * aiff, au, amr, mp2, mp4, ac3, avi, wmv,
 * mpeg, ircam and any other format supported by libsox.

Dependencies
------------
* libsox v14.3.2 or above

Quick install on
OSX (Homebrew):
```bash
brew install sox
```
Linux (Ubuntu):
```bash
sudo apt-get install sox libsox-dev libsox-fmt-all
```

Installation
------------

```bash
pip install cffi
python setup.py install
```

Quick Usage
-----------

```python
import torchaudio
sound, sample_rate = torchaudio.load('foo.mp3')
torchaudio.save('foo_save.mp3', sound, sample_rate) # saves tensor to file
```

API Reference
-----------
torchaudio.load
```
loads an audio file into a Tensor
audio.load(
	string,  # path to file
	out=None, # optionally pass output Tensor (any CPU Tensor type)
)
```

torchaudio.save
```
saves a tensor into an audio file. The extension of the given path is used as the saving format.
audio.save(
	string, # path to file
	tensor, # NSamples x NChannels 2D tensor
	number, # sample_rate of the audio to be saved as
)
```