GstBtFluidSynth: GStreamer Buzztrax Reference Manual

## GstBtFluidSynth GstBtFluidSynth — FluidSynth GStreamer wrapper |

## Properties

gchar * | audio-alsa-device | Read / Write
gchar * | audio-driver | Read / Write
gchar * | audio-file-endian | Read / Write
gchar * | audio-file-format | Read / Write
gchar * | audio-file-name | Read / Write
gchar * | audio-file-type | Read / Write
gint | audio-input-channels | Read / Write
gint | audio-jack-autoconnect | Read / Write
gchar * | audio-jack-id | Read / Write
gint | audio-jack-multi | Read / Write
gchar * | audio-jack-server | Read / Write
gchar * | audio-oss-device | Read / Write
gint | audio-output-channels | Read / Write
gint | audio-period-size | Read / Write
gint | audio-periods | Read / Write
gint | audio-pulseaudio-adjust-latency | Read / Write
gchar * | audio-pulseaudio-device | Read / Write
gchar * | audio-pulseaudio-media-role | Read / Write
gchar * | audio-pulseaudio-server | Read / Write
gint | audio-realtime-prio | Read / Write
gchar * | audio-sample-format | Read / Write
gint | chorus-count | Read / Write
gdouble | chorus-depth | Read / Write
gboolean | chorus-enable | Read / Write
gdouble | chorus-freq | Read / Write
gdouble | chorus-level | Read / Write
GstBtFluidSynthChorusWaveform | chorus-waveform | Read / Write
gchar * | instrument-patch | Read / Write
GstBtFluidSynthInterpolationMode | interpolation | Read / Write
gchar * | midi-alsa-device | Read / Write
gchar * | midi-alsa-seq-device | Read / Write
gchar * | midi-alsa-seq-id | Read / Write
gchar * | midi-driver | Read / Write
gchar * | midi-jack-id | Read / Write
gchar * | midi-jack-server | Read / Write
gchar * | midi-oss-device | Read / Write
gchar * | midi-portname | Read / Write
gint | midi-realtime-prio | Read / Write
GstBtNote | note | Write
gint | note-length | Read / Write
gint | note-velocity | Read / Write
gint | player-reset-synth | Read / Write
gchar * | player-timing-source | Read / Write
gint | program | Read / Write
gdouble | reverb-damp | Read / Write
gboolean | reverb-enable | Read / Write
gdouble | reverb-level | Read / Write
gdouble | reverb-room-size | Read / Write
gdouble | reverb-width | Read / Write
gint | shell-port | Read / Write
gchar * | shell-prompt | Read / Write
gint | synth-audio-channels | Read / Write
gint | synth-audio-groups | Read / Write
gint | synth-chorus-active | Read / Write
gint | synth-cpu-cores | Read / Write
gint | synth-device-id | Read / Write
gint | synth-dump | Read / Write
gint | synth-effects-channels | Read / Write
gdouble | synth-gain | Read / Write
gint | synth-ladspa-active | Read / Write
gchar * | synth-midi-bank-select | Read / Write
gint | synth-midi-channels | Read / Write
gint | synth-min-note-length | Read / Write
gdouble | synth-overflow-age | Read / Write
gdouble | synth-overflow-percussion | Read / Write
gdouble | synth-overflow-released | Read / Write
gdouble | synth-overflow-sustained | Read / Write
gdouble | synth-overflow-volume | Read / Write
gint | synth-parallel-render | Read / Write
gint | synth-polyphony | Read / Write
gint | synth-reverb-active | Read / Write
gdouble | synth-sample-rate | Read / Write
gint | synth-threadsafe-api | Read / Write
gint | synth-verbose | Read / Write

## Types and Values

enum | GstBtFluidSynthInterpolationMode
enum | GstBtFluidSynthChorusWaveform
struct | GstBtFluidSynth

## Object Hierarchy

        GEnum
        ├── GstBtFluidSynthChorusWaveform
        ╰── GstBtFluidSynthInterpolationMode
        GObject
        ╰── GInitiallyUnowned
            ╰── GstObject
                ╰── GstElement
                    ╰── GstBaseSrc
                        ╰── GstBtAudioSynth
                            ╰── GstBtFluidSynth

## Implemented Interfaces

GstBtFluidSynth implements GstPreset and GstBtTempo.

## Description

