aviglitch 0.0.1 → 0.0.2

data/ChangeLog

@@ -1,3 +1,11 @@
+== 0.0.2 / 2010-05-17
+
+* Removed AviGlitch#new. Use AviGlitch#open instead of #new.
+* Added warning for a large file.
+* Changed datamosh command interface.
+* Changed the library file layout.
+* And tiny internal changes.
+
 == 0.0.1 / 2009-08-01
 
 * initial release

data/README.rdoc

@@ -8,7 +8,7 @@ AviGlitch destroys your AVI files.
 
 I can't explain why they're going to destroy their own data.
 
-See followig urls for details;
+See following urls for details;
 * vimeo http://www.vimeo.com/groups/artifacts
 * wikipedia http://en.wikipedia.org/wiki/Compression_artifact
 
@@ -22,22 +22,21 @@ See followig urls for details;
 
   require 'aviglitch'
 
-  avi = AviGlitch.new('/path/to/your.avi')
+  avi = AviGlitch.open('/path/to/your.avi')
   avi.glitch(:keyframe) do |data|
     data.gsub(/\d/, '0')
   end
-  avi.write('/path/to/broken.avi')
+  avi.output('/path/to/broken.avi')
 
-This library also includes a command tool named +datamosh+.
+This library also includes a command line tool named +datamosh+.
 It creates the keyframes removed video.
 
-  $ datamosh /path/to/your.avi /path/to/broken.avi
+  $ datamosh /path/to/your.avi -o /path/to/broken.avi
 
 == Installation
 
-  gem sources -a http://gems.github.com
-  sudo gem install ucnv-aviglitch
+  gem install aviglitch
 
 == Copyright
 
-Copyright (c) 2009 ucnv. See LICENSE for details.
+Copyright (c) 2009 - 2010 ucnv. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/datamosh

@@ -1,25 +1,51 @@
 #!/usr/bin/env ruby
 # Generate datamoshing
 
+require 'optparse'
 require 'rubygems'
 require 'aviglitch'
 
-if ARGV.size < 1 || ARGV.first == '--help'
-  puts <<-BANNER.gsub(/^\s+/, '')
-    Usage: #{File.basename $0} INPUT [OUTPUT]
-    Generate a datamoshing video from INPUT to OUTPUT (./out.avi by default).
-  BANNER
-  exit 0
-end
+output = './out.avi'
+all = false
+force = false
 
-input, output = ARGV
+opts = OptionParser.new do |opts|
+  opts.banner = "datamosh - AviGlitch's datamoshing video generator."
+  opts.define_head "Usage: #{File.basename($0)} <input> [options]"
+  opts.separator "Options:"
+  opts.on("-o", "--output [OUTPUT]", 
+    "Output the video to OUTPUT (./out.avi by default)") do |f|
+    output = f
+  end
+  opts.on("-f", "--force", "Overwrite an existing output file") do
+    force = true
+  end
+  opts.on("-a", "--all", 
+    "Remove all keyframes (It remains a first keyframe by default)") do
+    all = true
+  end
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+input = opts.parse!
+if input.empty?
+  puts opts
+  exit 1
+end
+if !force && File.exists?(output)
+  puts "!!! `#{output}' already exists. Use -f option to overwrite."
+  exit 1
+end
 
-a = AviGlitch.new input
+a = AviGlitch.open input.first
 a.glitch_with_index :keyframe do |frame, i|
-  if i == 0  # keep the first frame
+  if !all && i == 0  # keep the first frame
     frame
   else
     "\000" * frame.size
   end
 end
-a.write(output || 'out.avi')
+a.output(output)
+

data/lib/aviglitch.rb

@@ -1,5 +1,4 @@
-require 'tempfile'
-require 'fileutils'
+require 'aviglitch/base'
 require 'aviglitch/frame'
 require 'aviglitch/frames'
 
@@ -9,162 +8,35 @@ require 'aviglitch/frames'
 #
 # You can manipulate each frame, like:
 #
-#   avi = Aviglitch.new '/path/to/your.avi'
+#   avi = AviGlitch.open '/path/to/your.avi'
 #   avi.frames.each |frame|
 #     if frame.is_keyframe?
 #       frame.data = frame.data.gsub(/\d/, '0')
 #     end
 #   end
-#   avi.write '/path/to/broken.avi'
+#   avi.output '/path/to/broken.avi'
 #
 # Using the method glitch, it can be written like:
 #
-#   avi = AviGlitch.new '/path/to/your.avi'
+#   avi = AviGlitch.open '/path/to/your.avi'
 #   avi.glitch(:keyframe) do |data|
 #     data.gsub(/\d/, '0')
 #   end
-#   avi.write '/path/to/broken.avi'
+#   avi.output '/path/to/broken.avi'
 #
 #--
 # It does not support AVI2, interleave format.
 #
-class AviGlitch
+module AviGlitch
 
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
-  # AviGlitch::Frames object generated from the +file+.
-  attr_reader :frames
-  # The input file (copied tempfile).
-  attr_reader :file
-
-  ##
-  # Create a new instance of AviGlitch, open the file and 
-  # make it ready to manipulate.
-  # It requires +path+ as String or Pathname.
-  def initialize path
-    File.open(path) do |f|
-      # copy as tempfile
-      @file = Tempfile.open 'aviglitch'
-      f.rewind
-      while d = f.read(1024) do
-        @file.print d
-      end
-    end
-
-    unless AviGlitch.surely_formatted? @file
-      raise 'Unsupported file passed.'
-    end
-    @frames = Frames.new @file
-    # I believe Ruby's GC to close and remove the Tempfile..
-  end
-
-  ##
-  # Output the glitched file to +path+, and close the file.
-  def write path
-    FileUtils.cp @file.path, path
-    close
-  end
-
-  ##
-  # An explicit file close.
-  def close
-    @file.close!
-  end
-
-  ##
-  # Glitch each frame data.
-  # It is a convent method to iterate each frame.
-  #
-  # The argument +target+ takes symbols listed below:
-  # [<tt>:keyframe</tt> or <tt>:iframe</tt>]   select video key frames (aka I-frame)
-  # [<tt>:deltaframe</tt> or <tt>:pframe</tt>] select video delta frames (difference frames)
-  # [<tt>:videoframe</tt>] select both of keyframe and deltaframe
-  # [<tt>:audioframe</tt>] select audio frames
-  # [<tt>:all</tt>]        select all frames
-  #
-  # It also requires a block. In the block, you take the frame data
-  # as a String parameter.
-  # To modify the data, simply return a modified data.
-  def glitch target = :all, &block  # :yield: data
-    frames.each do |frame|
-      if valid_target? target, frame
-        frame.data = yield frame.data
-      end
-    end
-  end
-
-  ##
-  # Do glitch with index.
-  def glitch_with_index target = :all, &block  # :yield: data, index
-    i = 0
-    frames.each do |frame|
-      if valid_target? target, frame
-        frame.data = yield(frame.data, i)
-        i += 1
-      end
-    end
-  end
-
-  alias :output :write
-
-  def valid_target? target, frame # :nodoc:
-    return true if target == :all
-    begin
-      frame.send "is_#{target.to_s}?"
-    rescue
-      false
-    end
-  end
-
-  private_instance_methods :valid_target?
   class << self
-
     ##
-    # Check if the +file+ is a correctly formetted AVI file.
-    # +file+ can be String or Pathname or IO.
-    def surely_formatted? file, debug = false
-      answer = true
-      is_io = file.respond_to?(:seek)  # Probably IO.
-      file = File.open(file) unless is_io
-      begin
-        file.seek 0, IO::SEEK_END
-        eof = file.pos
-        file.rewind
-        unless file.read(4) == 'RIFF'
-          answer = false
-          warn 'RIFF sign is not found' if debug
-        end
-        len = file.read(4).unpack('V').first
-        unless len + 8 == eof
-          answer = false
-          warn 'Length info is invalid' if debug
-        end
-        unless file.read(4) == 'AVI '
-          answer = false
-          warn 'AVI sign is not found' if debug
-        end
-        while file.read(4) =~ /^(?:LIST|JUNK)$/ do
-          s = file.read(4).unpack('V').first
-          file.pos += s
-        end
-        file.pos -= 4
-        # we require idx1
-        unless file.read(4) == 'idx1'
-          answer = false
-          warn 'idx1 is not found' if debug
-        end
-        s = file.read(4).unpack('V').first
-        file.pos += s
-      rescue => err
-        warn err.message if debug
-        answer = false
-      ensure
-        file.close unless is_io
-      end
-      answer
+    # Returns AviGlitch::Base instance.
+    # It requires +path+ as String or Pathname.
+    def AviGlitch.open path
+      AviGlitch::Base.new(Pathname(path))
     end
-
-    alias :open :new
-
   end
 end

data/lib/aviglitch/base.rb

