polly-ffmpeg 0.1.1

data/README.rdoc

@@ -0,0 +1,41 @@
+= FFMpeg
+
+	A DSL for building and executing ffmpeg commands.
+
+== Requirements
+
+  It requires that you already have ffmpeg installed, obviously :)
+
+== Install
+
+  gem install polly-ffmpeg --source http://gems.github.com
+
+== Usage
+	
+	To build and execute a command you would use the FFMpeg::convert method and then call the FFMpeg::run method like this:
+	
+		include FFMpeg
+	
+		convert "file.ext", :to => "new_file.ext" do
+			seek 		 "00:01:13"
+			duration "00:10:01"
+		end.run
+
+== Extending
+	
+	FFMpeg takes a lot of options, I mean alot ;), so I haven't been able to add methods for wrapping them all yet.
+	Luckily it's really easy to add your own wrapper methods, just add them to the class that's including the FFMpeg module.
+	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:
+
+		def	quantizer_scale_blur(blur)
+			FFMpegCommand << "-qblur #{blur}"
+		end
+	
+	You would then call it inside the convert block just like any other method:
+	
+		convert "file.ext", :to => "new_file.ext" do
+			quantizer_scale_blur "0.5"
+		end
+
+	If you where to add a method with the same name as one already defined in the library your method will take precedence
+	over the predefined one, a warning message informing you about the conflict will be printed out through $stderr however.

data/VERSION.yml

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

data/lib/ffmpeg/class_methods.rb

@@ -0,0 +1,18 @@
+module FFMpeg
+  module ClassMethods
+    def check_method(name)
+      print_error_message_for name if method_defined? name
+    end
+    
+    def method_defined?(name)
+      FFMpeg.instance_methods.include?(name.to_s) || FFMpeg.instance_methods.include?(name.to_sym)
+    end
+    private :method_defined?
+    
+    def print_error_message_for(name)
+      $stderr.puts "WARNING: Possible conflict with FFMpeg extension:" + 
+                   "FFMpeg##{name} already exists and will be overwritten"
+    end
+    private :print_error_message_for
+  end
+end

data/lib/ffmpeg/ffmpeg_command.rb

@@ -0,0 +1,25 @@
+module FFMpegCommand
+  extend self
+  
+  @commands = []
+  
+  def <<(cmd)
+    @commands << cmd
+  end
+  
+  def add_at(cmd, pos)
+    @commands.insert(pos, cmd)
+  end
+  
+  def clear
+    @commands.clear
+  end
+  
+  def command(prefix="")
+    returning prefix.to_s do |prefix|
+      @commands.each do |command|
+        prefix << " #{command}"
+      end
+    end
+  end
+end

data/lib/ffmpeg/helper_methods.rb

@@ -0,0 +1,8 @@
+module FFMpeg
+  module HelperMethods
+    def returning(value)
+      yield  value
+      return value
+    end
+  end
+end

data/lib/ffmpeg/main_options.rb

@@ -0,0 +1,165 @@
+module FFMpeg
+  module MainOptions
+    
+    def source(*filename)
+      FFMpegCommand << "-i #{filename}"
+    end
+    
+    def target(target)
+      FFMpegCommand << "#{target}"
+    end
+    
+    #
+    # Overwrite output file if it already exists
+    #
+    def overwrite_existing_file
+      FFMpegCommand.add_at("-y", 0)
+    end
+    
+    #
+    # Set the duration specified in seconds.
+    # hh:mm:ss[.xxx] syntax is also supported
+    #
+    #   duration "600"
+    #
+    # or
+    #
+    #   duration "00:10:00"
+    #
+    def duration(duration)
+      FFMpegCommand << "-t #{duration}"
+    end
+    
+    #
+    # Set a file size limit in bytes
+    #
+    #   file_size_limit 104_857_600
+    #
+    def file_size_limit(limit)
+      FFMpegCommand << "-fs #{limit.to_s}"
+    end
+    
+    #
+    # Seek to given time position in seconds. 
+    # hh:mm:ss[.xxx] syntax is also supported.
+    #
+    #   seek "600"
+    #
+    # or
+    #
+    #   seek "00:10:00"
+    #
+    def seek(position)
+      FFMpegCommand << "-ss #{position}"
+    end
+    
+    #
+    # Set the input time offset in seconds. 
+    # [-]hh:mm:ss[.xxx] syntax is also supported. 
+    # This option affects all the input files that follow it. 
+    # The offset is added to the timestamps of the input files. 
+    # Specifying a positive offset means that the corresponding 
+    # streams are delayed by 'offset' seconds.
+    #
+    #   offset "600"
+    #
+    # or
+    #
+    #   offset "00:10:00"
+    #
+    def offset(offset)
+      FFMpegCommand << "-itsoffset #{offset}"
+    end
+    
+    #
+    # Set the title.
+    #
+    #   title "Some Title"
+    #
+    def title(title)
+      FFMpegCommand << "-title '#{title}'"
+    end
+    
+    #
+    # Set the author.
+    #
+    #   author "PMH"
+    #
+    def author(author)
+      FFMpegCommand << "-author '#{author}'"
+    end
+    
+    #
+    # Set the copyright.
+    # 
+    #   copyright "(c) Patrik Hedman 2009"
+    #
+    def copyright(copyright)
+      FFMpegCommand << "-copyright '#{copyright}'"
+    end
+    
+    #
+    # Set the comment.
+    #
+    #   comment "Some comment"
+    #
+    def comment(comment)
+      FFMpegCommand << "-comment '#{comment}'"
+    end
+    
+    #
+    # Set the album.
+    #
+    #   album "An awesome album"
+    #
+    def album(album)
+      FFMpegCommand << "-album '#{album}'"
+    end
+    
+    #
+    # Set the track number:
+    #
+    #   track 1
+    #
+    def track(track)
+      FFMpegCommand << "-track #{track}"
+    end
+    
+    # 
+    # Set the year.
+    # 
+    #   year 1985
+    # 
+    def year(year)
+      FFMpegCommand << "-year #{year}"
+    end
+    
+    #
+    # Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd", "ntsc-svcd", ... ). 
+    # All the format options (bitrate, codecs, buffer sizes) are then set automatically.
+    # Nevertheless you can specify additional options as long as you know they do not conflict 
+    # with the standard.
+    #
+    #   target "vcd"
+    #
+    def target(target)
+      FFMpegCommand << "-target #{target}"
+    end
+    
+    #
+    # Set the number of frames to record.
+    #
+    #   frames_to_record 50
+    #
+    def frames_to_record(frames)
+      FFMpegCommand <<  "-dframes #{frames}"
+    end
+    
+    #
+    # Force subtitle codec ('copy' to copy stream)
+    #
+    def subtitle_codec(codec)
+      FFMpegCommand << "-scodec #{codec}"
+    end
+  end
+end

