wahwah 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02bf7083fb530d058140db0b5f5e18cf2710ba7a6ba7fed2d2978c2109764ab2
-  data.tar.gz: dc9a32191879dfda4ea08477579ec4c631be6f0829d25ad066623232cd926a15
+  metadata.gz: 7ed4753543c1ad49e2c3c274198e3bc9a4a2416ff4e8937d6d418587f777756f
+  data.tar.gz: 16079b5131d51a3ba203a859acd7c17627a34d705105234a4a15a00bd68c9eb3
 SHA512:
-  metadata.gz: 59b2cd82d8d52b273bb2abfa4085a083716fb9cb701102c0103e6ccf2a08b3909253c8bda2ffe2d423bed43a056a8aab1bd7d3c172468c6f72fa7dafc4879b56
-  data.tar.gz: 578a61f74b3eea858ba31817d8d16e663b3e7680806886e2e44fc7b4c93b09b601a5559c07326f63cc0e43a6be2c1d362e6247297679e65578e301f0f7c591ee
+  metadata.gz: bf8adc7cef79b90caa947f5997a489b7b678defac1efc64fc51e2e95c9a50453a762dcf03a8295e4036cd5c9b6bd55fbd565381ba7d1fa9fcc74008bc4013eb0
+  data.tar.gz: a09f45c83ce58685d6da2df6ebffc20883acb2ce70cf95168c6896659b98fd682d696f3c52a066b092ac92694a9c3cb92e790c08edf3d0485e4a125116fac9ed

data/lib/wahwah/helper.rb

@@ -25,13 +25,52 @@ module WahWah
       string.split(Regexp.new(('\x00' * terminator_size).b), 2)
     end
 
-    def self.file_format(file_path)
-      File.extname(file_path).downcase.delete(".")
+    def self.file_format(io)
+      if io.respond_to?(:path) && io.path && !io.path.empty?
+        file_format = file_format_from_extension io.path
+        return file_format unless file_format.nil? || file_format.empty?
+      end
+
+      file_format_from_signature io
     end
 
     def self.byte_string_to_guid(byte_string)
       guid = byte_string.unpack("NnnA*").pack("VvvA*").unpack1("H*")
       [guid[0..7], guid[8..11], guid[12..15], guid[16..19], guid[20..]].join("-").upcase
     end
+
+    def self.file_format_from_extension(file_path)
+      File.extname(file_path).downcase[1..]
+    end
+
+    def self.file_format_from_signature(io)
+      io.rewind
+      signature = io.read(16)
+
+      # Source: https://en.wikipedia.org/wiki/List_of_file_signatures
+
+      # M4A is checked for first, since MP4 files start with a chunk size -
+      # and that chunk size may incidentally match another signature.
+      # No other formats would reasonably have "ftyp" as the next for bytes.
+      return "m4a" if signature[4...12] == "ftypM4A ".b
+      # Handled separately simply because it requires two checks.
+      return "wav" if signature.start_with?("RIFF".b) && signature[8...12] == "WAVE".b
+      magic_numbers = {
+        "fLaC".b => "flac",
+        "\xFF\xFB".b => "mp3",
+        "\xFF\xF3".b => "mp3",
+        "\xFF\xF2".b => "mp3",
+        "ID3".b => "mp3",
+        "OggS".b => "ogg",
+        "\x30\x26\xB2\x75\x8E\x66\xCF\x11\xA6\xD9\x00\xAA\x00\x62\xCE\x6C".b => "wma"
+      }
+      magic_numbers.each do |expected_signature, file_format|
+        return file_format if signature.start_with? expected_signature
+      end
+
+      nil
+    end
+
+    private_class_method :file_format_from_extension, :file_format_from_signature
   end
 end

data/lib/wahwah/id3/v2_header.rb

@@ -17,7 +17,7 @@ module WahWah
       attr_reader :major_version, :size
 
       def initialize(file_io)
-        header_content = file_io.read(HEADER_SIZE)
+        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?

data/lib/wahwah/mp3_tag.rb

@@ -50,11 +50,20 @@ module WahWah
     end
 
     def parse_id3_tag
-      id3_v1_tag = ID3::V1.new(@file_io.dup)
-      id3_v2_tag = ID3::V2.new(@file_io.dup)
-
-      return id3_v2_tag if id3_v2_tag.valid?
-      id3_v1_tag if id3_v1_tag.valid?
+      @file_io.rewind
+      signature = @file_io.read(6)
+
+      if signature.start_with?("ID3".b)
+        id3_v2_tag = ID3::V2.new(@file_io)
+        id3_v2_tag if id3_v2_tag.valid?
+      elsif ["\xFF\xFB".b, "\xFF\xF3".b, "\xFF\xF2".b].include? signature[...2]
+        # It's important to only initialize an ID3v1 object as the last option,
+        # as it requires reading to the end of the file. If the file is a
+        # streaming download (using, for example, Down), that requires
+        # downloading the whole file, which is not the case with ID3v2.
+        id3_v1_tag = ID3::V1.new(@file_io.dup)
+        id3_v1_tag if id3_v1_tag.valid?
+      end
     end
 
     def parse_duration