@@ -0,0 +1,170 @@
+require 'tempfile'
+require 'fileutils'
+require 'readline'
+require 'pathname'
+
+module AviGlitch
+  # Base is the object that provides interfaces mainly used.
+  # To glitch, and save file. The instance returned through AviGlitch#open.
+  #
+  class Base
+    SAFE_FRAMES_COUNT = 150000 # :nodoc:
+
+    # AviGlitch::Frames object generated from the +file+.
+    attr_reader :frames
+    # The input file (copied tempfile).
+    attr_reader :file
+
+    ##
+    # Create a new instance of AviGlitch::Base, open the file and 
+    # make it ready to manipulate.
+    # It requires +path+ as Pathname.
+    def initialize path
+      File.open(path) do |f|
+        # copy as tempfile
+        @file = Tempfile.open 'aviglitch'
+        f.rewind
+        while d = f.read(1024) do
+          @file.print d
+        end
+      end
+
+      unless AviGlitch::Base.surely_formatted? @file
+        raise 'Unsupported file passed.'
+      end
+      unless safe_frames_count? @file
+        close
+        exit
+      end
+      @frames = Frames.new @file
+      # I believe Ruby's GC to close and remove the Tempfile..
+    end
+
+    ##
+    # Output the glitched file to +path+, and close the file.
+    def output path
+      FileUtils.cp @file.path, path
+      close
+    end
+
+    ##
+    # An explicit file close.
+    def close
+      @file.close!
+    end
+
+    ##
+    # Glitch each frame data.
+    # It is a convent method to iterate each frame.
+    #
+    # The argument +target+ takes symbols listed below:
+    # [<tt>:keyframe</tt> or <tt>:iframe</tt>]   select video key frames (aka I-frame)
+    # [<tt>:deltaframe</tt> or <tt>:pframe</tt>] select video delta frames (difference frames)
+    # [<tt>:videoframe</tt>] select both of keyframe and deltaframe
+    # [<tt>:audioframe</tt>] select audio frames
+    # [<tt>:all</tt>]        select all frames
+    #
+    # It also requires a block. In the block, you take the frame data
+    # as a String parameter.
+    # To modify the data, simply return a modified data.
+    def glitch target = :all, &block  # :yield: data
+      frames.each do |frame|
+        if valid_target? target, frame
+          frame.data = yield frame.data
+        end
+      end
+    end
+
+    ##
+    # Do glitch with index.
+    def glitch_with_index target = :all, &block  # :yield: data, index
+      i = 0
+      frames.each do |frame|
+        if valid_target? target, frame
+          frame.data = yield(frame.data, i)
+          i += 1
+        end
+      end
+    end
+
+    alias :write :output
+
+    def valid_target? target, frame # :nodoc:
+      return true if target == :all
+      begin
+        frame.send "is_#{target.to_s}?"
+      rescue
+        false
+      end
+    end
+
+    def safe_frames_count? io # :nodoc:
+      r = true
+      io.pos = 12
+      while io.read(4) != 'idx1' do
+        s = io.read(4).unpack('V').first
+        io.pos += s
+      end
+      s = io.read(4).unpack('V').first
+      fc = s / 16
+      if fc >= SAFE_FRAMES_COUNT
+        trap(:INT) do
+          close
+          exit
+        end
+        m = ["WARNING: The passed file has too many frames (#{fc}).\n",
+          "It may use a large memory to process. ",
+            "We recommend to chop the movie to smaller chunks before you glitch.\n",
+            "Do you want to continue anyway? [yN] "].join('')
+          a = Readline.readline m
+          r = a == 'y'
+      end
+      r
+    end
+
+    private_instance_methods [:valid_target?, :is_safe_frames_count?]
+
+    class << self
+      ##
+      # Check if the +file+ is a correctly formetted AVI file.
+      # +file+ can be String or Pathname or IO.
+      def surely_formatted? file, debug = false
+        answer = true
+        is_io = file.respond_to?(:seek)  # Probably IO.
+        file = File.open(file) unless is_io
+        begin
+          file.seek 0, IO::SEEK_END
+          eof = file.pos
+          file.rewind
+          unless file.read(4) == 'RIFF'
+            answer = false
+            warn 'RIFF sign is not found' if debug
+          end
+          len = file.read(4).unpack('V').first
+          unless file.read(4) == 'AVI '
+            answer = false
+            warn 'AVI sign is not found' if debug
+          end
+          while file.read(4) =~ /^(?:LIST|JUNK)$/ do
+            s = file.read(4).unpack('V').first
+            file.pos += s
+          end
+          file.pos -= 4
+          # we require idx1
+          unless file.read(4) == 'idx1'
+            answer = false
+            warn 'idx1 is not found' if debug
+          end
+          s = file.read(4).unpack('V').first
+          file.pos += s
+        rescue => err
+          warn err.message if debug
+          answer = false
+        ensure
+          file.close unless is_io
+        end
+        answer
+      end
+    end
+  end
+end

data/lib/aviglitch/frame.rb

@@ -1,4 +1,4 @@
-class AviGlitch
+module AviGlitch
   
   # Frame is the struct of the frame data and meta-data.
   # You can access this class through AviGlitch::Frames.

