ID3v2.4 tag for .mp3 files: Ruby parsing library

File extension

mp3

KS implementation details

License: CC0-1.0

References

This page hosts a formal specification of ID3v2.4 tag for .mp3 files using Kaitai Struct. This specification can be automatically translated into a variety of programming languages to get a parsing library.

Usage

Runtime library

All parsing code for Ruby generated by Kaitai Struct depends on the Ruby runtime library. You have to install it before you can parse data.

The Ruby runtime library can be installed from RubyGems:

gem install kaitai-struct

Code

Parse a local file and get structure in memory:

data = Id3v24.from_file("path/to/local/file.mp3")

Or parse structure from a string of bytes:

bytes = "\x00\x01\x02..."
data = Id3v24.new(Kaitai::Struct::Stream.new(bytes))

After that, one can get various attributes from the structure by invoking getter methods like:

data.tag # => get tag

Ruby source code to parse ID3v2.4 tag for .mp3 files

id3v2_4.rb

# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild

require 'kaitai/struct/struct'

unless Gem::Version.new(Kaitai::Struct::VERSION) >= Gem::Version.new('0.9')
  raise "Incompatible Kaitai Struct Ruby API: 0.9 or later is required, but you have #{Kaitai::Struct::VERSION}"
end


##
# @see http://id3.org/id3v2.4.0-structure Source
# @see http://id3.org/id3v2.4.0-frames Source
class Id3v24 < Kaitai::Struct::Struct
  def initialize(_io, _parent = nil, _root = self)
    super(_io, _parent, _root)
    _read
  end

  def _read
    @tag = Tag.new(@_io, self, @_root)
    self
  end
  class U1beSynchsafe < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @padding = @_io.read_bits_int_be(1) != 0
      @value = @_io.read_bits_int_be(7)
      self
    end
    attr_reader :padding
    attr_reader :value
  end
  class U2beSynchsafe < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @byte0 = U1beSynchsafe.new(@_io, self, @_root)
      @byte1 = U1beSynchsafe.new(@_io, self, @_root)
      self
    end
    def value
      return @value unless @value.nil?
      @value = ((byte0.value << 7) | byte1.value)
      @value
    end
    attr_reader :byte0
    attr_reader :byte1
  end
  class Tag < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @header = Header.new(@_io, self, @_root)
      if header.flags.flag_headerex
        @header_ex = HeaderEx.new(@_io, self, @_root)
      end
      @frames = []
      i = 0
      begin
        _ = Frame.new(@_io, self, @_root)
        @frames << _
        i += 1
      end until  (((_io.pos + _.size.value) > header.size.value) || (_.is_invalid)) 
      if !(header.flags.flag_footer)
        @padding = Padding.new(@_io, self, @_root)
      end
      if header.flags.flag_footer
        @footer = Footer.new(@_io, self, @_root)
      end
      self
    end
    attr_reader :header
    attr_reader :header_ex
    attr_reader :frames
    attr_reader :padding
    attr_reader :footer
  end
  class U4beSynchsafe < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @short0 = U2beSynchsafe.new(@_io, self, @_root)
      @short1 = U2beSynchsafe.new(@_io, self, @_root)
      self
    end
    def value
      return @value unless @value.nil?
      @value = ((short0.value << 14) | short1.value)
      @value
    end
    attr_reader :short0
    attr_reader :short1
  end
  class Frame < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @id = (@_io.read_bytes(4)).force_encoding("ASCII")
      @size = U4beSynchsafe.new(@_io, self, @_root)
      @flags_status = FlagsStatus.new(@_io, self, @_root)
      @flags_format = FlagsFormat.new(@_io, self, @_root)
      @data = @_io.read_bytes(size.value)
      self
    end
    class FlagsStatus < Kaitai::Struct::Struct
      def initialize(_io, _parent = nil, _root = self)
        super(_io, _parent, _root)
        _read
      end

      def _read
        @reserved1 = @_io.read_bits_int_be(1) != 0
        @flag_discard_alter_tag = @_io.read_bits_int_be(1) != 0
        @flag_discard_alter_file = @_io.read_bits_int_be(1) != 0
        @flag_read_only = @_io.read_bits_int_be(1) != 0
        @reserved2 = @_io.read_bits_int_be(4)
        self
      end
      attr_reader :reserved1
      attr_reader :flag_discard_alter_tag
      attr_reader :flag_discard_alter_file
      attr_reader :flag_read_only
      attr_reader :reserved2
    end
    class FlagsFormat < Kaitai::Struct::Struct
      def initialize(_io, _parent = nil, _root = self)
        super(_io, _parent, _root)
        _read
      end

      def _read
        @reserved1 = @_io.read_bits_int_be(1) != 0
        @flag_grouping = @_io.read_bits_int_be(1) != 0
        @reserved2 = @_io.read_bits_int_be(2)
        @flag_compressed = @_io.read_bits_int_be(1) != 0
        @flag_encrypted = @_io.read_bits_int_be(1) != 0
        @flag_unsynchronisated = @_io.read_bits_int_be(1) != 0
        @flag_indicator = @_io.read_bits_int_be(1) != 0
        self
      end
      attr_reader :reserved1
      attr_reader :flag_grouping
      attr_reader :reserved2
      attr_reader :flag_compressed
      attr_reader :flag_encrypted
      attr_reader :flag_unsynchronisated
      attr_reader :flag_indicator
    end
    def is_invalid
      return @is_invalid unless @is_invalid.nil?
      @is_invalid = id == "\000\000\000\000"
      @is_invalid
    end
    attr_reader :id
    attr_reader :size
    attr_reader :flags_status
    attr_reader :flags_format
    attr_reader :data
  end
  class HeaderEx < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @size = U4beSynchsafe.new(@_io, self, @_root)
      @flags_ex = FlagsEx.new(@_io, self, @_root)
      @data = @_io.read_bytes((size.value - 5))
      self
    end
    class FlagsEx < Kaitai::Struct::Struct
      def initialize(_io, _parent = nil, _root = self)
        super(_io, _parent, _root)
        _read
      end

      def _read
        @reserved1 = @_io.read_bits_int_be(1) != 0
        @flag_update = @_io.read_bits_int_be(1) != 0
        @flag_crc = @_io.read_bits_int_be(1) != 0
        @flag_restrictions = @_io.read_bits_int_be(1) != 0
        @reserved2 = @_io.read_bits_int_be(4)
        self
      end
      attr_reader :reserved1
      attr_reader :flag_update
      attr_reader :flag_crc
      attr_reader :flag_restrictions
      attr_reader :reserved2
    end
    attr_reader :size
    attr_reader :flags_ex
    attr_reader :data
  end
  class Header < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @magic = @_io.read_bytes(3)
      raise Kaitai::Struct::ValidationNotEqualError.new([73, 68, 51].pack('C*'), magic, _io, "/types/header/seq/0") if not magic == [73, 68, 51].pack('C*')
      @version_major = @_io.read_u1
      @version_revision = @_io.read_u1
      @flags = Flags.new(@_io, self, @_root)
      @size = U4beSynchsafe.new(@_io, self, @_root)
      self
    end
    class Flags < Kaitai::Struct::Struct
      def initialize(_io, _parent = nil, _root = self)
        super(_io, _parent, _root)
        _read
      end

      def _read
        @flag_unsynchronization = @_io.read_bits_int_be(1) != 0
        @flag_headerex = @_io.read_bits_int_be(1) != 0
        @flag_experimental = @_io.read_bits_int_be(1) != 0
        @flag_footer = @_io.read_bits_int_be(1) != 0
        @reserved = @_io.read_bits_int_be(4)
        self
      end
      attr_reader :flag_unsynchronization
      attr_reader :flag_headerex
      attr_reader :flag_experimental
      attr_reader :flag_footer
      attr_reader :reserved
    end
    attr_reader :magic
    attr_reader :version_major
    attr_reader :version_revision
    attr_reader :flags
    attr_reader :size
  end
  class Padding < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @padding = @_io.read_bytes((_root.tag.header.size.value - _io.pos))
      self
    end
    attr_reader :padding
  end
  class Footer < Kaitai::Struct::Struct
    def initialize(_io, _parent = nil, _root = self)
      super(_io, _parent, _root)
      _read
    end

    def _read
      @magic = @_io.read_bytes(3)
      raise Kaitai::Struct::ValidationNotEqualError.new([51, 68, 73].pack('C*'), magic, _io, "/types/footer/seq/0") if not magic == [51, 68, 73].pack('C*')
      @version_major = @_io.read_u1
      @version_revision = @_io.read_u1
      @flags = Flags.new(@_io, self, @_root)
      @size = U4beSynchsafe.new(@_io, self, @_root)
      self
    end
    class Flags < Kaitai::Struct::Struct
      def initialize(_io, _parent = nil, _root = self)
        super(_io, _parent, _root)
        _read
      end

      def _read
        @flag_unsynchronization = @_io.read_bits_int_be(1) != 0
        @flag_headerex = @_io.read_bits_int_be(1) != 0
        @flag_experimental = @_io.read_bits_int_be(1) != 0
        @flag_footer = @_io.read_bits_int_be(1) != 0
        @reserved = @_io.read_bits_int_be(4)
        self
      end
      attr_reader :flag_unsynchronization
      attr_reader :flag_headerex
      attr_reader :flag_experimental
      attr_reader :flag_footer
      attr_reader :reserved
    end
    attr_reader :magic
    attr_reader :version_major
    attr_reader :version_revision
    attr_reader :flags
    attr_reader :size
  end
  attr_reader :tag
end