index :: misc

sfizz~

aliases: [ceammc/sfizz~]

SFZ format sample player

available since version: 0.9.4

---

arguments:

• SF soundfont path or builtin waveform name: #sine, #tri, #saw, #square, #noise
  type: symbol
  

methods:

• aftertouch aftertouch channel pressure
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • VEL MIDI velocity
    type: float
    required: True
    

• bend pitchband change
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • VALUE value in 0..0x3fff range, with 0x2000 center.
    type: int
    required: True
    

• bend:f pitchband change
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • VALUE value in -1..+1 range, with 0 center.
    type: float
    required: True
    

• bend:i pitchband change
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • VALUE value in -0x2000..0x1fff range, with 0 center.
    type: int
    required: True
    

• bendsens set pitchbend sensitivity (NOT SUPPORTED, this is stub function)
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • RANGE semitones sensitivity
    type: int
    units: semitone
    required: True
    

• cc control change
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • CC MIDI control number
    type: int
    required: True
    

  • VAL MIDI control value
    type: float
    required: True
    

• hold hold (sustain, right) pedal, ignore note release when active, release all notes when set to off.
  parameters:

  • CHAN MIDI channel
    type: int
    required: True
    

  • VAL pedal state
    type: int
    required: True
    

• legato enable or disable legato/smooth transitions between consecutive notes
  parameters:

  • CHAN MIDI channel, ignored
    type: int
    required: True
    

  • VAL pedal state
    type: int
    required: True
    

• midi send raw midi message to synth
  parameters:
  • BYTES list of bytes
    type: list
    required: True
    
• note play note
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • NOTE MIDI note
    type: int
    required: True
    

  • VEL MIDI velocity
    type: float
    required: True
    

• notes_off turn off all notes on a MIDI channel (put them into release phase)
  parameters:
  • [CHAN=0] MIDI channel
    type: int
    
• pan set channel panning
  parameters:

  • [CHAN] MIDI channel, ignored
    type: int
    

  • PAN pan value, 0: left, 8192(0x2000): center, 16383(0x3fff): right
    type: float
    required: True
    

• pan:f set channel panning
  parameters:

  • [CHAN] MIDI channel, ignored
    type: int
    

  • PAN pan value, -1: left, 0: center, 1): right
    type: float
    required: True
    

• pan:i set channel panning
  parameters:

  • [CHAN] MIDI channel, ignored
    type: int
    

  • PAN pan value, -8192(-0x2000): left, 0: center, 8191(0x1fff): right
    type: float
    required: True
    

• panic send MIDI system reset command (big red 'panic' button), turns off notes, resets controllers and restores initial basic channel configuration
  

• polytouch polytouch key pressure
  parameters:

  • [CHAN=0] MIDI channel, ignored
    type: int
    

  • NOTE MIDI note
    type: int
    required: True
    

  • VEL MIDI velocity
    type: float
    required: True
    

• prog program change
  parameters:

  • [CHAN=0] MIDI channel, if zero or ommited set for all channels
    type: int
    

  • PGM program number
    type: int
    required: True
    

• reset reset all synth channels
  

• soft soft (left) pedal, activate the soft strike effect
  parameters:

  • CHAN MIDI channel, ignored
    type: int
    required: True
    

  • VAL pedal state
    type: int
    required: True
    

• sostenuto sostenuto (middle) pedal, hold notes pressed before pedal activation, new notes are passed untouched. Release holded notes when set to off
  parameters:

  • CHAN MIDI channel, ignored
    type: int
    required: True
    

  • VAL pedal state
    type: int
    required: True
    

• sound_off immediately stop all notes on a MIDI channel (skips release phase).
  parameters:
  • [CHAN=0] MIDI channel
    type: int
    
• tune:12 set octave tuning program in cents deviations
  parameters:

  • BANK tuning bank (not related to MIDI instrument bank)
    type: int
    required: True
    

  • PRESET tuning preset (not related to MIDI instrument program)
    type: int
    required: True
    

  • TUNES list of scale deviations from 12TET in cents
    type: list
    required: True
    

• tunesel select tuning bank and preset
  parameters:

  • BANK tuning bank (not related to MIDI instrument bank)
    type: int
    required: True
    

  • PRESET tuning preset (not related to MIDI instrument program)
    type: int
    required: True
    

properties:

• @sf Get/set soundfont path or builtin waveform name: #sine, #tri, #saw, #square, #noise
  type: symbol
  

• @poly Get/set max number of voices
  type: int
  range: 1..256
  default: 64
  

• @avoices (readonly) Get number midi channels
  type: int
  default: 0
  

• @freq Get/set A4 standard tuning
  type: float
  units: Hz
  default: 440
  

• @key_labels (readonly) Get dict of control key labels
  type: atom
  default: []
  

• @cc_labels (readonly) Get dict of controller labels
  type: atom
  default: []
  

• @gain Get/set output gain (same as @value but in amp units)
  type: float
  range: 0..16
  default: 0.429
  

• @volume Get/set output volume (same as @gain but in db)
  type: float
  units: db
  range: -60..10
  default: -7.35
  

inlets:

• load mod file
  type: control

outlets:

• left channel and property output
  type: audio
• right channel
  type: audio

keywords:

mod player midi soundfont fluid

Authors: Serge Poltavsky

License: GPL3 or later