easytag 0.4.3 → 1.0.0

data/lib/easytag/attributes/ogg.rb

@@ -0,0 +1,27 @@
+require 'base64'
+
+require_relative 'vorbis'
+
+module EasyTag
+  module OggAttributeAccessors
+    def field_reader(attr_name, fields = nil, **opts)
+      fields = attr_name.to_s.upcase if fields.nil?
+      define_method(attr_name) do
+        v = self.class.read_fields(taglib.tag, fields, **opts)
+        self.class.post_process(v, **opts)
+      end
+    end
+
+    def album_art_reader(attr_name, **opts)
+      opts[:returns] = :list
+      define_method(attr_name) do
+        v = self.class.read_fields(taglib.tag, 'METADATA_BLOCK_PICTURE', **opts)
+        v.collect do |b64_data|
+          pic = TagLib::FLAC::Picture.new
+          pic.parse(Base64.decode64(b64_data))
+          EasyTag::Image.new(pic.data)
+        end
+      end
+    end
+  end
+end

data/lib/easytag/attributes/vorbis.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module EasyTag
+  module VorbisAttributeAccessors
+    include BaseAttributeAccessors
+
+
+    def read_fields(xiph_comment, fields, **opts)
+      fields = Array(fields)
+      fields.each do |field|
+        next unless xiph_comment.contains?(field)
+        data = xiph_comment.field_list_map[field]
+        return opts[:returns] == :list ? data : data.first
+      end
+      opts[:returns] == :list ? [] : nil
+    end
+  end
+end

data/lib/easytag/taggers/base.rb

@@ -0,0 +1,19 @@
+module EasyTag
+  class BaseTagger
+    attr_reader :taglib
+
+    def year
+      date.nil? ? 0 : date.year
+    end
+
+    def close
+      taglib.close
+    end
+
+    def method_missing(method, *args, **kwargs)
+      warn "#{self.class.name}##{method} does not exist"
+      method.to_s[-1].eql?('?') ? false : nil
+    end
+  end
+
+end

data/lib/easytag/taggers/factory.rb

@@ -0,0 +1,59 @@
+module EasyTag
+  class TaggerFactory
+    def self.open(file, &block)
+      tagger_klass = tagger_class(file)
+
+      if block_given?
+        tagger = tagger_klass.new(file)
+        begin
+          block.call(tagger)
+        ensure
+          tagger.close
+        end
+      else
+        tagger_klass.new(file)
+      end
+    end
+
+    def self.tagger_class(file)
+      tagger_klass = tagger_for_filename(file)
+      if tagger_klass.nil?
+        data = nil
+        File.open(file, 'rb') { |fp| data = fp.read(16) }
+        tagger_klass = tagger_for_signature(data.bytes)
+      end
+
+      raise 'Could not determine file type' if tagger_klass.nil?
+      tagger_klass
+    end
+
+    def self.tagger_for_filename(fname)
+      case fname.split('.')[-1].downcase.to_sym
+      when :mp3; MP3Tagger
+      when :mp4, :m4a; MP4Tagger
+      when :flac; FLACTagger
+      when :ogg; OggTagger
+      else; nil
+      end
+    end
+
+    def self.tagger_for_signature(bytes)
+      case
+      when bytes[0...11] == [0, 0, 0, 32, 102, 116, 121, 112, 77, 52, 65] # ...ftypM4A
+        MP4Tagger
+      when bytes[0...11] == [0, 0, 0, 24, 102, 116, 121, 112, 109, 112, 52] # ...ftypmp4
+        MP4Tagger
+      when bytes[0...4] == [102, 76, 97, 67] # fLaC
+        FLACTagger
+      when bytes[0...4] == [79, 103, 103, 83] # OggS
+        OggTagger
+      when bytes[0...3] == [73, 68, 51] # ID3
+        MP3Tagger
+      when bytes[0...2] == [255, 251] # FF FB
+        MP3Tagger
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/easytag/taggers/flac.rb

