The cl-mpg123 Reference Manual

This is the cl-mpg123 Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:16:26 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-mpg123

Bindings to libmpg123, providing cross-platform, fast MPG1/2/3 decoding.

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://Shirakumo.github.io/cl-mpg123/

Source Control

(GIT https://github.com/Shirakumo/cl-mpg123.git)

Bug Tracker

https://github.com/Shirakumo/cl-mpg123/issues

License

zlib

Version

1.0.0

Dependencies
  • cffi (system).
  • trivial-features (system).
  • trivial-garbage (system).
  • documentation-utils (system).
Source

cl-mpg123.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 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

3.1.3 cl-mpg123/toolkit.lisp

Dependency

package.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Internals

3.1.4 cl-mpg123/conditions.lisp

Dependency

toolkit.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface
Internals

3.1.5 cl-mpg123/low-level.lisp

Dependency

conditions.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface
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

3.1.7 cl-mpg123/metadata.lisp

Dependency

id3-data.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface
Internals

3.1.8 cl-mpg123/wrapper.lisp

Dependency

metadata.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).

Public Interface
Internals

3.1.9 cl-mpg123/documentation.lisp

Dependency

wrapper.lisp (file).

Source

cl-mpg123.asd.

Parent Component

cl-mpg123 (system).


4 Packages

Packages are listed by definition order.


4.1 cl-mpg123-cffi

Source

package.lisp.

Nickname

org.shirakumo.fraf.mpg123.cffi

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

*here* (special variable).


4.2 cl-mpg123

Source

package.lisp.

Nickname

org.shirakumo.fraf.mpg123

Use List
  • cffi.
  • 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 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.


5.1.4 Generic functions

Generic Reader: accepted-format (object)

Returns the accepted format for the decoder.

This can be NIL for none, T for all, or a list of three values: (RATE CHANNELS ENCODINGS) where RATE is the accepted rate in Hertz, CHANNELS is one of :left :right :left-right, and ENCODINGS is a list of allowed data encodings, each value being one of:
:int8 :uint8 :int16 :uint16 :int24 :uint24
:int32 :uint32 :ulaw-8 :alaw-8 :float :double

This can be set via the :accepted-format initarg.

See FILE
See CL-MPG123-CFFI:ENC

Package

cl-mpg123.

Methods
Reader Method: accepted-format ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

accepted-format.

Generic Reader: auto-resample (object)

Returns whether to automatic internal resampling of any kind.

This can be set via the :auto-resample initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: auto-resample ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

auto-resample.

Generic Reader: band (condition)

Returns the band that was attempted to be accessed.

Package

cl-mpg123.

Methods
Reader Method: band ((condition equalizer-set-failed))
Source

conditions.lisp.

Target Slot

band.

Reader Method: band ((condition equalizer-query-failed))
Source

conditions.lisp.

Target Slot

band.

Generic Reader: buffer (condition)

Returns a pointer to the C char buffer that is used to store decoded data.

This might be NIL if the buffer-size is NIL.

See FILE
See BUFFER-SIZE

Package

cl-mpg123.

Methods
Reader Method: buffer ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

buffer.

Reader Method: buffer ((condition read-failed))
Source

conditions.lisp.

Target Slot

buffer.

Generic Writer: (setf buffer) (object)
Package

cl-mpg123.

Methods
Writer Method: (setf buffer) ((file file))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

buffer.

Generic Reader: buffer-size (condition)

Returns the size of the internal buffer used to store decoded data.

This can be NIL for no buffer, T for automatic size, or an integer specifying the number of bytes to use. The automatic size is picked by CL-MPG123-CFFI:OUTBLOCK.

This can be set via the :buffer-size initarg.

See FILE
See BUFFER

Package

cl-mpg123.

Methods
Reader Method: buffer-size ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

buffer-size.

Reader Method: buffer-size ((condition read-failed))
Source

conditions.lisp.

Target Slot

buffer-size.

Generic Writer: (setf buffer-size) (object)
Package

cl-mpg123.

Methods
Writer Method: (setf buffer-size) ((file file))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

buffer-size.

Generic Reader: by (condition)

Returns the way by which the seek was performed. Must be one of :SAMPLE :FRAME :SECOND

See SEEK-FAILED

Package

cl-mpg123.

Methods
Reader Method: by ((condition seek-failed))
Source

conditions.lisp.

Target Slot

by.

Generic Reader: channel (condition)

Returns the channel that was attempted to be accessed.

Package

cl-mpg123.

Methods
Reader Method: channel ((condition equalizer-set-failed))
Source

conditions.lisp.

Target Slot

channel.

Reader Method: channel ((condition equalizer-query-failed))
Source

conditions.lisp.

Target Slot

channel.

Generic Reader: channels (object)

Returns the number of channels the decoded file has.

This is NIL until the file is connected.

See FILE
See CONNECT
See FILE-FORMAT

Package

cl-mpg123.

Methods
Reader Method: channels ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

channels.

Generic Reader: connected (object)

Returns whether the file has been connected to the file or not.

Before being connected most queries or actions against the file will fail.

See FILE
See CONNECT

Package

cl-mpg123.

Methods
Reader Method: connected ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

connected.

Generic Reader: data (object)

Returns the actual picture data as an octet-vector.

You are responsible for converting or interpreting the data as needed.

See PICTURE.

Package

cl-mpg123.

Methods
Reader Method: data ((picture picture))

automatically generated reader method

Source

metadata.lisp.

Target Slot

data.

Generic Reader: decode-frames (object)

Returns the number of frames that are decoded or T for all.

This can be set via the :decode-frames initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: decode-frames ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

decode-frames.

Generic Reader: decoder (object)

The decoder driver to use as backend.

See SUPPORTED-DECODERS for a list of decoders that can be used as a backend.

This is SETFable.

See FILE
See DECODER-SET-FAILED

Package

cl-mpg123.

Methods
Reader Method: decoder ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

decoder.

Generic Reader: description (object)

Returns the picture description string.

See PICTURE

Package

cl-mpg123.

Methods
Reader Method: description ((picture picture))

automatically generated reader method

Source

metadata.lisp.

Target Slot

description.

Generic Reader: down-sample (object)

Returns the downsampling approach being used.

Can be one of NIL :NATIVE :HALF-RATE :QUARTER-RATE.

This can be set via the :down-sample initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: down-sample ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

down-sample.

Generic Reader: downspeed (object)

Returns the number of times a frame will be played.

This can be set via the :downspeed initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: downspeed ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

downspeed.

Generic Reader: encoding (object)

Returns the encoding the file is in.

This is NIL until the file is connected.

See FILE
See CONNECT
See FILE-FORMAT

Package

cl-mpg123.

Methods
Reader Method: encoding ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

encoding.

Generic Reader: error-code (condition)

Returns the CL-MPG123-CFFI:ERRORS error-code associated with the condition.

See ERROR-STRING-ERROR
See ERROR-STRING

Package

cl-mpg123.

Methods
Reader Method: error-code ((condition error-string-error))
Source

conditions.lisp.

Target Slot

error.

Generic Function: error-string (error)

Returns the string describing the error code associated with the condition.

See ERROR-STRING-ERROR

Package

cl-mpg123.

Methods
Method: error-string ((error error-string-error))
Source

conditions.lisp.

Generic Reader: fields (object)

Returns the list of fields stored in the metadata.
Each entry in the list is of the following form:

ENTRY ::= (TYPE LANG DESCRIPTION TEXT)
TYPE — A keyword corresponding to the id3v2 frame type name.
LANG — A three-letter language string or NIL if no language was given. DESCRIPTION — A string describing the field or NIL if no description was given. TEXT — The actual text content. Can also be an integer in cases where the data type was known (year, track number).

Note that fields that can potentially contain multiple values of the same type will be split into multiple instances of the same field. For example, a TPE1 frame with text "FOO/BAR" gets split into two TPE1 entries, one with FOO as text and one with BAR.

See METADATA
See FIELD
See FIELD-TEXT

Package

cl-mpg123.

Methods
Reader Method: fields ((metadata metadata))

automatically generated reader method

Source

metadata.lisp.

Target Slot

fields.

Generic Reader: file (condition)

Returns the file associated with the condition.

See FILE
See MPG-FILE-ERROR

Package

cl-mpg123.

Methods
Reader Method: file ((condition volume-set-failed))
Source

conditions.lisp.

Target Slot

file.

Reader Method: file ((condition equalizer-set-failed))
Source

conditions.lisp.

Target Slot

file.

Reader Method: file ((condition equalizer-query-failed))
Source

conditions.lisp.

Target Slot

file.

Reader Method: file ((condition seek-failed))
Source

conditions.lisp.

Target Slot

file.

Reader Method: file ((condition query-failed))
Source

conditions.lisp.

Target Slot

file.

Reader Method: file ((condition decoder-set-failed))
Source

conditions.lisp.

Target Slot

file.

Reader Method: file ((condition connection-failed))
Source

conditions.lisp.

Target Slot

file.

Reader Method: file ((condition mpg-file-error))
Source

conditions.lisp.

Target Slot

file.

Generic Reader: force-8bit (object)

Returns whether to force 8bit formats.

This can be set via the :force-8bit initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: force-8bit ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

force-8bit.

Generic Reader: force-channels (object)

Returns, if at all, which channels are forced.

Can be one of NIL :mono-right :mono-left :mono-mix :stereo.

This can be set via the :force-channels initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: force-channels ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

force-channels.

Generic Reader: force-float (object)

Returns whether to force floating-point output.

