The id3v2 Reference Manual

Child Component

src (module).

Next: Files, Previous: Systems, Up: The id3v2 Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

id3v2/src

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

3.1 `id3v2/src`

Source

Parent Component

id3v2 (system).

Child Components

id3v2.lisp (file).
id3v22.lisp (file).
id3v23.lisp (file).
id3v24.lisp (file).
limit-stream.lisp (file).
mp3.lisp (file).
util.lisp (file).

Next: Packages, Previous: Modules, Up: The id3v2 Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: id3v2/src/id3v2.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `id3v2/id3v2.asd`

Source: id3v2.asd.
Parent Component: id3v2 (system).
ASDF Systems: id3v2.
Packages: id3v2-asd.

Next: id3v2/src/id3v22.lisp, Previous: id3v2/id3v2.asd, Up: Lisp [Contents][Index]

4.1.2 `id3v2/src/id3v2.lisp`

Dependencies

id3v22.lisp (file).
id3v23.lisp (file).
id3v24.lisp (file).
limit-stream.lisp (file).
mp3.lisp (file).
util.lisp (file).

Source

Parent Component

src (module).

Packages

Public Interface

id3v2-header (structure).
id3v2-header-flags (reader).
(setf id3v2-header-flags) (writer).
id3v2-header-revision (reader).
(setf id3v2-header-revision) (writer).
id3v2-header-size (reader).
(setf id3v2-header-size) (writer).
id3v2-header-version (reader).
(setf id3v2-header-version) (writer).
read-mp3-file (function).

Internals

copy-id3v2-header (function).
has-id3-tag-p (function).
id3v2-header-p (function).
make-id3v2-header (function).
read-id3v2-header (function).

Next: id3v2/src/id3v23.lisp, Previous: id3v2/src/id3v2.lisp, Up: Lisp [Contents][Index]

4.1.3 `id3v2/src/id3v22.lisp`

Dependencies

mp3.lisp (file).
util.lisp (file).

Source

Parent Component

src (module).

Packages

id3v2.2.

Public Interface

parse-id3v22 (function).

Next: id3v2/src/id3v24.lisp, Previous: id3v2/src/id3v22.lisp, Up: Lisp [Contents][Index]

4.1.4 `id3v2/src/id3v23.lisp`

Dependencies

mp3.lisp (file).
util.lisp (file).

Source

Parent Component

src (module).

Packages

id3v2.3.

Public Interface

parse-id3v23 (function).

Next: id3v2/src/limit-stream.lisp, Previous: id3v2/src/id3v23.lisp, Up: Lisp [Contents][Index]

4.1.5 `id3v2/src/id3v24.lisp`

Dependencies

mp3.lisp (file).
util.lisp (file).

Source

Parent Component

src (module).

Packages

id3v2.4.

Public Interface

parse-id3v24 (function).

Next: id3v2/src/mp3.lisp, Previous: id3v2/src/id3v24.lisp, Up: Lisp [Contents][Index]

4.1.6 `id3v2/src/limit-stream.lisp`

Source

Parent Component

src (module).

Packages

Public Interface

limit-stream (class).
make-limit-stream (function).
stream-element-type (method).
stream-read-byte (method).
stream-read-sequence (method).

Internals

limit-stream-real-stream (reader method).
(setf limit-stream-real-stream) (writer method).

Next: id3v2/src/util.lisp, Previous: id3v2/src/limit-stream.lisp, Up: Lisp [Contents][Index]

4.1.7 `id3v2/src/mp3.lisp`

Source

Parent Component

src (module).

Packages

id3v2.mp3.

Public Interface

make-mp3 (function).
mp3 (structure).
mp3-album (reader).
(setf mp3-album) (writer).
mp3-artist (reader).
(setf mp3-artist) (writer).
mp3-comments (reader).
(setf mp3-comments) (writer).
mp3-disc (reader).
(setf mp3-disc) (writer).
mp3-genre (reader).
(setf mp3-genre) (writer).
mp3-header (reader).
(setf mp3-header) (writer).
mp3-length (reader).
(setf mp3-length) (writer).
mp3-name (reader).
(setf mp3-name) (writer).
mp3-track (reader).
(setf mp3-track) (writer).
mp3-year (reader).
(setf mp3-year) (writer).

Internals

copy-mp3 (function).
mp3-p (function).

Previous: id3v2/src/mp3.lisp, Up: Lisp [Contents][Index]

4.1.8 `id3v2/src/util.lisp`

Source

Parent Component

src (module).

Packages

id3v2.util.

Public Interface

read-comment-string (function).
read-frame-size (function).
read-id (function).
read-string (function).
skip-bytes (function).

Next: Definitions, Previous: Files, Up: The id3v2 Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

id3v2
id3v2.3
id3v2-asd
id3v2.2
id3v2.4
id3v2.limit-stream
id3v2.util
id3v2.mp3

Next: id3v2.3, Previous: Packages, Up: Packages [Contents][Index]

5.1 `id3v2`

Source

id3v2.lisp.

Use List

common-lisp.
id3v2.2.
id3v2.3.
id3v2.4.
id3v2.limit-stream.
id3v2.mp3.
id3v2.util.

