voyeur 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+.DS_Store
+Vagrantfile
+.vagrant
+.rvmrc
+.bundle
+Gemfile.lock
+pkg/*
+bin
+test_data/*
+*.mp4
+*.swp
+*.swo
+*.box

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in Voyeur.gemspec
+gemspec

data/README.md

@@ -0,0 +1,100 @@
+# Voyeur
+Voyeur is a ruby library that will take your video files and convert
+them to common HTML5 formats exposing an easy to use API. Seriously
+it's like falling out of a tree then climbing back.
+
+## Installation
+The gem is easily installed by including the following line in your
+Gemfile (if you role that way)
+
+    gem 'voyeur'
+    
+ or on the command line 
+ 
+    gem install voyeur
+    require 'voyeur'
+    
+## Setup
+This gem requires ffmpeg to be installed. If you require assistance
+there is a basic guide included in the [wiki page](https://github.com/devthenet/Voyeur/wiki/Installing-ffmpeg-%28Ubuntu%29). Feel free to add more!  
+You can also try out automated [setup scripts](https://github.com/devthenet/ffmpeg_setup) (at the moment we only have for ubuntu):
+
+
+
+
+## Usage
+Simple conversions may be done by simply:
+
+    Voyeur::Video.new( filename: path_to_file ).convert( to: :mp4 )
+    
+This will convert the video into Mp4 and save it in the same directory
+as the original video.
+
+Alternatively you can convert to all 3 types at once:
+
+    Voyeur::Video.new( filename: path_to_file ).convert_to_html5
+This will convert the video into 3 formats. Mp4, Ogv and Webm and place
+them in the same folder as the parent.
+
+I have allowed the user to specify an output filename. (Note: if no
+output filename the file is just named after the original file):
+
+    Voyeur::Video.new( filename: path_to_file ).convert( to: :mp4, output_filename: "my_cool_video" )
+
+This will give you a converted video called "my_cool_video.mp4".
+
+You can also convert to all with the following:
+
+    Voyeur::Video.new( filename: path_to_file ).convert_to_html5( output_filename: "my_cool_video" )
+
+It is also possible to place the formatted video in a custom folder:
+
+    Voyeur::Video.new( filename: path_to_file ).convert( to: :mp4, output_path: "my/cool/file/path" )
+
+or
+
+    Voyeur::Video.new( filename: path_to_file ).convert_to_html5( output_path: "my/cool/file/path" )
+
+## Extendibility
+
+I've designed this in the hopes that others will be able to add
+other formats / conversion options (haven't quite gone that far yet).
+Right now it's as simple as creating a file similar to this:
+
+    module Voyeur
+      class Mp4 < Converter
+
+        def file_extension
+          "mp4"
+        end
+
+        def convert_options
+          "-b 1500k -vcodec libx264 -g 30"
+        end
+      end
+    end
+
+
+The two methods file_extension and convert options are mandatory.
+
+## Todo
+1. Spawn processes simultaniously so more than one video can be converted
+at once.
+2. Add functionality so that users can use more specific convert
+options
+
+## Authors
+#### Peter Garbers  
+* https://github.com/petergarbers      
+* http://twitter.com/petergarbers
+
+#### Hendrik Louw
+* https://github.com/HendrikLouw  
+* http://twitter.com/hendrik_louw
+
+## Sources
+
+### Links
+* http://stackoverflow.com/questions/5487085/ffmpeg-covert-html-5-video-not-working
+* http://johndyer.name/ffmpeg-settings-for-html5-codecs-h264mp4-theoraogg-vp8webm/
+* http://rodrigopolo.com/ffmpeg/cheats.html

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/Voyeur.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "Voyeur/version"
+
+Gem::Specification.new do |s|
+  s.name        = "voyeur"
+  s.version     = Voyeur::VERSION
+  s.authors     = ["Peter Garbers", "Hendrik F. Louw"]
+  s.email       = ["peter.garbers@gmail.com", "hflouw@gmail.com"]
+  s.homepage    = "http://devthenet.github.com/"
+  s.summary     = %q{Ruby library to convert common video formats to HTML5 formats}
+  s.description = %q{A ruby library to convert videos into common html5 formats}
+
+  s.rubyforge_project = "Voyeur"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_dependency "open4"
+end

data/lib/Voyeur/converter.rb

@@ -0,0 +1,55 @@
+module Voyeur
+  class Converter
+    attr_accessor :input_video
+    attr_reader :output_video
+    attr_reader :status
+
+    def self.create(options)
+      constant = Voyeur
+      klass = "#{options[:format].capitalize}"
+      raise Voyeur::Exceptions::InvalidFormat unless constant.const_defined? klass
+      klass = constant.const_get klass
+      klass.new
+    end
+
+    def convert(options)
+      @input_video = options[:video]
+      raise Voyeur::Exceptions::NoVideoPresent unless @input_video
+      output_filename = self.output_path( options[:output_path] )
+      @output_video = Video.new(filename: output_file(options[:output_path], options[:output_filename]))
+      self.call_external_converter
+    end
+
+    protected
+
+    def output_file(path, filename)
+      "#{output_path(path)}/#{output_filename(filename)}"
+    end
+
+    def output_path(output_path = nil)
+      raise Voyeur::Exceptions::InvalidLocation if output_path && !File.directory?(output_path)
+      output_path ? output_path : File.dirname(@input_video.filename)
+    end
+
+    def output_filename(input_filename = nil)
+      filename = input_filename.nil? ? @input_video.filename : input_filename
+      File.basename(filename, '.*') + ".#{self.file_extension}"
+    end
+
+    def call_external_converter
+      command = "ffmpeg -i #{@input_video.filename} #{self.convert_options} #{@output_video.filename}"
+      out, err = ""
+
+      status = Open4::popen4(command) do |pid, stdin, stdout, stderr|
+        out = stdout.read.strip
+        err = stderr.read.strip
+      end
+
+      error_message = err.split('\n').last
+
+      @status = { status: status.exitstatus, stdout: out, stderr: err,
+        error_message: error_message, video: @output_video }
+      return @status
+    end
+  end
+end

data/lib/Voyeur/exceptions.rb

@@ -0,0 +1,7 @@
+module Voyeur
+  module Exceptions
+    class NoVideoPresent < StandardError; end
+    class InvalidFormat < StandardError; end
+    class InvalidLocation < StandardError; end
+  end
+end

data/lib/Voyeur/version.rb

@@ -0,0 +1,3 @@
+module Voyeur
+  VERSION = "0.0.1"
+end

data/lib/Voyeur/video.rb

@@ -0,0 +1,23 @@
+module Voyeur
+  class Video
+    attr_reader :filename
+    def initialize(options)
+      @filename = options[:filename]
+    end
+
+    def convert(options)
+      converter = Voyeur::Converter.create(format: options[:to])
+      converter.convert(video: self,
+                        output_filename: options[:output_filename],
+                        output_path: options[:output_path])
+    end
+
+    def convert_to_html5(options = nil)
+      [:mp4, :ogv, :webm].each do |f|
+        options_hash = {to: f}
+        options_hash.merge!(options) if options
+        convert(options_hash)
+      end
+    end
+  end
+end

data/lib/Voyeur/video_converters/mp4.rb

@@ -0,0 +1,13 @@
+module Voyeur
+  class Mp4 < Converter
+
+    def file_extension
+      "mp4"
+    end
+
+    def convert_options
+      "-b 1500k -vcodec libx264 -g 30"
+    end
+  end
+
+end

data/lib/Voyeur/video_converters/ogv.rb

@@ -0,0 +1,12 @@
+module Voyeur
+  class Ogv < Converter
+
+    def file_extension
+      "ogv"
+    end
+
+    def convert_options
+      "-b 1500k -vcodec libtheora -acodec libvorbis -ab 160000 -g 30"
+    end
+  end
+end

data/lib/Voyeur/video_converters/webm.rb

@@ -0,0 +1,12 @@
+module Voyeur
+  class Webm < Converter
+
+    def file_extension
+      "webm"
+    end
+
+    def convert_options
+      "-b 1500k -vcodec libvpx -acodec libvorbis -ab 160000 -f webm -g 30"
+    end
+  end
+end

data/lib/Voyeur.rb

@@ -0,0 +1,8 @@
+require "Voyeur/version"
+require "Voyeur/video"
+require "Voyeur/exceptions"
+require "Voyeur/converter"
+require "Voyeur/video_converters/ogv"
+require "Voyeur/video_converters/mp4"
+require "Voyeur/video_converters/webm"
+require 'open4'

data/spec/converter_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Voyeur::Converter do
+  it "should raise an exception if there is not a proper video type" do
+    -> { Voyeur::Converter.create(format: :asd) }.should raise_error
+  end
+end

data/spec/converters/mp4_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Voyeur::Mp4 do
+  before :each do
+    @converter = Voyeur::Converter.create(format: :mp4)
+    @video = Voyeur::Video.new(filename: valid_mpeg_file_path)
+  end
+
+  it "should use the correct factory" do
+    @converter.class.to_s.should == "Voyeur::Mp4"
+  end
+
+  it "default convert string" do
+    @converter.convert_options.should == "-b 1500k -vcodec libx264 -g 30"
+  end
+
+  context "A valid Video" do
+    after :each do
+      File.delete(valid_mpeg_file_path.gsub(/mpeg/, "mp4")) if File.exists?(valid_mpeg_file_path.gsub(/mpeg/, "mp4"))
+    end
+
+    context "#convert_options" do
+      it "should name the video correctly" do
+        @converter.convert(video: @video)
+        output_file = valid_mpeg_file_path.gsub(/mpeg/, "mp4")
+        @converter.output_video.filename.should == output_file
+      end
+
+      it "should return a video" do
+        @converter.convert(video: @video)
+        @converter.input_video.should == @video
+      end
+
+      context "real video" do
+        it "should return conversion status indicating success" do
+          result = @converter.convert(video: @video)
+          result[:status].should == 0
+          result[:video].should == @converter.output_video
+        end
+
+        it "should allow them to name the video" do
+          result = @converter.convert(video: @video)
+          result[:status].should == 0
+          result[:video].should == @converter.output_video
+        end
+
+        it "should return stdout" do
+          pending "why do we want this? this is returning ffmpeg version stuff"
+          result = @converter.convert(video: @video)
+          result[:stderr].should == ""
+          result[:stdout].should == ""
+        end
+      end
+    end
+  end
+
+  context "An invalid Video" do
+    before :each do
+      @converter = Voyeur::Converter.create(format: :mp4)
+      @video = Voyeur::Video.new(filename: 'test_video.mpeg')
+    end
+
+    context "File does not exist" do
+      it "should return conversion status indicating failure" do
+        result = @converter.convert(video: @video)
+        result[:status].should == 1
+        result[:video].should == @converter.output_video
+        result[:error_message].should match(/test_video.mpeg: No such file or directory/)
+        result[:stderr].nil?.should == false
+      end
+    end
+  end
+end

data/spec/converters/ogv_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Voyeur::Ogv do
+  context "New Video" do
+    before :each do
+      @converter = Voyeur::Converter.create(format: :ogv)
+      @video = Voyeur::Video.new(filename: 'test_video.ogv')
+    end
+
+    it "should use the correct factory" do
+      @converter.class.to_s.should == "Voyeur::Ogv"
+    end
+
+    context "#convert_options" do
+      it "default convert string" do
+        @converter.convert_options.should == "-b 1500k -vcodec libtheora -acodec libvorbis -ab 160000 -g 30"
+      end
+
+      it "should raise an exception if no video is passed" do
+        @video = nil
+        -> { @converter.convert(video: @video) }.should raise_error Voyeur::Exceptions::NoVideoPresent
+      end
+
+      it "should return a video" do
+        @converter.convert(video: @video)
+        @converter.input_video.should == @video
+      end
+    end
+  end
+
+  context "An invalid Video" do
+    before :each do
+      @converter = Voyeur::Converter.create(format: :ogv)
+      @video = Voyeur::Video.new(filename: 'test_video.mpeg')
+    end
+    context "File does not exist" do
+      it "should return conversion status indicating failure" do
+        result = @converter.convert(video: @video)
+        result[:status].should == 1
+        result[:video].should == @converter.output_video
+        result[:error_message].should match(/test_video.mpeg: No such file or directory/)
+        result[:stderr].nil?.should == false
+      end
+    end
+  end
+end

data/spec/converters/webm_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Voyeur::Webm do
+  context "New Video" do
+    before :each do
+      @converter = Voyeur::Converter.create(format: :webm)
+      @video = Voyeur::Video.new(filename: 'test_video.webm')
+    end
+
+    it "should use the correct factory" do
+      @converter.class.to_s.should == "Voyeur::Webm"
+    end
+
+    context "#convert_options" do
+      it "default convert string" do
+        @converter.convert_options.should == "-b 1500k -vcodec libvpx -acodec libvorbis -ab 160000 -f webm -g 30"
+      end
+
+      it "should raise an exception if no video is passed" do
+        @video = nil
+        -> { @converter.convert(video: @video) }.should raise_error Voyeur::Exceptions::NoVideoPresent
+      end
+
+      it "should return a video" do
+        @converter.convert(video: @video)
+        @converter.input_video.should == @video
+      end
+    end
+  end
+
+  context "An invalid Video" do
+    before :each do
+      @converter = Voyeur::Converter.create(format: :webm)
+      @video = Voyeur::Video.new(filename: 'test_video.mpeg')
+    end
+
+    context "File does not exist" do
+      it "should return conversion status indicating failure" do
+        result = @converter.convert(video: @video)
+        result[:status].should == 1
+        result[:video].should == @converter.output_video
+        result[:error_message].should match(/test_video.mpeg: No such file or directory/)
+        result[:stderr].nil?.should == false
+      end
+    end
+  end
+
+end

data/spec/fixtures/converted/PLACEHOLDER

@@ -0,0 +1,2 @@
+Nothing to see here, just so github saves the folder else shit breaks, just trust me, k love?
+

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'Voyeur'
+require 'spec_helpers/video_file_spec_helper'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+include SpecHelper::VideoFileSpecHelper

data/spec/spec_helpers/video_file_spec_helper.rb

@@ -0,0 +1,19 @@
+module SpecHelper
+  module VideoFileSpecHelper
+    def current_path
+      File.join( File.dirname(__FILE__), "../" )
+    end
+
+    def fixture_file_path
+      File.join(current_path, "fixtures")
+    end
+
+    def valid_3g_file_path
+      File.join(fixture_file_path, "test.3gp")
+    end
+
+    def valid_mpeg_file_path
+      File.join(fixture_file_path, "test.mpeg")
+    end
+  end
+end

data/spec/video_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Voyeur::Video do
+  it 'should create a new video object from a filename' do
+    video_input_name = 'test_file.mpeg'
+    video = Voyeur::Video.new filename: video_input_name
+    video.filename.should == video_input_name
+  end
+
+  it "should convert a video to ogv" do
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).convert(to: :ogv)
+    File.exist?(valid_mpeg_file_path.gsub(/mpeg/, "ogv")).should be_true
+    File.delete(valid_mpeg_file_path.gsub(/mpeg/, "ogv"))
+  end
+
+  it "should convert a video to mp4" do
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).convert(to: :mp4)
+    File.exist?(valid_mpeg_file_path.gsub(/mpeg/, "mp4")).should be_true
+    File.delete(valid_mpeg_file_path.gsub(/mpeg/, "mp4"))
+  end
+
+  it "should convert a video to webm" do
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).convert(to: :webm)
+    File.exist?(valid_mpeg_file_path.gsub(/mpeg/, "webm")).should be_true
+    File.delete(valid_mpeg_file_path.gsub(/mpeg/, "webm"))
+  end
+
+  it "should convert a video to all HTML5 video formats" do
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).convert_to_html5
+    File.exists?(valid_mpeg_file_path.gsub(/mpeg/, "mp4")).should be_true
+    File.delete(valid_mpeg_file_path.gsub(/mpeg/, "mp4"))
+    File.exists?(valid_mpeg_file_path.gsub(/mpeg/, "ogv")).should be_true
+    File.delete(valid_mpeg_file_path.gsub(/mpeg/, "ogv"))
+    File.exists?(valid_mpeg_file_path.gsub(/mpeg/, "webm")).should be_true
+    File.delete(valid_mpeg_file_path.gsub(/mpeg/, "webm"))
+  end
+
+  it "should allow the user to name the video" do
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).
+      convert(to: :webm, output_filename: "sexypants")
+    File.exists?("#{fixture_file_path}/sexypants.webm").should be_true
+    File.delete("#{fixture_file_path}/sexypants.webm")
+  end
+
+  it "should allow the user to specify a video path" do
+    output_path = "#{fixture_file_path}/converted"
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).
+      convert(to: :ogv, output_path: output_path)
+    File.exists?("#{output_path}/test.ogv").should be_true
+    File.delete("#{output_path}/test.ogv")
+  end
+
+  it "should allow a user to specify a video path and filename" do
+    output_path = "#{fixture_file_path}/converted"
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).
+      convert(to: :ogv, output_path: output_path, output_filename: "supersexypants")
+    File.exists?("#{output_path}/supersexypants.ogv").should be_true
+    File.delete("#{output_path}/supersexypants.ogv")
+  end
+
+  it "should allow a user to specify a video path and filename when converting all formats" do
+    output_path = "#{fixture_file_path}/converted"
+    Voyeur::Video.new( filename: valid_mpeg_file_path ).
+      convert_to_html5(output_path: output_path, output_filename: "supersexypants")
+    File.exists?("#{output_path}/supersexypants.ogv").should be_true
+    File.delete("#{output_path}/supersexypants.ogv")
+    File.exists?("#{output_path}/supersexypants.mp4").should be_true
+    File.delete("#{output_path}/supersexypants.mp4")
+    File.exists?("#{output_path}/supersexypants.webm").should be_true
+    File.delete("#{output_path}/supersexypants.webm")
+  end
+
+  it "should not allow the user to specify a folder that doesn't exist" do
+    output_path = "#{fixture_file_path}/icecream"
+    -> { Voyeur::Video.new( filename: valid_mpeg_file_path ).
+      convert(to: :ogv, output_path: output_path) }.should raise_error Voyeur::Exceptions::InvalidLocation
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: voyeur
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Garbers
+- Hendrik F. Louw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70172804487660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70172804487660
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: &70172804487240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70172804487240
+description: A ruby library to convert videos into common html5 formats
+email:
+- peter.garbers@gmail.com
+- hflouw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- Voyeur.gemspec
+- lib/Voyeur.rb
+- lib/Voyeur/converter.rb
+- lib/Voyeur/exceptions.rb
+- lib/Voyeur/version.rb
+- lib/Voyeur/video.rb
+- lib/Voyeur/video_converters/mp4.rb
+- lib/Voyeur/video_converters/ogv.rb
+- lib/Voyeur/video_converters/webm.rb
+- spec/converter_spec.rb
+- spec/converters/mp4_spec.rb
+- spec/converters/ogv_spec.rb
+- spec/converters/webm_spec.rb
+- spec/fixtures/converted/PLACEHOLDER
+- spec/fixtures/test.3gp
+- spec/fixtures/test.mpeg
+- spec/spec_helper.rb
+- spec/spec_helpers/video_file_spec_helper.rb
+- spec/video_spec.rb
+homepage: http://devthenet.github.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: Voyeur
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby library to convert common video formats to HTML5 formats
+test_files:
+- spec/converter_spec.rb
+- spec/converters/mp4_spec.rb
+- spec/converters/ogv_spec.rb
+- spec/converters/webm_spec.rb
+- spec/fixtures/converted/PLACEHOLDER
+- spec/fixtures/test.3gp
+- spec/fixtures/test.mpeg
+- spec/spec_helper.rb
+- spec/spec_helpers/video_file_spec_helper.rb
+- spec/video_spec.rb