SOURCE
ssiaudio.dll

SUMMARY
WavWriter WavWriter
WavReader WavReader
WavProvider WavProvider
VoiceActivityVerifier VoiceActivityVerifier
VoiceActivitySender VoiceActivitySender
STKAudioMixer STKAudioMixer
SNRatio SNRatio
PreEmphasis PreEmphasis
AudioPlayer AudioPlayer
AudioNoiseGate AudioNoiseGate
AudioMono AudioMono
AudioLpc AudioLpc
AudioLoopBack AudioLoopBack
AudioIntensity AudioIntensity
AudioConvert AudioConvert
AudioActivity AudioActivity
Audio Audio

DETAILS
WavWriter
  WavWriter  CONSUMER
 
           Stores an audio stream to a wav file.
 
             +  path   CHAR   1024   ''   LOCK   file path (empty for stdout) 
             +  overwrite   BOOL   1   'false'   LOCK   overwrite file if it already exists (otherwise a unique path will be created) 
             +  keepEmpty   BOOL   1   'true'   LOCK   store stream even if it is empty 
             +  chunks   BOOL   1   'false'   LOCK   write each chunk to a new file (chunk number will be added to path) 
             +  chunksCountFrom   UINT   1   '1'   LOCK   begin numbering from here (if chunks turned on) 
 
WavReader
  WavReader  SENSOR
 
           Reads in a wav file from disk and streams it as a mono or stereo audio waveform.
 
             +  path   CHAR   1024   ''   LOCK   filepath 
             +  block   DOUBLE   1   '0.10000'   LOCK   block size in seconds 
             +  blockInSamples   UINT   1   '0'   LOCK   block size in samples (overwrites block if > 0) 
             +  offset   DOUBLE   1   '0.00000'   LOCK   offset in seconds 
             +  offsetInSamples   UINT   1   '0'   LOCK   offset in samples (overwrites offset if > 0) 
             +  run   BOOL   1   'false'   LOCK   best effort delivery 
             +  scale   BOOL   1   'true'   LOCK   scale to interval [-1..1] 
             +  loop   BOOL   1   'true'   LOCK   loop file 
 
           Available channels:
 
             +  audio   A mono or stereo waveform either as a stream of short values in range [-32768 32767] or float values in range [-1.0 1.0] 
 
WavProvider
  WavProvider  PROVIDER
 
           Provides an audio stream to a wav file
 
             +  path   CHAR   1024   ''   LOCK   file path (empty for stdout) 
 
VoiceActivityVerifier
  VoiceActivityVerifier  CONSUMER
 
           Verifies if an activity event is voiced.
 
             +  sname   CHAR   1024   'audio'   LOCK   name of sender 
             +  ename   CHAR   1024   'vadok'   LOCK   name of event 
             +  threshold   UINT   1   '1073741824'   LOCK   event is verified if threshold is exceeded (normalized squared sum of lpc coefficients) 
             +  from   UINT   1   '1'   LOCK   first lpc index to consider 
             +  to   UINT   1   '6'   LOCK   last lpc index to consider 
             +  method   CHAR   1024   'acf'   LOCK   This option sets the lpc method to use. Choose between: 'acf' acf (autocorrelation) method with Levinson-Durbin algorithm , 'burg' Burg method (N. Anderson (1978)) 
             +  p   UINT   1   '8'   LOCK   Predictor order (= number of lpc coefficients) 
             +  saveLPCoeff   BOOL   1   'true'   LOCK   true = save LP coefficients to output 
             +  lpGain   BOOL   1   'false'   LOCK   true = save lpc gain (error) in output vector 
             +  saveRefCoeff   BOOL   1   'false'   LOCK   true = save reflection coefficients to output 
             +  residual   BOOL   1   'false'   LOCK   true = compute lpc residual signal and store in output frame 
             +  forwardFilter   BOOL   1   'false'   LOCK   true = apply forward instead of inverse filter when computing residual 
             +  lpSpectrum   BOOL   1   'false'   LOCK   true = compute lp spectrum using 'lpSpecDeltaF' as frequency resolution or 'lpSpecBins' bins 
             +  lpSpecDeltaF   FLOAT   1   '10.00000'   LOCK   frequency resolution of lp spectrum (only applicable if 'lpSpectrum=true') 
             +  lpSpecBins   UINT   1   '100'   LOCK   number of bins to compute lp spectrum for (overrides lpSpecDeltaF) (only applicable if 'lpSpectrum=true') 
             +  lsp   BOOL   1   'false'   LOCK   compute LSP (line spectral pairs) from LPC coefficients 
 