Public Interface

id3v2-header (structure).
id3v2-header-flags (reader).
(setf id3v2-header-flags) (writer).
id3v2-header-revision (reader).
(setf id3v2-header-revision) (writer).
id3v2-header-size (reader).
(setf id3v2-header-size) (writer).
id3v2-header-version (reader).
(setf id3v2-header-version) (writer).
read-mp3-file (function).

Internals

copy-id3v2-header (function).
has-id3-tag-p (function).
id3v2-header-p (function).
make-id3v2-header (function).
read-id3v2-header (function).

Next: id3v2-asd, Previous: id3v2, Up: Packages [Contents][Index]

5.2 `id3v2.3`

Source

id3v23.lisp.

Use List

common-lisp.
id3v2.mp3.
id3v2.util.

Used By List

Public Interface

parse-id3v23 (function).

Next: id3v2.2, Previous: id3v2.3, Up: Packages [Contents][Index]

5.3 `id3v2-asd`

Source

Use List

asdf/interface.
common-lisp.

Next: id3v2.4, Previous: id3v2-asd, Up: Packages [Contents][Index]

5.4 `id3v2.2`

Source

id3v22.lisp.

Use List

common-lisp.
id3v2.mp3.
id3v2.util.

Used By List

Public Interface

parse-id3v22 (function).

Next: id3v2.limit-stream, Previous: id3v2.2, Up: Packages [Contents][Index]

5.5 `id3v2.4`

Source

id3v24.lisp.

Use List

common-lisp.
id3v2.mp3.
id3v2.util.

Used By List

Public Interface

parse-id3v24 (function).

Next: id3v2.util, Previous: id3v2.4, Up: Packages [Contents][Index]

5.6 `id3v2.limit-stream`

Source

limit-stream.lisp.

Use List

common-lisp.

Used By List

Public Interface

limit-stream (class).
make-limit-stream (function).

Internals

limit-stream-real-stream (generic reader).
(setf limit-stream-real-stream) (generic writer).

Next: id3v2.mp3, Previous: id3v2.limit-stream, Up: Packages [Contents][Index]

5.7 `id3v2.util`

Source

util.lisp.

Use List

common-lisp.

Used By List

id3v2.
id3v2.2.
id3v2.3.
id3v2.4.

Public Interface

read-comment-string (function).
read-frame-size (function).
read-id (function).
read-string (function).
skip-bytes (function).

Previous: id3v2.util, Up: Packages [Contents][Index]

5.8 `id3v2.mp3`

Source

mp3.lisp.

Use List

common-lisp.

Used By List

id3v2.
id3v2.2.
id3v2.3.
id3v2.4.

Public Interface

make-mp3 (function).
mp3 (structure).
mp3-album (reader).
(setf mp3-album) (writer).
mp3-artist (reader).
(setf mp3-artist) (writer).
mp3-comments (reader).
(setf mp3-comments) (writer).
mp3-disc (reader).
(setf mp3-disc) (writer).
mp3-genre (reader).
(setf mp3-genre) (writer).
mp3-header (reader).
(setf mp3-header) (writer).
mp3-length (reader).
(setf mp3-length) (writer).
mp3-name (reader).
(setf mp3-name) (writer).
mp3-track (reader).
(setf mp3-track) (writer).
mp3-year (reader).
(setf mp3-year) (writer).

Internals

copy-mp3 (function).
mp3-p (function).

Next: Indexes, Previous: Packages, Up: The id3v2 Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Ordinary functions
Standalone methods
Structures
Classes

Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Reader: id3v2-header-flags (instance) ¶

Writer: (setf id3v2-header-flags) (instance) ¶

Package: id3v2.
Source: id3v2.lisp.
Target Slot: flags.

Reader: id3v2-header-revision (instance) ¶

Writer: (setf id3v2-header-revision) (instance) ¶

Package: id3v2.
Source: id3v2.lisp.
Target Slot: revision.

Reader: id3v2-header-size (instance) ¶

Writer: (setf id3v2-header-size) (instance) ¶

Package: id3v2.
Source: id3v2.lisp.
Target Slot: size.

Reader: id3v2-header-version (instance) ¶

Writer: (setf id3v2-header-version) (instance) ¶

Package: id3v2.
Source: id3v2.lisp.
Target Slot: version.

Function: make-limit-stream (stream limit) ¶

Package: id3v2.limit-stream.
Source: limit-stream.lisp.

Function: make-mp3 (&key header name artist album year track disc genre length comments) ¶

Package: id3v2.mp3.
Source: mp3.lisp.

Reader: mp3-album (instance) ¶

Writer: (setf mp3-album) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: album.

Reader: mp3-artist (instance) ¶

Writer: (setf mp3-artist) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: artist.

Reader: mp3-comments (instance) ¶

Writer: (setf mp3-comments) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: comments.

Reader: mp3-disc (instance) ¶

Writer: (setf mp3-disc) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: disc.

Reader: mp3-genre (instance) ¶

Writer: (setf mp3-genre) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: genre.

