https://github.com/jazz-soft/jzz-synth-fluid

A JZZ wrapper for FluidSynth
https://github.com/jazz-soft/jzz-synth-fluid

fluidsynth midi soundfont

Last synced: 2 months ago
JSON representation

A JZZ wrapper for FluidSynth

• Host: GitHub
• URL: https://github.com/jazz-soft/jzz-synth-fluid
• Owner: jazz-soft
• Created: 2022-06-19T21:12:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-10T00:57:43.000Z (6 months ago)
• Last Synced: 2024-08-11T00:25:33.052Z (6 months ago)
• Topics: fluidsynth, midi, soundfont
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# JZZ-synth-Fluid

[![npm](https://img.shields.io/npm/v/jzz-synth-fluid.svg)](https://www.npmjs.com/package/jzz-synth-fluid)

[![npm](https://img.shields.io/npm/dt/jzz-synth-fluid.svg)](https://www.npmjs.com/package/jzz-synth-fluid)

[![build](https://github.com/jazz-soft/JZZ-synth-Fluid/actions/workflows/build.yml/badge.svg)](https://github.com/jazz-soft/JZZ-synth-Fluid/actions)

[![Coverage Status](https://coveralls.io/repos/github/jazz-soft/JZZ-synth-Fluid/badge.svg?branch=main)](https://coveralls.io/github/jazz-soft/JZZ-synth-Fluid?branch=main)

A [JZZ](https://github.com/jazz-soft/JZZ) wrapper for [FluidSynth](https://github.com/FluidSynth/fluidsynth)

## Install

`npm install jzz-synth-fluid`

You also need to have [FluidSynth](https://github.com/FluidSynth/fluidsynth) installed in your computer.

## Usage

##### Play directly

```js

var JZZ = require('jzz');

require('jzz-synth-fluid')(JZZ);

JZZ.synth.Fluid({ path: '/path/to/my/fluidsynth', sf: '/path/to/my/soundfont.sf2' })

   .noteOn(0, 'C5', 127)

   .wait(500).noteOn(0, 'E5', 127)

   .wait(500).noteOn(0, 'G5', 127)

   .wait(500).noteOff(0, 'C5').noteOff(0, 'E5').noteOff(0, 'G5')

   .close();

```

##### Register as a MIDI port

```js

var JZZ = require('jzz');

require('jzz-synth-fluid')(JZZ);

JZZ.synth.Fluid.register('Fluid Synth', { path: '/path/to/my/fluidsynth', sf: '/path/to/my/soundfont.sf2' });

JZZ().openMidiOut('Fluid Synth')

   .noteOn(0, 'C5', 127)

   .wait(500).noteOn(0, 'E5', 127)

   .wait(500).noteOn(0, 'G5', 127)

   .wait(500).noteOff(0, 'C5').noteOff(0, 'E5').noteOff(0, 'G5')

   .close();

```

## API

##### Create/register

```js

var synth = JZZ.synth.Fluid(params);

// or

JZZ.synth.Fluid.register(params);

// or

JZZ.synth.Fluid.register(name, params);

var synth = JZZ().openMidiOut(name)

```

`name`: a unique name for the synth; default: `'JZZ.synth.Fluid'`.  

`params`: an object with the following keys:  

- `path`: path to the FluidSynth executable; default: `'fluidsynth'`;  

- `sf`: path to the soundfont file; optional - can be loaded later;  

- `args`: an array of additional arguments for the fluidsynth command line; default: `[]`.

##### MIDI port calls

See https://jazz-soft.net/doc/JZZ/midiout.html for the complete list.

##### Load soundfont

```js

synth.loadSF(path);

```

`path`: path to the soundfont file.

##### STDIN/STDOUT

`port.stdin`, `port.stdout` (for those who want direct access to the fluidsynth via shell commands).

## More information

Please visit [**https://jazz-soft.net**](https://jazz-soft.net) for more information.