wahwah 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5677433a8471c7ed8ba480c0c7d42804e0ad3494edc88135728766b2778bc01
-  data.tar.gz: 3163af32c9dc394f8da2b538a6356c111aeb85981b33ec6c42babbe4634de1c0
+  metadata.gz: e742f50b1a22c7cbbe63ba26506803720bbc44dbfe9943ac07a32e7efe048cbe
+  data.tar.gz: 47e1352b98217e34eb3e3fb3c258695a8f7cf2a4d579ce6baaeda1216703f4e8
 SHA512:
-  metadata.gz: dc8742ff453a6f1826b2458b2daf78bdef6825dbb0ce4e208d11b5c1456ff998ab2f0ff33223393a9a2366e42fc39652930866c1316434859444f016529ad9bb
-  data.tar.gz: 1c0a2099a2df566f755f12074ce5628ebaa831d01c679509965cff9b6b950aaa6af0e0c7bd5e6dd6dd770d3868595225645a6f79a32ba5e377eeb01a2ac4cc0c
+  metadata.gz: f5450f35d5478a3a434ac0e366589edb3999b40eb1f321e53086ccd1d3d20c5542ce63ac9d8d7b380379cafd719bbc97c33d2768d585c9a2b1d71218950f1b36
+  data.tar.gz: 86a134f7ac39a2430fcc2a62756a23354aa42825bf1a97ad4b7ba6b71f42bb72c20f3dda4a884db06e77faa84517c7fe5f4004e317939bd36d4c60369067c93e

data/lib/wahwah.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
+require 'stringio'
+require 'forwardable'
+require 'zlib'
+
 require 'wahwah/version'
 require 'wahwah/errors'
 require 'wahwah/helper'
 require 'wahwah/tag_delegate'
+require 'wahwah/lazy_read'
 require 'wahwah/tag'
 
 require 'wahwah/id3/v1'

data/lib/wahwah/asf/object.rb

@@ -11,29 +11,24 @@ module WahWah
     # 8 bytes: Object size
     # variable-sized: Object data
     class Object
+      prepend LazyRead
+
       HEADER_SIZE = 24
       HEADER_FORMAT = 'a16Q<'
 
-      attr_reader :size, :guid
+      attr_reader :guid
 
-      def initialize(file_io)
-        guid_bytes, @size = file_io.read(HEADER_SIZE)&.unpack(HEADER_FORMAT)
+      def initialize
+        guid_bytes, @size = @file_io.read(HEADER_SIZE)&.unpack(HEADER_FORMAT)
         return unless valid?
 
         @size = @size - HEADER_SIZE
         @guid = Helper.byte_string_to_guid(guid_bytes)
-        @file_io = file_io
-        @position = file_io.pos
       end
 
       def valid?
         !@size.nil? && @size >= HEADER_SIZE
       end
-
-      def data
-        @file_io.seek(@position)
-        @file_io.read(size)
-      end
     end
   end
 end

data/lib/wahwah/asf_tag.rb

@@ -54,7 +54,7 @@ module WahWah
         when CONTENT_DESCRIPTION_OBJECT_GUID
           parse_content_description_object(sub_object)
         else
-          @file_io.seek(sub_object.size, IO::SEEK_CUR)
+          sub_object.skip
         end
       end
 
@@ -187,7 +187,7 @@ module WahWah
 
         return unless stream_type_guid == AUDIO_MEDIA_OBJECT_GUID
 
-        @sample_rate, bytes_per_second = object_data.read(type_specific_data_length).unpack('x4VV')
+        @sample_rate, bytes_per_second, @bit_depth = object_data.read(type_specific_data_length).unpack('x4VVx2v')
         @bitrate = (bytes_per_second * 8.0 / 1000).round
       end
 

data/lib/wahwah/flac/block.rb

@@ -3,13 +3,15 @@
 module WahWah
   module Flac
     class Block
+      prepend LazyRead
+
       HEADER_SIZE = 4
       HEADER_FORMAT = 'B*'
       BLOCK_TYPE_INDEX = %w(STREAMINFO PADDING APPLICATION SEEKTABLE VORBIS_COMMENT CUESHEET PICTURE)
 
-      attr_reader :size, :type
+      attr_reader :type
 
-      def initialize(file_io)
+      def initialize
         # Block header structure:
         #
         # Length(bit)  Meaning
@@ -30,14 +32,11 @@ module WahWah
         #
         # 24           Length (in bytes) of metadata to follow
         #              (does not include the size of the METADATA_BLOCK_HEADER)