data/lib/wahwah/ogg_tag.rb

@@ -17,6 +17,20 @@ module WahWah
       :sample_rate,
       :lyrics
 
+    # Oggs require reading to the end of the file in order to calculate their
+    # duration (as it's not stored in any header or metadata). Thus, if the
+    # IO like object supplied to WahWah is a streaming download, getting the
+    # duration would download the entire audio file, which may not be
+    # desirable. Making it lazy in this manner allows the user to avoid that.
+    def duration
+      @duration ||= parse_duration
+    end
+
+    # Requires duration to calculate, so lazy as well.
+    def bitrate
+      @bitrate ||= parse_bitrate
+    end
+
     private
 
     def packets
@@ -41,8 +55,6 @@ module WahWah
         Ogg::FlacTag.new(identification_packet, comment_packet)
       end
 
-      @duration = parse_duration
-      @bitrate = parse_bitrate
       @bit_depth = parse_bit_depth
     end
 

data/lib/wahwah/riff/chunk.rb

@@ -37,7 +37,7 @@ module WahWah
       end
 
       def valid?
-        !@id.empty? && !@size.nil? && @size > 0
+        @id && !@id.empty? && !@size.nil? && @size > 0
       end
 
       private

data/lib/wahwah/riff_tag.rb

@@ -95,6 +95,12 @@ module WahWah
     def parse_fmt_chunk(chunk)
       _, @channel, @sample_rate, _, _, @bit_depth = chunk.data.unpack("vvVVvv")
       @bitrate = @sample_rate * @channel * @bit_depth / 1000
+
+      # There is a rare situation where the data chunk is not included in the top RIFF chunk.
+      # In this case, the duration can not be got from the data chunk, some player even cannot play the file.
+      # So try to estimate the duration from the file size and bitrate.
+      # This may be inaccurate, but at least can get approximate duration.
+      @duration = (@file_size * 8) / (@bitrate * 1000).to_f if @duration.nil?
     end
 
     def parse_data_chunk(chunk)

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 bit_depth]
+    INSPECT_ATTRIBUTES = %i[title artist album albumartist composer track track_total genre year disc disc_total]
 
     attr_reader(
       :title,
@@ -26,14 +26,9 @@ module WahWah
       :file_size
     )
 
-    def initialize(file)
-      if file.is_a?(IO) || file.is_a?(StringIO)
-        @file_size = file.size
-        @file_io = file
-      else
-        @file_size = File.size(file)
-        @file_io = File.open(file)
-      end
+    def initialize(io)
+      @file_size = io.size
+      @file_io = io
 
       @comments = []
       @images_data = []
@@ -44,8 +39,6 @@ module WahWah
         value = instance_variable_get("@#{attr_name}")&.to_i
         instance_variable_set("@#{attr_name}", value)
       end
-    ensure
-      @file_io.close
     end
 
     def inspect
@@ -58,7 +51,7 @@ module WahWah
     def images
       return @images_data if @images_data.empty?
 
-      @images_data.map do |data|
+      @images ||= @images_data.map do |data|
         parse_image_data(data)
       end
     end

data/lib/wahwah/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WahWah
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/lib/wahwah.rb

@@ -60,23 +60,36 @@ module WahWah
     Mp4Tag: ["m4a"]
   }.freeze
 
-  def self.open(file_path)
-    file_path = file_path.to_path if file_path.respond_to? :to_path
-    file_path = file_path.to_str
+  def self.open(path_or_io)
+    with_io path_or_io do |io|
+      file_format = Helper.file_format io
 
-    file_format = Helper.file_format(file_path)
+      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)
+      FORMATE_MAPPING.each do |tag, formats|
+        break const_get(tag).new(io) if formats.include?(file_format)
+      end
     end
   end
 
   def self.support_formats
     FORMATE_MAPPING.values.flatten
   end
+
+  def self.with_io(path_or_io, &block)
+    path_or_io = Pathname.new path_or_io if path_or_io.respond_to? :to_str
+
+    if path_or_io.is_a? Pathname
+      raise WahWahArgumentError, "File does not exist" unless File.exist? path_or_io
+      raise WahWahArgumentError, "File is unreadable" unless File.readable? path_or_io
+      raise WahWahArgumentError, "File is empty" unless File.size(path_or_io) > 0
+
+      path_or_io.open(&block)
+    else
+
+      block.call path_or_io
+    end
+  end
+
+  private_class_method :with_io
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wahwah
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - aidewoode
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Audio metadata reader ruby gem