@@ -0,0 +1,23 @@
+require 'easytag/attributes/flac'
+
+require_relative 'base'
+
+module EasyTag
+  class FLACTagger < BaseTagger
+    extend FLACAttributeAccessors
+    extend VorbisAttributes
+
+    initialize_vorbis_attributes
+
+    audio_prop_reader :length
+    audio_prop_reader :bitrate
+    audio_prop_reader :sample_rate
+    audio_prop_reader :channels
+    audio_prop_reader :sample_width
+    audio_prop_reader :signature
+
+    def initialize(file)
+      @taglib = TagLib::FLAC::File.new(file)
+    end
+  end
+end

data/lib/easytag/taggers/mp3.rb

@@ -0,0 +1,77 @@
+require 'easytag/attributes/mp3'
+
+require_relative 'base'
+
+module EasyTag
+  class MP3Tagger < BaseTagger
+    extend MP3AttributeAccessors
+
+    single_tag_reader :title, 'TIT2', :title
+    single_tag_reader :title_sort_order, %w{TSOT XSOT}
+    single_tag_reader :subtitle, 'TIT3'
+    single_tag_reader :artist, 'TPE1', :artist
+    single_tag_reader :artist_sort_order, %w{TSOP XSOP}
+    single_tag_reader :album, 'TALB', :album
+    single_tag_reader :album_sort_order, %w{TSOA XSOA}
+    single_tag_reader :album_artist, 'TPE2'
+    single_tag_reader :album_artist_sort_order, 'TSO2'
+    single_tag_reader :compilation?, 'TCMP', nil, returns: :bool
+    single_tag_reader :genre, 'TCON', :genre
+    single_tag_reader :disc_subtitle, 'TSST'
+    single_tag_reader :media, 'TMED'
+    single_tag_reader :label, 'TPUB'
+    single_tag_reader :encoded_by, 'TENC'
+    single_tag_reader :encoder_settings, 'TSSE'
+    single_tag_reader :group, 'TIT1'
+    single_tag_reader :composer, 'TCOM'
+    single_tag_reader :conductor, 'TPE3'
+    single_tag_reader :remixer, 'TPE4'
+    single_tag_reader :lyrics, 'USLT'
+    single_tag_reader :lyricist, 'TEXT'
+    single_tag_reader :copyright, 'TCOP'
+    single_tag_reader :bpm, 'TBPM', nil, returns: :int
+    single_tag_reader :mood, 'TMOD'
+    single_tag_reader :isrc, 'TSRC'
+    single_tag_reader :track_number, 'TRCK', :track, cast: :int_pair, extract_list_pos: 0
+    single_tag_reader :total_tracks, 'TRCK', :track, cast: :int_pair, extract_list_pos: 1
+    single_tag_reader :disc_number, 'TPOS', nil, cast: :int_pair, extract_list_pos: 0
+    single_tag_reader :total_discs, 'TPOS', nil, cast: :int_pair, extract_list_pos: 1
+    single_tag_reader :original_date, %w{TDOR TORY}, nil, returns: :datetime
+
+    all_tags_reader :comments, 'COMM', :comment
+    all_tags_reader :album_art, 'APIC'
+
+    audio_prop_reader :length
+    audio_prop_reader :bitrate
+    audio_prop_reader :sample_rate
+    audio_prop_reader :channels
+    audio_prop_reader :copyrighted?
+    audio_prop_reader :layer
+    audio_prop_reader :original?
+    audio_prop_reader :protection_enabled?, :protection_enabled
+
+    user_info_reader :asin, 'ASIN'
+    user_info_reader :script, 'SCRIPT'
+    user_info_reader :barcode, 'BARCODE'
+    user_info_reader :catalog_number, 'CATALOGNUMBER'
+    user_info_reader :musicbrainz_track_id, 'MusicBrainz Release Track Id'
+    user_info_reader :musicbrainz_album_id, 'MusicBrainz Album Id'
+    user_info_reader :musicbrainz_artist_id, 'MusicBrainz Artist Id', returns: :list
+    user_info_reader :musicbrainz_album_artist_id, 'MusicBrainz Album Artist Id'
+    user_info_reader :musicbrainz_trm_id, 'MusicBrainz TRM Id'
+    user_info_reader :musicbrainz_disc_id, 'MusicBrainz Disc Id'
+    user_info_reader :musicbrainz_release_status, 'MusicBrainz Album Status'
+    user_info_reader :musicbrainz_release_type, 'MusicBrainz Album Type', returns: :list
+    user_info_reader :musicbrainz_release_country, 'MusicBrainz Album Release Country'
+    user_info_reader :musicbrainz_release_group_id, 'MusicBrainz Release Group Id'
+    user_info_reader :musicip_puid, 'MusicIP PUID'
+    user_info_reader :musicip_fingerprint, 'MusicMagic Fingerprint'
+
+    ufid_reader :musicbrainz_recording_id, 'http://musicbrainz.org'
+    date_reader :date
+
+    def initialize(file)
+      @taglib = TagLib::MPEG::File.new(file)
+    end
+  end
+end

