polly-rffmpeg 0.0.2

data/README.rdoc

@@ -0,0 +1,104 @@
+= rFFmpeg
+
+A tiny wrapper for ffmpeg
+
+== Requirements
+
+  rFFmpeg requires that you already have ffmpeg installed, obviously :)
+
+== Install
+
+  gem install polly-rffmpeg --source http://gems.github.com
+	
+== Note
+
+  Please note that this is still pretty experimental and should be viewed more as an api proposal 
+  rather than production ready.
+  However it does work so you can use it right now, if you so choose, but expect some major api 
+  changes as time goes on.
+
+== Usage
+
+  === You can use RFFmpef like so:
+  
+    require 'rubygems'
+    require 'rffmpeg'
+  
+    include RFFmpeg
+  	
+    capture_stream "/path/to/video/<filename>.<ext>" do |input_stream|
+    input_stream.seek                 "00:02:10"
+      input_stream.duration             "00:04:53"
+	
+      input_stream.output_to "/path/to/video/<filename>.<ext>" do |output_stream|
+        output_stream.resolution           "800x600"
+        output_stream.overwrite_existing   true
+      end
+    end
+		
+    RFFmpeg::run
+	
+  === or like this:
+  
+    require 'rubygems'
+    require 'rffmpeg'
+
+    include RFFmpeg  
+
+    capture_stream("/path/to/video/<filename>.<ext>").output_to("/path/to/video/<filename>.<ext>")
+		
+    RFFmpeg::run
+	
+  === or how about:
+  
+    require 'rubygems'
+    require 'rffmpeg'
+
+    include RFFmpeg
+
+    capture_stream("/path/to/video/<filename>.<ext>")
+    output_to("/path/to/video/<filename>.<ext>")
+		
+    RFFmpeg::run
+
+  === this also works:
+	
+    require 'rubygems'
+    require 'rffmpeg'
+
+    include RFFmpeg
+
+    capture_stream("/path/to/video/<filename>.<ext>").seek("00:02:10").output_to("/path/to/video/<filename>.<ext>").resolution("800x600")
+		
+    RFFmpeg::run
+    
+
+== Extending
+
+  You can extend it with your own methods if they aren't already available, or even overide the default 
+  behaviour of existing ones. Here's how you would go about it:
+
+  RFFmpeg::add_method :my_extension, :args do |args|
+    RFFmpegCommand.add args
+  end
+
+  So if you wanted to add a method for say, setting the video quantizer scale blur for example, here's
+  how you could do it:
+  
+  RFFmpeg::add_method :quantizer_scale_blur, :blur do |blur|
+    RFFmpegCommand.add "-qblur #{blur}"
+  end
+  
+  You would then call it just like any other method:
+
+  capture_stream "/path/to/video/<filename>.<ext>" do |input_stream|
+    input_stream.quantizer_scale_blur "0.5"   # Your method is now available just like any other
+                                              # library method.
+   
+    input_stream.output_to "/path/to/video/<filename>.<ext>" do |output_stream|
+      output_stream.resolution           "800x600"
+      output_stream.overwrite_existing   true
+    end
+  end
+		
+  RFFmpeg::run

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 0

data/lib/rffmpeg.rb

