flacinfo-rb 0.3.1 → 0.4

data/README

@@ -1,4 +1,4 @@
-:: flacinfo-rb ::
+:: FlacInfo-rb ::
 Author: Darren Kirby
 mailto:bulliver@badcomputer.org
 License: Ruby
@@ -14,7 +14,7 @@ foo = FlacInfo.new("someSong.flac")
 
 streaminfo   :: hash of STREAMINFO block metadata
 seektable    :: hash of arrays of seek points
-comment      :: array of VORBIS COMMENT block metadata 
+comment      :: array of VORBIS COMMENT block metadata
 tags         :: user-friendly hash of Vorbis comment metadata key=value pairs
 application  :: hash of APPLICATION block metadata
 padding      :: hash of PADDING block metadata
@@ -24,13 +24,19 @@ flac_file    :: hash of APPLICATION Id 0x41544348 (Flac File) metadata if presen
 
  == Public methods ==
 
-print_streaminfo  :: pretty-print streaminfo hash
+comment_add       :: adds a comment
+comment_del       :: deletes a comment
 hastag('str')     :: returns true if tags['str'] exists
-print_tags        :: pretty-print tags hash
-print_seektable   :: pretty-print seektable hash
 meta_flac         :: prints all META BLOCKS. (Mostly) equivelant to 'metaflac --list'
+padding_add!(b)   :: adds a PADDING block of size 'b' or 4096 bytes
+padding_del!      :: deletes the PADDING block
+padding_resize!   :: resizes (grow or shrink) a padding block to size 'b' or 4096 bytes
+print_seektable   :: pretty-print seektable hash
+print_streaminfo  :: pretty-print streaminfo hash
+print_tags        :: pretty-print tags hash
 raw_data_dump(?)  :: if passed a filename it will dump flac_file['raw_data'] to that file,
-                     otherwise it will dump it to the console (even if binary!) 
+                       otherwise it will dump it to the console (even if binary!)
+update!           :: writes comment changes to disk
 write_picture(?)  :: write image from PICTURE block(s) to optional file
 
 For more/different documentation see http://badcomputer.org/unix/code/flacinfo/

data/lib/flacinfo.rb

@@ -17,9 +17,10 @@
 # = Copyright and Disclaimer
 #
 # Copyright:: (c) 2006, 2007 Darren Kirby
-# FlacInfo is free software.
-# No warranty is provided and the author cannot accept responsibility
-# for lost or damaged files.
+#
+# FlacInfo is free software. No warranty is provided and the author
+# cannot accept responsibility for lost or damaged files.
+#
 # License:: Ruby
 # Author:: Darren Kirby (mailto:bulliver@badcomputer.org)
 # Website:: http://badcomputer.org/unix/code/flacinfo/index.bot
@@ -53,7 +54,7 @@ end
 # All attributes will be present but empty if the associated block is not present in the Flac file,
 # except for 'picture' which will have the key 'n' with the value '0'.
 # All 'offset' and 'block_size' values do not include the block header. All block headers are 4 bytes
-# no matter the type, so if you need the offset including the header, subtract 4. If you need the size 
+# no matter the type, so if you need the offset including the header, subtract 4. If you need the size
 # including the header, add 4.
 class FlacInfo
   # A list of 'standard field names' according to the Vorbis Comment specification. It is certainly
@@ -321,19 +322,15 @@ class FlacInfo
     nil
   end
 
-  # Writes changes to disk
+  # Writes Vorbis tag changes to disk
   #
   # :call-seq:
-  #   FlacInfo.update   -> bool
+  #   FlacInfo.update!   -> bool
   #
   # Returns true if write was successful, false otherwise.
   #
-  def update
-    if write_to_disk
-      return true
-    else
-      return false
-    end
+  def update!
+    write_to_disk ? true : false
   end
 
   # Adds a new comment to the comment array
@@ -342,8 +339,8 @@ class FlacInfo
   #   FlacInfo.comment_add(str)   -> bool
   #
   # 'str' must be in the form 'name=value', or 'name=' if you want to
-  # set an empty value for a particular tag.
-  # Returns 'true' if successful, false otherwise.
+  # set an empty value for a particular tag. Returns 'true' if successful,
+  # false otherwise. Remember to call 'update!' to write changes to the file.
   #
   def comment_add(name)
     if name !~ /\w=/  #  We accept 'name=' in case you want to leave the value empty
