x11_recorder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 230c768bfb2889155436ab71b053f81ac1ccc87b
+  data.tar.gz: 0b2e9c94f42d7b568b1f1ef13803b897ea6dcdc8
+SHA512:
+  metadata.gz: a7419bbfcc5164e38532c385d3b7b8fd5d7258929e146d3b4bedd2782fe4259c17de8966843640c61387be2278ac4c084701a6346ed3f5b609f21a4bfc8c3391
+  data.tar.gz: 1d0fd5571acc6a3d33e0ca46028eec5924bf598fc55a0c24c95632dd780adf42106530e5762b3d1ee6fb253bbafa39a9e864e2b1518fb5fe339247c93876012f

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    x11_recorder (0.0.1)
+      childprocess (>= 0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    ffi (1.9.3)
+    mime-types (2.3)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    rake (0.9.6)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.2)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  rake (~> 0.9.2)
+  rspec (~> 2.5)
+  x11_recorder!

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jason Gowan
+
+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.mdown

@@ -0,0 +1,43 @@
+X11 Recorder
+============
+
+Thin wrapper around ffmpeg to record X11 displays.
+
+Requirements
+====
+* X11 display
+* Debian/Ubuntu (apt-get install ffmpeg)
+* CentOS/RHEL/Fedora -> setup rpmfusion then yum install ffmpeg
+* Arch Linux (pacman -S ffmpeg)
+
+Usage
+====
+
+```ruby
+require 'x11_recorder'
+
+recorder = X11Recorder::Display.new(
+  :filename => 'test_video.mp4',
+  :codec    => 'mpeg4',
+  :display  => ':1',
+  :frame_rate => '5',
+  :frame_size => '1024x768')
+
+recorder.start
+
+# do something
+
+recorder.stop
+```
+
+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.
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/x11_recorder.rb

@@ -0,0 +1,7 @@
+
+require 'childprocess'
+
+module X11Recorder
+end
+
+require 'x11_recorder/display'

data/lib/x11_recorder/display.rb

@@ -0,0 +1,48 @@
+
+module X11Recorder
+  class Display
+
+    DEFAULT_OPTIONS = {
+      :filename => './test.mp4',
+      :codec => 'mpeg4',
+      :display => ENV['DISPLAY'],
+      :frame_rate => '5',
+      :frame_size => '1024x768'
+    }
+
+    def initialize(opts = {})
+      @options = DEFAULT_OPTIONS.dup.merge(opts)
+    end
+
+    def start
+      @recorder = create_process
+      @recorder.start
+    end
+
+    def stop
+      @recorder && @recorder.stop
+      @recorder = nil
+    end
+
+    private
+
+    def create_process
+      @output = @options[:filename]
+
+      process = ChildProcess.build(
+        'ffmpeg',
+        '-an',
+        '-y',
+        '-f', 'x11grab',
+        '-r', @options[:frame_rate],
+        '-s', @options[:frame_size],
+        '-i', @options[:display],
+        '-vcodec', @options[:codec],
+        @options[:filename]
+      )
+
+      process.io.stdout = process.io.stderr = File.open('/dev/null', 'w')
+      process
+    end
+  end
+end

data/lib/x11_recorder/version.rb

@@ -0,0 +1,5 @@
+
+module X11Recorder
+  VERSION = '0.0.1'
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
+
+$LOAD_PATH.unshift File.expand_path("../lib")
+require 'x11_recorder'

data/spec/x11_recorder/display_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module X11Recorder
+  describe Display do
+    let(:mock_process) { double(ChildProcess, :start => nil, :stop => nil, :io => double('io').as_null_object) }
+
+    it "can start recorder with default mp4 options" do
+      display = ENV['DISPLAY'] || ':1'
+      ChildProcess.should_receive(:build).with(
+        'ffmpeg',
+        '-an',
+        '-y',
+        '-f', 'x11grab',
+        '-r', '5',
+        '-s', '1024x768',
+        '-i', display,
+        '-vcodec', 'mpeg4',
+        './test.mp4'
+      ).and_return(mock_process)
+      mock_process.should_receive(:start)
+      mock_process.should_receive(:stop)
+
+      recorder = X11Recorder::Display.new
+      recorder.start
+      recorder.stop
+    end
+
+    it "can start recorder with non-default mp4 options" do
+      ChildProcess.should_receive(:build).with(
+        'ffmpeg',
+        '-an',
+        '-y',
+        '-f', 'x11grab',
+        '-r', '6',
+        '-s', '768x768',
+        '-i', ':42',
+        '-vcodec', 'v8',
+        './test.webm'
+      ).and_return(mock_process)
+      mock_process.should_receive(:start)
+      mock_process.should_receive(:stop)
+
+      recorder = X11Recorder::Display.new(
+        :filename => './test.webm',
+        :codec => 'v8',
+        :display => ':42',
+        :frame_rate => '6',
+        :frame_size => '768x768'
+      )
+      recorder.start
+      recorder.stop
+    end
+
+  end
+end

data/x11_recorder.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "x11_recorder/version"
+
+Gem::Specification.new do |s|
+  s.name        = "x11_recorder"
+  s.version     = X11Recorder::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jason Gowan"]
+  s.email       = ["gowanjason@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Thin wrapper around ffmpeg to record X11 displays}
+  s.description = %q{Thin wrapper around ffmpeg to record X11 displays}
+
+  s.rubyforge_project = "x11_recorder"
+
+  s.add_dependency "childprocess", ">= 0.0.1"
+  s.add_development_dependency "rspec", "~> 2.5"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "rake", "~> 0.9.2"
+
+  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"]
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: x11_recorder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Gowan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Thin wrapper around ffmpeg to record X11 displays
+email:
+- gowanjason@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.mdown
+- Rakefile
+- lib/x11_recorder.rb
+- lib/x11_recorder/display.rb
+- lib/x11_recorder/version.rb
+- spec/spec_helper.rb
+- spec/x11_recorder/display_spec.rb
+- x11_recorder.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: x11_recorder
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Thin wrapper around ffmpeg to record X11 displays
+test_files:
+- spec/spec_helper.rb
+- spec/x11_recorder/display_spec.rb