wahwah 0.1.0 → 1.0.0

data/lib/wahwah/id3/v1.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module WahWah
+  module ID3
+    class V1 < Tag
+      TAG_SIZE = 128
+      TAG_ID = 'TAG'
+      DEFAULT_ENCODING = 'iso-8859-1'
+      GENRES = [
+        # Standard Genres
+        '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',
+
+        # Winamp Extended Genres
+        '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', 'Goa', 'Drum & Bass', 'Club-House',
+        'Hardcore Techno', 'Terror', 'Indie', 'BritPop', 'Negerpunk', 'Polsk Punk', 'Beat',
+        'Christian Gangsta Rap', 'Heavy Metal', 'Black Metal', 'Contemporary Christian', 'Christian Rock',
+
+        # Added on WinAmp 1.91
+        'Merengue', 'Salsa', 'Thrash Metal', 'Anime', 'Jpop', 'Synthpop',
+
+        # Added on WinAmp 5.6
+        'Abstract', 'Art Rock', 'Baroque', 'Bhangra', 'Big Beat', 'Breakbeat', 'Chillout',
+        'Downtempo', 'Dub', 'EBM', 'Eclectic', 'Electro', 'Electroclash', 'Emo',
+        'Experimental', 'Garage', 'Illbient', 'Industro-Goth', 'Jam Band', 'Krautrock', 'Leftfield',
+        'Lounge', 'Math Rock', 'New Romantic', 'Nu-Breakz', 'Post-Punk', 'Post-Rock', 'Psytrance',
+        'Shoegaze', 'Space Rock', 'Trop Rock', 'World Music', 'Neoclassical', 'Audiobook', 'Audio Theatre',
+        'Neue Deutsche Welle', 'Podcast', 'Indie Rock', 'G-Funk', 'Dubstep', 'Garage Rock', 'Psybient'
+      ]
+
+      def size
+        TAG_SIZE
+      end
+
+      def version
+        'v1'
+      end
+
+      def valid?
+        @id == TAG_ID
+      end
+
+      private
+        # For ID3v1 info, see here https://en.wikipedia.org/wiki/ID3#ID3v1
+        #
+        # header    3         "TAG"
+        # title     30        30 characters of the title
+        # artist    30        30 characters of the artist name
+        # album     30        30 characters of the album name
+        # year      4         A four-digit year
+        # comment   28 or 30  The comment.
+        # zero-byte 1         If a track number is stored, this byte contains a binary 0.
+        # track     1         The number of the track on the album, or 0. Invalid, if previous byte is not a binary 0.
+        # genre     1         Index in a list of genres, or 255
+        def parse
+          return unless @file_io.size >= TAG_SIZE
+
+          @file_io.seek(-TAG_SIZE, IO::SEEK_END)
+          @id = Helper.encode_to_utf8(@file_io.read(3), source_encoding: DEFAULT_ENCODING)
+
+          return unless valid?
+
+          @title = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
+          @artist = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
+          @album = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
+          @year = Helper.encode_to_utf8(@file_io.read(4), source_encoding: DEFAULT_ENCODING)
+
+          comment = @file_io.read(30)
+
+          if comment.getbyte(-2) == 0
+            @track = comment.getbyte(-1)
+            comment = comment.byteslice(0..-3)
+          end
+
+          @comments.push(Helper.encode_to_utf8(comment, source_encoding: DEFAULT_ENCODING))
+          @genre = GENRES[@file_io.getbyte] || ''
+        end
+    end
+  end
+end

data/lib/wahwah/id3/v2.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module WahWah
+  module ID3
+    class V2 < Tag
+      extend Forwardable
+
+      def_delegators :@header, :major_version, :size, :has_extended_header?, :valid?
+
+      def version
+        "v2.#{major_version}"
+      end
+
+      private
+        def parse
+          @file_io.rewind
+          @header = V2Header.new(@file_io)
+
+          return unless valid?
+
+          until end_of_tag? do
+            frame = ID3::Frame.new(@file_io, major_version)
+            next unless frame.valid?
+
+            update_attribute(frame)
+          end
+        end
+
+        def update_attribute(frame)
+          name = frame.name
+          value = frame.value
+
+          case name
+          when :comment
+            # Because there may be more than one comment frame in each tag,
+            # so push it into a array.
+            @comments.push(value)
+          when :image
+            # Because there may be more than one image frame in each tag,
+            # so push it into a array.
+            @images.push(value)
+          when :track, :disc
+            # Track and disc value may be extended with a "/" character
+            # and a numeric string containing the total numer.
+            count, total_count = value.split('/', 2)
+            instance_variable_set("@#{name}", count)
+            instance_variable_set("@#{name}_total", total_count) unless total_count.nil?
+          else
+            instance_variable_set("@#{name}", value)
+          end
+        end
+
+        def end_of_tag?
+          size <= @file_io.pos || file_size <= @file_io.pos
+        end
+    end
+  end
+end