data/lib/ffmpeg/video_options.rb

@@ -0,0 +1,70 @@
+module FFMpeg
+  module VideoOptions
+    #
+    # Set frame size. The format is `wxh' (ffserver default = 160x128, ffmpeg default = same as source). 
+    # The following abbreviations are recognized:
+    #
+    #   'sqcif'
+    #       128x96
+    #   'qcif'
+    #       176x144
+    #   'cif'
+    #       352x288
+    #   '4cif'
+    #       704x576
+    #   'qqvga'
+    #       160x120
+    #   'qvga'
+    #       320x240
+    #   'vga'
+    #       640x480
+    #   'svga'
+    #       800x600
+    #   'xga'
+    #       1024x768
+    #   'uxga'
+    #       1600x1200
+    #   'qxga'
+    #       2048x1536
+    #   'sxga'
+    #       1280x1024
+    #   'qsxga'
+    #       2560x2048
+    #   'hsxga'
+    #       5120x4096
+    #   'wvga'
+    #       852x480
+    #   'wxga'
+    #       1366x768
+    #   'wsxga'
+    #       1600x1024
+    #   'wuxga'
+    #       1920x1200
+    #   'woxga'
+    #       2560x1600
+    #   'wqsxga'
+    #       3200x2048
+    #   'wquxga'
+    #       3840x2400
+    #   'whsxga'
+    #       6400x4096
+    #   'whuxga'
+    #       7680x4800
+    #   'cga'
+    #       320x200
+    #   'ega'
+    #       640x350
+    #   'hd480'
+    #       852x480
+    #   'hd720'
+    #       1280x720
+    #   'hd1080'
+    #       1920x1080
+    #
+    #
+    #
+    def resolution(resolution)
+      FFMpegCommand << "-s #{resolution}"
+    end
+  end
+end

data/lib/ffmpeg.rb

