ogginfo-rb 0.0.2

data/lib/ogginfo-rb.rb

@@ -0,0 +1,185 @@
+# Useful sites:
+# http://en.wikipedia.org/wiki/Ogg#Page_structure
+# http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-600004.2
+
+require 'stringio'
+
+module Ogg
+  class Info
+    attr_reader :comments
+    attr_reader :duration, :sample_rate, :nominal_bitrate, :channels, :bitrate
+
+    def initialize path
+      file = File.new(path.to_str, 'rb')
+
+      # Identification header
+      id_packet = Vorbis::IdentificationHeaderPacket.new(Page.find_page(file))
+      @sample_rate = id_packet.audio_sample_rate
+      @nominal_bitrate = id_packet.bitrate_nominal
+      @channels = id_packet.audio_channels
+
+      # Comment header
+      comment_packet = Vorbis::CommentHeaderPacket.new(id_packet.next_page)
+      @comments = comment_packet.comments
+
+      pos_after_headers = file.pos
+
+      begin
+        @duration = calculate_duration file
+      rescue Exception
+        @duration = 0
+      end
+
+      begin
+        @bitrate = (file.stat.size - pos_after_headers).to_f * 8 / @duration
+      rescue Exception
+        @bitrate = 0
+      end
+
+      file.close
+    end
+
+    def self.open(path)
+      info = Ogg::Info.new(path)
+      yield info if block_given?
+      return info
+    end
+
+    private
+    def calculate_duration file
+      # This seek is a dirty performance hack (saves reading whole file)
+      file.seek(-5000, IO::SEEK_END)
+      # Find last page
+      pg = page = Page.find_page(file)
+      while pg
+        page = pg
+        pg = pg.next_page
+      end
+      # Duration is last granule position divided by sample right
+      return page.granule_position.to_f / @sample_rate
+    end
+  end
+
+  class Page
+    CAPTURE = 'OggS'
+
+    attr_reader :data
+    attr_reader :segment_table, :granule_position, :page_type
+
+    def initialize file
+      @file = file
+
+      # Header
+      capture = file.read(CAPTURE.size)
+      puts "Capture is not #{CAPTURE.inspect}" unless capture == CAPTURE
+
+      version = file.read(1).unpack('C').first
+      @page_type = file.read(1).unpack('C').first
+      @granule_position = file.read(8).unpack('Q').first
+      bitstream_serial_number = file.read(4).unpack('L').first
+      page_sequence_number = file.read(4).unpack('L').first
+      checksum = file.read(4).unpack('L').first
+      page_segments = file.read(1).unpack('C').first
+      @segment_table = file.read(page_segments).unpack('C*')
+
+      # Content
+      @data = StringIO.new '', 'w+'
+      @segment_table.each do |n|
+        @data.write file.read(n)
+      end
+      @data.close_write
+      @data.rewind
+    end
+
+    def continues?
+      return @segment_table.last == 255
+    end
+
+    def next_page
+      return Page.find_page(@file)
+    end
+
+    def self.find_page file
+      buffer = file.read(CAPTURE.size)
+      while buffer != CAPTURE
+        return if file.eof?
+        buffer = buffer[1..-1] << file.read(1)
+      end
+      file.pos -= CAPTURE.size
+      return Page.new(file)
+    end
+  end
+
+  class Packet
+    attr_reader :data
+
+    def initialize page
+      @data = StringIO.new('', 'w+')
+      @data.write(page.data.read)
+      while page.continues?
+        page = page.next_page
+        @data.write(page.data.read)
+      end
+      @last_page = page
+      @data.close_write
+      @data.rewind
+    end
+
+    def next_page
+      return @last_page.next_page
+    end
+  end
+
+  module Vorbis
+    attr_reader :packet_type
+
+    class HeaderPacket < Ogg::Packet
+      def initialize page
+        super
+
+        @packet_type = @data.read(1).unpack('C').first
+        vorbis_check = @data.read(6)
+        unless vorbis_check == 'vorbis'
+          $stderr.puts "Warning: 'vorbis' string not found in header"
+        end
+      end
+    end
+
+    class IdentificationHeaderPacket < HeaderPacket
+      attr_reader :vorbis_version, :audio_channels, :audio_sample_rate
+      attr_reader :bitrate_maximum, :bitrate_nominal, :bitrate_minimum
+
+      def initialize page
+        super
+
+        @vorbis_version = @data.read(4).unpack('L').first
+        @audio_channels = @data.read(1).unpack('C').first
+        @audio_sample_rate = @data.read(4).unpack('L').first
+        @bitrate_maximum = @data.read(4).unpack('l').first
+        @bitrate_nominal = @data.read(4).unpack('l').first
+        @bitrate_minimum = @data.read(4).unpack('l').first
+        blocksizes = @data.read(1).unpack('C').first
+      end
+    end
+
+    class CommentHeaderPacket < HeaderPacket
+      attr_reader :comments, :vendor_string
+
+      def initialize page
+        super
+
+        vendor_length = @data.read(4).unpack('L').first
+        @vendor_string = @data.read(vendor_length)
+        user_comment_list_length = @data.read(4).unpack('L').first
+        @comments = {}
+
+        user_comment_list_length.times do
+          length = @data.read(4).unpack('L').first
+          comment = @data.read(length)
+          key, value = comment.split('=', 2)
+          (@comments[key.downcase] ||= []) << value
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+name: ogginfo-rb
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Aiden Nibali
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-09 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dismal.denizen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ogginfo-rb.rb
+has_rdoc: false
+homepage: http://rubyforge.org/projects/ogginfo-rb/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ogginfo-rb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A library for accessing metadata in Ogg files
+test_files: []
+