data/lib/wahwah/id3/v2_header.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module WahWah
+  module ID3
+    # The ID3v2 tag header, which should be the first information in the file,
+    # is 10 bytes as follows:
+
+    # ID3v2/file identifier   "ID3"
+    # ID3v2 version           $03 00
+    # ID3v2 flags             %abc00000
+    # ID3v2 size              4 * %0xxxxxxx
+    class V2Header
+      TAG_ID = 'ID3'
+      HEADER_SIZE = 10
+      HEADER_FORMAT = 'A3CxB8B*'
+
+      attr_reader :major_version, :size
+
+      def initialize(file_io)
+        header_content = file_io.read(HEADER_SIZE)
+        @id, @major_version, @flags, size_bits = header_content.unpack(HEADER_FORMAT) if header_content.size >= HEADER_SIZE
+
+        return unless valid?
+
+        # Tag size is the size excluding the header size,
+        # so add header size back to get total size.
+        @size = Helper.id3_size_caculate(size_bits) + HEADER_SIZE
+
+        if has_extended_header?
+          # Extended header structure:
+          #
+          # Extended header size   $xx xx xx xx
+          # Extended Flags         $xx xx
+          # Size of padding        $xx xx xx xx
+
+          # Skip extended_header
+          extended_header_size = Helper.id3_size_caculate(file_io.read(4).unpack('B32').first)
+          file_io.seek(extended_header_size - 4, IO::SEEK_CUR)
+        end
+      end
+
+      def valid?
+        @id == TAG_ID
+      end
+
+      # The second bit in flags byte indicates whether or not the header
+      # is followed by an extended header.
+      def has_extended_header?
+        @flags[1] == '1'
+      end
+    end
+  end
+end

data/lib/wahwah/mp3/mpeg_frame_header.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module WahWah
+  module Mp3
+    # mpeg frame header structure:
+    #
+    # Position   Length    Meaning
+    # 0          11        Frame sync to find the header (all bits are always set)
+    #
+    # 11         2         Audio version ID
+    #                      00 - MPEG Version 2.5 (unofficial extension of MPEG 2)
+    #                      01 - reserved
+    #                      10 - MPEG Version 2 (ISO/IEC 13818-3)
+    #                      11 - MPEG Version 1 (ISO/IEC 11172-3)
+    #
+    # 13         2         Layer index
+    #                      00 - reserved
+    #                      01 - Layer III
+    #                      10 - Layer II
+    #                      11 - Layer I
+    #
+    # 15         1         Protection bit
+    #
+    # 16         4         Bitrate index, see FRAME_BITRATE_INDEX constant
+    #
+    # 20         2         Sampling rate index, see SAMPLE_RATE_INDEX constant
+    #
+    # 22         1         Padding bit
+    #
+    # 23         1         Private bit
+    #
+    # 24         2         Channel mode
+    #                      00 - Stereo
+    #                      01 - Joint Stereo (Stereo)
+    #                      10 - Dual channel (Two mono channels)
+    #                      11 - Single channel (Mono)
+    #
+    # 26         2         Mode extension (Only used in Joint Stereo)
+    #
+    # 28         1         Copyright bit (only informative)
+    #
+    # 29         1         Original bit (only informative)
+    #
+    # 30         2         Emphasis
+    class MpegFrameHeader
+      HEADER_SIZE = 4
+
+      FRAME_BITRATE_INDEX = {
+        'MPEG1 layer1' => [0, 32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 448, 0],
+        'MPEG1 layer2' => [0, 32, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 384, 0],
+        'MPEG1 layer3' => [0, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 0],
+
+        'MPEG2 layer1' => [0, 32, 48, 56, 64, 80, 96, 112, 128, 144, 160, 176, 192, 224, 256, 0],
+        'MPEG2 layer2' => [0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0],
+        'MPEG2 layer3' => [0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0],
+
+        'MPEG2.5 layer1' => [0, 32, 48, 56, 64, 80, 96, 112, 128, 144, 160, 176, 192, 224, 256, 0],
+        'MPEG2.5 layer2' => [0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0],
+        'MPEG2.5 layer3' => [0, 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 144, 160, 0]
+      }
+
+      VERSIONS_INDEX = ['MPEG2.5', nil, 'MPEG2', 'MPEG1']
+      LAYER_INDEX = [nil, 'layer3', 'layer2', 'layer1']
+      CHANNEL_MODE_INDEX = ['Stereo', 'Joint Stereo', 'Dual Channel', 'Single Channel']
+
+      SAMPLE_RATE_INDEX = {
+        'MPEG1' => [44100, 48000, 32000],
+        'MPEG2' => [22050, 24000, 16000],
+        'MPEG2.5' => [11025, 12000, 8000]
+      }
+
+      SAMPLES_PER_FRAME_INDEX = {
+        'MPEG1 layer1' => 384,
+        'MPEG1 layer2' => 1152,
+        'MPEG1 layer3' => 1152,
+
+        'MPEG2 layer1' => 384,
+        'MPEG2 layer2' => 1152,
+        'MPEG2 layer3' => 576,
+
+        'MPEG2.5 layer1' => 384,
+        'MPEG2.5 layer2' => 1152,
+        'MPEG2.5 layer3' => 576
+      }
+
+      attr_reader :version, :layer, :frame_bitrate, :channel_mode, :sample_rate
+
+      def initialize(file_io, offset = 0)
+        # mpeg frame header start with '11111111111' sync bits,
+        # So look through file until find it.
+        loop do
+          file_io.rewind
+          file_io.seek(offset)
+
+          break if file_io.eof?
+
+          header = file_io.read(HEADER_SIZE)
+          sync_bits = header.unpack('B11').first
+
+          if sync_bits == "#{'1' * 11}".b
+            @header = header.unpack('B*').first
+            @position = offset
+
+            parse; break
+          end
+
+          offset += 1
+        end
+      end
+
+      def valid?
+        !@header.nil?
+      end
+
+      def position
+        return 0 unless valid?
+        @position
+      end
+
+      def kind
+        return if @version.nil? && @layer.nil?
+        "#{@version} #{@layer}"
+      end
+
+      def samples_per_frame
+        SAMPLES_PER_FRAME_INDEX[kind]
+      end
+
+      private
+        def parse
+          return unless valid?
+
+          @version = VERSIONS_INDEX[@header[11..12].to_i(2)]
+          @layer = LAYER_INDEX[@header[13..14].to_i(2)]
+          @frame_bitrate = FRAME_BITRATE_INDEX[kind]&.fetch(@header[16..19].to_i(2))
+          @channel_mode = CHANNEL_MODE_INDEX[@header[24..25].to_i(2)]
+          @sample_rate = SAMPLE_RATE_INDEX[@version]&.fetch(@header[20..21].to_i(2))
+        end
+    end
+  end
+end

