index :: array

array.grainer~

array granulator

available since version: 0.9.2

---

information

Grain properties: @at - grain position in source array (in samples) @l - grain length (in samples) @amp - grain amplitude in 0..256 range @s - grain speed in -10..10 range @p - grain pan in 0..1 range @w - grain window: rect, tri or hann @tb - time before grain start (in samples) @ta - time after grain done (in samples) @r - grain number of repeats (-1: infinite) @tag - grain tag

arguments:

• ARRAY array name
  type: symbol
  

methods:

• align align grain(s) to onset
  parameters:
  • [SUBJ] if '*' or omitted: align all grains, if '.': align finished grains only, if float: align grain with corresponding #id, if symbol: align grains with corresponding tag
    type: atom
    
• append append several grains
  parameters:

  • N number of grains
    type: int
    required: True
    

  • PROPS grain properties
    type: list
    required: True
    

• clear remove grain(s)
  parameters:
  • [SUBJ] if '*' or omitted: remove all grains, if '.': remove finished grains only, if float: remove grain with corresponding #id, if symbol: remove grains with corresponding tag
    type: atom
    
• defer defer method call until grains will finish
  parameters:

  • [N] number of finished grains to wait before calling. If not specified, treat as 1.
    type: int
    

  • METHOD method name
    type: symbol
    required: True
    

  • [ARGS] method arguments
    type: list
    

• fill fill with grains (remove all existing grains before)
  parameters:

  • N number of grains
    type: int
    required: True
    

  • PROPS grain properties
    type: list
    required: True
    

• grain create single grain
  parameters:
  • PROPS grain properties
    type: list
    required: True
    
• onsets analyze source array for onsets
  parameters:

  • [METHOD=default] onset detection method
    type: symbol
    

  • [SPACE=64] minimal space between onsets
    type: float
    units: ms
    

  • [SILENCE=-40] silence level
    type: float
    units: db
    

• pause pause (resume) grain(s)
  parameters:

  • SUBJ if '*': pause all grains, if float: pause grain with corresponding #id, if symbol: pause grains with matched tag
    type: atom
    required: True
    

  • [STATE] on/off value
    type: int
    

• permutate permutate grain positions (@ta and @tb) values
  parameters:

  • [N] number of permutations. If N>0 results N-th next permutation, N<0 - N-th previous permutation
    type: int
    

  • [TAG] if '*' or omitted: reverse positions of all grains, if '.': reverse positions of finished grains only, otherwise reverse grains with corresponding tag
    type: symbol
    

• reverse reverse grain positions (@ta and @tb) values
  parameters:
  • [TAG] if '*' or omitted: reverse positions of all grains, if '.': reverse positions of finished grains only, otherwise reverse grains with corresponding tag
    type: symbol
    
• set set grain(s) properties
  parameters:

  • SUBJ if '*': set for all grains, if float: set for grain with specified #id, if symbol: set for grains with specified tag
    type: atom
    required: True
    

  • PROPS grain properties
    type: list
    required: True
    

• shuffle shuffle grain positions (@ta and @tb) values
  parameters:
  • [TAG] if '*' or omitted: shuffle all grains, if '.': shuffle finished grains only, otherwise shuffle grains with corresponding tag
    type: symbol
    
• slice slice specified duration to specified number of grains and add them
  parameters:

  • N desired number of grains
    type: int
    required: True
    

  • [DUR] duration to slice. Positive time value expected, for example: 100ms, 1.02s, 400samp etc. Float value treat as millisecond. If not specified - use the whole source array duration
    type: atom
    

  • [GRAIN] properties of sliced grains
    type: list
    

• spread uniformly arrange grains to fill specified time space
  parameters:

  • [DUR] time space. Positive time values are expected, for example: 100ms, 1.02s, 400samp etc. Float value treat as millisecond. If not specified - use the whole source array duration
    type: atom
    

  • [TAG] if '*' or omitted: spread all grains, if '.': spread finished grains only, otherwise spread grains with corresponding tag
    type: symbol
    

properties:

• @array Get/set array name
  type: symbol
  

• @sync Get/set grain sync mode. If 'none': start grains right after they are finished, if 'int': start grains after specified interval (@tsync).
  type: symbol
  enum: none, int, ext
  default: none
  

• @tsync Get/set grain sync interval
  type: float
  units: ms
  min value: 1
  default: 50
  

• @prob Get/set grain start probability in internal or external sync mode. ('int' or 'ext')
  type: float
  range: 0..1
  default: 1
  

inlets:

• control inlet
  type: control

outlets:

• left output
  type: audio
• right output
  type: audio

keywords:

array grain particle granular

See also: [array.each]

Authors: Serge Poltavsky

License: GPL3 or later