The flac-metadata Reference Manual

Table of Contents

The flac-metadata Reference Manual

This is the flac-metadata Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:04:40 2021 GMT+0.

1 Introduction

flac-metadata

A utility for reading metadata embedded in FLAC audio files.

Overview

This utility was created as an alternative to flac-parser. They both do the same thing, but flac-metadata is faster, more concise, and I decided to abandon flac-parser.

Install

(ql:quickload :flac-metadata)

Usage

You can read metadata from a FLAC audio file in one of two ways.

The following will return an object, representing the concrete syntax tree of the FLAC specification. With it, you can access the metadata you wish:

(load-file #p"/path/to/file.flac") ; => #<FLAC-METADATA::FLAC {100490C5F3}>

Alternatively, you may dump out the metadata pretty-printed:

(dump-file #p"/path/to/file.flac")

#|

File                                    /path/to/file.flac
  Marker                                fLaC
  Metadata Blocks
    Stream Information                  34 bytes
      Minimum block size                4,096 bytes
      Maximum block size                4,096 bytes
      Minimum frame size                14 bytes
      Maximum frame size                12,297 bytes
      Sample rate                       44,100Hz
      Channels                          1
      Bit depth                         16 bits per sample
      Total samples                     5,157,936
      MD5 checksum                      A2331F9298112C0E2121A371898B08D4
    Seek Table                          216 bytes
      Seek Point
        Target sample                   0
        Offset                          0
        Sample count                    4,096
      Seek Point
        Target sample                   438,272
        Offset                          1,068,557
        Sample count                    4,096
      Seek Point
        Target sample                   880,640
        Offset                          2,185,151
        Sample count                    4,096
      Seek Point
        Target sample                   1,318,912
        Offset                          3,327,723
        Sample count                    4,096
      Seek Point
        Target sample                   1,761,280
        Offset                          4,511,460
        Sample count                    4,096
      Seek Point
        Target sample                   2,203,648
        Offset                          5,723,533
        Sample count                    4,096
      Seek Point
        Target sample                   2,641,920
        Offset                          6,845,851
        Sample count                    4,096
      Seek Point
        Target sample                   3,084,288
        Offset                          7,985,828
        Sample count                    4,096
      Seek Point
        Target sample                   3,526,656
        Offset                          9,136,439
        Sample count                    4,096
      Seek Point
        Target sample                   3,964,928
        Offset                          10,295,520
        Sample count                    4,096
      Seek Point
        Target sample                   4,407,296
        Offset                          11,529,075
        Sample count                    4,096
      Seek Point
        Target sample                   4,849,664
        Offset                          12,563,214
        Sample count                    4,096
    Vorbis Comment                      1,405 bytes
      Vendor                            reference libFLAC 1.3.1 20141125
      Comments count                    53
        ACOUSTID_FINGERPRINT            <empty>
        ACOUSTID_ID                     <empty>
        ALBUM                           Breath of Fire Original Soundtrack Special Box
        ALBUM ARTIST                    Various Artists
        ALBUMARTIST                     Various Artists
        ALBUMARTISTSORT                 Various Artists
        ALBUMARTIST_CREDIT              Various Artists
        ARTIST                          Yuko Takehara
        ARTISTSORT                      Yuko Takehara
        ARTIST_CREDIT                   Yuko Takehara
        ASIN                            <empty>
        BPM                             0
        CATALOGNUMBER                   CPCA-10146
        COMPILATION                     1
        COMPOSER                        <empty>
        DATE                            2006
        DISC                            3
        DISCC                           11
        DISCNUMBER                      3
        DISCSUBTITLE                    <empty>
        DISCTOTAL                       11
        ENCODEDBY                       <empty>
        ENCODER                         <empty>
        GENRE                           Electronic
        GROUPING                        <empty>
        LABEL                           Suleputer
        LANGUAGE                        eng
        LYRICS                          <empty>
        MEDIA                           CD
        MUSICBRAINZ_ALBUMARTISTID       89ad4ac3-39f7-470e-963a-56509c546377
        MUSICBRAINZ_ALBUMCOMMENT        <empty>
        MUSICBRAINZ_ALBUMID             46ac4441-e568-4a37-8fc2-22368b3a6dd9
        MUSICBRAINZ_ALBUMSTATUS         Pseudo-Release
        MUSICBRAINZ_ALBUMTYPE           soundtrack
        MUSICBRAINZ_ARTISTID            7a463c32-b9b3-4143-8c4c-96590473dad0
        MUSICBRAINZ_RELEASEGROUPID      4085f1c7-f74a-4c7d-bd4a-cc148b65d115
        MUSICBRAINZ_TRACKID             f9eea541-873f-422b-b28e-385f069cdff7
        ORIGINALDATE                    2006-03-31
        PUBLISHER                       Suleputer
        RELEASECOUNTRY                  JP
        REPLAYGAIN_ALBUM_GAIN           -6.12 dB
        REPLAYGAIN_ALBUM_PEAK           1.000031
        REPLAYGAIN_TRACK_GAIN           -7.21 dB
        REPLAYGAIN_TRACK_PEAK           0.858699
        SCRIPT                          Latn
        TITLE                           We're Rangers
        TOTALDISCS                      11
        TOTALTRACKS                     23
        TRACK                           9
        TRACKC                          23
        TRACKNUMBER                     9
        TRACKTOTAL                      23
        YEAR                            2006
    Picture                             58243
        Type                            0
        MIME type                       image/jpeg
        Description
        Width                           0px
        Height                          0px
        Color depth                     0bpp
        Indexed colors                  0
        Size                            58,201
  Frames                                <not implemented>

|#

License

Copyright © 2017-2020 [Michael Fiano] mail@mfiano.net.

Licensed under the MIT License.

2 Systems

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

2.1 flac-metadata

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://git.mfiano.net/mfiano/flac-metadata

License

MIT

Description

A utility for reading metadata embedded in FLAC audio files.

Dependencies

• golden-utils
• parsley

Source

flac-metadata.asd (file)

Components

• package.lisp (file)
• flac.lisp (file)
• datastream.lisp (file)
• metadata.lisp (file)
• metadata-types.lisp (file)
• dump-data.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 flac-metadata.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/flac-metadata-20210411-git/flac-metadata.asd

Systems

flac-metadata (system)

3.1.2 flac-metadata/package.lisp

Parent

flac-metadata (system)

Location

package.lisp

Packages

flac-metadata

3.1.3 flac-metadata/flac.lisp

Dependency

package.lisp (file)

Parent

flac-metadata (system)

Location

flac.lisp

Exported Definitions

• load-file (function)
• parse-tree (method)
• (setf parse-tree) (method)

Internal Definitions

• %load-stream (function)
• *flac* (special variable)
• file-path (method)
• (setf file-path) (method)
• flac (class)

3.1.4 flac-metadata/datastream.lisp

Dependency

flac.lisp (file)

Parent

flac-metadata (system)

Location

datastream.lisp

Internal Definitions

• datastream (class)
• frames (method)
• marker (method)
• metadata-blocks (method)
• parse-datastream (function)
• parse-frames (function)
• parse-marker (function)
• parse-metadata-blocks (function)
• stream-info (method)

3.1.5 flac-metadata/metadata.lisp

Dependency

datastream.lisp (file)

Parent

flac-metadata (system)

Location

metadata.lisp

Internal Definitions

• %metadata-size (method)
• %metadata-type (method)
• *metadata-block* (special variable)
• data (method)
• header (method)
• last-flag (method)
• last-metadata-p (function)
• metadata-block (class)
• metadata-block-header (class)
• metadata-size (function)
• metadata-type (function)
• parse-metadata-block (function)

3.1.6 flac-metadata/metadata-types.lisp

Dependency

metadata.lisp (file)

Parent

flac-metadata (system)

Location

metadata-types.lisp

Internal Definitions

• cuesheet-track (class)
• cuesheet-track-index (class)
• define-metadata (macro)
• metadata-application (class)
• metadata-cuesheet (class)
• metadata-invalid (class)
• metadata-padding (class)
• metadata-picture (class)
• metadata-reserved (class)
• metadata-seektable (class)
• metadata-streaminfo (class)
• metadata-vorbis-comment (class)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• seek-point (class)

3.1.7 flac-metadata/dump-data.lisp

Dependency

metadata-types.lisp (file)

Parent

flac-metadata (system)

Location

dump-data.lisp

Exported Definitions

dump-file (function)

Internal Definitions

• *dump-padding* (special variable)
• *dump-spec* (special variable)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• print-line (function)

4 Packages

Packages are listed by definition order.

4.1 flac-metadata

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• dump-file (function)
• load-file (function)
• parse-tree (generic function)
• parse-tree (method)
• (setf parse-tree) (method)
• (setf parse-tree) (generic function)

Internal Definitions

• %load-stream (function)
• %metadata-size (generic function)
• %metadata-size (method)
• %metadata-type (generic function)
• %metadata-type (method)
• *dump-padding* (special variable)
• *dump-spec* (special variable)
• *flac* (special variable)
• *metadata-block* (special variable)
• cuesheet-track (class)
• cuesheet-track-index (class)
• data (generic function)
• data (method)
• datastream (class)
• define-metadata (macro)
• dump (generic function)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• dump (method)
• file-path (generic function)
• file-path (method)
• (setf file-path) (method)
• (setf file-path) (generic function)
• flac (class)
• frames (generic function)
• frames (method)
• header (generic function)
• header (method)
• last-flag (generic function)
• last-flag (method)
• last-metadata-p (function)
• marker (generic function)
• marker (method)
• metadata-application (class)
• metadata-block (class)
• metadata-block-header (class)
• metadata-blocks (generic function)
• metadata-blocks (method)
• metadata-cuesheet (class)
• metadata-invalid (class)
• metadata-padding (class)
• metadata-picture (class)
• metadata-reserved (class)
• metadata-seektable (class)
• metadata-size (function)
• metadata-streaminfo (class)
• metadata-type (function)
• metadata-vorbis-comment (class)
• parse-datastream (function)
• parse-frames (function)
• parse-marker (function)
• parse-metadata (generic function)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata (method)
• parse-metadata-block (function)
• parse-metadata-blocks (function)
• print-line (function)
• seek-point (class)
• stream-info (generic function)
• stream-info (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: dump-file FILE &rest SPEC

Print out the FLAC metadata of FILE. SPEC may be one or more of the following to control which types of metadata are dumped, or NIL for all types:

:STREAMINFO, :APPLICATION, :SEEKTABLE, :VORBIS-COMMENT, :CUESHEET, :PICTURE.

Package

flac-metadata

Source

dump-data.lisp (file)

Function: load-file PATH

Load the FLAC file located at the given filesystem PATH. Returns an object with the concrete syntax tree of the FLAC specification.

Package

flac-metadata

Source

flac.lisp (file)

5.1.2 Generic functions

Generic Function: parse-tree OBJECT

Generic Function: (setf parse-tree) NEW-VALUE OBJECT

Package

flac-metadata

Methods

Method: parse-tree (FLAC flac)

automatically generated reader method

Source

flac.lisp (file)

Method: (setf parse-tree) NEW-VALUE (FLAC flac)

automatically generated writer method

Source

flac.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *dump-padding*

Package

flac-metadata

Source

dump-data.lisp (file)

Special Variable: *dump-spec*

Package

flac-metadata

Source

dump-data.lisp (file)

Special Variable: *flac*

Package

flac-metadata

Source

flac.lisp (file)

Special Variable: *metadata-block*

Package

flac-metadata

Source

metadata.lisp (file)

5.2.2 Macros

Macro: define-metadata (TYPE) (&rest SLOTS) &body BODY

Package

flac-metadata

Source

metadata-types.lisp (file)

5.2.3 Functions

Function: %load-stream STREAM &optional PATH

Package

flac-metadata

Source

flac.lisp (file)

Function: last-metadata-p METADATA-BLOCK

Package

flac-metadata

Source

metadata.lisp (file)

Function: metadata-size ()

Package

flac-metadata

Source

metadata.lisp (file)

Function: metadata-type ()

Package

flac-metadata

Source

metadata.lisp (file)

Function: parse-datastream ()

Package

flac-metadata

Source

datastream.lisp (file)

Function: parse-frames ()

Package

flac-metadata

Source

datastream.lisp (file)

Function: parse-marker ()

Package

flac-metadata

Source

datastream.lisp (file)

Function: parse-metadata-block ()

Package

flac-metadata

Source

metadata.lisp (file)

Function: parse-metadata-blocks ()

Package

flac-metadata

Source

datastream.lisp (file)

Function: print-line LEVEL LABEL &optional VALUE

Package

flac-metadata

Source

dump-data.lisp (file)

5.2.4 Generic functions

Generic Function: %metadata-size OBJECT

Package

flac-metadata

Methods

Method: %metadata-size (METADATA-BLOCK-HEADER metadata-block-header)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: %metadata-type OBJECT

Package

flac-metadata

Methods

Method: %metadata-type (METADATA-BLOCK-HEADER metadata-block-header)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: data OBJECT

Package

flac-metadata

Methods

Method: data (METADATA-BLOCK metadata-block)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: dump TYPE NODE LEVEL

Package

flac-metadata

Methods

Method: dump (TYPE (eql picture)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql cuesheet)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql vorbis-comment)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql seektable)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql application)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql padding)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql streaminfo)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql datastream)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump (TYPE (eql file)) NODE LEVEL