data/lib/easytag/taggers/mp4.rb

@@ -0,0 +1,73 @@
+require 'easytag/attributes/mp4'
+
+require_relative 'base'
+
+module EasyTag
+  class MP4Tagger < BaseTagger
+    extend MP4AttributeAccessors
+
+    item_reader :title, '©nam'
+    item_reader :title_sort_order, 'sonm'
+    item_reader :artist, '©ART'
+    item_reader :artist_sort_order, 'soar'
+    item_reader :album_artist, 'aART'
+    item_reader :album_artist_sort_order, 'soaa'
+    item_reader :album, '©alb'
+    item_reader :album_sort_order, 'soal'
+    item_reader :genre, '©gen'
+    item_reader :comments, '©cmt', data_type: :string_list, returns: :list
+    item_reader :lyrics, '©lyr'
+    item_reader :date, '©day', returns: :datetime
+    item_reader :encoded_by, '©enc'
+    item_reader :encoder_settings, '©too'
+    item_reader :group, '©grp'
+    item_reader :compilation?, 'cpil', data_type: :bool
+    item_reader :bpm, 'tmpo', data_type: :int
+    item_reader :mood, 'mood'
+    item_reader :copyright, 'cprt'
+    item_reader :track_number, 'trkn', data_type: :int_pair, cast: :int_pair, extract_list_pos: 0
+    item_reader :total_tracks, 'trkn', data_type: :int_pair, cast: :int_pair, extract_list_pos: 1
+    item_reader :disc_number, 'disk', data_type: :int_pair, cast: :int_pair, extract_list_pos: 0
+    item_reader :total_discs, 'disk', data_type: :int_pair, cast: :int_pair, extract_list_pos: 1
+    item_reader :album_art, 'covr', data_type: :cover_art_list, returns: :list
+
+    item_reader :subtitle, '----:com.apple.iTunes:SUBTITLE'
+    item_reader :disc_subtitle, '----:com.apple.iTunes:DISCSUBTITLE'
+    item_reader :media, '----:com.apple.iTunes:MEDIA'
+    item_reader :label, '----:com.apple.iTunes:LABEL'
+    item_reader :composer, '----:com.apple.iTunes:COMPOSER'
+    item_reader :remixer, '----:com.apple.iTunes:REMIXER'
+    item_reader :conductor, '----:com.apple.iTunes:CONDUCTOR'
+    item_reader :lyricist, '----:com.apple.iTunes:LYRICIST'
+    item_reader :asin, '----:com.apple.iTunes:ASIN'
+    item_reader :isrc, '----:com.apple.iTunes:ISRC'
+    item_reader :script, '----:com.apple.iTunes:SCRIPT'
+    item_reader :barcode, '----:com.apple.iTunes:BARCODE'
+    item_reader :catalog_number, '----:com.apple.iTunes:CATALOGNUMBER'
+
+    item_reader :musicbrainz_recording_id, '----:com.apple.iTunes:MusicBrainz Track Id'
+    item_reader :musicbrainz_track_id, '----:com.apple.iTunes:MusicBrainz Release Track Id'
+    item_reader :musicbrainz_artist_id, '----:com.apple.iTunes:MusicBrainz Artist Id', data_type: :string_list, returns: :list
+    item_reader :musicbrainz_album_artist_id, '----:com.apple.iTunes:MusicBrainz Album Artist Id'
+    item_reader :musicbrainz_album_id, '----:com.apple.iTunes:MusicBrainz Album Id'
+    item_reader :musicbrainz_disc_id, '----:com.apple.iTunes:MusicBrainz Disc Id'
+    item_reader :musicbrainz_trm_id, '----:com.apple.iTunes:MusicBrainz TRM Id'
+    item_reader :musicbrainz_release_group_id, '----:com.apple.iTunes:MusicBrainz Release Group Id'
+    item_reader :musicbrainz_release_status, '----:com.apple.iTunes:MusicBrainz Album Status'
+    item_reader :musicbrainz_release_type, '----:com.apple.iTunes:MusicBrainz Album Type', data_type: :string_list, returns: :list
+    item_reader :musicbrainz_release_country, '----:com.apple.iTunes:MusicBrainz Album Release Country'
+    item_reader :musicip_puid, '----:com.apple.iTunes:MusicIP PUID'
+    item_reader :musicip_fingerprint, '----:com.apple.iTunes:fingerprint'
+
+    audio_prop_reader :length
+    audio_prop_reader :bitrate
+    audio_prop_reader :sample_rate
+    audio_prop_reader :channels
+    audio_prop_reader :bits_per_sample
+    audio_prop_reader :encrypted?
+
+    def initialize(file)
+      @taglib = TagLib::MP4::File.new(file)
+    end
+  end
+end