This can be set via the :force-float initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: force-float ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

force-float.

Generic Reader: force-rate (object)

Returns, if forced, the rate at which output is produced.

This can be set via the :force-rate initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: force-rate ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

force-rate.

Generic Reader: fuzzy-seek (object)

Returns whether to allow approximate seeking by guessing.

This can be set via the :fuzzy-seek initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: fuzzy-seek ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

fuzzy-seek.

Generic Reader: gapless (object)

Returns whether to use gapless decoding.

This can be set via the :gapless initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: gapless ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

gapless.

Generic Reader: handle (object)

Returns the CL-MPG123-CFFI:HANDLE pointer of the file.

See FILE

Package

cl-mpg123.

Methods
Reader Method: handle ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

handle.

Generic Reader: ignore-infoframe (object)

Returns whether to ignore LAME/Xing info frames and treat them as normal MPEG data.

This can be set via the :ignore-infoframe initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: ignore-infoframe ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

ignore-infoframe.

Generic Reader: in-buffer (condition)

Returns the pointer to the C char buffer used for input on decoding.

Package

cl-mpg123.

Methods
Reader Method: in-buffer ((condition decode-failed))
Source

conditions.lisp.

Target Slot

in-buffer.

Generic Reader: in-size (condition)

Returns the size of the input buffer in bytes.

Package

cl-mpg123.

Methods
Reader Method: in-size ((condition decode-failed))
Source

conditions.lisp.

Target Slot

in-size.

Generic Reader: index-size (object)

Returns the frame index size.

Can be NIL for default, T for dynamic growth, or an integer for specific size (positive) or growth rate (negative).

This can be set via the :index-size initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: index-size ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

index-size.

Generic Reader: kind (object)

Returns the picture type.

Can be one of:
:OTHER :ICON :OTHER-ICON :FRONT-COVER :BACK-COVER :LEAFLET :MEDIA :LEAD :ARTIST :CONDUCTOR :ORCHESTRA :COMPOSER :LYRICIST :LOCATION :RECORDING :PERFORMANCE :VIDEO :FISH :ILLUSTRATION :ARTIST-LOGO :PUBLISHER-LOGO

See PICTURE

Package

cl-mpg123.

Methods
Reader Method: kind ((picture picture))

automatically generated reader method

Source

metadata.lisp.

Target Slot

kind.

Generic Reader: mime-type (object)

Returns the picture data’s mime-type as a string.

See PICTURE

Package

cl-mpg123.

Methods
Reader Method: mime-type ((picture picture))

automatically generated reader method

Source

metadata.lisp.

Target Slot

mime-type.

Generic Reader: mode (condition)

Returns the mode by which the seek was performed. Must be one of :ABSOLUTE :RELATIVE :FROM-END

See SEEK-FAILED

Package

cl-mpg123.

Methods
Reader Method: mode ((condition seek-failed))
Source

conditions.lisp.

Target Slot

mode.

Generic Reader: out-buffer (condition)

Returns the pointer to the C char buffer used for output on decoding.

Package

cl-mpg123.

Methods
Reader Method: out-buffer ((condition decode-failed))
Source

conditions.lisp.

Target Slot

out-buffer.

Generic Reader: out-size (condition)

Returns the size of the output buffer in bytes.

Package

cl-mpg123.

Methods
Reader Method: out-size ((condition decode-failed))
Source

conditions.lisp.

Target Slot

out-size.

Generic Reader: outscale (object)

Returns the output sample amplitude scale.

This can be set via the :outscale initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: outscale ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

outscale.

Generic Reader: parse-pictures (object)

Returns whether ID3V2 APIC tags should be parsed.

This can be set via the :parse-pictures initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: parse-pictures ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

parse-pictures.

Generic Reader: path (condition)

Returns the pathname of the file being accessed.

See FILE
See CONNECT

Package

cl-mpg123.

Methods
Reader Method: path ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

path.

Reader Method: path ((condition connection-failed))
Source

conditions.lisp.

Target Slot

path.

Generic Reader: pictures (object)

Returns the list of pictures stored in the metadata.

See PICTURE
See METADATA

Package

cl-mpg123.

Methods
Reader Method: pictures ((metadata metadata))

automatically generated reader method

Source

metadata.lisp.

Target Slot

pictures.

Generic Reader: preframes (object)

Returns how many frames to decode or ignore in advance for layer 3.

This can be set via the :preframes initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: preframes ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

preframes.

Generic Reader: query (condition)

The function that performed the query that failed.

Package

cl-mpg123.

Methods
Reader Method: query ((condition query-failed))
Source

conditions.lisp.

Target Slot

query.

Generic Reader: rate (object)

Returns the rate in Hertz that the decoded file is in.

This is NIL until the file is connected.

See FILE
See CONNECT
See FILE-FORMAT

Package

cl-mpg123.

Methods
Reader Method: rate ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

rate.

Generic Reader: relative (condition)

Returns whether the volume was attempted to be adjusted relatively or absolutely.

Package

cl-mpg123.

Methods
Reader Method: relative ((condition volume-set-failed))
Source

conditions.lisp.

Target Slot

relative.

Generic Reader: rva (object)

Returns the RVA mode being used.

Can be one of NIL :OFF :MIX :ALBUM.

This can be set via the :down-sample initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: rva ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

rva.

Generic Reader: scanned (object)

Returns whether the file has been scanned for metadata.

Before being scanned, some queries will return inaccurate results or might not be able to return any data at all, in which case they will initiate a scan themselves automatically.

See FILE
See SCAN

Package

cl-mpg123.

Methods
Reader Method: scanned ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

scanned.

Generic Reader: seek-position (condition)

Returns the position to which the seek was performed.

See SEEK-FAILED

Package

cl-mpg123.

Methods
Reader Method: seek-position ((condition seek-failed))
Source

conditions.lisp.

Target Slot

seek-position.

Generic Reader: skip-id3v2 (object)

Returns whether to skip the ID3V2 tag information.

This can be set via the :skip-id3v2 initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: skip-id3v2 ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

skip-id3v2.

Generic Reader: start-frame (object)

Returns the index of the starting frame. Frames before this are not played.

This can be set via the :start-frame initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: start-frame ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

start-frame.

Generic Reader: upspeed (object)

Returns the number of frames between two played frames.

This can be set via the :upspeed initarg.

See FILE

Package

cl-mpg123.

Methods
Reader Method: upspeed ((file file))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

upspeed.

Generic Reader: value (condition)

Returns the value the function tried to set before the condition was signalled.

Package

cl-mpg123.

Methods
Reader Method: value ((condition volume-set-failed))
Source

conditions.lisp.

Target Slot

value.

Reader Method: value ((condition equalizer-set-failed))
Source

conditions.lisp.

Target Slot

value.

Reader Method: value ((condition decoder-set-failed))
Source

conditions.lisp.

Target Slot

value.

Generic Reader: version (object)

The version of the ID3 metadata.
Can be either "1.0" "1.1" "2.3" or "2.4".

See METADATA

Package

cl-mpg123.

Methods
Reader Method: version ((metadata metadata))

automatically generated reader method

Source

metadata.lisp.

Target Slot

version.


5.1.5 Standalone methods

Method: describe-object ((file file) stream)
Source

wrapper.lisp.

Method: print-object ((file file) stream)
Source

wrapper.lisp.

Method: reinitialize-instance :before ((data metadata) &key)
Source

metadata.lisp.

Method: reinitialize-instance :around ((file file) &key)
Source

wrapper.lisp.

Method: shared-initialize :after ((data metadata) slots &key id3v2 id3v1 id3v1-encoding)
Source

metadata.lisp.

Method: shared-initialize :after ((file file) slots &key)
Source

wrapper.lisp.

Method: shared-initialize :after ((picture picture) slots &key struct)
Source

metadata.lisp.


5.1.6 Conditions

Condition: connection-failed

Condition signalled when connecting to/opening the underlying file fails.

See CONNECT
See MPG-FILE-STRING-ERROR
See PATH

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Direct methods
Direct slots
Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

This slot is read-only.

Slot: path
Initform

(quote nil)

Initargs

:path

Readers

path.

Writers

This slot is read-only.

Condition: decode-failed
Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Direct methods
Direct slots
Slot: in-buffer
Initargs

:in-buffer

Readers

in-buffer.

Writers

This slot is read-only.

Slot: out-buffer
Initargs

:out-buffer

Readers

out-buffer.

Writers

This slot is read-only.

Slot: in-size
Initargs

:in-size

Readers

in-size.

Writers

This slot is read-only.

Slot: out-size
Initargs

:out-size

Readers

out-size.

Writers

This slot is read-only.

Condition: decoder-set-failed

Condition signalled when changing the decoder of a file fails.

See VALUE
See (SETF DECODER)
See MPG-FILE-STRING-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Direct methods
Direct slots
Slot: value
Initform

(quote nil)

Initargs

:value

Readers

value.

Writers

This slot is read-only.

Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

This slot is read-only.

Condition: disconnection-failed

Condition signalled when disconnecting from/closing the underlying file fails.

See DISCONNECT
See MPG-FILE-STRING-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Condition: equalizer-reset-failed

Condition signalled when resetting the equalizer failed.

See MPG-FILE-STRING_ERROR
See RESET-EQUALIZER

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Condition: equalizer-set-failed

Condition signalled when setting an equalizer band value failed.

See BAND
See CHANNEL
See MPG-FILE-STRING-ERROR
See (SETF EQUALIZER)

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Direct methods
Direct slots
Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

This slot is read-only.