@@ -0,0 +1,108 @@
+require 'rffmpeg/ffmpeg_command'
+
+include FFMpegCommand
+
+module RFFmpeg
+
+  def capture_stream(*input_streams, &block)
+    yield self if block_given?
+    input_streams.each do |input_stream|
+      FFMpegCommand.add "-i #{input_stream}"
+    end
+  end
+  
+  def output_to(*output_streams, &block)
+    yield self if block_given?
+    output_streams.each do |output_stream|
+      FFMpegCommand.add "#{output_stream}"
+    end
+  end
+  
+  def self.add_method(name, *args, &block)
+    define_method name do |args|
+      yield args
+    end
+  end
+  
+  
+  # Main options
+  def overwrite_existing(overwrite)
+    FFMpegCommand.add_at("-y", 0) if overwrite
+  end
+
+  def duration(duration)
+    FFMpegCommand.add "-t #{duration}"
+  end
+
+  def file_size_limit(limit)
+    FFMpegCommand.add "-fs #{limit}"
+  end
+
+  def seek(position)
+    FFMpegCommand.add "-ss #{position}"
+  end
+
+  def offset(offset)
+    FFMpegCommand.add "-itsoffset #{offset}"
+  end
+
+  def title(title)
+    FFMpegCommand.add "-title '#{title}'"
+  end
+
+  def timestamp(timestamp)
+    FFMpegCommand.add "-timestamp #{timestamp}"
+  end
+
+  def author(author)
+    FFMpegCommand.add "-author '#{author}'"
+  end
+
+  def copyright(copyright)
+    FFMpegCommand.add "-copyright '#{copyright}'"
+  end
+
+  def comment(comment)
+    FFMpegCommand.add "-comment '#{comment}'"
+  end
+
+  def album(album)
+    FFMpegCommand.add "-album '#{album}'"
+  end
+
+  def track(track)
+    FFMpegCommand.add "-track #{track}"
+  end
+
+  def year(year)
+    FFMpegCommand.add "-year #{year}"
+  end
+
+  def logging_verbosity_level(verbosity)
+    FFMpegCommand.add "-v #{verbosity}"
+  end
+
+  def target(target)
+    FFMpegCommand.add "-target #{target}"
+  end
+
+  def frames_to_record(frames)
+    FFMpegCommand.add  "-dframes #{frames}"
+  end
+
+  def subtitle_codec(codec)
+    FFMpegCommand.add "-scodec #{codec}"
+  end
+  
+  # Video options
+  def resolution(resolution)
+    FFMpegCommand.add "-s #{resolution}"
+  end
+  
+  # Execute ffmpeg command
+  
+  def self.run
+    puts "Executing: " + FFMpegCommand.run
+    system FFMpegCommand.run
+  end
+end

data/lib/rffmpeg/ffmpeg_command.rb

@@ -0,0 +1,25 @@
+module FFMpegCommand
+  extend self
+  
+  @@commands = []
+  
+  def add(cmd)
+    @@commands << cmd
+  end
+  
+  def add_at(cmd, pos)
+    @@commands.insert(pos, cmd)
+  end
+  
+  def clear
+    @@commands.clear
+  end
+  
+  def run
+    str = "ffmpeg"
+    @@commands.each do |cmd|
+      str << " " + cmd
+    end
+    str
+  end
+end

data/spec/rffmpeg_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'rffmpeg'
+
+include RFFmpeg
+
+describe "calling a single method from the public api" do
+
+  it "should construct the corresponding ffmpeg command" do
+    FFMpegCommand.clear
+    
+	  resolution "800x600"
+	  
+    FFMpegCommand.run.should eql("ffmpeg -s 800x600")
+  end
+  
+end
+
+describe "calling several methods from the public api" do
+
+  it "should construct the corresponding ffmpeg command" do
+    FFMpegCommand.clear
+    
+	  capture_stream("some_movie.mov")
+	  seek("00:02:10")
+	  output_to("test.avi")
+	  resolution("800x600")
+	  
+    FFMpegCommand.run.should eql("ffmpeg -i some_movie.mov -ss 00:02:10 test.avi -s 800x600")
+  end
+  
+end
+
+describe "chaining methods from the public api" do
+  
+  it "should construct the corresponding ffmpeg command" do
+    FFMpegCommand.clear
+    
+    capture_stream("some_movie.mov").seek("00:02:10").output_to("test.avi").resolution("800x600")
+    
+    FFMpegCommand.run.should eql("ffmpeg -i some_movie.mov -ss 00:02:10 test.avi -s 800x600")
+  end
+end
+
+describe "using RFFmpeg with blocks" do
+  
+  it "should construct the corresponding ffmpeg command" do
+    FFMpegCommand.clear
+    
+    capture_stream "some_movie.mov" do |input_stream|
+		  input_stream.seek "00:02:10"
+
+		  input_stream.output_to "some_movie.mov" do |output_stream|
+		    output_stream.resolution "800x600"
+		  end
+		end
+		
+		FFMpegCommand.run.should eql("ffmpeg -ss 00:02:10 -s 800x600 some_movie.mov -i some_movie.mov")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rffmpeg'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: polly-rffmpeg
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Patrik Hedman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: patrik@moresale.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/rffmpeg
+- lib/rffmpeg/ffmpeg_command.rb
+- lib/rffmpeg.rb
+- spec/rffmpeg_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/polly/rffmpeg
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+