The ernestine Reference Manual

Child Components

lib (module).
src (module).

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

3 Modules

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

ernestine/lib
ernestine/src
ernestine/src/backend
ernestine/src/tools

Next: ernestine/src, Previous: Modules, Up: Modules [Contents][Index]

3.1 `ernestine/lib`

Source: ernestine.asd.
Parent Component: ernestine (system).
Child Component: covers.lisp (file).

Next: ernestine/src/backend, Previous: ernestine/lib, Up: Modules [Contents][Index]

3.2 `ernestine/src`

Dependency

lib (module).

Source

Parent Component

ernestine (system).

Child Components

backend (module).
tools (module).

Next: ernestine/src/tools, Previous: ernestine/src, Up: Modules [Contents][Index]

3.3 `ernestine/src/backend`

Source

Parent Component

src (module).

Child Components

package.lisp (file).
specials.lisp (file).
errors.lisp (file).
obj.lisp (file).
api.lisp (file).
prevalence.lisp (file).
common.lisp (file).

Previous: ernestine/src/backend, Up: Modules [Contents][Index]

3.4 `ernestine/src/tools`

Dependency

backend (module).

Source

Parent Component

src (module).

Child Components

package.lisp (file).
specials.lisp (file).
music.lisp (file).
io.lisp (file).
misc.lisp (file).

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

4.1.1 `ernestine/ernestine.asd`

Source: ernestine.asd.
Parent Component: ernestine (system).
ASDF Systems: ernestine.

Next: ernestine/src/backend/package.lisp, Previous: ernestine/ernestine.asd, Up: Lisp [Contents][Index]

4.1.2 `ernestine/lib/covers.lisp`

Source

Parent Component

lib (module).

Packages

cl-covers.

Public Interface

search-album-covers (function).

Internals

+cover-search+ (constant).
+ws-amazon+ (constant).

Next: ernestine/src/backend/specials.lisp, Previous: ernestine/lib/covers.lisp, Up: Lisp [Contents][Index]

4.1.3 `ernestine/src/backend/package.lisp`

Source: ernestine.asd.
Parent Component: backend (module).
Packages: ernestine-database.

Next: ernestine/src/backend/errors.lisp, Previous: ernestine/src/backend/package.lisp, Up: Lisp [Contents][Index]

4.1.4 `ernestine/src/backend/specials.lisp`

Dependency: package.lisp (file).
Source: ernestine.asd.
Parent Component: backend (module).
Public Interface: *print-ernestine-database* (special variable).

Next: ernestine/src/backend/obj.lisp, Previous: ernestine/src/backend/specials.lisp, Up: Lisp [Contents][Index]

4.1.5 `ernestine/src/backend/errors.lisp`

Dependency

package.lisp (file).

Source

Parent Component

backend (module).

Public Interface

album-name (reader method).
album-name (reader method).
artist-name (reader method).
artist-name (reader method).
existing-album-error (condition).
existing-artist-error (condition).
existing-song-error (condition).
unknown-album-error (condition).
unknown-artist-error (condition).
unknown-backend-error (condition).
unknown-song-error (condition).

Internals

album-error (condition).
artist-error (condition).
backend-type (reader method).
ernestine-error (condition).
song-error (condition).
song-name (reader method).

Next: ernestine/src/backend/api.lisp, Previous: ernestine/src/backend/errors.lisp, Up: Lisp [Contents][Index]

4.1.6 `ernestine/src/backend/obj.lisp`

Dependency

specials.lisp (file).

Source

Parent Component

backend (module).

Public Interface

album (class).
album-artist (reader method).
(setf album-artist) (writer method).
album-cover (reader method).
(setf album-cover) (writer method).
album-date (reader method).
(setf album-date) (writer method).
album-name (reader method).
(setf album-name) (writer method).
album-style (reader method).
(setf album-style) (writer method).
artist (class).
artist-name (reader method).
(setf artist-name) (writer method).
print-object (method).
print-object (method).
print-object (method).
song (class).
song-album (reader method).
(setf song-album) (writer method).
song-artist (reader method).
(setf song-artist) (writer method).
song-filename (reader method).
(setf song-filename) (writer method).
song-rank (reader method).
(setf song-rank) (writer method).
song-time (reader method).
(setf song-time) (writer method).
song-title (reader method).
(setf song-title) (writer method).

Internals

album-songs (reader method).
(setf album-songs) (writer method).
artist-albums (reader method).
(setf artist-albums) (writer method).

Next: ernestine/src/backend/prevalence.lisp, Previous: ernestine/src/backend/obj.lisp, Up: Lisp [Contents][Index]

4.1.7 `ernestine/src/backend/api.lisp`

Dependency

specials.lisp (file).

Source

Parent Component

backend (module).

Public Interface

backend (class).
delete-album (generic function).
delete-artist (generic function).
delete-song (generic function).
do-albums (macro).
do-artists (macro).
do-songs (macro).
get-album-song (generic function).
get-album-song-by-rank (generic function).
get-album-songs (generic function).
get-artist (generic function).
get-artist-album (generic function).
get-artist-albums (generic function).
get-artists (generic function).
get-genre (generic function).
get-music-by-genre (generic function).
make-album (generic function).
make-artist (generic function).
make-song (generic function).
print-database (generic function).

Next: ernestine/src/backend/common.lisp, Previous: ernestine/src/backend/api.lisp, Up: Lisp [Contents][Index]

