The cl-mpg123 Reference Manual

3.1.1 cl-mpg123/cl-mpg123.asd

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

ASDF Systems

cl-mpg123.

---

3.1.2 cl-mpg123/package.lisp

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Packages

• cl-mpg123-cffi.
• cl-mpg123.

---

3.1.3 cl-mpg123/toolkit.lisp

Dependency

package.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Internals

• direct-str (function).
• mstring (function).
• split (function).
• string-nil (function).
• with-error (macro).
• with-foreign-values (macro).
• with-generic-error (macro).
• with-negative-error (macro).
• with-value-args (macro).
• with-zero-error (macro).

---

3.1.4 cl-mpg123/conditions.lisp

Dependency

toolkit.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface

• band (reader method).
• band (reader method).
• buffer (reader method).
• buffer-size (reader method).
• by (reader method).
• channel (reader method).
• channel (reader method).
• connection-failed (condition).
• decode-failed (condition).
• decoder-set-failed (condition).
• disconnection-failed (condition).
• equalizer-reset-failed (condition).
• equalizer-set-failed (condition).
• error-code (reader method).
• error-string (method).
• error-string-error (condition).
• file (reader method).
• file (reader method).
• file (reader method).
• file (reader method).
• file (reader method).
• file (reader method).
• file (reader method).
• file (reader method).
• frame-decode-failed (condition).
• generic-error (condition).
• handler-creation-failed (condition).
• id3-query-failed (condition).
• in-buffer (reader method).
• in-size (reader method).
• init-failed (condition).
• mode (reader method).
• mpg-error (condition).
• mpg-file-error (condition).
• mpg-file-string-error (condition).
• not-connected (condition).
• out-buffer (reader method).
• out-size (reader method).
• path (reader method).
• query (reader method).
• query-failed (condition).
• read-failed (condition).
• relative (reader method).
• scan-failed (condition).
• seek-failed (condition).
• seek-position (reader method).
• unknown-id3v2-frame-type (condition).
• value (reader method).
• value (reader method).
• value (reader method).
• volume-query-failed (condition).
• volume-set-failed (condition).

Internals

• define-direct-condition (macro).
• define-simple-condition (macro).
• equalizer-query-failed (condition).
• form (reader method).
• name (reader method).

---

3.1.5 cl-mpg123/low-level.lisp

Dependency

conditions.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface

• *static* (special variable).
• add-string (function).
• add-substring (function).
• chomp-string (function).
• clip (function).
• close (function).
• copy-string (function).
• current-decoder (function).
• decode (function).
• decode-frame (function).
• decoder (function).
• decoders (function).
• delete (function).
• delete-pars (function).
• enc-from-id3 (function).
• encodings (function).
• encsize (function).
• eq (function).
• errcode (function).
• exit (function).
• feature (function).
• feed (function).
• feedseek (function).
• fmt (function).
• fmt (class).
• fmt-all (function).
• fmt-channels (function).
• (setf fmt-channels) (function).
• fmt-encoding (function).
• (setf fmt-encoding) (function).
• fmt-none (function).
• fmt-rate (function).
• (setf fmt-rate) (function).
• fmt-support (function).
• format (function).
• format-all (function).
• format-none (function).
• format-support (function).
• framebyframe-decode (function).
• framebyframe-next (function).
• framedata (function).
• frameinfo (class).
• frameinfo-abr-rate (function).
• (setf frameinfo-abr-rate) (function).
• frameinfo-bitrate (function).
• (setf frameinfo-bitrate) (function).
• frameinfo-emphasis (function).
• (setf frameinfo-emphasis) (function).
• frameinfo-flags (function).
• (setf frameinfo-flags) (function).
• frameinfo-framesize (function).
• (setf frameinfo-framesize) (function).
• frameinfo-layer (function).
• (setf frameinfo-layer) (function).
• frameinfo-mode (function).
• (setf frameinfo-mode) (function).
• frameinfo-mode-ext (function).
• (setf frameinfo-mode-ext) (function).
• frameinfo-rate (function).
• (setf frameinfo-rate) (function).
• frameinfo-vbr (function).
• (setf frameinfo-vbr) (function).
• frameinfo-version (function).
• (setf frameinfo-version) (function).
• framelength (function).
• framepos (function).
• free-string (function).
• geteq (function).
• getformat (function).
• getpar (function).
• getparam (function).
• getstate (function).
• getvolume (function).
• grow-string (function).
• handle (class).
• icy (constant).
• icy (function).
• icy2utf8 (function).
• id3 (constant).
• id3 (function).
• id3v1 (class).
• id3v1-album (function).
• (setf id3v1-album) (function).
• id3v1-artist (function).
• (setf id3v1-artist) (function).
• id3v1-comment (function).
• (setf id3v1-comment) (function).
• id3v1-genre (function).
• (setf id3v1-genre) (function).
• id3v1-tag (function).
• (setf id3v1-tag) (function).
• id3v1-title (function).
• (setf id3v1-title) (function).
• id3v1-year (function).
• (setf id3v1-year) (function).
• id3v2 (class).
• id3v2-album (function).
• (setf id3v2-album) (function).
• id3v2-artist (function).
• (setf id3v2-artist) (function).
• id3v2-comment (function).
• (setf id3v2-comment) (function).
• id3v2-comment-list (function).
• (setf id3v2-comment-list) (function).
• id3v2-comments (function).
• (setf id3v2-comments) (function).
• id3v2-extra (function).
• (setf id3v2-extra) (function).
• id3v2-extras (function).
• (setf id3v2-extras) (function).
• id3v2-genre (function).
• (setf id3v2-genre) (function).
• id3v2-picture (function).
• (setf id3v2-picture) (function).
• id3v2-pictures (function).
• (setf id3v2-pictures) (function).
• id3v2-text (function).
• (setf id3v2-text) (function).
• id3v2-texts (function).
• (setf id3v2-texts) (function).
• id3v2-title (function).
• (setf id3v2-title) (function).
• id3v2-version (function).
• (setf id3v2-version) (function).
• id3v2-year (function).
• (setf id3v2-year) (function).
• index (function).
• info (function).
• init (function).
• init-string (function).
• length (function).
• meta-check (function).
• meta-free (function).
• mstring (class).
• mstring-fill (function).
• (setf mstring-fill) (function).
• mstring-p (function).
• (setf mstring-p) (function).
• mstring-size (function).
• (setf mstring-size) (function).
• new (function).
• new-icy (constant).
• new-id3 (constant).
• new-pars (function).
• open (function).
• open-fd (function).
• open-feed (function).
• open-handle (function).
• outblock (function).
• par (function).
• param (function).
• parnew (function).
• pars (class).
• picture (class).
• picture-data (function).
• (setf picture-data) (function).
• picture-description (function).
• (setf picture-description) (function).
• picture-mime-type (function).
• (setf picture-mime-type) (function).
• picture-size (function).
• (setf picture-size) (function).
• picture-type (function).
• (setf picture-type) (function).
• plain-strerror (function).
• position (function).
• rates (function).
• read (function).
• replace-buffer (function).
• replace-reader (function).
• replace-reader-handle (function).
• reset-eq (function).
• resize-string (function).
• safe-buffer (function).
• samplesize (function).
• scan (function).
• seek (function).
• seek-frame (function).
• set-filesize (function).
• set-index (function).
• set-string (function).
• set-substring (function).
• spf (function).
• store-utf8 (function).
• strerror (function).
• strlen (function).
• supported-decoders (function).
• tell (function).
• tell-stream (function).
• tellframe (function).
• text (class).
• text-description (function).
• (setf text-description) (function).
• text-id (function).
• (setf text-id) (function).
• text-lang (function).
• (setf text-lang) (function).
• text-text (function).
• (setf text-text) (function).
• timeframe (function).
• tpf (function).
• volume (function).
• volume-change (function).

Internals

*here* (special variable).

---

3.1.6 cl-mpg123/id3-data.lisp

Dependency

low-level.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface

• *id3v1-genre-list* (special variable).
• *id3v2-type-map* (special variable).
• id3v1-genre (function).
• id3v2-genre (function).
• id3v2-type (function).

---

3.1.7 cl-mpg123/metadata.lisp

