index :: synth

synth.fgrain~

file granulator from STK

available since version: 0.6

---

methods:

• open open a monophonic soundfile to be "granulated". Only WAV and AIFF formats are supported.
  parameters:
  • [PATH] path to file
    type: symbol
    
• reset reset the file pointer and all existing grains to the file start
  

properties:

• @file Get/set path file to granulate. Only WAV and AIFF formats are supported.
  type: symbol
  

• @voices Get/set number of simultaneous grain "voices" to use
  type: int
  range: 0..200
  default: 1
  

• @stretch Get/set stretch factor used for grain playback (1 - 1000). Granular synthesis allows for time-stetching without affecting the original pitch of a sound. A stretch factor of 4 will produce a resulting sound of length 4 times the orignal sound. The default parameter of 1 produces no stretching.
  type: int
  range: 1..1000
  default: 1
  

• @random Get/set factor used when setting individual grain parameters. This random factor is applied when all grain state durations are calculated. If set to 0.0, no randomness occurs. When @random=0.5, a grain segment of length duration will be randomly augmented by up to +-duration seconds (i.e., a 30 millisecond length will be augmented by an extra length of up to +15 or -15 milliseconds)
  type: float
  range: 0..0.97
  default: 0.1
  

• @gramp Get/set grain ramp. For values of @gramp greater than zero, a linear envelope will be applied to each grain. If @gramp = 100, the resultant grain "window" is triangular while @gramp = 50 produces a trapezoidal window.
  type: int
  units: %
  range: 1..100
  default: 50
  

• @gdur Get/set grain duration
  type: int
  units: ms
  min value: 1
  default: 30
  

• @goffset Get/set offset parameter that controls grain pointer jumps between enveloped grain segments.
  type: int
  units: ms
  min value: 0
  default: 0
  

• @gdelay Get/set delay parameter that causes grain calculations to pause between grains
  type: int
  units: ms
  min value: 0
  default: 0
  

inlets:

• control inlet
  type: control

outlets:

• 
  type: audio

keywords:

grain

Authors: Serge Poltavsky

License: GPL3 or later