# Nendo Plugin FX Core
<br>
<p align="left">
<img src="https://okio.ai/docs/assets/nendo_core_logo.png" width="350" alt="Nendo Core">
</p>
<br>
<p align="left">
<a href="https://okio.ai" target="_blank">
<img src="https://img.shields.io/website/https/okio.ai" alt="Website">
</a>
<a href="https://twitter.com/okio_ai" target="_blank">
<img src="https://img.shields.io/twitter/url/https/twitter.com/okio_ai.svg?style=social&label=Follow%20%40okio_ai" alt="Twitter">
</a>
<a href="https://discord.gg/gaZMZKzScj" target="_blank">
<img src="https://dcbadge.vercel.app/api/server/XpkUsjwXTp?compact=true&style=flat" alt="Discord">
</a>
</p>
---
NendoFX: Use common audio effects out of the box (based on [pedalboard](https://github.com/spotify/pedalboard) by Spotify Research).
## Features
- Apply well known audio effects to a `NendoTrack`
- modulation via: `chorus`, `phaser`
- different filters: `lowpass`, `highpass`, `low_shelf`, `high_shelf`
- adaptive processing based on MIR features via: `limiter`
- custom effects like: `stereo`
- also basics like: `distortion`, `reverb`, `delay`, `compressor`
## Installation
1. [Install Nendo](https://github.com/okio-ai/nendo#installation)
2. `pip install nendo-plugin-fx-core`
## Usage
Take a look at a basic usage example below.
For more detailed information, please refer to the [documentation](https://okio.ai/docs/plugins).
For more advanced examples, check out the examples folder.
or try it in colab:
<a target="_blank" href="https://colab.research.google.com/drive/1wSGM2lhgP1z8gL2cVOErzot9m9AJ1zCU?usp=sharing">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>
```python
from nendo import Nendo, NendoConfig
nd = Nendo(config=NendoConfig(plugins=["nendo_plugin_fx_core"]))
track = nd.library.add_track(file_path='/path/to/track.mp3')
track = nd.plugins.fx_core.compressor(track=track)
track = nd.plugins.fx_core.reverb(
track=track,
wet_level=0.2,
dry_level=0.8,
room_size=0.1,
)
track = nd.plugins.fx_core.limiter(track=track)
track.play()
```
## Contributing
Visit our docs to learn all about how to contribute to Nendo: [Contributing](https://okio.ai/docs/contributing/)
## Licence
Nendo: MIT
Pedalboard: GPL3
For additional licences check https://github.com/spotify/pedalboard
Raw data
{
"_id": null,
"home_page": "https://okio.ai",
"name": "nendo-plugin-fx-core",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "nendo,music,audio effect,compressor,reverb,filter,equalizer,distortion,phaser,chorus,filter,eq,digital signal processing,dsp,pedalboard,nendo effects,plugin",
"author": "Aaron Abebe",
"author_email": "aaron@okio.ai",
"download_url": "https://files.pythonhosted.org/packages/40/0f/ecc0bf5dcd990ae8fcbef851f770981acebb57d5cee8c8f6e299a4341d9f/nendo_plugin_fx_core-0.1.2.tar.gz",
"platform": null,
"description": "# Nendo Plugin FX Core\n\n<br>\n<p align=\"left\">\n <img src=\"https://okio.ai/docs/assets/nendo_core_logo.png\" width=\"350\" alt=\"Nendo Core\">\n</p>\n<br>\n\n<p align=\"left\">\n<a href=\"https://okio.ai\" target=\"_blank\">\n <img src=\"https://img.shields.io/website/https/okio.ai\" alt=\"Website\">\n</a>\n<a href=\"https://twitter.com/okio_ai\" target=\"_blank\">\n <img src=\"https://img.shields.io/twitter/url/https/twitter.com/okio_ai.svg?style=social&label=Follow%20%40okio_ai\" alt=\"Twitter\">\n</a>\n<a href=\"https://discord.gg/gaZMZKzScj\" target=\"_blank\">\n <img src=\"https://dcbadge.vercel.app/api/server/XpkUsjwXTp?compact=true&style=flat\" alt=\"Discord\">\n</a>\n</p>\n\n---\n\nNendoFX: Use common audio effects out of the box (based on [pedalboard](https://github.com/spotify/pedalboard) by Spotify Research).\n\n## Features\n\n- Apply well known audio effects to a `NendoTrack`\n- modulation via: `chorus`, `phaser`\n- different filters: `lowpass`, `highpass`, `low_shelf`, `high_shelf`\n- adaptive processing based on MIR features via: `limiter`\n- custom effects like: `stereo`\n- also basics like: `distortion`, `reverb`, `delay`, `compressor`\n\n## Installation\n\n1. [Install Nendo](https://github.com/okio-ai/nendo#installation)\n2. `pip install nendo-plugin-fx-core`\n\n## Usage\n\nTake a look at a basic usage example below.\nFor more detailed information, please refer to the [documentation](https://okio.ai/docs/plugins).\n\nFor more advanced examples, check out the examples folder.\nor try it in colab:\n\n<a target=\"_blank\" href=\"https://colab.research.google.com/drive/1wSGM2lhgP1z8gL2cVOErzot9m9AJ1zCU?usp=sharing\">\n <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n</a>\n\n```python\nfrom nendo import Nendo, NendoConfig\n\nnd = Nendo(config=NendoConfig(plugins=[\"nendo_plugin_fx_core\"]))\n\ntrack = nd.library.add_track(file_path='/path/to/track.mp3')\n\n\ntrack = nd.plugins.fx_core.compressor(track=track)\ntrack = nd.plugins.fx_core.reverb(\n track=track,\n wet_level=0.2,\n dry_level=0.8,\n room_size=0.1,\n)\ntrack = nd.plugins.fx_core.limiter(track=track)\ntrack.play()\n```\n\n## Contributing\n\nVisit our docs to learn all about how to contribute to Nendo: [Contributing](https://okio.ai/docs/contributing/)\n\n## Licence\n\nNendo: MIT\n\nPedalboard: GPL3\n\nFor additional licences check https://github.com/spotify/pedalboard\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "NendoFX plugin: Use common audio effects out of the box.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://okio.ai",
"Repository": "https://github.com/okio-ai/nendo_plugin_fx_core"
},
"split_keywords": [
"nendo",
"music",
"audio effect",
"compressor",
"reverb",
"filter",
"equalizer",
"distortion",
"phaser",
"chorus",
"filter",
"eq",
"digital signal processing",
"dsp",
"pedalboard",
"nendo effects",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f073965059691b5c1545eb2d8ab47dbc47cc93a5cb96cd77467c10aaefa6e268",
"md5": "7dbba8c785967e969b9c4ac3ce91faf9",
"sha256": "67a2c6f97a726c044417f559d02e481d0c5ad4acd0e61d9f0d1c4478d2627a81"
},
"downloads": -1,
"filename": "nendo_plugin_fx_core-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7dbba8c785967e969b9c4ac3ce91faf9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 17529,
"upload_time": "2024-02-21T09:38:37",
"upload_time_iso_8601": "2024-02-21T09:38:37.394478Z",
"url": "https://files.pythonhosted.org/packages/f0/73/965059691b5c1545eb2d8ab47dbc47cc93a5cb96cd77467c10aaefa6e268/nendo_plugin_fx_core-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "400fecc0bf5dcd990ae8fcbef851f770981acebb57d5cee8c8f6e299a4341d9f",
"md5": "e7f78df40f50dc9d6992f71b79ef9472",
"sha256": "02073b93c8c8090518eee8d7f351264b2486ded50344774ed8d3747134ca1b39"
},
"downloads": -1,
"filename": "nendo_plugin_fx_core-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e7f78df40f50dc9d6992f71b79ef9472",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 17807,
"upload_time": "2024-02-21T09:38:38",
"upload_time_iso_8601": "2024-02-21T09:38:38.705576Z",
"url": "https://files.pythonhosted.org/packages/40/0f/ecc0bf5dcd990ae8fcbef851f770981acebb57d5cee8c8f6e299a4341d9f/nendo_plugin_fx_core-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 09:38:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "okio-ai",
"github_project": "nendo_plugin_fx_core",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nendo-plugin-fx-core"
}
JSON