FluidSynth is a SoundFont 2 capable wavetable synthesizer. Soundpatches are available on sounds.resonance.org. Distributions also have a few soundfonts packaged. The internet offers free patches for download.

When specifying a patch as a relative path, the element looks in common places for the files.

### Example launch line

    1
    gst-launch-1.0 fluidsynth num-buffers=10 note="c-3" ! autoaudiosink

Plays one c-3 tone using the first instrument.

    1
    gst-launch-1.0 fluidsynth num-buffers=20 instrument-patch="Vintage_Dreams_Waves_v2.sf2" program=2 note="c-3" ! alsasink

Load a specific patch and plays one c-3 tone using the second program.

## Functions

## Types and Values

### enum GstBtFluidSynthInterpolationMode

Synthesis engine interpolation mode.

#### Members

GSTBT_FLUID_SYNTH_INTERPOLATION_MODE_NONE | no interpolation |
GSTBT_FLUID_SYNTH_INTERPOLATION_MODE_LINEAR | linear interpolation |
GSTBT_FLUID_SYNTH_INTERPOLATION_MODE_4THORDER | 4th order interpolation |
GSTBT_FLUID_SYNTH_INTERPOLATION_MODE_7THORDER | 7th order interpolation |

### enum GstBtFluidSynthChorusWaveform

Modulation waveform for the chorus effect.

#### Members

GSTBT_FLUID_SYNTH_CHORUS_MOD_SINE | sine wave |
GSTBT_FLUID_SYNTH_CHORUS_MOD_TRIANGLE | triangle wave |

### struct GstBtFluidSynth

    struct GstBtFluidSynth;

Class instance data.

## Property Details

### The `“audio-alsa-device”` property

      “audio-alsa-device”        gchar *

audio.alsa.device.

Flags: Read / Write

Default value: "default"

### The `“audio-driver”` property

      “audio-driver”             gchar *

audio.driver.

Flags: Read / Write

Default value: "jack"

### The `“audio-file-endian”` property

      “audio-file-endian”        gchar *

audio.file.endian.

Flags: Read / Write

Default value: "auto"

### The `“audio-file-format”` property

      “audio-file-format”        gchar *

audio.file.format.

Flags: Read / Write

Default value: "s16"

### The `“audio-file-name”` property

      “audio-file-name”          gchar *

audio.file.name.

Flags: Read / Write

Default value: "fluidsynth.wav"

### The `“audio-file-type”` property

      “audio-file-type”          gchar *

audio.file.type.

Flags: Read / Write

Default value: "auto"

### The `“audio-input-channels”` property

      “audio-input-channels”     gint

audio.input-channels.

Flags: Read / Write

Allowed values: [0,2]

Default value: 0

### The `“audio-jack-autoconnect”` property

      “audio-jack-autoconnect”   gint

audio.jack.autoconnect.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

### The `“audio-jack-id”` property

      “audio-jack-id”            gchar *

audio.jack.id.

Flags: Read / Write

Default value: "fluidsynth"

### The `“audio-jack-multi”` property

      “audio-jack-multi”         gint

audio.jack.multi.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

### The `“audio-jack-server”` property

      “audio-jack-server”        gchar *

audio.jack.server.

Flags: Read / Write

Default value: ""

### The `“audio-oss-device”` property

      “audio-oss-device”         gchar *

audio.oss.device.

Flags: Read / Write

Default value: "/dev/dsp"

### The `“audio-output-channels”` property

      “audio-output-channels”    gint

audio.output-channels.

Flags: Read / Write

Allowed values: [2,32]

Default value: 2

### The `“audio-period-size”` property

      “audio-period-size”        gint

audio.period-size.

Flags: Read / Write

Allowed values: [64,8192]

Default value: 64

### The `“audio-periods”` property

      “audio-periods”            gint

audio.periods.

Flags: Read / Write

Allowed values: [2,64]

Default value: 16

### The `“audio-pulseaudio-adjust-latency”` property

      “audio-pulseaudio-adjust-latency” gint

