mp3renamer

by Garry A Offord ([email protected])
http://rubyforge.org/projects/mp3renamer/

== DESCRIPTION:

This program takes an MP3 audiobook and renames the subdirs and files using a consistent naming convention.
It also updates the ID3v1 and ID3v2 tags for artist, album, track number, track title, genre, and year.

NOTES

(1) The following source directory structure is assumed for this program:

<artist>
|
`--- <album> <==== this is the SOURCE-DIRECTORY command line parameter.
|
+--- <disc 1>
| |
| +--- <disc 1 track 1>.mp3
| +--- <disc 1 track 2>.mp3
| | ...
| `--- <disc 1 track N1>.mp3
|
+--- <disc 2>
| |
| +--- <disc 2 track 1>.mp3
| +--- <disc 2 track 2>.mp3
| | ...
| `--- <disc 2 track N1>.mp3
|
| ...
|
`--- <disc M>
|
+--- <disc M track 1>.mp3
+--- <disc M track 2>.mp3
| ...
`--- <disc M track NM>.mp3


(2) The following output directory structure will be created:

<output-directory> <==== this is value of the --output command line parameter.
|
`--- <artist>
|
`--- <album>
|
+--- <album> [D01.MM]
| |
| +--- D01.MM-T01.N1.mp3
| +--- D01.MM-T02.N1.mp3
| | ...
| `--- D01.MM-TN1.N1.mp3
|
+--- <album> [D02.MM]
| |
| +--- D02.MM-T01.N2.mp3
| +--- D02.MM-T02.N2.mp3
| | ...
| `--- D02.MM-TN2.N2.mp3
|
| ...
|
`--- <album> [DMM.MM]
|
+--- DMM.MM-T01.NN.mp3
+--- DMM.MM-T02.NN.mp3
| ...
`--- DMM.MM-TNN.NN.mp3



== FEATURES/PROBLEMS:

* Renames folders and files using a consistent naming convention.
* Sets the ID3v1 and ID3v2 tags for artist, album, track number, track title, genre, and year.
* Note that although the individual album folders are renamed to have the disc number as
a part of album name, the album name set in the ID3 tags do not include the disc number.

== SYNOPSIS:

Usage:
mp3renamer.rb [options] SOURCE-DIRECTORY

Options

-o, --output DIRECTORY Directory into which the renamed files will be written.
Default is: C:/DOCUME~1/ec2yvgm/LOCALS~1/Temp/renamed_mp3_files

-a, --artist ARTIST-NAME Name of the album's artist.
Default is: base name of the PARENT directory

-t, --title ALBUM-TITLE Title of the album.
Default is: base name of the CURRENT directory

-y, --year RELEASE-YEAR Year of the album's release.
Default is: 2009

-c, --[no-]copy-files Copy files from source directory into output directory.
Default is: true

-1, --[no-]update-id3v1-tags Update ID3v1 tags for artist, album, track number, track title, genre, and year.
Default is: true

-2, --[no-]update-id3v2-tags Update ID3v2 tags for artist, album, track number, track title, genre, and year.
Default is: true

-h, --help This help info.

== REQUIREMENTS:

* bones (>= 2.4.0)
* cooloptions (>= 1.1.1)
* ruby-mp3info (>= 0.6.12)

== INSTALL:

* gem install mp3renamer

== LICENSE:

(The MIT License)

Copyright (c) 2009 Garry A Offord

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.