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

The mp3-duration Reference Manual

This is the mp3-duration Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 14:22:47 2023 GMT+0.

Next: Systems, Previous: The mp3-duration Reference Manual, Up: The mp3-duration Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The mp3-duration Reference Manual [Contents][Index]

2 Systems

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

mp3-duration

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

2.1 `mp3-duration`

Get the duration of an MP3 file

Author

Eitaro Fukamachi

License

BSD 2-Clause

Long Description

# Mp3-Duration - Get the duration of an MP3 file

## Usage

“‘common-lisp
(import ’mp3-duration:estimate-duration)

;; Get the duration of an MP3 file in seconds. (estimate-duration #P"Music/ピノキオP/ありふれたせかいせいふく.mp3") ;=> 202.97144
“‘

## Author

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

## Copyright

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Source

mp3-duration.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The mp3-duration Reference Manual [Contents][Index]

3 Modules

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

mp3-duration/src

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

3.1 `mp3-duration/src`

Source: mp3-duration.asd.
Parent Component: mp3-duration (system).
Child Component: mp3-duration.lisp (file).

Next: Packages, Previous: Modules, Up: The mp3-duration 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: mp3-duration/src/mp3-duration.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `mp3-duration/mp3-duration.asd`

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

Previous: mp3-duration/mp3-duration.asd, Up: Lisp [Contents][Index]

4.1.2 `mp3-duration/src/mp3-duration.lisp`

Source

mp3-duration.asd.

Parent Component

src (module).

Packages

mp3-duration.

Public Interface

estimate-duration (function).

Internals

*skip-buffer* (special variable).
copy-peekable-stream (function).
make-peekable-stream (function).
parse-frame (function).
peek-byte (function).
peekable-stream (structure).
peekable-stream-p (function).
peekable-stream-peek (reader).
(setf peekable-stream-peek) (writer).
peekable-stream-real-stream (reader).
(setf peekable-stream-real-stream) (writer).
read-byte* (function).
skip-bytes (function).
skip-id3-tag (function).
unread-byte (function).

Next: Definitions, Previous: Files, Up: The mp3-duration Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

mp3-duration-asd
mp3-duration

Next: mp3-duration, Previous: Packages, Up: Packages [Contents][Index]

5.1 `mp3-duration-asd`

Source

mp3-duration.asd.

Use List

asdf/interface.
common-lisp.

Previous: mp3-duration-asd, Up: Packages [Contents][Index]

5.2 `mp3-duration`

Source

mp3-duration.lisp.

Use List

common-lisp.

Public Interface

estimate-duration (function).

Internals

*skip-buffer* (special variable).
copy-peekable-stream (function).
make-peekable-stream (function).
parse-frame (function).
peek-byte (function).
peekable-stream (structure).
peekable-stream-p (function).
peekable-stream-peek (reader).
(setf peekable-stream-peek) (writer).
peekable-stream-real-stream (reader).
(setf peekable-stream-real-stream) (writer).
read-byte* (function).
skip-bytes (function).
skip-id3-tag (function).
unread-byte (function).

Next: Indexes, Previous: Packages, Up: The mp3-duration 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

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

6.1.1 Ordinary functions

Function: estimate-duration (input) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

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

6.2 Internals

Special variables
Ordinary functions
Structures

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

6.2.1 Special variables

Special Variable: *skip-buffer* ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Next: Structures, Previous: Special variables, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: copy-peekable-stream (instance) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Function: make-peekable-stream (&key peek real-stream) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Function: parse-frame (in) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Function: peek-byte (stream) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Function: peekable-stream-p (object) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Reader: peekable-stream-peek (instance) ¶

Writer: (setf peekable-stream-peek) (instance) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.
Target Slot: peek.

Reader: peekable-stream-real-stream (instance) ¶

Writer: (setf peekable-stream-real-stream) (instance) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.
Target Slot: real-stream.

Function: read-byte* (stream) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Function: skip-bytes (in count) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Function: skip-id3-tag (in) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

Function: unread-byte (stream byte) ¶

Package: mp3-duration.
Source: mp3-duration.lisp.

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

6.2.3 Structures

Structure: peekable-stream ¶

Package

mp3-duration.

Source

mp3-duration.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: peek ¶

Type: (or null (unsigned-byte 8))
Readers: peekable-stream-peek.
Writers: (setf peekable-stream-peek).

Slot: real-stream ¶

Type: stream
Readers: peekable-stream-real-stream.
Writers: (setf peekable-stream-real-stream).

Previous: Definitions, Up: The mp3-duration Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( C E F M P R S U

	Index Entry	Section

(
	`(setf peekable-stream-peek)`:	Private ordinary functions
	`(setf peekable-stream-real-stream)`:	Private ordinary functions

C
	`copy-peekable-stream`:	Private ordinary functions

E
	`estimate-duration`:	Public ordinary functions

F
	`Function, (setf peekable-stream-peek)`:	Private ordinary functions
	`Function, (setf peekable-stream-real-stream)`:	Private ordinary functions
	`Function, copy-peekable-stream`:	Private ordinary functions
	`Function, estimate-duration`:	Public ordinary functions
	`Function, make-peekable-stream`:	Private ordinary functions
	`Function, parse-frame`:	Private ordinary functions
	`Function, peek-byte`:	Private ordinary functions
	`Function, peekable-stream-p`:	Private ordinary functions
	`Function, peekable-stream-peek`:	Private ordinary functions
	`Function, peekable-stream-real-stream`:	Private ordinary functions
	`Function, read-byte*`:	Private ordinary functions
	`Function, skip-bytes`:	Private ordinary functions
	`Function, skip-id3-tag`:	Private ordinary functions
	`Function, unread-byte`:	Private ordinary functions

M
	`make-peekable-stream`:	Private ordinary functions

P
	`parse-frame`:	Private ordinary functions
	`peek-byte`:	Private ordinary functions
	`peekable-stream-p`:	Private ordinary functions
	`peekable-stream-peek`:	Private ordinary functions
	`peekable-stream-real-stream`:	Private ordinary functions

R
	`read-byte*`:	Private ordinary functions

S
	`skip-bytes`:	Private ordinary functions
	`skip-id3-tag`:	Private ordinary functions

U
	`unread-byte`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* P R S

	Index Entry	Section

*
	`skip-buffer`:	Private special variables

P
	`peek`:	Private structures

R
	`real-stream`:	Private structures

S
	`Slot, peek`:	Private structures
	`Slot, real-stream`:	Private structures
	`Special Variable, skip-buffer`:	Private special variables

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

A.4 Data types

Jump to:	F M P S

	Index Entry	Section

F
	`File, mp3-duration.asd`:	The mp3-duration/mp3-duration․asd file
	`File, mp3-duration.lisp`:	The mp3-duration/src/mp3-duration․lisp file

M
	`Module, src`:	The mp3-duration/src module
	`mp3-duration`:	The mp3-duration system
	`mp3-duration`:	The mp3-duration package
	`mp3-duration-asd`:	The mp3-duration-asd package
	`mp3-duration.asd`:	The mp3-duration/mp3-duration․asd file
	`mp3-duration.lisp`:	The mp3-duration/src/mp3-duration․lisp file

P
	`Package, mp3-duration`:	The mp3-duration package
	`Package, mp3-duration-asd`:	The mp3-duration-asd package
	`peekable-stream`:	Private structures

S
	`src`:	The mp3-duration/src module
	`Structure, peekable-stream`:	Private structures
	`System, mp3-duration`:	The mp3-duration system

The mp3-duration Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 mp3-duration

3 Modules

3.1 mp3-duration/src

4 Files

4.1 Lisp

4.1.1 mp3-duration/mp3-duration.asd

4.1.2 mp3-duration/src/mp3-duration.lisp

5 Packages

5.1 mp3-duration-asd

5.2 mp3-duration

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

6.2.3 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `mp3-duration`

3.1 `mp3-duration/src`

4.1.1 `mp3-duration/mp3-duration.asd`

4.1.2 `mp3-duration/src/mp3-duration.lisp`

5.1 `mp3-duration-asd`

5.2 `mp3-duration`