audio.pulseaudio.adjust-latency.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“audio-pulseaudio-device”` property

      “audio-pulseaudio-device”  gchar *

audio.pulseaudio.device.

Flags: Read / Write

Default value: "default"

### The `“audio-pulseaudio-media-role”` property

      “audio-pulseaudio-media-role” gchar *

audio.pulseaudio.media-role.

Flags: Read / Write

Default value: "music"

### The `“audio-pulseaudio-server”` property

      “audio-pulseaudio-server”  gchar *

audio.pulseaudio.server.

Flags: Read / Write

Default value: "default"

### The `“audio-realtime-prio”` property

      “audio-realtime-prio”      gint

audio.realtime-prio.

Flags: Read / Write

Allowed values: [0,99]

Default value: 60

### The `“audio-sample-format”` property

      “audio-sample-format”      gchar *

audio.sample-format.

Flags: Read / Write

Default value: "16bits"

### The `“chorus-count”` property

      “chorus-count”             gint

Number of chorus delay lines.

Flags: Read / Write

Allowed values: [1,99]

Default value: 3

### The `“chorus-depth”` property

      “chorus-depth”             gdouble

Chorus depth.

Flags: Read / Write

Allowed values: [0,10]

Default value: 8

### The `“chorus-enable”` property

      “chorus-enable”            gboolean

Chorus enable.

Flags: Read / Write

Default value: TRUE

### The `“chorus-freq”` property

      “chorus-freq”              gdouble

Chorus modulation frequency (Hz).

Flags: Read / Write

Allowed values: [0.3,5]

Default value: 0.3

### The `“chorus-level”` property

      “chorus-level”             gdouble

Output level of each chorus line.

Flags: Read / Write

Allowed values: [0,10]

Default value: 2

### The `“chorus-waveform”` property

      “chorus-waveform”          GstBtFluidSynthChorusWaveform

Chorus waveform type.

Flags: Read / Write

Default value: GSTBT_FLUID_SYNTH_CHORUS_MOD_SINE

### The `“instrument-patch”` property

      “instrument-patch”         gchar *

Path to soundfont intrument patch file.

Flags: Read / Write

Default value: NULL

### The `“interpolation”` property

      “interpolation”            GstBtFluidSynthInterpolationMode

Synthesis Interpolation type.

Flags: Read / Write

Default value: GSTBT_FLUID_SYNTH_INTERPOLATION_MODE_4THORDER

### The `“midi-alsa-device”` property

      “midi-alsa-device”         gchar *

midi.alsa.device.

Flags: Read / Write

Default value: "default"

### The `“midi-alsa-seq-device”` property

      “midi-alsa-seq-device”     gchar *

midi.alsa_seq.device.

Flags: Read / Write

Default value: "default"

### The `“midi-alsa-seq-id”` property

      “midi-alsa-seq-id”         gchar *

midi.alsa_seq.id.

Flags: Read / Write

Default value: "pid"

### The `“midi-driver”` property

      “midi-driver”              gchar *

midi.driver.

Flags: Read / Write

Default value: "alsa_seq"

### The `“midi-jack-id”` property

      “midi-jack-id”             gchar *

midi.jack.id.

Flags: Read / Write

Default value: "fluidsynth-midi"

### The `“midi-jack-server”` property

      “midi-jack-server”         gchar *

midi.jack.server.

Flags: Read / Write

Default value: ""

### The `“midi-oss-device”` property

      “midi-oss-device”          gchar *

midi.oss.device.

Flags: Read / Write

Default value: "/dev/midi"

### The `“midi-portname”` property

      “midi-portname”            gchar *

midi.portname.

Flags: Read / Write

Default value: ""

### The `“midi-realtime-prio”` property

      “midi-realtime-prio”       gint

midi.realtime-prio.

Flags: Read / Write

Allowed values: [0,99]

Default value: 50

### The `“note”` property

      “note”                     GstBtNote

Musical note (e.g. 'c-3', 'd#4').

Flags: Write

Default value: NONE

### The `“note-length”` property

      “note-length”              gint

Length of a note in ticks (buffers).

Flags: Read / Write

Allowed values: [1,100]

Default value: 4

### The `“note-velocity”` property

      “note-velocity”            gint

Velocity of a note.

Flags: Read / Write

Allowed values: [0,127]

Default value: 100

### The `“player-reset-synth”` property

      “player-reset-synth”       gint

player.reset-synth.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“player-timing-source”` property

      “player-timing-source”     gchar *

player.timing-source.

Flags: Read / Write

Default value: "sample"

### The `“program”` property

      “program”                  gint

Sound program number.

Flags: Read / Write

Allowed values: [0,16383]

Default value: 0

### The `“reverb-damp”` property

      “reverb-damp”              gdouble

Reverb dampening.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

### The `“reverb-enable”` property

      “reverb-enable”            gboolean

Reverb enable.

Flags: Read / Write