-        header_bits = file_io.read(HEADER_SIZE).unpack(HEADER_FORMAT).first
+        header_bits = @file_io.read(HEADER_SIZE).unpack(HEADER_FORMAT).first
 
         @last_flag = header_bits[0]
         @type = BLOCK_TYPE_INDEX[header_bits[1..7].to_i(2)]
         @size = header_bits[8..-1].to_i(2)
-
-        @file_io = file_io
-        @position = file_io.pos
       end
 
       def valid?
@@ -47,11 +46,6 @@ module WahWah
       def is_last?
         @last_flag.to_i == 1
       end
-
-      def data
-        @file_io.seek(@position)
-        @file_io.read(size)
-      end
     end
   end
 end

data/lib/wahwah/flac/streaminfo_block.rb

@@ -40,11 +40,11 @@ module WahWah
         info_bits = block_data.unpack('x10B64').first
 
         @sample_rate = info_bits[0..19].to_i(2)
-        bits_per_sample = info_bits[23..27].to_i(2) + 1
+        @bit_depth = info_bits[23..27].to_i(2) + 1
         total_samples = info_bits[28..-1].to_i(2)
 
         @duration = (total_samples.to_f / @sample_rate).round if @sample_rate > 0
-        @bitrate =  @sample_rate * bits_per_sample / 1000
+        @bitrate =  @sample_rate * @bit_depth / 1000
       end
     end
   end

data/lib/wahwah/flac_tag.rb

@@ -38,9 +38,9 @@ module WahWah
         when 'VORBIS_COMMENT'
           parse_vorbis_comment(block.data)
         when 'PICTURE'
-          parse_picture_block(block.data)
+          @images_data.push(block); block.skip
         else
-          @file_io.seek(block.size, IO::SEEK_CUR)
+          block.skip
         end
       end
 
@@ -69,8 +69,8 @@ module WahWah
       # 32           The length of the picture data in bytes.
       #
       # n*8          The binary picture data.
-      def parse_picture_block(block_data)
-        block_content = StringIO.new(block_data)
+      def parse_image_data(picture_block)
+        block_content = StringIO.new(picture_block.data)
 
         type_index, mime_type_length = block_content.read(8).unpack('NN')
         mime_type = Helper.encode_to_utf8(block_content.read(mime_type_length))
@@ -78,7 +78,7 @@ module WahWah
         data_length = block_content.read(description_length + 20).unpack("#{'x' * (description_length + 16)}N").first
         data = block_content.read(data_length)
 
-        @images.push({ data: data, mime_type: mime_type, type: ID3::ImageFrameBody::TYPES[type_index] })
+        { data: data, mime_type: mime_type, type: ID3::ImageFrameBody::TYPES[type_index] }
       end
   end
 end

data/lib/wahwah/id3/frame.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'zlib'
-
 module WahWah
   module ID3
     class Frame
+      prepend LazyRead
+
       ID_MAPPING = {
         # ID3v2.2 frame id
         COM: :comment,
@@ -78,10 +78,9 @@ module WahWah
         array[15] = :data_length_indicator
       end
 
-      attr_reader :name, :value
+      attr_reader :name
 
-      def initialize(file_io, version)
-        @file_io = file_io
+      def initialize(version)
         @version = version
 
         parse_frame_header
@@ -98,8 +97,6 @@ module WahWah
           @file_io.seek(4, IO::SEEK_CUR)
           @size = @size - 4
         end
-
-        parse_body
       end
 
       def valid?
@@ -114,6 +111,13 @@ module WahWah
         @flags.include? :data_length_indicator
       end
 
+      def value
+        return unless @size > 0
+
+        content = compressed? ? Zlib.inflate(data) : data
+        frame_body = frame_body_class.new(content, @version)
+        frame_body.value
+      end
 
       private
         # ID3v2.2 frame header structure:
@@ -154,15 +158,6 @@ module WahWah
           end.compact
         end
 
-        def parse_body
-          return unless @size > 0
-          (@file_io.seek(@size, IO::SEEK_CUR); return) if @name.nil?
-
-          content = compressed? ? Zlib.inflate(@file_io.read(@size)) : @file_io.read(@size)
-          frame_body = frame_body_class.new(content, @version)
-          @value = frame_body.value
-        end
-
         def frame_body_class
           case @name
           when :comment

data/lib/wahwah/id3/v2.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
 module WahWah
   module ID3
     class V2 < Tag
@@ -22,7 +20,7 @@ module WahWah
 
           until end_of_tag? do
             frame = ID3::Frame.new(@file_io, major_version)
-            next unless frame.valid?
+            (frame.skip; next) unless frame.valid?
 
             update_attribute(frame)
           end
@@ -30,31 +28,34 @@ module WahWah
 
         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)