data/lib/easytag/taggers/ogg.rb

@@ -0,0 +1,25 @@
+require 'easytag/attributes/ogg'
+
+require_relative 'base'
+
+module EasyTag
+  class OggTagger < BaseTagger
+    extend OggAttributeAccessors
+    extend VorbisAttributes
+
+    initialize_vorbis_attributes
+
+    audio_prop_reader :length
+    audio_prop_reader :bitrate
+    audio_prop_reader :sample_rate
+    audio_prop_reader :channels
+    audio_prop_reader :bitrate_maximum
+    audio_prop_reader :bitrate_minimum
+    audio_prop_reader :bitrate_nominal
+    audio_prop_reader :vorbis_version
+
+    def initialize(file)
+      @taglib = TagLib::Ogg::Vorbis::File.new(file)
+    end
+  end
+end

data/lib/easytag/taggers/vorbis.rb

@@ -0,0 +1,66 @@
+require 'easytag/attributes/vorbis'
+
+require_relative 'base'
+
+module EasyTag
+  module VorbisAttributes
+    include VorbisAttributeAccessors
+
+    def initialize_vorbis_attributes
+      field_reader :title
+      field_reader :title_sort_order, 'TITLESORT'
+      field_reader :subtitle
+      field_reader :artist
+      field_reader :artist_sort_order, 'ARTISTSORT'
+      field_reader :album
+      field_reader :album_sort_order, 'ALBUMSORT'
+      field_reader :album_artist, 'ALBUMARTIST'
+      field_reader :album_artist_sort_order, 'ALBUMARTISTSORT'
+      field_reader :compilation?, 'COMPILATION', returns: :bool
+      field_reader :genre
+      field_reader :disc_subtitle, 'DISCSUBTITLE'
+      field_reader :media
+      field_reader :label
+      field_reader :encoded_by, 'ENCODEDBY'
+      field_reader :encoder_settings, 'ENCODERSETTINGS'
+      field_reader :group
+      field_reader :composer
+      field_reader :conductor
+      field_reader :remixer
+      field_reader :lyrics
+      field_reader :lyricist
+      field_reader :copyright
+      field_reader :bpm, returns: :int
+      field_reader :mood
+      field_reader :isrc
+      field_reader :track_number, 'TRACKNUMBER', returns: :int
+      field_reader :total_tracks, %w{TRACKTOTAL TOTALTRACKS}, returns: :int
+      field_reader :disc_number, 'DISCNUMBER', returns: :int
+      field_reader :total_discs, %W{DISCTOTAL TOTALDISCS}, returns: :int
+      field_reader :date, returns: :datetime
+      field_reader :original_date, 'ORIGINALDATE', returns: :datetime
+      field_reader :comments, 'COMMENT', returns: :list
+
+      album_art_reader :album_art
+
+      field_reader :asin, 'ASIN'
+      field_reader :script, 'SCRIPT'
+      field_reader :barcode, 'BARCODE'
+      field_reader :catalog_number, 'CATALOGNUMBER'
+      field_reader :musicbrainz_recording_id, 'MUSICBRAINZ_TRACKID'
+      field_reader :musicbrainz_track_id, 'MUSICBRAINZ_RELEASETRACKID'
+      field_reader :musicbrainz_album_id, 'MUSICBRAINZ_ALBUMID'
+      field_reader :musicbrainz_artist_id, 'MUSICBRAINZ_ARTISTID', returns: :list
+      field_reader :musicbrainz_album_artist_id, 'MUSICBRAINZ_ALBUMARTISTID'
+      field_reader :musicbrainz_trm_id, 'MUSICBRAINZ_TRMID'
+      field_reader :musicbrainz_disc_id, 'MUSICBRAINZ_DISCID'
+      field_reader :musicbrainz_release_status, 'RELEASESTATUS'
+      field_reader :musicbrainz_release_type, 'RELEASETYPE', returns: :list
+      field_reader :musicbrainz_release_country, 'RELEASECOUNTRY'
+      field_reader :musicbrainz_release_group_id, 'MUSICBRAINZ_RELEASEGROUPID'
+      field_reader :musicip_puid, 'MUSICIP_PUID'
+      # TODO
+      # field_reader :musicip_fingerprint, 'MusicMagic Fingerprint'
+    end
+  end
+end

