wahwah 1.0.0 → 1.3.0

data/lib/wahwah/riff_tag.rb

@@ -17,7 +17,7 @@ module WahWah
       TRCK: :track
     }
 
-    CHANNEL_MODE_INDEX = %w(Mono Stereo)
+    CHANNEL_MODE_INDEX = %w[Mono Stereo]
 
     tag_delegate :@id3_tag,
       :title,
@@ -39,102 +39,104 @@ module WahWah
     end
 
     private
-      def parse
-        top_chunk = Riff::Chunk.new(@file_io)
-        return unless top_chunk.valid?
 
-        total_chunk_size = top_chunk.size + Riff::Chunk::HEADER_SIZE
+    def parse
+      top_chunk = Riff::Chunk.new(@file_io)
+      return unless top_chunk.valid?
 
-        # The top "RIFF" chunks include an additional field in the first four bytes of the data field.
-        # This additional field provides the form type of the field.
-        # For wav file, the value of the type field is 'WAVE'
-        return unless top_chunk.id == 'RIFF' && top_chunk.type == 'WAVE'
+      total_chunk_size = top_chunk.size + Riff::Chunk::HEADER_SIZE
 
-        until total_chunk_size <= @file_io.pos || @file_io.eof? do
-          sub_chunk = Riff::Chunk.new(@file_io)
-          parse_sub_chunk(sub_chunk)
-        end
-      end
+      # The top "RIFF" chunks include an additional field in the first four bytes of the data field.
+      # This additional field provides the form type of the field.
+      # For wav file, the value of the type field is 'WAVE'
+      return unless top_chunk.id == "RIFF" && top_chunk.type == "WAVE"
 
-      def parse_sub_chunk(sub_chunk)
-        return unless sub_chunk.valid?
-
-        case sub_chunk.id
-        when 'fmt'
-          parse_fmt_chunk(sub_chunk)
-        when 'data'
-          parse_data_chunk(sub_chunk)
-        when 'LIST'
-          parse_list_chunk(sub_chunk)
-        when 'id3', 'ID3'
-          parse_id3_chunk(sub_chunk)
-        else
-          @file_io.seek(sub_chunk.size, IO::SEEK_CUR)
-        end
+      until total_chunk_size <= @file_io.pos || @file_io.eof?
+        sub_chunk = Riff::Chunk.new(@file_io)
+        parse_sub_chunk(sub_chunk)
       end
+    end
 
-      # The fmt chunk data structure:
-      # Length             Meaning       Description
-      #
-      # 2(little endian)   AudioFormat   PCM = 1 (i.e. Linear quantization)
-      #                                  Values other than 1 indicate some
-      #                                  form of compression.
-      #
-      # 2(little endian)   NumChannels   Mono = 1, Stereo = 2, etc.
-      #
-      # 4(little endian)   SampleRate    8000, 44100, etc.
-      #
-      # 4(little endian)   ByteRate      == SampleRate * NumChannels * BitsPerSample/8
-      #
-      # 2(little endian)   BlockAlign    == NumChannels * BitsPerSample/8
-      #                                  The number of bytes for one sample including
-      #                                  all channels.
-      #
-      # 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
+    def parse_sub_chunk(sub_chunk)
+      return unless sub_chunk.valid?
+
+      case sub_chunk.id
+      when "fmt"
+        parse_fmt_chunk(sub_chunk)
+      when "data"
+        parse_data_chunk(sub_chunk)
+      when "LIST"
+        parse_list_chunk(sub_chunk)
+      when "id3", "ID3"
+        parse_id3_chunk(sub_chunk)
+      else
+        sub_chunk.skip
       end
+    end
 
-      def parse_data_chunk(chunk)
-        @duration = chunk.size * 8 / (@bitrate * 1000)
-        @file_io.seek(chunk.size, IO::SEEK_CUR)
-      end
+    # The fmt chunk data structure:
+    # Length             Meaning       Description
+    #
+    # 2(little endian)   AudioFormat   PCM = 1 (i.e. Linear quantization)
+    #                                  Values other than 1 indicate some
+    #                                  form of compression.
+    #
+    # 2(little endian)   NumChannels   Mono = 1, Stereo = 2, etc.
+    #
+    # 4(little endian)   SampleRate    8000, 44100, etc.
+    #
+    # 4(little endian)   ByteRate      == SampleRate * NumChannels * BitsPerSample/8
+    #
+    # 2(little endian)   BlockAlign    == NumChannels * BitsPerSample/8
+    #                                  The number of bytes for one sample including
+    #                                  all channels.
+    #
+    # 2(little endian)   BitsPerSample 8 bits = 8, 16 bits = 16, etc.
+    def parse_fmt_chunk(chunk)
+      _, @channel, @sample_rate, _, _, @bit_depth = chunk.data.unpack("vvVVvv")
+      @bitrate = @sample_rate * @channel * @bit_depth / 1000
+    end
 
-      def parse_list_chunk(chunk)
-        list_chunk_end_position = @file_io.pos + chunk.size
+    def parse_data_chunk(chunk)
+      @duration = chunk.size * 8 / (@bitrate * 1000).to_f
+      chunk.skip
+    end
 
-        # 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)
-        else
-          until list_chunk_end_position <= @file_io.pos do
-            info_chunk = Riff::Chunk.new(@file_io)
+    def parse_list_chunk(chunk)
+      list_chunk_end_position = @file_io.pos + chunk.size
 
-            unless INFO_ID_MAPPING.keys.include? info_chunk.id.to_sym
-              @file_io.seek(info_chunk.size, IO::SEEK_CUR); next
-            end
+      # RIFF can be tagged with metadata in the INFO chunk.
+      # And INFO chunk as a subchunk for LIST chunk.
+      if chunk.type != "INFO"
+        chunk.skip
+      else
+        until list_chunk_end_position <= @file_io.pos
+          info_chunk = Riff::Chunk.new(@file_io)
 
-            update_attribute(info_chunk)
+          unless INFO_ID_MAPPING.key? info_chunk.id.to_sym
+            info_chunk.skip
+            next
           end
+
+          update_attribute(info_chunk)
         end
       end
+    end
 
-      def parse_id3_chunk(chunk)
-        @id3_tag = ID3::V2.new(StringIO.new(chunk.data))
-      end
+    def parse_id3_chunk(chunk)
+      @id3_tag = ID3::V2.new(StringIO.new(chunk.data))
+    end
 
-      def update_attribute(chunk)
-        attribute_name = INFO_ID_MAPPING[chunk.id.to_sym]
-        chunk_data = Helper.encode_to_utf8(chunk.data)
+    def update_attribute(chunk)
+      attr_name = INFO_ID_MAPPING[chunk.id.to_sym]
+      chunk_data = Helper.encode_to_utf8(chunk.data)
 
-        case attribute_name
-        when :comment
-          @comments.push(chunk_data)
-        else
-          instance_variable_set("@#{attribute_name}", chunk_data)
-        end
+      case attr_name
+      when :comment
+        @comments.push(chunk_data)
+      else
+        instance_variable_set("@#{attr_name}", chunk_data)
       end
+    end
   end
 end

data/lib/wahwah/tag.rb

@@ -2,8 +2,8 @@
 
 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)
+    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 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
 
@@ -43,17 +43,29 @@ module WahWah
         value = instance_variable_get("@#{attr_name}")&.to_i
         instance_variable_set("@#{attr_name}", value)
       end
-    end
-
-    def parse
-      raise WahWahNotImplementedError, 'The parse method is not implemented'
+    ensure
+      @file_io.close
     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(' ')