Source

dump-data.lisp (file)

Method: dump TYPE NODE LEVEL around

Source

dump-data.lisp (file)

Generic Function: file-path OBJECT

Generic Function: (setf file-path) NEW-VALUE OBJECT

Package

flac-metadata

Methods

Method: file-path (FLAC flac)

automatically generated reader method

Source

flac.lisp (file)

Method: (setf file-path) NEW-VALUE (FLAC flac)

automatically generated writer method

Source

flac.lisp (file)

Generic Function: frames OBJECT

Package

flac-metadata

Methods

Method: frames (DATASTREAM datastream)

automatically generated reader method

Source

datastream.lisp (file)

Generic Function: header OBJECT

Package

flac-metadata

Methods

Method: header (METADATA-BLOCK metadata-block)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: last-flag OBJECT

Package

flac-metadata

Methods

Method: last-flag (METADATA-BLOCK-HEADER metadata-block-header)

automatically generated reader method

Source

metadata.lisp (file)

Generic Function: marker OBJECT

Package

flac-metadata

Methods

Method: marker (DATASTREAM datastream)

automatically generated reader method

Source

datastream.lisp (file)

Generic Function: metadata-blocks OBJECT

Package

flac-metadata

Methods

Method: metadata-blocks (DATASTREAM datastream)

