headless 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36a92b0fed73ea273bf7cc4201b545be19d539e2
-  data.tar.gz: 29feae5dcdb2be2fa1d5147e009910d4c7f7c044
+  metadata.gz: 8dc1c06f85049924c12fc40b4558040fd514c01a
+  data.tar.gz: a5e904086bdccf72798574e2450ce76b64fda0a7
 SHA512:
-  metadata.gz: 0a2c40f5cad61642e952565e3ab9666f00a4fe40eaee09ec99eb2facfff76bc4a87976cd2ca42dea02cf5b185d7d4f4d2a812ec44eb9c5a43ed016f9cbef12f6
-  data.tar.gz: ce8ea2ace8823b3507bcef65da7194f57b0fbce038f2fe0eef4f7a7dfbb69e7de678e4172c4761736297eb4b7d05f1e3128c93c6ee95cd6d42e81a18050fe773
+  metadata.gz: d6ad825721817e789fde8d9786bac8fec26ef097e5fb4af74f8c685a9895dfa3b5850161f3bf8f809b5024a7827c08f35dfd131d843e2f0cc71b274b4197ddea
+  data.tar.gz: af0c4aea4a57b14f56868315a1874bf28a09e7ab8a4a91355d0b864e09e939794aa9eedcf9ced54692c79dc428ae5a30003ea43afaa097edaaf75b06ee85fd5f

data/CHANGELOG

@@ -1,3 +1,7 @@
+## 2.1.0 (2015-05-10)
+
+* Allow path to video recorder binary to be customized (from @briandamaged)
+
 ## 2.0.0 (2015-04-23)
 
 * Rewritten Xvfb launch using Process.spawn and avoiding a shell

data/README.md

@@ -131,12 +131,13 @@ headless = Headless.new(:video => { :frame_rate => 12, :codec => 'libx264' })
 Available options:
 
 * :codec - codec to be used by ffmpeg
-* :frame_rate    - frame rate of video capture
-* :provider      - ffmpeg provider - either :libav (default) or :ffmpeg
-* :pid_file_path - path to ffmpeg pid file, default: "/tmp/.headless_ffmpeg_#{@display}.pid"
-* :tmp_file_path - path to tmp video file,  default: "/tmp/.headless_ffmpeg_#{@display}.mov"
-* :log_file_path - ffmpeg log file,         default: "/dev/null"
-* :extra         - array of extra ffmpeg options, default: [] 
+* :frame_rate      - frame rate of video capture
+* :provider        - ffmpeg provider - either :libav (default) or :ffmpeg
+* :provider_binary_path - Explicit path to avconv or ffmpeg.  Only required when the binary cannot be discovered on the system $PATH.
+* :pid_file_path   - path to ffmpeg pid file, default: "/tmp/.headless_ffmpeg_#{@display}.pid"
+* :tmp_file_path   - path to tmp video file,  default: "/tmp/.headless_ffmpeg_#{@display}.mov"
+* :log_file_path   - ffmpeg log file,         default: "/dev/null"
+* :extra           - array of extra ffmpeg options, default: [] 
 
 ## Taking screenshots
 

data/headless.gemspec

@@ -3,7 +3,7 @@ spec = Gem::Specification.new do |s|
   s.email = 'leonid@shevtsov.me'
 
   s.name = 'headless'
-  s.version = '2.0.0'
+  s.version = '2.1.0'
   s.summary = 'Ruby headless display interface'
 
   s.description = <<-EOF

data/lib/headless/video/video_recorder.rb

@@ -4,6 +4,9 @@ class Headless
   class VideoRecorder
     attr_accessor :pid_file_path, :tmp_file_path, :log_file_path
 
+    # Allow end-users to override the path to the binary
+    attr_accessor :provider_binary_path
+
     def initialize(display, dimensions, options = {})
       @display = display
       @dimensions = dimensions[/.+(?=x)/]
@@ -14,9 +17,14 @@ class Headless
       @codec = options.fetch(:codec, "qtrle")
       @frame_rate = options.fetch(:frame_rate, 30)
       @provider = options.fetch(:provider, :libav)  # or :ffmpeg
+
+      # If no provider_binary_path was specified, then
+      # make a guess based upon the provider.
+      @provider_binary_path = options.fetch(:provider_binary_path, guess_the_provider_binary_path)
+
       @extra = Array(options.fetch(:extra, []))
 
-      CliUtil.ensure_application_exists!(provider_binary, "#{provider_binary} not found on your system. Install it or change video recorder provider")
+      CliUtil.ensure_application_exists!(provider_binary_path, "#{provider_binary_path} not found on your system. Install it or change video recorder provider")
     end
 
     def capture_running?
@@ -55,8 +63,8 @@ class Headless
 
     private
 
-    def provider_binary
-      @provider==:libav ? 'avconv' : 'ffmpeg'
+    def guess_the_provider_binary_path
+      @provider== :libav ? 'avconv' : 'ffmpeg'
     end
 
     def command_line_for_capture
@@ -69,7 +77,7 @@ class Headless
       end
 
       ([
-        CliUtil.path_to(provider_binary),
+        CliUtil.path_to(provider_binary_path),
         "-y",
         "-r #{@frame_rate}",
         "-s #{dimensions}",

data/spec/video_recorder_spec.rb

@@ -1,17 +1,44 @@
 require 'headless'
 
+require 'tempfile'
+
 describe Headless::VideoRecorder do
   before do
     stub_environment
   end
 
   describe "instantiation" do
-    before do
+
+    it "throws an error if provider_binary_path is not installed" do
       allow(Headless::CliUtil).to receive(:application_exists?).and_return(false)
+      expect { Headless::VideoRecorder.new(99, "1024x768x32") }.to raise_error(Headless::Exception)
     end
 
-    it "throws an error if ffmpeg is not installed" do
-      expect { Headless::VideoRecorder.new(99, "1024x768x32") }.to raise_error(Headless::Exception)
+    it "allows provider_binary_path to be specified" do 
+      Tempfile.open('some_provider') do |f|
+        v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :ffmpeg, provider_binary_path: f.path)
+        expect(v.provider_binary_path).to eq(f.path)
+      end
+    end
+
+    it "allows provider_binary_path to be specified" do 
+      Tempfile.open('some_provider') do |f|
+        v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :ffmpeg, provider_binary_path: f.path)
+        expect(v.provider_binary_path).to eq(f.path)
+      end
+    end
+
+    context "provider_binary_path not specified" do 
+      it "assumes the provider binary is 'ffmpeg' if the provider is :ffmpeg" do 
+        v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :ffmpeg)
+        expect(v.provider_binary_path).to eq("ffmpeg")
+      end
+
+      it "assumes the provider binary is 'avconv' if the provider is :libav" do 
+        v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :libav)
+        expect(v.provider_binary_path).to eq("avconv")
+      end
+
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headless
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,3 +98,4 @@ signing_key:
 specification_version: 4
 summary: Ruby headless display interface
 test_files: []
+has_rdoc: