The cl-mixed Reference Manual

Table of Contents

The cl-mixed Reference Manual

This is the cl-mixed Reference Manual, version 2.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:15:00 2018 GMT+0.

1 Introduction

About cl-mixed

This is a bindings library to libmixed, an audio mixing and processing library.

How To

Precompiled versions of the underlying library are included in this. If you want to build it manually however, refer to the libmixed repository.

First, set up your input and output parts such as file decoders and audio systems. Handling this is not a part of libmixed. To see an example of how to incorporate them, see the test.lisp file.

Load the system through ASDF or Quicklisp:

(ql:quickload :cl-mixed)

Now you'll need to integrate your inputs and outputs with the Mixed system. In order to do that, you'll want an unpacker and a packer segment. Both of those create "packed-audio", which holds all the information about how the raw audio data is encoded in a byte buffer.

(cl-mixed:make-unpacker c-buffer bytes sample-encoding channel-count channel-layout samplerate)

If you don't already have a byte buffer from your input or output implementation, passing NIL for the c-buffer will automatically create one for you, which you can then access with data. An example call might look like this:

(cl-mixed:make-unpacker NIL 4096 :int16 2 :alternating 44100)

An optional third parameter designates the sample rate of the buffers that the source converts to or the drain converts from. This "buffer sample rate" has to be the same across all segments in a mixer pipeline. It defaults to 44100. Creating a packer looks and works exactly the same as an unpacker.

Next you'll want to create the segments that'll do the actual audio processing you want. For this example, let's create a 3D audio segment (space-mixer) and a fade effect (fader).

(cl-mixed:make-space-mixer)
(cl-mixed:make-fader :duration 5.0)

Next we'll need to create the buffers that are used to manipulate the audio internally and bind them to the appropriate inputs and outputs of our segments.

(cl-mixed:with-buffers 500 (input left right)
  (cl-mixed:connect unpacker :left fader :mono input)
  (setf (cl-mixed:output :right unpacker) right)
  (cl-mixed:connect fader :mono space-mixer 0 input)
  (cl-mixed:connect space-mixer :left packer :left left)
  (cl-mixed:connect space-mixer :right packer :right right)
  ...)

This here means we create three buffers, input, left, and right, each with a size capable of holding 500 samples. We then connect the source's left output to the fader's single input. Then we connect the right buffer to the unpacker's right output, just so that it has both outputs set. If your unpacker only has one channel, you can leave that out. If it has more, you'll have to repeat it for the other channels as well. Next we connect the fader's output as the space-mixer's first input. Finally we connect the left and right outputs of the space-mixer segment to the left and right inputs of the packer respectively. For the fader segment we can connect the same buffer to both input and output, as it is declared to work "in place". For the space-mixer segment we need distinct buffers, hence the extra input buffer.

Now we can create our segment-sequence object, which keeps the order in which to process each segment.

(cl-mixed:make-segment-sequence source fader space drain)

Finally we can move to the main processing loop, which should look as follows:

(cl-mixed:start segment-sequence)
(unwind-protect
    (loop while has-more
          do (process-source)
             (cl-mixed:mix 500 segment-sequence)
             (process-drain))
  (cl-mixed:end segment-sequence))

Where process-source and process-drain are functions that will cause your source to put samples into its buffer and drain to read out the samples from its buffer. Running this now will just give you a fade in effect, which isn't too exciting. Since we haven't actually set or changed any of the 3D audio parameters, that effect remains inaudible. Changing the loop body to read something like the following

for tt = 0 then (+ tt 0.001)
for dx = 0 then (- (* 100 (sin tt)) x)
for dz = 0 then (- (* 50 (cos tt)) z)
for x = (* 100 (sin tt)) then (+ x dx)
for z = (* 50 (cos tt)) then (+ z dz)
do (setf (cl-mixed:input-field :location 0 space-mixer) (list x 0 z))
   (setf (cl-mixed:input-field :velocity 0 space-mixer) (list dx 0 dz))
   (process-source)
   (cl-mixed:mix 500 segment-sequence)
   (process-drain)

Should cause the source to now also circle around the listener as it is fading in. If you change the tt change factor from 0.001 to something higher, it will circle faster, and the doppler effect should become more noticeable.

The following segments are included with the standard libmixed distribution:

• basic-mixer Linearly mix multiple inputs.
• delay Delay the input by a given amount of time.
• fader Fade the volume of a source in or out.
• frequency-pass Filter out low or high frequencies.
• generator Generate simple wave forms.
• ladspa Use a LADSPA plugin.
• noise Generate noise.
• pitch Shift the pitch.
• repeat Record an input and then repeat it back.
• space-mixer Mix multiple inputs as if they were in 3D space.
• volume-control Adapt the volume and pan of a stereo signal.

See the next section on how to make custom segments.

Creating Custom Segments

While it is perfectly possible to create custom segments in C and load them into your lisp image, you can also write them directly in CL. This may be desired if performance is not crucial or if you want to quickly prototype an effect before translating it to a lower-level language.

In order to create a segment in Lisp, you must subclass virtual and in the very least implement the mix method for it. Here's an example for a very primitive echo effect:

(defclass echo (cl-mixed:virtual)
  ((buffer :initform NIL :accessor buffer)
   (offset :initform 0 :accessor offset)
   (delay :initarg :delay :initform 0.2 :accessor delay)
   (falloff :initarg :falloff :initform 0.8 :accessor falloff)
   (samplerate :initarg :samplerate :initform 44100 :accessor samplerate)))

(defmethod cl-mixed:start ((echo echo))
  (setf (buffer echo) (make-array (ceiling (* (delay echo) (samplerate echo)))
                                  :element-type 'single-float
                                  :initial-element 0.0s0)))

(defmethod cl-mixed:mix (samples (echo echo))
  (let ((out (cl-mixed:data (aref (cl-mixed:outputs echo) 0)))
        (in (cl-mixed:data (aref (cl-mixed:inputs echo) 0)))
        (buf (buffer echo))
        (offset (offset echo))
        (falloff (falloff echo)))
    (loop for i from 0 below samples
          for sample = (cffi:mem-aref in :float i)
          for echo = (aref buf offset)
          do (setf (cffi:mem-aref out :float i) (+ sample echo))
             (setf (aref buf offset) (* (+ sample echo) falloff))
             (setf offset (mod (1+ offset) (length buf))))
    (setf (offset echo) offset)))

In order to achieve the echo effect we keep samples of a given duration around in a ring buffer and then decrease their potency with each iteration while adding the new samples on top. Of course, a more natural sounding echo effect would need more complicated processing than this. Regardless, this segment can now be integrated just the same as the fader segment from the above introductory code.

Concepts

Buffer