VoiceActivitySender
  VoiceActivitySender  FEATURE
 
           Determines voice activity in a raw audio signal
 
             +  method   INT   1   '0'   LOCK   Activity method (0=loudness, 1=intensity, 2=signal-to-noise ratio 
             +  threshold   FLOAT   1   '0.05000'   LOCK   Threshold to determine activity 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  hard   BOOL   1   'false'   LOCK   consider all dimensions 
             +  hangin   UINT   1   '3'   LOCK   # of non-zero values before onset is detected 
             +  hangout   UINT   1   '10'   LOCK   # of non-zero values before offset is detected 
             +  mindur   DOUBLE   1   '0.50000'   LOCK   minimum duration in seconds 
             +  maxdur   DOUBLE   1   '5.00000'   LOCK   maximum duration in seconds (0 to turn off) 
             +  incdur   DOUBLE   1   '0.00000'   LOCK   duration in seconds for sending incremental events (0 to turn off) 
             +  loffset   DOUBLE   1   '0.00000'   LOCK   lower offset in seconds (will be substracted from event start time) 
             +  uoffset   DOUBLE   1   '0.00000'   LOCK   upper offset in seconds (will be added to event end time) 
             +  skip   BOOL   1   'false'   LOCK   skip if max duration is exceeded 
             +  sname   CHAR   1024   'audio'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'vad'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  eager   BOOL   1   'false'   LOCK   start event is sent as soon as possible event is triggered 
             +  empty   BOOL   1   'true'   LOCK   send as empty event 
             +  string   CHAR   1024   ''   LOCK   default string (if empty == false) 
 
STKAudioMixer
  STKAudioMixer  FILTER
 
           Mixes incoming audio signals
 
 
SNRatio
  SNRatio  FEATURE
 
           Computes signal-to-noise ratio of input stream.
 
             +  thresh   FLOAT   1   '0.00000'   LOCK   values below thresh are set to zero. 
 
PreEmphasis
  PreEmphasis  FILTER
 
           This component performs pre- and de-emphasis of speech signals using a 1st order difference equation: y(t) = x(t) - k*x(t-1) (de-emphasis: y(t) = x(t) + k*x(t-1)).
 
             +  de   BOOL   1   'false'   LOCK   De-emphasis instead of pre-emphasis (i.e. y[n] = x[n] + k*x[n-1]) 
             +  k   FLOAT   1   '0.97000'   LOCK   The pre-emphasis coefficient k in y[n] = x[n] - k*x[n-1]. 
 
AudioPlayer
  AudioPlayer  CONSUMER
 
           Opens an audio output device for playback of a mono or stereo waveform.
 
             +  device   INT   1   '-1'   LOCK   audio device id 
             +  remember   BOOL   1   'true'   LOCK   remember selected audio device 
             +  numBuffers   UINT   1   '8'   LOCK   the number of audio buffers (blocks) to be used in parallel for audio playback 
             +  bufferSize   DOUBLE   1   '0.10000'   LOCK   the size of the audio buffers (blocks) in seconds. Must be >= audio block input 
             +  bufferSizeSamples   UINT   1   '0'   LOCK   the size of the audio buffers (blocks) in samples (overwrites size if > 0) 
 
AudioNoiseGate
  AudioNoiseGate  FILTER
 
           Computes Intensity and/or Loudness (narrow band approximation)
 
             +  bypass   BOOL   1   'false'   FREE   bypass 
             +  threshold   FLOAT   1   '-70.00000'   FREE   threshold (dB) 
             +  attack   UINT   1   '30'   FREE   attack (ms) 
             +  hold   UINT   1   '500'   FREE   hold (ms) 
             +  decay   UINT   1   '1000'   FREE   decay (ms) 
             +  range   FLOAT   1   '-90.00000'   FREE   range (dB) 
 
AudioMono
  AudioMono  FILTER
 
           Converts audio signal from shorts to floats or vice versa.
 
             +  normalize   BOOL   1   'true'   LOCK   Normalize sample values. 
 
AudioLpc
  AudioLpc  FEATURE
 
           This component computes linear predictive coding (LPC) coefficients from PCM frames. Burg's algorithm and the standard ACF/Durbin based method are implemented for LPC coefficient computation. The output of LPC filter coefficients, reflection coefficients, residual signal, LP spectrum and LSP is supported.
 
             +  method   CHAR   1024   'acf'   LOCK   This option sets the lpc method to use. Choose between: 'acf' acf (autocorrelation) method with Levinson-Durbin algorithm , 'burg' Burg method (N. Anderson (1978)) 
             +  p   UINT   1   '8'   LOCK   Predictor order (= number of lpc coefficients) 
             +  saveLPCoeff   BOOL   1   'true'   LOCK   true = save LP coefficients to output 
             +  lpGain   BOOL   1   'false'   LOCK   true = save lpc gain (error) in output vector 
             +  saveRefCoeff   BOOL   1   'false'   LOCK   true = save reflection coefficients to output 
             +  residual   BOOL   1   'false'   LOCK   true = compute lpc residual signal and store in output frame 
             +  forwardFilter   BOOL   1   'false'   LOCK   true = apply forward instead of inverse filter when computing residual 
             +  lpSpectrum   BOOL   1   'false'   LOCK   true = compute lp spectrum using 'lpSpecDeltaF' as frequency resolution or 'lpSpecBins' bins 
             +  lpSpecDeltaF   FLOAT   1   '10.00000'   LOCK   frequency resolution of lp spectrum (only applicable if 'lpSpectrum=true') 
             +  lpSpecBins   UINT   1   '100'   LOCK   number of bins to compute lp spectrum for (overrides lpSpecDeltaF) (only applicable if 'lpSpectrum=true') 
             +  lsp   BOOL   1   'false'   LOCK   compute LSP (line spectral pairs) from LPC coefficients 
 
AudioLoopBack
  AudioLoopBack  SENSOR
 
           Captures audio coming to a audio playback device
 
             +  scale   BOOL   1   'true'   LOCK   scale to interval [-1..1] 
 
           Available channels:
 
             +  audio   A mono or stereo waveform either as a stream of short values in range [-32768 32767] or float values in range [-1.0 1.0] 
 
AudioIntensity
  AudioIntensity  FEATURE
 
           Computes Intensity and/or Loudness (narrow band approximation)
 
             +  intensity   BOOL   1   'true'   LOCK   enables the output of intensity I (mean of squared input values multiplied by a Hamming window) 
             +  loudness   BOOL   1   'false'   LOCK   enables the output of loudness L : L = (I/I0)^0.3 ; I0 = 0.000001 (for sample values normalised to the range -1..1) 
 
AudioConvert
  AudioConvert  FILTER
 
           Converts audio signal from shorts to floats or vice versa.
 
 
AudioActivity
  AudioActivity  FEATURE
 
           Determines activity in a raw audio signal
 
             +  method   INT   1   '0'   LOCK   Activity method (0=loudness, 1=intensity, 2=signal-to-noise ratio 
             +  threshold   FLOAT   1   '0.00000'   FREE   Threshold to determine activity 
 
Audio
  Audio  SENSOR
 
           Opens an audio input device for recording and streams a mono or stereo waveform.
 
             +  device   CHAR   1024   ''   LOCK   audio device name (if empty a dialog will be shown) 
             +  remember   BOOL   1   'true'   LOCK   remember selected audio device 
             +  sr   DOUBLE   1   '16000.00000'   LOCK   sample rate in Hz 
             +  size   DOUBLE   1   '0.10000'   LOCK   block size in seconds (deprecated) 
             +  block   DOUBLE   1   '0.10000'   LOCK   block size in seconds 
             +  blockInSamples   UINT   1   '0'   LOCK   block size in samples (overwrites size if > 0) 
             +  channels   UINT   1   '1'   LOCK   number of channels (1=mono, 2=stereo) 
             +  bytes   UINT   1   '2'   LOCK   bytes per sample 
             +  scale   BOOL   1   'true'   LOCK   scale to interval [-1..1] 
             +  volume   FLOAT   1   '-1.00000'   LOCK   recording volume in range [0..1] (only applied if > 0) 
 
           Available channels:
 
             +  audio   A mono or stereo waveform either as a stream of short values in range [-32768 32767] or float values in range [-1.0 1.0] 
 


Built with Social Signal Interpretation (SSI) [v1.0.5]
(c) University of Augsburg
http://openssi.net