4.1.8 `ernestine/src/backend/prevalence.lisp`

Dependencies

api.lisp (file).
obj.lisp (file).
errors.lisp (file).

Source

Parent Component

backend (module).

Public Interface

delete-album (method).
delete-artist (method).
delete-song (method).
get-album-song (method).
get-album-song-by-rank (method).
get-album-songs (method).
get-artist (method).
get-artist-album (method).
get-artist-albums (method).
get-artists (method).
make-album (method).
make-artist (method).
make-prevalence-backend (function).
make-song (method).
prevalence (class).
(setf prevalence-system) (writer method).
prevalence-system (reader method).

Internals

database (class).
database-artists (reader method).
(setf database-artists) (writer method).
get-database (function).
init-music-system (function).
prevalence-directory (reader method).
(setf prevalence-directory) (writer method).
tx-create-album (function).
tx-create-artist (function).
tx-create-music (function).
tx-create-song (function).
tx-delete-album (function).
tx-delete-artist (function).
tx-delete-song (function).
with-album (macro).
with-artist (macro).
with-song (macro).

Next: ernestine/src/tools/package.lisp, Previous: ernestine/src/backend/prevalence.lisp, Up: Lisp [Contents][Index]

4.1.9 `ernestine/src/backend/common.lisp`

Dependency

prevalence.lisp (file).

Source

Parent Component

backend (module).

Public Interface

get-backend (function).
with-backend (macro).

Next: ernestine/src/tools/specials.lisp, Previous: ernestine/src/backend/common.lisp, Up: Lisp [Contents][Index]

4.1.10 `ernestine/src/tools/package.lisp`

Source: ernestine.asd.
Parent Component: tools (module).
Packages: ernestine-tools.

Next: ernestine/src/tools/music.lisp, Previous: ernestine/src/tools/package.lisp, Up: Lisp [Contents][Index]

4.1.11 `ernestine/src/tools/specials.lisp`

Dependency

package.lisp (file).

Source

Parent Component

tools (module).

Public Interface

*player-command* (special variable).
*volume-command* (special variable).
+player-args+ (constant).
+volume-args+ (constant).

Internals

*file-info* (special variable).
*id3-v1-genres* (special variable).
*mp3-info* (special variable).
*mp3-info-args* (special variable).
*no-id3-v1* (special variable).
*ogg-info* (special variable).

Next: ernestine/src/tools/io.lisp, Previous: ernestine/src/tools/specials.lisp, Up: Lisp [Contents][Index]

4.1.12 `ernestine/src/tools/music.lisp`

Dependency

specials.lisp (file).

Source

Parent Component

tools (module).

Internals

copy-tag-infos (function).
extract-info (function).
extract-mp3-tag (function).
extract-ogg-tag (function).
make-tag-infos (function).
property-key-value (function).
read-property (function).
run-shell-command (function).
tag-infos (structure).
tag-infos-album (reader).
(setf tag-infos-album) (writer).
tag-infos-artist (reader).
(setf tag-infos-artist) (writer).
tag-infos-date (reader).
(setf tag-infos-date) (writer).
tag-infos-genre (reader).
(setf tag-infos-genre) (writer).
tag-infos-p (function).
tag-infos-title (reader).
(setf tag-infos-title) (writer).
tag-infos-track (reader).
(setf tag-infos-track) (writer).
with-program-result (macro).

Next: ernestine/src/tools/misc.lisp, Previous: ernestine/src/tools/music.lisp, Up: Lisp [Contents][Index]

4.1.13 `ernestine/src/tools/io.lisp`

Dependency

music.lisp (file).

Source

Parent Component

tools (module).

Public Interface

scan-directory (function).

Internals

*image-types* (special variable).
*music-types* (special variable).
directory-p (function).
extract-data (function).
extract-files (function).
get-file-extension (function).
list-directory (function).

Previous: ernestine/src/tools/io.lisp, Up: Lisp [Contents][Index]

4.1.14 `ernestine/src/tools/misc.lisp`

Dependency

specials.lisp (file).

Source

Parent Component

tools (module).

Public Interface

check-installation (function).
get-ernestine-directory (function).

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

5 Packages

Packages are listed by definition order.

cl-covers
ernestine-database
ernestine-tools

