Skip to content

Commit

Permalink
Update readme with reverb example for release v0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
pzelasko authored Jan 28, 2023
1 parent 538a999 commit c661818
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,30 @@

A small package with stateful audio limiter implementation in Cython. Since the limiter is stateful it is suitable for streaming audio processing.

## Examples
We're slowly growing into other effects beyond limiter, starting with streaming reverb in v0.4.

## What's new?

### v0.4: Added reverb with RIR

```python
from cylimiter import ReverbRIR

reverb = ReverbRIR() # default RIR
# or user-provided RIR:
# reverb = ReverbRIR([0.001, 0.021, 0.007, ...])

reverb.apply(audio) # makes a copy
reverb.apply_inplace(audio) # no copies with np.array input

# preserves context between calls for streaming applications
for chunk in audio_source:
reverb.apply_inplace(chunk)
```



### Examples

```python
import numpy as np
Expand Down

0 comments on commit c661818

Please sign in to comment.