data/lib/easytag/util.rb

@@ -50,44 +50,22 @@ module EasyTag
 
     # get_int_pair
     #
-    # Parses a pos/total string and returns a pair of ints
-    def self.get_int_pair(str)
+    # Parses a pos/total string and returns a pair of ints (or nils)
+    def self.get_int_pair(input)
+      return input.collect { |i| i.to_i }[0..1] if input.is_a?(Array)
+
+      input = input.to_s
       pair = [0, 0]
 
-      unless str.nil? || str.empty?
-        if str.include?('/')
-          pair = str.split('/').map { |it| it.to_i }
+      unless input.nil? || input.empty?
+        if input.include?('/')
+          pair = input.split('/').collect { |it| it.to_i }
         else
-          pair[0] = str.to_i
+          pair[0] = input.to_i
         end
       end
 
       pair
     end
-
-    def self.normalize_string(str)
-      str = str.to_s
-      # downcase string
-      str.downcase!
-      # we want snakecase
-      str.gsub!(/\s/, '_')
-      # we only want alphanumeric characters
-      str.gsub(/\W/, '')
-    end
-
-    def self.normalize_object(object)
-      if object.is_a?(String)
-        normalize_string(object)
-      elsif object.is_a?(Symbol)
-        normalize_string(object.to_s).to_sym
-      elsif object.is_a?(Array)
-        new_array = []
-        object.each { |item| new_array << normalize_object(item) }
-        new_array
-      else
-          object
-      end
-    end
-
   end
 end