Next: ernestine-database, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-covers`

Source

covers.lisp.

Use List

common-lisp.

Public Interface

search-album-covers (function).

Internals

+cover-search+ (constant).
+ws-amazon+ (constant).

Next: ernestine-tools, Previous: cl-covers, Up: Packages [Contents][Index]

5.2 `ernestine-database`

Prevalence backend of ernestine

Source

package.lisp.

Use List

cl-prevalence.
common-lisp.

Used By List

ernestine-tools.

Public Interface

*print-ernestine-database* (special variable).
album (class).
album (slot).
album-artist (generic reader).
(setf album-artist) (generic writer).
album-cover (generic reader).
(setf album-cover) (generic writer).
album-date (generic reader).
(setf album-date) (generic writer).
album-name (generic reader).
(setf album-name) (generic writer).
album-style (generic reader).
(setf album-style) (generic writer).
artist (class).
artist (slot).
artist-name (generic reader).
(setf artist-name) (generic writer).
backend (class).
delete-album (generic function).
delete-artist (generic function).
delete-song (generic function).
do-albums (macro).
do-artists (macro).
do-songs (macro).
existing-album-error (condition).
existing-artist-error (condition).
existing-song-error (condition).
get-album-song (generic function).
get-album-song-by-rank (generic function).
get-album-songs (generic function).
get-artist (generic function).
get-artist-album (generic function).
get-artist-albums (generic function).
get-artists (generic function).
get-backend (function).
get-genre (generic function).
get-music-by-genre (generic function).
make-album (generic function).
make-artist (generic function).
make-prevalence-backend (function).
make-song (generic function).
prevalence (class).
print-database (generic function).
song (class).
song-album (generic reader).
(setf song-album) (generic writer).
song-artist (generic reader).
(setf song-artist) (generic writer).
song-filename (generic reader).
(setf song-filename) (generic writer).
song-rank (generic reader).
(setf song-rank) (generic writer).
song-time (generic reader).
(setf song-time) (generic writer).
song-title (generic reader).
(setf song-title) (generic writer).
unknown-album-error (condition).
unknown-artist-error (condition).
unknown-backend-error (condition).
unknown-song-error (condition).
with-backend (macro).

Internals

album-error (condition).
album-songs (generic reader).
(setf album-songs) (generic writer).
artist-albums (generic reader).
(setf artist-albums) (generic writer).
artist-error (condition).
backend-type (generic reader).
database (class).
database-artists (generic reader).
(setf database-artists) (generic writer).
ernestine-error (condition).
get-database (function).
init-music-system (function).
prevalence-directory (generic reader).
(setf prevalence-directory) (generic writer).
song-error (condition).
song-name (generic reader).
tx-create-album (function).
tx-create-artist (function).
tx-create-music (function).
tx-create-song (function).
tx-delete-album (function).
tx-delete-artist (function).
tx-delete-song (function).
with-album (macro).
with-artist (macro).
with-song (macro).

Previous: ernestine-database, Up: Packages [Contents][Index]

5.3 `ernestine-tools`

Some tools using by Ernestine.

Source

package.lisp.

Use List

common-lisp.
ernestine-database.

Public Interface

*player-command* (special variable).
*volume-command* (special variable).
+player-args+ (constant).
+volume-args+ (constant).
check-installation (function).
get-ernestine-directory (function).
scan-directory (function).

Internals

*file-info* (special variable).
*id3-v1-genres* (special variable).
*image-types* (special variable).
*mp3-info* (special variable).
*mp3-info-args* (special variable).
*music-types* (special variable).
*no-id3-v1* (special variable).
*ogg-info* (special variable).
copy-tag-infos (function).
directory-p (function).
extract-data (function).
extract-files (function).
extract-info (function).
extract-mp3-tag (function).
extract-ogg-tag (function).
get-file-extension (function).
list-directory (function).
make-tag-infos (function).
property-key-value (function).
read-property (function).
run-shell-command (function).
tag-infos (structure).
tag-infos-album (reader).
(setf tag-infos-album) (writer).
tag-infos-artist (reader).
(setf tag-infos-artist) (writer).
tag-infos-date (reader).
(setf tag-infos-date) (writer).
tag-infos-genre (reader).
(setf tag-infos-genre) (writer).
tag-infos-p (function).
tag-infos-title (reader).
(setf tag-infos-title) (writer).
tag-infos-track (reader).
(setf tag-infos-track) (writer).
with-program-result (macro).

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

Constants
Special variables
Macros
Ordinary functions
Generic functions
Standalone methods
Conditions
Classes

Next: Special variables, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Constants

Constant: +player-args+ ¶

Package: ernestine-tools.
Source: specials.lisp.

Constant: +volume-args+ ¶

Package: ernestine-tools.
Source: specials.lisp.

Next: Macros, Previous: Constants, Up: Public Interface [Contents][Index]

6.1.2 Special variables

Special Variable: *player-command* ¶

The Swiss army knife of sound processing program.

Package: ernestine-tools.
Source: specials.lisp.

Special Variable: *print-ernestine-database* ¶

If T, modify the printed representation of Ernestine database objects.

Package: ernestine-database.
Source: specials.lisp.

Special Variable: *volume-command* ¶

The mixer control program.

Package: ernestine-tools.
Source: specials.lisp.

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

6.1.3 Macros

Macro: do-albums ((album) backend artist-name &body body) ¶

Retrieve artist named ARTIST-NAME and iterates over his albums extract from the BACKEND’s database.

Package: ernestine-database.
Source: api.lisp.

Macro: do-artists ((artist) backend &body body) ¶

Iterates over the artists of the BACKEND’s database.

Package: ernestine-database.
Source: api.lisp.

Macro: do-songs ((song) backend artist-name album-name &body body) ¶

Retrieve artist’s album named ARTIST-NAME and ALBUM-NAME, and iterates over the album’s songs extract from BACKEND’s database.

Package: ernestine-database.
Source: api.lisp.

Macro: with-backend ((backend type directory) &body body) ¶

Macro which defined a new BACKEND and executes BODY.

Package: ernestine-database.
Source: common.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

6.1.4 Ordinary functions

Function: check-installation () ¶

Check installation for Ernestine.

Package: ernestine-tools.
Source: misc.lisp.

Function: get-backend (type &optional directory) ¶

Get a backend from TYPE.
Throws an UNKNOWN-BACKEND-ERROR is backend type TYPE is unknown

Package: ernestine-database.
Source: common.lisp.

Function: get-ernestine-directory () ¶

Get the home directory of Ernestine.

Package: ernestine-tools.
Source: misc.lisp.

Function: make-prevalence-backend (directory) ¶

Create the prevalence system backend, and initialize the prevalence system. DIRECTORY will contain the log transaction’s file of cl-prevalence. Throws a sb-int:simple-file-error if DIRECTORY is unknown.

Package: ernestine-database.
Source: prevalence.lisp.

Function: scan-directory (backend directory &key stream type covers-p) ¶

Create music database. DIRECTORY contains music file. We use *mp3-info* and *ogg-info* to extract informations of music files.

Package: ernestine-tools.
Source: io.lisp.

Function: search-album-covers (artist-name &optional album-name) ¶

Package: cl-covers.
Source: covers.lisp.

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

6.1.5 Generic functions

Generic Reader: album-artist (object) ¶

Generic Writer: (setf album-artist) (object) ¶

Package

Methods

Reader Method: album-artist ((album album)) ¶

Writer Method: (setf album-artist) ((album album)) ¶

Name of the artist to which this album belongs

Source: obj.lisp.
Target Slot: artist.

Generic Reader: album-cover (object) ¶

Generic Writer: (setf album-cover) (object) ¶

Package

Methods

Reader Method: album-cover ((album album)) ¶

Writer Method: (setf album-cover) ((album album)) ¶

An URI to retrieve cover art.

Source: obj.lisp.
Target Slot: cover.

Generic Reader: album-date (object) ¶

Generic Writer: (setf album-date) (object) ¶

Package

Methods

Reader Method: album-date ((album album)) ¶

Writer Method: (setf album-date) ((album album)) ¶

Vendor date

Source: obj.lisp.
Target Slot: date.

Generic Reader: album-name (condition) ¶

Generic Writer: (setf album-name) (object) ¶

Package

Methods

Reader Method: album-name ((album album)) ¶

Writer Method: (setf album-name) ((album album)) ¶

Album name

Source: obj.lisp.
Target Slot: name.

Reader Method: album-name ((condition song-error)) ¶

Source: errors.lisp.
Target Slot: album-name.

Reader Method: album-name ((condition album-error)) ¶

Source: errors.lisp.
Target Slot: album-name.

Generic Reader: album-style (object) ¶

Generic Writer: (setf album-style) (object) ¶

Package

Methods

Reader Method: album-style ((album album)) ¶

Writer Method: (setf album-style) ((album album)) ¶

Album music style

Source: obj.lisp.
Target Slot: style.

Generic Reader: artist-name (condition) ¶

Generic Writer: (setf artist-name) (object) ¶

Package

Methods

Reader Method: artist-name ((artist artist)) ¶

Writer Method: (setf artist-name) ((artist artist)) ¶

Music artist

Source: obj.lisp.
Target Slot: name.

Reader Method: artist-name ((condition album-error)) ¶

Source: errors.lisp.
Target Slot: artist-name.

Reader Method: artist-name ((condition artist-error)) ¶

Source: errors.lisp.
Target Slot: artist-name.

Generic Function: delete-album (backend artist-name album-name) ¶

Delete the album identified by ALBUM-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown.

Package

Source

Methods

Method: delete-album ((prevalence prevalence) artist-name album-name) ¶

Source: prevalence.lisp.

Generic Function: delete-artist (backend artist-name) ¶

Delete the artist identified by ARTIST-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown.

Package

Source

Methods

Method: delete-artist ((prevalence prevalence) artist-name) ¶

Source: prevalence.lisp.

Generic Function: delete-song (backend artist-name album-name song-title) ¶

Delete the song identified by SONG-TITLE in the
album ALBUM-NAME of artist ARTIST-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown. Throws an UNKNOWN-SONG-ERROR if SONG-TITLE is unknown.

Package

Source

Methods

Method: delete-song ((prevalence prevalence) artist-name album-name song-title) ¶

Source: prevalence.lisp.

Generic Function: get-album-song (backend artist-name album-name song-title) ¶

Retrieve the song named SONG-TITLE in album ALBUM-NAME of artist ARTIST-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown. Throws an UNKNOWN-SONG-ERROR if SONG-TITLE is unknown.

Package

Source

Methods

Method: get-album-song ((prevalence prevalence) artist-name album-name song-title) ¶

Source: prevalence.lisp.

Generic Function: get-album-song-by-rank (backend artist-name album-name rank) ¶

Retrieve the song in position RANK in album ALBUM-NAME of artist ARTIST-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown. Throws an UNKNOWN-SONG-ERROR if SONG-TITLE is already.

Package

Source

Methods

Method: get-album-song-by-rank ((prevalence prevalence) artist-name album-name rank) ¶

Source: prevalence.lisp.

Generic Function: get-album-songs (backend artist-name album-name) ¶

Retrieve the songs of album named ALBUM-NAME owned by artist ARTIST-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown.

Package

Source

Methods

Method: get-album-songs ((prevalence prevalence) artist-name album-name) ¶

Source: prevalence.lisp.

Generic Function: get-artist (backend artist-name) ¶

Retrieve the artist identified by ARTIST-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown.

Package

Source

Methods

Method: get-artist ((prevalence prevalence) artist-name) ¶

Source: prevalence.lisp.

Generic Function: get-artist-album (backend artist-name album-name) ¶

Retrieve the album named ALBUM-NAME, owned by artist ARTIST-NAME.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown.

Package

Source

Methods

Method: get-artist-album ((prevalence prevalence) artist-name album-name) ¶

Source: prevalence.lisp.

Generic Function: get-artist-albums (backend artist-name) ¶

Retrieve the albums of artist named ARTIST-NAME. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown.

Package

Source

Methods

Method: get-artist-albums ((prevalence prevalence) artist-name) ¶

Source: prevalence.lisp.

Generic Function: get-artists (backend) ¶

Retrieve an hashtable which contains artists. artists’s names are the keys of the hashtable.

Package

Source

Methods

Method: get-artists ((prevalence prevalence)) ¶

Source: prevalence.lisp.

Generic Function: get-genre (backend) ¶

Retrieve a list of music genres from all albums.

Package

Source

Methods

Method: get-genre ((backend backend)) ¶

Generic Function: get-music-by-genre (backend genres) ¶

Retrieve all songs with a music genre. GENRES is a list a different music genre.

Package

Source

Methods

Method: get-music-by-genre ((backend backend) genres) ¶

Generic Function: make-album (backend artist-name album-name style date cover songs) ¶

Create a music album named ALBUM-NAME for the artiste
identified by ARTIST-NAME. STYLE represents in which category the album is classified, DATE is the vendor date and SONGS an hashtable of album’s songs. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown.
Throws an EXISTING-ALBUM-ERROR if ALBUM-NAME is already.

Package

Source

Methods

Method: make-album ((prevalence prevalence) artist-name album-name style date cover songs) ¶

Source: prevalence.lisp.

Generic Function: make-artist (backend artist-name albums) ¶

Create a music artist named ARTIST-NAME. ALBUMS is
an hashtable which contains albums of the artist.
Throws an EXISTING-ARTIST-ERROR if NAME is already in database.

Package

Source

Methods

Method: make-artist ((prevalence prevalence) artist-name albums) ¶

Source: prevalence.lisp.

Generic Function: make-song (backend artist-name album-name song-title rank time filename) ¶

Create a song named SONG-TITLE in the album identified by ALBUM-NAME.
RANK is the song’s position in the album, and TIME the elapsed time. FILENAME is the pathname of the song.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown.
Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown.
Throws an EXISTING-SONG-ERROR if SONG-TITLE is already.

Package

Source

Methods

Method: make-song ((prevalence prevalence) artist-name album-name song-title rank time filename) ¶

Source: prevalence.lisp.

Generic Function: print-database (backend &key stream artistp albump songp) ¶

Print to the stream the database. If ARTISTP, print the artists’ names. If ALBUMP, print the albums’ names. If SONGP, print the songs’ names.

Package

Source

Methods

Method: print-database ((backend backend) &key stream artistp albump songp) ¶

Generic Reader: song-album (object) ¶

Generic Writer: (setf song-album) (object) ¶

Package

Methods

Reader Method: song-album ((song song)) ¶

Writer Method: (setf song-album) ((song song)) ¶

Album name to which this song belongs

Source: obj.lisp.
Target Slot: album.

Generic Reader: song-artist (object) ¶

Generic Writer: (setf song-artist) (object) ¶

Package

Methods

Reader Method: song-artist ((song song)) ¶

Writer Method: (setf song-artist) ((song song)) ¶

Name of the artist.

Source: obj.lisp.
Target Slot: artist.

Generic Reader: song-filename (object) ¶

Generic Writer: (setf song-filename) (object) ¶

Package

Methods

Reader Method: song-filename ((song song)) ¶

Writer Method: (setf song-filename) ((song song)) ¶

Filename of the song.

Source: obj.lisp.
Target Slot: filename.

Generic Reader: song-rank (object) ¶

Generic Writer: (setf song-rank) (object) ¶

Package

Methods

Reader Method: song-rank ((song song)) ¶

Writer Method: (setf song-rank) ((song song)) ¶

Rank of this song in the album

Source: obj.lisp.
Target Slot: rank.

Generic Reader: song-time (object) ¶

Generic Writer: (setf song-time) (object) ¶

Package

Methods

Reader Method: song-time ((song song)) ¶

Writer Method: (setf song-time) ((song song)) ¶

Elapsed time of this song

Source: obj.lisp.
Target Slot: time.

Generic Reader: song-title (object) ¶

Generic Writer: (setf song-title) (object) ¶

Package

Methods

Reader Method: song-title ((song song)) ¶

Writer Method: (setf song-title) ((song song)) ¶

Song name

Source: obj.lisp.
Target Slot: title.

Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]

6.1.6 Standalone methods

Writer Method: (setf prevalence-system) ((prevalence prevalence)) ¶

System prevalence

Package: cl-prevalence.
Source: prevalence.lisp.
Target Slot: system.

Reader Method: prevalence-system ((prevalence prevalence)) ¶

System prevalence

Package: cl-prevalence.
Source: prevalence.lisp.
Target Slot: system.

Method: print-object ((album album) stream) ¶

Source: obj.lisp.

Method: print-object ((artist artist) stream) ¶

Source: obj.lisp.

Method: print-object ((song song) stream) ¶

Source: obj.lisp.

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

6.1.7 Conditions

Condition: existing-album-error ¶

An existing album error

Package: ernestine-database.
Source: errors.lisp.
Direct superclasses: album-error.

Condition: existing-artist-error ¶

An existing artist error

Package: ernestine-database.
Source: errors.lisp.
Direct superclasses: artist-error.

Condition: existing-song-error ¶

An existing song error

Package: ernestine-database.
Source: errors.lisp.
Direct superclasses: song-error.

Condition: unknown-album-error ¶

An unknown album error

Package: ernestine-database.
Source: errors.lisp.
Direct superclasses: album-error.

Condition: unknown-artist-error ¶

An unknown artist error

Package: ernestine-database.
Source: errors.lisp.
Direct superclasses: artist-error.

Condition: unknown-backend-error ¶

Unknown backend error

Package

Source

Direct superclasses

Direct methods

backend-type.

Direct slots

Slot: backend-type ¶

Initargs: :backend-type
Readers: backend-type.
Writers: This slot is read-only.

Condition: unknown-song-error ¶

An unknown song error

Package: ernestine-database.
Source: errors.lisp.
Direct superclasses: song-error.

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

6.1.8 Classes

Class: album ¶

Music album

Package

Source

obj.lisp.

Direct methods

(setf album-artist).
album-artist.
(setf album-cover).
album-cover.
(setf album-date).
album-date.
(setf album-name).
album-name.
(setf album-songs).
album-songs.
(setf album-style).
album-style.
print-object.

Direct slots

Slot: name ¶

Album name

Package: cl-prevalence.
Initform: ""
Initargs: :name
Readers: album-name.
Writers: (setf album-name).

Slot: artist ¶

Name of the artist to which this album belongs

Initform: ""
Initargs: :artist
Readers: album-artist.
Writers: (setf album-artist).

Slot: style ¶

Album music style

Initform: ""
Initargs: :style
Readers: album-style.
Writers: (setf album-style).

Slot: date ¶

Vendor date

Initform: ""
Initargs: :date
Readers: album-date.
Writers: (setf album-date).

Slot: cover ¶

An URI to retrieve cover art.

Initform: ""
Initargs: :cover
Readers: album-cover.
Writers: (setf album-cover).

Slot: songs ¶

Hashtable of songs of this album

Initform: (make-hash-table :test (function equal))
Initargs: :songs
Readers: album-songs.
Writers: (setf album-songs).

Class: artist ¶

Music artist

Package

Source

obj.lisp.

Direct methods

(setf artist-albums).
artist-albums.
(setf artist-name).
artist-name.
print-object.

Direct slots

Slot: name ¶

Music artist

Package: cl-prevalence.
Initform: ""
Initargs: :name
Readers: artist-name.
Writers: (setf artist-name).

Slot: albums ¶

Hashtable which contains albums of this artist

Initform: (make-hash-table :test (function equal))
Initargs: :albums
Readers: artist-albums.
Writers: (setf artist-albums).

Class: backend ¶

All backend herites this class

Package

Source

Direct subclasses

prevalence.

Direct methods

get-genre.
get-music-by-genre.
print-database.

Class: prevalence ¶

Database backend which use the cl-prevalence tool

Package

Source

prevalence.lisp.

Direct superclasses

backend.

Direct methods

delete-album.
delete-artist.
delete-song.
get-album-song.
get-album-song-by-rank.
get-album-songs.
get-artist.
get-artist-album.
get-artist-albums.
get-artists.
make-album.
make-artist.
make-song.
(setf prevalence-directory).
prevalence-directory.
(setf prevalence-system).
prevalence-system.

Direct slots

Slot: system ¶

System prevalence

Initargs: :system
Readers: prevalence-system.
Writers: (setf prevalence-system).

Slot: directory ¶

Directory name of the log transaction’s file of cl-prevalence

Package: common-lisp.
Initargs: :directory
Readers: prevalence-directory.
Writers: (setf prevalence-directory).

Class: song ¶

Song of an album

Package

Source

obj.lisp.

Direct methods

print-object.
(setf song-album).
song-album.
(setf song-artist).
song-artist.
(setf song-filename).
song-filename.
(setf song-rank).
song-rank.
(setf song-time).
song-time.
(setf song-title).
song-title.

Direct slots

Slot: title ¶

Song name

Initform: ""
Initargs: :title
Readers: song-title.
Writers: (setf song-title).

Slot: album ¶

Album name to which this song belongs

Initform: ""
Initargs: :album
Readers: song-album.
Writers: (setf song-album).

Slot: artist ¶

Name of the artist.

Initform: ""
Initargs: :artist
Readers: song-artist.
Writers: (setf song-artist).

Slot: rank ¶

Rank of this song in the album

Initform: ""
Initargs: :rank
Readers: song-rank.
Writers: (setf song-rank).

Slot: time ¶

Elapsed time of this song

Package: common-lisp.
Initform: ""
Initargs: :time
Readers: song-time.
Writers: (setf song-time).

Slot: filename ¶

Filename of the song.

Initform: (error "song must have a pathname")
Initargs: :filename
Readers: song-filename.
Writers: (setf song-filename).

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

6.2 Internals

Constants
Special variables
Macros
Ordinary functions
Generic functions
Conditions
Structures
Classes

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

6.2.1 Constants

Constant: +cover-search+ ¶

Package: cl-covers.
Source: covers.lisp.

Constant: +ws-amazon+ ¶

Package: cl-covers.
Source: covers.lisp.

Next: Macros, Previous: Constants, Up: Internals [Contents][Index]

6.2.2 Special variables

Special Variable: *file-info* ¶

Determine file type

Package: ernestine-tools.
Source: specials.lisp.

Special Variable: *id3-v1-genres* ¶

Package: ernestine-tools.
Source: specials.lisp.

Special Variable: *image-types* ¶

Available format of images

Package: ernestine-tools.
Source: io.lisp.

Special Variable: *mp3-info* ¶

Command to extract id3tag informations from MP3 files

Package: ernestine-tools.
Source: specials.lisp.

Special Variable: *mp3-info-args* ¶

Package: ernestine-tools.
Source: specials.lisp.

Special Variable: *music-types* ¶

Available format of music

Package: ernestine-tools.
Source: io.lisp.

Special Variable: *no-id3-v1* ¶

Package: ernestine-tools.
Source: specials.lisp.

Special Variable: *ogg-info* ¶

Command to extract informations from Ogg Vorbis files

Package: ernestine-tools.
Source: specials.lisp.

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

6.2.3 Macros

Macro: with-album ((album prevalence artist-name album-name) &body body) ¶

Macro which find ALBUM by his name ALBUM-NAME and executes BODY. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown from database.

Package: ernestine-database.
Source: prevalence.lisp.

Macro: with-artist ((artist prevalence artist-name) &body body) ¶

Macro which find ARTIST by his name ARTIST-NAME and executes BODY. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database.

Package: ernestine-database.
Source: prevalence.lisp.

Macro: with-program-result ((result command args) &body body) ¶

Macros which executes COMMAND with ARGS, and set the ouput in string RESULT.

Package: ernestine-tools.
Source: music.lisp.

Macro: with-song ((song prevalence artist-name album-name song-title) &body body) ¶

Macro which find SONG by his name SONG-NAME and executes BODY. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown from database. Throws an UNKNOWN-SONG-ERROR if SONG-NAME is unknown from database.

Package: ernestine-database.
Source: prevalence.lisp.

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

6.2.4 Ordinary functions

Function: copy-tag-infos (instance) ¶

Package: ernestine-tools.
Source: music.lisp.

Function: directory-p (token) ¶

Returns TRUE if TOKEN is a directory.

Package: ernestine-tools.
Source: io.lisp.

Function: extract-data (directory) ¶

Extract directories name from directory

Package: ernestine-tools.
Source: io.lisp.

Function: extract-files (directory) ¶

Extract entries from a DIRECTORY

Package: ernestine-tools.
Source: io.lisp.

Function: extract-info (filename &optional stream) ¶

Executes the file command on FILENAME to extract MP3 tags. Return a list which contains song caracteristics : ’(rank title artist album genre year)

Package: ernestine-tools.
Source: music.lisp.

Function: extract-mp3-tag (filename) ¶

Extract tag informations from result of *mp3-info* command, and creates a TAG-INFOS structure.

Package: ernestine-tools.
Source: music.lisp.

Function: extract-ogg-tag (filename) ¶

Executes the *ogg-info* command on FILENAME to extract OGG VORBIS tags. Creates a TAG-INFOS structure.

Package: ernestine-tools.
Source: music.lisp.

Function: get-database (system) ¶

Retreive music database from system

Package: ernestine-database.
Source: prevalence.lisp.

Function: get-file-extension (file) ¶

Returns the extension of FILE

Package: ernestine-tools.
Source: io.lisp.

Function: init-music-system (system) ¶

Initialization of the database system

Package: ernestine-database.
Source: prevalence.lisp.

Function: list-directory (dir) ¶

List content of DIR

Package: ernestine-tools.
Source: io.lisp.

Function: make-tag-infos (&key title artist album date track genre) ¶

Package: ernestine-tools.
Source: music.lisp.

Function: property-key-value (property key) ¶

Extract value of KEY in PROPERTY.

Package: ernestine-tools.
Source: music.lisp.

Function: read-property (string &optional separator) ¶

Read STRING which is sequence of key=value. Creates a cons like (key . value).

Package: ernestine-tools.
Source: music.lisp.

Function: run-shell-command (command args &key output) ¶

Package: ernestine-tools.
Source: music.lisp.

Reader: tag-infos-album (instance) ¶

Writer: (setf tag-infos-album) (instance) ¶

Package: ernestine-tools.
Source: music.lisp.
Target Slot: album.

Reader: tag-infos-artist (instance) ¶

Writer: (setf tag-infos-artist) (instance) ¶

Package: ernestine-tools.
Source: music.lisp.
Target Slot: artist.

Reader: tag-infos-date (instance) ¶

Writer: (setf tag-infos-date) (instance) ¶

Package: ernestine-tools.
Source: music.lisp.
Target Slot: date.

Reader: tag-infos-genre (instance) ¶

Writer: (setf tag-infos-genre) (instance) ¶

Package: ernestine-tools.
Source: music.lisp.
Target Slot: genre.

Function: tag-infos-p (object) ¶

Package: ernestine-tools.
Source: music.lisp.

Reader: tag-infos-title (instance) ¶

Writer: (setf tag-infos-title) (instance) ¶

Package: ernestine-tools.
Source: music.lisp.
Target Slot: title.

Reader: tag-infos-track (instance) ¶

Writer: (setf tag-infos-track) (instance) ¶

Package: ernestine-tools.
Source: music.lisp.
Target Slot: track.

Function: tx-create-album (system artist-name album-name style date cover songs) ¶

Transaction for creating an album for this artist identified by ARTIST-NAME. Updates the database system and return the album object.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database. Throws an EXISTING-ALBUM-ERROR if ALBUM-NAME is already in database.

Package: ernestine-database.
Source: prevalence.lisp.

Function: tx-create-artist (system artist-name albums) ¶

Transaction for creating a music artist named ARTIST-NAME, which have ALBUMS. Updates the database system and return the artist object.
Throws an EXISTING-ARTIST-ERROR if NAME is already in database.

Package: ernestine-database.
Source: prevalence.lisp.

Function: tx-create-music (system) ¶

Create the music database

Package: ernestine-database.
Source: prevalence.lisp.

Function: tx-create-song (system artist-name album-name song-title rank time filename) ¶

Transaction for creating a song for this album identified by ALBUM-NAME. Updates the database system and return the song object.
Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown from database Throws an EXISTING-SONG-ERROR if SONG-TITLE is already in database.

Package: ernestine-database.
Source: prevalence.lisp.

Function: tx-delete-album (system artist-name album-name) ¶

Transaction for deleting the album identified by ALBUM-NAME from the database. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown from database.

Package: ernestine-database.
Source: prevalence.lisp.

Function: tx-delete-artist (system artist-name) ¶

Transaction for deleting the artist identified by ARTIST-NAME from the database. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database.

Package: ernestine-database.
Source: prevalence.lisp.

Function: tx-delete-song (system artist-name album-name song-title) ¶

Transaction for deleting the song identified by SONG-TITLE from the database. Throws an UNKNOWN-ARTIST-ERROR if ARTIST-NAME is unknown from database. Throws an UNKNOWN-ALBUM-ERROR if ALBUM-NAME is unknown from database. Throws an UNKNOWN-SONG-ERROR if SONG-TITLE is unknown from database.

Package: ernestine-database.
Source: prevalence.lisp.

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

6.2.5 Generic functions

Generic Reader: album-songs (object) ¶

Generic Writer: (setf album-songs) (object) ¶

Package

Methods

Reader Method: album-songs ((album album)) ¶

Writer Method: (setf album-songs) ((album album)) ¶

Hashtable of songs of this album

Source: obj.lisp.
Target Slot: songs.

Generic Reader: artist-albums (object) ¶

Generic Writer: (setf artist-albums) (object) ¶

Package

Methods

Reader Method: artist-albums ((artist artist)) ¶

Writer Method: (setf artist-albums) ((artist artist)) ¶

Hashtable which contains albums of this artist

Source: obj.lisp.
Target Slot: albums.

Generic Reader: backend-type (condition) ¶

Package

Methods

Reader Method: backend-type ((condition unknown-backend-error)) ¶

Source: errors.lisp.
Target Slot: backend-type.

Generic Reader: database-artists (object) ¶

Generic Writer: (setf database-artists) (object) ¶

Package

Methods

Reader Method: database-artists ((database database)) ¶

Writer Method: (setf database-artists) ((database database)) ¶

Hashtable of music artists

Source: prevalence.lisp.
Target Slot: artists.

Generic Reader: prevalence-directory (object) ¶

Generic Writer: (setf prevalence-directory) (object) ¶

Package

Methods

Reader Method: prevalence-directory ((prevalence prevalence)) ¶

Writer Method: (setf prevalence-directory) ((prevalence prevalence)) ¶

Directory name of the log transaction’s file of cl-prevalence

Source: prevalence.lisp.
Target Slot: directory.

Generic Reader: song-name (condition) ¶

Package

Methods

Reader Method: song-name ((condition song-error)) ¶

Source: errors.lisp.
Target Slot: song-name.

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

6.2.6 Conditions

Condition: album-error ¶

Package

Source

Direct superclasses

Direct subclasses

existing-album-error.
unknown-album-error.

Direct methods

album-name.
artist-name.

Direct slots

Slot: album-name ¶

Initargs: :album-name
Readers: album-name.
Writers: This slot is read-only.

Slot: artist-name ¶

Initargs: :artist-name
Readers: artist-name.
Writers: This slot is read-only.

Condition: artist-error ¶

Package

Source

Direct superclasses

Direct subclasses

existing-artist-error.
unknown-artist-error.

Direct methods

artist-name.

Direct slots

Slot: artist-name ¶

Initargs: :artist-name
Readers: artist-name.
Writers: This slot is read-only.

Condition: ernestine-error ¶

Main music error

Package

Source

Direct superclasses

simple-error.

Direct subclasses

album-error.
artist-error.
song-error.
unknown-backend-error.

Condition: song-error ¶

Package

Source

Direct superclasses

Direct subclasses

existing-song-error.
unknown-song-error.

Direct methods

album-name.
song-name.

Direct slots

Slot: song-name ¶

Initargs: :song-name
Readers: song-name.
Writers: This slot is read-only.

Slot: album-name ¶

Initargs: :album-name
Readers: album-name.
Writers: This slot is read-only.

Next: Classes, Previous: Conditions, Up: Internals [Contents][Index]

6.2.7 Structures

Structure: tag-infos ¶

Package

ernestine-tools.

Source

music.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: title ¶

Readers: tag-infos-title.
Writers: (setf tag-infos-title).

Slot: artist ¶

Package: ernestine-database.
Readers: tag-infos-artist.
Writers: (setf tag-infos-artist).

Slot: album ¶

Package: ernestine-database.
Readers: tag-infos-album.
Writers: (setf tag-infos-album).

Slot: date ¶

Readers: tag-infos-date.
Writers: (setf tag-infos-date).

Slot: track ¶

Readers: tag-infos-track.
Writers: (setf tag-infos-track).

Slot: genre ¶

Readers: tag-infos-genre.
Writers: (setf tag-infos-genre).

Previous: Structures, Up: Internals [Contents][Index]

6.2.8 Classes

Class: database ¶

Music Database

Package