NAME

SYNOPSIS

    my $conf=MP3::Archive::Config->new([\%newopts]);
    my $opts=$conf->parseconfig($conf->readconfigfile($file);
    $conf->setopts($opts);
    my $value=$conf->get("conf_var_name");

DESCRIPTION

The config file format is a fragment of perl which sets the configuration variables.

The user configuration file is automatically created the first time new is called. See "new" in METHODS for details.

CONFIGURATION FILES

1 Internal defaults are set.

2 Unless $apprconly is set in "new()", the default config files are loaded:

3 If $sysrc is set in "new()" it is loaded.

4 If $rcenv is set in "new()", and $ENV{$rcenv} is defined and exists, it is loaded.

5 Else, if $rcfile is set in "new()" it is loaded.

If you use mp3lint(1), and want to share the configuration, then either create .mp3archiverc as a symbolic link to .mp3lintrc, with:

~$ ln -sf ~/.mp3lintrc ~/.mp3archiverc

or change .mp3archiverc so it just says:

require "$ENV{HOME}/.mp3lintrc";

which will effectively include .mp3lintrc into .mp3archiverc. For this to work, the last line of .mp3lintrc should be "1;", or at least evaluate to true

FORMATS

Formats are regular expressions (see perlretut(1) and perlre(1)), but with ARTIST, ALBUM, TRACK, TRKNUM and EXT as placeholders for the artist, album, track name (song title), track number and extension respectively.

There are two types of formats.

Variables beginning with $formats_ are lists of permissible formats for parsing a filename, each of which are regular expressions (see perlretut(1) and perlre(1) for details). The formats are references to arrays, which essentially means you can have as many as you want, separated by commas, and they must start and end with [ and ] respectively. The individual formats should be quoted with single quotes (').

Variables beginning with $format_ are single formats that are ordinary strings, not regular expressions, and are used when creating filenames. They don't have [ and ] round them, but still should be quoted with single quotes ('), and there should be only one of them, not a list.

 02 - Dead Can Dance - Aion - Saltarello.wav

CONFIGURATION VARIABLES

$formats_album

This specifies acceptable formats for album tracks.

Default:

"$formats_album= ['TRKNUM - ARTIST - ALBUM - TRACK\.EXT', 'ARTIST - ALBUM - TRKNUM - TRACK\.EXT'];"

See above for details.

$formats_track

This specifies acceptable formats for non-album tracks.

Default:

"$formats_track=['ARTIST - TRACK\.EXT'];"

See above for details.

$formats_album_dir

This specifies how to extract info from the directory of an album track.

Default:

"$formats_album_dir= ['ARTIST - ALBUM$','ARTIST\/ALBUM$'];"

This would match

/Spiritualised - Lazer Guided Melodies/

or

/Spiritualised/Pure Phase/

both at the end of the pathname.

$formats_track_dir

This specifies how to extract info from the directory of a non-album track.

Default:

"$formats_track_dir= ['ARTIST$'];"

This specifies the last portion of the pathname is the artist.

$formats_album_m3u, $formats_track_m3u

Specifies the format of m3u playlist filenames for album and non-album tracks.

Default:

"$formats_album_m3u= ['ARTIST - ALBUM\.EXT'];"

"$formats_track_m3u = ['ARTIST\.EXT'];"

$format_default

How to treat tracks that are not in $paths_album or $paths_track. This can be album, track, or anything else, which means don't test the files at all (eg skip).

Default:

$format_default="skip";

$format_delimiter_album, $format_delimiter_track

These specify the delimiters for album and non-album tracks. This allows extra checks, eg to make sure there are the right number of fields (eg, if the delimiter is `-' and you have a track named Stem - Long Stem, so the file is called

07 - DJ Shadow - Entroducing - Stem - Long Stem.mp3

then the extra dash will cause you problems, but specifying a delimiter will allow mp3lint to determine there are too many fields.

Default:

"$format_delimiter_album= ' - ';"

"$format_delimiter_track= ' - ';"

$paths_album, $paths_track

These are used to determine from its pathname whether a file should be treated as part of an album. They are regular expressions, so the same warnings about quoting apply as to formats. This also means that they are substring matches, so the defaults below match any pathname that contains a component called albums or tracks. Although there is only one path each in the default, they can be lists of multiple paths (or portions of paths) to match.

Default:

"$paths_album=['album'];"

"$paths_track=['track'];"

This means that any pathname containing /albums or /tracks will be treated accordingly (eg /music/groovy-albums/).

$archive_root

$archive_root is currently only used to define the $path_write_* variables (below), but its use may be expanded in the future.

Default:

"$archive_root="$ENV{HOME}/music";"

On any sane unix system, $ENV{HOME} expands to your home directory.

$path_write_album, $path_write_track

$path_write_album and $path_write_track are used to determine the canonical pathname for files, for tools like movemusic(1).

The defaults are defined relative to $archive_root (see above).

Defaults:

"$path_write_album="$archive_root/cut/albums/";" "$path_write_track="$archive_root/tracks/";"

$format_write_album, $format_write_track , $format_write_album_m3u , $format_write_track_m3u, $format_write_album_dir, $format_write_track_dir,

These variables are analogous to the $formats_* variables above, but they are used for constructing filenames rather than parsing them to extract information. They are not regular expressions, they are ordinary strings, and there is only one of each rather than a list (array). The same magic variables ("TRKNUM", "ARTIST", "ALBUM", "TRACK") are used and are replaced with the actual data.

Defaults:

"$format_write_album='TRKNUM - ARTIST - ALBUM - TRACK.EXT';"

"$format_write_track='ARTIST - TRACK.EXT';"

"$format_write_album_m3u='ARTIST - ALBUM.EXT';"

"$format_write_track_m3u='ARTIST.EXT';"

"$format_write_album_dir="/ARTIST/ALBUM/";"

"$format_write_track_dir="/ARTIST/";"

METHODS

ENVIRONMENT

$MP3ARCHIVERC

If set, uses this instead of $HOME/.mp3archiverc

$HOME

Used to find .mp3archiverc

BUGS

I am especially interested in how well the code for filename formats works for other people's filenames.

SEE ALSO

AUTHOR