Default value: TRUE

### The `“reverb-level”` property

      “reverb-level”             gdouble

Reverb level.

Flags: Read / Write

Allowed values: [-30,30]

Default value: 4

### The `“reverb-room-size”` property

      “reverb-room-size”         gdouble

Reverb room size.

Flags: Read / Write

Allowed values: [0,1.2]

Default value: 0.4

### The `“reverb-width”` property

      “reverb-width”             gdouble

Reverb width.

Flags: Read / Write

Allowed values: [0,100]

Default value: 2

### The `“shell-port”` property

      “shell-port”               gint

shell.port.

Flags: Read / Write

Allowed values: [1,65535]

Default value: 9800

### The `“shell-prompt”` property

      “shell-prompt”             gchar *

shell.prompt.

Flags: Read / Write

Default value: ""

### The `“synth-audio-channels”` property

      “synth-audio-channels”     gint

synth.audio-channels.

Flags: Read / Write

Allowed values: [1,128]

Default value: 1

### The `“synth-audio-groups”` property

      “synth-audio-groups”       gint

synth.audio-groups.

Flags: Read / Write

Allowed values: [1,128]

Default value: 1

### The `“synth-chorus-active”` property

      “synth-chorus-active”      gint

synth.chorus.active.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“synth-cpu-cores”` property

      “synth-cpu-cores”          gint

synth.cpu-cores.

Flags: Read / Write

Allowed values: [1,256]

Default value: 1

### The `“synth-device-id”` property

      “synth-device-id”          gint

synth.device-id.

Flags: Read / Write

Allowed values: [0,126]

Default value: 0

### The `“synth-dump”` property

      “synth-dump”               gint

synth.dump.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

### The `“synth-effects-channels”` property

      “synth-effects-channels”   gint

synth.effects-channels.

Flags: Read / Write

Allowed values: [2,2]

Default value: 2

### The `“synth-gain”` property

      “synth-gain”               gdouble

synth.gain.

Flags: Read / Write

Allowed values: [0,10]

Default value: 0.2

### The `“synth-ladspa-active”` property

      “synth-ladspa-active”      gint

synth.ladspa.active.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

### The `“synth-midi-bank-select”` property

      “synth-midi-bank-select”   gchar *

synth.midi-bank-select.

Flags: Read / Write

Default value: "gs"

### The `“synth-midi-channels”` property

      “synth-midi-channels”      gint

synth.midi-channels.

Flags: Read / Write

Allowed values: [16,256]

Default value: 16

### The `“synth-min-note-length”` property

      “synth-min-note-length”    gint

synth.min-note-length.

Flags: Read / Write

Allowed values: [0,65535]

Default value: 10

### The `“synth-overflow-age”` property

      “synth-overflow-age”       gdouble

synth.overflow.age.

Flags: Read / Write

Allowed values: [-10000,10000]

Default value: 1000

### The `“synth-overflow-percussion”` property

      “synth-overflow-percussion” gdouble

synth.overflow.percussion.

Flags: Read / Write

Allowed values: [-10000,10000]

Default value: 4000

### The `“synth-overflow-released”` property

      “synth-overflow-released”  gdouble

synth.overflow.released.

Flags: Read / Write

Allowed values: [-10000,10000]

Default value: -2000

### The `“synth-overflow-sustained”` property

      “synth-overflow-sustained” gdouble

synth.overflow.sustained.

Flags: Read / Write

Allowed values: [-10000,10000]

Default value: -1000

### The `“synth-overflow-volume”` property

      “synth-overflow-volume”    gdouble

synth.overflow.volume.

Flags: Read / Write

Allowed values: [-10000,10000]

Default value: 500

### The `“synth-parallel-render”` property

      “synth-parallel-render”    gint

synth.parallel-render.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“synth-polyphony”` property

      “synth-polyphony”          gint

synth.polyphony.

Flags: Read / Write

Allowed values: [1,65535]

Default value: 256

### The `“synth-reverb-active”` property

      “synth-reverb-active”      gint

synth.reverb.active.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“synth-sample-rate”` property

      “synth-sample-rate”        gdouble

synth.sample-rate.

Flags: Read / Write

Allowed values: [8000,96000]

Default value: 44100

### The `“synth-threadsafe-api”` property

      “synth-threadsafe-api”     gint

synth.threadsafe-api.

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

### The `“synth-verbose”` property

      “synth-verbose”            gint

synth.verbose.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0