ffmpeg 0.2.5

data/.gitignore

@@ -0,0 +1,4 @@
+*.sw?
+.DS_Store
+coverage
+pkg/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Patrik Hedman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,45 @@
+h2. FFMpeg
+
+A DSL for building and executing ffmpeg commands.
+
+h2. Requirements
+
+It requires that you already have ffmpeg installed, obviously :)
+
+h2. Install
+
+gem install polly-ffmpeg --source http://gems.github.com
+
+h2. Usage
+
+To build and execute a command you would use the FFMpeg::convert method and then call the FFMpeg::run method like this:
+
+require "rubygems"
+require "ffmpeg"
+include FFMpeg
+
+convert "file.ext", :to => "new_file.ext" do
+<span>&nbsp;&nbsp;&nbsp;&nbsp;seek     "00:01:13"</span>
+<span>&nbsp;&nbsp;&nbsp;&nbsp;duration "00:10:01"</span>
+end.run
+
+If you want the output file to have the same name as the input file it's enough to just specify the new file extension like this:
+
+require "rubygems"
+require "ffmpeg"
+include FFMpeg
+
+convert "finding_that_nemo_dude.avi", :to => :flv do
+<span>&nbsp;&nbsp;&nbsp;&nbsp;...</span>
+end
+
+This will produce an output file called finding_that_nemo_dude.flv
+
+For more information checkout the "documentation":http://polly.github.com/ffmpeg/ or my "blog":http://pastbedti.me/
+
+h2. Credit where credit's due
+
+Thank's to "jwthompson2":http://github.com/jwthompson2 there's now support for all of the standard video and audio options and most of the advanced video options from the ffmpeg documentation as well 
+as improved and refactored specs.
+
+Thanks to "jamesdaniels":http://github.com/jamesdaniels for fixing a nasty output path error while using the :to => extension option

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "ffmpeg"
+    s.summary = %Q{A dsl for building and executing ffmpeg commands}
+    s.email = "patrik@moresale.se"
+    s.homepage = "http://github.com/polly/ffmpeg"
+    s.description = "A dsl for building and executing ffmpeg commands"
+    s.authors = ["Patrik Hedman"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'ffmpeg'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:minor: 2
+:patch: 5
+:major: 0
+:build: 

data/features/ffmpeg.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'ffmpeg'
+
+require 'spec/expectations'
+
+require 'test/unit/assertions'
+
+World do |world|
+  
+  world
+end

data/ffmpeg.gemspec

@@ -0,0 +1,86 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ffmpeg}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Patrik Hedman"]
+  s.date = %q{2009-08-16}
+  s.description = %q{A DSL for building and executing ffmpeg commands}
+  s.email = %q{patrik@moresale.se}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION.yml",
+     "features/ffmpeg.feature",
+     "features/steps/ffmpeg_steps.rb",
+     "features/support/env.rb",
+     "ffmpeg.gemspec",
+     "lib/ffmpeg.rb",
+     "lib/ffmpeg/audio_options.rb",
+     "lib/ffmpeg/class_methods.rb",
+     "lib/ffmpeg/ffmpeg_command.rb",
+     "lib/ffmpeg/file_extensions.rb",
+     "lib/ffmpeg/helper_methods.rb",
+     "lib/ffmpeg/main_options.rb",
+     "lib/ffmpeg/video_advanced_options.rb",
+     "lib/ffmpeg/video_options.rb",
+     "rdoc/classes/FFMpeg.html",
+     "rdoc/classes/FFMpeg/AudioOptions.html",
+     "rdoc/classes/FFMpeg/ClassMethods.html",
+     "rdoc/classes/FFMpeg/HelperMethods.html",
+     "rdoc/classes/FFMpeg/MainOptions.html",
+     "rdoc/classes/FFMpeg/VideoOptions.html",
+     "rdoc/classes/FFMpegCommand.html",
+     "rdoc/classes/FileExtensions.html",
+     "rdoc/created.rid",
+     "rdoc/files/README_textile.html",
+     "rdoc/files/lib/ffmpeg/audio_options_rb.html",
+     "rdoc/files/lib/ffmpeg/class_methods_rb.html",
+     "rdoc/files/lib/ffmpeg/ffmpeg_command_rb.html",
+     "rdoc/files/lib/ffmpeg/file_extensions_rb.html",
+     "rdoc/files/lib/ffmpeg/helper_methods_rb.html",
+     "rdoc/files/lib/ffmpeg/main_options_rb.html",
+     "rdoc/files/lib/ffmpeg/video_options_rb.html",
+     "rdoc/files/lib/ffmpeg_rb.html",
+     "rdoc/fr_class_index.html",
+     "rdoc/fr_file_index.html",
+     "rdoc/fr_method_index.html",
+     "rdoc/index.html",
+     "rdoc/rdoc-style.css",
+     "spec/audio_options_spec.rb",
+     "spec/ffmpeg_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/video_advanced_options_spec.rb",
+     "spec/video_options_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/polly/ffmpeg}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A dsl for building and executing ffmpeg commands}
+  s.test_files = [
+    "spec/audio_options_spec.rb",
+     "spec/ffmpeg_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/video_advanced_options_spec.rb",
+     "spec/video_options_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/ffmpeg.rb

@@ -0,0 +1,121 @@
+require 'ffmpeg/class_methods'
+require 'ffmpeg/main_options'
+require 'ffmpeg/file_extensions'
+require 'ffmpeg/video_options'
+require 'ffmpeg/video_advanced_options'
+require 'ffmpeg/audio_options'
+require 'ffmpeg/ffmpeg_command'
+require 'ffmpeg/helper_methods'
+require 'ffmpeg/meta_data'
+
+module FFMpeg
+  include HelperMethods
+  include MainOptions
+  include VideoOptions
+  include VideoAdvancedOptions
+  include AudioOptions
+  include MetaData
+  
+  #
+  # 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 = {})
+    @from_file = from_file
+    FFMpegCommand << "-i #{from_file}"
+    begin
+      yield if block_given?
+    rescue Exception => exception
+      disable_method_checking!
+      raise exception
+    end
+    
+    build_output_file_name(from_file, to_file[:to]) do |file_name|
+      FFMpegCommand << file_name
+    end
+  end
+  
+  #
+  # Explicitly set ffmpeg path
+  #
+  def ffmpeg_path(path)
+    @@ffmpeg_path = path
+  end
+
+  #
+  # Runs ffmpeg
+  #
+  def run
+    @@ffmpeg_path ||= locate_ffmpeg
+    unless @@ffmpeg_path.empty?
+      execute_command FFMpegCommand.command(@@ffmpeg_path)
+    else
+      $stderr.puts "Couldn't locate ffmpeg, try to specify an explicit path
+                    with the ffmpeg_path(path) method"
+    end
+  end
+  
+  private
+  
+  def build_output_file_name(from_file, to_file)
+    return if to_file.nil?
+    if FileExtensions::EXT.include?(to_file.to_s)
+      yield from_file.gsub(/#{File.extname(from_file)}$/, ".#{to_file}")
+    else
+      yield "#{to_file}"
+    end
+  end
+
+  #
+  # Checks if the thread local varialble 'method checking disabled'
+  # is true or false
+  #
+  def method_checking_enabled?
+    !Thread.current[:'method checking disabled']
+  end
+  
+  #
+  # Turns off the method checking functionality
+  #
+  def disable_method_checking!
+    Thread.current[:'method checking disabled'] = true
+  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/lib/ffmpeg/audio_options.rb

@@ -0,0 +1,47 @@
+module FFMpeg
+  module AudioOptions
+    # Set the number of audio frames to record.
+    def audio_frames(number)
+      FFMpegCommand << "-aframes #{number}"
+    end
+
+    # Set the audio sampling frequency (default = 44100 Hz).
+    def audio_sampling(frequency)
+      FFMpegCommand << "-ar #{frequency}"
+    end
+
+    # Set the audio bitrate in bit/s (default = 64k).
+    def audio_bitrate(bitrate)
+      FFMpegCommand << "-ab #{bitrate}"
+    end
+
+    # Set the number of audio channels (default = 1).
+    def audio_channels(number)
+      FFMpegCommand << "-ac #{number}"
+    end
+
+    # Disable audio recording.
+    def disable_audio
+      FFMpegCommand << "-an"
+    end
+
+    # Force audio codec to codec. Use the copy special value to specify that the raw codec data must be copied as is.
+    def audio_codec(codec)
+      FFMpegCommand << "-acodec #{codec}"
+    end
+
+    # Add a new audio track to the output file. If you want to specify parameters, do so before -newaudio (-acodec,
+    # -ab, etc..). Mapping will be done automatically, if the number of output streams is equal to the number of input
+    # streams, else it will pick the first one that matches. You can override the mapping using -map as usual. Example:
+    #
+    # ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
+    def new_audio
+      FFMpegCommand << "-newaudio"
+    end
+
+    # Set the ISO 639 language code (3 letters) of the current audio stream.
+    def audio_language(code)
+      FFMpegCommand << "-alang #{code}"
+    end
+  end
+end

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