The bdef Reference Manual

3.1.1 bdef/bdef.asd

Source

bdef.asd.

Parent Component

bdef (system).

ASDF Systems

bdef.

---

3.1.2 bdef/package.lisp

Source

bdef.asd.

Parent Component

bdef (system).

Packages

bdef.

---

3.1.3 bdef/bdef.lisp

Dependency

package.lisp (file).

Source

bdef.asd.

Parent Component

bdef (system).

Public Interface

• *bdef-backends* (special variable).
• *bdef-default-num-channels* (special variable).
• *bdef-temporary-directory* (special variable).
• all-bdef-names (function).
• all-bdefs (function).
• bdef (function).
• bdef (class).
• bdef-buffer (generic function).
• bdef-channels (generic function).
• bdef-dur (generic function).
• bdef-duration (generic function).
• bdef-elt (compiler macro).
• bdef-elt (function).
• bdef-file (generic function).
• bdef-frame (generic function).
• bdef-frames (generic function).
• bdef-free (function).
• bdef-id (generic function).
• bdef-key (compiler macro).
• (setf bdef-key) (compiler macro).
• bdef-key (function).
• (setf bdef-key) (function).
• bdef-length (generic function).
• bdef-metadata (generic function).
• (setf bdef-metadata) (method).
• (setf bdef-metadata) (method).
• (setf bdef-metadata) (method).
• (setf bdef-metadata) (method).
• bdef-metadata-keys (compiler macro).
• bdef-metadata-keys (function).
• bdef-name (generic function).
• bdef-names (function).
• bdef-p (function).
• bdef-sample-rate (generic function).
• bdef-splits (function).
• (setf bdef-splits) (function).
• bdef-splits-events (function).
• bdef-subseq (compiler macro).
• bdef-subseq (function).
• bdef-tempo (generic function).
• define-bdef-auto-metadata (macro).
• define-bdef-dynamic-metadata (macro).
• describe-object (method).
• find-bdef (function).
• (setf find-bdef) (function).
• print-object (method).
• remove-bdef-auto-metadata (function).
• remove-bdef-dynamic-metadata (function).
• set-bdef-auto-metadata (function).

Internals

• *bdef-auto-metadata* (special variable).
• *bdef-dictionary* (special variable).
• *bdef-dynamic-metadata* (special variable).
• *deprecated-function-error-(setf⎵bdef-key)-notified-p* (special variable).
• *deprecated-function-error-(setf⎵bdef-ref)-notified-p* (special variable).
• *deprecated-function-error-bdef-elt-notified-p* (special variable).
• *deprecated-function-error-bdef-get-notified-p* (special variable).
• *deprecated-function-error-bdef-key-notified-p* (special variable).
• *deprecated-function-error-bdef-metadata-keys-notified-p* (special variable).
• *deprecated-function-error-bdef-ref-notified-p* (special variable).
• *deprecated-function-error-bdef-set-notified-p* (special variable).
• *deprecated-function-error-bdef-subseq-notified-p* (special variable).
• *ffmpeg-path* (special variable).
• *ffprobe-path* (special variable).
• bdef-backend-free (generic function).
• bdef-backend-load (generic function).
• bdef-backend-supported-file-types (generic function).
• bdef-get (compiler macro).
• bdef-get (function).
• bdef-load (generic function).
• bdef-ref (compiler macro).
• (setf bdef-ref) (compiler macro).
• bdef-ref (function).
• (setf bdef-ref) (function).
• bdef-set (compiler macro).
• bdef-set (function).
• ensure-namestring (function).
• ensure-readable-audio-file (function).
• file-does-not-exist (condition).
• file-exists-p (function).
• file-metadata (function).

---

3.1.4 bdef/splits.lisp

Dependency

bdef.lisp (file).

Source

bdef.asd.

Parent Component

bdef (system).

Public Interface

• audacity-labels-from-splits (compiler macro).
• audacity-labels-from-splits (function).
• bdef-buffer (method).
• bdef-channels (method).
• bdef-file (method).
• bdef-frames (method).
• bdef-id (method).
• bdef-length (method).
• bdef-sample-rate (method).
• describe-object (method).
• make-splits (function).
• print-object (method).
• splits (class).
• splits-export (generic function).
• splits-from-aubio (function).
• splits-from-aubio-onsets (compiler macro).
• splits-from-aubio-onsets (function).
• splits-from-audacity-labels (compiler macro).
• splits-from-audacity-labels (function).
• splits-from-op-1-drumset (function).
• splits-import (function).
• splits-import-format (generic function).
• splits-length (function).
• splits-p (function).
• splits-point (function).
• splits-points (function).

Internals

• %splits-conversion-function (function).
• %splits-conversion-function-name (function).
• %splits-ensure-point-type (function).
• %splits-ensure-unit (function).
• *aubio-python-directory* (special variable).
• *deprecated-function-style-warning-splits-from-audacity-labels-notified-p* (special variable).
• *deprecated-function-warning-audacity-labels-from-splits-notified-p* (special variable).
• *deprecated-function-warning-splits-from-aubio-onsets-notified-p* (special variable).
• *splits-format-auto-detect-functions* (special variable).
• +op-1-bytes-in-12-sec+ (constant).
• +op-1-drumkit-end+ (constant).
• +size-of-uint16-t+ (constant).
• aubio-demo-bpm (function).
• aubio-demo-tempo (function).
• aubio-onsets (function).
• bpm-tools-bpm (function).
• detect-audacity-labels (function).
• end-point (function).
• frame-to-op-1-format (function).
• op-1-format-to-frame (function).
• percents-samples (function).
• percents-seconds (function).
• samples-percents (function).
• samples-seconds (function).
• seconds-percents (function).
• seconds-samples (function).
• splits-bdef (reader method).
• (setf splits-bdef) (writer method).
• splits-comments (function).
• splits-ends (function).
• splits-import-detect-format (function).
• splits-loops (function).
• splits-metadata (generic function).
• (setf splits-metadata) (method).
• splits-starts (function).
• splits-unit (reader method).
• (setf splits-unit) (writer method).
• string-extract-bpm (function).

---

3.1.5 bdef/sequence-extensions.lisp

Dependency

splits.lisp (file).

Source

bdef.asd.

Parent Component

bdef (system).

Public Interface

• elt (method).
• elt (method).
• emptyp (method).
• emptyp (method).
• length (method).
• length (method).
• subseq (method).

---

5.1.1 Special variables

Special Variable: *bdef-backends* ¶

The list of enabled backends. When the user attempts to create a bdef, each backend in this list is used to try to create the bdef from the file or object. If a backend returns nil, the next backend in the list will be tried. This is repeated until the first backend successfully returns a bdef object.

Note that backends are made available by loading the relevant bdef subsystem with Quicklisp or ASDF. For example, if you want to use SuperCollider/cl-collider, load ‘bdef/cl-collider’. Once you’ve loaded it, you should see that the :cl-collider keyword is in this list.

Package

bdef.

Source

bdef.lisp.

Special Variable: *bdef-default-num-channels* ¶

The default value of ‘bdef-load”s NUM-CHANNELS argument. If 2, all buffers will default to being loaded as stereo even if they are mono. If nil, load all the channels the source has.

Package

bdef.

Source

bdef.lisp.

Special Variable: *bdef-temporary-directory* ¶

The directory bdef should store its temporary files in (i.e. the .wav files generated from format auto-conversion).

Package

bdef.

Source

bdef.lisp.

---

5.1.2 Macros

Macro: define-bdef-auto-metadata (key &body body) ¶

Define an auto-metadata key for bdefs. The variable BDEF will be bound in BODY to the bdef in question.

Package

bdef.

Source

bdef.lisp.

Macro: define-bdef-dynamic-metadata (key get-body set-body) ¶

Define a metadata key that is calculated dynamically. For example, bpm is just tempo multiplied by 60.

KEY is the name of the key, GET-BODY is the function to run to get the key, and SET-BODY is the function to run to set metadata when (setf (bdef-metadata bdef KEY) ...) is called.

See also: ‘define-bdef-auto-metadata’, ‘bdef-metadata’

Package

bdef.

Source

bdef.lisp.

---

5.1.3 Compiler macros

Compiler Macro: audacity-labels-from-splits (&rest args) ¶

Package

bdef.

Source

splits.lisp.

