id3tag 0.0.0 → 0.1.0

data/lib/id3tag/frame_id_advisor.rb

@@ -0,0 +1,50 @@
+module ID3Tag
+  class FrameIdAdvisor
+    COMMON_FRAME_IDS_BY_VERSION = {
+      'v1.x' => {
+        :artist => :artist,
+        :title => :title,
+        :album => :album,
+        :year => :year,
+        :comments => :comments,
+        :genre => :genre,
+        :track_nr => :track_nr
+      },
+      'v2.2' => {
+        :artist => :TP1,
+        :title => :TT2,
+        :album => :TAL,
+        :year => :TYE,
+        :comments => :COM,
+        :genre => :TCO,
+        :track_nr => :TRK
+      },
+      'v2.3' => {
+        :artist => :TPE1,
+        :title => :TIT2,
+        :album => :TALB,
+        :year => :TYER,
+        :comments => :COMM,
+        :genre => :TCON,
+        :track_nr => :TRCK
+      },
+      'v2.4' => {
+        :artist => :TPE1,
+        :title => :TIT2,
+        :album => :TALB,
+        :year => :TDRC,
+        :comments => :COMM,
+        :genre => :TCON,
+        :track_nr => :TRCK
+      }
+    }
+
+    def initialize(version, major_version)
+      @version, @major_version = version, major_version
+    end
+
+    def advise(frame_name)
+      COMMON_FRAME_IDS_BY_VERSION["v#{@version}.#{@major_version}"][frame_name]
+    end
+  end
+end

data/lib/id3tag/frames/util/genre_names.rb

@@ -0,0 +1,140 @@
+module ID3Tag
+  module Frames
+    module Util
+      class GenreNames
+        LIST = [
+          'Blues',
+          'Classic Rock',
+          'Country',
+          'Dance',
+          'Disco',
+          'Funk',
+          'Grunge',
+          'Hip-Hop',
+          'Jazz',
+          'Metal',
+          'New Age',
+          'Oldies',
+          'Other',
+          'Pop',
+          'R&B',
+          'Rap',
+          'Reggae',
+          'Rock',
+          'Techno',
+          'Industrial',
+          'Alternative',
+          'Ska',
+          'Death Metal',
+          'Pranks',
+          'Soundtrack',
+          'Euro-Techno',
+          'Ambient',
+          'Trip-Hop',
+          'Vocal',
+          'Jazz+Funk',
+          'Fusion',
+          'Trance',
+          'Classical',
+          'Instrumental',
+          'Acid',
+          'House',
+          'Game',
+          'Sound Clip',
+          'Gospel',
+          'Noise',
+          'AlternRock',
+          'Bass',
+          'Soul',
+          'Punk',
+          'Space',
+          'Meditative',
+          'Instrumental Pop',
+          'Instrumental Rock',
+          'Ethnic',
+          'Gothic',
+          'Darkwave',
+          'Techno-Industrial',
+          'Electronic',
+          'Pop-Folk',
+          'Eurodance',
+          'Dream',
+          'Southern Rock',
+          'Comedy',
+          'Cult',
+          'Gangsta',
+          'Top 40',
+          'Christian Rap',
+          'Pop/Funk',
+          'Jungle',
+          'Native American',
+          'Cabaret',
+          'New Wave',
+          'Psychadelic',
+          'Rave',
+          'Showtunes',
+          'Trailer',
+          'Lo-Fi',
+          'Tribal',
+          'Acid Punk',
+          'Acid Jazz',
+          'Polka',
+          'Retro',
+          'Musical',
+          'Rock & Roll',
+          'Hard Rock',
+          'Folk',
+          'Folk-Rock',
+          'National Folk',
+          'Swing',
+          'Fast Fusion',
+          'Bebob',
+          'Latin',
+          'Revival',
+          'Celtic',
+          'Bluegrass',
+          'Avantgarde',
+          'Gothic Rock',
+          'Progressive Rock',
+          'Psychedelic Rock',
+          'Symphonic Rock',
+          'Slow Rock',
+          'Big Band',
+          'Chorus',
+          'Easy Listening',
+          'Acoustic',
+          'Humour',
+          'Speech',
+          'Chanson',
+          'Opera',
+          'Chamber Music',
+          'Sonata',
+          'Symphony',
+          'Booty Bass',
+          'Primus',
+          'Porn Groove',
+          'Satire',
+          'Slow Jam',
+          'Club',
+          'Tango',
+          'Samba',
+          'Folklore',
+          'Ballad',
+          'Power Ballad',
+          'Rhythmic Soul',
+          'Freestyle',
+          'Duet',
+          'Punk Rock',
+          'Drum Solo',
+          'A capella',
+          'Euro-House',
+          'Dance Hall'
+        ]
+
+        def self.find_by_id(id)
+          LIST[id.to_i]
+        end
+      end
+    end
+  end
+end

data/lib/id3tag/frames/v1/comments_frame.rb

@@ -0,0 +1,24 @@
+module ID3Tag
+  module Frames
+    module V1
+      class CommentsFrame < TextFrame
+        def language
+          'unknown'
+        end
+
+        def desciption
+          'unknown'
+        end
+
+        def text
+          content
+        end
+
+        def content
+          @content.encode(destination_encoding, source_encoding)
+        end
+      end
+    end
+  end
+end
+

data/lib/id3tag/frames/v1/genre_frame.rb

