The also-alsa Reference Manual

Table of Contents

The also-alsa Reference Manual

This is the also-alsa Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:01:48 2021 GMT+0.

1 Introduction

Basic ALSA bindings for Common Lisp

A small subset of ALSA interface for Common Lisp.

PCM streams are encapsulated in ALSO-ALSA:PCM-STREAM instances.

To play random noise on one channel of default stereo device:

(defconstant +buffer-size+ 256)
(defconstant +sample-rate+ 8000)
(defconstant +channels+ 2)

(also-alsa:with-alsa-device (pcm "sysdefault" +buffer-size+ '(signed-byte 16) :direction :output
				 :channels-count +channels+ :sample-rate +sample-rate+)
  (also-alsa:alsa-start pcm)
  (loop repeat 2 do
       (loop with buffer = (also-alsa:buffer pcm)
	  for pos from 0 below (* +channels+ (also-alsa:buffer-size pcm)) by (* 2 +channels+)
	  for sample = (coerce (- (random 65535) 32767) '(signed-byte 16)) do
	    (setf (aref buffer pos) (logand sample #xff))
	    (setf (aref buffer (1+ pos)) (logand (ash sample -8) #xff))
	    (multiple-value-bind (avail delay) (also-alsa:get-avail-delay pcm)
	      (also-alsa:alsa-write pcm)))))

2 Systems

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

2.1 also-alsa

Author

Eugene Zaikonnikov <eugene@funcall.org>

License

LGPL

Description

Basic ALSA bindings for Common Lisp

Dependency

cffi

Source

also-alsa.asd (file)

Components

• package.lisp (file)
• also-alsa.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 also-alsa.asd

Location

also-alsa.asd

Systems

also-alsa (system)

3.1.2 also-alsa/package.lisp

Parent

also-alsa (system)

Location

package.lisp

Packages

also-alsa

3.1.3 also-alsa/also-alsa.lisp

Dependency

package.lisp (file)

Parent

also-alsa (system)

Location

also-alsa.lisp

Exported Definitions

• alsa-close (method)
• alsa-element-type (function)
• alsa-open (function)
• alsa-read (method)
• alsa-reopen (generic function)
• alsa-reopen (method)
• alsa-start (method)
• alsa-wait (method)
• alsa-write (method)
• buffer (method)
• buffer-size (method)
• contents-to-lisp (method)
• direction (method)
• drain (method)
• element-type (method)
• get-avail-delay (method)
• get-delay (method)
• pcm-format (method)
• pcm-stream (class)
• ref (method)
• (setf ref) (method)
• with-alsa-device (macro)

Internal Definitions

• +epipe+ (constant)
• alsa-open-2 (function)
• channels-count (method)
• deref (function)
• device (method)
• ensure-success (function)
• handle (method)
• params (method)
• sample-rate (method)
• snd-pcm-avail-delay (function)
• snd-pcm-close (function)
• snd-pcm-delay (function)
• snd-pcm-drain (function)
• snd-pcm-drop (function)
• snd-pcm-hw-params (function)
• snd-pcm-hw-params-any (function)
• snd-pcm-hw-params-free (function)
• snd-pcm-hw-params-get-period-size (function)
• snd-pcm-hw-params-malloc (function)
• snd-pcm-hw-params-set-access (function)
• snd-pcm-hw-params-set-channels (function)
• snd-pcm-hw-params-set-format (function)
• snd-pcm-hw-params-set-rate (function)
• snd-pcm-open (function)
• snd-pcm-prepare (function)
• snd-pcm-readi (function)
• snd-pcm-start (function)
• snd-pcm-state (function)
• snd-pcm-sw-params (function)
• snd-pcm-sw-params-current (function)
• snd-pcm-sw-params-get-start-threshold (function)
• snd-pcm-sw-params-malloc (function)
• snd-pcm-sw-params-set-avail-min (function)
• snd-pcm-sw-params-set-start-threshold (function)
• snd-pcm-wait (function)
• snd-pcm-writei (function)
• snd-strerror (function)
• status (method)
• (setf status) (method)
• swparams (method)
• to-alsa-format (function)
• with-alsa-buffer (macro)

4 Packages

Packages are listed by definition order.

4.1 also-alsa

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• alsa-close (generic function)
• alsa-close (method)
• alsa-element-type (function)
• alsa-open (function)
• alsa-read (generic function)
• alsa-read (method)
• alsa-reopen (generic function)
• alsa-reopen (method)
• alsa-start (generic function)
• alsa-start (method)
• alsa-wait (generic function)
• alsa-wait (method)
• alsa-write (generic function)
• alsa-write (method)
• buffer (generic function)
• buffer (method)
• buffer-size (generic function)
• buffer-size (method)
• contents-to-lisp (generic function)
• contents-to-lisp (method)
• direction (generic function)
• direction (method)
• drain (generic function)
• drain (method)
• element-type (generic function)
• element-type (method)
• get-avail-delay (generic function)
• get-avail-delay (method)
• get-delay (generic function)
• get-delay (method)
• pcm-format (generic function)
• pcm-format (method)
• pcm-stream (class)
• ref (generic function)
• ref (method)
• (setf ref) (method)
• (setf ref) (generic function)
• with-alsa-device (macro)

Internal Definitions

• +epipe+ (constant)
• alsa-open-2 (function)
• channels-count (generic function)
• channels-count (method)
• deref (function)
• device (generic function)
• device (method)
• ensure-success (function)
• handle (generic function)
• handle (method)
• params (generic function)
• params (method)
• sample-rate (generic function)
• sample-rate (method)
• snd-pcm-avail-delay (function)
• snd-pcm-close (function)
• snd-pcm-delay (function)
• snd-pcm-drain (function)
• snd-pcm-drop (function)
• snd-pcm-hw-params (function)
• snd-pcm-hw-params-any (function)
• snd-pcm-hw-params-free (function)
• snd-pcm-hw-params-get-period-size (function)
• snd-pcm-hw-params-malloc (function)
• snd-pcm-hw-params-set-access (function)
• snd-pcm-hw-params-set-channels (function)
• snd-pcm-hw-params-set-format (function)
• snd-pcm-hw-params-set-rate (function)
• snd-pcm-open (function)
• snd-pcm-prepare (function)
• snd-pcm-readi (function)
• snd-pcm-start (function)
• snd-pcm-state (function)
• snd-pcm-sw-params (function)
• snd-pcm-sw-params-current (function)
• snd-pcm-sw-params-get-start-threshold (function)
• snd-pcm-sw-params-malloc (function)
• snd-pcm-sw-params-set-avail-min (function)
• snd-pcm-sw-params-set-start-threshold (function)
• snd-pcm-wait (function)
• snd-pcm-writei (function)
• snd-strerror (function)
• status (generic function)
• status (method)
• (setf status) (method)
• (setf status) (generic function)
• swparams (generic function)
• swparams (method)
• to-alsa-format (function)
• with-alsa-buffer (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-alsa-device (STREAM DEVICE BUFFER-SIZE ELEMENT-TYPE &key DIRECTION SAMPLE-RATE CHANNELS-COUNT) &body BODY

Package

also-alsa

Source

also-alsa.lisp (file)

5.1.2 Functions

Function: alsa-element-type TYPE

Package

also-alsa

Source

also-alsa.lisp (file)

Function: alsa-open DEVICE BUFFER-SIZE ELEMENT-TYPE &key DIRECTION SAMPLE-RATE CHANNELS-COUNT

Package

also-alsa

Source

also-alsa.lisp (file)

5.1.3 Generic functions

Generic Function: alsa-close PCM

Package

also-alsa

Methods

Method: alsa-close (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: alsa-read PCM

Package

also-alsa

Methods

Method: alsa-read (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: alsa-reopen PCS DEVICE BUFFER-SIZE ELEMENT-TYPE &key DIRECTION SAMPLE-RATE CHANNELS-COUNT

Reopens the stream. If all parameters are the same, just keeps the exiting one.

Package

also-alsa

Source

also-alsa.lisp (file)

Methods

Method: alsa-reopen (PCS pcm-stream) DEVICE BUFFER-SIZE ELEMENT-TYPE &key DIRECTION SAMPLE-RATE CHANNELS-COUNT

Generic Function: alsa-start PCM

Package

also-alsa

Methods

Method: alsa-start (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: alsa-wait PCM &optional TIMEOUT

Package

also-alsa

Methods

Method: alsa-wait (PCM pcm-stream) &optional TIMEOUT

Source

also-alsa.lisp (file)

Generic Function: alsa-write PCM

Package

also-alsa

Methods

Method: alsa-write (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: buffer OBJECT

Package

also-alsa

Methods

Method: buffer (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: buffer-size OBJECT

Package

also-alsa

Methods

Method: buffer-size (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: contents-to-lisp PCM

Package

also-alsa

Methods

Method: contents-to-lisp (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: direction OBJECT

Package

also-alsa

Methods

Method: direction (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: drain PCM

Package

also-alsa

Methods

Method: drain (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: element-type OBJECT

Package

also-alsa

Methods

Method: element-type (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: get-avail-delay PCM

Package

also-alsa

Methods

Method: get-avail-delay (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: get-delay PCM

Package

also-alsa

Methods

Method: get-delay (PCM pcm-stream)

Source

also-alsa.lisp (file)

Generic Function: pcm-format OBJECT

Package

also-alsa

Methods

Method: pcm-format (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: ref PCM POSITION

Generic Function: (setf ref) VALUE PCM POSITION

Package

also-alsa

Methods

Method: ref (PCM pcm-stream) POSITION

Method: (setf ref) VALUE (PCM pcm-stream) POSITION

Source

also-alsa.lisp (file)

5.1.4 Classes

Class: pcm-stream ()

Package

also-alsa

Source

also-alsa.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• contents-to-lisp (method)
• alsa-read (method)
• alsa-write (method)
• alsa-wait (method)
• alsa-close (method)
• get-avail-delay (method)
• get-delay (method)
• alsa-start (method)
• drain (method)
• ref (method)
• ref (method)
• alsa-reopen (method)
• status (method)
• status (method)
• channels-count (method)
• direction (method)
• sample-rate (method)
• element-type (method)
• buffer-size (method)
• buffer (method)
• pcm-format (method)
• swparams (method)
• params (method)
• device (method)
• handle (method)

Direct slots

Slot: handle

Initform

(cffi:foreign-alloc :pointer :initial-contents (list (cffi-sys:null-pointer)))

Readers

handle (generic function)

Slot: device

Initargs

:device

Readers

device (generic function)

Slot: params

Initform

(cffi:foreign-alloc :pointer :initial-contents (list (cffi-sys:null-pointer)))

Readers

params (generic function)

Slot: swparams

Initform

(cffi:foreign-alloc :pointer :initial-contents (list (cffi-sys:null-pointer)))

Readers

swparams (generic function)

Slot: pcm-format

Initargs

:pcm-format

Initform

:snd-pcm-format-s16-le

Readers

pcm-format (generic function)

Slot: buffer

Initargs

:buffer

Readers

buffer (generic function)

Slot: buffer-size

Initargs

:buffer-size

Readers

buffer-size (generic function)

Slot: element-type

Initargs

:element-type

Readers

element-type (generic function)

Slot: sample-rate

Initargs

:sample-rate

Initform

44100

Readers

sample-rate (generic function)

Slot: direction

Initargs

:direction

Readers

direction (generic function)

Slot: channels-count

Initargs

:channels-count

Readers

channels-count (generic function)

Slot: status

Type

(or :initial :open :closed)

Initform

:initial

Readers

status (generic function)

Writers

(setf status) (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +epipe+

Package

also-alsa

Source

also-alsa.lisp (file)

5.2.2 Macros

Macro: with-alsa-buffer (BUFFER PCM &body BODY)

Package

also-alsa

Source

also-alsa.lisp (file)

5.2.3 Functions

Function: alsa-open-2 PCS

Package

also-alsa

Source

also-alsa.lisp (file)

Function: deref VAR

Package

also-alsa

Source

also-alsa.lisp (file)

Function: ensure-success VALUE

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-avail-delay PCM AVAILP DELAYP

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-close PCM

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-delay PCM DELAYP

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-drain PCM

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-drop PCM

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params PCM PARAMS

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-any PCM PARAMS

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-free PARAMS

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-get-period-size PCM VALP DIR

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-malloc DPTR

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-set-access PCM PARAMS ACCESS

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-set-channels PCM PARAMS VAL

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-set-format PCM PARAMS FORMAT

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-hw-params-set-rate PCM PARAMS VAL DIR

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-open PCM NAME STREAM MODE

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-prepare PCM

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-readi PCM BUFFER SIZE

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-start PCM

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-state PCM

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-sw-params PCM SWPARAMS

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-sw-params-current PCM SWPARAMS

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-sw-params-get-start-threshold PCM SWPARAMS PVAL

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-sw-params-malloc DPTR

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-sw-params-set-avail-min PCM SWPARAMS VAL

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-sw-params-set-start-threshold PCM SWPARAMS VAL

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-wait PCM TIMEOUT

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-pcm-writei PCM BUFFER SIZE

Package

also-alsa

Source

also-alsa.lisp (file)

Function: snd-strerror VAL

Package

also-alsa

Source

also-alsa.lisp (file)

Function: to-alsa-format ELEMENT-TYPE

Package

also-alsa

Source

also-alsa.lisp (file)

5.2.4 Generic functions

Generic Function: channels-count OBJECT

Package

also-alsa

Methods

Method: channels-count (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: device OBJECT

Package

also-alsa

Methods

Method: device (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: handle OBJECT

Package

also-alsa

Methods

Method: handle (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: params OBJECT

Package

also-alsa

Methods

Method: params (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: sample-rate OBJECT

Package

also-alsa

Methods

Method: sample-rate (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Generic Function: status OBJECT

Generic Function: (setf status) NEW-VALUE OBJECT

Package

also-alsa

Methods

Method: status (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Method: (setf status) NEW-VALUE (PCM-STREAM pcm-stream)

automatically generated writer method

Source

also-alsa.lisp (file)

Generic Function: swparams OBJECT

Package

also-alsa

Methods

Method: swparams (PCM-STREAM pcm-stream)

automatically generated reader method

Source

also-alsa.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types