mp3renamer 0.0.1

data/.svnignore

@@ -0,0 +1,4 @@
+#======================================================================
+# $Id: .svnignore 2 2009-03-05 22:19:20Z gofford $
+#======================================================================
+pkg

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-02-23
+
+* 1 major enhancement
+  * Birthday!

data/README.txt

@@ -0,0 +1,48 @@
+mp3renamer
+    by FIXME (your name)
+    FIXME (url)
+
+== DESCRIPTION:
+
+FIXME (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIXME (list of features or problems)
+
+== SYNOPSIS:
+
+  FIXME (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIXME (list of requirements)
+
+== INSTALL:
+
+* FIXME (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME (different license?)
+
+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.

data/Rakefile

@@ -0,0 +1,30 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'mp3renamer'
+
+task :default => 'spec:run'
+
+PROJ.name = 'mp3renamer'
+PROJ.authors = 'FIXME (who is writing this software)'
+PROJ.email = 'FIXME (your e-mail)'
+PROJ.url = 'FIXME (project homepage)'
+PROJ.version = Mp3renamer::VERSION
+PROJ.rubyforge.name = 'mp3renamer'
+
+PROJ.spec.opts << '--color'
+
+# EOF

data/bin/mp3renamer.rb

@@ -0,0 +1,174 @@
+#!C:\ruby\bin\ruby.exe
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib mp3renamer]))
+require 'rubygems'
+require 'cooloptions'
+require 'mp3info'
+require 'pp'
+
+$:.unshift(File.join(File.dirname($0), 'lib'))
+$:.unshift(File.join(File.dirname($0), '..', 'lib'))
+$:.unshift("./lib/")
+
+require 'mp3/album'
+require 'mp3/disc'
+require 'mp3/renamer'
+require 'mp3/track'
+
+#
+# constants
+#
+CURRENT_DIR = 'base name of the CURRENT directory'
+PARENT_DIR  = 'base name of the PARENT directory'
+
+#
+# globals
+#
+temp_dir = File::expand_path(ENV['TEMP'] || File::SEPARATOR)
+puts "Temporary directory is \"#{temp_dir}\"" if $DEBUG
+
+source_dir = Dir::pwd
+puts "Source directory is \"#{source_dir}\"" if $DEBUG
+
+target_dir = File.join(temp_dir, 'renamed_mp3_files')
+puts "Target directory is \"#{target_dir}\"" if $DEBUG
+
+album_artist = PARENT_DIR
+album_title  = CURRENT_DIR
+album_year   = Time::new.year.to_s
+puts "Current Year     is \"#{album_year}\"" if $DEBUG
+
+puts ''
+
+options = CoolOptions.parse!('[options] SOURCE-DIRECTORY') do |cooloptions|
+
+    cooloptions.desc ' '
+    cooloptions.desc 'This program takes an MP3 audiobook and renames the subdirs and files using a consistent naming convention.'
+    cooloptions.desc 'It also updates the ID3v1 and ID3v2 tags for artist, album, track number, track title, genre, and year.'
+    cooloptions.desc ' '
+
+    cooloptions.desc ' '
+    cooloptions.desc 'NOTES'
+    cooloptions.desc ' '
+    cooloptions.desc '(1) The following source directory structure is assumed for this program:'
+    cooloptions.desc ' '
+    cooloptions.desc '      <artist>'
+    cooloptions.desc '          |'
+    cooloptions.desc '          `--- <album>                   <==== this is the SOURCE-DIRECTORY command line parameter.'
+    cooloptions.desc '                  |'
+    cooloptions.desc '                  +--- <disc 1>'
+    cooloptions.desc '                  |       |'
+    cooloptions.desc '                  |       +--- <disc 1 track 1>.mp3'
+    cooloptions.desc '                  |       +--- <disc 1 track 2>.mp3'
+    cooloptions.desc '                  |       |           ...'
+    cooloptions.desc '                  |       `--- <disc 1 track N1>.mp3'
+    cooloptions.desc '                  |'
+    cooloptions.desc '                  +--- <disc 2>'
+    cooloptions.desc '                  |       |'
+    cooloptions.desc '                  |       +--- <disc 2 track 1>.mp3'
+    cooloptions.desc '                  |       +--- <disc 2 track 2>.mp3'
+    cooloptions.desc '                  |       |           ...'
+    cooloptions.desc '                  |       `--- <disc 2 track N1>.mp3'
+    cooloptions.desc '                  |'
+    cooloptions.desc '                  |      ...'
+    cooloptions.desc '                  |'
+    cooloptions.desc '                  `--- <disc M>'
+    cooloptions.desc '                          |'
+    cooloptions.desc '                          +--- <disc M track 1>.mp3'
+    cooloptions.desc '                          +--- <disc M track 2>.mp3'
+    cooloptions.desc '                          |           ...'
+    cooloptions.desc '                          `--- <disc M track NM>.mp3'
+    cooloptions.desc ' '
+    cooloptions.desc ' '
+    cooloptions.desc '(2) The following output directory structure will be created:'
+    cooloptions.desc ' '
+    cooloptions.desc '      <output-directory>                 <==== this is value of the --output command line parameter.'
+    cooloptions.desc '          |'
+    cooloptions.desc '          `--- <artist>'
+    cooloptions.desc '                  |'
+    cooloptions.desc '                  `--- <album>'
+    cooloptions.desc '                          |'
+    cooloptions.desc '                          +--- <album> [D01.MM]'
+    cooloptions.desc '                          |       |'
+    cooloptions.desc '                          |       +--- D01.MM-T01.N1.mp3'
+    cooloptions.desc '                          |       +--- D01.MM-T02.N1.mp3'
+    cooloptions.desc '                          |       |           ...'
+    cooloptions.desc '                          |       `--- D01.MM-TN1.N1.mp3'
+    cooloptions.desc '                          |'
+    cooloptions.desc '                          +--- <album> [D02.MM]'
+    cooloptions.desc '                          |       |'
+    cooloptions.desc '                          |       +--- D02.MM-T01.N2.mp3'
+    cooloptions.desc '                          |       +--- D02.MM-T02.N2.mp3'
+    cooloptions.desc '                          |       |           ...'
+    cooloptions.desc '                          |       `--- D02.MM-TN2.N2.mp3'
+    cooloptions.desc '                          |'
+    cooloptions.desc '                          |      ...'
+    cooloptions.desc '                          |'
+    cooloptions.desc '                          `--- <album> [DMM.MM]'
+    cooloptions.desc '                                  |'
+    cooloptions.desc '                                  +--- DMM.MM-T01.NN.mp3'
+    cooloptions.desc '                                  +--- DMM.MM-T02.NN.mp3'
+    cooloptions.desc '                                  |           ...'
+    cooloptions.desc '                                  `--- DMM.MM-TNN.NN.mp3'
+    cooloptions.desc ' '
+    cooloptions.desc ' '
+
+    cooloptions.desc ' '
+    cooloptions.desc 'OPTIONS'
+    cooloptions.desc ' '
+
+    cooloptions.on 'output DIRECTORY'  , 'Directory into which the renamed files will be written.', target_dir
+    cooloptions.desc ' '
+
+    cooloptions.on 'artist ARTIST-NAME', 'Name of the album\'s artist.', album_artist
+    cooloptions.desc ' '
+    cooloptions.on 'title ALBUM-TITLE' , 'Title of the album.', album_title
+    cooloptions.desc ' '
+    cooloptions.on 'year RELEASE-YEAR' , 'Year of the album\'s release.', album_year
+    cooloptions.desc ' '
+
+    cooloptions.on 'copy-files'        , 'Copy files from source directory into output directory.', true
+    cooloptions.desc ' '
+    cooloptions.on 'update-id3v(1)-tags', 'Update ID3v1 tags for artist, album, track number, track title, genre, and year.', true
+    cooloptions.desc ' '
+    cooloptions.on 'update-id3v(2)-tags', 'Update ID3v2 tags for artist, album, track number, track title, genre, and year.', true
+
+    cooloptions.after do |result|
+        if result.year !~ /^(\d\d\d\d)$/
+            cooloptions.error("\nERROR: Invalid year: \"#{result.year}\"\n\n")
+        else
+            album_year = result.year
+        end
+
+        target_dir = result.output
+        album_artist = (result.artist != PARENT_DIR)  ? result.artist : nil
+        album_title  = (result.title  != CURRENT_DIR) ? result.title  : nil
+    end
+
+end
+
+if $DEBUG
+    puts "Source directory is \"#{source_dir}\""
+    puts "Target directory is \"#{target_dir}\""
+    puts "Album artist     is \"#{album_artist}\""
+    puts "Album title      is \"#{album_title}\""
+    puts "Album year       is \"#{album_year}\""
+end
+
+if ARGV.size == 0
+    ARGV << '.'
+end
+
+ARGV.each do |src_dir|
+    renamer = Mp3::Renamer.new
+    renamer.album_artist = album_artist if defined? album_artist
+    renamer.album_title  = album_title  if defined? album_title
+    renamer.album_year   = album_year
+
+    renamer.read_album(src_dir)
+    renamer.rename_tracks
+    renamer.write_album(target_dir)
+    renamer.update_id3_tags(target_dir)
+end
+puts ''