@@ -366,7 +363,8 @@ class FlacInfo
   # If 'str' is in the form 'name=value' only exact matches
   # will be deleted. If 'str' is in the form 'name' any and all
   # comments named 'name' will be deleted. Returns 'true' if a
-  # comment was deleted, false otherwise.
+  # comment was deleted, false otherwise. Remember to call 
+  # 'update!' to write changes to the file.
   #
   def comment_del(name)
     bc = Array.new(@comment)  #  We need a copy
@@ -384,6 +382,55 @@ class FlacInfo
     end
   end
 
+  # Adds a padding block
+  #
+  # :call-seq:
+  #   FlacInfo.padding_add!(size)   --> Boolean
+  #
+  # 'size' is an optional integer argument for the
+  # size of the padding block. It defaults to 4096 bytes.
+  # Returns true if successful, else false.
+  #
+  def padding_add!(size=4096)
+    @metadata_blocks.each do |type|
+      if type[0] == "padding"
+        raise FlacInfoError, "PADDING block exists. Use 'padding_resize!'"
+      end
+    end
+    build_padding_block(size) ? true : false
+  end
+
+  # Removes a padding block
+  #
+  # :call-seq:
+  #   FlacInfo.padding_del!()   --> Boolean
+  #
+  # Returns true if the padding block is
+  # successfully removed else false.
+  #
+  def padding_del!
+    remove_padding_block ? true : false
+  end
+
+  # Resizes a padding block
+  #
+  # :call-seq:
+  #   FlacInfo.padding_resize!(size)   --> Boolean
+  #
+  # 'size' is an optional integer argument for the
+  # size of the new padding block. It defaults to 4096 bytes.
+  # Returns true if successful, else false.
+  #
+  def padding_resize!(size=4096)
+    begin
+      remove_padding_block
+      build_padding_block(size)
+      true
+    rescue
+      false
+    end
+  end
+
   #--
   #  This cleans up the output when using FlacInfo in irb
   def inspect #:nodoc:
@@ -486,7 +533,7 @@ class FlacInfo
     header = @fp.read(4)
     #  First 4 bytes must be 0x66, 0x4C, 0x61, and 0x43
     if header != 'fLaC'