Compiler Macro: bdef-elt (&rest args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: bdef-key (&rest args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: (setf bdef-key) (args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: bdef-metadata-keys (&rest args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: bdef-subseq (&rest args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: splits-from-aubio-onsets (&rest args) ¶

Package

bdef.

Source

splits.lisp.

Compiler Macro: splits-from-audacity-labels (&rest args) ¶

Package

bdef.

Source

splits.lisp.

---

5.1.4 Ordinary functions

Function: all-bdef-names (&key include-aliases package dictionary) ¶

Get a list of the names of all defined bdef objects.

See also: ‘all-bdefs’, ‘bdef-names’

Package

bdef.

Source

bdef.lisp.

Function: all-bdefs (&key package dictionary) ¶

Get a list of all defined bdef objects in DICTIONARY. With PACKAGE, get only bdefs whose name is a symbol in that package.

See also: ‘all-bdef-names’, ‘bdef-names’, ‘find-bdef’

Package

bdef.

Source

bdef.lisp.

Function: audacity-labels-from-splits (splits &optional file) ¶

Deprecated alias for (splits-export SPLITS FILE :audacity).

Package

bdef.

Source

splits.lisp.

Function: bdef (name &optional value &key num-channels wavetable metadata backend dictionary) ¶

Automatically load a buffer or reference one that’s already loaded. NAME is the name to give the buffer in the bdef dictionary. VALUE is the path to the file to load, or the data to construct the buffer from (i.e. an envelope, a list of frames, etc).

Without VALUE, bdef will look up and return the bdef that already exists with the given name. If NAME is a pathname or string, it’s assumed to be the name of a file, which is automatically loaded if necessary.

Package

bdef.

Source

bdef.lisp.

Function: bdef-elt (bdef index &optional channel) ¶

Deprecated alias for ‘bdef-frame’.

Package

bdef.

Source

bdef.lisp.

Function: bdef-free (bdef &optional dictionary) ¶

Free BDEF’s buffer and remove all names in DICTIONARY that point to it.

Package

bdef.

Source

bdef.lisp.

Function: bdef-key (object) ¶

Deprecated alias for ‘bdef-name’.

Package

bdef.

Source

bdef.lisp.

Function: (setf bdef-key) (object) ¶

Deprecated alias for ‘(setf bdef-name)’.

Package

bdef.

Source

bdef.lisp.

Function: bdef-metadata-keys (bdef) ¶

Deprecated alias for (keys (bdef-metadata bdef)).

Package

bdef.

Source

bdef.lisp.

Function: bdef-names (name &key include-aliases dictionary) ¶

Get a list of all the names in DICTIONARY that point to NAME.

See also: ‘all-bdef-names’, ‘all-bdefs’

Package

bdef.

Source

bdef.lisp.

Function: bdef-p (object) ¶

Test whether OBJECT is a bdef.

See also: ‘find-bdef’

Package

bdef.

Source

bdef.lisp.

Function: bdef-splits (bdef) ¶

Get any ‘splits’ from BDEF’s metadata, searching in preferred order (i.e. :splits key first, etc).

See also: ‘bdef-splits-events’, ‘splits-events’

Package

bdef.

Source

bdef.lisp.

Function: (setf bdef-splits) (bdef) ¶

Package

bdef.

Source

bdef.lisp.

Function: bdef-splits-events (bdef &key unit keys remove-keys) ¶

Get the ‘splits’ from BDEF’s metadata (as per ‘bdef-splits’) as a list of events (as per ‘splits-events’).

See also: ‘bdef-splits’, ‘splits-events’

Package

bdef.

Source

bdef.lisp.

Function: bdef-subseq (bdef &optional start end channel) ¶

Deprecated alias for ‘bdef-frames’.

Package

bdef.

Source

bdef.lisp.

Function: find-bdef (name &key errorp dictionary) ¶

Get the object named NAME in the bdef dictionary. If ERRORP is true, signals an error when NAME isn’t found in the dictionary. Returns t or nil as a second value showing whether the symbol was found.

See also: ‘bdef-p’, ‘all-bdefs’, ‘all-bdef-names’

Package

bdef.

Source

bdef.lisp.

Function: (setf find-bdef) (name &key errorp dictionary) ¶

Package

bdef.

Source

bdef.lisp.

Function: make-splits (starts &key ends loops comments unit bdef metadata) ¶

Make a ‘splits’ object. Ends, loops, and comments for each split can be specified with the keyword arguments or as sublists in STARTS.

Examples:

;; (make-splits (list (list 0 1 "first split") (list 1 2 "second split")) :unit seconds)
;; ;; ...is equivalent to:
;; (make-splits (list 0 1) :ends (list 1 2) :comments (list "first split" "second split") :unit :seconds)

See also: ‘splits’, ‘splits-points’, ‘splits-starts’, ‘splits-ends’, ‘splits-loops’, ‘splits-comments’

Package

bdef.

Source

splits.lisp.

Function: remove-bdef-auto-metadata (key) ¶

Remove a previously-defined auto-metadata key.

Package

bdef.

Source

bdef.lisp.

Function: remove-bdef-dynamic-metadata (key) ¶

Remove a key from the bdef dynamic metadata list.

Package

bdef.

Source

bdef.lisp.

Function: set-bdef-auto-metadata (key function) ¶

Add KEY as an auto-metadata key for bdefs. FUNCTION will be run with the bdef as its argument, and the result will be set to the bdef’s metadata for KEY.

Package

bdef.

Source

bdef.lisp.

Function: splits-from-aubio (file &rest args &key &allow-other-keys) ¶

Make a ‘splits’ from onsets data generated by Aubio by using the ‘aubio-onsets’ function.

See also: ‘splits’, ‘aubio-onsets’

Package

bdef.

Source

splits.lisp.

Function: splits-from-aubio-onsets (file &rest args &key &allow-other-keys) ¶

Deprecated alias for (splits-from-aubio FILE :utility :onset ...).

Package

bdef.

Source

splits.lisp.

Function: splits-from-audacity-labels (file) ¶

Deprecated alias for (splits-import-format FILE :audacity).

See also: ‘splits-import’, ‘splits-import-format’.

Package

bdef.

Source

splits.lisp.

Function: splits-from-op-1-drumset (drumset &key if-invalid) ¶

Make a ‘splits’ object by reading the metadata from an OP-1 format drumset file. IF-INVALID specifies what to do if DRUMSET can’t be parsed as an op-1 drumset file; it can be either :ERROR to signal an error, or NIL to simply return nil.

Package

bdef.

Source

splits.lisp.

Function: splits-import (source &optional format) ¶

Derive a ‘splits’ object from another format. If FORMAT is not provided, attempt to autodetect.

See also: ‘splits-export’

Package

bdef.

Source

splits.lisp.

Function: splits-length (object) ¶

Get the number of splits defined in OBJECT.

Package

bdef.

Source

splits.lisp.

Function: splits-p (object) ¶

True if OBJECT is a splits.

See also: ‘splits’, ‘make-splits’

Package

bdef.

Source

splits.lisp.

Function: splits-point (splits split &optional point unit) ¶

Get the split point SPLIT from SPLITS, converting to the correct UNIT (percent, samples, seconds).

Package

bdef.

Source

splits.lisp.

Function: splits-points (splits &optional point unit) ¶

Get the split points for POINTS (i.e. start, end, loops, comments) from SPLITS converted to UNIT (i.e. percent, samples, seconds).

Package

bdef.

Source

splits.lisp.

---

5.1.5 Generic functions

Generic Function: bdef-buffer (object) ¶

The actual buffer object that the bdef refers to.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-buffer ((this splits)) ¶

Source

splits.lisp.

Method: bdef-buffer ((null null)) ¶

Method: bdef-buffer ((symbol symbol)) ¶

Reader Method: bdef-buffer ((bdef bdef)) ¶

The actual buffer object that the bdef refers to.

Target Slot

buffer.

Generic Function: bdef-channels (bdef) ¶

The number of BDEF’s channels.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-channels ((this splits)) ¶

Source

splits.lisp.

Method: bdef-channels (bdef) ¶

Generic Function: bdef-dur (bdef) ¶

Get the dur of the bdef in beats.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-dur (bdef) ¶

Generic Function: bdef-duration (bdef) ¶

Get the duration of the bdef in seconds.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-duration (bdef) ¶

Generic Function: bdef-file (bdef) ¶

The file that BDEF was loaded from, or nil if it was not loaded from a file.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-file ((this splits)) ¶

Source

splits.lisp.

Method: bdef-file (bdef) ¶

Generic Function: bdef-frame (bdef index &optional channel) ¶

Get the value of the bdef frame at INDEX. Without CHANNEL, return an array of the specified index in all channels. With CHANNEL, return just the value as a number.

See also: ‘bdef-frames’

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-frame (bdef index &optional channels) ¶

Generic Function: bdef-frames (bdef &key start end channels) ¶

Get an array of the frames of BDEF’s buffer, from START below END. CHANNELS specifies which channel(s) to get; if an integer, returns a single-dimensional array of the specified channel; if a list, returns a multi-dimensional array of the specified channels. Defaults to all frames of all channels.

See also: ‘bdef-frame’

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-frames ((this splits) &key start end channels) ¶

Source

splits.lisp.

Method: bdef-frames ((bdef bdef) &key start end channels) ¶

Generic Function: bdef-id (bdef) ¶

The ID number of this bdef, or nil if the bdef’s backend does not support IDs.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-id ((this splits)) ¶

Source

splits.lisp.

Method: bdef-id ((bdef bdef)) ¶

Method: bdef-id ((null null)) ¶

Method: bdef-id ((name string)) ¶

Method: bdef-id ((name symbol)) ¶

Generic Function: bdef-length (bdef) ¶

BDEF’s length in frames.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-length ((this splits)) ¶

Source

splits.lisp.

Method: bdef-length (bdef) ¶

Generic Function: bdef-metadata (bdef &optional key) ¶

Get the value of BDEF’s metadata for KEY, or the full metadata hashtable if KEY is not provided. Returns true as a second value if the metadata had an entry for KEY, or false if it did not.

Note that this function will block if the specified metadata is one of the ‘*bdef-auto-metadata*’ that hasn’t finished being generated yet.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-metadata ((bdef bdef) &optional key) ¶

Method: bdef-metadata ((null null) &optional key) ¶

Method: bdef-metadata ((name string) &optional key) ¶

Method: bdef-metadata ((name symbol) &optional key) ¶

Generic Function: (setf bdef-metadata) (symbol &optional key) ¶

Package

bdef.

Methods

Method: (setf bdef-metadata) ((bdef bdef) &optional key) ¶

Source

bdef.lisp.

Method: (setf bdef-metadata) ((null null) &optional key) ¶

Source

bdef.lisp.

Method: (setf bdef-metadata) ((string string) &optional key) ¶

Source

bdef.lisp.

Method: (setf bdef-metadata) ((symbol symbol) &optional key) ¶

Source

bdef.lisp.

Generic Function: bdef-name (bdef) ¶

The name (key) of the bdef.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-name ((null null)) ¶

Method: bdef-name ((symbol symbol)) ¶

Reader Method: bdef-name ((bdef bdef)) ¶

The name (key) of the bdef.

Target Slot

name.

Generic Function: bdef-sample-rate (bdef) ¶

BDEF’s sample rate in Hz.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-sample-rate ((this splits)) ¶

Source

splits.lisp.

Method: bdef-sample-rate (bdef) ¶

Generic Function: bdef-tempo (bdef) ¶

Get the tempo of the bdef in beats per second. Defaults to 1 if no tempo metadatum exists.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-tempo (bdef) ¶

Generic Function: splits-export (splits destination format) ¶

Write a ‘splits’ object as another format.

See also: ‘splits-import’

Package

bdef.

Source

splits.lisp.

Methods

Method: splits-export ((splits splits) (stream stream) (format (eql :audacity))) ¶

Method: splits-export (object (file pathname) format) ¶

Method: splits-export (object (file string) format) ¶

Method: splits-export ((bdef bdef) file format) ¶

Generic Function: splits-import-format (input format) ¶

Make a ‘splits’ object by importing from INPUT in FORMAT.

See also: ‘splits-import’, ‘splits-export’

Package

bdef.

Source

splits.lisp.

Methods

Method: splits-import-format ((stream stream) (format (eql :audacity))) ¶

Method: splits-import-format ((path string) (format (eql :audacity))) ¶

---

5.1.6 Standalone methods

Method: describe-object ((splits splits) stream) ¶

Source

splits.lisp.

Method: describe-object ((bdef bdef) stream) ¶

Source

bdef.lisp.

Method: elt ((this splits) index) ¶

Package

sb-sequence.

Source

sequence-extensions.lisp.

Method: elt ((this bdef) index) ¶

Package

sb-sequence.

Source

sequence-extensions.lisp.

Method: emptyp ((this splits)) ¶

Package

sb-sequence.

Source

sequence-extensions.lisp.

Method: emptyp ((this bdef)) ¶

Package

sb-sequence.

Source

sequence-extensions.lisp.

Method: length ((this splits)) ¶

Package

sb-sequence.

Source

sequence-extensions.lisp.

Method: length ((this bdef)) ¶

Package

sb-sequence.

Source

sequence-extensions.lisp.

Method: print-object ((splits splits) stream) ¶

Source

splits.lisp.

Method: print-object ((bdef bdef) stream) ¶

Source

bdef.lisp.

Method: subseq ((this bdef) start &optional end) ¶

Package

sb-sequence.

Source

sequence-extensions.lisp.

---

5.1.7 Classes

Class: bdef ¶

Package

bdef.

Source

bdef.lisp.

Direct methods

• bdef-buffer.
• bdef-frames.
• bdef-id.
• (setf bdef-metadata).
• bdef-metadata.
• bdef-name.
• describe-object.
• elt.
• emptyp.
• length.
• print-object.
• splits-export.
• subseq.

Direct slots

Slot: name ¶

The name (key) of the bdef.

Type

alexandria:string-designator

Initargs

:name

Readers

bdef-name.

Writers

This slot is read-only.

Slot: buffer ¶

The actual buffer object that the bdef refers to.

Initargs

:buffer

Readers

bdef-buffer.

Writers

This slot is read-only.

Slot: metadata ¶

Hash table of additional data associated with the bdef, accessible with the ‘bdef-metadata’ function.

Type

hash-table

Initform

(make-hash-table)

Initargs

:metadata

Class: splits ¶

List of split data for dividing buffers into pieces.

Package

bdef.

Source

splits.lisp.

Direct superclasses

sequence.

Direct methods

• bdef-buffer.
• bdef-channels.
• bdef-file.
• bdef-frames.
• bdef-id.
• bdef-length.
• bdef-sample-rate.
• describe-object.
• elt.
• emptyp.
• length.
• print-object.
• (setf splits-bdef).
• splits-bdef.
• splits-export.
• (setf splits-metadata).
• splits-metadata.
• (setf splits-unit).
• splits-unit.

Direct slots

Slot: starts ¶

The vector of split start points. If the "end" slot is non-nil, each start point will be matched with an end point in the "end" slot with the same index.

Type

(vector number)

Initargs

:starts

Slot: ends ¶

The vector of split end points, or NIL if no end points are defined.

Type

(or null (vector number))

Initargs

:ends

Slot: loops ¶

The vector of split loop points, or NIL if no loop points are defined.

Type

(or null (vector number))

Initargs

:loops

Slot: comments ¶

The vector of comments for each split point.

Type

(or null (vector (or null string)))

Initargs

:comments

Slot: unit ¶

The unit type of each split point, i.e. percents, samples, or seconds.

Type

symbol

Initform

:percents

Initargs

:unit

Readers

splits-unit.

Writers

(setf splits-unit).

Slot: bdef ¶

The bdef object that this splits references (i.e. for information like duration, sample rate, etc, for converting point data).

Type

bdef:bdef

Initargs

:bdef

Readers

splits-bdef.

Writers

(setf splits-bdef).

Slot: metadata ¶

Hash table of additional data associated with the splits, accessible with the ‘splits-metadata’ function.

Type

hash-table

Initform

(make-hash-table)

Initargs

:metadata

---

5.2.1 Constants

Constant: +op-1-bytes-in-12-sec+ ¶

Package

bdef.

Source

splits.lisp.

Constant: +op-1-drumkit-end+ ¶

Package

bdef.

Source

splits.lisp.

Constant: +size-of-uint16-t+ ¶

Package

bdef.

Source

splits.lisp.

---

5.2.2 Special variables

Special Variable: *aubio-python-directory* ¶

The path to Aubio’s "demos" directory.

Package

bdef.

Source

splits.lisp.

Special Variable: *bdef-auto-metadata* ¶

Plist of keys that will automatically be populated in a bdef’s metadata for all newly-created or loaded buffers. The value for each key is the function that generates the value of the key for the bdef metadata. Use the ‘define-bdef-auto-metadata’ macro or ‘set-bdef-auto-metadata’ function to define bdef-auto-metadata keys, or ‘remove-bdef-auto-metadata’ to remove them.

Package

bdef.

Source

bdef.lisp.

Special Variable: *bdef-dictionary* ¶

The bdef dictionary hash table.

See also: ‘find-bdef’

Package

bdef.

Source

bdef.lisp.

Special Variable: *bdef-dynamic-metadata* ¶

Alist of dynamic metadata keys and their get and set functions.

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-(setf⎵bdef-key)-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-(setf⎵bdef-ref)-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-bdef-elt-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-bdef-get-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-bdef-key-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-bdef-metadata-keys-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-bdef-ref-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-bdef-set-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-error-bdef-subseq-notified-p* ¶

Package

bdef.

Source

bdef.lisp.

Special Variable: *deprecated-function-style-warning-splits-from-audacity-labels-notified-p* ¶

Package

bdef.

Source

splits.lisp.

Special Variable: *deprecated-function-warning-audacity-labels-from-splits-notified-p* ¶

Package

bdef.

Source

splits.lisp.

Special Variable: *deprecated-function-warning-splits-from-aubio-onsets-notified-p* ¶

Package

bdef.

Source

splits.lisp.

Special Variable: *ffmpeg-path* ¶

The path to ffmpeg, or nil if ffmpeg could not be found.

Package

bdef.

Source

bdef.lisp.

Special Variable: *ffprobe-path* ¶

The path to ffprobe, or nil if ffprobe could not be found.

Package

bdef.

Source

bdef.lisp.

Special Variable: *splits-format-auto-detect-functions* ¶

List of functions to check objects against when imported via ‘splits-import’ without its format specified.

Package

bdef.

Source

splits.lisp.

---

5.2.3 Compiler macros

Compiler Macro: bdef-get (&rest args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: bdef-ref (&rest args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: (setf bdef-ref) (args) ¶

Package

bdef.

Source

bdef.lisp.

Compiler Macro: bdef-set (&rest args) ¶

Package

bdef.

Source

bdef.lisp.

---

5.2.4 Ordinary functions

Function: %splits-conversion-function (splits unit) ¶

Get a function that can be used to convert SPLITS’ unit into the unit type specified.

Package

bdef.

Source

splits.lisp.

Function: %splits-conversion-function-name (splits unit) ¶

Get the name of the conversion function to convert SPLITS’ unit type into the unit specified.

Package

bdef.

Source

splits.lisp.

Function: %splits-ensure-point-type (point) ¶

Ensure POINT is one of the splits point types.

Package

bdef.

Source

splits.lisp.

Function: %splits-ensure-unit (unit) ¶

Ensure UNIT is one of the splits position unit types.

Package

bdef.

Source

splits.lisp.

Function: aubio-demo-bpm (file &key mode) ¶

Use aubio’s demo_bpm_extract.py to get the bpm of FILE.

Package

bdef.

Source

splits.lisp.

Function: aubio-demo-tempo (file &key sample-rate) ¶

Use aubio’s demo_tempo.py to get a list of beats in FILE. The returned list gives onsets in seconds from the start of the file.

Package

bdef.

Source

splits.lisp.

Function: aubio-onsets (file &rest args &key utility algorithm threshold silence minimum-interval buf-size hop-size &allow-other-keys) ¶

Use the "aubioonset" or "aubiotrack" utility to get a list of onset points in FILE in seconds. FILE can be a filename, a bdef, or a supported buffer object. UTILITY specifies whether to use Aubio’s "onset" or "track" utility. The rest of the arguments are sent as parameters to the Aubio utility in use; see Aubio’s documentation for more information on them.

Package

bdef.

Source

splits.lisp.

Function: bdef-get (key &optional dictionary) ¶

Deprecated alias for ‘find-bdef’.

Package

bdef.

Source

bdef.lisp.

Function: bdef-ref (name &optional dictionary) ¶

Deprecated alias for ‘find-bdef’.

Package

bdef.

Source

bdef.lisp.

Function: (setf bdef-ref) (name &optional dictionary) ¶

Deprecated alias for ‘(setf find-bdef)’.

Package

bdef.

Source

bdef.lisp.

Function: bdef-set (key value &optional dictionary) ¶

Deprecated alias for ‘(setf find-bdef)’.

Package

bdef.

Source

bdef.lisp.

Function: bpm-tools-bpm (file) ¶

Use bpm-tools’ "bpm" utility to get the BPM of FILE.

Package

bdef.

Source

splits.lisp.

Function: detect-audacity-labels (file) ¶

Returns :audacity if FILE is a valid Audacity labels file.

Package

bdef.

Source

splits.lisp.

Function: end-point (object &optional unit) ¶

Get the end point of OBJECT.

Package

bdef.

Source

splits.lisp.

Function: ensure-namestring (filename) ¶

Get the full path to FILENAME.

Package

bdef.

Source

bdef.lisp.

Function: ensure-readable-audio-file (file &key num-channels backend extensions) ¶

Use ffmpeg to convert FILE to the first format in EXTENSIONS if it is not already in one of those formats. Returns the path to the converted file (or FILE if no conversion is needed), and the file’s metadata. The converted file is stored under ‘*bdef-temporary-directory*’.

See also: ‘file-metadata’, ‘*ffmpeg-path*’, ‘*bdef-temporary-directory*’

Package

bdef.

Source

bdef.lisp.

Function: file-exists-p (filename) ¶

True if FILENAME names a file that exists. This function is needed to ensure characters like ? are not interpreted as Common Lisp pathname wildcards.

Package

bdef.

Source

bdef.lisp.

Function: file-metadata (file) ¶

Get the metadata of FILE as a plist.

Package

bdef.

Source

bdef.lisp.

Function: frame-to-op-1-format (frame) ¶

Convert a frame number to the OP-1 split point format.

See also: ‘op-1-format-to-frame’

Package

bdef.

Source

splits.lisp.

Function: op-1-format-to-frame (op-1) ¶

Convert a frame number to the OP-1 split point format.

See also: ‘op-1-format-to-frame’

Package

bdef.

Source

splits.lisp.

Function: percents-samples (percent total-samples) ¶

Package

bdef.

Source

splits.lisp.

Function: percents-seconds (percent total-seconds) ¶

Package

bdef.

Source

splits.lisp.

Function: samples-percents (samples total-samples) ¶

Package

bdef.

Source

splits.lisp.

Function: samples-seconds (samples sample-rate) ¶

Package

bdef.

Source

splits.lisp.

Function: seconds-percents (seconds total-seconds) ¶

Package

bdef.

Source

splits.lisp.

Function: seconds-samples (seconds sample-rate) ¶

Package

bdef.

Source

splits.lisp.

Function: splits-comments (splits &optional unit) ¶

Package

bdef.

Source

splits.lisp.

Function: splits-ends (splits &optional unit) ¶

Package

bdef.

Source

splits.lisp.

Function: splits-import-detect-format (source) ¶

Auto-detect the format of SOURCE by testing it through ‘*splits-format-auto-detect-functions*’. Returns a list of the possible formats detected.

Package

bdef.

Source

splits.lisp.

Function: splits-loops (splits &optional unit) ¶

Package

bdef.

Source

splits.lisp.

Function: splits-starts (splits &optional unit) ¶

Package

bdef.

Source

splits.lisp.

Function: string-extract-bpm (string &key min-bpm max-bpm) ¶

Extract the BPM from a string (typically a filename), or nil if no BPM-like string is found. If "bpm" is not in the string, then this function will look for a number in the range MIN-BPM to MAX-BPM, starting from the end of the string.

Package

bdef.

Source

splits.lisp.

---

5.2.5 Generic functions

Generic Function: bdef-backend-free (buffer) ¶

Free a buffer via its backend.

See also: ‘bdef-backend-load’

Package

bdef.

Source

bdef.lisp.

Generic Function: bdef-backend-load (backend object &key &allow-other-keys) ¶

Load a file or other object into a bdef via the specified backend. This method should return the backend’s buffer object. OBJECT will either be a string (the path to the file to load) or a list of strings (if the files should be loaded as consecutive buffers, i.e. for SuperCollider’s VOsc UGen). Requested files will always be in a format that the backend reports supporting via the ‘bdef-backend-supported-file-types’ method.

See also: ‘bdef-backend-free’, ‘bdef-backend-supported-file-types’

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-backend-load (backend (object pathname) &rest args &key &allow-other-keys) ¶

Generic Function: bdef-backend-supported-file-types (backend) ¶

Get a list of file extensions as keywords naming the file types that the backend natively supports (i.e. that don’t need conversion).

See also: ‘bdef-backend-load’, ‘ensure-readable-audio-file’

Package

bdef.

Source

bdef.lisp.

Generic Function: bdef-load (object &key backend num-channels wavetable metadata &allow-other-keys) ¶

Load a file or other object into a bdef. Different backends will support different object types, and different key arguments. Here are the key arguments supported by one or more backends:

- ID - Requested buffer number.
- NUM-CHANNELS - Number of channels to load (defaults to ‘*bdef-default-num-channels*’, which itself defaults to nil, meaning load the same number of channels as the source).
- WAVETABLE - Whether to load the object in wavetable format. If T, the buffer length will be the next power of two. If a number is provided, load the object as a wavetable of that size. - METADATA - Plist of metadata to include in the bdef.

Package

bdef.

Source

bdef.lisp.

Methods

Method: bdef-load ((file string) &rest args &key backend num-channels wavetable metadata &allow-other-keys) ¶

Generic Reader: splits-bdef (object) ¶

Generic Writer: (setf splits-bdef) (object) ¶

Package

bdef.

Methods

Reader Method: splits-bdef ((splits splits)) ¶

Writer Method: (setf splits-bdef) ((splits splits)) ¶

The bdef object that this splits references (i.e. for information like duration, sample rate, etc, for converting point data).

Source

splits.lisp.

Target Slot

bdef.

Generic Function: splits-metadata (splits &optional key) ¶

Get the value of SPLITS’s metadata for KEY, or the full metadata hashtable if KEY is not provided. Returns true as a second value if the metadata had an entry for KEY, or false if it did not.

Package

bdef.

Source

splits.lisp.

Methods

Method: splits-metadata ((splits splits) &optional key) ¶

Generic Function: (setf splits-metadata) (splits &optional key) ¶

Package

bdef.

Methods

Method: (setf splits-metadata) ((splits splits) &optional key) ¶

Source

splits.lisp.

Generic Reader: splits-unit (object) ¶

Generic Writer: (setf splits-unit) (object) ¶

Package

bdef.

Methods

Reader Method: splits-unit ((splits splits)) ¶

Writer Method: (setf splits-unit) ((splits splits)) ¶

The unit type of each split point, i.e. percents, samples, or seconds.

Source

splits.lisp.

Target Slot

unit.

---

5.2.6 Conditions

Condition: file-does-not-exist ¶

Package

bdef.

Source

bdef.lisp.

Direct superclasses

• file-error.
• simple-condition.

---