vtranscoder 0.0.1 → 0.0.2

data/.gitignore

@@ -3,3 +3,5 @@
 coverage
 rdoc
 pkg
+driver.rb
+screenshot*

data/README.markdown

@@ -0,0 +1,85 @@
+# vtranscoder
+
+VTranscoder is a collection of utility methods for transcoding and 'publishing' videos with FFMPEG. The goal of this project is to make transcoding video to web formats like FLV and commonly associated tasks easier. 
+
+VTanscoder also provides connivence methods for taking screenshots, uploading to S3/CloudFront etc.
+
+## Dependencies
+
+You'll need FFMPEG and libmp3lame (if you want to use the default MP3 conversion options).
+
+If you're on Mac OSX:
+
+    sudo port install ffmpeg
+    
+If you're on Fedora:
+    
+    yum install ffmpeg
+    
+For Ubuntu:
+
+    apt-get install ffmpeg
+
+## Installation
+
+Installation is really simple--thanks Gemcutter!
+
+    gem install vtranscoder
+
+## Getting Started
+
+Consider this block of code:
+
+    require 'rubygems'
+    require 'vtranscoder'
+
+    # open a video
+    @video = VTranscoder.new('/path/to/some/video.avi')
+
+    # how big is the file?
+    puts "File size: #{@video.meta[:size]}"
+
+    # print more information
+    puts "Meta data: #{@video.meta.inspect}"
+    puts "Duration (seconds): #{@video.duration_in_seconds}"
+
+    # take five equally spaced out screenshots
+    5.times do |i|
+      @video.take_screenshot :at => (@video.duration_in_seconds/5)*i, :to => "screenshot_#{i}.jpg"
+    end
+
+    # create Flash video from it
+    @video.convert 'video-transcoded.flv'
+    
+## Advanced Usage
+
+Should you need to pass your own options to the FFMPEG command-line binary, most methods (with the exception of *convert*) take an optional _options_ hash, which is structured as such:
+
+    some_ffmpeg_options_hash = {
+      :i => @source,
+      :y => '',
+      ...
+    }
+
+(Notice how the "-y" flag is represented by an empty string.)
+
+You can use *convert_with_options* to start conversion with your own options hash:
+
+    @video.convert_with_options('outfile.mpg',{
+      :b => "200"
+    })
+    
+The default options for FLV conversion used with *convert* are:
+  
+    FFMPEG_OPTIONS = {
+      :b => 800,
+      :r => 25,
+      :vcodec => 'flv',
+      :acodec => 'libmp3lame',
+      :ab => 128,
+      :ar => 44100
+    }
+
+## Copyright
+
+Copyright (c) 2009 Chris Bielinski. See LICENSE for details.

data/VERSION

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

data/lib/vtranscoder.rb

@@ -1,6 +1,14 @@
+# VTranscoder is a utility/convienece class for transcoding video. More specificially it provides any easy-to-use
+# interface for FFMPEG which VTranscoder depends on. Zero-configuration default options are provided for converting
+# video to Flash (FLV) format, commonly used for delivering web video.
+#
+# Feel free to contribute because I'm no expert on FFMPEG or it's complex configuration options.
+#
+# @author Chris Bielinski <chris@shadowreactor.com>
+#
 class VTranscoder
   
-  attr_accessor :source
+  attr_accessor :source, :meta
   
   FFMPEG_OPTIONS = {
     :b => 800,
@@ -17,7 +25,58 @@ class VTranscoder
   
   def initialize(source)
     @source = source
+    @meta = {}
+    get_video_information
+  end
+  
+  def duration_in_seconds
+    # 00:21:41.18
+    ( $1.to_i * 60 * 60 ) + ( $2.to_i * 60 ) + ( $3.to_i ) + ( ($4.to_i/100) * 60 ) if @meta[:duration] =~ /([0-9][0-9])\:([0-9][0-9])\:([0-9][0-9])\.([0-9][0-9])/
+  end
+  
+  # options[:at] => number of seconds into video to take the screenshot
+  # options[:size] => desired pixel dimensions of screenshot (default is '320*240')
+  # options[:to] => path to destination image (/path/to/some/image.jpg)
+  def take_screenshot(options)
+    verify_ffmpeg_exists
+    verify_source_exists
+    options = { :size => '320*240' }.merge(options)
+    
+    ffmpeg_options = {
+      :i => @source,
+      :y => '',
+      :ss => options[:at],
+      :sameq => '',
+      :t => '0.001',
+      :s => options[:size]
+    }
+    
+    output = run_ffmpeg( ffmpeg_options, options[:to], true )
+    raise "unable to take screenshot:\n\n#{output}" unless File.exists?(options[:to])
+  end
+  
+  def get_video_information
+    verify_ffmpeg_exists
     verify_source_exists
+
+    # Sample FFMPEG output
+    #
+    # Input #0, avi, from 'video.filename.avi':
+    #   Duration: 00:21:41.18, start: 0.000000, bitrate: 1126 kb/s
+    #     Stream #0.0: Video: mpeg4, yuv420p, 624x352 [PAR 1:1 DAR 39:22], 23.98 tbr, 23.98 tbn, 23.98 tbc
+    #     Stream #0.1: Audio: mp3, 48000 Hz, stereo, s16, 128 kb/s
+
+    ffmpeg_output = `ffmpeg -i #{@source} 2>&1` # we know we're going to get an error but we want to capture 
+                                                # the output anyways, so 2>&1 routes STDERR to STDOUT
+    
+    @meta[:size] = File.size(@source)
+    @meta[:duration] = $1 if ffmpeg_output =~ /Duration\: ([0-9][0-9]\:[0-9][0-9]\:[0-9][0-9]\.[0-9][0-9])\,/
+    @meta[:bitrate] = $1 if ffmpeg_output =~ /\, bitrate\: (.*)$/
+    
+    @meta[:streams] = []
+    ffmpeg_output.scan(/Stream #0.([0-9]): (.*): (.*), (.*)/).each do |match|
+      @meta[:streams][match[0].to_i] = { :type => match[1], :codec => match[2], :details => match[3] }
+    end
   end
   
   def convert_with_options(destination,options)
@@ -29,19 +88,25 @@ class VTranscoder
     convert_with_options destination, FFMPEG_OPTIONS
   end
   
+  def file
+    verify_source_exists
+    File.open(@source)
+  end
+  
   protected
   
-  def run(command,parameters)
-    actual_command = "#{command} #{parameters}"
+  def run(command,parameters,reroute_output=false)
+    actual_command = "#{command} #{parameters}#{' 2>&1' if reroute_output}"
+    puts " ===> #{actual_command}"
     `#{actual_command}`
   end
   
-  def run_ffmpeg(options,outputfile)
-    run('ffmpeg',"#{command_params options.merge({ :i => @source})} #{outputfile}")
+  def run_ffmpeg(options,outputfile,reroute_output=false)
+    run('ffmpeg',"#{command_params options.merge({ :i => @source})} #{outputfile}",reroute_output)
   end
   
   def command_params(hsh)
-    hsh.each_key.map { |key| "-#{key.to_s} #{hsh[key]}" }.join(' ')
+    hsh.each_key.map { |key| "-#{key.to_s}#{ hsh[key].to_s == '' ? '' : ' '+hsh[key].to_s }" }.join(' ')
   end
   
   def verify_source_exists

data/vtranscoder.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vtranscoder}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Bielinski"]
+  s.date = %q{2009-10-18}
+  s.description = %q{VTranscoder is a collection of utility methods for transcoding and 'publishing' videos, with the intent to make transcoding video to web formats like FLV easier. VTanscoder also provides convience methods for taking screenshots, uploading to S3/CloudFront etc.}
+  s.email = %q{chris@shadowreactor.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/vtranscoder.rb",
+     "test/test_helper.rb",
+     "test/vtranscoder_test.rb",
+     "vtranscoder.gemspec"
+  ]
+  s.homepage = %q{http://github.com/chrisb/vtranscoder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Provides a simple, zero-configuration front end to encoding videos with FFMPEG.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/vtranscoder_test.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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vtranscoder
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Chris Bielinski
@@ -21,17 +21,18 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/vtranscoder.rb
 - test/test_helper.rb
 - test/vtranscoder_test.rb
+- vtranscoder.gemspec
 has_rdoc: true
 homepage: http://github.com/chrisb/vtranscoder
 licenses: []

data/README.rdoc

@@ -1,18 +0,0 @@
-= vtranscoder
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 Chris Bielinski. See LICENSE for details.