-      raise FlacInfoError, "#{@filename} does not appear to be a valid Flac file"
+      raise FlacInfoReadError, "#{@filename} does not appear to be a valid Flac file"
     end
 
     typetable = { 0 => "streaminfo", 1 => "padding", 2 => "application",
@@ -501,12 +548,13 @@ class FlacInfo
       #  first bit = Last-metadata-block flag
       #  bits 2-8 = BLOCK_TYPE. See typetable above
       block_header = @fp.read(1).unpack("B*")[0]
+      #puts block_header
       lastheader = block_header[0].to_i & 1
       type = sprintf("%u", "0b#{block_header[1..7]}").to_i
       @metadata_blocks << [typetable[type], type, lastheader]
 
       if type >= typetable.size
-        raise FlacInfoError, "Invalid block header type"
+        raise FlacInfoReadError, "Invalid block header type"
       end
 
       pos += 1
@@ -538,7 +586,7 @@ class FlacInfo
       end
 
     rescue
-      raise FlacInfoError, "Could not parse METADATA_BLOCK_SEEKTABLE"
+      raise FlacInfoReadError, "Could not parse METADATA_BLOCK_SEEKTABLE"
     end
   end
 
@@ -553,7 +601,7 @@ class FlacInfo
 
       @fp.seek(@cuesheet['block_size'], IO::SEEK_CUR)
     rescue
-      raise FlacInfoError, "Could not parse METADATA_BLOCK_CUESHEET"
+      raise FlacInfoReadError, "Could not parse METADATA_BLOCK_CUESHEET"
     end
   end
 
@@ -591,7 +639,7 @@ class FlacInfo
 
       @fp.seek((@picture[n]['raw_data_length']), IO::SEEK_CUR)
     rescue
-      raise FlacInfoError, "Could not parse METADATA_BLOCK_PICTURE"
+      raise FlacInfoReadError, "Could not parse METADATA_BLOCK_PICTURE"
     end
   end
 
@@ -620,7 +668,7 @@ class FlacInfo
         @application['raw_data'] = @fp.read(@application['block_size'] - 4)
       end
     rescue
-      raise FlacInfoError, "Could not parse METADATA_BLOCK_APPLICATION" 
+      raise FlacInfoReadError, "Could not parse METADATA_BLOCK_APPLICATION" 
     end
   end
 
@@ -664,7 +712,7 @@ class FlacInfo
       end
 
     rescue
-      raise FlacInfoError, "Could not parse METADATA_BLOCK_VORBIS_COMMENT"
+      raise FlacInfoReadError, "Could not parse METADATA_BLOCK_VORBIS_COMMENT"
     end
   end
 
@@ -679,7 +727,7 @@ class FlacInfo
 
       @fp.seek(@padding['block_size'], IO::SEEK_CUR)
     rescue
-      raise FlacInfoError, "Could not parse METADATA_BLOCK_PADDING"
+      raise FlacInfoReadError, "Could not parse METADATA_BLOCK_PADDING"
     end
   end
 
@@ -710,7 +758,7 @@ class FlacInfo
       #  128 bits :: MD5 signature of the unencoded audio data.
       @streaminfo['md5'] = @fp.read(16).unpack("H32")[0]
     rescue
-      raise FlacInfoError, "Could not parse METADATA_BLOCK_STREAMINFO"
+      raise FlacInfoReadError, "Could not parse METADATA_BLOCK_STREAMINFO"
     end
   end
 
@@ -725,7 +773,7 @@ class FlacInfo
       size = size - 2 - desc_length - mime_length
       @flac_file['raw_data'] = @fp.read(size)
     rescue
-      raise FlacInfoError, "Could not parse Flac File data"
+      raise FlacInfoReadError, "Could not parse Flac File data"
     end
   end
 
@@ -824,6 +872,64 @@ class FlacInfo
     flac.close
   end
 
+  # remove the padding block
+  def remove_padding_block
+    begin
+      new_last_block = @metadata_blocks[-2]
+
+      flac = File.new(@filename, "r+b")
+      flac.binmode
+
+      flac.seek((@padding['offset'] + @padding['block_size']), IO::SEEK_CUR)
+      rest_of_file = flac.read()
+
+      flac.seek((@padding['offset'] - 4), IO::SEEK_SET)
+      flac.write(rest_of_file)
+
+      nbh = build_block_header(new_last_block[1], new_last_block[4], 1)
+
+      flac.seek((new_last_block[3] - 4), IO::SEEK_SET)
+      flac.write(nbh)
+      flac.close()
+
+      parse_flac_meta_blocks  #  Parse the file again to update new values
+      true
+    rescue
+      false
+    end
+  end
+
+  def build_padding_block(size)
+    begin
+      old_last_block = @metadata_blocks[-1]
+
+      a = Array.new(size / 2, 0)
+      pbd = a.pack("v*")
+      pbh = build_block_header(1, size, 1)
+
+      flac = File.new(@filename, "r+b")
+      flac.binmode
+
+      flac.seek((old_last_block[4] + old_last_block[3]), IO::SEEK_CUR)
+      co = flac.tell
+      rest_of_file = flac.read()
+      flac.seek(co, IO::SEEK_SET)
+
+      flac.write(pbh)
+      flac.write(pbd)
+      flac.write(rest_of_file)
+      nbh = build_block_header(old_last_block[1], old_last_block[4], 0)
+
+      flac.seek((old_last_block[3] - 4), IO::SEEK_SET)
+      flac.write(nbh)
+
+      flac.close()
+      parse_flac_meta_blocks  #  Parse the file again to update new values
+      true
+    rescue
+      false
+    end
+  end
 end
 
 # If called directly from the command line, run meta_flac on each argument

data/test/test-flacinfo.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'test/unit'
+require 'flacinfo'
+
+class TestFlacInfo < Test::Unit::TestCase
+
+  def setup
+    @flac = FlacInfo.new("test.flac")
+  end
+
+  def test_streaminfo
+    assert_equal(34,     @flac.streaminfo['block_size'])
+    assert_equal(8,      @flac.streaminfo['offset'])
+    assert_equal(4096,   @flac.streaminfo['minimum_block'])
+    assert_equal(4096,   @flac.streaminfo['maximum_block'])
+    assert_equal(4454,   @flac.streaminfo['minimum_frame'])
+    assert_equal(7491,   @flac.streaminfo['maximum_frame'])
+    assert_equal(44100,  @flac.streaminfo['samplerate'])
+    assert_equal(2,      @flac.streaminfo['channels'])
+    assert_equal(16,     @flac.streaminfo['bits_per_sample'])
+    assert_equal(663552, @flac.streaminfo['total_samples'])
+    assert_equal("8cde6ba4d9b7458f1446215941ea5e1b", @flac.streaminfo['md5'])
+  end
+
+  def test_vorbis_comments
+    assert_equal(294, @flac.tags['block_size'])
+    assert_equal(46, @flac.tags['offset'])
+    assert_equal("test.flac", @flac.tags['TITLE'])
+    assert_equal("Darren Kirby", @flac.tags['ARTIST'])
+    assert_equal("No Thanks", @flac.tags['COPYRIGHT'])
+    assert_equal("Badcomputer Org.", @flac.tags['ORGANIZATION'])
+    assert_equal("A simple reference flac for the unit tests", @flac.tags['DESCRIPTION'])
+    assert_equal("Spoken Word", @flac.tags['GENRE'])
+    assert_equal("Wed Aug 15 14:28:07 2007", @flac.tags['DATE'])
+    assert_equal("IN UR COMPUTER READING UR FLACS", @flac.tags['LOCATION'])
+    assert_equal("reference libFLAC 1.2.0 20070715", @flac.tags['vendor_tag'])
+  end
+
+  def test_picture_one
+    assert_equal(2, @flac.picture["n"])
+    assert_equal(15921, @flac.picture[1]['block_size'])
+    assert_equal(344, @flac.picture[1]['offset'])
+    assert_equal("image/png", @flac.picture[1]['mime_type'])
+    assert_equal("Artist/performer", @flac.picture[1]['type_string'])
+    assert_equal(8, @flac.picture[1]['type_int'])
+    assert_equal("The author of flacinfo", @flac.picture[1]['description_string'])
+    assert_equal(0, @flac.picture[1]['n_colours'])
+    assert_equal(32, @flac.picture[1]['colour_depth'])
+    assert_equal(99, @flac.picture[1]['height'])
+    assert_equal(100, @flac.picture[1]['width'])
+    assert_equal(407, @flac.picture[1]['raw_data_offset'])
+    assert_equal(15858, @flac.picture[1]['raw_data_length'])
+  end
+
+  def test_picture_two
+    assert_equal(2, @flac.picture["n"])
+    assert_equal(22183, @flac.picture[2]['block_size'])
+    assert_equal(16269, @flac.picture[2]['offset'])
+    assert_equal("image/jpeg", @flac.picture[2]['mime_type'])
+    assert_equal("Other", @flac.picture[2]['type_string'])
+    assert_equal(0, @flac.picture[2]['type_int'])
+    assert_equal("A silly picture for the unit test", @flac.picture[2]['description_string'])
+    assert_equal(0, @flac.picture[2]['n_colours'])
+    assert_equal(24, @flac.picture[2]['colour_depth'])
+    assert_equal(353, @flac.picture[2]['height'])
+    assert_equal(507, @flac.picture[2]['width'])
+    assert_equal(16344, @flac.picture[2]['raw_data_offset'])
+    assert_equal(22108, @flac.picture[2]['raw_data_length'])
+  end
+
+  def test_padding
+    assert_equal(258,   @flac.padding['block_size'])
+    assert_equal(38456, @flac.padding['offset'])
+  end
+
+end
+

metadata

@@ -3,14 +3,14 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: flacinfo-rb
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2007-07-12 00:00:00 -06:00
-summary: Pure Ruby lib for accessing metadata (including Vorbis tags) from Flac files
+  version: "0.4"
+date: 2007-09-08 00:00:00 -06:00
+summary: Pure Ruby library for accessing metadata from Flac files
 require_paths: 
 - lib
 email: bulliver@badcomputer.org
 homepage: http://badcomputer.org/unix/code/flacinfo/
-rubyforge_project: 
+rubyforge_project: flacinfo-rb
 description: 
 autorequire: flacinfo
 default_executable: 
@@ -31,8 +31,9 @@ authors:
 files: 
 - README
 - lib/flacinfo.rb
-test_files: []
-
+test_files: 
+- test/test-flacinfo.rb
+- test/test.flac
 rdoc_options: []
 
 extra_rdoc_files: