The cl-mpg123 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-mpg123 Reference Manual

This is the cl-mpg123 Reference Manual, version 1.0.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:26:21 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

About cl-mpg123

This is a bindings and wrapper library to libmpg123 allowing for convenient, extensive, and fast decoding of MPEG1/2/3 (most prominently mp3) files.

How To

Precompiled versions of the underlying library are included in this. If you want to build it manually however, refer to the mpg123 page.

Load the system through ASDF or Quicklisp:

(ql:quickload :cl-mpg123)

Create a new file object:

(defvar *file* (cl-mpg123:make-file #p"~/my-cool-music.mp3"))

This will initialise a file and set the requested parameters. As it is now, we've left everything up to defaults. If you need more tailored control as to how the file will be treated, see the file class documentation. Next we will want to actually open up the underlying file so that we can look into it.

(cl-mpg123:connect *file*)

Processing the actual sound data, is just a matter of calling process and passing the buffer to something that can do something useful with the raw audio data. However, unless you specifically chose the audio data format yourself, you'll first want to query that:

(cl-mpg123:file-format *file*)

This will give you the rate, channels, and encoding of the file so that you can configure your audio processing library accordingly. Next we can process the data in a loop:

(loop with buffer = (cl-mpg123:buffer *file*)
      for bytes = (cl-mpg123:process *file*)
      until (= 0 bytes)
      do (process-buffer-somehow buffer bytes))

This library is also capable of extracting ID3 tags from the file. A quick summary of information found in a file can be displayed with describe:

(describe *file*)

Direct access to the metadata object is possible with metadata. This object will then allow you to retrieve the values of various tags through field and field-text:

(cl-mpg123:field-text :album (metadata *file*))

For the list of possible field names, see *id3v2-type-map. For a listing of all recognised tags, simply use fields on the metadata object. If possible, picture tags are also extracted and converted. You can get your hands on those through the pictures reader. Returned are a list of picture objects that will encapsulate the data.

Should you wish to change parameters for the decoding or the file itself, you can do so via reinitialize-instance. Just be aware that doing so will close the handle and is thus not recommended during processing.

Also included in libmpg123 are volume changing and a full 32 band equalizer. The volume can be accessed by, naturally, volume, and the equalizer by equalizer.

(setf (cl-mpg123:volume *file*) 0.5)
(cl-mpg123:volume *file*)

You can also seek around in the file if necessary. Doing so is done by the single seek function which allows you to seek by samples, frames, or track seconds, either relatively, absolutely, or from the end of the file.

(cl-mpg123:seek *file* 1 :by :second)

Once you know you are done with the file, you can disconnect it to release the underlying file descriptor. Once the file is GCed, its handler and buffer will automatically be freed so that there's no worry about permanent memory leaks.

(cl-mpg123:disconnect *file*)

And that's about it. See the individual functions for more information on what exactly you can get or change. If you want to look at a full example that actually plays something, see the cl-mpg123-example system, which shows how to use it in combination with cl-out123 using either the low-level binding interface, or the high-level wrapper interface shown here.

Also See


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-mpg123

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

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

License

Artistic

Description

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

Version

1.0.0

Dependencies
Source

cl-mpg123.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-mpg123.asd

Location

cl-mpg123.asd

Systems

cl-mpg123 (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-mpg123/package.lisp

Parent

cl-mpg123 (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-mpg123/toolkit.lisp

Dependency

package.lisp (file)

Parent

cl-mpg123 (system)

Location

toolkit.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-mpg123/conditions.lisp

Dependency

toolkit.lisp (file)

Parent

cl-mpg123 (system)

Location

conditions.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-mpg123/low-level.lisp

Dependency

conditions.lisp (file)

Parent

cl-mpg123 (system)

Location

low-level.lisp

Exported Definitions
Internal Definitions

*here* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 cl-mpg123/id3-data.lisp

Dependency

low-level.lisp (file)

Parent

cl-mpg123 (system)

Location

id3-data.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 cl-mpg123/metadata.lisp

Dependency

id3-data.lisp (file)

Parent

cl-mpg123 (system)

Location

metadata.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 cl-mpg123/wrapper.lisp

Dependency

metadata.lisp (file)

Parent

cl-mpg123 (system)

Location

wrapper.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.9 cl-mpg123/documentation.lisp

Dependency

wrapper.lisp (file)

Parent

cl-mpg123 (system)

Location

documentation.lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-mpg123

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.mpg123

Use List
Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.2 cl-mpg123-cffi

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.mpg123.cffi

Use List
Exported Definitions
Internal Definitions

*here* (special variable)


Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Constants

Constant: icy
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Constant: id3
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Constant: new-icy
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Constant: new-id3
Package

cl-mpg123-cffi

Source

low-level.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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 (file)

Special Variable: *static*
Package

cl-mpg123-cffi

Source

low-level.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: add-string MSTRING STUFF
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: add-substring MSTRING STUFF FROM COUNT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: chomp-string MSTRING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: clip HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: close HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: copy-string FROM TO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: current-decoder HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: decode HANDLE INMEMORY INMEMSIZE OUTMEMORY OUTMEMSIZE DONE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: decode-frame HANDLE NUM AUDIO BYTES
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: (setf decoder) DECODER FILE
Package

cl-mpg123

Source

wrapper.lisp (file)

Reader

decoder (generic function)

Function: decoder HANDLE NAME
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: decoders ()

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

See SUPPORTED-DECODERS

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: decoders ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: delete HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: delete-pars PARS
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: enc-from-id3 ID3-ENC-BYTE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: encodings LIST NUMBER
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: encsize ENCODING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: eq HANDLE CHANNEL BAND VAL
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Writer

(setf equalizer) (function)

Function: (setf equalizer) VALUE FILE CHANNEL BAND
Package

cl-mpg123

Source

wrapper.lisp (file)

Reader

equalizer (function)

Function: errcode HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: exit ()

Cleans up the underlying library if not already done so.

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: exit ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: feature KEY
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: feed HANDLE IN SIZE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: feedseek HANDLE SAMPLEOFF WHENCE INPUT-OFFSET
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

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 (file)

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 (file)

Function: fmt PARS RATE CHANNELS ENCODINGS
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: fmt-all PARS
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: fmt-channels POINTER-TO-FMT
Function: (setf fmt-channels) VALUE POINTER-TO-FMT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: fmt-encoding POINTER-TO-FMT
Function: (setf fmt-encoding) VALUE POINTER-TO-FMT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: fmt-none PARS
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: fmt-rate POINTER-TO-FMT
Function: (setf fmt-rate) VALUE POINTER-TO-FMT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: fmt-support PARS RATE ENCODING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: format HANDLE RATE CHANNELS ENCODINGS
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: format-all HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: format-none HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: format-support HANDLE RATE ENCODING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: frame-position FILE

Returns the current position as a frame index.

See FILE

Package

cl-mpg123

Source

wrapper.lisp (file)

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 (file)

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 (file)

Function: framebyframe-decode HANDLE NUM AUDIO BYTES
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: framebyframe-next HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: framedata HANDLE HEADER BODYDATA BODYBYTES
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-abr-rate POINTER-TO-FRAMEINFO
Function: (setf frameinfo-abr-rate) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-bitrate POINTER-TO-FRAMEINFO
Function: (setf frameinfo-bitrate) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-emphasis POINTER-TO-FRAMEINFO
Function: (setf frameinfo-emphasis) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-flags POINTER-TO-FRAMEINFO
Function: (setf frameinfo-flags) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-framesize POINTER-TO-FRAMEINFO
Function: (setf frameinfo-framesize) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-layer POINTER-TO-FRAMEINFO
Function: (setf frameinfo-layer) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-mode POINTER-TO-FRAMEINFO
Function: (setf frameinfo-mode) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-mode-ext POINTER-TO-FRAMEINFO
Function: (setf frameinfo-mode-ext) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-rate POINTER-TO-FRAMEINFO
Function: (setf frameinfo-rate) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-vbr POINTER-TO-FRAMEINFO
Function: (setf frameinfo-vbr) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: frameinfo-version POINTER-TO-FRAMEINFO
Function: (setf frameinfo-version) VALUE POINTER-TO-FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: framelength HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: framepos HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: free-string MSTRING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: geteq HANDLE CHANNEL BAND
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: getformat HANDLE RATE CHANNELS ENCODING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: getpar PARS TYPE VALUE FVALUE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: getparam HANDLE TYPE VALUE FVALUE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: getstate HANDLE KEY VAL FVAL
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: getvolume HANDLE BASE REALLY RVA-DB
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: grow-string MSTRING NEWS
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: icy HANDLE ICY-META
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: icy2utf8 ICY_TEXT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3 HANDLE V1 V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v1-album POINTER-TO-ID3V1
Function: (setf id3v1-album) VALUE POINTER-TO-ID3V1
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v1-artist POINTER-TO-ID3V1
Function: (setf id3v1-artist) VALUE POINTER-TO-ID3V1
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v1-comment POINTER-TO-ID3V1
Function: (setf id3v1-comment) VALUE POINTER-TO-ID3V1
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: id3v1-genre POINTER-TO-ID3V1
Function: (setf id3v1-genre) VALUE POINTER-TO-ID3V1
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v1-tag POINTER-TO-ID3V1
Function: (setf id3v1-tag) VALUE POINTER-TO-ID3V1
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v1-title POINTER-TO-ID3V1
Function: (setf id3v1-title) VALUE POINTER-TO-ID3V1
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v1-year POINTER-TO-ID3V1
Function: (setf id3v1-year) VALUE POINTER-TO-ID3V1
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-album POINTER-TO-ID3V2
Function: (setf id3v2-album) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-artist POINTER-TO-ID3V2
Function: (setf id3v2-artist) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-comment POINTER-TO-ID3V2
Function: (setf id3v2-comment) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-comment-list POINTER-TO-ID3V2
Function: (setf id3v2-comment-list) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-comments POINTER-TO-ID3V2
Function: (setf id3v2-comments) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-extra POINTER-TO-ID3V2
Function: (setf id3v2-extra) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-extras POINTER-TO-ID3V2
Function: (setf id3v2-extras) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: id3v2-genre POINTER-TO-ID3V2
Function: (setf id3v2-genre) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-picture POINTER-TO-ID3V2
Function: (setf id3v2-picture) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-pictures POINTER-TO-ID3V2
Function: (setf id3v2-pictures) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-text POINTER-TO-ID3V2
Function: (setf id3v2-text) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-texts POINTER-TO-ID3V2
Function: (setf id3v2-texts) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-title POINTER-TO-ID3V2
Function: (setf id3v2-title) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-type NAME

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

Package

cl-mpg123

Source

id3-data.lisp (file)

Function: id3v2-version POINTER-TO-ID3V2
Function: (setf id3v2-version) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: id3v2-year POINTER-TO-ID3V2
Function: (setf id3v2-year) VALUE POINTER-TO-ID3V2
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: index HANDLE OFFSETS STEP FILL
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: info HANDLE FRAMEINFO
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: init ()

Prepares the underlying library if not already done so.

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: init ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: init-string MSTRING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: length HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: meta-check HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: meta-free HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: mstring-fill POINTER-TO-MSTRING
Function: (setf mstring-fill) VALUE POINTER-TO-MSTRING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: mstring-p POINTER-TO-MSTRING
Function: (setf mstring-p) VALUE POINTER-TO-MSTRING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: mstring-size POINTER-TO-MSTRING
Function: (setf mstring-size) VALUE POINTER-TO-MSTRING
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: new DECODER ERROR
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: new-pars ERROR
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: open HANDLE PATH
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: open-fd HANDLE FD
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: open-feed HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: open-handle HANDLE IOHANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: outblock HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: par PARS TYPE VALUE FVALUE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: param HANDLE TYPE VALUE FVALUE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: parnew PARS DECODER ERROR
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: picture-data POINTER-TO-PICTURE
Function: (setf picture-data) VALUE POINTER-TO-PICTURE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: picture-description POINTER-TO-PICTURE
Function: (setf picture-description) VALUE POINTER-TO-PICTURE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: picture-mime-type POINTER-TO-PICTURE
Function: (setf picture-mime-type) VALUE POINTER-TO-PICTURE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: picture-size POINTER-TO-PICTURE
Function: (setf picture-size) VALUE POINTER-TO-PICTURE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: picture-type POINTER-TO-PICTURE
Function: (setf picture-type) VALUE POINTER-TO-PICTURE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: plain-strerror ERRCODE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: position HANDLE FRAME-OFFSET BUFFERED-BYTES CURRENT-FRAME FRAMES-LEFT CURRENT-SECONDS SECONDS-LEFT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

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 (file)

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 (file)

Function: rates LIST NUMBER
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: read HANDLE OUTMEMORY OUTMEMSIZE DONE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: replace-buffer HANDLE DATA SIZE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: replace-reader HANDLE R_READ R_LSEEK
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: replace-reader-handle HANDLE R_READ R_LSEEK CLEANUP
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: reset-eq HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: resize-string MSTRING NEWS
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: safe-buffer ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: sample-position FILE

Returns the current position as a sample index.

See FILE

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: samplesize ENC
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: scan HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

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 (file)

Function: seek HANDLE SAMPLEOFF WHENCE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: seek-frame HANDLE FRAMEOFF WHENCE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: set-filesize HANDLE SIZE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: set-index HANDLE OFFSETS STEP FILL
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: set-string MSTRING STUFF
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: set-substring MSTRING STUFF FROM COUNT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: spf HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: store-utf8 MSTRING ENC SOURCE SOURCE-SIZE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: stream-position FILE

Returns the current position in stream as a byte index.

See FILE

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: strerror HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: strlen MSTRING UTF8
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: supported-decoders ()

Returns a list of all supported decoder backends.

See DECODERS
See DECODER

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: supported-decoders ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: supported-encodings ()

Returns a list of all supported encoding types.

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: supported-rates ()
Package

cl-mpg123

Source

wrapper.lisp (file)

Function: tell HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: tell-stream HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: tellframe HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: text-description POINTER-TO-TEXT
Function: (setf text-description) VALUE POINTER-TO-TEXT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: text-id POINTER-TO-TEXT
Function: (setf text-id) VALUE POINTER-TO-TEXT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: text-lang POINTER-TO-TEXT
Function: (setf text-lang) VALUE POINTER-TO-TEXT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: text-text POINTER-TO-TEXT
Function: (setf text-text) VALUE POINTER-TO-TEXT
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: time-frame-index FILE SECONDS

Returns the frame index of a given track seconds index.

See FILE

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: timeframe HANDLE SEC
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: tpf HANDLE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: track-length FILE

Returns the length of the track in seconds.

See FRAME-SECONDS
See FRAME-COUNT

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: track-position FILE

Returns the current track seconds position.

See FRAME-SECONDS
See FRAME-POSITION

Package

cl-mpg123

Source

wrapper.lisp (file)

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 (file)

Writer

(setf volume) (function)

Function: (setf volume) VOLUME FILE &key RELATIVE
Package

cl-mpg123

Source

wrapper.lisp (file)

Reader

volume (function)

Function: volume HANDLE VOL
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Function: volume-change HANDLE CHANGE
Package

cl-mpg123-cffi

Source

low-level.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: 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
Method: accepted-format (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: auto-resample (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: band CONDITION

Returns the band that was attempted to be accessed.

Package

cl-mpg123

Methods
Method: band (CONDITION equalizer-set-failed)
Source

conditions.lisp (file)

Method: band (CONDITION equalizer-query-failed)
Source

conditions.lisp (file)

Generic Function: 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

Writer

(setf buffer) (generic function)

Methods
Method: buffer (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Method: buffer (CONDITION read-failed)
Source

conditions.lisp (file)

Generic Function: (setf buffer) NEW-VALUE OBJECT
Package

cl-mpg123

Reader

buffer (generic function)

Methods
Method: (setf buffer) NEW-VALUE (FILE file)

automatically generated writer method

Source

wrapper.lisp (file)

Generic Function: 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

Writer

(setf buffer-size) (generic function)

Methods
Method: buffer-size (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Method: buffer-size (CONDITION read-failed)
Source

conditions.lisp (file)

Generic Function: (setf buffer-size) NEW-VALUE OBJECT
Package

cl-mpg123

Reader

buffer-size (generic function)

Methods
Method: (setf buffer-size) NEW-VALUE (FILE file)

automatically generated writer method

Source

wrapper.lisp (file)

Generic Function: 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
Method: by (CONDITION seek-failed)
Source

conditions.lisp (file)

Generic Function: channel CONDITION

Returns the channel that was attempted to be accessed.

Package

cl-mpg123

Methods
Method: channel (CONDITION equalizer-set-failed)
Source

conditions.lisp (file)

Method: channel (CONDITION equalizer-query-failed)
Source

conditions.lisp (file)

Generic Function: 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
Method: channels (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: connected (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: data (PICTURE picture)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: 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
Method: decode-frames (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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

Writer

(setf decoder) (function)

Methods
Method: decoder (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: description OBJECT

Returns the picture description string.

See PICTURE

Package

cl-mpg123

Methods
Method: description (PICTURE picture)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: 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
Method: down-sample (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: downspeed (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: encoding (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: error-code (CONDITION error-string-error)
Source

conditions.lisp (file)

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 (file)

Generic Function: 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
Method: fields (METADATA metadata)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: file CONDITION

Returns the file associated with the condition.

See FILE
See MPG-FILE-ERROR

Package

cl-mpg123

Methods
Method: file (CONDITION volume-set-failed)
Source

conditions.lisp (file)

Method: file (CONDITION equalizer-set-failed)
Source

conditions.lisp (file)

Method: file (CONDITION equalizer-query-failed)
Source

conditions.lisp (file)

Method: file (CONDITION seek-failed)
Source

conditions.lisp (file)

Method: file (CONDITION query-failed)
Source

conditions.lisp (file)

Method: file (CONDITION decoder-set-failed)
Source

conditions.lisp (file)

Method: file (CONDITION connection-failed)
Source

conditions.lisp (file)

Method: file (CONDITION mpg-file-error)
Source

conditions.lisp (file)

Generic Function: force-8bit OBJECT

Returns whether to force 8bit formats.

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

See FILE

Package

cl-mpg123

Methods
Method: force-8bit (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: force-channels (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: force-float (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: force-rate (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: fuzzy-seek (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: gapless OBJECT

Returns whether to use gapless decoding.

This can be set via the :gapless initarg.

See FILE

Package

cl-mpg123

Methods
Method: gapless (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: handle OBJECT

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

See FILE

Package

cl-mpg123

Methods
Method: handle (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: ignore-infoframe (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: in-buffer CONDITION

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

Package

cl-mpg123

Methods
Method: in-buffer (CONDITION decode-failed)
Source

conditions.lisp (file)

Generic Function: in-size CONDITION

Returns the size of the input buffer in bytes.

Package

cl-mpg123

Methods
Method: in-size (CONDITION decode-failed)
Source

conditions.lisp (file)

Generic Function: 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
Method: index-size (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: kind (PICTURE picture)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: mime-type OBJECT

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

See PICTURE

Package

cl-mpg123

Methods
Method: mime-type (PICTURE picture)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: 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
Method: mode (CONDITION seek-failed)
Source

conditions.lisp (file)

Generic Function: out-buffer CONDITION

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

Package

cl-mpg123

Methods
Method: out-buffer (CONDITION decode-failed)
Source

conditions.lisp (file)

Generic Function: out-size CONDITION

Returns the size of the output buffer in bytes.

Package

cl-mpg123

Methods
Method: out-size (CONDITION decode-failed)
Source

conditions.lisp (file)

Generic Function: outscale OBJECT

Returns the output sample amplitude scale.

This can be set via the :outscale initarg.

See FILE

Package

cl-mpg123

Methods
Method: outscale (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: parse-pictures (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: path CONDITION

Returns the pathname of the file being accessed.

See FILE
See CONNECT

Package

cl-mpg123

Methods
Method: path (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Method: path (CONDITION connection-failed)
Source

conditions.lisp (file)

Generic Function: pictures OBJECT

Returns the list of pictures stored in the metadata.

See PICTURE
See METADATA

Package

cl-mpg123

Methods
Method: pictures (METADATA metadata)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: 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
Method: preframes (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: query CONDITION

The function that performed the query that failed.

Package

cl-mpg123

Methods
Method: query (CONDITION query-failed)
Source

conditions.lisp (file)

Generic Function: 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
Method: rate (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: relative CONDITION

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

Package

cl-mpg123

Methods
Method: relative (CONDITION volume-set-failed)
Source

conditions.lisp (file)

Generic Function: 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
Method: rva (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: scanned (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: seek-position CONDITION

Returns the position to which the seek was performed.

See SEEK-FAILED

Package

cl-mpg123

Methods
Method: seek-position (CONDITION seek-failed)
Source

conditions.lisp (file)

Generic Function: 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
Method: skip-id3v2 (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: start-frame (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: 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
Method: upspeed (FILE file)

automatically generated reader method

Source

wrapper.lisp (file)

Generic Function: value CONDITION

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

Package

cl-mpg123

Methods
Method: value (CONDITION volume-set-failed)
Source

conditions.lisp (file)

Method: value (CONDITION equalizer-set-failed)
Source

conditions.lisp (file)

Method: value (CONDITION decoder-set-failed)
Source

conditions.lisp (file)

Generic Function: 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
Method: version (METADATA metadata)

automatically generated reader method

Source

metadata.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 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 (file)

Direct superclasses

mpg-file-string-error (condition)

Direct methods
Direct slots
Slot: file
Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

Slot: path
Initargs

:path

Initform

(quote nil)

Readers

path (generic function)

Condition: decode-failed ()
Package

cl-mpg123

Source

conditions.lisp (file)

Direct superclasses

mpg-file-string-error (condition)

Direct methods
Direct slots
Slot: in-buffer
Initargs

:in-buffer

Readers

in-buffer (generic function)

Slot: out-buffer
Initargs

:out-buffer

Readers

out-buffer (generic function)

Slot: in-size
Initargs

:in-size

Readers

in-size (generic function)

Slot: out-size
Initargs

:out-size

Readers

out-size (generic function)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

Direct methods
Direct slots
Slot: value
Initargs

:value

Initform

(quote nil)

Readers

value (generic function)

Slot: file
Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

Direct methods
Direct slots
Slot: file
Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

Slot: band
Initargs

:band

Initform

(quote nil)

Readers

band (generic function)

Slot: channel
Initargs

:channel

Initform

(quote nil)

Readers

channel (generic function)

Slot: value
Initargs

:value

Initform

(quote nil)

Readers

value (generic function)

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 (file)

Direct superclasses

mpg-error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: error
Initargs

:error

Initform

(quote nil)

Readers

error-code (generic function)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

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 (file)

Direct superclasses

error-string-error (condition)

Direct subclasses

query-failed (condition)

Direct methods

form (method)

Direct slots
Slot: form
Initargs

:form

Initform

(quote nil)

Readers

form (generic function)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

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 (file)

Direct superclasses

error-string-error (condition)

Condition: mpg-error ()

Condition superclass for all errors related to this library.

Package

cl-mpg123

Source

conditions.lisp (file)

Direct superclasses

error (condition)

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 (file)

Direct superclasses

mpg-error (condition)

Direct subclasses
Direct methods

file (method)

Direct slots
Slot: file
Initargs

:file

Readers

file (generic function)

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 (file)

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 (file)

Direct superclasses

mpg-file-error (condition)

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 (file)

Direct superclasses
Direct methods
Direct slots
Slot: query
Initargs

:query

Initform

(quote nil)

Readers

query (generic function)

Slot: file
Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

Direct methods
Direct slots
Slot: buffer
Initargs

:buffer

Readers

buffer (generic function)

Slot: buffer-size
Initargs

:buffer-size

Readers

buffer-size (generic function)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

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 (file)

Direct superclasses

mpg-file-error (condition)

Direct methods
Direct slots
Slot: file
Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

Slot: by
Initargs

:by

Initform

(quote nil)

Readers

by (generic function)

Slot: mode
Initargs

:mode

Initform

(quote nil)

Readers

mode (generic function)

Slot: seek-position
Initargs

:seek-position

Initform

(quote nil)

Readers

seek-position (generic function)

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 (file)

Direct superclasses

mpg-error (condition)

Direct methods

name (method)

Direct slots
Slot: name
Initargs

:name

Initform

(quote nil)

Readers

name (generic function)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

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 (file)

Direct superclasses

mpg-file-string-error (condition)

Direct methods
Direct slots
Slot: file
Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

Slot: relative
Initargs

:relative

Initform

(quote nil)

Readers

relative (generic function)

Slot: value
Initargs

:value

Initform

(quote nil)

Readers

value (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 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 (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: handle
Readers

handle (generic function)

Slot: connected
Readers

connected (generic function)

Writers

set-connected (generic function)

Slot: scanned
Readers

scanned (generic function)

Writers

set-scanned (generic function)

Slot: buffer
Readers

buffer (generic function)

Writers

(setf buffer) (generic function)

Slot: rate
Readers

rate (generic function)

Slot: channels
Readers

channels (generic function)

Slot: encoding
Readers

encoding (generic function)

Slot: path
Initargs

:path

Readers

path (generic function)

Slot: decoder
Initargs

:decoder

Readers

decoder (generic function)

Slot: accepted-format
Initargs

:accepted-format

Readers

accepted-format (generic function)

Slot: buffer-size
Initargs

:buffer-size

Readers

buffer-size (generic function)

Writers

(setf buffer-size) (generic function)

Slot: force-rate
Initargs

:force-rate

Readers

force-rate (generic function)

Slot: down-sample
Initargs

:down-sample

Readers

down-sample (generic function)

Slot: rva
Initargs

:rva

Readers

rva (generic function)

Slot: downspeed
Initargs

:downspeed

Readers

downspeed (generic function)

Slot: upspeed
Initargs

:upspeed

Readers

upspeed (generic function)

Slot: start-frame
Initargs

:start-frame

Readers

start-frame (generic function)

Slot: decode-frames
Initargs

:decode-frames

Readers

decode-frames (generic function)

Slot: outscale
Initargs

:outscale

Readers

outscale (generic function)

Slot: index-size
Initargs

:index-size

Readers

index-size (generic function)

Slot: preframes
Initargs

:preframes

Readers

preframes (generic function)

Slot: force-channels
Initargs

:force-channels

Readers

force-channels (generic function)

Slot: force-8bit
Initargs

:force-8bit

Readers

force-8bit (generic function)

Slot: gapless
Initargs

:gapless

Readers

gapless (generic function)

Slot: fuzzy-seek
Initargs

:fuzzy-seek

Readers

fuzzy-seek (generic function)

Slot: force-float
Initargs

:force-float

Readers

force-float (generic function)

Slot: skip-id3v2
Initargs

:skip-id3v2

Readers

skip-id3v2 (generic function)

Slot: ignore-infoframe
Initargs

:ignore-infoframe

Readers

ignore-infoframe (generic function)

Slot: auto-resample
Initargs

:auto-resample

Readers

auto-resample (generic function)

Slot: parse-pictures
Initargs

:parse-pictures

Readers

parse-pictures (generic function)

Direct Default Initargs
InitargValue
:pathnil
:decodernil
:accepted-formatt
:buffer-sizet
:force-ratenil
:down-samplenil
:rva:off
: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
Class: fmt ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: frameinfo ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: handle ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: id3v1 ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: id3v2 ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
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 (file)

Direct superclasses

standard-object (class)

Direct methods
  • reinitialize-instance (method)
  • shared-initialize (method)
  • pictures (method)
  • fields (method)
  • version (method)
Direct slots
Slot: version
Readers

version (generic function)

Slot: fields
Readers

fields (generic function)

Slot: pictures
Readers

pictures (generic function)

Class: mstring ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: pars ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
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 (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: kind
Readers

kind (generic function)

Slot: description
Readers

description (generic function)

Slot: mime-type
Readers

mime-type (generic function)

Slot: data
Readers

data (generic function)

Class: picture ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: text ()
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *here*
Package

cl-mpg123-cffi

Source

low-level.lisp (file)

Special Variable: *init*

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

Package

cl-mpg123

Source

wrapper.lisp (file)

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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

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 (file)

Macro: do-text-array (LANG ID DESCRIPTION TEXT) (ARRAY SIZE) &body BODY
Package

cl-mpg123

Source

metadata.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 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 (file)

Function: configure-properties FILE
Package

cl-mpg123

Source

wrapper.lisp (file)

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 (file)

Function: decode-flags FLAGS

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

Package

cl-mpg123

Source

wrapper.lisp (file)

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 (file)

Function: dispose-handle HANDLE

Cleans up the handle and deallocates it.

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: encode-channels CHANNELS

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

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: encode-encodings ENCODINGS

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

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: format-time SECS

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

Package

cl-mpg123

Source

wrapper.lisp (file)

Function: map-text-array FUNC ARRAY SIZE
Package

cl-mpg123

Source

metadata.lisp (file)

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 (file)

Function: split STRING CHAR

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

Package

cl-mpg123

Source

toolkit.lisp (file)

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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: form CONDITION

Returns he form that caused the generic error.

See GENERIC-ERROR

Package

cl-mpg123

Methods
Method: form (CONDITION generic-error)
Source

conditions.lisp (file)

Generic Function: name CONDITION

Returns the name of the erroneously requested id3v2 frame type.

See UNKNOWN-ID3v2-FRAME-TYPE

Package

cl-mpg123

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

conditions.lisp (file)

Generic Function: set-connected NEW-VALUE OBJECT
Package

cl-mpg123

Methods
Method: set-connected NEW-VALUE (FILE file)

automatically generated writer method

Source

wrapper.lisp (file)

Generic Function: set-scanned NEW-VALUE OBJECT
Package

cl-mpg123

Methods
Method: set-scanned NEW-VALUE (FILE file)

automatically generated writer method

Source

wrapper.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

Direct superclasses

mpg-file-error (condition)

Direct methods
Direct slots
Slot: file
Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

Slot: band
Initargs

:band

Initform

(quote nil)

Readers

band (generic function)

Slot: channel
Initargs

:channel

Initform

(quote nil)

Readers

channel (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-mpg123.asd: The cl-mpg123<dot>asd file
cl-mpg123/conditions.lisp: The cl-mpg123/conditions<dot>lisp file
cl-mpg123/documentation.lisp: The cl-mpg123/documentation<dot>lisp file
cl-mpg123/id3-data.lisp: The cl-mpg123/id3-data<dot>lisp file
cl-mpg123/low-level.lisp: The cl-mpg123/low-level<dot>lisp file
cl-mpg123/metadata.lisp: The cl-mpg123/metadata<dot>lisp file
cl-mpg123/package.lisp: The cl-mpg123/package<dot>lisp file
cl-mpg123/toolkit.lisp: The cl-mpg123/toolkit<dot>lisp file
cl-mpg123/wrapper.lisp: The cl-mpg123/wrapper<dot>lisp file

F
File, Lisp, cl-mpg123.asd: The cl-mpg123<dot>asd file
File, Lisp, cl-mpg123/conditions.lisp: The cl-mpg123/conditions<dot>lisp file
File, Lisp, cl-mpg123/documentation.lisp: The cl-mpg123/documentation<dot>lisp file
File, Lisp, cl-mpg123/id3-data.lisp: The cl-mpg123/id3-data<dot>lisp file
File, Lisp, cl-mpg123/low-level.lisp: The cl-mpg123/low-level<dot>lisp file
File, Lisp, cl-mpg123/metadata.lisp: The cl-mpg123/metadata<dot>lisp file
File, Lisp, cl-mpg123/package.lisp: The cl-mpg123/package<dot>lisp file
File, Lisp, cl-mpg123/toolkit.lisp: The cl-mpg123/toolkit<dot>lisp file
File, Lisp, cl-mpg123/wrapper.lisp: The cl-mpg123/wrapper<dot>lisp file

L
Lisp File, cl-mpg123.asd: The cl-mpg123<dot>asd file
Lisp File, cl-mpg123/conditions.lisp: The cl-mpg123/conditions<dot>lisp file
Lisp File, cl-mpg123/documentation.lisp: The cl-mpg123/documentation<dot>lisp file
Lisp File, cl-mpg123/id3-data.lisp: The cl-mpg123/id3-data<dot>lisp file
Lisp File, cl-mpg123/low-level.lisp: The cl-mpg123/low-level<dot>lisp file
Lisp File, cl-mpg123/metadata.lisp: The cl-mpg123/metadata<dot>lisp file
Lisp File, cl-mpg123/package.lisp: The cl-mpg123/package<dot>lisp file
Lisp File, cl-mpg123/toolkit.lisp: The cl-mpg123/toolkit<dot>lisp file
Lisp File, cl-mpg123/wrapper.lisp: The cl-mpg123/wrapper<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

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

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

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

C
channel: Exported generic functions
channel: Exported generic functions
channel: Exported generic functions
channels: Exported generic functions
channels: Exported generic functions
check-connected: Internal functions
chomp-string: Exported functions
clip: Exported functions
close: Exported functions
configure-properties: Internal functions
connect: Exported functions
connected: Exported generic functions
connected: Exported generic functions
copy-string: Exported functions
current-decoder: Exported functions

D
data: Exported generic functions
data: Exported generic functions
decode: Exported functions
decode: Exported functions
decode-directly: Internal functions
decode-flags: Internal functions
decode-frame: Exported functions
decode-frame: Exported functions
decode-frames: Exported generic functions
decode-frames: Exported generic functions
decoder: Exported functions
decoder: Exported generic functions
decoder: Exported generic functions
decoders: Exported functions
decoders: Exported functions
define-direct-condition: Internal macros
define-simple-condition: Internal macros
delete: Exported functions
delete-pars: Exported functions
description: Exported generic functions
description: Exported generic functions
direct-str: Internal functions
disconnect: Exported functions
dispose-handle: Internal functions
do-text-array: Internal macros
down-sample: Exported generic functions
down-sample: Exported generic functions
downspeed: Exported generic functions
downspeed: Exported generic functions

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

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

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

H
handle: Exported generic functions
handle: Exported generic functions

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

K
kind: Exported generic functions
kind: Exported generic functions

L
length: Exported functions

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

N
name: Internal generic functions
name: Internal generic functions
new: Exported functions
new-pars: Exported functions

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

P
par: Exported functions
param: Exported functions
parnew: Exported functions
parse-pictures: Exported generic functions
parse-pictures: Exported generic functions
path: Exported generic functions
path: Exported generic functions
path: Exported generic functions
picture-data: Exported functions
picture-description: Exported functions
picture-mime-type: Exported functions
picture-size: Exported functions
picture-type: Exported functions
pictures: Exported generic functions
pictures: Exported generic functions
plain-strerror: Exported functions
position: Exported functions
preframes: Exported generic functions
preframes: Exported generic functions
process: Exported functions
process-into-vector: Exported functions
process-to-vector: Exported functions

Q
query: Exported generic functions
query: Exported generic functions

R
rate: Exported generic functions
rate: Exported generic functions
rates: Exported functions
read: Exported functions
read-directly: Exported functions
relative: Exported generic functions
relative: Exported generic functions
replace-buffer: Exported functions
replace-reader: Exported functions
replace-reader-handle: Exported functions
reset-eq: Exported functions
reset-equalizer: Exported functions
resize-string: Exported functions
rva: Exported generic functions
rva: Exported generic functions

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

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

U
upspeed: Exported generic functions
upspeed: Exported generic functions

V
value: Exported generic functions
value: Exported generic functions
value: Exported generic functions
value: Exported generic functions
version: Exported generic functions
version: Exported generic functions
volume: Exported functions
volume: Exported functions
volume-change: Exported functions

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

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

Next: , Previous: , Up: Indexes   [Contents][Index]

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*: Internal special variables
*id3v1-genre-list*: Exported special variables
*id3v2-type-map*: Exported special variables
*init*: Internal special variables
*print-object-path-limit*: Internal special variables
*static*: Exported special variables

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

B
band: Exported conditions
band: Internal conditions
buffer: Exported conditions
buffer: Exported classes
buffer-size: Exported conditions
buffer-size: Exported classes
by: Exported conditions

C
channel: Exported conditions
channel: Internal conditions
channels: Exported classes
connected: Exported classes
Constant, icy: Exported constants
Constant, id3: Exported constants
Constant, new-icy: Exported constants
Constant, new-id3: Exported constants

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

E
encoding: Exported classes
error: Exported conditions

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

G
gapless: Exported classes

H
handle: Exported classes

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

K
kind: Exported classes

M
mime-type: Exported classes
mode: Exported conditions

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

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

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

Q
query: Exported conditions

R
rate: Exported classes
relative: Exported conditions
rva: Exported classes

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

U
upspeed: Exported classes

V
value: Exported conditions
value: Exported conditions
value: Exported conditions
version: Exported classes

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

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

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

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

D
decode-failed: Exported conditions
decoder-set-failed: Exported conditions
disconnection-failed: Exported conditions

E
equalizer-query-failed: Internal conditions
equalizer-reset-failed: Exported conditions
equalizer-set-failed: Exported conditions
error-string-error: Exported conditions

F
file: Exported classes
fmt: Exported classes
frame-decode-failed: Exported conditions
frameinfo: Exported classes

G
generic-error: Exported conditions

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

I
id3-query-failed: Exported conditions
id3v1: Exported classes
id3v2: Exported classes
init-failed: Exported conditions

M
metadata: Exported classes
mpg-error: Exported conditions
mpg-file-error: Exported conditions
mpg-file-string-error: Exported conditions
mstring: Exported classes

N
not-connected: Exported conditions

P
Package, cl-mpg123: The cl-mpg123 package
Package, cl-mpg123-cffi: The cl-mpg123-cffi package
pars: Exported classes
picture: Exported classes
picture: Exported classes

Q
query-failed: Exported conditions

R
read-failed: Exported conditions

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

T
text: Exported classes

U
unknown-id3v2-frame-type: Exported conditions

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

Jump to:   C   D   E   F   G   H   I   M   N   P   Q   R   S   T   U   V