Slot: band
Initform

(quote nil)

Initargs

:band

Readers

band.

Writers

This slot is read-only.

Slot: channel
Initform

(quote nil)

Initargs

:channel

Readers

channel.

Writers

This slot is read-only.

Slot: value
Initform

(quote nil)

Initargs

:value

Readers

value.

Writers

This slot is read-only.

Condition: error-string-error

Condition superclass for all errors that include an error string from the underlying library.

See MPG-ERROR
See ERROR-CODE
See ERROR-STRING

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-error.

Direct subclasses
Direct methods
Direct slots
Slot: error
Package

common-lisp.

Initform

(quote nil)

Initargs

:error

Readers

error-code.

Writers

This slot is read-only.

Condition: frame-decode-failed

Condition signalled when mpg123 fails to decode a frame.

See MPG-FILE-STRING-ERROR
See DECODE-FRAME

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Condition: generic-error

A generic error class to be used in situations where no more specific class applies.

See FORM
See ERROR-STRING-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

error-string-error.

Direct subclasses

query-failed.

Direct methods

form.

Direct slots
Slot: form
Initform

(quote nil)

Initargs

:form

Readers

form.

Writers

This slot is read-only.

Condition: handler-creation-failed

Condition signalled when creating a new mpg handler object fails.

See MPG-FILE-STRING-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Condition: id3-query-failed

Condition signalled when retrieving the ID3 metadata failed.

See MPG-FILE-STRING-ERROR
See METADATA

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Condition: init-failed

Condition signalled in the case that the initialisation of the library fails.

See INIT
See ERROR-STRING-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

error-string-error.

Condition: mpg-error

Condition superclass for all errors related to this library.

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

error.

Direct subclasses
Condition: mpg-file-error

Condition superclass for all errors that relate to a FILE object.

See FILE
See MPG-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-error.

Direct subclasses
Direct methods

file.

Direct slots
Slot: file
Initargs

:file

Readers

file.

Writers

This slot is read-only.

Condition: mpg-file-string-error

Combination of MPG-FILE-ERROR and ERROR-STRING-ERROR.

See MPG-FILE-ERROR
See ERROR-STRING-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses
Direct subclasses
Condition: not-connected

Condition signalled when an attempt is made to use a function that requires the file object to be connected, but it isn’t.

See MPG-FILE-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-error.

Condition: query-failed

Generic condition signalled when the querying for a value failed.

See QUERY
See MPG-FILE-ERROR
See GENERIC-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: query
Initform

(quote nil)

Initargs

:query

Readers

query.

Writers

This slot is read-only.

Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

This slot is read-only.

Condition: read-failed

Condition signalled when mpg123 fails to read into a buffer.

See BUFFER
See BUFFER-SIZE
See MPG-FILE-STRING-ERROR
See DIRECT-READ

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Direct methods
Direct slots
Slot: buffer
Initargs

:buffer

Readers

buffer.

Writers

This slot is read-only.

Slot: buffer-size
Initargs

:buffer-size

Readers

buffer-size.

Writers

This slot is read-only.

Condition: scan-failed

Condition signalled when scanning the file for metadata failed.

See MPG-FILE-STRING-ERROR
See SCAN

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Condition: seek-failed

Condition signalled when a seek to a different position in the file failed.

See BY
See MODE
See SEEK-POSITION
See MPG-FILE-ERROR
See SEEK

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-error.

Direct methods
Direct slots
Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

This slot is read-only.

Slot: by
Initform

(quote nil)

Initargs

:by

Readers

by.

Writers

This slot is read-only.

Slot: mode
Initform

(quote nil)

Initargs

:mode

Readers

mode.

Writers

This slot is read-only.

Slot: seek-position
Initform

(quote nil)

Initargs

:seek-position

Readers

seek-position.

Writers

This slot is read-only.

Condition: unknown-id3v2-frame-type

Condition signalled when an unknown id3v2 frame type name is requested from a metadata object.

See NAME
See METADATA
See MPG-ERROR

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-error.

Direct methods

name.

Direct slots
Slot: name
Initform

(quote nil)

Initargs

:name

Readers

name.

Writers

This slot is read-only.

Condition: volume-query-failed

Condition signalled when querying for the current volume failed.

See MPG-FILE-STRING-ERROR
See VOLUME

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Condition: volume-set-failed

Condition signalled when setting the current volume failed.

See MPG-FILE-STRING-ERROR
See (SETF VOLUME)
See RELATIVE
See VALUE

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-string-error.

Direct methods
Direct slots
Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

This slot is read-only.

Slot: relative
Initform

(quote nil)

Initargs

:relative

Readers

relative.

Writers

This slot is read-only.

Slot: value
Initform

(quote nil)

Initargs

:value

Readers

value.

Writers

This slot is read-only.


5.1.7 Classes

Class: file

Container class for a file.

Manages all the decoding information so that it is easily accessible.
Also takes care of managing the underlying C values so that you don’t
have to worry about garbage collection or buffer allocation and so forth.
It also takes care of setting up the desired decoding parameters and flags.

The slots of the file are not settable, however you can reconfigure the
file at any point using REINITIALIZE-INSTANCE. Note that this will have
to DISCONNECT the file and delete its handle first. It will reCONNECT
if it was previously connected, but you cannot do this if you are in the
middle of processing data or need to otherwise preserve state.

You can find more information about most of the properties that can be set
via initargs in the mpg123.h mpg123_params and mpg123_param_flags enums.
See https://www.mpg123.de/api/group__mpg123__init.shtml#ga73a8ff3363028b89afc72b3ea032b9cb

See HANDLE
See CONNECTED
See SCANNED
See BUFFER
See RATE
See CHANNELS
See ENCODING
See PATH
See DECODER
See ACCEPTED-FORMAT
See BUFFER-SIZE
See FORCE-RATE
See DOWN-SAMPLE
See RVA
See DOWNSPEED
See UPSPEED
See START-FRAME
See DECODE-FRAMES
See OUTSCALE
See INDEX-SIZE
See PREFRAMES
See FORCE-CHANNELS
See FORCE-8BIT
See GAPLESS
See FUZZY-SEEK
See FORCE-FLOAT
See SKIP-ID3V2
See IGNORE-INFOFRAME
See AUTO-RESAMPLE
See PICTURES
See CONNECT
See DISCONNECT
See READ-DIRECTLY
See PROCESS
See PROCESS-TO-VECTOR
See PROCESS-INTO-VECTOR
See DECODE
See DECODE-FRAME
See SAMPLE-POSITION
See FRAME-POSITION
See STREAM-POSITION
See SEEK
See TIME-FRAME-INDEX
See EQUALIZER
See RESET-EQUALIZER
See VOLUME
See INFO
See FILE-FORMAT
See SCAN
See FRAME-COUNT
See SAMPLE-COUNT
See FRAME-SECONDS
See FRAME-SAMPLES
See TRACK-LENGTH
See METADATA

Package

cl-mpg123.

Source

wrapper.lisp.

Direct methods
Direct Default Initargs
InitargValue
:pathnil
:decodernil
:accepted-formatt
:buffer-sizet
:force-ratenil
:down-samplenil
:rvaoff
:downspeednil
:upspeednil
:start-framenil
:decode-framest
:outscalet
:index-sizenil
:preframes4
:force-channelsnil
:force-8bitnil
:gaplesst
:fuzzy-seeknil
:force-floatnil
:skip-id3v2nil
:ignore-infoframenil
:auto-resamplet
:parse-picturest
Direct slots
Slot: handle
Readers

handle.

Writers

This slot is read-only.

Slot: connected
Readers

connected.

Writers

set-connected.

Slot: scanned
Readers

scanned.

Writers

set-scanned.

Slot: buffer
Readers

buffer.

Writers

(setf buffer).

Slot: rate
Readers

rate.

Writers

This slot is read-only.

Slot: channels
Readers

channels.

Writers

This slot is read-only.

Slot: encoding
Readers

encoding.

Writers

This slot is read-only.

Slot: path
Initargs

:path

Readers

path.

Writers

This slot is read-only.

Slot: decoder
Initargs

:decoder

Readers

decoder.

Writers

This slot is read-only.

Slot: accepted-format
Initargs

:accepted-format

Readers

accepted-format.

Writers

This slot is read-only.

Slot: buffer-size
Initargs

:buffer-size

Readers

buffer-size.

Writers

(setf buffer-size).

Slot: force-rate
Initargs

:force-rate

Readers

force-rate.

Writers

This slot is read-only.

Slot: down-sample
Initargs

:down-sample

Readers

down-sample.

Writers

This slot is read-only.

Slot: rva
Initargs

:rva

Readers

rva.

Writers

This slot is read-only.

Slot: downspeed
Initargs

:downspeed

Readers

downspeed.

Writers

This slot is read-only.

Slot: upspeed
Initargs

:upspeed

Readers

upspeed.

Writers

This slot is read-only.

Slot: start-frame
Initargs

:start-frame

Readers

start-frame.

Writers

This slot is read-only.

Slot: decode-frames
Initargs

:decode-frames

Readers

decode-frames.

Writers

This slot is read-only.

Slot: outscale
Initargs

:outscale

Readers

outscale.

Writers

This slot is read-only.

Slot: index-size
Initargs

:index-size

Readers

index-size.

Writers

This slot is read-only.

Slot: preframes
Initargs

:preframes

Readers

preframes.

Writers

This slot is read-only.

Slot: force-channels
Initargs

:force-channels

Readers

force-channels.

Writers

This slot is read-only.

