./src/rm-soundfile-mode.lsp

render-mode/soundfile-mode [ Render Modes ]

[ Top ] [ render-mode ] [ Render Modes ]

Name

 soundfile-mode

File

 rm-soundfile-mode.lsp

Description

 A basic render-mode for sampled sounds. The soundfiles linked to in the
 soundfile-slot of events will be placed in time. If soundfile is a
 soundfile-object an has a duration and/or start-time, it will be cut
 by these values first.

 If an amplitude is given, the sound will be scaled by that amplitude.

 When src = t (the default) and the soundfile is a soundfile-object 
 with a given pitch and the event has a pitch, the resulting sound will
 be sped up or slowed down using sample-rate-conversion, with the 
 soundfiles pitch as reference and the events pitch as target.

 When the protagonist has a non-zero expansion, it is considered to
 represent an array of multiple loudspeakers. Events are placed and scaled
 on each channel depending on their spatial position. An expansion of nil 
 or 0 will result in a mono-file, a 1-dimensional protagonist will
 result in a stereo-file, a 2-dimensional protagonist will result in a
 4-channel file, and so forth (2^dims-protagonist = channels).

Output Format

 :sound

Required Slots

 soundfile, duration, start-time

Optional Slots

 pitch, amplitude, location, expansion

Options

 src (default: t)
 srt-width (default: 5, depth of src)
 srate (default: 44100)

Dependencies

 :clm

Synopsis

#+clm
(make-render-mode soundfile-mode :sound
                  :required-slots
                  (soundfile duration start-time)
                  :optional-slots
                  (pitch amplitude)
                  :options
                  ((src t) (srt-width 5) (srate 44100))
                  :required-packages (:clm)