mkplaylist.py Manual

A playlist creator

Author: Marc 'BlackJack' Rintsch
Contact: marc@rintsch.de
Date: 2004-11-08
Version: 0.4
Copyright: This document has been placed in the public domain.

Contents

1   Name

mkplaylist.py -- creates playlists from directory trees.

2   Synopsis

mkplaylist.py [-h|--help|--version]
mkplaylist.py [options] directory [directory ...]

The directories are the ones where the scripts starts to search for media files.

3   Description

The script scans the given directories for media files with known file name extensions and writes the names into a playlist file in M3U format. This very simple format is used or at least understood by the vast majority of media players on different platforms.

Symlinks to directories are not scanned to avoid running into cycles.

3.1   Known File Name Extensions

The script searches for the following file name extensions (case insensitive):

Media file name extensions.
Extension Format
ac3 ATSC A/52
flac Free Lossless Audio Codec
it Impulse Tracker
mod Amiga MOD
mp3 MPEG 2 Layer 3
ogg Ogg Vorbis
s3m Scream Tracker III
wav Wave

4   Requirements

The script requires Python version 2.3 or higher.

5   Commandline Options

--version show program's version number and exit
-h, --help show this help message and exit
-oOUTFILE, --output=OUTFILE
 name of the output file or '-' for stdout (default)
-fOUTPUT_FORMAT, --output-format=OUTPUT_FORMAT
 format of the output (default: m3u)
--shuffle shuffle the playlist before saving it.

6   Examples

Scan the directory /data/music and write all media files into a (sorted) playlist named playlist.m3u:

./mkplaylist.py -o playlist.m3u /data/music

Scan the directories /data/music/Various and /data/Music/Soundtracks and write a shuffled playlist to standard output:

./mkplaylist.py --shuffle /data/music/Various     \
                          /data/music/Soundtracks

7   History

0.2 : 2004-11-08

The playlist is sorted now and can be shuffled with an option (--shuffle). It's possible to give more than one directory name at the command line.

There are many changes under the surface to allow extensions to read meta data from the media files and to support different output formats too. That's the reason for the new --f and --output-format options which are not very useful at the moment because the only allowed value is m3u which happens to be the default anyway.

0.1.1 : 2004-10-23
Fixed a minor(?) packaging problem. The archive content is now in an own subdirectory. Much more standard on Unices. :-)
0.1 : 2004-10-20
Initial release. Creates simple playlists in M3U format.

8   ToDo

9   Bugs

None known yet. If you find some please send me a mail.