automatically generated reader method

Source

datastream.lisp (file)

Generic Function: parse-metadata TYPE-SYMBOL0

Package

flac-metadata

Methods

Method: parse-metadata (TYPE-SYMBOL0 (eql invalid))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql reserved))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql picture))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql cuesheet))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql vorbis-comment))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql seektable))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql application))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql padding))

Source

metadata-types.lisp (file)

Method: parse-metadata (TYPE-SYMBOL0 (eql streaminfo))

Source

metadata-types.lisp (file)

Generic Function: stream-info OBJECT

Package

flac-metadata

Methods

Method: stream-info (DATASTREAM datastream)

automatically generated reader method

Source

datastream.lisp (file)

5.2.5 Classes

Class: cuesheet-track ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: %offset

Initargs

:offset

Slot: %number

Initargs

:number

Slot: %isrc

Initargs

:isrc

Slot: %type

Initargs

:type

Slot: %pre-emphasis-flag

Initargs

:pre-emphasis-flag

Slot: %index-count

Initargs

:index-count

Slot: %indices

Initargs

:indices

Class: cuesheet-track-index ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: %offset

Initargs

:offset

Slot: %number

Initargs

:number

Class: datastream ()

Package

flac-metadata

Source

datastream.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• frames (method)
• metadata-blocks (method)
• stream-info (method)
• marker (method)

