musicfix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f17741eecd6fd928c9cc4dd4a23f413d4df4f37
+  data.tar.gz: 9e8d84a8aad5c677fa2a1de96b935575d391ca39
+SHA512:
+  metadata.gz: 2289ce8b5a494a1a9bdf817af6d7506fc6721523aa0c83c2a0c70d2801b8d280cb9a7fd7946c19e40bf3b0d1a418d1f2615a4d53cf94e93941e8c19234fbf3ef
+  data.tar.gz: ff5ce233fe598ac27e0d23119b289dd4eea27a5640bf47c70ed07a28f1f9eb1e7bbb13bbbdc57a9dada2ee7c220e7f4aa2c5a44dc045bb3854b9c2cc01bda9a3

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2012--2013 Lazaros Koromilas <lostd@2f30.org>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,91 @@
+# $Id: README,v 1.11 2013/02/02 09:44:52 lostd Exp $
+
+# Description
+
+Musicfix is a music file renamer and tagger with consistency concerns.
+It has a release-centered logic and gets data from the Discogs.com site.
+First configure the target music directory (`mdir` config attribute).
+Next browse the site and locate your album.  Change to the album's
+directory.  Ensure the files are ordered and provide the release id
+to the program.  Enjoy!
+
+
+# Dependencies
+
+  * System packages: taglib
+  * Ruby gems: discogs-wrapper stringex taglib-ruby
+
+
+# Usage
+
+    $ musicfix relid [tracks]
+    $ musicfix dump relid [relfile]
+    $ musicfix load [relfile]
+
+More sophisticated track selection can be performed by providing
+a second command line argument of the form:
+
+    "1--3,5,8"
+    "A2--A4,B3"
+    "1-8--1-9,1-10--1-11"
+
+Alternatively, YAML metadata files can be used (`release.yaml` by default)
+in order to dump information from Discogs.com and/or load the information
+from file.  This way you can generate a base release file, edit to
+your needs, and then use it for tagging and renaming.
+
+
+# Configuration
+
+The simplest `~/.musicfixrc` configuration file only contains:
+
+    mdir: ~/music
+
+Furthermore, templates are used for the naming of music files
+and the cover artwork image.  The defaults are:
+
+    track: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{d}#{fn}-#{fa}-#{ft}.#{x}"'
+    image: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_cover.jpg"'
+
+To run a shell command upon completion use the `after` attribute.
+For example, to update the MPD database:
+
+    after: '"mpc update #{fba}-#{my}-#{fb}-#{fv}"'
+
+The variables used in the templates are explained below.
+The 'f' prefix means "normalized for filename".
+
+Use everywhere:
+
+    [f]b: album name
+    [f]ba: album artist
+    y: release year
+    my: master release year
+    g: genre style
+    [f]v: release format
+
+Only for track naming:
+
+    [f]a: track artist
+    [f]t: track title
+    [f]n: track number, may have letters (vinyls)
+    d: disc number
+    tn: track number counter
+    x: file extension in lowercase
+
+Only for image naming:
+
+    zz: zeros that match d + n width
+
+
+# Some test releases
+
+  * Sound, The (2) – From The Lions Mouth: 377432
+  * Various – Return Of The Banshee: 127565
+  * Harold Budd & Brian Eno – The Pearl: 699395
+  * Dead Souls Rising – Clepsydre 1993-1999: 1212954
+  * Metro Decay – Υπέρβαση: 1766242
+  * Dispossessed, The (2) – Sister Mary: 1965566
+  * Einstürzende Neubauten – Strategies Against Architecture IV: 2506503
+  * David Bowie – The Man Who Sold The World: 484622
+  * Various – Some Bizzare Album: 1381202

data/bin/musicfix