@@ -0,0 +1,19 @@
+module ID3Tag
+  module Frames
+    module V1
+      class GenreFrame
+        attr_reader :id
+
+        def initialize(id, content)
+         @id, @content = id, content
+        end
+
+        def content
+          nr = @content.unpack(NumberUtil::FORMAT_FOR_8_BIT_SIGNED_INTEGER).first
+          nr && Util::GenreNames.find_by_id(nr)
+        end
+      end
+    end
+  end
+end
+

data/lib/id3tag/frames/v1/text_frame.rb

@@ -0,0 +1,27 @@
+module ID3Tag
+  module Frames
+    module V1
+      class TextFrame
+        attr_reader :id
+
+        def initialize(id, content)
+         @id, @content = id, content
+        end
+
+        def content
+          @content.encode(destination_encoding, source_encoding)
+        end
+
+        private
+
+        def destination_encoding
+          Encoding::UTF_8
+        end
+
+        def source_encoding
+          Encoding::ISO8859_1
+        end
+      end
+    end
+  end
+end

data/lib/id3tag/frames/v1/track_nr_frame.rb

@@ -0,0 +1,18 @@
+module ID3Tag
+  module Frames
+    module V1
+      class TrackNrFrame
+        attr_reader :id
+
+        def initialize(id, content)
+         @id, @content = id, content
+        end
+
+        def content
+          @content.unpack(NumberUtil::FORMAT_FOR_8_BIT_SIGNED_INTEGER).first.to_s
+        end
+      end
+    end
+  end
+end
+

data/lib/id3tag/frames/v2/basic_frame.rb

@@ -0,0 +1,26 @@
+module  ID3Tag
+  module Frames
+    module  V2
+      class BasicFrame
+        attr_reader :id
+        def initialize(id, content, flags, major_version_number)
+          @id, @raw_content, @flags, @major_version_number = id.to_sym, content, flags, major_version_number
+        end
+
+        def content
+          @raw_content
+        end
+
+        def inspect
+          "<#{self.class.name} #{id}: #{inspect_content}>"
+        end
+
+        private
+
+        def inspect_content
+          content
+        end
+      end
+    end
+  end
+end

data/lib/id3tag/frames/v2/comments_frame.rb

@@ -0,0 +1,44 @@
+module  ID3Tag
+  module Frames
+    module  V2
+      class CommentsFrame < TextFrame
+
+        # language code according to https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
+        def language
+          @language ||= get_language
+        end
+
+        def description
+          @desciption ||= encoded_text_and_content_parts.first
+        end
+
+        def text
+          @text ||= encoded_text_and_content_parts.last
+        end
+
+        def content
+          text
+        end
+
+        private
+
+        def encoded_text_and_content_parts
+          @encoded_text_and_content_parts ||= encoded_text_and_content.split("\00",2)
+        end
+
+        def encoded_text_and_content
+          raw_text_and_content.encode(destination_encoding, source_encoding)
+        end
+
+        def raw_text_and_content
+          content_without_encoding_byte[3..-1]
+        end
+
+        def get_language
+          content_without_encoding_byte[0..2].downcase
+        end
+      end
+    end
+  end
+end
+

data/lib/id3tag/frames/v2/frame_fabricator.rb

@@ -0,0 +1,36 @@
+module  ID3Tag
+  module Frames
+    module  V2
+      class FrameFabricator
+        class << self
+          def fabricate(id, content, flags, major_version_number)
+            new(id, content, flags, major_version_number).fabricate
+          end
+        end
+
+        def initialize(id, content, flags, major_version_number)
+          @id, @content, @flags, @major_version_number = id, content, flags, major_version_number
+        end
+
+        def fabricate
+          frame_class.new(@id, @content, @flags, @major_version_number)
+        end
+
+        def frame_class
+          case @id
+          when /^(TCON|TCO)$/
+            GenreFrame
+          when /^T/
+            TextFrame
+          when /^(COM|COMM)$/
+            CommentsFrame
+          when /^UFID$/
+            UniqueFileIdFrame
+          else
+            BasicFrame
+          end
+        end
+      end
+    end
+  end
+end

data/lib/id3tag/frames/v2/genre_frame.rb

@@ -0,0 +1,34 @@
+module ID3Tag
+  module Frames
+    module  V2
+      class GenreFrame < BasicFrame
+        class MissingGenreParser < StandardError; end
+
+        def genres
+          @genres ||= get_genres
+        end
+
+        def content
+          genres.join(", ")
+        end
+
+        private
+
+        def get_genres
+          genre_parser.new(@raw_content).genres
+        end
+
+        def genre_parser
+          case @major_version_number
+          when 0...4
+            GenreParserPre24
+          when 4
+            GenreParser24
+          else
+            raise(MissingGenreParser,"Missing genre parser for tag version v.2.#{@major_version_number}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/id3tag/frames/v2/genre_frame/genre_parser.rb

@@ -0,0 +1,36 @@
+module ID3Tag
+  module Frames
+    module  V2
+      class GenreFrame
+        class GenreParser
+          NUMERIC = /\A\d+\z/
+          attr_reader :genre_string
+
+          def initialize(genre_string)
+            @genre_string = genre_string
+          end
+
+          def expand_abbreviation(abbreviation)
+            case abbreviation
+            when 'CR'
+              'Cover'
+            when 'RX'
+              'Remix'
+            else
+              if abbreviation =~ NUMERIC
+                Util::GenreNames.find_by_id(abbreviation.to_i)
+              else
+                abbreviation
+              end
+            end
+          end
+
+          def genres
+            raise "#genres is not implemented for class #{self.class}"
+          end
+        end
+      end
+    end
+  end
+end
+