A buffer holds an array of float-encoded audio samples. Everything within libmixed deals in float samples and reads from these buffers and/or writes to these buffers. This means everything that processes audio will be able to work within the same constraints of 32-bit float encoded samples, without having to worry about different sample rates, sample encodings, or channel layouts. Buffers have a fixed number of samples that they can hold, which should typically be consistent throughout the entire system.

Packed-Audio

The packed-audio is a representation of audio data that is packed into a single array and isn't in the standard buffer format. Many libraries that decode or encode audio files, play audio back, or process audio in some other way expect a single audio sample array of a particular samplerate, sample encoding, and channel layout, rather than the standardised sample buffers that libmixed uses. The packed-audio allows you to handle the conversion from this single array, encoded format, to the buffer format of libmixed and back.

Particularly relevant are the unpacker and packer segments, which you can use to handle the edges of the pipeline where other libraries interact with libmixed.

Segment

Libmixed allows you to define a pipeline to process audio in. This pipeline -- or graph, if you will -- is pieced together by segments that exchange data between each other through buffers. Each segment has a number of inputs, outputs, and fields that you can set and get. Every input and output can also have a differing amount of applicable fields, but each must have at least the buffer field, which designates the buffer that is connected at that point. You can retrieve information about how many inputs and outputs the segment expects or supports as well as information about the fields it understands by using the info function on a segment.

Aside from the inputs, outputs, and fields, each segment has three methods that are central to the mixing of audio: start, mix, and end. start and end allow you to prepare and clean up work shortly before and after mixing has been done. This can be important for real-time audio processing that cannot afford long pauses. The mix method performs the actual mixing operation and should cause new samples to appear in the outputs' buffers.

Mixer

Mixers are segments that take a run-time variable number of inputs and mix them together to a single output per channel. Libmixed provides two standard mixers out of the box, basic-mixer and space-mixer, which should serve most needs.

Segment-Sequence

A segment-sequence simply ties together a number of segments and performs the start, mix, and end operations in the order the segments were added to the sequence. This is mostly for convenience, in order to quickly perform the actual mixing, once the pipeline has been completely assembled already.

Also See

• CFFI
• libmixed

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-mixed

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shirakumo/cl-mixed

License

Artistic

Description

Bindings to libmixed, a sound mixing and processing library.

Version

2.0.0

Dependencies

• alexandria
• cffi
• trivial-features
• trivial-garbage
• documentation-utils

Source

cl-mixed.asd (file)

Components

• package.lisp (file)
• low-level.lisp (file)
• toolkit.lisp (file)
• c-object.lisp (file)
• buffer.lisp (file)
• packed-audio.lisp (file)
• segment.lisp (file)
• mixer.lisp (file)
• segment-sequence.lisp (file)
• segments (module)
• documentation.lisp (file)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-mixed/segments

Dependency

segment-sequence.lisp (file)

Parent

cl-mixed (system)

Location

segments/

Components

• basic-mixer.lisp (file)
• delay.lisp (file)
• fader.lisp (file)
• frequency-pass.lisp (file)
• generator.lisp (file)
• ladspa.lisp (file)
• noise.lisp (file)
• packer.lisp (file)
• pitch.lisp (file)
• repeat.lisp (file)
• space-mixer.lisp (file)
• unpacker.lisp (file)
• virtual.lisp (file)
• volume-control.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-mixed.asd

Location

cl-mixed.asd

Systems

cl-mixed (system)

4.1.2 cl-mixed/package.lisp

Parent

cl-mixed (system)

Location

package.lisp

Packages

• cl-mixed
• cl-mixed-cffi

4.1.3 cl-mixed/low-level.lisp

Dependency

package.lisp (file)

Parent

cl-mixed (system)

Location

low-level.lisp

Exported Definitions

• *static* (special variable)
• buffer (class)
• buffer-data (function)
• (setf buffer-data) (function)
• buffer-from-packed-audio (function)
• buffer-size (function)
• (setf buffer-size) (function)
• buffer-to-packed-audio (function)
• clear-buffer (function)
• copy-buffer (function)
• direct-segment-data (function)
• (setf direct-segment-data) (function)
• direct-segment-end (function)
• (setf direct-segment-end) (function)
• direct-segment-free (function)
• (setf direct-segment-free) (function)
• direct-segment-get (function)
• (setf direct-segment-get) (function)
• direct-segment-get-in (function)
• (setf direct-segment-get-in) (function)
• direct-segment-get-out (function)
• (setf direct-segment-get-out) (function)
• direct-segment-info (function)
• (setf direct-segment-info) (function)
• direct-segment-mix (function)
• (setf direct-segment-mix) (function)
• direct-segment-set (function)
• (setf direct-segment-set) (function)
• direct-segment-set-in (function)
• (setf direct-segment-set-in) (function)
• direct-segment-set-out (function)
• (setf direct-segment-set-out) (function)
• direct-segment-start (function)
• (setf direct-segment-start) (function)
• error (function)
• error-string (function)
• field-info (class)
• field-info-description (function)
• (setf field-info-description) (function)
• field-info-field (function)
• (setf field-info-field) (function)
• field-info-flags (function)
• (setf field-info-flags) (function)
• field-info-type (function)
• (setf field-info-type) (function)
• field-info-type-count (function)
• (setf field-info-type-count) (function)
• free-buffer (function)
• free-segment (function)
• free-segment-sequence (function)
• make-buffer (function)
• make-segment-basic-mixer (function)
• make-segment-delay (function)
• make-segment-fade (function)
• make-segment-frequency-pass (function)
• make-segment-generator (function)
• make-segment-ladspa (function)
• make-segment-noise (function)
• make-segment-packer (function)
• make-segment-pitch (function)
• make-segment-repeat (function)
• make-segment-space-mixer (function)
• make-segment-unpacker (function)
• make-segment-volume-control (function)
• packed-audio (class)
• packed-audio-channels (function)
• (setf packed-audio-channels) (function)
• packed-audio-data (function)
• (setf packed-audio-data) (function)
• packed-audio-encoding (function)
• (setf packed-audio-encoding) (function)
• packed-audio-layout (function)
• (setf packed-audio-layout) (function)
• packed-audio-samplerate (function)
• (setf packed-audio-samplerate) (function)
• packed-audio-size (function)
• (setf packed-audio-size) (function)
• resample-cubic (function)
• resample-linear (function)
• resample-nearest (function)
• resize-buffer (function)
• samplesize (function)
• segment (class)
• segment-end (function)
• segment-get (function)
• segment-get-in (function)
• segment-get-out (function)
• segment-info (function)
• segment-info (class)
• segment-info-description (function)
• (setf segment-info-description) (function)
• segment-info-fields (function)
• (setf segment-info-fields) (function)
• segment-info-flags (function)
• (setf segment-info-flags) (function)
• segment-info-max-inputs (function)
• (setf segment-info-max-inputs) (function)
• segment-info-min-inputs (function)
• (setf segment-info-min-inputs) (function)
• segment-info-name (function)
• (setf segment-info-name) (function)
• segment-info-outputs (function)
• (setf segment-info-outputs) (function)
• segment-mix (function)
• segment-sequence (class)
• segment-sequence-add (function)
• segment-sequence-count (function)
• (setf segment-sequence-count) (function)
• segment-sequence-end (function)
• segment-sequence-mix (function)
• segment-sequence-remove (function)
• segment-sequence-segments (function)
• (setf segment-sequence-segments) (function)
• segment-sequence-size (function)
• (setf segment-sequence-size) (function)
• segment-sequence-start (function)
• segment-set (function)
• segment-set-in (function)
• segment-set-out (function)
• segment-start (function)

