Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/korilakkuma/xsound
XSound gives Web Developers Powerful Audio Features Easily !
https://github.com/korilakkuma/xsound
audio music webassembly webaudio webmidi webrtc
Last synced: 1 day ago
JSON representation
XSound gives Web Developers Powerful Audio Features Easily !
- Host: GitHub
- URL: https://github.com/korilakkuma/xsound
- Owner: Korilakkuma
- License: mit
- Created: 2017-11-19T07:00:02.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T12:52:17.000Z (17 days ago)
- Last Synced: 2024-12-29T11:03:35.897Z (1 day ago)
- Topics: audio, music, webassembly, webaudio, webmidi, webrtc
- Language: TypeScript
- Homepage: https://xsound.jp
- Size: 35.5 MB
- Stars: 209
- Watchers: 7
- Forks: 17
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://xsound.jp)
[](https://github.com/Korilakkuma/XSound/actions?query=workflow%3A%22Node.js+CI%22)
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/xsound)
[](https://www.jsdelivr.com/package/npm/xsound)
## Overview
XSound gives Web Developers Powerful Audio Features Easily !
In concrete, XSound is useful to implement the following features.
- Create Sound
- Play the One-Shot Audio
- Play the Audio
- Play the Media
- Streaming (by WebRTC)
- MIDI (by Web MIDI API)
- MML (Music Macro Language)
- Effectors (Compressor / Wah / Equalizer / Tremolo / Phaser / Chorus / Delay / Reverb ... etc)
- Visualization (Overview in Time Domain / Time Domain / Spectrum)
- Multi-Track Recording (Create WAVE file)
- Audio Streaming
- Visual Audio Sprite
XSound don't depend on other libraries or frameworks (For example, jQuery, React).
## Supported Browsers
## Getting Started
In case of using as **full stack** (For example, use oscillator) ...
```JavaScript
X('oscillator').setup([true, true, false, false]).ready(2, 5).start([440, 880]).stop();
```
or, in case of using as **module base** (For example, use chorus effector) ...
```JavaScript
// The instance of `AudioContext`
const context = X.get();
// Create the instance of `Chorus` that is defined by XSound
const chorus = new X.Chorus(context);
const oscillator = context.createOscillator();
// The instance that is defined by XSound has connectors for input and output
oscillator.connect(chorus.INPUT);
chorus.OUTPUT.connect(context.destination);
// Set parameters for chorus
chorus.param({
time : 0.025,
depth: 0.5,
rate : 2.5,
mix : 0.5
});
// Activate
chorus.activate();
oscillator.start(0);
```
XSound enable to using the following classes (Refer to [API Documentation](https://xsound.jp/docs/) for details).
```TypeScript
X.Analyser(context: AudioContext);
X.Recorder(context: AudioContext);
// Effectors
X.Autopanner(context: AudioContext);
X.BitCrusher(context: AudioContext);
X.Chorus(context: AudioContext);
X.Compressor(context: AudioContext);
X.Delay(context: AudioContext);
X.Equalizer(context: AudioContext);
X.Filter(context: AudioContext);
X.Flanger(context: AudioContext);
X.Fuzz(context: AudioContext);
X.Listener(context: AudioContext);
X.NoiseGate(context: AudioContext);
X.NoiseSuppressor(context: AudioContext);
X.OverDrive(context: AudioContext);
X.Panner(context: AudioContext);
X.Phaser(context: AudioContext);
X.PitchShifter(context: AudioContext);
X.Preamp(context: AudioContext);
X.Reverb(context: AudioContext);
X.Ringmodulator(context: AudioContext);
X.Stereo(context: AudioContext);
X.Tremolo(context: AudioContext);
X.VocalCanceler(context: AudioContext);
X.Wah(context: AudioContext);
```
## Demo
[XSound.app](https://xsound.app) uses this library.
Now, I'm creating website for Web Audio API. Please refer to the following site for understanding API Documentation.
[Web Music Documentation](https://korilakkuma.github.io/Web-Music-Documentation/)
## Installation
```bash
$ npm install --save xsound
```
or,
```bash
$ pnpm install xsound
```
## Usage
In case of using ES Modules,
```JavaScript
import { XSound, X } from 'xsound';
```
If SSR (Server-Side Rendering), use [dynamic imports](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import),
```JavaScript
async () => {
const { XSound, X } = await import('xsound');
};
```
In case of using CDN,
```HTML
```
## Setup
### Use Webpack Dev Server
```bash
$ git clone [email protected]:Korilakkuma/XSound.git
$ cd XSound
$ npm install
$ npm run build # for build WebAssembly Modules
$ npm run dev
$ open http://localhost:8080/playground/
```
### Use Docker
```bash
$ git clone [email protected]:Korilakkuma/XSound.git
$ cd XSound
$ npm install
$ npm run build # for build WebAssembly Modules
$ npm run watch
$ docker compose up -d --build
$ open http://localhost:8080/playground/
```
### Installation instructions using the emsdk
Use WebAssembly Modules on v4 or later.
Therefore, it is required to set up emsdk (Refer to [details](https://emscripten.org/docs/getting_started/downloads.html)).
```bash
$ git clone https://github.com/emscripten-core/emsdk.git # Use an another directory excepte XSound directory
$ cd emsdk
$ ./emsdk install latest
$ ./emsdk activate latest
$ source ./emsdk_env.sh
$ cd /${path}/XSound
# If error occurred, execute `softwareupdate --install-rosetta`, then retry (in case of using macOS)
```
## API Documentation
[XSound API Documentation](https://xsound.jp/docs/)
## Playground
[XSound Playground](https://xsound.jp/playground/) (Watch by [YouTube](https://www.youtube.com/watch?v=QBe7FkidrUc)).
## Migration to v3
Please refer to [API Documentation](#api-documentation) for details.
### Case sensitive
```JavaScript
// Bad (v2 or earlier)
X('audio').module('panner').param({ coneinnerangle: 240 });
// Good (v3)
X('audio').module('panner').param({ coneInnerAngle: 240 });
```
### Use plain object if parameters setter
```JavaScript
// Bad (v2 or earlier)
X('oscillator').get(0).param('type', 'sawtooth');
// Good (v3)
X('oscillator').get(0).param({ type: 'sawtooth' });
```
### Validate parameters on the application side
```JavaScript
if ((type === 'sine') || (type === 'square') || (type === 'sawtooth') || (type === 'triangle')) {
X('oscillator').get(0).param({ type });
}
```
## Migration to v3.1.x or later
If use bundle tool and compress class names such as webpack and `terser-webpack-plugin`,
**must add the following [options](https://webpack.js.org/plugins/terser-webpack-plugin/#terseroptions)** (because of using inline `AudioWorkletProcessor`).
```JavaScript
new TerserWebpackPlugin({
// ... other options
terserOptions: {
keep_classnames: /^.*?Processor$/
}
})
```
## Pickups
- [9 libraries to kickstart your Web Audio stuff - DEV Community](https://dev.to/areknawo/9-libraries-to-kickstart-your-web-audio-stuff-460p)
-
XSound is a batteries-included library for everything audio. From basic management and loading through streaming, effects, ending with visualizations and recording, this libraries provides almost everything! It also has nice, semi-chainable API with solid documentation.
- [20 Useful Web Audio Javascript Libraries – Bashooka](https://bashooka.com/coding/web-audio-javascript-libraries/)
- [Extending X3D Realism with Audio Graphs, Acoustic Properties and 3D Spatial Sound](https://dl.acm.org/doi/10.1145/3424616.3424709)
- [DeView: Confining Progressive Web Applications by Debloating Web APIs](https://www.microsoft.com/en-us/research/uploads/prod/2022/09/deview-acsac22.pdf)
- In this section, we discuss the effectiveness of DeView’s Web API profiling in terms of code coverage. We choose three popular PWAs: Starbucks, Telegram [112], and XSound [57] from eCommerce, social media, and productivity categories, respectively.
## License
Released under the [MIT](https://github.com/Korilakkuma/XSound/blob/main/LICENSE) license