Slot: force-8bit
Initargs

:force-8bit

Readers

force-8bit.

Writers

This slot is read-only.

Slot: gapless
Initargs

:gapless

Readers

gapless.

Writers

This slot is read-only.

Slot: fuzzy-seek
Initargs

:fuzzy-seek

Readers

fuzzy-seek.

Writers

This slot is read-only.

Slot: force-float
Initargs

:force-float

Readers

force-float.

Writers

This slot is read-only.

Slot: skip-id3v2
Initargs

:skip-id3v2

Readers

skip-id3v2.

Writers

This slot is read-only.

Slot: ignore-infoframe
Initargs

:ignore-infoframe

Readers

ignore-infoframe.

Writers

This slot is read-only.

Slot: auto-resample
Initargs

:auto-resample

Readers

auto-resample.

Writers

This slot is read-only.

Slot: parse-pictures
Initargs

:parse-pictures

Readers

parse-pictures.

Writers

This slot is read-only.

Class: fmt
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: frameinfo
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: handle
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: id3v1
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: id3v2
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: metadata

Class container for ID3 metadata.

When re/initialising this, you should pass the ID3V1/2 struct pointers as the respective initargs. Note that ID3V1 and ID3V2 values will coexist, but ID3V2 values should always come before ID3V1 values in the resulting fields list. Also note that duplicate (by EQUAL) entries are not stored.

Note that when the metadata is reinitialised, all fields and pictures are cleared out first, before potentially being repopulated by the passed args.

Note that ID3V1 text values are by default parsed by UTF-8 first and by ISO-8859-1 if that fails. See DIRECT-STR. You can override the UTF-8 default by specifying the :ID3V1-ENCODING initarg.

See METADATA
See VERSION
See FIELDS
See PICTURES
See FIELD
See FIELD-TEXT

Package

cl-mpg123.

Source

metadata.lisp.

Direct methods
Direct slots
Slot: version
Readers

version.

Writers

This slot is read-only.

Slot: fields
Readers

fields.

Writers

This slot is read-only.

Slot: pictures
Readers

pictures.

Writers

This slot is read-only.

Class: mstring
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: pars
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: picture
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: picture

Container class for a picture encapsulated in an ID3 tag.

The data is copied over to a lisp (unsigned-byte 8) vector, so the picture data will stay fresh even if the source file or id3 data is freed.

See KIND
See DESCRIPTION
See MIME-TYPE
See DATA

Package

cl-mpg123.

Source

metadata.lisp.

Direct methods
Direct slots
Slot: kind
Readers

kind.

Writers

This slot is read-only.

Slot: description
Readers

description.

Writers

This slot is read-only.

Slot: mime-type
Readers

mime-type.

Writers

This slot is read-only.

Slot: data
Readers

data.

Writers

This slot is read-only.

Class: text
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

5.2 Internals


5.2.1 Special variables

Special Variable: *here*
Package

cl-mpg123-cffi.

Source

low-level.lisp.

Special Variable: *init*

Stores whether CL-MPG123-CFFI:INIT has been called or not.

Package

cl-mpg123.

Source

wrapper.lisp.

Special Variable: *print-object-path-limit*

Sets the amount of characters printed of the path of the FILE during PRINT-OBJECT.

See FILE

Package

cl-mpg123.

Source

wrapper.lisp.


5.2.2 Macros

Macro: define-direct-condition (name superclasses format-string &rest args)

Expands to DEFINE-SIMPLE-CONDITION except automatically constructing slots for each access to C.

See DEFINE-SIMPLE-CONDITION

Package

cl-mpg123.

Source

conditions.lisp.

Macro: define-simple-condition (name superclasses &body report)

Shorthand for DEFINE-CONDITION.
If the first argument in the body is a list, it is taken as the slots list. Otherwise the arguments are the format string and arguments for the report.

In the report body, C is bound to the condition and S to the stream.

Package

cl-mpg123.

Source

conditions.lisp.

Macro: do-text-array ((lang id description text) (array size) &body body)
Package

cl-mpg123.

Source

metadata.lisp.

Macro: with-error ((err datum &rest datum-args &key ok &allow-other-keys) &body form)

Handle a form that returns a CL-MPG123-CFFI:ERRORS enum value.

Package

cl-mpg123.

Source

toolkit.lisp.

Macro: with-foreign-values (bindings &body body)

Same as CFFI:WITH-FOREIGN-OBJECTS except resolving the bindings at the end and returning them as multiple values.

Package

cl-mpg123.

Source

toolkit.lisp.

Macro: with-generic-error (&body form)

Simple variant of WITH-ERROR that signals a generic variant.
Uses of this should be replaced by more explicit condition signals later.

Package

cl-mpg123.

Source

toolkit.lisp.

Macro: with-negative-error ((datum &rest datum-args) &body form)

Handle a form that errors when its result is negative.

Package

cl-mpg123.

Source

toolkit.lisp.

Macro: with-value-args (bindings call &body body)

Same as CFFI:WITH-FOREIGN-OBJECTS except that after CALL the bindings contain the resolved values.

Package

cl-mpg123.

Source

toolkit.lisp.

Macro: with-zero-error ((datum &rest datum-args) &body form)

Handle a form that errors when its result is zero.

Package

cl-mpg123.

Source

toolkit.lisp.


5.2.3 Ordinary functions

Function: check-connected (file)

Checks whether the file is connected or not. If not, an error is signalled.

See FILE
See CONNECTED
See NOT-CONNECTED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: configure-properties (file)
Package

cl-mpg123.

Source

wrapper.lisp.

Function: decode-directly (file in in-size out out-size)

Decodes data from the given input array pointer to the given output array pointer.

Returns the number of bytes decoded.

See FILE
See DECODE-FAILED

Package

cl-mpg123.

Source

wrapper.lisp.

Function: decode-flags (flags)

Decodes the flags integer into a list of flag enum keywords.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: direct-str (pointer length &optional encoding)

Translate the string pointed to by POINTER into a string of max LENGTH.
If the translated string is empty, NIL is returned.

At first the string is attempted to be decoded by the specified ENCODING. If this fails, it is instead decoded by ISO-8859-1.

Package

cl-mpg123.

Source

toolkit.lisp.

Function: dispose-handle (handle)

Cleans up the handle and deallocates it.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: encode-channels (channels)

Encodes the list of channels as a single integer by ORing their values together.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: encode-encodings (encodings)

Encodes the list of encodings as a single integer by ORing their values together.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: format-time (secs)

Formats the given seconds in H:MM:SS format.

Package

cl-mpg123.

Source

wrapper.lisp.

Function: map-text-array (func array size)
Package

cl-mpg123.

Source

metadata.lisp.

Function: mstring (mstring)

Translates an CL-MPG123-CFFI:MSTRING struct or pointer to such a struct to a string. If the translated string is empty, NIL is returned.

Package

cl-mpg123.

Source

toolkit.lisp.

Function: split (string char)

Splits the string on each occurrence of char, dropping empty substrings.

Package

cl-mpg123.

Source

toolkit.lisp.

Function: string-nil (string)

When the argument is NIL or an empty string, return NIL, otherwise return the argument.

Package

cl-mpg123.

Source

toolkit.lisp.


5.2.4 Generic functions

Generic Reader: form (condition)

Returns he form that caused the generic error.

See GENERIC-ERROR

Package

cl-mpg123.

Methods
Reader Method: form ((condition generic-error))
Source

conditions.lisp.

Target Slot

form.

Generic Reader: name (condition)

Returns the name of the erroneously requested id3v2 frame type.

See UNKNOWN-ID3v2-FRAME-TYPE

Package

cl-mpg123.

Methods
Reader Method: name ((condition unknown-id3v2-frame-type))
Source

conditions.lisp.

Target Slot

name.

Generic Writer: set-connected (new-value object)
Package

cl-mpg123.

Methods
Writer Method: set-connected ((new-value file) file)

automatically generated writer method

Source

wrapper.lisp.

Target Slot

connected.

Generic Writer: set-scanned (new-value object)
Package

cl-mpg123.

Methods
Writer Method: set-scanned ((new-value file) file)

automatically generated writer method

Source

wrapper.lisp.

Target Slot

scanned.


5.2.5 Conditions

Condition: equalizer-query-failed

Condition signalled when querying for an equalizer band value failed.

See BAND
See CHANNEL
See MPG-FILE-ERROR
See EQUALIZER

Package

cl-mpg123.

Source

conditions.lisp.

Direct superclasses

mpg-file-error.

Direct methods
Direct slots
Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

This slot is read-only.

Slot: band
Initform

(quote nil)

Initargs

:band

Readers

band.

Writers

This slot is read-only.

Slot: channel
Initform

(quote nil)

Initargs

:channel

Readers

channel.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