data/lib/mp3/album.rb

@@ -0,0 +1,114 @@
+require 'mp3/disc'
+require 'utils/parser'
+
+class Mp3
+
+    #
+    # This class presents an album, consisting of one of more physical media 
+    # (LPs, CDs, tapes), each of which is referred to as a disc. 
+    # 
+    # An instance of this class holds:
+    # * the name of the album's artist;
+    # * the title of the album;
+    # * year of release;
+    # * and an array of Disc instances, each of which describes
+    #   just one of the aforementioned physical media making up the album.
+    #
+    class Album
+
+        attr_accessor :album_artist
+        attr_accessor :album_title
+        attr_accessor :album_year
+        attr_reader   :discs
+        
+        #
+        # The constructor takes a hash of symbols and their corresponding values. Valid symbols are:
+        # * <b>:artist</b> => the name(s) of the artist(s) responsible for the album;
+        # * <b>:title</b>  => the title of the album;
+        # * <b>:year</b>   => the year of release.
+        #
+        # If the <b>:artist</b> and/or <b>:title</b> symbols are not specified, they are derived from the grandparent and parent
+        # directories, respectively.
+        #
+        def initialize(*args)
+            @discs = []
+            parse_args(nil, args)
+        end
+
+        #
+        # This method is used to add a Disc instance to the [current] album instance.
+        # Assumptions
+        # * The order in which discs are appended _is_ the disc play order.
+        #
+        def add(item)
+            if item.class.name == Disc.name
+                @discs << item
+            end
+            self
+        end
+        
+        #
+        # This method is used to rename the album and all of its contained discs to a consistent format.
+        #
+        # Right now:
+        # * the <i>album level</i> album title is left unchanged;
+        # * the <i>disc level</i> album titles are set to "D<i>disc-number</i>.<i>number-of-discs</i>" for all of the
+        #   discs in the album;
+        # * the <i>track level</i> album titles are also set to "D<i>disc-number</i>.<i>number-of-discs</i>" for all of the
+        #   discs in the album;
+        # * the tracks are renamed recursively (see the Track class for details).
+        #
+        def rename
+            $track_number = 0
+            @discs.each do |disc|
+                printf("Renaming disc %02d  : ", disc.disc_number); $stdout.flush
+
+                disc.album_artist = @album_artist    
+                disc.album_title  = @album_title     
+                disc.album_year   = @album_year      
+                disc.rename(discs.size)
+                
+                print "\n"
+            end
+        end
+        
+        def write(dst_dir)
+            here = Dir.pwd
+            Dir.chdir dst_dir
+            @discs.each do |disc|
+                printf("Copying disc %02d   : ", disc.disc_number); $stdout.flush
+                disc.write
+                puts ""
+            end
+            Dir.chdir here
+        end
+        
+        def update_id3_tags(dst_dir)
+            here = Dir.pwd
+            Dir.chdir dst_dir
+            @discs.each do |disc|
+                print "Updating ID3 tags for disc #{disc.disc_number}"; $stdout.flush
+                disc.update_id3_tags
+                puts ""
+            end
+            Dir.chdir here
+        end
+        
+        private
+        
+        include Utils::Parser
+
+        def parse_string(name, value)
+            puts "album: parse_string(\"#{name}\", \"#{value}\")" if $DEBUG
+
+            if    name.to_s == 'artist'; @album_artist = value
+            elsif name.to_s == 'title' ; @album_title  = value
+            elsif name.to_s == 'year'  ; @album_year   = value
+            else
+                puts "Unknown keyword: \"#{name}\""
+            end
+        end
+        
+    end # Album
+    
+end # Mp3

