Metadata-Version: 2.5
Name: ipyaudioworklet
Version: 0.7.0
Summary: A Jupyter Widget for Web Audio Recording using Audio Worklet
Project-URL: Homepage, https://github.com/naoh16/ipyaudioworklet
Author-email: Sunao Hara <sunao.hara@gmail.com>
License: Copyright (c) 2023 Sunao Hara
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE.txt
Keywords: IPython,Jupyter,Widgets
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Python: >=3.11
Requires-Dist: ipydatawidgets>=4.0.0
Requires-Dist: ipywidgets>=8.0.0
Requires-Dist: numpy
Requires-Dist: traittypes
Provides-Extra: dev
Requires-Dist: hatch-nodejs-version>=0.3.2; extra == 'dev'
Requires-Dist: hatchling>=1.5.0; extra == 'dev'
Requires-Dist: jupyter-builder>=1.0.0; extra == 'dev'
Requires-Dist: jupyterlab>=4.0.0; extra == 'dev'
Requires-Dist: tbump; extra == 'dev'
Provides-Extra: docs
Requires-Dist: jupyter-sphinx; extra == 'docs'
Requires-Dist: nbsphinx; extra == 'docs'
Requires-Dist: nbsphinx-link; extra == 'docs'
Requires-Dist: pypandoc; extra == 'docs'
Requires-Dist: pytest-check-links; extra == 'docs'
Requires-Dist: recommonmark; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Requires-Dist: sphinx>=1.5; extra == 'docs'
Provides-Extra: examples
Requires-Dist: matplotlib; extra == 'examples'
Provides-Extra: test
Requires-Dist: nbval; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest>=6.0; extra == 'test'
Description-Content-Type: text/markdown


# ipyaudioworklet

<!--
[![Build Status](https://travis-ci.org/naoh16/ipyaudioworklet.svg?branch=master)](https://travis-ci.org/naoh16/ipyaudioworklet)
[![codecov](https://codecov.io/gh/naoh16/ipyaudioworklet/branch/master/graph/badge.svg)](https://codecov.io/gh/naoh16/ipyaudioworklet)
-->

A Jupyter Widget for Web Audio Recording using Audio Worklet

This extension will be enable us to record PCM audio using AudioWorkletNode of Web Audio API.
For the security constraints of major web-browsers, you need to run JupyterLab with HTTPS context.

![Screenshot](docs/source/_static/screenshot_1.png)

## Installation

You can install using `pip`:

### Prebuild

```bash
pip install -U ipyaudioworklet
```

or, you may find some prebuilt packages in GitHub releases. Eg.

```bash
pip install -U https://github.com/naoh16/ipyaudioworklet/releases/download/v0.1.3/ipyaudioworklet-0.1.3-py3-none-any.whl
```

### Self-build from master branch

```bash
pip install git+https://github.com/naoh16/ipyaudioworklet.git
```

## Usage

### quickstart

- You can see the interface as following cell:

  ```python
  import ipyaudioworklet as ipyaudio
  
  recorder = ipyaudio.AudioRecorder()
  recorder
  ```

- Then you can find three buttons in the widget.

  - `[Boot RECORDER]` Button / `recorder.run()`
    -  As first, you need to push the button to boot up the recorder.
    -  Please allow your web browser access to your PC's microphone.
  - `[Record]` Button / `recorder.resume()`
    - You can record audio.
  - `[Stop]` Button / `recorder.suspend()`
    - You can stop the recording.
  - audio control (HTML5's ``<audio>``)
    - You can preview the recroded sound.
    - You may download the sound as WAV file through option menu of the control. (depend on your web browser)

### Examples

See examples: [examples/introduction.ipynb](examples/introduction.ipynb)

You can try them on Binder:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/naoh16/ipyaudioworklet/main?labpath=examples)


## For developers and Audio/Sound reserchers!!

Please check the following files. They are the core modules of this extension.

- JupyterLab/ipywidgets interface
  - [src/widgets.ts](src/widgets.ts) ... Frontend of the widget
  - [ipyaudioworklet/audio.py](ipyaudioworklet/audio.py) ... Backend of the widget
- Audio Recording
  - [src/audio.ts](src/audio.ts) ... Utility functions using Web Audio API
  - [src/_static/audio-processor.js](src/_static/audio-processor.js) ... AudioWorkletNode definition. This node is ping pong the recording audio fragments to the callback function defined in `audio.ts`.

---

TODO: The following lines are not modified from cookie-cutter templates.

### Miscs

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:
```bash
jupyter nbextension enable --py [--sys-prefix|--user|--system] ipyaudioworklet
```

## Development Installation

Create a dev environment:
```bash
conda create -n ipyaudioworklet-dev -c conda-forge nodejs yarn python jupyterlab
conda activate ipyaudioworklet-dev
```

Install the python. This will also build the TS package.
```bash
pip install -e ".[test, examples]"
```

When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:

```
jupyter-builder develop --overwrite .
yarn run build
```

For classic notebook, you need to run:

```
jupyter nbextension install --sys-prefix --symlink --overwrite --py ipyaudioworklet
jupyter nbextension enable --sys-prefix --py ipyaudioworklet
```

Note that the `--symlink` flag doesn't work on Windows, so you will here have to run
the `install` command every time that you rebuild your extension. For certain installations
you might also need another flag instead of `--sys-prefix`, but we won't cover the meaning
of those flags here.

### How to see your changes
#### Typescript:
If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
terminals to watch for changes in the extension's source and automatically rebuild the widget.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab
```

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

#### Python:
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.

## Updating the version

To update the version, install tbump and use it to bump the version.
By default it will also create a tag.

```bash
pip install tbump
tbump <new-version>
# or
# tbump <new-version> --no-push
```

## Build sdist and wheel

```bash
hatch build
```

## Publish public repository and CDNs

### PyPI

```bash
pip install twine
twine upload --repository testpypi dist/ipyaudioworklet-<new-version>*whl
twine upload --repository pypi dist/ipyaudioworklet-<new-version>*whl
```

### NPM

```bash
npm publish --access public
```