data/lib/aviglitch/frames.rb

@@ -1,4 +1,4 @@
-class AviGlitch
+module AviGlitch
 
   # Frames provides the interface to access each frame
   # in the AVI file.

data/spec/aviglitch_spec.rb

@@ -18,28 +18,33 @@ describe AviGlitch do
 
   it 'raise an error against unsupported files' do
     lambda {
-      avi = AviGlitch.new __FILE__
+      avi = AviGlitch.open __FILE__
     }.should raise_error
   end
 
+  it 'returns AviGlitch::Base object through the method #open' do
+    avi = AviGlitch.open @in
+    avi.should be_kind_of AviGlitch::Base
+  end
+
   it 'saves the same file when nothing is changed' do
-    avi = AviGlitch.new @in
+    avi = AviGlitch.open @in
     avi.frames.each do |f|
       ;
     end
-    avi.write @out
+    avi.output @out
     FileUtils.cmp(@in, @out).should be true
 
-    avi = AviGlitch.new @in
+    avi = AviGlitch.open @in
     avi.glitch do |d|
       d
     end
-    avi.write @out
+    avi.output @out
     FileUtils.cmp(@in, @out).should be true
   end
 
   it 'can manipulate each frame' do
-    avi = AviGlitch.new @in
+    avi = AviGlitch.open @in
     f = avi.frames
     f.should be_kind_of Enumerable
     avi.frames.each do |f|
@@ -47,26 +52,26 @@ describe AviGlitch do
         f.data = f.data.gsub(/\d/, '0')
       end
     end
-    avi.write @out
-    AviGlitch.surely_formatted?(@out, true).should be true
+    avi.output @out
+    AviGlitch::Base.surely_formatted?(@out, true).should be true
   end
 
   it 'can glitch each keyframe' do
-    avi = AviGlitch.new @in
+    avi = AviGlitch.open @in
     n = 0
     avi.glitch :keyframe do |kf|
       n += 1
       kf.slice(10..kf.size)
     end
-    avi.write @out
+    avi.output @out
     i_size = File.stat(@in).size
     o_size = File.stat(@out).size
     o_size.should == i_size - (10 * n)
-    AviGlitch.surely_formatted?(@out, true).should be true
+    AviGlitch::Base.surely_formatted?(@out, true).should be true
   end
 
   it 'can glitch each keyframe with index' do
-    avi = AviGlitch.new @in
+    avi = AviGlitch.open @in
     avi.glitch_with_index :keyframe do |kf, idx|
       if idx < 25
         kf.slice(10..kf.size)
@@ -74,26 +79,26 @@ describe AviGlitch do
         kf
       end
     end
-    avi.write @out
+    avi.output @out
     i_size = File.stat(@in).size
     o_size = File.stat(@out).size
     o_size.should == i_size - (10 * 25)
-    AviGlitch.surely_formatted?(@out, true).should be true
+    AviGlitch::Base.surely_formatted?(@out, true).should be true
   end
 
   it 'can remove a frame with returning nil' do
-    avi = AviGlitch.new @in
+    avi = AviGlitch.open @in
     in_frame_size = avi.frames.size
     rem_count = 0
     avi.glitch :keyframe do |kf|
       rem_count += 1
       nil
     end
-    avi.write @out
-    AviGlitch.surely_formatted?(@out, true).should be true
+    avi.output @out
+    AviGlitch::Base.surely_formatted?(@out, true).should be true
 
     # frames length in the output file is correct
-    avi = AviGlitch.new @out
+    avi = AviGlitch.open @out
     out_frame_size = avi.frames.size
     out_frame_size.should == in_frame_size - rem_count
   end
@@ -101,9 +106,8 @@ describe AviGlitch do
   it 'has some alias methods' do
     lambda {
       avi = AviGlitch.open @in
-      avi.output @out
+      avi.write @out
     }.should_not raise_error
-    AviGlitch.surely_formatted?(@out, true).should be true
+    AviGlitch::Base.surely_formatted?(@out, true).should be true
   end
-
 end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - ucnv
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-02 00:00:00 +09:00
+date: 2010-05-17 00:00:00 +09:00
 default_executable: datamosh
 dependencies: []
 
@@ -35,10 +35,12 @@ files:
 - VERSION
 - bin/datamosh
 - lib/aviglitch.rb
+- lib/aviglitch/base.rb
 - lib/aviglitch/frame.rb
 - lib/aviglitch/frames.rb
 - spec/aviglitch_spec.rb
 - spec/files/sample.avi
+- spec/spec.opts
 - spec/spec_helper.rb
 - LICENSE
 has_rdoc: true