Internal Definitions

*here* (special variable)

4.1.4 cl-mixed/toolkit.lisp

Dependency

low-level.lisp (file)

Parent

cl-mixed (system)

Location

toolkit.lisp

Exported Definitions

• *default-samplerate* (special variable)
• error-code (method)
• (setf error-code) (method)
• mixed-error (condition)

Internal Definitions

• calloc (function)
• coerce-ctype (function)
• define-accessor (macro)
• define-callback (macro)
• define-delegated-slot-accessor (macro)
• define-field-accessor (macro)
• define-input-vector-field-accessor (macro)
• define-std-callback (macro)
• define-vector-field-accessor (macro)
• ptr->vec (function)
• removef (function)
• vec->ptr (function)
• vector-insert-pos (function)
• vector-remove (function)
• vector-remove-pos (function)
• with-cleanup-on-failure (macro)
• with-error-on-failure (macro)

4.1.5 cl-mixed/c-object.lisp

Dependency

toolkit.lisp (file)

Parent

cl-mixed (system)

Location

c-object.lisp

Exported Definitions

• c-object (class)
• free (method)
• handle (method)
• handle (method)
• (setf handle) (method)
• pointer->object (function)
• (setf pointer->object) (function)

Internal Definitions

*c-object-table* (special variable)

4.1.6 cl-mixed/buffer.lisp

Dependency

c-object.lisp (file)

Parent

cl-mixed (system)

Location

buffer.lisp

Exported Definitions

• buffer (class)
• clear (method)
• data (method)
• (setf data) (method)
• make-buffer (function)
• size (method)
• (setf size) (method)
• with-buffers (macro)

Internal Definitions

• allocate-handle (method)
• free-handle (method)

4.1.7 cl-mixed/packed-audio.lisp

Dependency

buffer.lisp (file)

Parent

cl-mixed (system)

Location

packed-audio.lisp

Exported Definitions

• channels (method)
• (setf channels) (method)
• data (method)
• (setf data) (method)
• encoding (method)
• (setf encoding) (method)
• layout (method)
• (setf layout) (method)
• make-packed-audio (function)
• packed-audio (class)
• samplerate (method)
• (setf samplerate) (method)
• size (method)
• (setf size) (method)
• (setf size) (method)

Internal Definitions

• allocate-handle (method)
• free-handle (method)
• own-data (method)

4.1.8 cl-mixed/segment.lisp

Dependency

packed-audio.lisp (file)

Parent

cl-mixed (system)

Location

segment.lisp

Exported Definitions

• connect (method)
• end (method)
• (setf field) (method)
• info (method)
• input (method)
• (setf input) (method)
• input-field (method)
• input-field (method)
• (setf input-field) (method)
• (setf input-field) (method)
• inputs (method)
• mix (method)
• output (method)
• (setf output) (method)
• output-field (method)
• output-field (method)
• (setf output-field) (method)
• (setf output-field) (method)
• outputs (method)
• segment (class)
• start (method)

Internal Definitions

• allocate-handle (method)
• decode-field-info (function)
• decode-flags (function)
• direct-info (method)
• (setf direct-info) (method)
• encode-field-info (function)
• encode-flags (function)
• free-handle (method)

4.1.9 cl-mixed/mixer.lisp

Dependency

segment.lisp (file)

Parent

cl-mixed (system)

Location

mixer.lisp

Exported Definitions

• add (method)
• input-field (method)
• (setf input-field) (method)
• mixer (class)
• source (method)
• source (method)
• sources (method)
• (setf sources) (method)
• withdraw (method)

4.1.10 cl-mixed/segment-sequence.lisp

Dependency

mixer.lisp (file)

Parent

cl-mixed (system)

Location

segment-sequence.lisp

Exported Definitions

• add (method)
• end (method)
• make-segment-sequence (function)
• mix (method)
• segment-sequence (class)
• segments (method)
• size (method)
• (setf size) (method)
• start (method)
• withdraw (method)

Internal Definitions

• allocate-handle (method)
• free-handle (method)

4.1.11 cl-mixed/segments/basic-mixer.lisp

Parent

segments (module)

Location

segments/basic-mixer.lisp

Exported Definitions

• add (method)
• basic-mixer (class)
• channels (method)
• (setf channels) (method)
• field (method)
• (setf field) (method)
• make-basic-mixer (function)
• volume (method)
• (setf volume) (method)
• withdraw (method)

4.1.12 cl-mixed/segments/delay.lisp

Parent

segments (module)

Location

segments/delay.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• delay (class)
• duration (method)
• (setf duration) (method)
• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• make-delay (function)
• samplerate (method)
• (setf samplerate) (method)

4.1.13 cl-mixed/segments/fader.lisp

Parent

segments (module)

Location

segments/fader.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• duration (method)
• (setf duration) (method)
• fade-type (method)
• (setf fade-type) (method)
• fader (class)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• from (method)
• (setf from) (method)
• make-fader (function)
• to (method)
• (setf to) (method)

4.1.14 cl-mixed/segments/frequency-pass.lisp

Parent

segments (module)

Location

segments/frequency-pass.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• cutoff (method)
• (setf cutoff) (method)
• field (method)
• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• frequency-pass (method)
• (setf frequency-pass) (method)
• frequency-pass (class)
• make-frequency-pass (function)
• samplerate (method)
• (setf samplerate) (method)

4.1.15 cl-mixed/segments/generator.lisp

Parent

segments (module)

Location

segments/generator.lisp

Exported Definitions

• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• frequency (method)
• (setf frequency) (method)
• generator (class)
• make-generator (function)
• volume (method)
• (setf volume) (method)
• wave-type (method)
• (setf wave-type) (method)

4.1.16 cl-mixed/segments/ladspa.lisp

Parent

segments (module)

Location

segments/ladspa.lisp

Exported Definitions

• field (method)
• (setf field) (method)
• ladspa (class)
• make-ladspa (function)

4.1.17 cl-mixed/segments/noise.lisp

Parent