Direct slots

Slot: %marker

Readers

marker (generic function)

Slot: %stream-info

Readers

stream-info (generic function)

Slot: %metadata-blocks

Readers

metadata-blocks (generic function)

Slot: %frames

Readers

frames (generic function)

Class: flac ()

Package

flac-metadata

Source

flac.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• parse-tree (method)
• parse-tree (method)
• file-path (method)
• file-path (method)

Direct slots

Slot: %file-path

Readers

file-path (generic function)

Writers

(setf file-path) (generic function)

Slot: %parse-tree

Readers

parse-tree (generic function)

Writers

(setf parse-tree) (generic function)

Class: metadata-application ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: id

Slot: data

Class: metadata-block ()

Package

flac-metadata

Source

metadata.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• data (method)
• header (method)

Direct slots

Slot: %header

Initform

(make-instance (quote flac-metadata::metadata-block-header))

Readers

header (generic function)

Slot: %data

Readers

data (generic function)

Class: metadata-block-header ()

Package

flac-metadata

Source

metadata.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• %metadata-size (method)
• %metadata-type (method)
• last-flag (method)

Direct slots

Slot: %last-flag

Readers

last-flag (generic function)

Slot: %type

Readers

%metadata-type (generic function)

Slot: %length

Readers

%metadata-size (generic function)

Class: metadata-cuesheet ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: media-catalog-id

Slot: lead-in-sample-count

Slot: cd-flag

Slot: track-count

Slot: tracks

Class: metadata-invalid ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Class: metadata-padding ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Class: metadata-picture ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: type

Slot: mime-type-length

Slot: mime-type

Slot: description-length

Slot: description

Slot: width

Slot: height

Slot: bits-per-pixel

Slot: indexed-color-count

Slot: size

Slot: data

Class: metadata-reserved ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Class: metadata-seektable ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: seek-points

Class: metadata-streaminfo ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: minimum-block-size

Slot: maximum-block-size

Slot: minimum-frame-size

Slot: maximum-frame-size

Slot: sample-rate

Slot: channel-count

Slot: bits-per-sample

Slot: sample-count

Slot: md5

Class: metadata-vorbis-comment ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: vendor-length

Slot: vendor

Slot: user-comments-count

Slot: user-comments

Class: seek-point ()

Package

flac-metadata

Source

metadata-types.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: %sample

Initargs

:sample

Slot: %offset

Initargs

:offset

Slot: %sample-count

Initargs

:sample-count

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types