The id3v2 Reference Manual

Table of Contents

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

The id3v2 Reference Manual

This is the id3v2 Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:50:46 2018 GMT+0.


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

1 Introduction

id3v2 - ID3v2 parser

Usage

(id3v2:read-mp3-file #P"Music/ピノキオP/ありふれたせかいせいふく.mp3")
;=> #S(ID3V2.MP3:MP3
;      :HEADER #S(ID3V2:ID3V2-HEADER :VERSION 4 :REVISION 0 :FLAGS 0 :SIZE 202227)
;      :NAME "ありふれたせかいせいふく"
;      :ARTIST "ピノキオP Feat. 初音ミク"
;      :ALBUM "Obscure Questions"
;      :YEAR "2012"
;      :TRACK NIL
;      :DISC NIL
;      :GENRE "Electronica"
;      :LENGTH NIL
;      :COMMENTS NIL)

Author

Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.


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 id3v2

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

ID3v2 parser

Long Description

# id3v2 - ID3v2 parser

## Usage

“‘common-lisp
(id3v2:read-mp3-file #P"Music/ピノキオP/ありふれたせかいせいふく.mp3")
;=> #S(ID3V2.MP3:MP3
; :HEADER #S(ID3V2:ID3V2-HEADER :VERSION 4 :REVISION 0 :FLAGS 0 :SIZE 202227) ; :NAME "ありふれたせかいせいふく"
; :ARTIST "ピノキオP Feat. 初音ミク"
; :ALBUM "Obscure Questions"
; :YEAR "2012"
; :TRACK NIL
; :DISC NIL
; :GENRE "Electronica"
; :LENGTH NIL
; :COMMENTS NIL)
“‘

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies
Source

id3v2.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 id3v2/src

Parent