segments (module)

Location

segments/noise.lisp

Exported Definitions

• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• make-noise (function)
• noise (class)
• noise-type (method)
• (setf noise-type) (method)
• volume (method)
• (setf volume) (method)

4.1.18 cl-mixed/segments/packer.lisp

Parent

segments (module)

Location

segments/packer.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• channels (method)
• (setf channels) (method)
• data (method)
• (setf data) (method)
• encoding (method)
• (setf encoding) (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• layout (method)
• (setf layout) (method)
• make-packer (function)
• packed-audio (method)
• packer (class)
• samplerate (method)
• (setf samplerate) (method)
• size (method)
• (setf size) (method)
• volume (method)
• (setf volume) (method)

4.1.19 cl-mixed/segments/pitch.lisp

Parent

segments (module)

Location

segments/pitch.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• make-pitch (function)
• pitch (method)
• (setf pitch) (method)
• pitch (class)
• samplerate (method)
• (setf samplerate) (method)

4.1.20 cl-mixed/segments/repeat.lisp

Parent

segments (module)

Location

segments/repeat.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• duration (method)
• (setf duration) (method)
• field (method)
• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• make-repeat (function)
• repeat (class)
• repeat-mode (method)
• (setf repeat-mode) (method)
• samplerate (method)
• (setf samplerate) (method)

4.1.21 cl-mixed/segments/space-mixer.lisp

Parent

segments (module)

Location

segments/space-mixer.lisp

Exported Definitions

• add (method)
• direction (method)
• (setf direction) (method)
• doppler-factor (method)
• (setf doppler-factor) (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• input-field (method)
• (setf input-field) (method)
• input-field (method)
• (setf input-field) (method)
• input-location (method)
• (setf input-location) (method)
• input-location (method)
• (setf input-location) (method)
• input-location (method)
• (setf input-location) (method)
• input-velocity (method)
• (setf input-velocity) (method)
• input-velocity (method)
• (setf input-velocity) (method)
• input-velocity (method)
• (setf input-velocity) (method)
• location (method)
• (setf location) (method)
• make-space-mixer (function)
• max-distance (method)
• (setf max-distance) (method)
• min-distance (method)
• (setf min-distance) (method)
• rolloff (method)
• (setf rolloff) (method)
• soundspeed (method)
• (setf soundspeed) (method)
• space-mixer (class)
• up (method)
• (setf up) (method)
• velocity (method)
• (setf velocity) (method)
• volume (method)
• (setf volume) (method)
• withdraw (method)

Internal Definitions

• attenuation (method)
• (setf attenuation) (method)

4.1.22 cl-mixed/segments/unpacker.lisp

Parent

segments (module)

Location

segments/unpacker.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• channels (method)
• (setf channels) (method)
• data (method)
• (setf data) (method)
• encoding (method)
• (setf encoding) (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• layout (method)
• (setf layout) (method)
• make-unpacker (function)
• packed-audio (method)
• samplerate (method)
• (setf samplerate) (method)
• size (method)
• (setf size) (method)
• unpacker (class)
• volume (method)
• (setf volume) (method)

4.1.23 cl-mixed/segments/virtual.lisp

Parent

segments (module)

Location

segments/virtual.lisp

Exported Definitions

• end (method)
• field (method)
• (setf field) (method)
• info (method)
• input-field (method)
• input-field (method)
• (setf input-field) (method)
• mix (method)
• output-field (method)
• output-field (method)
• (setf output-field) (method)
• start (method)
• virtual (class)

Internal Definitions

free-handle (method)

4.1.24 cl-mixed/segments/volume-control.lisp

Parent

segments (module)

Location

segments/volume-control.lisp

Exported Definitions

• bypass (method)
• (setf bypass) (method)
• field (method)
• field (method)
• field (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• make-volume-control (function)
• pan (method)
• (setf pan) (method)
• volume (method)
• (setf volume) (method)
• volume-control (class)

4.1.25 cl-mixed/documentation.lisp

Dependency

segments (module)

Parent

cl-mixed (system)

Location

documentation.lisp

5 Packages

Packages are listed by definition order.

5.1 cl-mixed

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.mixed

Use List

• cffi
• common-lisp

Exported Definitions

• *default-samplerate* (special variable)
• add (generic function)
• add (method)
• add (method)
• add (method)
• add (method)
• basic-mixer (class)
• buffer (class)
• bypass (generic function)
• bypass (method)
• (setf bypass) (method)
• bypass (method)
• (setf bypass) (method)
• bypass (method)
• (setf bypass) (method)
• bypass (method)
• (setf bypass) (method)
• bypass (method)
• (setf bypass) (method)
• bypass (method)
• (setf bypass) (method)
• bypass (method)
• (setf bypass) (method)
• bypass (method)
• (setf bypass) (method)
• (setf bypass) (generic function)
• c-object (class)
• channels (generic function)
• channels (method)
• (setf channels) (method)
• channels (method)
• (setf channels) (method)
• channels (method)
• (setf channels) (method)
• channels (method)
• (setf channels) (method)
• (setf channels) (generic function)
• clear (generic function)
• clear (method)
• connect (generic function)
• connect (method)
• cutoff (generic function)
• cutoff (method)
• (setf cutoff) (method)
• (setf cutoff) (generic function)
• data (generic function)
• data (method)
• (setf data) (method)
• data (method)
• (setf data) (method)
• data (method)
• (setf data) (method)
• data (method)
• (setf data) (method)
• (setf data) (generic function)
• delay (class)
• direction (generic function)
• direction (method)
• (setf direction) (method)
• (setf direction) (generic function)
• doppler-factor (generic function)
• doppler-factor (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (generic function)
• duration (generic function)
• duration (method)
• (setf duration) (method)
• duration (method)
• (setf duration) (method)
• duration (method)
• (setf duration) (method)
• (setf duration) (generic function)
• encoding (generic function)
• encoding (method)
• (setf encoding) (method)
• encoding (method)
• (setf encoding) (method)
• encoding (method)
• (setf encoding) (method)
• (setf encoding) (generic function)
• end (generic function)
• end (method)
• end (method)
• end (method)
• error-code (generic function)
• error-code (method)
• (setf error-code) (method)
• (setf error-code) (generic function)
• fade-type (generic function)
• fade-type (method)
• (setf fade-type) (method)
• (setf fade-type) (generic function)
• fader (class)
• field (generic function)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• field (method)
• (setf field) (generic function)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• (setf field) (method)
• free (generic function)
• free (method)
• frequency (generic function)
• frequency (method)
• (setf frequency) (method)
• (setf frequency) (generic function)
• frequency-pass (generic function)
• frequency-pass (method)
• (setf frequency-pass) (method)
• (setf frequency-pass) (generic function)
• frequency-pass (class)
• from (generic function)
• from (method)
• (setf from) (method)
• (setf from) (generic function)
• generator (class)
• handle (generic function)
• handle (method)
• handle (method)
• (setf handle) (generic function)
• (setf handle) (method)
• info (generic function)
• info (method)
• info (method)
• input (generic function)
• input (method)
• (setf input) (method)
• (setf input) (generic function)
• input-field (generic function)
• input-field (method)
• input-field (method)
• (setf input-field) (method)
• input-field (method)
• (setf input-field) (method)
• input-field (method)
• (setf input-field) (method)
• input-field (method)
• input-field (method)
• input-field (method)
• (setf input-field) (method)
• (setf input-field) (generic function)
• (setf input-field) (method)
• (setf input-field) (method)
• input-location (generic function)
• input-location (method)
• (setf input-location) (method)
• input-location (method)
• (setf input-location) (method)
• input-location (method)
• (setf input-location) (method)
• (setf input-location) (generic function)
• input-velocity (generic function)
• input-velocity (method)
• (setf input-velocity) (method)
• input-velocity (method)
• (setf input-velocity) (method)
• input-velocity (method)
• (setf input-velocity) (method)
• (setf input-velocity) (generic function)
• inputs (generic function)
• inputs (method)
• ladspa (class)
• layout (generic function)
• layout (method)
• (setf layout) (method)
• layout (method)
• (setf layout) (method)
• layout (method)
• (setf layout) (method)
• (setf layout) (generic function)
• location (generic function)
• location (method)
• (setf location) (method)
• (setf location) (generic function)
• make-basic-mixer (function)
• make-buffer (function)
• make-delay (function)
• make-fader (function)
• make-frequency-pass (function)
• make-generator (function)
• make-ladspa (function)
• make-noise (function)
• make-packed-audio (function)
• make-packer (function)
• make-pitch (function)
• make-repeat (function)
• make-segment-sequence (function)
• make-space-mixer (function)
• make-unpacker (function)
• make-volume-control (function)
• max-distance (generic function)
• max-distance (method)
• (setf max-distance) (method)
• (setf max-distance) (generic function)
• min-distance (generic function)
• min-distance (method)
• (setf min-distance) (method)
• (setf min-distance) (generic function)
• mix (generic function)
• mix (method)
• mix (method)
• mix (method)
• mixed-error (condition)
• mixer (class)
• noise (class)
• noise-type (generic function)
• noise-type (method)
• (setf noise-type) (method)
• (setf noise-type) (generic function)
• output (generic function)
• output (method)
• (setf output) (method)
• (setf output) (generic function)
• output-field (generic function)
• output-field (method)
• output-field (method)
• (setf output-field) (method)
• output-field (method)
• output-field (method)
• (setf output-field) (method)
• (setf output-field) (generic function)
• (setf output-field) (method)
• outputs (generic function)
• outputs (method)
• packed-audio (generic function)
• packed-audio (method)
• packed-audio (method)
• packed-audio (class)
• packer (class)
• pan (generic function)
• pan (method)
• (setf pan) (method)
• (setf pan) (generic function)
• pitch (generic function)
• pitch (method)
• (setf pitch) (method)
• (setf pitch) (generic function)
• pitch (class)
• pointer->object (function)
• (setf pointer->object) (function)
• repeat (class)
• repeat-mode (generic function)
• repeat-mode (method)
• (setf repeat-mode) (method)
• (setf repeat-mode) (generic function)
• rolloff (generic function)
• rolloff (method)
• (setf rolloff) (method)
• (setf rolloff) (generic function)
• samplerate (generic function)
• samplerate (method)
• (setf samplerate) (method)
• samplerate (method)
• (setf samplerate) (method)
• samplerate (method)
• (setf samplerate) (method)
• samplerate (method)
• (setf samplerate) (method)
• samplerate (method)
• (setf samplerate) (method)
• samplerate (method)
• (setf samplerate) (method)
• samplerate (method)
• (setf samplerate) (method)
• (setf samplerate) (generic function)
• segment (class)
• segment-sequence (class)
• segments (generic function)
• segments (method)
• size (generic function)
• size (method)
• (setf size) (method)
• size (method)
• (setf size) (method)
• size (method)
• (setf size) (method)
• size (method)
• (setf size) (method)
• size (method)
• (setf size) (method)
• (setf size) (generic function)
• (setf size) (method)
• soundspeed (generic function)
• soundspeed (method)
• (setf soundspeed) (method)
• (setf soundspeed) (generic function)
• source (generic function)
• source (method)
• source (method)
• (setf source) (generic function)
• sources (generic function)
• sources (method)
• (setf sources) (method)
• (setf sources) (generic function)
• space-mixer (class)
• start (generic function)
• start (method)
• start (method)
• start (method)
• to (generic function)
• to (method)
• (setf to) (method)
• (setf to) (generic function)
• unpacker (class)
• up (generic function)
• up (method)
• (setf up) (method)
• (setf up) (generic function)
• velocity (generic function)
• velocity (method)
• (setf velocity) (method)
• (setf velocity) (generic function)
• virtual (class)
• volume (generic function)
• volume (method)
• (setf volume) (method)
• volume (method)
• (setf volume) (method)
• volume (method)
• (setf volume) (method)
• volume (method)
• (setf volume) (method)
• volume (method)
• (setf volume) (method)
• volume (method)
• (setf volume) (method)
• volume (method)
• (setf volume) (method)
• (setf volume) (generic function)
• volume-control (class)
• wave-type (generic function)
• wave-type (method)
• (setf wave-type) (method)
• (setf wave-type) (generic function)
• with-buffers (macro)
• withdraw (generic function)
• withdraw (method)
• withdraw (method)
• withdraw (method)
• withdraw (method)

Internal Definitions

• *c-object-table* (special variable)
• allocate-handle (generic function)
• allocate-handle (method)
• allocate-handle (method)
• allocate-handle (method)
• allocate-handle (method)
• attenuation (generic function)
• attenuation (method)
• (setf attenuation) (method)
• (setf attenuation) (generic function)
• calloc (function)
• coerce-ctype (function)
• decode-field-info (function)
• decode-flags (function)
• define-accessor (macro)
• define-callback (macro)
• define-delegated-slot-accessor (macro)
• define-field-accessor (macro)
• define-input-vector-field-accessor (macro)
• define-std-callback (macro)
• define-vector-field-accessor (macro)
• direct-info (generic function)
• direct-info (method)
• (setf direct-info) (method)
• (setf direct-info) (generic function)
• encode-field-info (function)
• encode-flags (function)
• free-handle (generic function)
• free-handle (method)
• free-handle (method)
• free-handle (method)
• free-handle (method)
• free-handle (method)
• own-data (generic function)
• own-data (method)
• ptr->vec (function)
• removef (function)
• vec->ptr (function)
• vector-insert-pos (function)
• vector-remove (function)
• vector-remove-pos (function)
• with-cleanup-on-failure (macro)
• with-error-on-failure (macro)

5.2 cl-mixed-cffi

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.mixed.cffi

Use List

• cffi
• common-lisp

Exported Definitions

• *static* (special variable)
• buffer (class)
• buffer-data (function)
• (setf buffer-data) (function)
• buffer-from-packed-audio (function)
• buffer-size (function)
• (setf buffer-size) (function)
• buffer-to-packed-audio (function)
• clear-buffer (function)
• copy-buffer (function)
• direct-segment-data (function)
• (setf direct-segment-data) (function)
• direct-segment-end (function)
• (setf direct-segment-end) (function)
• direct-segment-free (function)
• (setf direct-segment-free) (function)
• direct-segment-get (function)
• (setf direct-segment-get) (function)
• direct-segment-get-in (function)
• (setf direct-segment-get-in) (function)
• direct-segment-get-out (function)
• (setf direct-segment-get-out) (function)
• direct-segment-info (function)
• (setf direct-segment-info) (function)
• direct-segment-mix (function)
• (setf direct-segment-mix) (function)
• direct-segment-set (function)
• (setf direct-segment-set) (function)
• direct-segment-set-in (function)
• (setf direct-segment-set-in) (function)
• direct-segment-set-out (function)
• (setf direct-segment-set-out) (function)
• direct-segment-start (function)
• (setf direct-segment-start) (function)
• error (function)
• error-string (function)
• field-info (class)
• field-info-description (function)
• (setf field-info-description) (function)
• field-info-field (function)
• (setf field-info-field) (function)
• field-info-flags (function)
• (setf field-info-flags) (function)
• field-info-type (function)
• (setf field-info-type) (function)
• field-info-type-count (function)
• (setf field-info-type-count) (function)
• free-buffer (function)
• free-segment (function)
• free-segment-sequence (function)
• make-buffer (function)
• make-segment-basic-mixer (function)
• make-segment-delay (function)
• make-segment-fade (function)
• make-segment-frequency-pass (function)
• make-segment-generator (function)
• make-segment-ladspa (function)
• make-segment-noise (function)
• make-segment-packer (function)
• make-segment-pitch (function)
• make-segment-repeat (function)
• make-segment-space-mixer (function)
• make-segment-unpacker (function)
• make-segment-volume-control (function)
• packed-audio (class)
• packed-audio-channels (function)
• (setf packed-audio-channels) (function)
• packed-audio-data (function)
• (setf packed-audio-data) (function)
• packed-audio-encoding (function)
• (setf packed-audio-encoding) (function)
• packed-audio-layout (function)
• (setf packed-audio-layout) (function)
• packed-audio-samplerate (function)
• (setf packed-audio-samplerate) (function)
• packed-audio-size (function)
• (setf packed-audio-size) (function)
• resample-cubic (function)
• resample-linear (function)
• resample-nearest (function)
• resize-buffer (function)
• samplesize (function)
• segment (class)
• segment-end (function)
• segment-get (function)
• segment-get-in (function)
• segment-get-out (function)
• segment-info (function)
• segment-info (class)
• segment-info-description (function)
• (setf segment-info-description) (function)
• segment-info-fields (function)
• (setf segment-info-fields) (function)
• segment-info-flags (function)
• (setf segment-info-flags) (function)
• segment-info-max-inputs (function)
• (setf segment-info-max-inputs) (function)
• segment-info-min-inputs (function)
• (setf segment-info-min-inputs) (function)
• segment-info-name (function)
• (setf segment-info-name) (function)
• segment-info-outputs (function)
• (setf segment-info-outputs) (function)
• segment-mix (function)
• segment-sequence (class)
• segment-sequence-add (function)
• segment-sequence-count (function)
• (setf segment-sequence-count) (function)
• segment-sequence-end (function)
• segment-sequence-mix (function)
• segment-sequence-remove (function)
• segment-sequence-segments (function)
• (setf segment-sequence-segments) (function)
• segment-sequence-size (function)
• (setf segment-sequence-size) (function)
• segment-sequence-start (function)
• segment-set (function)
• segment-set-in (function)
• segment-set-out (function)
• segment-start (function)

Internal Definitions

*here* (special variable)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *default-samplerate*

This variable holds the default sample rate used throughout.

This is set to 44100 for 44.1 kHz, which is
the standard sample rate for CD audio and should
thus be of sufficient quality for most purposes.

Package

cl-mixed

Source

toolkit.lisp (file)

Special Variable: *static*

Variable containing the path to the static directory. That directory contains the precompiled library binaries.

Package

cl-mixed-cffi

Source

low-level.lisp (file)

6.1.2 Macros

Macro: with-buffers SIZE BUFFERS &body BODY

Create a number of buffers for the duration of the body.

BUFFERS should be a list of symbols, to each of which a fresh instance of a BUFFER with a size of SAMPLES will be bound.

Package

cl-mixed

Source

buffer.lisp (file)

6.1.3 Functions

Function: buffer-data POINTER-TO-BUFFER

Function: (setf buffer-data) VALUE POINTER-TO-BUFFER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: buffer-from-packed-audio CHANNEL BUFFERS SAMPLES VOLUME

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: buffer-size POINTER-TO-BUFFER

Function: (setf buffer-size) VALUE POINTER-TO-BUFFER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: buffer-to-packed-audio BUFFERS CHANNEL SAMPLES VOLUME

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: clear-buffer BUFFER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: copy-buffer FROM TO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-data POINTER-TO-SEGMENT

Function: (setf direct-segment-data) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-end POINTER-TO-SEGMENT

Function: (setf direct-segment-end) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-free POINTER-TO-SEGMENT

Function: (setf direct-segment-free) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-get POINTER-TO-SEGMENT

Function: (setf direct-segment-get) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-get-in POINTER-TO-SEGMENT

Function: (setf direct-segment-get-in) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-get-out POINTER-TO-SEGMENT

Function: (setf direct-segment-get-out) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-info POINTER-TO-SEGMENT

Function: (setf direct-segment-info) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-mix POINTER-TO-SEGMENT

Function: (setf direct-segment-mix) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-set POINTER-TO-SEGMENT

Function: (setf direct-segment-set) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-set-in POINTER-TO-SEGMENT

Function: (setf direct-segment-set-in) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-set-out POINTER-TO-SEGMENT

Function: (setf direct-segment-set-out) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: direct-segment-start POINTER-TO-SEGMENT

Function: (setf direct-segment-start) VALUE POINTER-TO-SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: error ()

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: error-string ERROR

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: field-info-description POINTER-TO-FIELD-INFO

Function: (setf field-info-description) VALUE POINTER-TO-FIELD-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: field-info-field POINTER-TO-FIELD-INFO

Function: (setf field-info-field) VALUE POINTER-TO-FIELD-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: field-info-flags POINTER-TO-FIELD-INFO

Function: (setf field-info-flags) VALUE POINTER-TO-FIELD-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: field-info-type POINTER-TO-FIELD-INFO

Function: (setf field-info-type) VALUE POINTER-TO-FIELD-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: field-info-type-count POINTER-TO-FIELD-INFO

Function: (setf field-info-type-count) VALUE POINTER-TO-FIELD-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: free-buffer BUFFER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: free-segment SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: free-segment-sequence SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-basic-mixer CHANNELS

Create a new basic mixer, adding the given buffers as inputs.

See BASIC-MIXER
See ADD
See WITHDRAW

Package

cl-mixed

Source

basic-mixer.lisp (file)

Function: make-buffer SIZE

Create a new buffer capable of storing SIZE floats.

See BUFFER

Package

cl-mixed

Source

buffer.lisp (file)

Function: make-buffer SIZE BUFFER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-delay &rest ARGS &key TIME SAMPLERATE

Create a new delay segment.

See DELAY

Package

cl-mixed

Source

delay.lisp (file)

Function: make-fader &rest ARGS &key FROM TO TIME TYPE SAMPLERATE

Create a new volume fader segment.

See FADER

Package

cl-mixed

Source

fader.lisp (file)

Function: make-frequency-pass &rest ARGS &key PASS CUTOFF SAMPLERATE

Create a new frequency pass segment.

PASS can be either :high or :low, which will cause high and low frequencies to pass through the filter respectively.

See FREQUENCY-PASS

Package

cl-mixed

Source

frequency-pass.lisp (file)

Function: make-generator &rest ARGS &key TYPE FREQUENCY SAMPLERATE

Create a new tone generator.

See GENERATOR

Package

cl-mixed

Source

generator.lisp (file)

Function: make-ladspa &rest ARGS &key FILE INDEX SAMPLERATE &allow-other-keys

Create a new LADSPA segment.

The file must point to a valid shared library and the index should designate the requested plugin with the library.

Any additional keys are used to set the corresponding fields on the segments, allowing you to directly configure the LADSPA plugin in the same call.

See LADSPA

Package

cl-mixed

Source

ladspa.lisp (file)

Function: make-noise &rest ARGS &key TYPE

Create a new noise segment.

The type can be one of :WHITE, :PINK, :BROWN.

See NOISE

Package

cl-mixed

Source

noise.lisp (file)

Function: make-packed-audio DATA SIZE ENCODING CHANNELS LAYOUT SAMPLERATE

Create a new packed-audio object.

If DATA is NIL, then a new data buffer is allocated with SIZE number of bytes. This data buffer will be automatically freed whenever the pack is freed.

See PACKED-AUDIO

Package

cl-mixed

Source

packed-audio.lisp (file)

Function: make-packer DATA SIZE ENCODING CHANNELS LAYOUT SOURCE-SAMPLERATE &optional TARGET-SAMPLERATE

Create a new packer segment.

This automatically creates a packed-audio object to use. If you prefer to use a packed-audio object you created yourself, simply use MAKE-INSTANCE instead.

See PACKED-AUDIO
See PACKER

Package

cl-mixed

Source

packer.lisp (file)

Function: make-pitch &rest ARGS &key PITCH SAMPLERATE

Create a new pitch shifting segment.

See PITCH

Package

cl-mixed

Source

pitch.lisp (file)

Function: make-repeat &rest ARGS &key TIME SAMPLERATE

Create a new repeat segment.

The time designates the size of the internal buffer that it can repeat to the output.

See REPEAT

Package

cl-mixed

Source

repeat.lisp (file)

Function: make-segment-basic-mixer CHANNELS SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-delay TIME SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-fade FROM TO TIME TYPE SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-frequency-pass PASS CUTOFF SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-generator TYPE FREQUENCY SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-ladspa FILE INDEX SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-noise TYPE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-packer PACKED SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-pitch PITCH SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-repeat TIME SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-sequence &rest SEGMENTS

Create a new segment-sequence instance.

The segments given are added in order.

See SEGMENT-SEQUENCE

Package

cl-mixed

Source

segment-sequence.lisp (file)

Function: make-segment-space-mixer SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-unpacker PACKED SAMPLERATE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-segment-volume-control VOLUME PAN SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: make-space-mixer &rest ARGS &key SAMPLERATE UP SOUNDSPEED DOPPLER-FACTOR MIN-DISTANCE MAX-DISTANCE ROLLOFF ATTENUATION

Create a new space-mixer segment for 3D audio processing.

See SPACE-MIXER

Package

cl-mixed

Source

space-mixer.lisp (file)

Function: make-unpacker DATA SIZE ENCODING CHANNELS LAYOUT UNPACKER-SAMPLERATE &optional TARGET-SAMPLERATE

Create a new unpacker segment.

This automatically creates a packed-audi object to use. If you prefer to use a packed-audio object you created yourself, simply use MAKE-INSTANCE instead.

See PACKED-AUDIO
See UNPACKER

Package

cl-mixed

Source

unpacker.lisp (file)

Function: make-volume-control &rest ARGS &key VOLUME PAN

Create a new volume control segment.

See VOLUME-CONTROL

Package

cl-mixed

Source

volume-control.lisp (file)

Function: packed-audio-channels POINTER-TO-PACKED-AUDIO

Function: (setf packed-audio-channels) VALUE POINTER-TO-PACKED-AUDIO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: packed-audio-data POINTER-TO-PACKED-AUDIO

Function: (setf packed-audio-data) VALUE POINTER-TO-PACKED-AUDIO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: packed-audio-encoding POINTER-TO-PACKED-AUDIO

Function: (setf packed-audio-encoding) VALUE POINTER-TO-PACKED-AUDIO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: packed-audio-layout POINTER-TO-PACKED-AUDIO

Function: (setf packed-audio-layout) VALUE POINTER-TO-PACKED-AUDIO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: packed-audio-samplerate POINTER-TO-PACKED-AUDIO

Function: (setf packed-audio-samplerate) VALUE POINTER-TO-PACKED-AUDIO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: packed-audio-size POINTER-TO-PACKED-AUDIO

Function: (setf packed-audio-size) VALUE POINTER-TO-PACKED-AUDIO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: pointer->object POINTER

Accessor to the object associated with the given foreign pointer.

See *C-OBJECT-TABLE*

Package

cl-mixed

Source

c-object.lisp (file)

Writer

(setf pointer->object) (function)

Function: (setf pointer->object) OBJECT POINTER

Package

cl-mixed

Source

c-object.lisp (file)

Reader

pointer->object (function)

Function: resample-cubic IN IN-SAMPLERATE OUT OUT-SAMPLERATE OUT-SAMPLES

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: resample-linear IN IN-SAMPLERATE OUT OUT-SAMPLERATE OUT-SAMPLES

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: resample-nearest IN IN-SAMPLERATE OUT OUT-SAMPLERATE OUT-SAMPLES

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: resize-buffer SIZE BUFFER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: samplesize ENCODING

Return the number of bytes required to represent a sample in the given format.

Acceptable values are
:INT8 :UINT8 :INT16 :UINT16 :INT24 :UINT24 :INT32 :UINT32
:FLOAT :DOUBLE

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-end SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-get FIELD VALUE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-get-in FIELD LOCATION VALUE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-get-out FIELD LOCATION VALUE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info-description POINTER-TO-SEGMENT-INFO

Function: (setf segment-info-description) VALUE POINTER-TO-SEGMENT-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info-fields POINTER-TO-SEGMENT-INFO

Function: (setf segment-info-fields) VALUE POINTER-TO-SEGMENT-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info-flags POINTER-TO-SEGMENT-INFO

Function: (setf segment-info-flags) VALUE POINTER-TO-SEGMENT-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info-max-inputs POINTER-TO-SEGMENT-INFO

Function: (setf segment-info-max-inputs) VALUE POINTER-TO-SEGMENT-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info-min-inputs POINTER-TO-SEGMENT-INFO

Function: (setf segment-info-min-inputs) VALUE POINTER-TO-SEGMENT-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info-name POINTER-TO-SEGMENT-INFO

Function: (setf segment-info-name) VALUE POINTER-TO-SEGMENT-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-info-outputs POINTER-TO-SEGMENT-INFO

Function: (setf segment-info-outputs) VALUE POINTER-TO-SEGMENT-INFO

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-mix SAMPLES SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-add SEGMENT MIXER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-count POINTER-TO-SEGMENT-SEQUENCE

Function: (setf segment-sequence-count) VALUE POINTER-TO-SEGMENT-SEQUENCE

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-end MIXER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-mix SAMPLES MIXER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-remove SEGMENT MIXER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-segments POINTER-TO-SEGMENT-SEQUENCE

Function: (setf segment-sequence-segments) VALUE POINTER-TO-SEGMENT-SEQUENCE

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-size POINTER-TO-SEGMENT-SEQUENCE

Function: (setf segment-sequence-size) VALUE POINTER-TO-SEGMENT-SEQUENCE

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-sequence-start MIXER

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-set FIELD VALUE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-set-in FIELD LOCATION VALUE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-set-out FIELD LOCATION VALUE SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

Function: segment-start SEGMENT

Package

cl-mixed-cffi

Source

low-level.lisp (file)

6.1.4 Generic functions

Generic Function: add BUFFER SEGMENT

Add the object to the given collection.

For segment-sequences this means adding a segment to the sequence. For mixers this means adding another input buffer.

See SEGMENT-SEQUENCE
See MIXER

Package

cl-mixed

Methods

Method: add (NEW segment) (SEGMENT space-mixer)

Source

space-mixer.lisp (file)

Method: add (NEW segment) (SEGMENT basic-mixer)

Source

basic-mixer.lisp (file)

Method: add (SEGMENT segment) (SEQUENCE segment-sequence)

Source

segment-sequence.lisp (file)

Method: add (BUFFER buffer) (SEGMENT mixer)

Source

mixer.lisp (file)

Generic Function: bypass SEGMENT2

Accessor to whether the segment is bypassed or not.

A bypassed segment does not perform any operations when mixed. The exact effects of this varies per segment, but usually for a segment that transforms its inputs somehow this will mean that it just copies the input to the output verbatim.

Note that not all segments support bypassing. Check the :FIELDS value in the field’s info plist.

See SEGMENT
See INFO

Package

cl-mixed

Writer

(setf bypass) (generic function)

Methods

Method: bypass (SEGMENT2 volume-control)

Source

volume-control.lisp (file)

Method: bypass (SEGMENT2 unpacker)

Source

unpacker.lisp (file)

Method: bypass (SEGMENT2 repeat)

Source

repeat.lisp (file)

Method: bypass (SEGMENT2 pitch)

Source

pitch.lisp (file)

Method: bypass (SEGMENT2 packer)

Source

packer.lisp (file)

Method: bypass (SEGMENT2 frequency-pass)

Source

frequency-pass.lisp (file)

Method: bypass (SEGMENT2 fader)

Source

fader.lisp (file)

Method: bypass (SEGMENT2 delay)

Source

delay.lisp (file)

Generic Function: (setf bypass) VALUE1 SEGMENT2

Package

cl-mixed

Reader

bypass (generic function)

Methods

Method: (setf bypass) VALUE1 (SEGMENT2 volume-control)

Source

volume-control.lisp (file)

Method: (setf bypass) VALUE1 (SEGMENT2 unpacker)

Source

unpacker.lisp (file)

Method: (setf bypass) VALUE1 (SEGMENT2 repeat)

Source

repeat.lisp (file)

Method: (setf bypass) VALUE1 (SEGMENT2 pitch)

Source

pitch.lisp (file)

Method: (setf bypass) VALUE1 (SEGMENT2 packer)

Source

packer.lisp (file)

Method: (setf bypass) VALUE1 (SEGMENT2 frequency-pass)

Source

frequency-pass.lisp (file)

Method: (setf bypass) VALUE1 (SEGMENT2 fader)

Source

fader.lisp (file)

Method: (setf bypass) VALUE1 (SEGMENT2 delay)

Source

delay.lisp (file)

Generic Function: channels PACKED-AUDIO

Accessor to the number of channels encoded in the data buffer in the object.

See PACKED-AUDIO

Package

cl-mixed

Writer

(setf channels) (generic function)

Methods

Method: channels (UNPACKER unpacker)

Source

unpacker.lisp (file)

Method: channels (PACKER packer)

Source

packer.lisp (file)

Method: channels (BASIC-MIXER basic-mixer)

automatically generated reader method

Source

basic-mixer.lisp (file)

Method: channels (PACKED-AUDIO packed-audio)

Source

packed-audio.lisp (file)

Generic Function: (setf channels) VALUE0 PACKED-AUDIO

Package

cl-mixed

Reader

channels (generic function)

Methods

Method: (setf channels) VALUE0 (UNPACKER unpacker)

Source

unpacker.lisp (file)

Method: (setf channels) VALUE0 (PACKER packer)

Source

packer.lisp (file)

Method: (setf channels) NEW-VALUE (BASIC-MIXER basic-mixer)

automatically generated writer method

Source

basic-mixer.lisp (file)

Method: (setf channels) VALUE0 (PACKED-AUDIO packed-audio)

Source

packed-audio.lisp (file)