+            @comments.push(frame.value)
           when :image
             # Because there may be more than one image frame in each tag,
             # so push it into a array.
-            @images.push(value)
+            @images_data.push(frame); frame.skip
           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)
+            count, total_count = frame.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)
+            instance_variable_set("@#{name}", frame.value)
           end
         end
 
         def end_of_tag?
           size <= @file_io.pos || file_size <= @file_io.pos
         end
+
+        def parse_image_data(image_frame)
+          image_frame.value
+        end
     end
   end
 end

data/lib/wahwah/lazy_read.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module WahWah
+  module LazyRead
+    def self.prepended(base)
+      base.class_eval do
+        attr_reader :size
+      end
+    end
+
+    def initialize(file_io, *arg)
+      @file_io = file_io
+      super(*arg)
+      @position = @file_io.pos
+    end
+
+    def data
+      @file_io.seek(@position)
+      @file_io.read(size)
+    end
+
+    def skip
+      @file_io.seek(size, IO::SEEK_CUR)
+    end
+  end
+end

data/lib/wahwah/mp3_tag.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
 module WahWah
   class Mp3Tag < Tag
     extend TagDelegate

data/lib/wahwah/mp4/atom.rb

@@ -3,13 +3,15 @@
 module WahWah
   module Mp4
     class Atom
+      prepend LazyRead
+
       VERSIONED_ATOMS = %w(meta stsd)
       FLAGGED_ATOMS = %w(stsd)
       HEADER_SIZE = 8
       HEADER_SIZE_FIELD_SIZE = 4
       EXTENDED_HEADER_SIZE = 8
 
-      attr_reader :size, :type
+      attr_reader :type
 
       def self.find(file_io, *atom_path)
         file_io.rewind
@@ -39,25 +41,18 @@ module WahWah
       # Type:
       # A 32-bit integer that contains the type of the atom.
       # This can often be usefully treated as a four-character field with a mnemonic value .
-      def initialize(file_io)
-        @size, @type = file_io.read(HEADER_SIZE)&.unpack('Na4')
+      def initialize
+        @size, @type = @file_io.read(HEADER_SIZE)&.unpack('Na4')
         return unless valid?
 
         # If the size field of an atom is set to 1, the type field is followed by a 64-bit extended size field,
         # which contains the actual size of the atom as a 64-bit unsigned integer.
-        @size = file_io.read(EXTENDED_HEADER_SIZE).unpack('Q>').first - EXTENDED_HEADER_SIZE if @size == 1
+        @size = @file_io.read(EXTENDED_HEADER_SIZE).unpack('Q>').first - EXTENDED_HEADER_SIZE if @size == 1
 
         # If the size field of an atom is set to 0, which is allowed only for a top-level atom,
         # designates the last atom in the file and indicates that the atom extends to the end of the file.
-        @size = file_io.size if @size == 0
+        @size = @file_io.size if @size == 0
         @size = @size - HEADER_SIZE
-        @file_io = file_io
-        @position = file_io.pos
-      end
-
-      def data
-        @file_io.seek(@position)
-        @file_io.read(size)
       end
 
       def valid?

data/lib/wahwah/mp4_tag.rb

@@ -59,7 +59,7 @@ module WahWah
         # The metadata item list atom is of type ‘ilst’ and contains a number of metadata items, each of which is an atom.
         # each metadata item atom contains a Value Atom, to hold the value of the metadata item
         atom.children.each do |child_atom|
-          attribute_name = META_ATOM_MAPPING[child_atom.type]
+          attr_name = META_ATOM_MAPPING[child_atom.type]
 
           # The value of the metadata item is expressed as immediate data in a value atom.
           # The value atom starts with two fields: a type indicator, and a locale indicator.
@@ -68,27 +68,30 @@ module WahWah
           data_atom = child_atom.find('data')
           return unless data_atom.valid?
 
-          data_type, data_value = data_atom.data.unpack('Nx4a*')
-          encoded_data_value = META_ATOM_DECODE_BY_TYPE[data_type]&.call(data_value)
+          (@images_data.push(data_atom); next) if attr_name == :image
 
-          next if attribute_name.nil? || encoded_data_value.nil?
+          encoded_data_value = parse_meta_data_atom(data_atom)
+          next if attr_name.nil? || encoded_data_value.nil?
 
-          case attribute_name
-          when :image
-            @images.push(encoded_data_value)
+          case attr_name
           when :comment
             @comments.push(encoded_data_value)
           when :track, :disc
             count, total_count = encoded_data_value.unpack('x2nn')
 