@@ -0,0 +1,277 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# $Id: musicfix,v 1.30 2013/06/13 23:09:01 lostd Exp $
+
+require 'rubygems'
+require 'fileutils'
+require 'open-uri'
+require 'discogs'
+require 'stringex'
+require 'taglib'
+require 'yaml'
+
+# Concatenate artist list using '&'
+# Convert "Sound, The (2)" to "The Sound"
+def mkartist al
+    nl = al.collect {|a| a.name}
+    nl.each {|n| n.gsub! /\s\(\d+\)$/, ''}
+    nl.each {|n| n.gsub! /(.*), The$/, 'The \1'}
+    nl.join ' & '
+end
+
+# Convert "3" to (nil, "03")
+# Convert "A" to (nil, "A0")
+# Convert "A3" to (nil, "A3")
+# Convert "2.3" to ("2", "03")
+# Convert "2.03" to ("2", "03")
+# Convert "CD2-3" to ("2", "03")
+def mkdiscnum pos
+    np = pos.gsub /[-.]/, '#'
+    d, n = np.split '#'
+    if not n
+        n = d
+        d = nil
+    else
+        d = d.gsub /\D/, ''
+    end
+    if n.match /[A-Z]/
+        n = n.ljust(2, '0')
+    else
+        n = n.rjust(2, '0')
+    end
+    return d, n
+end
+
+# Add wordings for symbols
+Stringex.localize_from :en => {"≠" => "not equals"}
+
+# Convert to lowercase ASCII without punctuation
+def mkname n
+    n = n.gsub '12"', '12 inch'
+    n = n.gsub "12''", "12 inch"
+    n = n.gsub "12'", "12 inch"
+    n = n.gsub '7"', '7 inch'
+    n = n.gsub "7''", "7 inch"
+    n = n.gsub "7'", "7 inch"
+    n = n.gsub " & ", " and "
+    n.to_url.gsub '-', '_'
+end
+
+# Get cover artwork
+def getimgurl rel
+    return nil unless rel.images
+    img = rel.images.select {|i| i.type == 'primary'}.first ||
+          rel.images.first
+    img.uri.gsub 'api.discogs.com', 's.pixogs.com'
+end
+
+# Construct position list from tracks filter
+# The string "1--3,5,8" becomes ["1", "2", "3", "5", "8"]
+# The string "A2--A4,B3" becomes ["A2", "A3", "A4", "B3"]
+# The string "1-8--1-9,1-10--1-11" becomes ["1-8", "1-9", "1-10", "1-11"]
+# Returns nil on error
+def mkposlist tracks
+    pl = tracks.split(",").map do |r|
+        r = r.split("--")
+        return nil if r.include? ""
+        r = case r.length
+            when 1 then r
+            when 2 then (r[0] .. r[1]).map {|i| i}
+            else return nil
+        end
+        return nil if r.empty?
+        r
+    end
+    pl.flatten
+end
+
+# Parse command line
+usage = ''
+usage << "Usage: musicfix relid [tracks]\n"
+usage << "       musicfix dump relid [relfile]\n"
+usage << "       musicfix load [relfile]\n"
+cmd = ARGV[0] || (puts usage; exit)
+case cmd
+when 'load' then
+    relfile = ARGV[1] || 'release.yaml'
+when 'dump' then
+    relid = ARGV[1] || (puts usage; exit)
+    relfile = ARGV[2] || 'release.yaml'
+else
+    relid = ARGV[0]
+    tracks = ARGV[1] || nil
+end
+
+# Default configuration
+cfg = {}
+cfg['mdir'] = '/var/music'
+cfg['track'] = '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{d}#{fn}-#{fa}-#{ft}.#{x}"'
+cfg['image'] = '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_cover.jpg"'
+#cfg['after'] = '"mpc update #{fba}-#{my}-#{fb}-#{fv}"'
+
+# User configuration overrides
+cfgpath = File.expand_path('~/.musicfixrc')
+if File.exists? cfgpath
+    new = YAML.load File.open(cfgpath, 'r')
+    cfg.merge! new
+end
+
+# Expand music directory
+cfg['mdir'] = File.expand_path cfg['mdir']
+
+# Print configuration
+puts 'Configuration'
+puts cfg.to_yaml
+
+unless cmd == 'dump' then
+    # Supported formats
+    fmtre = /mp3|ogg|m4a|mpc|flac|wv/i
+    # Construct file list
+    fl = Dir['*'].select {|f| File.extname(f).match fmtre}.sort
+    if fl.empty? then
+        puts 'No music files found!'
+        exit
+    end
+    # Output file list
+    puts 'Files to process'
+    puts fl.to_yaml
+end
+
+# Initialize release info
+if cmd == 'load' then
+    # Load release data from file
+    if File.exists? relfile then
+        puts "Loading release data..."
+        rel = YAML.load File.open(relfile, 'r')
+    else
+        puts "Release file #{relfile} not found."
+        exit
+    end
+else
+    # Get release data from Discogs
+    puts "Geting release data..."
+    discogs = Discogs::Wrapper.new("musicfix")
+    r = discogs.get_release(relid)
+    mr = if r.master_id then discogs.get_master_release(r.master_id) end
+    # Tracklist can contain dummy header tracks, strip them
+    tl = r.tracklist.select {|t| t.position}
+    # Apply tracks filter if given
+    if tracks then
+        pl = mkposlist tracks
+        puts "Invalid tracks filter: #{tracks}" unless pl
+        tl = tl.select {|t| pl.include? t.position}
+    end
+    # Gather release-wide data
+    rel = {}
+    rel['artist'] = mkartist r.artists
+    rel['album'] = r.title
+    rel['year'] = r.released
+    rel['masteryear'] = if mr then mr.year end || r.released
+    # Year can be full-date so keep only the year part
+    rel['year'] = rel['year'].slice(0..3)
+    rel['masteryear'] = rel['masteryear'].slice(0..3)
+    rel['genre'] = if r.styles then r.styles.first end ||
+                   if r.genres then r.genres.first end
+    rel['format'] = r.formats.first.name
+    rel['comment'] = "Discogs: #{r.id}"
+    rel['imgurl'] = getimgurl r
+    rel['tracklist'] = []
+    # Populate tracklist
+    tl.each do |s|
+        trk = {}
+        trk['pos'] = s.position
+        trk['artist'] = mkartist s.artists if s.artists
+        trk['title'] = s.title
+        rel['tracklist'] << trk
+    end
+end
+
+# Output release info
+puts rel.to_yaml
+if cmd == 'dump' then
+    File.open(relfile, 'w') do |f|
+        f.puts rel.to_yaml
+    end
+    exit
+end
+
+# Variables for use in templates
+mdir = cfg['mdir']
+ba = rel['artist']
+b = rel['album']
+y = rel['year']
+my = rel['masteryear']
+g = rel['genre']
+v = rel['format']
+c = rel['comment']
+fba = mkname ba
+fb = mkname b
+fv = mkname v
+# Internal use only
+tl = rel['tracklist']
+
+# Sanity checks
+if tl.length != fl.length then
+    puts "Found #{tl.length} tracks for #{fl.length} music files."
+    if fl.length < tl.length then
+        # Limit entries to number of files
+        tl = tl.first fl.length
+        print "Use only the first #{fl.length} entries? [y/N] "
+    else
+        # Limit files to available tracks
+        fl = fl.first tl.length
+        print "Use only the first #{fl.length} files? [y/N] "
+    end
+    res = STDIN.readline.strip
+    exit unless res == 'y'
+end
+
+# Loop over the music files and
+#   1. Copy them over with proper names
+#   2. Fix the tags on the new files
+tn = 0
+fl.each do |ofname|
+    tn = tn.next
+    trk = tl[tn - 1]
+    # Use track artist for compilations, fallback to release
+    a = trk['artist'] || rel['artist']
+    d, n = mkdiscnum trk['pos'].to_s
+    t = trk['title']
+    fa = mkname a
+    ft = mkname t
+    fn = mkname n
+    x = File.extname(ofname).delete('.').downcase
+    nfname = eval cfg['track']
+    puts "Copy track to #{nfname}"
+    FileUtils.makedirs(File.dirname nfname)
+    FileUtils.copy(ofname, nfname)
+    TagLib::FileRef.open(nfname) do |f|
+        f.tag.artist = a
+        f.tag.album = b
+        f.tag.title = t
+        f.tag.track = tn
+        f.tag.year = y.to_i
+        f.tag.genre = g
+        f.tag.comment = c
+        f.save
+    end
+end
+
+# Also save the first image of the artwork
+zz = '0' * (mkdiscnum tl.last['pos'].to_s).join.length
+imgname = eval cfg['image']
+if rel['imgurl'] then
+    puts "Save cover to #{imgname}"
+    img = open(rel['imgurl'], {"User-Agent" => "Mozilla"}).read
+    File.open(imgname, 'wb').write img
+end
+
+# Execute command if provided
+if cfg['after'] then
+    puts "Executing finishing command"
+    run = eval cfg['after']
+    `#{run}`
+end
+
+# vim:set ts=4 sw=4 et:

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: musicfix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lazaros Koromilas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: discogs-wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stringex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: taglib-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Musicfix is a music file renamer and tagger with consistency concerns. '
+email: lostd@2f30.org
+executables:
+- musicfix
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/musicfix
+- README
+- LICENSE
+homepage: http://www.2f30.org/~lostd/musicfix
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Music file renamer and tagger using Discogs.com
+test_files: []