Dependency

id3-data.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface

• data (reader method).
• description (reader method).
• field (function).
• field-text (function).
• fields (reader method).
• kind (reader method).
• metadata (class).
• mime-type (reader method).
• picture (class).
• pictures (reader method).
• reinitialize-instance (method).
• shared-initialize (method).
• shared-initialize (method).
• version (reader method).

Internals

• do-text-array (macro).
• map-text-array (function).

---

3.1.8 cl-mpg123/wrapper.lisp

Dependency

metadata.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface

• accepted-format (reader method).
• auto-resample (reader method).
• buffer (reader method).
• (setf buffer) (writer method).
• buffer-size (reader method).
• (setf buffer-size) (writer method).
• channels (reader method).
• connect (function).
• connected (reader method).
• decode (function).
• decode-frame (function).
• decode-frames (reader method).
• decoder (reader method).
• (setf decoder) (function).
• decoders (function).
• describe-object (method).
• disconnect (function).
• down-sample (reader method).
• downspeed (reader method).
• encoding (reader method).
• equalizer (function).
• (setf equalizer) (function).
• exit (function).
• file (class).
• file-format (function).
• force-8bit (reader method).
• force-channels (reader method).
• force-float (reader method).
• force-rate (reader method).
• frame-count (function).
• frame-position (function).
• frame-samples (function).
• frame-seconds (function).
• fuzzy-seek (reader method).
• gapless (reader method).
• handle (reader method).
• ignore-infoframe (reader method).
• index-size (reader method).
• info (function).
• init (function).
• make-file (function).
• metadata (function).
• outscale (reader method).
• parse-pictures (reader method).
• path (reader method).
• preframes (reader method).
• print-object (method).
• process (function).
• process-into-vector (function).
• process-to-vector (function).
• rate (reader method).
• read-directly (function).
• reinitialize-instance (method).
• reset-equalizer (function).
• rva (reader method).
• sample-count (function).
• sample-position (function).
• scan (function).
• scanned (reader method).
• seek (function).
• shared-initialize (method).
• skip-id3v2 (reader method).
• start-frame (reader method).
• stream-position (function).
• supported-decoders (function).
• supported-encodings (function).
• supported-rates (function).
• time-frame-index (function).
• track-length (function).
• track-position (function).
• upspeed (reader method).
• volume (function).
• (setf volume) (function).

Internals

• *init* (special variable).
• *print-object-path-limit* (special variable).
• check-connected (function).
• configure-properties (function).
• decode-directly (function).
• decode-flags (function).
• dispose-handle (function).
• encode-channels (function).
• encode-encodings (function).
• format-time (function).
• set-connected (writer method).
• set-scanned (writer method).

---

3.1.9 cl-mpg123/documentation.lisp

Dependency

wrapper.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

---

5.1.1 Constants

Constant: icy ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Constant: id3 ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Constant: new-icy ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Constant: new-id3 ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

---

5.1.2 Special variables

Special Variable: *id3v1-genre-list* ¶

A list of genres that the ID3V1 genre index references. Includes WinAmp extensions. See https://de.wikipedia.org/wiki/Liste_der_ID3v1-Genres

Package

cl-mpg123.

Source

id3-data.lisp.

Special Variable: *id3v2-type-map* ¶

A map of id3v2 frame type name to human-readable names. See http://id3.org/d3v2.3.0

Package

cl-mpg123.

Source

id3-data.lisp.

Special Variable: *static* ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

---

5.1.3 Ordinary functions