-            instance_variable_set("@#{attribute_name}", count) unless count.zero?
-            instance_variable_set("@#{attribute_name}_total", total_count) unless total_count.zero?
+            instance_variable_set("@#{attr_name}", count) unless count.zero?
+            instance_variable_set("@#{attr_name}_total", total_count) unless total_count.zero?
           else
-            instance_variable_set("@#{attribute_name}", encoded_data_value)
+            instance_variable_set("@#{attr_name}", encoded_data_value)
           end
         end
       end
 
+      def parse_meta_data_atom(atom)
+        data_type, data_value = atom.data.unpack('Nx4a*')
+        META_ATOM_DECODE_BY_TYPE[data_type]&.call(data_value)
+      end
+
       def parse_mvhd_atom(atom)
         return unless atom.valid?
 
@@ -122,5 +125,9 @@ module WahWah
         @sample_rate = mp4a_atom.data.unpack('x22I>').first if mp4a_atom.valid?
         @bitrate = esds_atom.data.unpack('x26I>').first / 1000 if esds_atom.valid?
       end
+
+      def parse_image_data(image_data_atom)
+        parse_meta_data_atom(image_data_atom)
+      end
   end
 end

data/lib/wahwah/ogg/flac_tag.rb

@@ -6,7 +6,7 @@ module WahWah
       include VorbisComment
       include Flac::StreaminfoBlock
 
-      attr_reader :bitrate, :duration, :sample_rate, *COMMET_FIELD_MAPPING.values
+      attr_reader :bitrate, :duration, :sample_rate, :bit_depth, *COMMET_FIELD_MAPPING.values
 
       def initialize(identification_packet, comment_packet)
         # Identification packet structure:

data/lib/wahwah/ogg/vorbis_comment.rb

@@ -39,7 +39,7 @@ module WahWah
           comment_length = comment_content.read(4).unpack('V').first
           comment = Helper.encode_to_utf8(comment_content.read(comment_length))
           field_name, field_value = comment.split('=', 2)
-          attr_name = COMMET_FIELD_MAPPING[field_name]
+          attr_name = COMMET_FIELD_MAPPING[field_name&.upcase]
 
           field_value = field_value.to_i if %i(track disc).include? attr_name
 

data/lib/wahwah/ogg_tag.rb

@@ -24,6 +24,10 @@ module WahWah
       @bitrate ||= parse_bitrate
     end
 
+    def bit_depth
+      @bit_depth ||= parse_bit_depth
+    end
+
     private
       def packets
         @packets ||= Ogg::Packets.new(@file_io)
@@ -62,5 +66,9 @@ module WahWah
         return @tag.bitrate if @tag.respond_to? :bitrate
         ((file_size - @overhead_packets_size) * 8.0 / duration / 1000).round
       end
+
+      def parse_bit_depth
+        @tag.bit_depth if @tag.respond_to? :bit_depth
+      end
   end
 end

data/lib/wahwah/riff/chunk.rb

@@ -16,19 +16,19 @@ module WahWah
     # 4 bytes: an ASCII identifier for this particular RIFF or LIST chunk (for RIFF in the typical case, these 4 bytes describe the content of the entire file, such as "AVI " or "WAVE").
     # rest of data: subchunks.
     class Chunk
+      prepend LazyRead
+
       HEADER_SIZE = 8
       HEADER_FORMAT = 'A4V'
       HEADER_TYPE_SIZE = 4
 
       attr_reader :id, :type
 
-      def initialize(file_io)
-        @id, @size = file_io.read(HEADER_SIZE)&.unpack(HEADER_FORMAT)
+      def initialize
+        @id, @size = @file_io.read(HEADER_SIZE)&.unpack(HEADER_FORMAT)
         return unless valid?
 
-        @type = file_io.read(HEADER_TYPE_SIZE).unpack('A4').first if have_type?
-        @file_io = file_io
-        @position = file_io.pos
+        @type = @file_io.read(HEADER_TYPE_SIZE).unpack('A4').first if have_type?
       end
 
       def size
@@ -36,11 +36,6 @@ module WahWah
         have_type? ? @size - HEADER_TYPE_SIZE : @size
       end
 
-      def data
-        @file_io.seek(@position)
-        @file_io.read(size)
-      end
-
       def valid?
         !@id.empty? && !@size.nil? && @size > 0
       end

data/lib/wahwah/riff_tag.rb

@@ -69,7 +69,7 @@ module WahWah
         when 'id3', 'ID3'
           parse_id3_chunk(sub_chunk)
         else
-          @file_io.seek(sub_chunk.size, IO::SEEK_CUR)
+          sub_chunk.skip
         end
       end
 
