wiki:Specs/VCLT

Vorbis Comment Like Text

Vorbis Comment Like Text (short: VCLT) is a playlist format mainly used by the RoarAudio PlayList Daemon? (rpld). It can store a playlist of multiple local and remote files and streams. It contrast to most other playlist formats (like m3u or xspf) it supports storing a large range of meta data.

The file format

The file format is a plain text file. Each line corresponds to a meta date or a separator. Lines are ended by new-line ('\n', 0x0A). All lines including the very last one must be terminated this way. the character carriage return ('\r', 0x0D) is not allowed anywhere within the file. The encoding is UTF-8. Playlist entries are separated by a single line containing only two '='. There must be no empty lines. All lines not an entry separator nor a meta date are invalid. However the reader should ignore empty lines. In case it finds any other invalid line it should ask the user if it should continue importing the data.

Each meta date is a line containing a key followed by '=' and an value, ended by the line terminator (see above). The key is a case insensitive string. Allowed characters for the key are ASCII 0x20 through 0x7D, 0x3D ('=') excluded as well as 0x41 through 0x5A inclusive. See the VorbisComment? specification for details. The value may contain all characters in Unicode space but the ASCII values 0x00 through 0x1F inclusive, exclusive 0x09 (tab). The later limitation is done to avoid problems with reading applications considering those characters control characters.

Possible keys

All keys as specified in the official VorbisComment? specification are valid. User defined keys are also considered valid as long as they do not conflict with the official key names as published in the VorbisComment? specification nor any other keys defined in this document. To avoid this it is recommended to use "X-application-key" format with application being the name of the application an key the name of the key (e.g. "X-SuperPlayer?-Visualization-Source=aduio track").

The following keys are specific to this playlist format and may be used in other contexts (for example Tantalos) as well.

Key Description Format Example
STREAMURL URL of a stream (non-seekable) for this resource. This is the normal case for webradio. URL http://radio.localnet:8000/stream.ogg
FILENAME Filename of the resource Filename (OS depending, '/' is preferred as directory separator) /home/someuser/music/bla.ogg
FILEURL URL to the resource URL http://localhost/~someuser/music/bla.ogg
LENGTH Playback time of the source [HH:]MM:SS[.ss[m[nnn]] 00:04:32.33
HASH Checksum or identifier for resource {TYPE}value (value in common format for TYPE. Hex format generally preferred over Base64 if both is common) {SHA1}da39a3ee5e6b4b0d3255bfef95601890afd80709, {UUID}e278173d-4d6d-4c66-95ec-4ec85eedc7d1
SIGNALINFO, AUDIOINFO Information about the signal represented by this resource See Specs/SignalInfoFormat rate:44100Hz bits:16 channels:2 codec:flac
OFFSET Offset of data (track) within given resource Not yet defined -/-

Notes

This specification should be aligned with the VorbisComment? specification as published by the Xiph Foundation. Any conflict is unintentional.

Last modified 5 years ago Last modified on 09/19/12 14:43:40