data/lib/mp3/disc.rb

@@ -0,0 +1,96 @@
+require 'mp3/track'
+require 'utils/parser'
+require 'utils/formatter'
+
+class Mp3
+
+    class Disc
+
+        attr_accessor :disc_number
+        attr_accessor :disc_title
+        attr_accessor :album_artist
+        attr_accessor :album_title
+        attr_accessor :album_year
+        attr_reader   :tracks
+        attr_accessor :separator
+        attr_accessor :prefix
+        attr_accessor :suffix
+        
+        def initialize(*args)
+            @disc_title = ''
+            @tracks     = []
+            @separator  = '.'
+            @prefix     = 'D'
+            @suffix     = ''
+            parse_args(nil, args)
+        end
+
+        def add(item)
+            if item.class.name == Track.name
+                @tracks << item
+            end
+            self
+        end
+
+        def rename(number_of_discs)
+        
+            @disc_title = format(@prefix, @separator, @suffix, @disc_number, number_of_discs)
+        
+            tracks.each do |track|
+                track.album_artist = @album_artist    
+                track.album_title  = @album_title     
+                track.album_year   = @album_year      
+                track.rename(@disc_title, tracks.size)
+            end
+            
+        end
+
+        def update_id3_tags
+            disc_subdir = "#{@album_title} [#{@disc_title}]"
+
+            here = Dir.pwd
+            Dir.chdir disc_subdir
+            
+            @tracks.each do |track| 
+                track.update_id3_tags
+            end
+
+            Dir.chdir here
+        end
+
+        def write
+            disc_subdir = "#{@album_title} [#{@disc_title}]"
+            if $DEBUG
+                print "\n\talbum title = #{@album_title}"
+                print "\n\tdisc  title = #{@disc_title}" 
+                print "\n\tdisc subdir = #{disc_subdir}" 
+            end
+            File.makedirs(disc_subdir) 
+            
+            here = Dir.pwd
+            Dir.chdir disc_subdir
+            
+            @tracks.each do |track|
+                track.write
+            end
+
+            Dir.chdir here
+        end
+        
+        private
+        
+        include Utils::Formatter
+        include Utils::Parser
+
+        def parse_string(name, value)
+            puts "album: parse_string(\"#{name}\", \"#{value}\")" if $DEBUG
+
+            if name.to_s == 'number'; @disc_number = value
+            else
+                puts "Unknown keyword: \"#{name}\""
+            end
+        end
+        
+    end # Disc
+    
+end # Mp3

data/lib/mp3/renamer.rb

@@ -0,0 +1,113 @@
+require 'fileutils'
+require 'find'
+require 'ftools'
+
+require 'mp3/disc'
+require 'utils/parser'
+
+class Mp3
+
+    class Renamer
+
+        attr_accessor :album_artist
+        attr_accessor :album_title 
+        attr_accessor :album_year 
+        attr_accessor :album
+    
+        def initialize(*args)
+            @album_artist = nil
+            @album_title  = nil
+            @album_year   = nil
+        end # initialize
+
+        def read_album(src_dir)
+            here = Dir.pwd
+            
+            Dir.chdir src_dir
+            
+            puts "you are here: \"#{Dir.pwd}\"" if $DEBUG
+            
+            @album_artist ||= File.basename(File.expand_path('..'))
+            @album_title  ||= File.basename(File.expand_path('.'))
+            @album_year   ||= '2008'
+            
+            @album = Mp3::Album.new(:artist => @album_artist, :title => @album_title, :year => @album_year)
+            
+            disc_number = 0
+            Dir['*'].sort.each do |e|
+                next if not File.directory?(e)
+                puts "\t#{e}" if $DEBUG
+                disc_number += 1
+                disc = Mp3::Disc::new(:number => disc_number)
+                here2 = Dir.pwd
+                Dir.chdir e
+                track_number = 0
+                Dir['*'].sort.each do |t|
+                    if t =~ /\.((mp3)|(mp4)|(aac))$/
+                        track_number += 1
+                        track = Mp3::Track::new(:number => track_number, :file => t, :path => File.expand_path(t))
+                    end
+                    #puts "\t\t#{t}"
+                    disc.add(track)
+                end
+                Dir.chdir here2
+                @album.add(disc)
+            end
+            Dir.chdir here
+
+            puts "Album artist      : #{@album.album_artist}"
+            puts "Album title       : #{@album.album_title}"
+            puts "Album year        : #{@album.album_year}"
+            puts "Number of disc(s) : #{@album.discs.size}"
+            
+            #pp(album)  if $DEBUG
+        end # read
+        
+        def rename_tracks
+            @album.rename
+        end # read
+        
+        def update_id3_tags(dst_dir)
+            dst_dir = File.join(dst_dir, @album.album_artist, @album.album_title)
+            @album.update_id3_tags(dst_dir)
+        end
+        
+        def write_album(dst_dir)
+            #
+            # (1) create the output directory (if necessary)
+            # (2) create the individual disc subdirs
+            # (3) copy the track files per disc subdir
+            #
+            dst_dir = File.join(dst_dir, @album.album_artist, @album.album_title)
+            if File.exists?(dst_dir)
+                FileUtils.remove_dir(dst_dir, true)
+                puts "Deleted output dir: #{dst_dir}"
+            end
+            puts "Created output dir: #{dst_dir}"
+            File.makedirs(dst_dir) 
+            
+            here = Dir.pwd
+            Dir.chdir dst_dir
+            @album.write(dst_dir)
+            Dir.chdir here
+        end # read
+        
+        private
+        
+        include Utils::Parser
+
+        def parse_string(name, value)
+            puts "Rename: parse_string(\"#{name}\", \"#{value}\")" if $DEBUG
+
+            puts "Unknown keyword: \"#{name}\""
+        end # parse_string
+        
+        def purge_dir_subtree(root)
+            Find.find(root) do |item|
+                puts "found: #{item}"
+            end
+        end
+        
+    end # Renamer
+
+end # Mp3