@@ -92,13 +92,13 @@ module WahWah
       #
       # 2(little endian)   BitsPerSample 8 bits = 8, 16 bits = 16, etc.
       def parse_fmt_chunk(chunk)
-        _, @channel, @sample_rate, _, _, @bits_per_sample = chunk.data.unpack('vvVVvv')
-        @bitrate = @sample_rate * @channel * @bits_per_sample / 1000
+        _, @channel, @sample_rate, _, _, @bit_depth = chunk.data.unpack('vvVVvv')
+        @bitrate = @sample_rate * @channel * @bit_depth / 1000
       end
 
       def parse_data_chunk(chunk)
         @duration = chunk.size * 8 / (@bitrate * 1000)
-        @file_io.seek(chunk.size, IO::SEEK_CUR)
+        chunk.skip
       end
 
       def parse_list_chunk(chunk)
@@ -107,13 +107,13 @@ module WahWah
         # RIFF can be tagged with metadata in the INFO chunk.
         # And INFO chunk as a subchunk for LIST chunk.
         if chunk.type != 'INFO'
-          @file_io.seek(chunk.size, IO::SEEK_CUR)
+          chunk.skip
         else
           until list_chunk_end_position <= @file_io.pos do
             info_chunk = Riff::Chunk.new(@file_io)
 
             unless INFO_ID_MAPPING.keys.include? info_chunk.id.to_sym
-              @file_io.seek(info_chunk.size, IO::SEEK_CUR); next
+              info_chunk.skip; next
             end
 
             update_attribute(info_chunk)
@@ -126,14 +126,14 @@ module WahWah
       end
 
       def update_attribute(chunk)
-        attribute_name = INFO_ID_MAPPING[chunk.id.to_sym]
+        attr_name = INFO_ID_MAPPING[chunk.id.to_sym]
         chunk_data = Helper.encode_to_utf8(chunk.data)
 
-        case attribute_name
+        case attr_name
         when :comment
           @comments.push(chunk_data)
         else
-          instance_variable_set("@#{attribute_name}", chunk_data)
+          instance_variable_set("@#{attr_name}", chunk_data)
         end
       end
   end

data/lib/wahwah/tag.rb

@@ -3,7 +3,7 @@
 module WahWah
   class Tag
     INTEGER_ATTRIBUTES = %i(disc disc_total track track_total)
-    INSPECT_ATTRIBUTES = %i(title artist album albumartist composer track track_total genre year disc disc_total duration bitrate sample_rate)
+    INSPECT_ATTRIBUTES = %i(title artist album albumartist composer track track_total genre year disc disc_total duration bitrate sample_rate bit_depth)
 
     attr_reader(
       :title,
@@ -18,10 +18,10 @@ module WahWah
       :year,
       :disc,
       :disc_total,
-      :images,
       :duration,
       :bitrate,
       :sample_rate,
+      :bit_depth,
       :file_size
     )
 
@@ -35,7 +35,7 @@ module WahWah
       end
 
       @comments = []
-      @images = []
+      @images_data = []
 
       parse if @file_size > 0
 
@@ -45,15 +45,24 @@ module WahWah
       end
     end
 
-    def parse
-      raise WahWahNotImplementedError, 'The parse method is not implemented'
-    end
-
     def inspect
       inspect_id = ::Kernel.format '%x', (object_id * 2)
       inspect_attributes_values = INSPECT_ATTRIBUTES.map { |attr_name| "#{attr_name}=#{self.send(attr_name)}" }.join(' ')
 
       "<#{self.class.name}:0x#{inspect_id} #{inspect_attributes_values}>"
     end
+
+    def images
+      return @images_data if @images_data.empty?
+
+      @images_data.map do |data|
+        parse_image_data(data)
+      end
+    end
+
+    private
+      def parse
+        raise WahWahNotImplementedError, 'The parse method is not implemented'
+      end
   end
 end

data/lib/wahwah/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WahWah
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wahwah
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - aidewoode
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.17
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.14
 description: WahWah is an audio metadata reader ruby gem, it supports many popular
   formats including mp3(ID3 v1, v2.2, v2.3, v2.4), m4a, ogg, oga, opus, wav, flac
   and wma.
@@ -121,6 +135,7 @@ files:
 - lib/wahwah/id3/v1.rb
 - lib/wahwah/id3/v2.rb
 - lib/wahwah/id3/v2_header.rb
+- lib/wahwah/lazy_read.rb
 - lib/wahwah/mp3/mpeg_frame_header.rb
 - lib/wahwah/mp3/vbri_header.rb
 - lib/wahwah/mp3/xing_header.rb