The sc-extensions Reference Manual

This is the sc-extensions Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:50:14 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 sc-extensions

additional library collection for cl-collider

Author

<>

License

Public Domain / 0-clause MIT

Dependencies
  • cl-collider (system).
  • alexandria (system).
  • named-readtables (system).
Source

sc-extensions.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 sc-extensions/sc-extensions.asd

Source

sc-extensions.asd.

Parent Component

sc-extensions (system).

ASDF Systems

sc-extensions.


3.1.2 sc-extensions/package.lisp

Source

sc-extensions.asd.

Parent Component

sc-extensions (system).

Packages

3.1.3 sc-extensions/util.lisp

Dependency

package.lisp (file).

Source

sc-extensions.asd.

Parent Component

sc-extensions (system).

Public Interface

define-code (macro).


3.1.4 sc-extensions/ugens.lisp

Dependency

util.lisp (file).

Source

sc-extensions.asd.

Parent Component

sc-extensions (system).

Public Interface

3.1.5 sc-extensions/server-side.lisp

Dependency

ugens.lisp (file).

Source

sc-extensions.asd.

Parent Component

sc-extensions (system).

Public Interface
Internals

3.1.6 sc-extensions/client-side.lisp

Dependency

server-side.lisp (file).

Source

sc-extensions.asd.

Parent Component

sc-extensions (system).

Public Interface
Internals

3.1.7 sc-extensions/pc.lisp

Dependency

client-side.lisp (file).

Source

sc-extensions.asd.

Parent Component