data/lib/mp3/track.rb

@@ -0,0 +1,101 @@
+require 'mp3info'
+
+require 'utils/parser'
+require 'utils/formatter'
+
+class Mp3
+
+    class Track
+
+        attr_accessor :track_number
+        attr_accessor :track_title
+        attr_accessor :album_artist
+        attr_accessor :album_title
+        attr_accessor :album_year
+        attr_accessor :file
+        attr_accessor :path
+        attr_accessor :separator
+        attr_accessor :prefix
+        attr_accessor :suffix
+        
+        def initialize(*args)
+            @track_title = ''
+            @separator   = '.'
+            @prefix      = 'T'
+            @suffix      = ''
+            parse_args(nil, args)
+        end
+        
+        def rename(disc_title, number_of_tracks)
+            print '.'; $stdout.flush
+            
+            @track_title = disc_title + '-' + format(@prefix, @separator, @suffix, @track_number, number_of_tracks)
+            
+            #print @track_title + "/"; $stdout.flush
+            
+        end
+
+        def update_id3_tags
+            print '.'; $stdout.flush
+            track_filename = "#{@track_title}.mp3"
+            $track_number += 1
+            if $DEBUG
+                print "\n\ttrack source file = #{@path}"
+                print "\n\ttrack filename    = #{track_filename}"
+                print "\n\t@track number     = #{@track_number}"
+                print "\n\t$track number     = #{$track_number}"
+            end
+            Mp3Info.open(track_filename) do |mp3|
+                #
+                # ID3v1 tags
+                #
+                mp3.tag.tracknum = $track_number # @track_number.to_i
+                mp3.tag.title    = @track_title
+                mp3.tag.artist   = @album_artist
+                mp3.tag.album    = @album_title
+                mp3.tag.year     = @album_year
+                mp3.tag.genre_s  = 'speech'
+                mp3.tag.comments = "Renamed on #{Time.now}"
+                
+                #
+                # ID3v2 tags
+                #
+                mp3.tag2.TRK = $track_number # @track_number.to_i
+                mp3.tag2.TT2 = @track_title
+                mp3.tag2.TP2 = @album_artist
+                mp3.tag2.TAL = @album_title
+                mp3.tag2.TYE = @album_year
+                mp3.tag2.TCO = mp3.tag.genre_s
+                mp3.tag2.COM = mp3.tag.comments
+            end
+        end
+        
+        def write
+            print '.'; $stdout.flush
+            track_filename = "#{@track_title}.mp3"
+            if $DEBUG
+                print "\n\ttrack source file = #{@path}"
+                print "\n\ttrack filename    = #{track_filename}"
+            end
+            File.copy(@path, track_filename, false)
+        end
+        
+        private
+
+        include Utils::Formatter
+        include Utils::Parser
+        
+        def parse_string(track_title, value)
+            puts "album: parse_string(\"#{track_title}\", \"#{value}\")" if $DEBUG
+
+            if    track_title.to_s == 'number'; @track_number = value
+            elsif track_title.to_s == 'file'  ; @file         = value
+            elsif track_title.to_s == 'path'  ; @path         = value
+            else
+                puts "Unknown keyword: \"#{track_title}\""
+            end
+        end
+        
+    end # Track 
+    
+end # Mp3