index :: env

envelope

aliases: [ceammc/envelope], [ceammc/env], [env]

Envelope data type

available since version: 0.5

---

information

Data type for sound envelope. Contains points specified by time and value. Points could have stop property - to execute oly part of envelope and stop on this point. So multisegment envelopes could be created Point also has segment type property, that defines following segment curve - it could be step, line (default) or exp (exponential) Exponential segment also has curve property: if 0 - (linear) <0 (concave, negatively curved) >0 (convex, positively curved)

arguments:

• adsr ADSR envelope: attack(ms), decay(ms), sustain(%), release(ms)
  type: list
  

• asr ASR envelope: attack(ms), release(ms) - with sustain stop point
  type: list
  

• ar AR envelope: attack(ms), release(ms)
  type: list
  

• eadsr exponential ADSR envelope: attack(ms), attack_curve, decay(ms), decay_curve, sustain(%), release(ms), release_curve
  type: list
  

• easr exponential ASR envelope: attack(ms), attack_curve, release(ms), release_curve

• with sustain stop point
  type: list
  

• ear exponential ASR envelope: attack(ms), attack_curve, release(ms), release_curve
• no sustain point
  type: list
  

methods:

---

multiply all envelope points to specified value
parameters:

• VALUE value
  type: float
  required: True
  

• + add specified value to all envelope points
  parameters:
  • VALUE value
    type: float
    required: True
    
• >> shift all envelope point by specified time in milliseconds
  parameters:
  • SHIFT value
    type: float
    units: ms
    required: True
    
• add_point add envelope point
  parameters:

  • TIME point time
    type: float
    units: ms
    required: True
    

  • VALUE point value
    type: float
    required: True
    

  • [IS_STOP=0] is stop point
    type: int
    

  • [TYPE=line] segment type: step, linear, exponential, sin^2 or sigmoid curve
    type: symbol
    

  • [CURVE=1] exponential curve degree: 0 (linear) <0 (concave, negatively curved) >0 (convex, positively curved)
    type: float
    

• add_seg add segment to the end of envelope. On empty envelope adds start point at 0ms and 0 value
  parameters:

  • TYPE segment type
    type: symbol
    required: True
    

  • LENGTH segment length
    type: float
    units: ms
    required: True
    

  • VALUE end segment value
    type: float
    required: True
    

  • [CURVE=0] curve (for exp and sigmoid type)
    type: float
    

• adsr creates ADSR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • DECAY decay time
    type: float
    units: ms
    required: True
    

  • SUSTAIN sustain level
    type: float
    units: %
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

• ar creates AR envelope without stop points
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

• asr creates ASR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

• clear remove all envelope points
  

• eadsr creates exponential ADSR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • ATTACK_CURVE attack segment curve
    type: float
    required: True
    

  • DECAY decay time
    type: float
    units: ms
    required: True
    

  • DECAY_CURVE decay segment curve
    type: float
    required: True
    

  • SUSTAIN sustain level
    type: float
    units: %
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

  • RELEASE_CURVE release segment curve
    type: float
    required: True
    

• ear creates exponential AR envelope without stop points
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • ATTACK_CURVE attack segment curve
    type: float
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

  • RELEASE_CURVE release segment curve
    type: float
    required: True
    

• easr creates exponential AR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • ATTACK_CURVE attack segment curve
    type: float
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

  • RELEASE_CURVE release segment curve
    type: float
    required: True
    

• exp creates exponential-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • CURVE0 segment curve
    type: float
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [CURVE1] segment curve
    type: float
    

  • [VAL2] value
    type: float
    

• line creates line-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [VAL2] value
    type: float
    

• remove_point remove envelope point by specified time
  parameters:
  • IDX point index
    type: int
    required: True
    
• set_point set point time and value
  parameters:

  • IDX point index
    type: int
    required: True
    

  • TIME point time
    type: float
    units: ms
    required: True
    

  • VALUE point value
    type: int
    required: True
    

  • [IS_STOP=0] stop point
    type: int
    

• set_point_time set point time
  parameters:

  • IDX point index
    type: int
    required: True
    

  • TIME point time
    type: float
    units: ms
    required: True
    

• set_point_value set point time
  parameters:

  • IDX point index
    type: int
    required: True
    

  • VALUE point value
    type: int
    required: True
    

• set_seg_type set segment type
  parameters:

  • IDX segment index, starting from 0
    type: int
    required: True
    

  • TYPE segment type
    type: symbol
    required: True
    

• set_stop_point set stop-point
  parameters:

  • IDX point index
    type: int
    required: True
    

  • IS_STOP stop point
    type: int
    required: True
    

• sigmoid creates sigmoid-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • CURVE0 segment curve
    type: float
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [CURVE1] segment curve
    type: float
    

  • [VAL2] value
    type: float
    

• sin2 creates quadratic sine-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [VAL2] value
    type: float
    

• step creates step-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 step length
    type: float
    units: ms
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [VAL2] value
    type: float
    

properties:

• @npoints (readonly) Get number of points
  type: int
  min value: 0
  default: 0
  

• @length (readonly) Get total envelope time length
  type: float
  units: ms
  min value: 0
  default: 0
  

• @points (readonly) Get list of point times (ms)
  type: list
  

• @values (readonly) Get list of point values
  type: list
  

• @stops (readonly) Get list of stop points
  type: list
  

inlets:

• outputs current envelope
  type: control

outlets:

• data output
  type: control

keywords:

envelope

See also: [env->array] [env->vline]

Authors: Serge Poltavsky

License: GPL3 or later