sc-extensions (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 pc

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 sc-extensions

Source

package.lisp.

Use List
  • cl-collider.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: cosr (lo hi rate &optional offset)
Package

sc-extensions.

Source

client-side.lisp.

Macro: define-code (name args &body body)
Package

sc-extensions.

Source

util.lisp.

Macro: nth-beat (dur list)
Package

sc-extensions.

Source

client-side.lisp.

Macro: on-trigger ((cnt div &optional rem) &body body)
Package

sc-extensions.

Source

server-side.lisp.

Macro: once (form)
Package

sc-extensions.

Source

client-side.lisp.

Macro: pattern-at (buffer (cnt div &optional rem) list &rest lists)
Package

sc-extensions.

Source

server-side.lisp.

Macro: pp (&body body)
Package

sc-extensions.

Source

client-side.lisp.

Macro: proxy-handle (key &optional action handle &key to pos)
Package

sc-extensions.

Source

ugens.lisp.

Macro: schedule (name (quant &key ahead count) &optional function)
Package

sc-extensions.

Source

client-side.lisp.

Macro: sinr (lo hi rate &optional offset)
Package

sc-extensions.

Source

client-side.lisp.

Macro: with-grid ((div n &key mode) grid &body body)
Package

sc-extensions.

Source

server-side.lisp.

Macro: with-grid-poly ((div len &optional self) grid &body body)
Package

sc-extensions.

Source

server-side.lisp.

Macro: with-lambda ((dur) &body body)
Package

sc-extensions.

Source

client-side.lisp.


5.1.2 Ordinary functions

Function: asr.kr (attk level rel gate &optional reset &key act)
Package

sc-extensions.

Source

ugens.lisp.

Function: beat (n)
Package

sc-extensions.

Source

server-side.lisp.

Function: bpm (&optional bpm &key relaunch lag pre-tick)
Package

sc-extensions.

Source

client-side.lisp.

Function: chord (root type)
Package

pc.

Source

pc.lisp.

Function: chord-to-scale (root type)
Package

pc.

Source

pc.lisp.

Function: cnt (div)
Package

sc-extensions.

Source

server-side.lisp.

Function: degree (value pc)
Package

pc.

Source

pc.lisp.

Function: del.kr (in del &optional max-delay)
Package

sc-extensions.

Source

ugens.lisp.

Function: diatonic (root maj-min degree)
Package

pc.

Source

pc.lisp.

Function: div (n)
Package

sc-extensions.

Source

server-side.lisp.

Function: env.kr (attk dur rel trig level &optional reset &key act)
Package

sc-extensions.

Source

ugens.lisp.

Function: g+ (div len contents)
Package

sc-extensions.

Source

ugens.lisp.

Function: gate-lane (div n seqs)
Package

sc-extensions.

Source

server-side.lisp.

Function: make-chord (lower upper number &optional pc)
Package

pc.

Source

pc.lisp.

Function: metro (bpm &key relaunch lag pre-tick)
Package

sc-extensions.

Source

server-side.lisp.

Function: pattern (buffer list &rest lists)
Package

sc-extensions.

Source

server-side.lisp.

Function: pc-random (lower upper pc)
Package

pc.

Source

pc.lisp.

Function: perc.kr (gate &optional attack release level curve)
Package

sc-extensions.

Source

ugens.lisp.

Function: poly (n gate)
Package

sc-extensions.

Source

ugens.lisp.

Function: quantize (pitch-in &optional pc)
Package

pc.

Source

pc.lisp.

Function: quantize-list (lst pc)
Package

pc.

Source

pc.lisp.

Function: r+ (sig min max)
Package

sc-extensions.

Source

ugens.lisp.

Function: rand-tr (tr odds)
Package

sc-extensions.

Source

ugens.lisp.

Function: relative (pitch i pc)
Package

pc.

Source

pc.lisp.

Function: rrand (n &optional p)
Package

sc-extensions.

Source

client-side.lisp.

Function: s+ (div contents)
Package

sc-extensions.

Source

ugens.lisp.

Function: safe-tr (tr)
Package

sc-extensions.

Source

ugens.lisp.

Function: scale (root type)
Package

pc.

Source

pc.lisp.

Function: sel-pos.kr (div contents)
Package

sc-extensions.

Source

ugens.lisp.

Function: t+ (tr contents)
Package

sc-extensions.

Source

ugens.lisp.

Function: t-gate.kr (dur trig &optional adjust)
Package

sc-extensions.

Source

ugens.lisp.

Function: t-line.ar (start end dur gate)
Package

sc-extensions.

Source

ugens.lisp.

Function: t-line.kr (start end dur gate)
Package

sc-extensions.

Source

ugens.lisp.

Function: tr (div)
Package

sc-extensions.

Source

server-side.lisp.

Function: transpose (val lst pc)
Package

pc.

Source

pc.lisp.

Function: wait-when (div)
Package

sc-extensions.

Source

server-side.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *bpm-functions*
Package

sc-extensions.

Source

client-side.lisp.

Special Variable: *chord->scale*
Package

pc.

Source

pc.lisp.

Special Variable: *chord-syms*
Package

pc.

Source

pc.lisp.

Special Variable: *chord-syms-scales*
Package

pc.

Source

pc.lisp.

Special Variable: *cnt-function*
Package

sc-extensions.

Source

server-side.lisp.

Special Variable: *diatonic-major*
Package

pc.

Source

pc.lisp.

Special Variable: *diatonic-minor*
Package

pc.

Source

pc.lisp.

Special Variable: *gate-lane-function*
Package

sc-extensions.

Source

server-side.lisp.

Special Variable: *max-beat*
Package

sc-extensions.

Source

server-side.lisp.

Special Variable: *scales*
Package

pc.

Source

pc.lisp.

Special Variable: *schedule-object*
Package

sc-extensions.

Source

client-side.lisp.

Special Variable: *tr-function*
Package

sc-extensions.

Source

server-side.lisp.


5.2.2 Ordinary functions

Function: copy-schedule-object (instance)
Package

sc-extensions.

Source

client-side.lisp.

Function: invert (lst pc &rest args)
Package

pc.

Source

pc.lisp.

Function: ivl-invert (lst &rest args)
Package

pc.

Source

pc.lisp.

Function: ivl-transpose (val lst)
Package

pc.

Source

pc.lisp.

Function: make-schedule-object (&key time running-p)
Package

sc-extensions.

Source

client-side.lisp.

Function: metro-cnt (div)
Package

sc-extensions.

Source

server-side.lisp.

Function: metro-gate-lane (div n seqs)
Package

sc-extensions.

Source

server-side.lisp.

Function: metro-tr (div)
Package

sc-extensions.

Source

server-side.lisp.

Function: pc (pitch)
Package

pc.

Source

pc.lisp.

Function: pc? (pitch pc)
Package

pc.

Source

pc.lisp.

Function: pp-synth (beat name &rest param &key &allow-other-keys)
Package

sc-extensions.

Source

client-side.lisp.

Function: schedule-object-p (object)
Package

sc-extensions.

Source

client-side.lisp.

Reader: schedule-object-running-p (instance)
Writer: (setf schedule-object-running-p) (instance)
Package

sc-extensions.

Source

client-side.lisp.

Target Slot

running-p.

Reader: schedule-object-time (instance)
Writer: (setf schedule-object-time) (instance)
Package

sc-extensions.

Source

client-side.lisp.

Target Slot

time.

Function: schedule-status ()
Package

sc-extensions.

Source

client-side.lisp.


5.2.3 Structures

Structure: schedule-object
Package

sc-extensions.

Source

client-side.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: time
Package

common-lisp.

Readers

schedule-object-time.

Writers

(setf schedule-object-time).

Slot: running-p
Readers

schedule-object-running-p.

Writers

(setf schedule-object-running-p).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   I   M   N   O   P   Q   R   S   T   W  
Index Entry  Section

(
(setf schedule-object-running-p): Private ordinary functions
(setf schedule-object-time): Private ordinary functions

A
asr.kr: Public ordinary functions

B
beat: Public ordinary functions
bpm: Public ordinary functions

C
chord: Public ordinary functions
chord-to-scale: Public ordinary functions
cnt: Public ordinary functions
copy-schedule-object: Private ordinary functions
cosr: Public macros

D
define-code: Public macros
degree: Public ordinary functions
del.kr: Public ordinary functions
diatonic: Public ordinary functions
div: Public ordinary functions

E
env.kr: Public ordinary functions

F
Function, (setf schedule-object-running-p): Private ordinary functions
Function, (setf schedule-object-time): Private ordinary functions
Function, asr.kr: Public ordinary functions
Function, beat: Public ordinary functions
Function, bpm: Public ordinary functions
Function, chord: Public ordinary functions
Function, chord-to-scale: Public ordinary functions
Function, cnt: Public ordinary functions
Function, copy-schedule-object: Private ordinary functions
Function, degree: Public ordinary functions
Function, del.kr: Public ordinary functions
Function, diatonic: Public ordinary functions
Function, div: Public ordinary functions
Function, env.kr: Public ordinary functions
Function, g+: Public ordinary functions
Function, gate-lane: Public ordinary functions
Function, invert: Private ordinary functions
Function, ivl-invert: Private ordinary functions
Function, ivl-transpose: Private ordinary functions
Function, make-chord: Public ordinary functions
Function, make-schedule-object: Private ordinary functions
Function, metro: Public ordinary functions
Function, metro-cnt: Private ordinary functions
Function, metro-gate-lane: Private ordinary functions
Function, metro-tr: Private ordinary functions
Function, pattern: Public ordinary functions
Function, pc: Private ordinary functions
Function, pc-random: Public ordinary functions
Function, pc?: Private ordinary functions
Function, perc.kr: Public ordinary functions
Function, poly: Public ordinary functions
Function, pp-synth: Private ordinary functions
Function, quantize: Public ordinary functions
Function, quantize-list: Public ordinary functions
Function, r+: Public ordinary functions
Function, rand-tr: Public ordinary functions
Function, relative: Public ordinary functions
Function, rrand: Public ordinary functions
Function, s+: Public ordinary functions
Function, safe-tr: Public ordinary functions
Function, scale: Public ordinary functions
Function, schedule-object-p: Private ordinary functions
Function, schedule-object-running-p: Private ordinary functions
Function, schedule-object-time: Private ordinary functions
Function, schedule-status: Private ordinary functions
Function, sel-pos.kr: Public ordinary functions
Function, t+: Public ordinary functions
Function, t-gate.kr: Public ordinary functions
Function, t-line.ar: Public ordinary functions
Function, t-line.kr: Public ordinary functions
Function, tr: Public ordinary functions
Function, transpose: Public ordinary functions
Function, wait-when: Public ordinary functions

G
g+: Public ordinary functions
gate-lane: Public ordinary functions

I
invert: Private ordinary functions
ivl-invert: Private ordinary functions
ivl-transpose: Private ordinary functions

M
Macro, cosr: Public macros
Macro, define-code: Public macros
Macro, nth-beat: Public macros
Macro, on-trigger: Public macros
Macro, once: Public macros
Macro, pattern-at: Public macros
Macro, pp: Public macros
Macro, proxy-handle: Public macros
Macro, schedule: Public macros
Macro, sinr: Public macros
Macro, with-grid: Public macros
Macro, with-grid-poly: Public macros
Macro, with-lambda: Public macros
make-chord: Public ordinary functions
make-schedule-object: Private ordinary functions
metro: Public ordinary functions
metro-cnt: Private ordinary functions
metro-gate-lane: Private ordinary functions
metro-tr: Private ordinary functions

N
nth-beat: Public macros

O
on-trigger: Public macros
once: Public macros

P
pattern: Public ordinary functions
pattern-at: Public macros
pc: Private ordinary functions
pc-random: Public ordinary functions
pc?: Private ordinary functions
perc.kr: Public ordinary functions
poly: Public ordinary functions
pp: Public macros
pp-synth: Private ordinary functions
proxy-handle: Public macros

Q
quantize: Public ordinary functions
quantize-list: Public ordinary functions

R
r+: Public ordinary functions
rand-tr: Public ordinary functions
relative: Public ordinary functions
rrand: Public ordinary functions

S
s+: Public ordinary functions
safe-tr: Public ordinary functions
scale: Public ordinary functions
schedule: Public macros
schedule-object-p: Private ordinary functions
schedule-object-running-p: Private ordinary functions
schedule-object-time: Private ordinary functions
schedule-status: Private ordinary functions
sel-pos.kr: Public ordinary functions
sinr: Public macros

T
t+: Public ordinary functions
t-gate.kr: Public ordinary functions
t-line.ar: Public ordinary functions
t-line.kr: Public ordinary functions
tr: Public ordinary functions
transpose: Public ordinary functions

W
wait-when: Public ordinary functions
with-grid: Public macros
with-grid-poly: Public macros
with-lambda: Public macros


A.3 Variables