format_parser 2.3.0 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 513e379194ef145016aa1c34de9065ffb99d35b5cd8bcf65e43b3941d1ca92a2
-  data.tar.gz: e05007b688350e716f381be9f7aae6721b89a4de7daef858f25973e826c12fac
+  metadata.gz: 7ed2f3d1a503aee2a0b68f00dfae5253fa88cb9ab95b61066642749785542c06
+  data.tar.gz: 3cac7120ef119969273568714fa3f75c07e3493bd80c18b89e4a7ac93efbc9dd
 SHA512:
-  metadata.gz: 8823d7eea23e201b59b31059f36626bc44d761b5b92dae26eb2ce3243041cd8b6fbdc61d964174bd89243138124f597e89c3e2473e697f55294643253a3165c7
-  data.tar.gz: 777257aafb666788c0dceadd748977ef3dc381e91225d48cc6c882db5d921b6608397dd59651cce1b5b13e1fb263c9f429cd2fbff0f896543777187c15a97cdb
+  metadata.gz: 311393234d4bc595a81169dcfa658b872c539179fba29149d7794df64d388ebbad7e1bdbf8f963018b438c3ad0a350a1f23f47fd1a383a0d50d6897f429c727c
+  data.tar.gz: e73d90e24cef65d936eebd0765403b3d83e52fdb6bf3640bfabba2afd2b059d4a85a1010fca6ff575e6e0ff84e003cc75fa1bb4a8cb2adbff0c1fb55e97161d1

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 2.4.3
+* Improve resiliency in ISOBMFF parsing to missing mandatory boxes and fields.
+* Simplify ISOBMFF frame rate calculations.
+* Refactor.
+
+## 2.4.2 (yanked)
+* Added support for PDF 2.0
+* Expanded test coverage for PDF parsing
+
+## 2.4.1 (yanked)
+* Revert change where variable frame rates in MOV and MP4 files would result in an array value for `frame_rate`.
+
+## 2.4.0 (yanked)
+* Adapt the ISOBMFF based decoder for parsing MOV and MP4 parsing.
+* Fix MOV/MP4 issues:
+  * MP4 files being misidentified as MOV files.
+  * Dimensions being miscalculated when files include multiple tracks or transformations.
+
 ## 2.3.0
 * Add support for `RW2` files.
 

data/README.md