Function: add-string (mstring stuff) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: add-substring (mstring stuff from count) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: chomp-string (mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: clip (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: close (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: connect (file &key path) ¶

Connects the file to the underlying file on the filesystem.

This will trigger parsing of several pieces of information within the file and open the path to querying the file for properties. Naturally it will also allow actually decoding the file.

See FILE
See CONNECTED
See CONNECTION-FAILED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: copy-string (from to) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: current-decoder (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: decode (handle inmemory inmemsize outmemory outmemsize done) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: decode (file input output) ¶

Decodes data from the given input vector to the given output vector.

Returns the number of bytes decoded.

See DECODE-DIRECTLY

Package

cl-mpg123.

Source

wrapper.lisp.

Function: decode-frame (handle num audio bytes) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: decode-frame (file) ¶

Decodes the next frame into the library’s internal buffer.

This does not store it into the file buffer! BUFFER will not have changed!

See FILE
See FRAME-DECODE-FAILED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: decoder (handle name) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf decoder) (file) ¶

Package

cl-mpg123.

Source

wrapper.lisp.

Function: decoders () ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: decoders () ¶

Returns a list of all decoder backends the library knows about.

See SUPPORTED-DECODERS

Package

cl-mpg123.

Source

wrapper.lisp.

Function: delete (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: delete-pars (pars) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: disconnect (file) ¶

Disconnects the file from the underlying file on the filesystem.

This will free up the file descriptor. And prevent you from decoding any more data until the file is connected again.

See FILE
See CONNECTED
See DISCONNECTION-FAILED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: enc-from-id3 (id3-enc-byte) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: encodings (list number) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: encsize (encoding) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: eq (handle channel band val) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: equalizer (file channel band) ¶

Accesses the equalizer value for the given channel and band.

Channel must be within [0,31].

This is SETFable.

See EQUALIZER-QUERY-FAILED
See EQUALIZER-SET-FAILED
See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: (setf equalizer) (file channel band) ¶

Package

cl-mpg123.

Source

wrapper.lisp.

Function: errcode (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: exit () ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: exit () ¶

Cleans up the underlying library if not already done so.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: feature (key) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: feed (handle in size) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: feedseek (handle sampleoff whence input-offset) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: field (name metadata) ¶

Gathers all fields matching the requested type into a list.

The field type is excluded, so each match is a list of three values: language, description, and text.

On an unknown ID3V2 frame type name, an error is signalled.

See METADATA
See FIELDS
See ID3V2-TYPE

Package

cl-mpg123.

Source

metadata.lisp.

Function: field-text (name metadata) ¶

Returns all text values of the matching fields as multiple values.

This is mostly for convenience when you only care about one or more text values of a field.

See FIELD

Package

cl-mpg123.

Source

metadata.lisp.

Function: file-format (file) ¶

Returns information about the file’s actual format.

Returned are three values, the rate in Hertz, the channels, and the encoding used.

See RATE
See CHANNELS
See ENCODING
See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: fmt (pars rate channels encodings) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: fmt-all (pars) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: fmt-channels (pointer-to-fmt) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf fmt-channels) (pointer-to-fmt) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: fmt-encoding (pointer-to-fmt) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf fmt-encoding) (pointer-to-fmt) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: fmt-none (pars) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: fmt-rate (pointer-to-fmt) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf fmt-rate) (pointer-to-fmt) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: fmt-support (pars rate encoding) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: format (handle rate channels encodings) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: format-all (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: format-none (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: format-support (handle rate encoding) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frame-count (file) ¶

Returns the number of frames in the file.

Performs a SCAN if necessary.

See FILE
See SCAN

Package

cl-mpg123.

Source

wrapper.lisp.

Function: frame-position (file) ¶

Returns the current position as a frame index.

See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: frame-samples (file) ¶

Returns the number of samples per frame.

Performs a SCAN if necessary.

See FILE
See SCAN

Package

cl-mpg123.

Source

wrapper.lisp.

Function: frame-seconds (file) ¶

Returns the number of seconds a frame encompasses.

Performs a SCAN if necessary.

See FILE
See SCAN

Package

cl-mpg123.

Source

wrapper.lisp.

Function: framebyframe-decode (handle num audio bytes) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: framebyframe-next (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: framedata (handle header bodydata bodybytes) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-abr-rate (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-abr-rate) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-bitrate (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-bitrate) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-emphasis (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-emphasis) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-flags (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-flags) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-framesize (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-framesize) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-layer (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-layer) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-mode (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-mode) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-mode-ext (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-mode-ext) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-rate (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-rate) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-vbr (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-vbr) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: frameinfo-version (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf frameinfo-version) (pointer-to-frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: framelength (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: framepos (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: free-string (mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: geteq (handle channel band) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: getformat (handle rate channels encoding) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: getpar (pars type value fvalue) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: getparam (handle type value fvalue) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: getstate (handle key val fval) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: getvolume (handle base really rva-db) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: grow-string (mstring news) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: icy (handle icy-meta) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: icy2utf8 (icy_text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3 (handle v1 v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v1-album (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v1-album) (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v1-artist (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v1-artist) (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v1-comment (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v1-comment) (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v1-genre (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v1-genre) (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v1-genre (num) ¶

Returns the name of the corresponding genre of the integer as defined by id3v1.

Package

cl-mpg123.

Source

id3-data.lisp.

Function: id3v1-tag (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v1-tag) (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v1-title (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v1-title) (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v1-year (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v1-year) (pointer-to-id3v1) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-album (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-album) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-artist (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-artist) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-comment (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-comment) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-comment-list (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-comment-list) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-comments (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-comments) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-extra (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-extra) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-extras (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-extras) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-genre (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-genre) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-genre (genre) ¶

Parses the ID3V2 genre string into a list of genres.
More specifically, it handles ID3V1 references, of which there can be multiple.

Package

cl-mpg123.

Source

id3-data.lisp.

Function: id3v2-picture (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-picture) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-pictures (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-pictures) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-text (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-text) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-texts (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-texts) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-title (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-title) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-type (name) ¶

Returns the id3v2 frame type keyword for the passed equivalent human-readable name.

Package

cl-mpg123.

Source

id3-data.lisp.

Function: id3v2-version (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-version) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: id3v2-year (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf id3v2-year) (pointer-to-id3v2) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: index (handle offsets step fill) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: info (handle frameinfo) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: info (file) ¶

Returns various information about the current frame.

Returned is a plist with the following fields: :VERSION The MPEG version, 1.0/2.0/2.5
:LAYER The MPEG layer, 1/2/3
:RATE The sample rate in Hertz
:MODE The channel mode
:MODE-EXT The mode extension bit flag
:FLAGS A list of frame flags
:EMPHASIS The emphasis type
:BITRATE The bitrate in kbps
:ABR-RATE The target average bitrate
:VBR The VBR mode

See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: init () ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: init () ¶

Prepares the underlying library if not already done so.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: init-string (mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: length (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: make-file (path &rest args &key &allow-other-keys) ¶

Create a new file object pointing to the given path.

See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: meta-check (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: meta-free (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: metadata (file &optional id3v1-encoding) ¶

Returns a fresh metadata object created from the scanned ID3 tags.

Performs a SCAN if necessary.

The :ID3V1-ENCODING argument specifies which encoding to use for the strings in ID3V1 tags, as that is not formally specified and might vary by file.

See FILE
See SCAN
See METADATA

Package

cl-mpg123.

Source

wrapper.lisp.

Function: mstring-fill (pointer-to-mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf mstring-fill) (pointer-to-mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: mstring-p (pointer-to-mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf mstring-p) (pointer-to-mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: mstring-size (pointer-to-mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf mstring-size) (pointer-to-mstring) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: new (decoder error) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: new-pars (error) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: open (handle path) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: open-fd (handle fd) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: open-feed (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: open-handle (handle iohandle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: outblock (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: par (pars type value fvalue) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: param (handle type value fvalue) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: parnew (pars decoder error) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: picture-data (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf picture-data) (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: picture-description (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf picture-description) (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: picture-mime-type (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf picture-mime-type) (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: picture-size (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf picture-size) (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: picture-type (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf picture-type) (pointer-to-picture) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: plain-strerror (errcode) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: position (handle frame-offset buffered-bytes current-frame frames-left current-seconds seconds-left) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: process (file) ¶

Decodes data from the file into the internal buffer.

Note that this will fail grossly if the file’s buffer-size / buffer is NIL.

Returns the number of bytes read. See BUFFER for the pointer to the C buffer where the actual data is stored.

See READ-DIRECTLY
See BUFFER
See BUFFER-SIZE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: process-into-vector (file vector &optional offset) ¶

Decodes data from the file into the given octet-vector.

Returns the number of bytes read.

At most (min (length vector) (buffer-size file)) bytes are read.

See PROCESS

Package

cl-mpg123.

Source

wrapper.lisp.

Function: process-to-vector (file) ¶

Decodes data from the file into a new (unsigned-byte 8) vector.

The returned vector will have the exact length fitting to the amount of data decoded.

See PROCESS

Package

cl-mpg123.

Source

wrapper.lisp.

Function: rates (list number) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: read (handle outmemory outmemsize done) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: read-directly (file buffer-pointer buffer-size) ¶

Decodes data from the file and stores it in BUFFER, reading at most BUFFER-SIZE bytes.

Returns the number of bytes that were stored in the buffer.

See FILE
See PROCESS
See READ-FAILED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: replace-buffer (handle data size) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: replace-reader (handle r_read r_lseek) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: replace-reader-handle (handle r_read r_lseek cleanup) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: reset-eq (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: reset-equalizer (file) ¶

Resets the equalizer to its initial values. Which is to say it disables it.

See EQUALIZER-RESET-FAILED
See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: resize-string (mstring news) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: safe-buffer () ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: sample-count (file) ¶

Returns the number of samples in the file.

Performs a SCAN if necessary.

See FILE
See SCAN

Package

cl-mpg123.

Source

wrapper.lisp.

Function: sample-position (file) ¶

Returns the current position as a sample index.

See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: samplesize (enc) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: scan (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: scan (file) ¶

Scans the file for information.

This is only done if a scan has not already been performed.

See SCANNED
See FILE
See SCAN-FAILED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: seek (handle sampleoff whence) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: seek (file position &key mode by) ¶

Seek in the frame.

MODE can be one of :ABSOLUTE :RELATIVE :FROM-END which decides whether the given position should be absolute, relative to the current position, or from the end, respectively.

BY can be one of :SAMPLE :FRAME :SECOND which decides whether seeking should be by the sample, frame, or track seconds index.

Returns the new position as sample, frame, or track seconds index respectively.

See FILE
See SEEK-FAILED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: seek-frame (handle frameoff whence) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: set-filesize (handle size) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: set-index (handle offsets step fill) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: set-string (mstring stuff) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: set-substring (mstring stuff from count) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: spf (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: store-utf8 (mstring enc source source-size) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: stream-position (file) ¶

Returns the current position in stream as a byte index.

See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: strerror (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: strlen (mstring utf8) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: supported-decoders () ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: supported-decoders () ¶

Returns a list of all supported decoder backends.

See DECODERS
See DECODER

Package

cl-mpg123.

Source

wrapper.lisp.

Function: supported-encodings () ¶

Returns a list of all supported encoding types.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: supported-rates () ¶

Package

cl-mpg123.

Source

wrapper.lisp.

Function: tell (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: tell-stream (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: tellframe (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: text-description (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf text-description) (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: text-id (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf text-id) (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: text-lang (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf text-lang) (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: text-text (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: (setf text-text) (pointer-to-text) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: time-frame-index (file seconds) ¶

Returns the frame index of a given track seconds index.

See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: timeframe (handle sec) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: tpf (handle) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: track-length (file) ¶

Returns the length of the track in seconds.

See FRAME-SECONDS
See FRAME-COUNT

Package

cl-mpg123.

Source

wrapper.lisp.

Function: track-position (file) ¶

Returns the current track seconds position.

See FRAME-SECONDS
See FRAME-POSITION

Package

cl-mpg123.

Source

wrapper.lisp.

Function: volume (handle vol) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

Function: volume (file) ¶

Accesses the volume of the file.

Returned are three values: the base volume, the actual volume including potential changes by RVA, and the RVA adjustment made. The volumes are linear factors, and the RVA adjustment is in decibel.

This is SETFable. On SETF, an additional keyword argument :relative is supported, which says whether to adjust volume relatively to the current value, or absolutely.

See VOLUME-QUERY-FAILED
See VOLUME-SET-FAILED
See FILE

Package

cl-mpg123.

Source

wrapper.lisp.

Function: (setf volume) (file &key relative) ¶

Package

cl-mpg123.

Source

wrapper.lisp.

Function: volume-change (handle change) ¶

Package

cl-mpg123-cffi.

Source

low-level.lisp.

---