Metadata-Version: 2.1
Name: jaxdsp
Version: 0.3.1
Summary: Fast, differentiable audio processors on the CPU or GPU, with a browser client for real-time control
Home-page: https://github.com/khiner/jaxdsp
Author: Karl Hiner
Author-email: karl.hiner@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# JAXdsp

Fast, differentiable audio processors on the CPU or GPU, controlled from the browser.

**I'm still working on improvements and an interactive browser client, after which I'll write up a blog post.
In the meantime, the `docs` directory has several Jupyter notebooks with plenty of examples.
The `Differentiable Audio Processors` notebook shows many real DSP examples, along with loss/parameter time-series.**
_(All files under `docs/scratch` are working notes, and can be ignored.)_
g
The goal of this project is to parameterize audio graphs, in real-time, to produce an audio stream resembling incoming audio.

Built with [JAX](https://github.com/google/jax), WebRTC, WebSockets, and React.
[`react-three-fiber`](https://github.com/pmndrs/react-three-fiber) provides the WebGL backbone for
performant real-time clientside monitoring of the system.

## Server

### Docker

To build and run the server in a Linux container:

```shell
$ docker build . -t jaxdsp_server
$ docker run -p 8080:8080 jaxdsp_server
```

```shell
$ cd server
$ python server.py
```

## Client

_**Note:** For local development of the client within the test `/app` (see below), the client is included as a
local `file:../client` dependency, and included in the babel transpilation for the `/app` build (
see `app/craco.config.js`)._

_`build:dev` in the client just symlinks the `dist/jaxdsp-client.js` target to the root `index.js` file._

```shell
$ cd client
$ npm ci
$ npm run build # or, for a development build: `build:dev`
```

## App

```shell
$ cd app
$ npm ci
$ npm start
```