@@ -28,6 +28,10 @@ and [dimensions,](https://github.com/sstephenson/dimensions) borrowing from them
 * JPEG
 * M3U
 * M4A
+* M4B
+* M4P
+* M4R
+* M4V
 * MOV
 * MP3
 * MP4
@@ -195,16 +199,15 @@ Unless specified otherwise in this section the fixture files are MIT licensed an
 ### M3U
 - The M3U fixture files were created by one of the project maintainers
 
-### M4A
-- fixture.m4a was created by one of the project maintainers and is MIT licensed
-
-### MOOV
-- bmff.mp4 is borrowed from the [bmff](https://github.com/zuku/bmff) project
-- Test_Circular MOV files were created by one of the project maintainers and are MIT licensed
+### MOV
+- Fixtures were downloaded from https://pixabay.com/ (with some modifications) and are subject to the [Pixabay Licence](https://pixabay.com/service/license/). 
 
 ### MP3
 - Cassy.mp3 has been produced by WeTransfer and may be used with the library for the purposes of testing
 
+### MP4
+- Fixtures were downloaded from https://pixabay.com/ (with some modifications) and are subject to the [Pixabay Licence](https://pixabay.com/service/license/). 
+
 ### MPEG
 - The files (video 1 to 4) were downloaded from https://standaloneinstaller.com/blog/big-list-of-sample-videos-for-testers-124.html.
 - Video 5 was downloaded from https://archive.org/details/ligouHDR-HC1_sample1.
@@ -215,6 +218,10 @@ Unless specified otherwise in this section the fixture files are MIT licensed an
 ### OGG
 - `hi.ogg`,  `vorbis.ogg`, `with_confusing_magic_string.ogg`, `with_garbage_at_the_end.ogg` have been generated by the project contributors
 
+### PDF
+- PDF 2.0 files downloaded from the [PDF Association public Github repository](https://github.com/pdf-association/pdf20examples). These files are licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.
+- Lorem Ipsum PDF files created at WeTransfer for this project.
+
 ### PNG
 - `simulator_screenie.png` provided by [Rens Verhoeven](https://github.com/renssies)
 

data/format_parser.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'exifr', '>= 1.3.8'
   spec.add_dependency 'id3tag', '>= 0.14.2'
+  spec.add_dependency 'matrix'
   spec.add_dependency 'measurometer'
 
   spec.add_development_dependency 'parallel_tests'

data/lib/format_parser/version.rb

@@ -1,3 +1,3 @@
 module FormatParser
-  VERSION = '2.3.0'
+  VERSION = '2.4.3'
 end

data/lib/io_utils.rb

@@ -1,4 +1,11 @@
 module FormatParser::IOUtils
+  INTEGER_DIRECTIVES = {
+    1 => 'C',
+    2 => 'S',
+    4 => 'L',
+    8 => 'Q'
+  }
+
   class InvalidRead < ArgumentError
   end
 
@@ -26,41 +33,19 @@ module FormatParser::IOUtils
     nil
   end
 
-  def read_int_8
-    read_bytes(1).unpack('C').first
-  end
-
-  def read_int_16
-    read_bytes(2).unpack('n').first
-  end
-
-  def read_int_32
-    read_bytes(4).unpack('N').first
-  end
-
-  def read_int_64
-    read_bytes(8).unpack('Q>').first
-  end
-
-  def read_little_endian_int_16
-    read_bytes(2).unpack('v').first
-  end
-
-  def read_little_endian_int_32
-    read_bytes(4).unpack('V').first
-  end
-
-  def read_fixed_point_16
-    read_bytes(2).unpack('C2')
-  end
-
-  def read_fixed_point_32
-    read_bytes(4).unpack('n2')
+  # Read an integer.
+  # @param [Integer] n Number of bytes. Defaults to 4 (32-bit).
+  # @param [Boolean] signed Signed if true, Unsigned if false. Defaults to false. (unsigned)
+  # @param [Boolean] big_endian Big-endian if true, little-endian if false. Defaults to true (big-endian).
+  def read_int(n: 4, signed: false, big_endian: true)
+    directive = INTEGER_DIRECTIVES[n]
+    directive.downcase! if signed
+    directive += (big_endian ? ">" : "<") if n > 1
+    read_bytes(n).unpack(directive).first
   end
 
-  def read_fixed_point_32_2_30
-    n = read_int_32
-    [n >> 30, n & 0x3fffffff]
+  def read_fixed_point(fractional_digits: 16, **kwargs)
+    read_int(**kwargs) / 2.0**fractional_digits
   end
 
   # 'n' is the number of bytes to read

data/lib/parsers/cr3_parser/decoder.rb

@@ -5,7 +5,7 @@ class FormatParser::CR3Parser::Decoder < FormatParser::ISOBaseMediaFileFormat::D
 
   protected
 
-  ATOM_PARSERS = ATOM_PARSERS.merge({
+  BOX_PARSERS = BOX_PARSERS.merge({
     'CMT1' => :cmt1
   })
   CANON_METADATA_CONTAINER_UUID = '85c0b687820f11e08111f4ce462b6a48'
@@ -26,7 +26,7 @@ class FormatParser::CR3Parser::Decoder < FormatParser::ISOBaseMediaFileFormat::D
     usertype = read_bytes(16).unpack('H*').first
     fields = { usertype: usertype }
     children = if usertype == CANON_METADATA_CONTAINER_UUID
-      build_atom_tree(size - 16)
+      build_box_tree(size - 16)
     else
       skip_bytes(size - 16)
     end

data/lib/parsers/cr3_parser.rb

@@ -14,15 +14,17 @@ class FormatParser::CR3Parser
 
     return unless matches_cr3_definition?
 
-    atom_tree = Decoder.new.build_atom_tree(0xffffffff, @buf)
-    moov_atom = atom_tree.find { |atom| atom.type == 'moov' }
-    cmt1_atom = moov_atom&.find_first_descendent(['CMT1'])
-    return unless cmt1_atom
-
-    width = cmt1_atom.fields[:image_width]
-    height = cmt1_atom.fields[:image_length]
-    rotated = cmt1_atom.fields[:rotated]
-    orientation = cmt1_atom.fields[:orientation_sym]
+    box_tree = Measurometer.instrument('format_parser.cr3_parser.decoder.build_box_tree') do
+      Decoder.new.build_box_tree(0xffffffff, @buf)
+    end
+    moov_box = box_tree.find { |box| box.type == 'moov' }
+    cmt1_box = moov_box&.first_descendent('CMT1')
+    return unless cmt1_box
+
+    width = cmt1_box.fields[:image_width]
+    height = cmt1_box.fields[:image_length]
+    rotated = cmt1_box.fields[:rotated]
+    orientation = cmt1_box.fields[:orientation_sym]
     FormatParser::Image.new(
       format: :cr3,
       content_type: CR3_MIME_TYPE,
@@ -32,8 +34,8 @@ class FormatParser::CR3Parser
       display_width_px: rotated ? height : width,
       display_height_px: rotated ? width : height,
       intrinsics: {
-        atom_tree: atom_tree,
-        exif: cmt1_atom.fields,
+        box_tree: box_tree,
+        exif: cmt1_box.fields,
       },
     )
   end

data/lib/parsers/heif_parser.rb

@@ -121,7 +121,7 @@ class FormatParser::HEIFParser
   end
 
   def scan_file_type_box
-    file_type_box_length = read_int_32
+    file_type_box_length = read_int
     return unless read_string(4) == FILE_TYPE_BOX_MARKER
     @major_brand = read_string(4)
     return unless @major_brand == HEIF_MARKER || @major_brand == MIF1_MARKER
@@ -138,7 +138,7 @@ class FormatParser::HEIFParser
   end
 
   def scan_meta_level_box
-    metadata_length = read_int_32
+    metadata_length = read_int
     return unless read_string(4) == META_BOX_MARKER
     @metadata_start_pos = @buf.pos
     @metadata_end_pos = @buf.pos + metadata_length - HEADER_LENGTH # the real data is always without the 8 initial bytes of the handler
@@ -146,7 +146,7 @@ class FormatParser::HEIFParser
 
     # we are looking for box/containers right beneath the Meta box
     # we start with the HDLR (Handler) box..
-    handler_length = read_int_32
+    handler_length = read_int
     return unless read_string(4) == HANDLER_MARKER
     handler_length -= HEADER_LENGTH # subtract the header as usual (will not be mentioned anymore from now on)
     handler_start = @buf.pos
@@ -158,7 +158,7 @@ class FormatParser::HEIFParser
     @buf.seek(handler_start + handler_length) # the remaining part is reserved
 
     # ..continue looking for the IINF box and especially for the IPRP box, containing info about the image itself
-    next_box_length = read_int_32
+    next_box_length = read_int
     next_box = read_string(4)
     next_box_start_pos = @buf.pos
     while @buf.pos < @metadata_end_pos # we iterate over all next incoming boxed but without going outside the meta-box
@@ -178,25 +178,25 @@ class FormatParser::HEIFParser
   end
 
   def read_item_info_box
-    version = read_int_8
+    version = read_int(n: 1)
     skip_bytes(3) # 0 flags
     entry_count = if version == 0
-      read_int_16
+      read_int(n: 2)
     else
-      read_int_32
+      read_int
     end
     @sub_items = []
     entry_count.times {
-      item_info_entry_length = read_int_32
+      item_info_entry_length = read_int
       return unless read_string(4) == ITEM_INFO_ENTRY
       item_info_end_pos = @buf.pos + item_info_entry_length - HEADER_LENGTH
-      version = read_int_8
+      version = read_int(n: 1)
       skip_bytes(3) # 0 flags
       case version
       when 2
-        item_id = read_int_16
+        item_id = read_int(n: 2)
       when 3
-        item_id = read_int_32
+        item_id = read_int
       else
         return # wrong version according to standards, hence return
       end
@@ -217,12 +217,12 @@ class FormatParser::HEIFParser
   end
 
   def read_primary_item_box
-    version = read_int_8
+    version = read_int(n: 1)
     skip_bytes(3) # flags, always 0 in this current box
     @primary_item_id = if version == 0
-      read_int_16
+      read_int(n: 2)
     else
-      read_int_32
+      read_int
     end
   end
 
@@ -232,17 +232,17 @@ class FormatParser::HEIFParser
   # and in order to output relevant data from the format_parser we need all the properties associated to the primary_item.
   # Hence the need of the association between an item and its properties, found in the ITEM_PROPERTIES_ASSOCIATION_BOX
   def read_item_properties_box
-    ipco_length = read_int_32
+    ipco_length = read_int
     return unless read_string(4) == ITEM_PROPERTIES_CONTAINER_BOX
     read_item_properties_container_box(ipco_length)
-    read_int_32 # ipma_length
+    read_int # ipma_length
     return unless read_string(4) == ITEM_PROPERTIES_ASSOCIATION_BOX
     read_item_properties_association_box
   end
 
   def read_item_properties_container_box(box_length)
     end_of_ipco_box = @buf.pos + box_length - HEADER_LENGTH
-    item_prop_length = read_int_32
+    item_prop_length = read_int
     item_prop_name = read_string(4)
     item_prop_start_pos = @buf.pos
     item_prop_index = 1
@@ -250,16 +250,16 @@ class FormatParser::HEIFParser
       case item_prop_name
       when IMAGE_SPATIAL_EXTENTS_BOX
         read_nil_version_and_flag
-        width = read_int_32
-        height = read_int_32
+        width = read_int
+        height = read_int
         @item_props[item_prop_index] = {
           type: IMAGE_SPATIAL_EXTENTS_BOX,
           width: width,
           height: height
         }
       when PIXEL_ASPECT_RATIO_BOX
-        h_spacing = read_int_32
-        v_spacing = read_int_32
+        h_spacing = read_int
+        v_spacing = read_int
         pixel_aspect_ratio = "#{h_spacing}/#{v_spacing}"
         @item_props[item_prop_index] = {
           type: PIXEL_ASPECT_RATIO_BOX,
@@ -267,9 +267,9 @@ class FormatParser::HEIFParser
         }
       when COLOUR_INFO_BOX
         colour_info = {
-          colour_primaries: read_int_16,
-          transfer_characteristics: read_int_16,
-          matrix_coefficients: read_int_16
+          colour_primaries: read_int(n: 2),
+          transfer_characteristics: read_int(n: 2),
+          matrix_coefficients: read_int(n: 2)
         }
         @item_props[item_prop_index] = {
           type: COLOUR_INFO_BOX,
@@ -278,12 +278,12 @@ class FormatParser::HEIFParser
       when PIXEL_INFO_BOX
         pixel_info = []
         read_nil_version_and_flag
-        num_channels = read_int_8
+        num_channels = read_int(n: 1)
         channel = 1
         while channel <= num_channels
           channel += 1
           pixel_info << {
-            "bits_in_channel_#{channel}": read_int_8
+            "bits_in_channel_#{channel}": read_int(n: 1)
           }
         end
         @item_props[item_prop_index] = {
@@ -292,8 +292,8 @@ class FormatParser::HEIFParser
         }
       when RELATIVE_LOCATION_BOX
         read_nil_version_and_flag
-        horizontal_offset = read_int_32
-        vertical_offset = read_int_32
+        horizontal_offset = read_int
+        vertical_offset = read_int
         @item_props[item_prop_index] = {
           type: RELATIVE_LOCATION_BOX,
           horizontal_offset: horizontal_offset,
@@ -302,14 +302,14 @@ class FormatParser::HEIFParser
       when CLEAN_APERTURE_BOX
         clean_aperture = []
         clean_aperture << {
-          clean_aperture_width_n: read_int_32,
-          clean_aperture_width_d: read_int_32,
-          clean_aperture_height_n: read_int_32,
-          clean_aperture_height_d: read_int_32,
-          horiz_off_n: read_int_32,
-          horiz_off_d: read_int_32,
-          vert_off_n: read_int_32,
-          vert_off_d: read_int_32
+          clean_aperture_width_n: read_int,
+          clean_aperture_width_d: read_int,
+          clean_aperture_height_n: read_int,
+          clean_aperture_height_d: read_int,
+          horiz_off_n: read_int,
+          horiz_off_d: read_int,
+          vert_off_n: read_int,
+          vert_off_d: read_int
         }
         @item_props[item_prop_index] = {
           type: CLEAN_APERTURE_BOX,
@@ -317,7 +317,7 @@ class FormatParser::HEIFParser
         }
       when IMAGE_ROTATION_BOX
         read_nil_version_and_flag
-        binary = convert_byte_to_binary(read_int_8)
+        binary = convert_byte_to_binary(read_int(n: 1))
         # we need only the last 2 bits to retrieve the angle multiplier. angle multiplier * 90 specifies the angle
         rotation = binary.slice(6, 2).join.to_i(2) * 90
         @item_props[item_prop_index] = {
@@ -331,24 +331,24 @@ class FormatParser::HEIFParser
   end
 
   def read_item_properties_association_box
-    version = read_int_8
+    version = read_int(n: 1)
     skip_bytes(2) # we skip the first 2 bytes of the flags (total of 3 bytes) cause we care only about the least significant bit
-    flags = read_int_8
-    entry_count = read_int_32
+    flags = read_int(n: 1)
+    entry_count = read_int
     item_id = 0
     entry_count.times do
       item_id = if version == 0
-        read_int_16
+        read_int(n: 2)
       else
-        read_int_32
+        read_int
       end
 
-      association_count = read_int_8
+      association_count = read_int(n: 1)
       association_count.times do
         # we need to retrieve the "essential" bit wich is just the first bit in the next byte
-        binary = convert_byte_to_binary(read_int_8)
+        binary = convert_byte_to_binary(read_int(n: 1))
         # essential_bit = binary[0] # uncomment if needed
-        binary.concat(convert_byte_to_binary(read_int_8)) if (flags & 1) == 1 # if flag is 1 we need the next 15 bits instead of only the next 7 bits
+        binary.concat(convert_byte_to_binary(read_int(n: 1))) if (flags & 1) == 1 # if flag is 1 we need the next 15 bits instead of only the next 7 bits
         # we need to nullify the 1st bit since that one was the essential bit and doesn't count now to calculate the property index
         binary[0] = 0
         item_property_index = binary.join.to_i(2)
@@ -401,7 +401,7 @@ class FormatParser::HEIFParser
     skip_pos = box_start_pos + box_length - HEADER_LENGTH
     @buf.seek(skip_pos)
     return if skip_pos >= end_pos_upper_box
-    next_box_length = read_int_32
+    next_box_length = read_int
     next_box_name = read_string(4)
     [next_box_length, next_box_name, @buf.pos]
   end

data/lib/parsers/iso_base_media_file_format/box.rb

@@ -0,0 +1,80 @@
+module FormatParser
+  module ISOBaseMediaFileFormat
+    class Box < Struct.new(:type, :position, :size, :fields, :children)
+      def initialize(*args)
+        super
+        self.fields ||= {}
+        self.children ||= []
+      end
+
+      # Return all children with one of the given type(s).
+      #
+      # @param [Array<String>] types The box type(s) to search for.
+      # @return [Array<Box>]
+      def all_children(*types)
+        children.select { |child| types.include?(child.type) }
+      end
+
+      # Returns true if there are one or more children with the given type.
+      #
+      # @param [String] type The box type to search for.
+      # @return [Boolean]
+      def child?(type)
+        children.any? { |child| child.type == type }
+      end
+
+      # Return the first child with one of the given types.
+      #
+      # @param [Array<String>] types The box type(s) to search for.
+      # @return [Box, nil]
+      def first_child(*types)
+        children.find { |child| types.include?(child.type) }
+      end
+
+      # Find and return all descendents of a given type.
+      #
+      # @param [Array<String>] types The box type(s) to search for.
+      # @return [Array<Box>]
+      def all_descendents(*types)
+        children.flat_map do |child|
+          descendents = child.all_descendents(*types)
+          types.include?(child.type) ? [child] + descendents : descendents
+        end
+      end
+
+      # Find and return all descendents that exist at the given path.
+      #
+      # @param [Array<String>] path The path to search at.
+      # @return [Array<Box>]
+      def all_descendents_by_path(path)
+        return [] if path.empty?
+        next_type, *remaining_path = path
+        matching_children = all_children(next_type)
+        return matching_children if remaining_path.empty?
+        matching_children.flat_map { |child| child.all_descendents_by_path(remaining_path) }
+      end
+
+      # Find and return the first descendent (using depth-first search) of a given type.
+      #
+      # @param [Array<String>] types The box type(s) to search for.
+      # @return [Box, nil]
+      def first_descendent(*types)
+        children.each do |child|
+          return child if types.include?(child.type)
+          if (descendent = child.first_descendent(*types))
+            return descendent
+          end
+        end
+        nil
+      end
+
+      # Find and return the first descendent that exists at the given path.
+      #
+      # @param [Array<String>] path The path to search at.
+      # @return [Box, nil]
+      def first_descendent_by_path(path)
+        all_descendents_by_path(path)[0]
+      end
+    end
+  end
+end