Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-aubio Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:31:12 2022 GMT+0.
Next: Systems, Previous: The cl-aubio Reference Manual, Up: The cl-aubio Reference Manual [Contents][Index]
This library provides the c-bindings for the aubio audio library.
Well, you have to have libaubio
installed in your computer. You should probably check out the aubio download page
It's worth noting that in this part, you could choose to install other libraries (such as libsndfile or
FFTW) and build aubio with them so it will try to leverage some of the work to those libraries. It is totallly optional.
This project exposes two packages (each one in its own system):
aubio
(or by it's nickname, cl-aubio
)This is the one that you should use. It contains all the lipsy translations and utility wrappers for the actual c functions/structures.
aubio/bindings
This package contains the raw bindings, with no name processing or whatsoever. You should only use this package if I was super lazy and didn't provide a lispy binding for some function.
aubio/examples
A package to contain all the examples of usage of the different aubio objects
Before explaining each object by itself, I want to tell you that the guys and gals in charge of the aubio project did an extremely good job at mantaining its API object oriented. And what I am refering to is that
new_aubio_<name-of-the-object>
del_aubio_<name-of-the-object>
aubio_<name-of-the-object>_do
(which seems to respond of a method object of sorts)So, in my Lisp translation I'm trying to mantain that convention in this form:
make-<name-of-the-object>
functionclean
generic functiondo
part, but only if I find that it makes sense to have a polymorphic way of dealing with some objects.
In other cases, I probably will generate functions with more descriptive names of what the object is actually doingImportant note: In order to distinguish the object that represents the detection algorithm and the thing being detected
in this Lispy translation there exists two different objects to reify those two thing (like the note-detector
and the note
itself).
In the aubio source, there is no "detector" and the detector is named after the thing it detects. There is no struct or datatype that
reifies the thing being detected (in the previous example, a note is simply a list of three elements)
Next: Modules, Previous: Introduction, Up: The cl-aubio Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Aubio bindings for Common Lisp
Lautaro García
0.0.1
cffi/c2ffi (system).
Next: Files, Previous: Systems, Up: The cl-aubio Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: cl-aubio/bindings/spec, Previous: Modules, Up: Modules [Contents][Index]
cl-aubio (system).
Next: cl-aubio/src, Previous: cl-aubio/bindings, Up: Modules [Contents][Index]
package.lisp (file).
bindings (module).
aubio.h (file).
Previous: cl-aubio/bindings/spec, Up: Modules [Contents][Index]
cl-aubio (system).
Next: Packages, Previous: Modules, Up: The cl-aubio Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-aubio/bindings/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-aubio (system).
Next: cl-aubio/bindings/spec/aubio.h, Previous: cl-aubio/cl-aubio.asd, Up: Lisp [Contents][Index]
bindings (module).
Next: cl-aubio/src/package.lisp, Previous: cl-aubio/bindings/package.lisp, Up: Lisp [Contents][Index]
spec (module).
Next: cl-aubio/src/aubio-mop.lisp, Previous: cl-aubio/bindings/spec/aubio.h, Up: Lisp [Contents][Index]
src (module).
Next: cl-aubio/src/commons.lisp, Previous: cl-aubio/src/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
src (module).
Next: cl-aubio/src/float-vector.lisp, Previous: cl-aubio/src/aubio-mop.lisp, Up: Lisp [Contents][Index]
aubio-mop.lisp (file).
src (module).
Next: cl-aubio/src/float-matrix.lisp, Previous: cl-aubio/src/commons.lisp, Up: Lisp [Contents][Index]
commons.lisp (file).
src (module).
float-vector (class).
Next: cl-aubio/src/timestamp.lisp, Previous: cl-aubio/src/float-vector.lisp, Up: Lisp [Contents][Index]
float-vector.lisp (file).
src (module).
float-matrix (class).
Next: cl-aubio/src/source.lisp, Previous: cl-aubio/src/float-matrix.lisp, Up: Lisp [Contents][Index]
float-matrix.lisp (file).
src (module).
Next: cl-aubio/src/pitch.lisp, Previous: cl-aubio/src/timestamp.lisp, Up: Lisp [Contents][Index]
timestamp.lisp (file).
src (module).
Next: cl-aubio/src/onset.lisp, Previous: cl-aubio/src/source.lisp, Up: Lisp [Contents][Index]
source.lisp (file).
src (module).
Next: cl-aubio/src/tempo.lisp, Previous: cl-aubio/src/pitch.lisp, Up: Lisp [Contents][Index]
pitch.lisp (file).
src (module).
Next: cl-aubio/src/notes.lisp, Previous: cl-aubio/src/onset.lisp, Up: Lisp [Contents][Index]
onset.lisp (file).
src (module).
Next: cl-aubio/src/filterbank.lisp, Previous: cl-aubio/src/tempo.lisp, Up: Lisp [Contents][Index]
tempo.lisp (file).
src (module).
Next: cl-aubio/src/sink.lisp, Previous: cl-aubio/src/notes.lisp, Up: Lisp [Contents][Index]
notes.lisp (file).
src (module).
Previous: cl-aubio/src/filterbank.lisp, Up: Lisp [Contents][Index]
filterbank.lisp (file).
src (module).
Next: Definitions, Previous: Files, Up: The cl-aubio Reference Manual [Contents][Index]
Packages are listed by definition order.
aubio
common-lisp.
Next: Indexes, Previous: Packages, Up: The cl-aubio Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
Returns a copy of the filter-coefficients of A-FILTERBANK.
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
automatically generated reader method
automatically generated writer method
Transforms an aubio data structure to a lisp one.
Cleans the memory allocated for AN-AUBIO-OBJECT.
automatically generated reader method
automatically generated writer method
Get the detector confidence on it’s detection
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
Obtains the data inside an aubio data structure.
automatically generated reader method
data.
automatically generated reader method
data.
automatically generated reader method
Get the detector minimum inter onset interval in the unit specified
Set the detector minimum inter onset interval in the unit specified
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
Get the detector peak-picking algorithm threshold
automatically generated reader method
automatically generated reader method
Set the detector’s peak-picking algorithm threshold
automatically generated writer method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
Get the detector silence threshold
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
Set the detector’s silence threshold
automatically generated writer method
automatically generated writer method
automatically generated writer method
automatically generated writer method
automatically generated reader method
size.
automatically generated reader method
automatically generated writer method
automatically generated reader method
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
sb-mop.
sb-mop.
sb-mop.
sb-mop.
sb-mop.
sb-mop.
sb-mop.
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
Next: Types, Previous: Conditions, Up: Public Interface [Contents][Index]
integer
:midi-note
This slot is read-only.
float
:confidence
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]
Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]
automatically generated reader method
automatically generated reader method
automatically generated writer method
automatically generated writer method
automatically generated reader method
automatically generated reader method
automatically generated writer method
automatically generated writer method
automatically generated reader method
automatically generated reader method
automatically generated writer method
automatically generated writer method
automatically generated writer method
automatically generated writer method
automatically generated writer method
automatically generated reader method
Next: Classes, Previous: Generic functions, Up: Internals [Contents][Index]
Next: Types, Previous: Conditions, Up: Internals [Contents][Index]
standard-class.
cffi-sys:foreign-pointer
integer
:buffer-size
This slot is read-only.
integer
:number-of-filters
This slot is read-only.
float
integer
:buffer-size
integer
:hop-size
integer
:sample-rate
cffi-sys:foreign-pointer
cl-aubio:onset-detection-function
:default
:detection-method
integer
:buffer-size
integer
:hop-size
integer
:sample-rate
cffi-sys:foreign-pointer
cl-aubio:pitch-detection-method
:default
:detection-method
integer
:buffer-size
integer
:hop-size
integer
:sample-rate
cffi-sys:foreign-pointer
(cffi:foreign-string-alloc "hz")
This slot is read-only.
cffi-sys:foreign-pointer
(quote integer)
:sample-rate
(quote integer)
:hop-size
This slot is read-only.
This slot is read-only.
This slot is read-only.
string
"default"
:detection-method
integer
:buffer-size
integer
:hop-size
integer
:sample-rate
This slot is read-only.
cffi-sys:foreign-pointer
Previous: Definitions, Up: The cl-aubio Reference Manual [Contents][Index]
Jump to: | (
A B C D E F G H I L M N P R S T U V W |
---|
Jump to: | (
A B C D E F G H I L M N P R S T U V W |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | A B C D H I L M N P R S T U V W |
---|
Jump to: | A B C D H I L M N P R S T U V W |
---|
Jump to: | A B C F M N O P S T |
---|
Jump to: | A B C F M N O P S T |
---|