id3tag 0.0.0 → 0.1.0

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

@@ -0,0 +1,15 @@
+module ID3Tag
+  module Frames
+    module  V2
+      class GenreFrame
+        class GenreParser24 < GenreParser
+          def genres
+            genre_string.split("\x00").map do |genre|
+              expand_abbreviation(genre)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module ID3Tag
+  module Frames
+    module  V2
+      class GenreFrame
+        class GenreParserPre24 < GenreParser
+          REFINEMENT_IN_PARENTHESES = /(\(\([^()]+\))/
+          GENRE_NUMBERS_OR_NAMES = /\(([^)]+)\)/
+          REFINEMENTS = /([)](?<blank>)[(][^(])|(\)(?<regular>[^()]+)[)]*)|(\((?<in_parentheses>\([^()]+\)))/
+
+          def genres
+            result = []
+            just_genres.each_with_index do |genre, index|
+              if ID3Tag::StringUtil.blank?(just_requirements[index])
+                result << expand_abbreviation(genre)
+              else
+                result << just_requirements[index]
+              end
+            end
+            result
+          end
+
+          private
+
+          def just_genres
+            genre_string.gsub(REFINEMENT_IN_PARENTHESES, '').scan(GENRE_NUMBERS_OR_NAMES).flatten
+          end
+
+          def just_requirements
+            result = []
+            genre_string.scan(REFINEMENTS) do |blank, regular, in_parentheses|
+              result << (regular || in_parentheses || blank)
+            end
+            result
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module  ID3Tag
+  module Frames
+    module  V2
+      class TextFrame < BasicFrame
+        class UnsupportedTextEncoding < StandardError; end
+        ENCODING_MAP = {
+          0b0 => Encoding::ISO8859_1,
+          0b1 => Encoding::UTF_16,
+          0b10 => Encoding::UTF_16BE,
+          0b11 => Encoding::UTF_8
+        }
+
+        def content
+          @content ||= content_without_encoding_byte.encode(destination_encoding, source_encoding)
+        end
+
+        private
+
+        def source_encoding
+          ENCODING_MAP[get_encoding_byte] || raise(UnsupportedTextEncoding)
+        end
+
+        def destination_encoding
+          Encoding::UTF_8
+        end
+
+        def get_encoding_byte
+          @raw_content.getbyte(0)
+        end
+
+        def content_without_encoding_byte
+          @raw_content.byteslice(1, @raw_content.bytesize - 1)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module  ID3Tag
+  module Frames
+    module  V2
+      class UniqueFileIdFrame < BasicFrame
+        def owner_identifier
+          content_split_apart_by_null_byte.first
+        end
+
+        def content
+          content_split_apart_by_null_byte.last
+        end
+
+        private
+
+        def content_split_apart_by_null_byte
+          @raw_content.split("\x00", 2)
+        end
+
+        def inspect_content
+          "#{owner_identifier}"
+        end
+      end
+    end
+  end
+end

data/lib/id3tag/id3_v1_frame_parser.rb

@@ -0,0 +1,87 @@
+module ID3Tag
+  class ID3V1FrameParser
+
+    def initialize(input)
+      @input = StringIO.new(input)
+    end
+
+    def frames
+      @frames ||= get_frames
+    end
+
+    private
+
+    def get_frames
+      frames = Set.new
+      frames << title_frame
+      frames << artist_frame
+      frames << album_frame
+      frames << year_frame
+      frames << comment_frame
+      frames << genre_frame
+      frames << track_nr_frame if tag_version_1_1?
+      frames
+    end
+
+    def title_frame
+      Frames::V1::TextFrame.new(:title, read_from_pos_till_null_byte_or_limit(0, 30))
+    end
+
+    def artist_frame
+      Frames::V1::TextFrame.new(:artist, read_from_pos_till_null_byte_or_limit(30, 30))
+    end
+
+    def album_frame
+      Frames::V1::TextFrame.new(:album, read_from_pos_till_null_byte_or_limit(60, 30))
+    end
+
+    def year_frame
+      Frames::V1::TextFrame.new(:year, read_from_pos_till_null_byte_or_limit(90, 4))
+    end
+
+    def comment_frame
+      Frames::V1::CommentsFrame.new(:comments, read_from_pos_till_null_byte_or_limit(94, comment_frame_size))
+    end
+
+    def genre_frame
+      Frames::V1::GenreFrame.new(:genre, read_from_pos_till_limit(124, 1))
+    end
+
+    def track_nr_frame
+      Frames::V1::TrackNrFrame.new(:track_nr, read_from_pos_till_null_byte_or_limit(123, 1))
+    end
+
+    def comment_frame_size
+      if tag_version_1_1?
+        28
+      else
+        30
+      end
+    end
+
+    def tag_version_1_1?
+      @tag_version_1_1 ||= get_tag_version_1_1?
+    end
+
+    def get_tag_version_1_1?
+      second_last_comment_byte, last_comment_byte = read_from_pos_till_limit(122, 2).bytes.to_a
+      (second_last_comment_byte == 0) && (last_comment_byte != 0)
+    end
+
+    def read_from_pos_till_null_byte_or_limit(position, limit)
+      @input.seek(position)
+      value = ""
+      limit.times do
+        char = @input.getc
+        break if char == "\x00"
+        value << char
+      end
+      value
+    end
+
+    def read_from_pos_till_limit(position, limit)
+      @input.seek(position)
+      @input.read(limit)
+    end
+  end
+end

data/lib/id3tag/id3_v2_frame_parser.rb

@@ -0,0 +1,72 @@
+module ID3Tag
+  class ID3V2FrameParser
+    def initialize(input, major_version_number)
+      @input, @major_version_number = StringIO.new(input), major_version_number
+    end
+
+    def frames
+      @frames ||= get_frames
+    end
+
+    private
+
+    def get_frames
+      frames = []
+      rewind_input
+      loop do
+        frame_id = read_next_frame_id
+        frame_size = read_next_frame_size
+        frame_flags = read_next_frame_flags
+        frame_content = read_next_bytes(frame_size)
+        frames << Frames::V2::FrameFabricator.fabricate(frame_id, frame_content, frame_flags, @major_version_number)
+        break if padding_or_eof_reached?
+      end
+      frames
+    end
+
+    def read_next_frame_id
+      read_next_bytes(frame_id_length)
+    end
+
+    def read_next_frame_size
+      size_bytes = case frame_size_length
+      when 4
+        read_next_bytes(frame_size_length)
+      when 3
+        "\x00" + read_next_bytes(frame_size_length)
+      end
+      SynchsafeInteger.decode(NumberUtil.convert_string_to_32bit_integer(size_bytes))
+    end
+
+    def read_next_frame_flags
+      frames_has_flags? ? read_next_bytes(2) : nil
+    end
+
+    def frame_id_length
+      @major_version_number <= 2 ? 3 : 4
+    end
+
+    def frames_has_flags?
+      @major_version_number > 2
+    end
+
+    def frame_size_length
+      @major_version_number <= 2 ? 3 : 4
+    end
+
+    def read_next_bytes(limit)
+      @input.read(limit)
+    end
+
+    def rewind_input
+      @input.rewind
+    end
+
+    def padding_or_eof_reached?
+      current_position = @input.pos
+      next_byte = @input.getbyte
+      @input.pos = current_position
+      (next_byte == 0) || @input.eof?
+    end
+  end
+end

data/lib/id3tag/id3_v2_tag_header.rb

@@ -0,0 +1,61 @@
+module ID3Tag
+  class ID3v2TagHeader
+    def initialize(header_chunk)
+      @content = StringIO.new(header_chunk)
+    end
+
+    def major_version_number
+      @content.seek(3)
+      @content.readbyte
+    end
+
+    def minor_version_number
+      @content.seek(4)
+      @content.readbyte
+    end
+
+    def version_number
+      sprintf("%s.%s", major_version_number, minor_version_number)
+    end
+
+    def unsynchronisation?
+      flags_byte[7] == 1
+    end
+
+    def extended_header?
+      flags_byte[6] == 1
+    end
+
+    def experimental?
+      flags_byte[5] == 1
+    end
+
+    def footer_present?
+      flags_byte[4] == 1
+    end
+
+    def tag_size
+      @tag_size ||= get_tag_size
+    end
+
+    private
+
+    def flags_byte
+      @flags_byte ||= get_flags_byte
+    end
+
+    def get_flags_byte
+      @content.seek(5)
+      @content.readbyte
+    end
+
+    def get_tag_size
+      SynchsafeInteger.decode(NumberUtil.convert_string_to_32bit_integer(tag_size_bytes))
+    end
+
+    def tag_size_bytes
+      @content.seek(6)
+      @content.read(4)
+    end
+  end
+end

data/lib/id3tag/number_util.rb

@@ -0,0 +1,14 @@
+module ID3Tag
+  module NumberUtil
+    FORMAT_FOR_8_BIT_SIGNED_INTEGER = 'c'
+    FORMAT_FOR_32BIT_INTEGER = 'N'
+    def self.convert_string_to_32bit_integer(string)
+      integers = string.unpack(FORMAT_FOR_32BIT_INTEGER)
+      integers.first || raise(ArgumentError, "String: '#{string}' could not be decoded as 32-bit integer")
+    end
+
+    def self.convert_32bit_integer_to_string(integer)
+      [integer].pack(FORMAT_FOR_32BIT_INTEGER)
+    end
+  end
+end

data/lib/id3tag/string_util.rb

@@ -0,0 +1,7 @@
+module ID3Tag
+  module StringUtil
+    def self.blank?(string)
+      string !~ /[^[:space:]]/
+    end
+  end
+end

data/lib/id3tag/synchsafe_integer.rb

@@ -0,0 +1,28 @@
+module ID3Tag
+  class SynchsafeInteger
+    class << self
+      def encode(int)
+        mask = 0x7F
+        while mask <= 0x7FFFFFFF do
+          out = int & ~mask
+          out = out << 1
+          out = out | (int & mask)
+          mask = ((mask + 1) << 8) - 1
+          int = out
+        end
+        out
+      end
+
+      def decode(synchsafe_int)
+        out = 0
+        mask = 0x7F000000
+        while mask > 0 do
+          out = out >> 1
+          out = out | (synchsafe_int & mask)
+          mask = mask >> 8
+        end
+        out
+      end
+    end
+  end
+end

data/lib/id3tag/tag.rb

@@ -0,0 +1,121 @@
+module ID3Tag
+  class Tag
+    class MultipleFrameError < StandardError; end
+
+    class << self
+      def read(source, version = nil)
+        new(source, version)
+      end
+    end
+
+    def initialize(source, version = nil)
+      @source, @version = source, version
+    end
+
+    def artist
+      get_frame_content(frame_id_by_name(:artist))
+    end
+
+    def title
+      get_frame_content(frame_id_by_name(:title))
+    end
+
+    def album
+      get_frame_content(frame_id_by_name(:album))
+    end
+
+    def year
+      get_frame_content(frame_id_by_name(:year))
+    end
+
+    def comments(language = nil)
+      all_comments_frames = get_frames(frame_id_by_name(:comments))
+      comments_frame = if language
+        all_comments_frames.select { |frame| frame.language == language.to_s.downcase }.first
+      else
+        in_english = all_comments_frames.select { |frame| frame.language == 'eng' }
+        in_english.first || all_comments_frames.first
+      end
+      comments_frame && comments_frame.content
+    end
+
+    def track_nr
+      get_frame_content(frame_id_by_name(:track_nr))
+    end
+
+    def genre
+      get_frame_content(frame_id_by_name(:genre))
+    end
+
+    def get_frame(frame_id)
+      frames = get_frames(frame_id)
+      if frames.count > 1
+        raise MultipleFrameError, "Could not return only one frame with id: #{frame_id}. Tag has #{frames.count} of them"
+      else
+        frames.first
+      end
+    end
+
+    def get_frames(frame_id)
+      frames.select { |frame| frame.id == frame_id }
+    end
+
+    def frame_ids
+      frames.map { |frame| frame.id }
+    end
+
+    def frames
+      @frames ||= parse_frames
+    end
+
+    def get_frame_content(frame_id)
+      frame = get_frame(frame_id)
+      frame && frame.content
+    end
+
+    def parsable_version
+      @parsable_version ||= calc_parsable_version
+    end
+
+    private
+
+    def frame_id_by_name(name)
+      case parsable_version
+      when 2
+        FrameIdAdvisor.new(2, audio_file.v2_tag_major_version_number).advise(name)
+      when 1
+        FrameIdAdvisor.new(1, 'x').advise(name)
+      else
+        nil
+      end
+    end
+
+    def parse_frames
+      case parsable_version
+      when 2
+        ID3V2FrameParser.new(audio_file.v2_tag_body, audio_file.v2_tag_major_version_number).frames
+      when 1
+        ID3V1FrameParser.new(audio_file.v1_tag_body).frames
+      else
+        []
+      end
+    end
+
+    def calc_parsable_version
+      if @version
+        method = "v#{@version}_tag_present?"
+        if audio_file.respond_to?(method) && audio_file.send(method)
+          @version
+        else
+          nil
+        end
+      else
+        audio_file.greatest_tag_version
+      end
+    end
+
+    def audio_file
+      @audio_file ||= AudioFile.new(@source)
+    end
+  end
+end