Metadata-Version: 2.1
Name: audio-snippets
Version: 0.0.1
Summary: Simple snippets for audio analysis
Home-page: https://github.com/sizhky/audio_snippets/tree/master/
Author: Yeshwanth
Author-email: 1992chinna@gmail.com
License: Apache Software License 2.0
Keywords: audio,snippets
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pip
Requires-Dist: packaging
Requires-Dist: librosa
Requires-Dist: plotly
Requires-Dist: torch-snippets
Requires-Dist: soundfile
Provides-Extra: dev

# audio-snippets

## Install
```bash
pip install audio-snippets
```

## Usage
I suggest you use jupyter notebooks to take full advantage of all functions

### Load Audio
```python
from audio_snippets import Sound
s = Sound.from_path('/path/to/audio/file.mp3')
```
### Data
```python
print(s.audio) # just the numpy array :D
print(s.Fs)    # sampling frequency
```
### Play it
```python
s.play()
s.play(x=5)    # play the audio in 5x speed
```
### Size of audio
```python
len(s)         # Number of samples
s.size         # Number of seconds of audio
s.formatted_size 
# length of the audio in seconds/minutes/hours
# E.g.  # 5.323 seconds ; 6.43 minutes ; 1.53 hours
```
### Slice the audio
```python
t = s[3:5]     # Slices the audio from 3 to 5 seconds
t.play()
t = s[:5]      # Slice first 5 seconds
t = s[5:]      # Slice from 5 seconds onward
t = s[::2]     # select every second sample (speeds the audio by 2x)
```
### Plot the waveform
```python
s.plot()             # interactive plotly
s.plot(slice(5, 25)) # plot a slice of the waveform
```