(
(setf buffer): Public generic functions
(setf buffer): Public generic functions
(setf buffer-size): Public generic functions
(setf buffer-size): Public generic functions
(setf decoder): Public ordinary functions
(setf equalizer): Public ordinary functions
(setf fmt-channels): Public ordinary functions
(setf fmt-encoding): Public ordinary functions
(setf fmt-rate): Public ordinary functions
(setf frameinfo-abr-rate): Public ordinary functions
(setf frameinfo-bitrate): Public ordinary functions
(setf frameinfo-emphasis): Public ordinary functions
(setf frameinfo-flags): Public ordinary functions
(setf frameinfo-framesize): Public ordinary functions
(setf frameinfo-layer): Public ordinary functions
(setf frameinfo-mode): Public ordinary functions
(setf frameinfo-mode-ext): Public ordinary functions
(setf frameinfo-rate): Public ordinary functions
(setf frameinfo-vbr): Public ordinary functions
(setf frameinfo-version): Public ordinary functions
(setf id3v1-album): Public ordinary functions
(setf id3v1-artist): Public ordinary functions
(setf id3v1-comment): Public ordinary functions
(setf id3v1-genre): Public ordinary functions
(setf id3v1-tag): Public ordinary functions
(setf id3v1-title): Public ordinary functions
(setf id3v1-year): Public ordinary functions
(setf id3v2-album): Public ordinary functions
(setf id3v2-artist): Public ordinary functions
(setf id3v2-comment): Public ordinary functions
(setf id3v2-comment-list): Public ordinary functions
(setf id3v2-comments): Public ordinary functions
(setf id3v2-extra): Public ordinary functions
(setf id3v2-extras): Public ordinary functions
(setf id3v2-genre): Public ordinary functions
(setf id3v2-picture): Public ordinary functions
(setf id3v2-pictures): Public ordinary functions
(setf id3v2-text): Public ordinary functions
(setf id3v2-texts): Public ordinary functions
(setf id3v2-title): Public ordinary functions
(setf id3v2-version): Public ordinary functions
(setf id3v2-year): Public ordinary functions
(setf mstring-fill): Public ordinary functions
(setf mstring-p): Public ordinary functions
(setf mstring-size): Public ordinary functions
(setf picture-data): Public ordinary functions
(setf picture-description): Public ordinary functions
(setf picture-mime-type): Public ordinary functions
(setf picture-size): Public ordinary functions
(setf picture-type): Public ordinary functions
(setf text-description): Public ordinary functions
(setf text-id): Public ordinary functions
(setf text-lang): Public ordinary functions
(setf text-text): Public ordinary functions
(setf volume): Public ordinary functions

A
accepted-format: Public generic functions
accepted-format: Public generic functions
add-string: Public ordinary functions
add-substring: Public ordinary functions
auto-resample: Public generic functions
auto-resample: Public generic functions

B
band: Public generic functions
band: Public generic functions
band: Public generic functions
buffer: Public generic functions
buffer: Public generic functions
buffer: Public generic functions
buffer-size: Public generic functions
buffer-size: Public generic functions
buffer-size: Public generic functions
by: Public generic functions
by: Public generic functions

C
channel: Public generic functions
channel: Public generic functions
channel: Public generic functions
channels: Public generic functions
channels: Public generic functions
check-connected: Private ordinary functions
chomp-string: Public ordinary functions
clip: Public ordinary functions
close: Public ordinary functions
configure-properties: Private ordinary functions
connect: Public ordinary functions
connected: Public generic functions
connected: Public generic functions
copy-string: Public ordinary functions
current-decoder: Public ordinary functions

D
data: Public generic functions
data: Public generic functions
decode: Public ordinary functions
decode: Public ordinary functions
decode-directly: Private ordinary functions
decode-flags: Private ordinary functions
decode-frame: Public ordinary functions
decode-frame: Public ordinary functions
decode-frames: Public generic functions
decode-frames: Public generic functions
decoder: Public ordinary functions
decoder: Public generic functions
decoder: Public generic functions
decoders: Public ordinary functions
decoders: Public ordinary functions
define-direct-condition: Private macros
define-simple-condition: Private macros
delete: Public ordinary functions
delete-pars: Public ordinary functions
describe-object: Public standalone methods
description: Public generic functions
description: Public generic functions
direct-str: Private ordinary functions
disconnect: Public ordinary functions
dispose-handle: Private ordinary functions
do-text-array: Private macros
down-sample: Public generic functions
down-sample: Public generic functions
downspeed: Public generic functions
downspeed: Public generic functions

E
enc-from-id3: Public ordinary functions
encode-channels: Private ordinary functions
encode-encodings: Private ordinary functions
encoding: Public generic functions
encoding: Public generic functions
encodings: Public ordinary functions
encsize: Public ordinary functions
eq: Public ordinary functions
equalizer: Public ordinary functions
errcode: Public ordinary functions
error-code: Public generic functions
error-code: Public generic functions
error-string: Public generic functions
error-string: Public generic functions
exit: Public ordinary functions
exit: Public ordinary functions

F
feature: Public ordinary functions
feed: Public ordinary functions
feedseek: Public ordinary functions
field: Public ordinary functions
field-text: Public ordinary functions
fields: Public generic functions
fields: Public generic functions
file: Public generic functions
file: Public generic functions
file: Public generic functions
file: Public generic functions
file: Public generic functions
file: Public generic functions
file: Public generic functions
file: Public generic functions
file: Public generic functions
file-format: Public ordinary functions
fmt: Public ordinary functions
fmt-all: Public ordinary functions
fmt-channels: Public ordinary functions
fmt-encoding: Public ordinary functions
fmt-none: Public ordinary functions
fmt-rate: Public ordinary functions
fmt-support: Public ordinary functions
force-8bit: Public generic functions
force-8bit: Public generic functions
force-channels: Public generic functions
force-channels: Public generic functions
force-float: Public generic functions
force-float: Public generic functions
force-rate: Public generic functions
force-rate: Public generic functions
form: Private generic functions
form: Private generic functions
format: Public ordinary functions
format-all: Public ordinary functions
format-none: Public ordinary functions
format-support: Public ordinary functions
format-time: Private ordinary functions
frame-count: Public ordinary functions
frame-position: Public ordinary functions
frame-samples: Public ordinary functions
frame-seconds: Public ordinary functions
framebyframe-decode: Public ordinary functions
framebyframe-next: Public ordinary functions
framedata: Public ordinary functions
frameinfo-abr-rate: Public ordinary functions
frameinfo-bitrate: Public ordinary functions
frameinfo-emphasis: Public ordinary functions
frameinfo-flags: Public ordinary functions
frameinfo-framesize: Public ordinary functions
frameinfo-layer: Public ordinary functions
frameinfo-mode: Public ordinary functions
frameinfo-mode-ext: Public ordinary functions
frameinfo-rate: Public ordinary functions
frameinfo-vbr: Public ordinary functions
frameinfo-version: Public ordinary functions
framelength: Public ordinary functions
framepos: Public ordinary functions
free-string: Public ordinary functions
Function, (setf decoder): Public ordinary functions
Function, (setf equalizer): Public ordinary functions
Function, (setf fmt-channels): Public ordinary functions
Function, (setf fmt-encoding): Public ordinary functions
Function, (setf fmt-rate): Public ordinary functions
Function, (setf frameinfo-abr-rate): Public ordinary functions
Function, (setf frameinfo-bitrate): Public ordinary functions
Function, (setf frameinfo-emphasis): Public ordinary functions
Function, (setf frameinfo-flags): Public ordinary functions
Function, (setf frameinfo-framesize): Public ordinary functions
Function, (setf frameinfo-layer): Public ordinary functions
Function, (setf frameinfo-mode): Public ordinary functions
Function, (setf frameinfo-mode-ext): Public ordinary functions
Function, (setf frameinfo-rate): Public ordinary functions
Function, (setf frameinfo-vbr): Public ordinary functions
Function, (setf frameinfo-version): Public ordinary functions
Function, (setf id3v1-album): Public ordinary functions
Function, (setf id3v1-artist): Public ordinary functions
Function, (setf id3v1-comment): Public ordinary functions
Function, (setf id3v1-genre): Public ordinary functions
Function, (setf id3v1-tag): Public ordinary functions
Function, (setf id3v1-title): Public ordinary functions
Function, (setf id3v1-year): Public ordinary functions
Function, (setf id3v2-album): Public ordinary functions
Function, (setf id3v2-artist): Public ordinary functions
Function, (setf id3v2-comment): Public ordinary functions
Function, (setf id3v2-comment-list): Public ordinary functions
Function, (setf id3v2-comments): Public ordinary functions
Function, (setf id3v2-extra): Public ordinary functions
Function, (setf id3v2-extras): Public ordinary functions
Function, (setf id3v2-genre): Public ordinary functions
Function, (setf id3v2-picture): Public ordinary functions
Function, (setf id3v2-pictures): Public ordinary functions
Function, (setf id3v2-text): Public ordinary functions
Function, (setf id3v2-texts): Public ordinary functions
Function, (setf id3v2-title): Public ordinary functions
Function, (setf id3v2-version): Public ordinary functions
Function, (setf id3v2-year): Public ordinary functions
Function, (setf mstring-fill): Public ordinary functions
Function, (setf mstring-p): Public ordinary functions
Function, (setf mstring-size): Public ordinary functions
Function, (setf picture-data): Public ordinary functions
Function, (setf picture-description): Public ordinary functions
Function, (setf picture-mime-type): Public ordinary functions
Function, (setf picture-size): Public ordinary functions
Function, (setf picture-type): Public ordinary functions
Function, (setf text-description): Public ordinary functions
Function, (setf text-id): Public ordinary functions
Function, (setf text-lang): Public ordinary functions
Function, (setf text-text): Public ordinary functions
Function, (setf volume): Public ordinary functions
Function, add-string: Public ordinary functions
Function, add-substring: Public ordinary functions
Function, check-connected: Private ordinary functions
Function, chomp-string: Public ordinary functions
Function, clip: Public ordinary functions
Function, close: Public ordinary functions
Function, configure-properties: Private ordinary functions
Function, connect: Public ordinary functions
Function, copy-string: Public ordinary functions
Function, current-decoder: Public ordinary functions
Function, decode: Public ordinary functions
Function, decode: Public ordinary functions
Function, decode-directly: Private ordinary functions
Function, decode-flags: Private ordinary functions
Function, decode-frame: Public ordinary functions
Function, decode-frame: Public ordinary functions
Function, decoder: Public ordinary functions
Function, decoders: Public ordinary functions
Function, decoders: Public ordinary functions
Function, delete: Public ordinary functions
Function, delete-pars: Public ordinary functions
Function, direct-str: Private ordinary functions
Function, disconnect: Public ordinary functions
Function, dispose-handle: Private ordinary functions
Function, enc-from-id3: Public ordinary functions
Function, encode-channels: Private ordinary functions
Function, encode-encodings: Private ordinary functions
Function, encodings: Public ordinary functions
Function, encsize: Public ordinary functions
Function, eq: Public ordinary functions
Function, equalizer: Public ordinary functions
Function, errcode: Public ordinary functions
Function, exit: Public ordinary functions
Function, exit: Public ordinary functions
Function, feature: Public ordinary functions
Function, feed: Public ordinary functions
Function, feedseek: Public ordinary functions
Function, field: Public ordinary functions
Function, field-text: Public ordinary functions
Function, file-format: Public ordinary functions
Function, fmt: Public ordinary functions
Function, fmt-all: Public ordinary functions
Function, fmt-channels: Public ordinary functions
Function, fmt-encoding: Public ordinary functions
Function, fmt-none: Public ordinary functions
Function, fmt-rate: Public ordinary functions
Function, fmt-support: Public ordinary functions
Function, format: Public ordinary functions
Function, format-all: Public ordinary functions
Function, format-none: Public ordinary functions
Function, format-support: Public ordinary functions
Function, format-time: Private ordinary functions
Function, frame-count: Public ordinary functions
Function, frame-position: Public ordinary functions
Function, frame-samples: Public ordinary functions
Function, frame-seconds: Public ordinary functions
Function, framebyframe-decode: Public ordinary functions
Function, framebyframe-next: Public ordinary functions
Function, framedata: Public ordinary functions
Function, frameinfo-abr-rate: Public ordinary functions
Function, frameinfo-bitrate: Public ordinary functions
Function, frameinfo-emphasis: Public ordinary functions
Function, frameinfo-flags: Public ordinary functions
Function, frameinfo-framesize: Public ordinary functions
Function, frameinfo-layer: Public ordinary functions
Function, frameinfo-mode: Public ordinary functions
Function, frameinfo-mode-ext: Public ordinary functions
Function, frameinfo-rate: Public ordinary functions
Function, frameinfo-vbr: Public ordinary functions
Function, frameinfo-version: Public ordinary functions
Function, framelength: Public ordinary functions
Function, framepos: Public ordinary functions
Function, free-string: Public ordinary functions
Function, geteq: Public ordinary functions
Function, getformat: Public ordinary functions
Function, getpar: Public ordinary functions
Function, getparam: Public ordinary functions
Function, getstate: Public ordinary functions
Function, getvolume: Public ordinary functions
Function, grow-string: Public ordinary functions
Function, icy: Public ordinary functions
Function, icy2utf8: Public ordinary functions
Function, id3: Public ordinary functions
Function, id3v1-album: Public ordinary functions
Function, id3v1-artist: Public ordinary functions
Function, id3v1-comment: Public ordinary functions
Function, id3v1-genre: Public ordinary functions
Function, id3v1-genre: Public ordinary functions
Function, id3v1-tag: Public ordinary functions
Function, id3v1-title: Public ordinary functions
Function, id3v1-year: Public ordinary functions
Function, id3v2-album: Public ordinary functions
Function, id3v2-artist: Public ordinary functions
Function, id3v2-comment: Public ordinary functions
Function, id3v2-comment-list: Public ordinary functions
Function, id3v2-comments: Public ordinary functions
Function, id3v2-extra: Public ordinary functions
Function, id3v2-extras: Public ordinary functions
Function, id3v2-genre: Public ordinary functions
Function, id3v2-genre: Public ordinary functions
Function, id3v2-picture: Public ordinary functions
Function, id3v2-pictures: Public ordinary functions
Function, id3v2-text: Public ordinary functions
Function, id3v2-texts: Public ordinary functions
Function, id3v2-title: Public ordinary functions
Function, id3v2-type: Public ordinary functions
Function, id3v2-version: Public ordinary functions
Function, id3v2-year: Public ordinary functions
Function, index: Public ordinary functions
Function, info: Public ordinary functions
Function, info: Public ordinary functions
Function, init: Public ordinary functions
Function, init: Public ordinary functions
Function, init-string: Public ordinary functions
Function, length: Public ordinary functions
Function, make-file: Public ordinary functions
Function, map-text-array: Private ordinary functions
Function, meta-check: Public ordinary functions
Function, meta-free: Public ordinary functions
Function, metadata: Public ordinary functions
Function, mstring: Private ordinary functions
Function, mstring-fill: Public ordinary functions
Function, mstring-p: Public ordinary functions
Function, mstring-size: Public ordinary functions
Function, new: Public ordinary functions
Function, new-pars: Public ordinary functions
Function, open: Public ordinary functions
Function, open-fd: Public ordinary functions
Function, open-feed: Public ordinary functions
Function, open-handle: Public ordinary functions
Function, outblock: Public ordinary functions
Function, par: Public ordinary functions
Function, param: Public ordinary functions
Function, parnew: Public ordinary functions
Function, picture-data: Public ordinary functions
Function, picture-description: Public ordinary functions
Function, picture-mime-type: Public ordinary functions
Function, picture-size: Public ordinary functions
Function, picture-type: Public ordinary functions
Function, plain-strerror: Public ordinary functions
Function, position: Public ordinary functions
Function, process: Public ordinary functions
Function, process-into-vector: Public ordinary functions
Function, process-to-vector: Public ordinary functions
Function, rates: Public ordinary functions
Function, read: Public ordinary functions
Function, read-directly: Public ordinary functions
Function, replace-buffer: Public ordinary functions
Function, replace-reader: Public ordinary functions
Function, replace-reader-handle: Public ordinary functions
Function, reset-eq: Public ordinary functions
Function, reset-equalizer: Public ordinary functions
Function, resize-string: Public ordinary functions
Function, safe-buffer: Public ordinary functions
Function, sample-count: Public ordinary functions
Function, sample-position: Public ordinary functions
Function, samplesize: Public ordinary functions
Function, scan: Public ordinary functions
Function, scan: Public ordinary functions
Function, seek: Public ordinary functions
Function, seek: Public ordinary functions
Function, seek-frame: Public ordinary functions
Function, set-filesize: Public ordinary functions
Function, set-index: Public ordinary functions
Function, set-string: Public ordinary functions
Function, set-substring: Public ordinary functions
Function, spf: Public ordinary functions
Function, split: Private ordinary functions
Function, store-utf8: Public ordinary functions
Function, stream-position: Public ordinary functions
Function, strerror: Public ordinary functions
Function, string-nil: Private ordinary functions
Function, strlen: Public ordinary functions
Function, supported-decoders: Public ordinary functions
Function, supported-decoders: Public ordinary functions
Function, supported-encodings: Public ordinary functions
Function, supported-rates: Public ordinary functions
Function, tell: Public ordinary functions
Function, tell-stream: Public ordinary functions
Function, tellframe: Public ordinary functions
Function, text-description: Public ordinary functions
Function, text-id: Public ordinary functions
Function, text-lang: Public ordinary functions
Function, text-text: Public ordinary functions
Function, time-frame-index: Public ordinary functions
Function, timeframe: Public ordinary functions
Function, tpf: Public ordinary functions
Function, track-length: Public ordinary functions
Function, track-position: Public ordinary functions
Function, volume: Public ordinary functions
Function, volume: Public ordinary functions
Function, volume-change: Public ordinary functions
fuzzy-seek: Public generic functions
fuzzy-seek: Public generic functions

G
gapless: Public generic functions
gapless: Public generic functions
Generic Function, (setf buffer): Public generic functions
Generic Function, (setf buffer-size): Public generic functions
Generic Function, accepted-format: Public generic functions
Generic Function, auto-resample: Public generic functions
Generic Function, band: Public generic functions
Generic Function, buffer: Public generic functions
Generic Function, buffer-size: Public generic functions
Generic Function, by: Public generic functions
Generic Function, channel: Public generic functions
Generic Function, channels: Public generic functions
Generic Function, connected: Public generic functions
Generic Function, data: Public generic functions
Generic Function, decode-frames: Public generic functions
Generic Function, decoder: Public generic functions
Generic Function, description: Public generic functions
Generic Function, down-sample: Public generic functions
Generic Function, downspeed: Public generic functions
Generic Function, encoding: Public generic functions
Generic Function, error-code: Public generic functions
Generic Function, error-string: Public generic functions
Generic Function, fields: Public generic functions
Generic Function, file: Public generic functions
Generic Function, force-8bit: Public generic functions
Generic Function, force-channels: Public generic functions
Generic Function, force-float: Public generic functions
Generic Function, force-rate: Public generic functions
Generic Function, form: Private generic functions
Generic Function, fuzzy-seek: Public generic functions
Generic Function, gapless: Public generic functions
Generic Function, handle: Public generic functions
Generic Function, ignore-infoframe: Public generic functions
Generic Function, in-buffer: Public generic functions
Generic Function, in-size: Public generic functions
Generic Function, index-size: Public generic functions
Generic Function, kind: Public generic functions
Generic Function, mime-type: Public generic functions
Generic Function, mode: Public generic functions
Generic Function, name: Private generic functions
Generic Function, out-buffer: Public generic functions
Generic Function, out-size: Public generic functions
Generic Function, outscale: Public generic functions
Generic Function, parse-pictures: Public generic functions
Generic Function, path: Public generic functions
Generic Function, pictures: Public generic functions
Generic Function, preframes: Public generic functions
Generic Function, query: Public generic functions
Generic Function, rate: Public generic functions
Generic Function, relative: Public generic functions
Generic Function, rva: Public generic functions
Generic Function, scanned: Public generic functions
Generic Function, seek-position: Public generic functions
Generic Function, set-connected: Private generic functions
Generic Function, set-scanned: Private generic functions
Generic Function, skip-id3v2: Public generic functions
Generic Function, start-frame: Public generic functions
Generic Function, upspeed: Public generic functions
Generic Function, value: Public generic functions
Generic Function, version: Public generic functions
geteq: Public ordinary functions
getformat: Public ordinary functions
getpar: Public ordinary functions
getparam: Public ordinary functions
getstate: Public ordinary functions
getvolume: Public ordinary functions
grow-string: Public ordinary functions

H
handle: Public generic functions
handle: Public generic functions

I
icy: Public ordinary functions
icy2utf8: Public ordinary functions
id3: Public ordinary functions
id3v1-album: Public ordinary functions
id3v1-artist: Public ordinary functions
id3v1-comment: Public ordinary functions
id3v1-genre: Public ordinary functions
id3v1-genre: Public ordinary functions
id3v1-tag: Public ordinary functions
id3v1-title: Public ordinary functions
id3v1-year: Public ordinary functions
id3v2-album: Public ordinary functions
id3v2-artist: Public ordinary functions
id3v2-comment: Public ordinary functions
id3v2-comment-list: Public ordinary functions
id3v2-comments: Public ordinary functions
id3v2-extra: Public ordinary functions
id3v2-extras: Public ordinary functions
id3v2-genre: Public ordinary functions
id3v2-genre: Public ordinary functions
id3v2-picture: Public ordinary functions
id3v2-pictures: Public ordinary functions
id3v2-text: Public ordinary functions
id3v2-texts: Public ordinary functions
id3v2-title: Public ordinary functions
id3v2-type: Public ordinary functions
id3v2-version: Public ordinary functions
id3v2-year: Public ordinary functions
ignore-infoframe: Public generic functions
ignore-infoframe: Public generic functions
in-buffer: Public generic functions
in-buffer: Public generic functions
in-size: Public generic functions
in-size: Public generic functions
index: Public ordinary functions
index-size: Public generic functions
index-size: Public generic functions
info: Public ordinary functions
info: Public ordinary functions
init: Public ordinary functions
init: Public ordinary functions
init-string: Public ordinary functions

K
kind: Public generic functions
kind: Public generic functions

L
length: Public ordinary functions

M
Macro, define-direct-condition: Private macros
Macro, define-simple-condition: Private macros
Macro, do-text-array: Private macros
Macro, with-error: Private macros
Macro, with-foreign-values: Private macros
Macro, with-generic-error: Private macros
Macro, with-negative-error: Private macros
Macro, with-value-args: Private macros
Macro, with-zero-error: Private macros
make-file: Public ordinary functions
map-text-array: Private ordinary functions
meta-check: Public ordinary functions
meta-free: Public ordinary functions
metadata: Public ordinary functions
Method, (setf buffer): Public generic functions
Method, (setf buffer-size): Public generic functions
Method, accepted-format: Public generic functions
Method, auto-resample: Public generic functions
Method, band: Public generic functions
Method, band: Public generic functions
Method, buffer: Public generic functions
Method, buffer: Public generic functions
Method, buffer-size: Public generic functions
Method, buffer-size: Public generic functions
Method, by: Public generic functions
Method, channel: Public generic functions
Method, channel: Public generic functions
Method, channels: Public generic functions
Method, connected: Public generic functions
Method, data: Public generic functions
Method, decode-frames: Public generic functions
Method, decoder: Public generic functions
Method, describe-object: Public standalone methods
Method, description: Public generic functions
Method, down-sample: Public generic functions
Method, downspeed: Public generic functions
Method, encoding: Public generic functions
Method, error-code: Public generic functions
Method, error-string: Public generic functions
Method, fields: Public generic functions
Method, file: Public generic functions
Method, file: Public generic functions
Method, file: Public generic functions
Method, file: Public generic functions
Method, file: Public generic functions
Method, file: Public generic functions
Method, file: Public generic functions
Method, file: Public generic functions
Method, force-8bit: Public generic functions
Method, force-channels: Public generic functions
Method, force-float: Public generic functions
Method, force-rate: Public generic functions
Method, form: Private generic functions
Method, fuzzy-seek: Public generic functions
Method, gapless: Public generic functions
Method, handle: Public generic functions
Method, ignore-infoframe: Public generic functions
Method, in-buffer: Public generic functions
Method, in-size: Public generic functions
Method, index-size: Public generic functions
Method, kind: Public generic functions
Method, mime-type: Public generic functions
Method, mode: Public generic functions
Method, name: Private generic functions
Method, out-buffer: Public generic functions
Method, out-size: Public generic functions
Method, outscale: Public generic functions
Method, parse-pictures: Public generic functions
Method, path: Public generic functions
Method, path: Public generic functions
Method, pictures: Public generic functions
Method, preframes: Public generic functions
Method, print-object: Public standalone methods
Method, query: Public generic functions
Method, rate: Public generic functions
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, relative: Public generic functions
Method, rva: Public generic functions
Method, scanned: Public generic functions
Method, seek-position: Public generic functions
Method, set-connected: Private generic functions
Method, set-scanned: Private generic functions
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, skip-id3v2: Public generic functions
Method, start-frame: Public generic functions
Method, upspeed: Public generic functions
Method, value: Public generic functions
Method, value: Public generic functions
Method, value: Public generic functions
Method, version: Public generic functions
mime-type: Public generic functions
mime-type: Public generic functions
mode: Public generic functions
mode: Public generic functions
mstring: Private ordinary functions
mstring-fill: Public ordinary functions
mstring-p: Public ordinary functions
mstring-size: Public ordinary functions

N
name: Private generic functions
name: Private generic functions
new: Public ordinary functions
new-pars: Public ordinary functions

O
open: Public ordinary functions
open-fd: Public ordinary functions
open-feed: Public ordinary functions
open-handle: Public ordinary functions
out-buffer: Public generic functions
out-buffer: Public generic functions
out-size: Public generic functions
out-size: Public generic functions
outblock: Public ordinary functions
outscale: Public generic functions
outscale: Public generic functions

P
par: Public ordinary functions
param: Public ordinary functions
parnew: Public ordinary functions
parse-pictures: Public generic functions
parse-pictures: Public generic functions
path: Public generic functions
path: Public generic functions
path: Public generic functions
picture-data: Public ordinary functions
picture-description: Public ordinary functions
picture-mime-type: Public ordinary functions
picture-size: Public ordinary functions
picture-type: Public ordinary functions
pictures: Public generic functions
pictures: Public generic functions
plain-strerror: Public ordinary functions
position: Public ordinary functions
preframes: Public generic functions
preframes: Public generic functions
print-object: Public standalone methods
process: Public ordinary functions
process-into-vector: Public ordinary functions
process-to-vector: Public ordinary functions

Q
query: Public generic functions
query: Public generic functions

R
rate: Public generic functions
rate: Public generic functions
rates: Public ordinary functions
read: Public ordinary functions
read-directly: Public ordinary functions
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
relative: Public generic functions
relative: Public generic functions
replace-buffer: Public ordinary functions
replace-reader: Public ordinary functions
replace-reader-handle: Public ordinary functions
reset-eq: Public ordinary functions
reset-equalizer: Public ordinary functions
resize-string: Public ordinary functions
rva: Public generic functions
rva: Public generic functions

S
safe-buffer: Public ordinary functions
sample-count: Public ordinary functions
sample-position: Public ordinary functions
samplesize: Public ordinary functions
scan: Public ordinary functions
scan: Public ordinary functions
scanned: Public generic functions
scanned: Public generic functions
seek: Public ordinary functions
seek: Public ordinary functions
seek-frame: Public ordinary functions
seek-position: Public generic functions
seek-position: Public generic functions
set-connected: Private generic functions
set-connected: Private generic functions
set-filesize: Public ordinary functions
set-index: Public ordinary functions
set-scanned: Private generic functions
set-scanned: Private generic functions
set-string: Public ordinary functions
set-substring: Public ordinary functions
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
skip-id3v2: Public generic functions
skip-id3v2: Public generic functions
spf: Public ordinary functions
split: Private ordinary functions
start-frame: Public generic functions
start-frame: Public generic functions
store-utf8: Public ordinary functions
stream-position: Public ordinary functions
strerror: Public ordinary functions
string-nil: Private ordinary functions
strlen: Public ordinary functions
supported-decoders: Public ordinary functions
supported-decoders: Public ordinary functions
supported-encodings: Public ordinary functions
supported-rates: Public ordinary functions

T
tell: Public ordinary functions
tell-stream: Public ordinary functions
tellframe: Public ordinary functions
text-description: Public ordinary functions
text-id: Public ordinary functions
text-lang: Public ordinary functions
text-text: Public ordinary functions
time-frame-index: Public ordinary functions
timeframe: Public ordinary functions
tpf: Public ordinary functions
track-length: Public ordinary functions
track-position: Public ordinary functions

U
upspeed: Public generic functions
upspeed: Public generic functions

V
value: Public generic functions
value: Public generic functions
value: Public generic functions
value: Public generic functions
version: Public generic functions
version: Public generic functions
volume: Public ordinary functions
volume: Public ordinary functions
volume-change: Public ordinary functions

W
with-error: Private macros
with-foreign-values: Private macros
with-generic-error: Private macros
with-negative-error: Private macros
with-value-args: Private macros
with-zero-error: Private macros


A.3 Variables

Jump to:   *  
A   B   C   D   E   F   G   H   I   K   M   N   O   P   Q   R   S   U   V  
Index Entry  Section

*
*here*: Private special variables
*id3v1-genre-list*: Public special variables
*id3v2-type-map*: Public special variables
*init*: Private special variables
*print-object-path-limit*: Private special variables
*static*: Public special variables

A
accepted-format: Public classes
auto-resample: Public classes

B
band: Public conditions
band: Private conditions
buffer: Public conditions
buffer: Public classes
buffer-size: Public conditions
buffer-size: Public classes
by: Public conditions

C
channel: Public conditions
channel: Private conditions
channels: Public classes
connected: Public classes
Constant, icy: Public constants
Constant, id3: Public constants
Constant, new-icy: Public constants
Constant, new-id3: Public constants

D
data: Public classes
decode-frames: Public classes
decoder: Public classes
description: Public classes
down-sample: Public classes
downspeed: Public classes

E
encoding: Public classes
error: Public conditions

F
fields: Public classes
file: Public conditions
file: Public conditions
file: Public conditions
file: Public conditions
file: Public conditions
file: Public conditions
file: Public conditions
file: Private conditions
force-8bit: Public classes
force-channels: Public classes
force-float: Public classes
force-rate: Public classes
form: Public conditions
fuzzy-seek: Public classes

G
gapless: Public classes

H
handle: Public classes

I
icy: Public constants
id3: Public constants
ignore-infoframe: Public classes
in-buffer: Public conditions
in-size: Public conditions
index-size: Public classes

K
kind: Public classes

M
mime-type: Public classes
mode: Public conditions

N
name: Public conditions
new-icy: Public constants
new-id3: Public constants

O
out-buffer: Public conditions
out-size: Public conditions
outscale: Public classes

P
parse-pictures: Public classes
path: Public conditions
path: Public classes
pictures: Public classes
preframes: Public classes

Q
query: Public conditions

R
rate: Public classes
relative: Public conditions
rva: Public classes

S
scanned: Public classes
seek-position: Public conditions
skip-id3v2: Public classes
Slot, accepted-format: Public classes
Slot, auto-resample: Public classes
Slot, band: Public conditions
Slot, band: Private conditions
Slot, buffer: Public conditions
Slot, buffer: Public classes
Slot, buffer-size: Public conditions
Slot, buffer-size: Public classes
Slot, by: Public conditions
Slot, channel: Public conditions
Slot, channel: Private conditions
Slot, channels: Public classes
Slot, connected: Public classes
Slot, data: Public classes
Slot, decode-frames: Public classes
Slot, decoder: Public classes
Slot, description: Public classes
Slot, down-sample: Public classes
Slot, downspeed: Public classes
Slot, encoding: Public classes
Slot, error: Public conditions
Slot, fields: Public classes
Slot, file: Public conditions
Slot, file: Public conditions
Slot, file: Public conditions
Slot, file: Public conditions
Slot, file: Public conditions
Slot, file: Public conditions
Slot, file: Public conditions
Slot, file: Private conditions
Slot, force-8bit: Public classes
Slot, force-channels: Public classes
Slot, force-float: Public classes
Slot, force-rate: Public classes
Slot, form: Public conditions
Slot, fuzzy-seek: Public classes
Slot, gapless: Public classes
Slot, handle: Public classes
Slot, ignore-infoframe: Public classes
Slot, in-buffer: Public conditions
Slot, in-size: Public conditions
Slot, index-size: Public classes
Slot, kind: Public classes
Slot, mime-type: Public classes
Slot, mode: Public conditions
Slot, name: Public conditions
Slot, out-buffer: Public conditions
Slot, out-size: Public conditions
Slot, outscale: Public classes
Slot, parse-pictures: Public classes
Slot, path: Public conditions
Slot, path: Public classes
Slot, pictures: Public classes
Slot, preframes: Public classes
Slot, query: Public conditions
Slot, rate: Public classes
Slot, relative: Public conditions
Slot, rva: Public classes
Slot, scanned: Public classes
Slot, seek-position: Public conditions
Slot, skip-id3v2: Public classes
Slot, start-frame: Public classes
Slot, upspeed: Public classes
Slot, value: Public conditions
Slot, value: Public conditions
Slot, value: Public conditions
Slot, version: Public classes
Special Variable, *here*: Private special variables
Special Variable, *id3v1-genre-list*: Public special variables
Special Variable, *id3v2-type-map*: Public special variables
Special Variable, *init*: Private special variables
Special Variable, *print-object-path-limit*: Private special variables
Special Variable, *static*: Public special variables
start-frame: Public classes

U
upspeed: Public classes

V
value: Public conditions
value: Public conditions
value: Public conditions
version: Public classes


A.4 Data types

Jump to:   C   D   E   F   G   H   I   L   M   N   P   Q   R   S   T   U   V   W  
Index Entry  Section

C
cl-mpg123: The cl-mpg123 system
cl-mpg123: The cl-mpg123 package
cl-mpg123-cffi: The cl-mpg123-cffi package
cl-mpg123.asd: The cl-mpg123/cl-mpg123․asd file
Class, file: Public classes
Class, fmt: Public classes
Class, frameinfo: Public classes
Class, handle: Public classes
Class, id3v1: Public classes
Class, id3v2: Public classes
Class, metadata: Public classes
Class, mstring: Public classes
Class, pars: Public classes
Class, picture: Public classes
Class, picture: Public classes
Class, text: Public classes
Condition, connection-failed: Public conditions
Condition, decode-failed: Public conditions
Condition, decoder-set-failed: Public conditions
Condition, disconnection-failed: Public conditions
Condition, equalizer-query-failed: Private conditions
Condition, equalizer-reset-failed: Public conditions
Condition, equalizer-set-failed: Public conditions
Condition, error-string-error: Public conditions
Condition, frame-decode-failed: Public conditions
Condition, generic-error: Public conditions
Condition, handler-creation-failed: Public conditions
Condition, id3-query-failed: Public conditions
Condition, init-failed: Public conditions
Condition, mpg-error: Public conditions
Condition, mpg-file-error: Public conditions
Condition, mpg-file-string-error: Public conditions
Condition, not-connected: Public conditions
Condition, query-failed: Public conditions
Condition, read-failed: Public conditions
Condition, scan-failed: Public conditions
Condition, seek-failed: Public conditions
Condition, unknown-id3v2-frame-type: Public conditions
Condition, volume-query-failed: Public conditions
Condition, volume-set-failed: Public conditions
conditions.lisp: The cl-mpg123/conditions․lisp file
connection-failed: Public conditions

D
decode-failed: Public conditions
decoder-set-failed: Public conditions
disconnection-failed: Public conditions
documentation.lisp: The cl-mpg123/documentation․lisp file

E
equalizer-query-failed: Private conditions
equalizer-reset-failed: Public conditions
equalizer-set-failed: Public conditions
error-string-error: Public conditions

F
file: Public classes
File, cl-mpg123.asd: The cl-mpg123/cl-mpg123․asd file
File, conditions.lisp: The cl-mpg123/conditions․lisp file
File, documentation.lisp: The cl-mpg123/documentation․lisp file
File, id3-data.lisp: The cl-mpg123/id3-data․lisp file
File, low-level.lisp: The cl-mpg123/low-level․lisp file
File, metadata.lisp: The cl-mpg123/metadata․lisp file
File, package.lisp: The cl-mpg123/package․lisp file
File, toolkit.lisp: The cl-mpg123/toolkit․lisp file
File, wrapper.lisp: The cl-mpg123/wrapper․lisp file
fmt: Public classes
frame-decode-failed: Public conditions
frameinfo: Public classes

G
generic-error: Public conditions

H
handle: Public classes
handler-creation-failed: Public conditions

I
id3-data.lisp: The cl-mpg123/id3-data․lisp file
id3-query-failed: Public conditions
id3v1: Public classes
id3v2: Public classes
init-failed: Public conditions

L
low-level.lisp: The cl-mpg123/low-level․lisp file

M
metadata: Public classes
metadata.lisp: The cl-mpg123/metadata․lisp file
mpg-error: Public conditions
mpg-file-error: Public conditions
mpg-file-string-error: Public conditions
mstring: Public classes

N
not-connected: Public conditions

P
Package, cl-mpg123: The cl-mpg123 package
Package, cl-mpg123-cffi: The cl-mpg123-cffi package
package.lisp: The cl-mpg123/package․lisp file
pars: Public classes
picture: Public classes
picture: Public classes

Q
query-failed: Public conditions

R
read-failed: Public conditions

S
scan-failed: Public conditions
seek-failed: Public conditions
System, cl-mpg123: The cl-mpg123 system

T
text: Public classes
toolkit.lisp: The cl-mpg123/toolkit․lisp file

U
unknown-id3v2-frame-type: Public conditions

V
volume-query-failed: Public conditions
volume-set-failed: Public conditions

W
wrapper.lisp: The cl-mpg123/wrapper․lisp file