Reader: mp3-header (instance) ¶

Writer: (setf mp3-header) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: header.

Reader: mp3-length (instance) ¶

Writer: (setf mp3-length) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: length.

Reader: mp3-name (instance) ¶

Writer: (setf mp3-name) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: name.

Reader: mp3-track (instance) ¶

Writer: (setf mp3-track) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: track.

Reader: mp3-year (instance) ¶

Writer: (setf mp3-year) (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.
Target Slot: year.

Function: parse-id3v22 (file stream) ¶

Package: id3v2.2.
Source: id3v22.lisp.

Function: parse-id3v23 (file stream) ¶

Package: id3v2.3.
Source: id3v23.lisp.

Function: parse-id3v24 (file stream) ¶

Package: id3v2.4.
Source: id3v24.lisp.

Function: read-comment-string (stream size) ¶

Package: id3v2.util.
Source: util.lisp.

Function: read-frame-size (stream &optional count) ¶

Package: id3v2.util.
Source: util.lisp.

Function: read-id (stream &optional count) ¶

Package: id3v2.util.
Source: util.lisp.

Function: read-mp3-file (path) ¶

Package: id3v2.
Source: id3v2.lisp.

Function: read-string (stream size) ¶

Package: id3v2.util.
Source: util.lisp.

Function: skip-bytes (stream size) ¶

Package: id3v2.util.
Source: util.lisp.

Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.2 Standalone methods

Method: stream-element-type ((stream limit-stream)) ¶

Source: limit-stream.lisp.

Method: stream-read-byte ((stream limit-stream)) ¶

Package: sb-gray.
Source: limit-stream.lisp.

Method: stream-read-sequence ((stream limit-stream) sequence start end &key) ¶

Package: trivial-gray-streams.
Source: limit-stream.lisp.

Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]

6.1.3 Structures

Structure: id3v2-header ¶

Package

Source

id3v2.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: version ¶

Readers: id3v2-header-version.
Writers: (setf id3v2-header-version).

Slot: revision ¶

Readers: id3v2-header-revision.
Writers: (setf id3v2-header-revision).

Slot: flags ¶

Readers: id3v2-header-flags.
Writers: (setf id3v2-header-flags).

Slot: size ¶

Readers: id3v2-header-size.
Writers: (setf id3v2-header-size).

Structure: mp3 ¶

Package

id3v2.mp3.

Source

mp3.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: header ¶

Readers: mp3-header.
Writers: (setf mp3-header).

Slot: name ¶

Readers: mp3-name.
Writers: (setf mp3-name).

Slot: artist ¶

Readers: mp3-artist.
Writers: (setf mp3-artist).

Slot: album ¶

Readers: mp3-album.
Writers: (setf mp3-album).

Slot: year ¶

Readers: mp3-year.
Writers: (setf mp3-year).

Slot: track ¶

Readers: mp3-track.
Writers: (setf mp3-track).

Slot: disc ¶

Readers: mp3-disc.
Writers: (setf mp3-disc).

Slot: genre ¶

Readers: mp3-genre.
Writers: (setf mp3-genre).

Slot: length ¶

Package: common-lisp.
Readers: mp3-length.
Writers: (setf mp3-length).

Slot: comments ¶

Readers: mp3-comments.
Writers: (setf mp3-comments).

Previous: Structures, Up: Public Interface [Contents][Index]

6.1.4 Classes

Class: limit-stream ¶

Package

Source

limit-stream.lisp.

Direct superclasses

fundamental-binary-input-stream.

Direct methods

(setf limit-stream-real-stream).
limit-stream-real-stream.
stream-element-type.
stream-read-byte.
stream-read-sequence.

Direct slots

Slot: real-stream ¶

Type: stream
Initform: (error ":stream is required")
Initargs: :stream
Readers: limit-stream-real-stream.
Writers: (setf limit-stream-real-stream).

Slot: readable-bytes ¶

Type: integer
Initform: (error ":limit is required")
Initargs: :limit

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

6.2 Internals

Ordinary functions
Generic functions

Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Ordinary functions

Function: copy-id3v2-header (instance) ¶

Package: id3v2.
Source: id3v2.lisp.

Function: copy-mp3 (instance) ¶

Package: id3v2.mp3.
Source: mp3.lisp.

Function: has-id3-tag-p (stream) ¶

Package: id3v2.
Source: id3v2.lisp.

Function: id3v2-header-p (object) ¶

Package: id3v2.
Source: id3v2.lisp.

Function: make-id3v2-header (&key version revision flags size) ¶

Package: id3v2.
Source: id3v2.lisp.

Function: mp3-p (object) ¶

Package: id3v2.mp3.
Source: mp3.lisp.

Function: read-id3v2-header (stream) ¶

Package: id3v2.
Source: id3v2.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.2 Generic functions

Generic Reader: limit-stream-real-stream (object) ¶

Package

Methods

Reader Method: limit-stream-real-stream ((limit-stream limit-stream)) ¶

automatically generated reader method

Source: limit-stream.lisp.
Target Slot: real-stream.

Generic Writer: (setf limit-stream-real-stream) (object) ¶

Package