+      inspect_id = ::Kernel.format "%x", (object_id * 2)
+      inspect_attributes_values = INSPECT_ATTRIBUTES.map { |attr_name| "#{attr_name}=#{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.3.0"
 end

data/lib/wahwah.rb

@@ -1,57 +1,62 @@
 # frozen_string_literal: true
 
-require 'wahwah/version'
-require 'wahwah/errors'
-require 'wahwah/helper'
-require 'wahwah/tag_delegate'
-require 'wahwah/tag'
-
-require 'wahwah/id3/v1'
-require 'wahwah/id3/v2'
-require 'wahwah/id3/v2_header'
-require 'wahwah/id3/frame'
-require 'wahwah/id3/frame_body'
-require 'wahwah/id3/text_frame_body'
-require 'wahwah/id3/genre_frame_body'
-require 'wahwah/id3/comment_frame_body'
-require 'wahwah/id3/image_frame_body'
-
-require 'wahwah/mp3/mpeg_frame_header'
-require 'wahwah/mp3/xing_header'
-require 'wahwah/mp3/vbri_header'
-
-require 'wahwah/riff/chunk'
-
-require 'wahwah/flac/block'
-require 'wahwah/flac/streaminfo_block'
-
-require 'wahwah/ogg/page'
-require 'wahwah/ogg/pages'
-require 'wahwah/ogg/packets'
-require 'wahwah/ogg/vorbis_comment'
-require 'wahwah/ogg/vorbis_tag'
-require 'wahwah/ogg/opus_tag'
-require 'wahwah/ogg/flac_tag'
-
-require 'wahwah/asf/object'
-
-require 'wahwah/mp4/atom'
-
-require 'wahwah/mp3_tag'
-require 'wahwah/mp4_tag'
-require 'wahwah/ogg_tag'
-require 'wahwah/riff_tag'
-require 'wahwah/asf_tag'
-require 'wahwah/flac_tag'
+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"
+require "wahwah/id3/v2"
+require "wahwah/id3/v2_header"
+require "wahwah/id3/frame"
+require "wahwah/id3/frame_body"
+require "wahwah/id3/text_frame_body"
+require "wahwah/id3/genre_frame_body"
+require "wahwah/id3/comment_frame_body"
+require "wahwah/id3/image_frame_body"
+
+require "wahwah/mp3/mpeg_frame_header"
+require "wahwah/mp3/xing_header"
+require "wahwah/mp3/vbri_header"
+
+require "wahwah/riff/chunk"
+
+require "wahwah/flac/block"
+require "wahwah/flac/streaminfo_block"
+
+require "wahwah/ogg/page"
+require "wahwah/ogg/pages"
+require "wahwah/ogg/packets"
+require "wahwah/ogg/vorbis_comment"
+require "wahwah/ogg/vorbis_tag"
+require "wahwah/ogg/opus_tag"
+require "wahwah/ogg/flac_tag"
+
+require "wahwah/asf/object"
+
+require "wahwah/mp4/atom"
+
+require "wahwah/mp3_tag"
+require "wahwah/mp4_tag"
+require "wahwah/ogg_tag"
+require "wahwah/riff_tag"
+require "wahwah/asf_tag"
+require "wahwah/flac_tag"
 
 module WahWah
   FORMATE_MAPPING = {
-    Mp3Tag: ['mp3'],
-    OggTag: ['ogg', 'oga', 'opus'],
-    RiffTag: ['wav'],
-    FlacTag: ['flac'],
-    AsfTag: ['wma'],
-    Mp4Tag: ['m4a']
+    Mp3Tag: ["mp3"],
+    OggTag: ["ogg", "oga", "opus"],
+    RiffTag: ["wav"],
+    FlacTag: ["flac"],
+    AsfTag: ["wma"],
+    Mp4Tag: ["m4a"]
   }.freeze
 
   def self.open(file_path)
@@ -60,10 +65,10 @@ module WahWah
 
     file_format = Helper.file_format(file_path)
 
-    raise WahWahArgumentError, 'File is not exists' unless File.exist? file_path
-    raise WahWahArgumentError, 'File is unreadable' unless File.readable? file_path
-    raise WahWahArgumentError, 'File is empty' unless File.size(file_path) > 0
-    raise WahWahArgumentError, 'No supported format found' unless support_formats.include? file_format
+    raise WahWahArgumentError, "File is not exists" unless File.exist? file_path
+    raise WahWahArgumentError, "File is unreadable" unless File.readable? file_path
+    raise WahWahArgumentError, "File is empty" unless File.size(file_path) > 0
+    raise WahWahArgumentError, "No supported format found" unless support_formats.include? file_format
 
     FORMATE_MAPPING.each do |tag, formats|
       break const_get(tag).new(file_path) if formats.include?(file_format)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wahwah
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - aidewoode
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,47 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.1
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.1
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.17
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.17
+        version: 0.8.0
+- !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
@@ -152,15 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Audio metadata reader ruby gem