The cue-parser Reference Manual

Table of Contents

The cue-parser Reference Manual

This is the cue-parser Reference Manual, version 0.5, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:39:24 2018 GMT+0.

1 Introduction

This simple library can help you to parse cue sheet files in simple s-expr tree 
and  get metadata (i.e. performer, title of audio work, indices and so on) from
it.

See http://shamazmazum.github.io/cue-parser/ for documentation

2 Systems

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

2.1 cue-parser

Author

Vasily Postnicov <shamaz.mazum@gmail.com>

License

2-clause BSD

Description

A library for parsing audio CUE files

Version

0.5

Dependencies

• esrap
• flexi-streams

Source

cue-parser.asd (file)

Components

• package.lisp (file)
• parser.lisp (file)
• helper-functions.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 cue-parser.asd

Location

cue-parser.asd

Systems

cue-parser (system)

3.1.2 cue-parser/package.lisp

Parent

cue-parser (system)

Location

package.lisp

Packages

cue-parser

3.1.3 cue-parser/parser.lisp

Dependency

package.lisp (file)

Parent

cue-parser (system)

Location

parser.lisp

Exported Definitions

• *cue-external-format* (special variable)
• parse-cue (function)
• parse-cue-file (function)

Internal Definitions

• not-an-but-allowed (function)
• number-parser (function)
• repeat-n-times (function)
• string-to-keyword (function)

3.1.4 cue-parser/helper-functions.lisp

Dependency

package.lisp (file)

Parent

cue-parser (system)

Location

helper-functions.lisp

Exported Definitions

• find-track (function)
• get-command-arg (function)
• get-command-named-arg (function)
• get-file-name (function)
• get-toplevel (function)
• get-track-by-idx (function)
• get-track-index-sec (function)
• get-tracks (function)

4 Packages

Packages are listed by definition order.

4.1 cue-parser

Source

package.lisp (file)

Nickname

cue

Use List

• flexi-streams
• esrap
• common-lisp

Exported Definitions

• *cue-external-format* (special variable)
• find-track (function)
• get-command-arg (function)
• get-command-named-arg (function)
• get-file-name (function)
• get-toplevel (function)
• get-track-by-idx (function)
• get-track-index-sec (function)
• get-tracks (function)
• parse-cue (function)
• parse-cue-file (function)

Internal Definitions

• not-an-but-allowed (function)
• number-parser (function)
• repeat-n-times (function)
• string-to-keyword (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *cue-external-format*

Default external format for CUE sheet files

Package

cue-parser

Source

parser.lisp (file)

5.1.2 Functions

Function: find-track TREE TEST

Returns the first track in parsed CUE sheet @cl:param(tree) which satisfies the test. Test function receives a track as its only argument.

Package

cue-parser

Source

helper-functions.lisp (file)

Function: get-command-arg TREE COMMAND

Get an argument of the command from CUE sheet block
@cl:param(tree). @cl:param(tree) can be the toplevel block or a track block.

Package

cue-parser

Source

helper-functions.lisp (file)

Function: get-command-named-arg TREE COMMAND ARG-NAME

Get a named argument of the command from CUE sheet block
@cl:param(tree). @cl:param(tree) can be the toplevel block or a track block.

Package

cue-parser

Source

helper-functions.lisp (file)

Function: get-file-name TREE TRACK

Returns a file name where the track @cl:param(track) can be found

Package

cue-parser

Source

helper-functions.lisp (file)

Function: get-toplevel TREE

Get the toplevel block from parsed CUE sheet. Just wrapper around @c(first).

Package

cue-parser

Source

helper-functions.lisp (file)

Function: get-track-by-idx TREE IDX

Return a track from parsed CUE sheet @cl:param(tree) by its index @cl:param(idx).

Package

cue-parser

Source

helper-functions.lisp (file)

Function: get-track-index-sec TRACK &optional INDEX

Get an index in seconds for a @cl:param(track). @cl:param(index) can be either @c(:PREGAP), @c(:START) or a number.

Package

cue-parser

Source

helper-functions.lisp (file)

Function: get-tracks TREE

Get tracks from parsed CUE sheet. Just wrapper around @c(second).

Package

cue-parser

Source

helper-functions.lisp (file)

Function: parse-cue STREAM

Parse CUE sheet from the @cl:param(stream). Stream must be opened as a character stream. User must detect and set external format by himself

Package

cue-parser

Source

parser.lisp (file)

Function: parse-cue-file NAME &optional EXTERNAL-FORMAT

Parses CUE sheet from file with the name
@cl:param(name). @cl:param(external-format) is used for reading from file.

Package

cue-parser

Source

parser.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: not-an-but-allowed C

Package

cue-parser

Source

parser.lisp (file)

Function: number-parser LIST

Package

cue-parser

Source

parser.lisp (file)

Function: repeat-n-times FORM N

Package

cue-parser

Source

parser.lisp (file)

Function: string-to-keyword LIST

Package

cue-parser

Source

parser.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types