SOX-PROCESS

[GENERIC-FUNCTION]


OM-SoX
Function Reference
ARGUMENTS:
  - sox-input Audio input to be processed [sound, path, string/pipe, sox-input]  
  - sox-effect Sox-effect to be applied to audio input [string] [default = ""]
&key
 
  - output Output type (new file, replace file, pipe, or realtime) [string]. Also accepts directory, filename, filepath [path] [default = "realtime"]
  - filetype Filetype of produced audio [string]  
  - samplerate Samplerate of produced audio [string]  
  - bitdepth Bitdepth of produced audio [number]  
  - recursive recursive (when 'on' applies processing recursively to audio) [symbol] [default = off]
  - batch-mode Mode for batch-processing (break, repeat, cycle) [symbol] [default = "break"]

Description:

Main audio processing function for OM-SoX. Takes audio provided in <sox-input> and processes it with sox-effects provided in <sox-effect>.

<output> determines whether output is to be rendered into
a) new file,
b) replace the input file,
c) create a sox-command as a pipe (for further processing),
d) play back in realtime through audio device.

Alternatively, a filename, directory, or path can be provided which will write an audio file to the given destination.
It is also posisble to connect a function/patch in lambda mode, which (if available) will receive the path of <sox-input> as first argument.
This can be used to algorithmically name output files (e.g. in batch processes).

Optionally, the audio output <filetype> can be specified, as well as the <samplerate> and <bitdepth> (default: same as input).
<recursive> is an experimental option allowing to apply a sox-effect recursively to audio input (e.g. trimming).
<batch-mode> determines the behaviour when processing lists of sox-inputs and sox-effects that differ in length.



Auto doc generation by OpenMusic 6.7 © 2011 IRCAM