data/lib/wahwah/mp3/vbri_header.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module WahWah
+  module Mp3
+    # VBRI header structure:
+    #
+    # Position    Length    Meaning
+    # 0           4         VBR header ID in 4 ASCII chars, always 'VBRI', not NULL-terminated
+    #
+    # 4           2         Version ID as Big-Endian 16-bit unsigned
+    #
+    # 6           2         Delay as Big-Endian float
+    #
+    # 8           2         Quality indicator
+    #
+    # 10          4         Number of Bytes as Big-Endian 32-bit unsigned
+    #
+    # 14          4         Number of Frames as Big-Endian 32-bit unsigned
+    #
+    # 18          2         Number of entries within TOC table as Big-Endian 16-bit unsigned
+    #
+    # 20          2         Scale factor of TOC table entries as Big-Endian 32-bit unsigned
+    #
+    # 22          2         Size per table entry in bytes (max 4) as Big-Endian 16-bit unsigned
+    #
+    # 24          2         Frames per table entry as Big-Endian 16-bit unsigned
+    #
+    # 26                    TOC entries for seeking as Big-Endian integral.
+    #                       From size per table entry and number of entries,
+    #                       you can calculate the length of this field.
+    class VbriHeader
+      HEADER_SIZE = 32
+      HEADER_FORMAT = 'A4x6NN'
+
+      attr_reader :frames_count, :bytes_count
+
+      def initialize(file_io, offset = 0)
+        file_io.seek(offset)
+        @id, @bytes_count, @frames_count = file_io.read(HEADER_SIZE)&.unpack(HEADER_FORMAT)
+      end
+
+      def valid?
+        @id == 'VBRI'
+      end
+    end
+  end
+end

data/lib/wahwah/mp3/xing_header.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module WahWah
+  module Mp3
+    # Xing header structure:
+    #
+    # Position                Length    Meaning
+    # 0                       4         VBR header ID in 4 ASCII chars, either 'Xing' or 'Info',
+    #                                   not NULL-terminated
+    #
+    # 4                       4         Flags which indicate what fields are present,
+    #                                   flags are combined with a logical OR. Field is mandatory.
+    #
+    #                                   0x0001 - Frames field is present
+    #                                   0x0002 - Bytes field is present
+    #                                   0x0004 - TOC field is present
+    #                                   0x0008 - Quality indicator field is present
+    #
+    # 8                       4         Number of Frames as Big-Endian 32-bit unsigned (optional)
+    #
+    # 8 or 12                 4         Number of Bytes in file as Big-Endian 32-bit unsigned (optional)
+    #
+    # 8,12 or 16              100       100 TOC entries for seeking as integral BYTE (optional)
+    #
+    # 8,12,16,108,112 or 116  4         Quality indicator as Big-Endian 32-bit unsigned
+    #                                   from 0 - best quality to 100 - worst quality (optional)
+    class XingHeader
+      attr_reader :frames_count, :bytes_count
+
+      def initialize(file_io, offset = 0)
+        file_io.seek(offset)
+
+        @id, @flags = file_io.read(8)&.unpack('A4N')
+        return unless valid?
+
+        @frames_count = @flags & 1 == 1 ? file_io.read(4).unpack('N').first : 0
+        @bytes_count = @flags & 2 == 2 ? file_io.read(4).unpack('N').first : 0
+      end
+
+      def valid?
+        %w(Xing Info).include? @id
+      end
+    end
+  end
+end