id3v2 (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 id3v2.asd

Location

id3v2.asd

Systems

id3v2 (system)

Packages

id3v2-asd


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

4.1.2 id3v2/src/id3v2.lisp

Dependencies
Parent

src (module)

Location

src/id3v2.lisp

Packages

id3v2

Exported Definitions
Internal Definitions

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

4.1.3 id3v2/src/id3v22.lisp

Dependencies
Parent

src (module)

Location

src/id3v22.lisp

Packages

id3v2.2

Exported Definitions

parse-id3v22 (function)


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

4.1.4 id3v2/src/id3v23.lisp

Dependencies
Parent

src (module)

Location

src/id3v23.lisp

Packages

id3v2.3

Exported Definitions

parse-id3v23 (function)


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

4.1.5 id3v2/src/id3v24.lisp

Dependencies
Parent

src (module)

Location

src/id3v24.lisp

Packages

id3v2.4

Exported Definitions

parse-id3v24 (function)


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

4.1.6 id3v2/src/limit-stream.lisp

Parent

src (module)

Location

src/limit-stream.lisp

Packages

id3v2.limit-stream

Exported Definitions
Internal Definitions

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

4.1.7 id3v2/src/mp3.lisp

Parent

src (module)

Location

src/mp3.lisp

Packages

id3v2.mp3

Exported Definitions
Internal Definitions

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

4.1.8 id3v2/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

id3v2.util

Exported Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 id3v2-asd

Source

id3v2.asd

Use List

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

5.2 id3v2

Source

id3v2.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.3 id3v2.2

Source

id3v22.lisp (file)

Use List
Used By List

id3v2

Exported Definitions

parse-id3v22 (function)


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

5.4 id3v2.3

Source

id3v23.lisp (file)

Use List
Used By List

id3v2

Exported Definitions

parse-id3v23 (function)


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

5.5 id3v2.4

Source

id3v24.lisp (file)

Use List
Used By List

id3v2

Exported Definitions

parse-id3v24 (function)


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

5.6 id3v2.limit-stream

Source

limit-stream.lisp (file)

Use List

common-lisp

Used By List

id3v2

Exported Definitions
Internal Definitions

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

5.7 id3v2.mp3

Source

mp3.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions
Internal Definitions

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

5.8 id3v2.util

Source

util.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Functions

Function: id3v2-header-flags INSTANCE
Function: (setf id3v2-header-flags) VALUE INSTANCE
Package

id3v2

Source

id3v2.lisp (file)

Function: id3v2-header-revision INSTANCE
Function: (setf id3v2-header-revision) VALUE INSTANCE
Package

id3v2

Source

id3v2.lisp (file)

Function: id3v2-header-size INSTANCE
Function: (setf id3v2-header-size) VALUE INSTANCE
Package

id3v2

Source

id3v2.lisp (file)

Function: id3v2-header-version INSTANCE
Function: (setf id3v2-header-version) VALUE INSTANCE
Package

id3v2

Source

id3v2.lisp (file)

Function: make-limit-stream STREAM LIMIT
Package

id3v2.limit-stream

Source

limit-stream.lisp (file)

Function: make-mp3 &key (HEADER HEADER) (NAME NAME) (ARTIST ARTIST) (ALBUM ALBUM) (YEAR YEAR) (TRACK TRACK) (DISC DISC) (GENRE GENRE) (LENGTH LENGTH) (COMMENTS COMMENTS)
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-album INSTANCE
Function: (setf mp3-album) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-artist INSTANCE
Function: (setf mp3-artist) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-comments INSTANCE
Function: (setf mp3-comments) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-disc INSTANCE
Function: (setf mp3-disc) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-genre INSTANCE
Function: (setf mp3-genre) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-header INSTANCE
Function: (setf mp3-header) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-length INSTANCE
Function: (setf mp3-length) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-name INSTANCE
Function: (setf mp3-name) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-track INSTANCE
Function: (setf mp3-track) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: mp3-year INSTANCE
Function: (setf mp3-year) VALUE INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: parse-id3v22 FILE STREAM
Package

id3v2.2

Source

id3v22.lisp (file)

Function: parse-id3v23 FILE STREAM
Package

id3v2.3

Source

id3v23.lisp (file)

Function: parse-id3v24 FILE STREAM
Package

id3v2.4

Source

id3v24.lisp (file)

Function: read-comment-string STREAM SIZE
Package

id3v2.util

Source

util.lisp (file)

Function: read-frame-size STREAM &optional COUNT
Package

id3v2.util

Source

util.lisp (file)

Function: read-id STREAM &optional COUNT
Package

id3v2.util

Source

util.lisp (file)

Function: read-mp3-file PATH
Package

id3v2

Source

id3v2.lisp (file)

Function: read-string STREAM SIZE
Package

id3v2.util

Source

util.lisp (file)

Function: skip-bytes STREAM SIZE
Package

id3v2.util

Source

util.lisp (file)


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

6.1.2 Structures

Structure: id3v2-header ()
Package

id3v2

Source

id3v2.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: version
Readers

id3v2-header-version (function)

Writers

(setf id3v2-header-version) (function)

Slot: revision
Readers

id3v2-header-revision (function)

Writers

(setf id3v2-header-revision) (function)

Slot: flags
Readers

id3v2-header-flags (function)

Writers

(setf id3v2-header-flags) (function)

Slot: size
Readers

id3v2-header-size (function)

Writers

(setf id3v2-header-size) (function)

Structure: mp3 ()
Package

id3v2.mp3

Source

mp3.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: header
Readers

mp3-header (function)

Writers

(setf mp3-header) (function)

Slot: name
Readers

mp3-name (function)

Writers

(setf mp3-name) (function)

Slot: artist
Readers

mp3-artist (function)

Writers

(setf mp3-artist) (function)

Slot: album
Readers

mp3-album (function)

Writers

(setf mp3-album) (function)

Slot: year
Readers

mp3-year (function)

Writers

(setf mp3-year) (function)

Slot: track
Readers

mp3-track (function)

Writers

(setf mp3-track) (function)

Slot: disc
Readers

mp3-disc (function)

Writers

(setf mp3-disc) (function)

Slot: genre
Readers

mp3-genre (function)

Writers

(setf mp3-genre) (function)

Slot: length
Readers

mp3-length (function)

Writers

(setf mp3-length) (function)

Slot: comments
Readers

mp3-comments (function)

Writers

(setf mp3-comments) (function)


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

6.1.3 Classes

Class: limit-stream ()
Package

id3v2.limit-stream

Source

limit-stream.lisp (file)

Direct superclasses

fundamental-binary-input-stream (class)

Direct methods
  • stream-read-sequence (method)
  • stream-read-byte (method)
  • stream-element-type (method)
  • limit-stream-real-stream (method)
  • limit-stream-real-stream (method)
Direct slots
Slot: real-stream
Type

stream

Initargs

:stream

Initform

(error ":stream is required")

Readers

limit-stream-real-stream (generic function)

Writers

(setf limit-stream-real-stream) (generic function)

Slot: readable-bytes
Type

integer

Initargs

:limit

Initform

(error ":limit is required")


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

6.2 Internal definitions


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

6.2.1 Functions

Function: copy-id3v2-header INSTANCE
Package

id3v2

Source

id3v2.lisp (file)

Function: copy-mp3 INSTANCE
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: has-id3-tag-p STREAM
Package

id3v2

Source

id3v2.lisp (file)

Function: id3v2-header-p OBJECT
Package

id3v2

Source

id3v2.lisp (file)

Function: make-id3v2-header &key (VERSION VERSION) (REVISION REVISION) (FLAGS FLAGS) (SIZE SIZE)
Package

id3v2

Source

id3v2.lisp (file)

Function: mp3-p OBJECT
Package

id3v2.mp3

Source

mp3.lisp (file)

Function: read-id3v2-header STREAM
Package

id3v2

Source

id3v2.lisp (file)


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

6.2.2 Generic functions

Generic Function: limit-stream-real-stream OBJECT
Generic Function: (setf limit-stream-real-stream) NEW-VALUE OBJECT
Package

id3v2.limit-stream

Methods
Method: limit-stream-real-stream (LIMIT-STREAM limit-stream)

automatically generated reader method

Source

limit-stream.lisp (file)

Method: (setf limit-stream-real-stream) NEW-VALUE (LIMIT-STREAM limit-stream)

automatically generated writer method

Source

limit-stream.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   I   L   M  
Index Entry  Section

F
File, Lisp, id3v2.asd: The id3v2<dot>asd file
File, Lisp, id3v2/src/id3v2.lisp: The id3v2/src/id3v2<dot>lisp file
File, Lisp, id3v2/src/id3v22.lisp: The id3v2/src/id3v22<dot>lisp file
File, Lisp, id3v2/src/id3v23.lisp: The id3v2/src/id3v23<dot>lisp file
File, Lisp, id3v2/src/id3v24.lisp: The id3v2/src/id3v24<dot>lisp file
File, Lisp, id3v2/src/limit-stream.lisp: The id3v2/src/limit-stream<dot>lisp file
File, Lisp, id3v2/src/mp3.lisp: The id3v2/src/mp3<dot>lisp file
File, Lisp, id3v2/src/util.lisp: The id3v2/src/util<dot>lisp file

I
id3v2.asd: The id3v2<dot>asd file
id3v2/src: The id3v2/src module
id3v2/src/id3v2.lisp: The id3v2/src/id3v2<dot>lisp file
id3v2/src/id3v22.lisp: The id3v2/src/id3v22<dot>lisp file
id3v2/src/id3v23.lisp: The id3v2/src/id3v23<dot>lisp file
id3v2/src/id3v24.lisp: The id3v2/src/id3v24<dot>lisp file
id3v2/src/limit-stream.lisp: The id3v2/src/limit-stream<dot>lisp file
id3v2/src/mp3.lisp: The id3v2/src/mp3<dot>lisp file
id3v2/src/util.lisp: The id3v2/src/util<dot>lisp file

L
Lisp File, id3v2.asd: The id3v2<dot>asd file
Lisp File, id3v2/src/id3v2.lisp: The id3v2/src/id3v2<dot>lisp file
Lisp File, id3v2/src/id3v22.lisp: The id3v2/src/id3v22<dot>lisp file
Lisp File, id3v2/src/id3v23.lisp: The id3v2/src/id3v23<dot>lisp file
Lisp File, id3v2/src/id3v24.lisp: The id3v2/src/id3v24<dot>lisp file
Lisp File, id3v2/src/limit-stream.lisp: The id3v2/src/limit-stream<dot>lisp file
Lisp File, id3v2/src/mp3.lisp: The id3v2/src/mp3<dot>lisp file
Lisp File, id3v2/src/util.lisp: The id3v2/src/util<dot>lisp file

M
Module, id3v2/src: The id3v2/src module

Jump to:   F   I   L   M  

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

A.2 Functions

Jump to:   (  
C   F   G   H   I   L   M   P   R   S  
Index Entry  Section

(
(setf id3v2-header-flags): Exported functions
(setf id3v2-header-revision): Exported functions
(setf id3v2-header-size): Exported functions
(setf id3v2-header-version): Exported functions
(setf limit-stream-real-stream): Internal generic functions
(setf limit-stream-real-stream): Internal generic functions
(setf mp3-album): Exported functions
(setf mp3-artist): Exported functions
(setf mp3-comments): Exported functions
(setf mp3-disc): Exported functions
(setf mp3-genre): Exported functions
(setf mp3-header): Exported functions
(setf mp3-length): Exported functions
(setf mp3-name): Exported functions
(setf mp3-track): Exported functions
(setf mp3-year): Exported functions

C
copy-id3v2-header: Internal functions
copy-mp3: Internal functions

F
Function, (setf id3v2-header-flags): Exported functions
Function, (setf id3v2-header-revision): Exported functions
Function, (setf id3v2-header-size): Exported functions
Function, (setf id3v2-header-version): Exported functions
Function, (setf mp3-album): Exported functions
Function, (setf mp3-artist): Exported functions
Function, (setf mp3-comments): Exported functions
Function, (setf mp3-disc): Exported functions
Function, (setf mp3-genre): Exported functions
Function, (setf mp3-header): Exported functions
Function, (setf mp3-length): Exported functions
Function, (setf mp3-name): Exported functions
Function, (setf mp3-track): Exported functions
Function, (setf mp3-year): Exported functions
Function, copy-id3v2-header: Internal functions
Function, copy-mp3: Internal functions
Function, has-id3-tag-p: Internal functions
Function, id3v2-header-flags: Exported functions
Function, id3v2-header-p: Internal functions
Function, id3v2-header-revision: Exported functions
Function, id3v2-header-size: Exported functions
Function, id3v2-header-version: Exported functions
Function, make-id3v2-header: Internal functions
Function, make-limit-stream: Exported functions
Function, make-mp3: Exported functions
Function, mp3-album: Exported functions
Function, mp3-artist: Exported functions
Function, mp3-comments: Exported functions
Function, mp3-disc: Exported functions
Function, mp3-genre: Exported functions
Function, mp3-header: Exported functions
Function, mp3-length: Exported functions
Function, mp3-name: Exported functions
Function, mp3-p: Internal functions
Function, mp3-track: Exported functions
Function, mp3-year: Exported functions
Function, parse-id3v22: Exported functions
Function, parse-id3v23: Exported functions
Function, parse-id3v24: Exported functions
Function, read-comment-string: Exported functions
Function, read-frame-size: Exported functions
Function, read-id: Exported functions
Function, read-id3v2-header: Internal functions
Function, read-mp3-file: Exported functions
Function, read-string: Exported functions
Function, skip-bytes: Exported functions

G
Generic Function, (setf limit-stream-real-stream): Internal generic functions
Generic Function, limit-stream-real-stream: Internal generic functions

H
has-id3-tag-p: Internal functions

I
id3v2-header-flags: Exported functions
id3v2-header-p: Internal functions
id3v2-header-revision: Exported functions
id3v2-header-size: Exported functions
id3v2-header-version: Exported functions

L
limit-stream-real-stream: Internal generic functions
limit-stream-real-stream: Internal generic functions

M
make-id3v2-header: Internal functions
make-limit-stream: Exported functions
make-mp3: Exported functions
Method, (setf limit-stream-real-stream): Internal generic functions
Method, limit-stream-real-stream: Internal generic functions
mp3-album: Exported functions
mp3-artist: Exported functions
mp3-comments: Exported functions
mp3-disc: Exported functions
mp3-genre: Exported functions
mp3-header: Exported functions
mp3-length: Exported functions
mp3-name: Exported functions
mp3-p: Internal functions
mp3-track: Exported functions
mp3-year: Exported functions

P
parse-id3v22: Exported functions
parse-id3v23: Exported functions
parse-id3v24: Exported functions

R
read-comment-string: Exported functions
read-frame-size: Exported functions
read-id: Exported functions
read-id3v2-header: Internal functions
read-mp3-file: Exported functions
read-string: Exported functions

S
skip-bytes: Exported functions

Jump to:   (  
C   F   G   H   I   L   M   P   R   S  

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

A.3 Variables

Jump to:   A   C   D   F   G   H   L   N   R   S   T   V   Y  
Index Entry  Section

A
album: Exported structures
artist: Exported structures

C
comments: Exported structures

D
disc: Exported structures

F
flags: Exported structures

G
genre: Exported structures

H
header: Exported structures

L
length: Exported structures

N
name: Exported structures

R
readable-bytes: Exported classes
real-stream: Exported classes
revision: Exported structures

S
size: Exported structures
Slot, album: Exported structures
Slot, artist: Exported structures
Slot, comments: Exported structures
Slot, disc: Exported structures
Slot, flags: Exported structures
Slot, genre: Exported structures
Slot, header: Exported structures
Slot, length: Exported structures
Slot, name: Exported structures
Slot, readable-bytes: Exported classes
Slot, real-stream: Exported classes
Slot, revision: Exported structures
Slot, size: Exported structures
Slot, track: Exported structures
Slot, version: Exported structures
Slot, year: Exported structures

T
track: Exported structures

V
version: Exported structures

Y
year: Exported structures

Jump to:   A   C   D   F   G   H   L   N   R   S   T   V   Y  

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

A.4 Data types

Jump to:   C   I   L   M   P   S  
Index Entry  Section

C
Class, limit-stream: Exported classes

I
id3v2: The id3v2 system
id3v2: The id3v2 package
id3v2-asd: The id3v2-asd package
id3v2-header: Exported structures
id3v2.2: The id3v2<dot>2 package
id3v2.3: The id3v2<dot>3 package
id3v2.4: The id3v2<dot>4 package
id3v2.limit-stream: The id3v2<dot>limit-stream package
id3v2.mp3: The id3v2<dot>mp3 package
id3v2.util: The id3v2<dot>util package

L
limit-stream: Exported classes

M
mp3: Exported structures

P
Package, id3v2: The id3v2 package
Package, id3v2-asd: The id3v2-asd package
Package, id3v2.2: The id3v2<dot>2 package
Package, id3v2.3: The id3v2<dot>3 package
Package, id3v2.4: The id3v2<dot>4 package
Package, id3v2.limit-stream: The id3v2<dot>limit-stream package
Package, id3v2.mp3: The id3v2<dot>mp3 package
Package, id3v2.util: The id3v2<dot>util package

S
Structure, id3v2-header: Exported structures
Structure, mp3: Exported structures
System, id3v2: The id3v2 system

Jump to:   C   I   L   M   P   S