@@ -0,0 +1,80 @@
+require 'ffmpeg/class_methods'
+require 'ffmpeg/main_options'
+require 'ffmpeg/video_options'
+require 'ffmpeg/ffmpeg_command'
+require 'ffmpeg/helper_methods'
+
+module FFMpeg
+  include HelperMethods
+  include MainOptions
+  include VideoOptions
+  
+  #
+  # When mixed into a class, extend  
+  # it with the ClassMethods module
+  #
+  def self.included(klass)
+    klass.extend ClassMethods
+    
+    # 
+    # Everytime a method is added to the
+    # class, check for conflicts with existing
+    # module methods
+    #
+    def klass.method_added(name)
+      check_method(name) if method_checking_enabled?
+    end
+  end
+  
+  #
+  # Sets up an FFmpegCommand for converting files:
+  #
+  #  convert "file1.ext", :to => "file2.ext" do
+  #    seek       "00:03:00"
+  #    duration   "01:10:00"
+  #    resolution "800x600"
+  #  end
+  #
+  def convert(from_file, to_file = {})
+    FFMpegCommand << "-i #{from_file}"
+    FFMpegCommand << "#{to_file[:to]}" unless to_file[:to].nil?
+    begin
+      yield if block_given?
+    rescue Exception => exception
+      Thread.current[:'method checking enabled'] = true
+      raise exception
+    end
+  end
+  
+  #
+  # Runs ffmpeg
+  #
+  def run
+    execute_command FFMpegCommand.command(locate_ffmpeg)
+  end
+  
+  private
+  
+  #
+  # 
+  #
+  def method_checking_enabled?
+    !Thread.current[:'method checking enabled']
+  end
+  
+  #
+  # Tries to locate the FFmpeg executable
+  #
+  def locate_ffmpeg
+    ffmpeg_executable = %x[which ffmpeg].strip
+  end
+  
+  #
+  # Executes FFmpeg with the specified command
+  #
+  def execute_command(cmd)
+    puts "Executing: #{cmd}}"
+    %x[#{cmd}]
+    puts $?.success?
+  end
+end

data/spec/ffmpeg_spec.rb

@@ -0,0 +1,162 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "FFMpeg" do
+  before(:each) do
+    @from_file, @to_file = "~/Desktop/test.avi", "~/Desktop/test2.avi"
+    FFMpegCommand.clear
+  end
+  
+  it "should generate a valid command" do
+    convert @from_file, :to => @to_file
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file}")
+  end
+  
+  it "should generate a valid command when fed an empty block" do
+    convert(@from_file, :to => @to_file) {}
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file}")
+  end
+end
+
+describe "FFMpeg Main Options" do
+  before(:each) do
+    @from_file, @to_file = "~/Desktop/test.avi", "~/Desktop/test2.avi"
+    FFMpegCommand.clear
+  end
+  
+  it "should overwrite existing files" do
+    convert @from_file, :to => @to_file do
+      overwrite_existing_file
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -y -i #{@from_file} #{@to_file}")
+  end
+  
+  it "should set a duration" do
+    convert @from_file, :to => @to_file do
+      duration "00:03:01"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -t 00:03:01")
+  end
+  
+  it "should set a file size limit" do
+    convert @from_file, :to => @to_file do
+      file_size_limit 104_857_600
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -fs 104857600")
+  end
+  
+  it "should seek to the specified time position" do
+    convert @from_file, :to => @to_file do
+      seek "00:03:01"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -ss 00:03:01")
+  end
+  
+  it "should the input time offset" do
+    convert @from_file, :to => @to_file do
+      offset "00:03:01"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -itsoffset 00:03:01")
+  end
+  
+  it "should the title" do
+    convert @from_file, :to => @to_file do
+      title "Some Title"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -title 'Some Title'")
+  end
+  
+  it "should the author" do
+    convert @from_file, :to => @to_file do
+      author "PMH"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -author 'PMH'")
+  end
+  
+  it "should the copyright" do
+    convert @from_file, :to => @to_file do
+      copyright "(c) Patrik Hedman 2009"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -copyright '(c) Patrik Hedman 2009'")
+  end
+  
+  it "should the comment" do
+    convert @from_file, :to => @to_file do
+      comment "Some Comment"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -comment 'Some Comment'")
+  end
+  
+  it "should the album" do
+    convert @from_file, :to => @to_file do
+      album "An awesome album"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -album 'An awesome album'")
+  end
+  
+  it "should the track" do
+    convert @from_file, :to => @to_file do
+      track 1
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -track 1")
+  end
+  
+  it "should the year" do
+    convert @from_file, :to => @to_file do
+      year 1985
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -year 1985")
+  end
+  
+  it "should the target" do
+    convert @from_file, :to => @to_file do
+      target "vcd"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -target vcd")
+  end
+  
+  it "should the number of frames to record" do
+    convert @from_file, :to => @to_file do
+      frames_to_record 50
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -dframes 50")
+  end
+  
+  it "should set the subtitle codec" do
+    convert @from_file, :to => @to_file do
+      subtitle_codec 'copy'
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -scodec copy")
+  end
+end
+
+describe "FFMpeg Video Options" do
+  before(:each) do
+    @from_file, @to_file = "~/Desktop/test.avi", "~/Desktop/test2.avi"
+    FFMpegCommand.clear
+  end
+  
+  it "should set the resolution" do
+    convert @from_file, :to => @to_file do
+      resolution "vga"
+    end
+    
+    FFMpegCommand.command("ffmpeg").should eql("ffmpeg -i #{@from_file} #{@to_file} -s vga")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'ffmpeg'
+include FFMpeg
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: polly-ffmpeg
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Patrik Hedman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-17 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: patrik@moresale.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/ffmpeg
+- lib/ffmpeg/class_methods.rb
+- lib/ffmpeg/ffmpeg_command.rb
+- lib/ffmpeg/helper_methods.rb
+- lib/ffmpeg/main_options.rb
+- lib/ffmpeg/video_options.rb
+- lib/ffmpeg.rb
+- spec/ffmpeg_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/polly/ffmpeg
+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: []
+