screen-recorder 1.3.0 → 1.6.0

data/lib/screen-recorder/options.rb

@@ -6,17 +6,17 @@ module ScreenRecorder
   class Options
     attr_reader :all
 
-    DEFAULT_LOG_FILE          = 'ffmpeg.log'.freeze
-    DEFAULT_FPS               = 15.0
+    DEFAULT_LOG_FILE = 'ffmpeg.log'.freeze
+    DEFAULT_FPS = 15.0
     DEFAULT_MAC_INPUT_PIX_FMT = 'uyvy422'.freeze # For avfoundation
-    DEFAULT_PIX_FMT           = 'yuv420p'.freeze
-    YUV420P_SCALING           = '"scale=trunc(iw/2)*2:trunc(ih/2)*2"'.freeze
+    DEFAULT_PIX_FMT = 'yuv420p'.freeze
+    YUV420P_SCALING = '"scale=trunc(iw/2)*2:trunc(ih/2)*2"'.freeze
 
     def initialize(options)
       # @todo Consider using OpenStruct
-      @all                 = verify_options options
-      advanced[:input]     = default_advanced_input.merge(advanced_input)
-      advanced[:output]    = default_advanced_output.merge(advanced_output)
+      @all = verify_options options
+      advanced[:input] = default_advanced_input.merge(advanced_input)
+      advanced[:output] = default_advanced_output.merge(advanced_output)
       advanced[:log] ||= DEFAULT_LOG_FILE
 
       # Fix for using yuv420p pixel format for output
@@ -74,9 +74,9 @@ module ScreenRecorder
     def parsed
       vals = "-f #{capture_device} "
       vals << parse_advanced(advanced_input)
-      vals << "-i #{input} "
-      vals << parse_advanced(advanced_output)
+      vals << "-i #{input} " unless advanced_input[:i] # Input provided by user
       vals << parse_advanced(advanced)
+      vals << parse_advanced(advanced_output)
       vals << output
     end
 
@@ -91,7 +91,7 @@ module ScreenRecorder
       TypeChecker.check options, Hash
       TypeChecker.check options[:advanced], Hash if options[:advanced]
       missing_options = required_options.select { |req| options[req].nil? }
-      err             = "Required options are missing: #{missing_options}"
+      err = "Required options are missing: #{missing_options}"
       raise(ArgumentError, err) unless missing_options.empty?
 
       options
@@ -131,31 +131,32 @@ module ScreenRecorder
     def parse_advanced(opts)
       # @todo Replace arr with opts.each_with_object([])
       arr = []
+      rejects = %i[input output log]
       # Do not parse input/output and log as they're placed separately in #parsed
-      opts.reject { |k, _| %i[input output log].include? k }
+      opts.reject { |k, _| rejects.include? k }
         .each do |k, v|
         arr.push "-#{k} #{v}" unless v.nil? # Ignore blank params
       end
-      arr.join(' ') + ' '
+      "#{arr.join(' ')} "
     end
 
     #
     # Returns input capture device based on user given value or the current OS.
     #
     def determine_capture_device
-      # User given capture device or format
+      # User given capture device or format from advanced configs Hash
       # @see https://www.ffmpeg.org/ffmpeg.html#Main-options
-      return advanced[:f] if advanced[:f]
+      return advanced_input[:f] if advanced_input[:f]
 
-      return advanced[:fmt] if advanced[:fmt]
+      return advanced_input[:fmt] if advanced_input[:fmt]
 
-      os_specific_capture_device
+      default_capture_device
     end
 
     #
     # Returns input capture device for current OS.
     #
-    def os_specific_capture_device
+    def default_capture_device
       return 'gdigrab' if OS.windows?
 
       return 'x11grab' if OS.linux?

data/lib/screen-recorder/screenshot.rb

@@ -0,0 +1,39 @@
+module ScreenRecorder
+  # All screenshot related code
+  module Screenshot
+    #
+    # Takes a screenshot in the current context (input) - desktop or current window
+    #
+    def screenshot(filename, resolution = nil)
+      ScreenRecorder.logger.debug "Screenshot filename: #{filename}, resolution: #{resolution}"
+      cmd = screenshot_cmd(filename: filename, resolution: resolution)
+      process = execute_command(cmd)
+      exit_code = wait_for_process_exit(process) # 0 (success) or 1 (fail)
+      if exit_code&.zero?
+        ScreenRecorder.logger.info "Screenshot: #{filename}"
+        return filename
+      end
+      ScreenRecorder.logger.error 'Failed to take a screenshot.'
+      nil
+    end
+
+    #
+    # Parameters to capture a single frame
+    #
+    def screenshot_cmd(filename:, resolution: nil)
+      resolution = resolution ? resolution_arg(resolution) : nil
+      # -f overwrites existing file
+      "#{ffmpeg_bin} -f #{options.capture_device} -i #{options.input} -framerate 1 -frames:v 1 #{resolution}#{filename}"
+    end
+
+    private
+
+    #
+    # Returns OS specific video resolution arg for ffmpeg
+    #
+    def resolution_arg(size)
+      # macOS likes -s, windows and linux like -video_size
+      OS.mac? ? "-s #{size} " : "-video_size #{size} "
+    end
+  end
+end

data/lib/screen-recorder/version.rb

@@ -1,3 +1,3 @@
 module ScreenRecorder
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/lib/screen-recorder/window.rb

@@ -2,6 +2,8 @@
 module ScreenRecorder
   # @since 1.0.0-beta11
   class Window < Common
+    include Screenshot
+
     #
     # Window recording mode.
     #
@@ -21,7 +23,7 @@ module ScreenRecorder
       #   ScreenRecorder::Window.fetch_title('chrome')
       #   #=> ["New Tab - Google Chrome"]
       def fetch_title(process_name)
-        ScreenRecorder.logger.debug "Retrieving window title for: #{process_name}"
+        ScreenRecorder.logger.debug "Retrieving window title from '#{process_name}'"
         window_title_for process_name
       end
 
@@ -43,6 +45,8 @@ module ScreenRecorder
         raise Errors::ApplicationNotFound, "No open windows found for: #{process_name}.exe" if titles.empty?
 
         warn_on_mismatch(titles, process_name)
+        ScreenRecorder.logger.debug "Retrieved titles: #{titles}"
+
         titles
       end
 

data/screen-recorder.gemspec

@@ -9,15 +9,15 @@ Gem::Specification.new do |spec|
   spec.authors               = ['Lakshya Kapoor']
   spec.email                 = ['kapoorlakshya@gmail.com']
   spec.homepage              = 'http://github.com/kapoorlakshya/screen-recorder'
-  spec.summary               = 'Video record your computer screen using FFmpeg.'
-  spec.description           = 'Video record your computer screen - desktop or specific window - using FFmpeg ' \
-                               'on Windows, Linux, and macOS. Primarily geared towards recording automated UI ' \
-                               '(Selenium) test executions for debugging and documentation.'
+  spec.summary               = 'Video record and take screenshots your computer screen using FFmpeg.'
+  spec.description           = 'A Ruby gem to video record and take screenshots of your desktop or ' \
+                                  ' specific application window. Works on Windows, Linux, and macOS.'
   spec.license               = 'MIT'
-  # noinspection RubyStringKeysInHashInspection,RubyStringKeysInHashInspection,RubyStringKeysInHashInspection
+  # noinspection RubyStringKeysInHashInspection
   spec.metadata              = {
     'changelog_uri' => 'https://github.com/kapoorlakshya/screen-recorder/blob/master/CHANGELOG.md',
-    'source_code_uri' => 'https://github.com/kapoorlakshya/screen-recorder/',
+    'source_code_uri' => "https://github.com/kapoorlakshya/screen-recorder/tree/v#{ScreenRecorder::VERSION}",
+    'documentation_uri' => "https://www.rubydoc.info/gems/screen-recorder/#{ScreenRecorder::VERSION}",
     'bug_tracker_uri' => 'https://github.com/kapoorlakshya/screen-recorder/issues',
     'wiki_uri' => 'https://github.com/kapoorlakshya/screen-recorder/wiki'
   }
@@ -28,17 +28,17 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'ffi' # For selenium_webdriver on Windows
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'ffi' # For selenium-webdriver on Windows
+  spec.add_development_dependency 'rake', '>= 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.73'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.1.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
+  spec.add_development_dependency 'rubocop', '~> 0.75'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'watir', '~> 6.0'
   spec.add_development_dependency 'webdrivers', '~> 4.0'
 
-  spec.add_runtime_dependency 'childprocess', '~> 1.0'
-  spec.add_runtime_dependency 'os', '~> 1.0.0'
+  spec.add_runtime_dependency 'childprocess', '>= 1.0', '< 5.0' # Roughly match Selenium
+  spec.add_runtime_dependency 'os', '~> 1.0'
   spec.add_runtime_dependency 'streamio-ffmpeg', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: screen-recorder
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Lakshya Kapoor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-26 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.73'
+        version: '0.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.73'
+        version: '0.75'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -140,30 +140,36 @@ dependencies:
   name: childprocess
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: streamio-ffmpeg
   requirement: !ruby/object:Gem::Requirement
@@ -178,9 +184,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Video record your computer screen - desktop or specific window - using
-  FFmpeg on Windows, Linux, and macOS. Primarily geared towards recording automated
-  UI (Selenium) test executions for debugging and documentation.
+description: A Ruby gem to video record and take screenshots of your desktop or  specific
+  application window. Works on Windows, Linux, and macOS.
 email:
 - kapoorlakshya@gmail.com
 executables: []
@@ -188,16 +193,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE.md"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - bin/console
 - bin/setup
 - lib/screen-recorder.rb
@@ -205,21 +209,19 @@ files:
 - lib/screen-recorder/desktop.rb
 - lib/screen-recorder/errors.rb
 - lib/screen-recorder/options.rb
+- lib/screen-recorder/screenshot.rb
 - lib/screen-recorder/titles.rb
 - lib/screen-recorder/type_checker.rb
 - lib/screen-recorder/version.rb
 - lib/screen-recorder/window.rb
 - screen-recorder.gemspec
-- support/install_jruby.ps1
-- support/start_test_reporter.sh
-- support/start_xvfb.sh
-- support/stop_test_reporter.sh
 homepage: http://github.com/kapoorlakshya/screen-recorder
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/kapoorlakshya/screen-recorder/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/kapoorlakshya/screen-recorder/
+  source_code_uri: https://github.com/kapoorlakshya/screen-recorder/tree/v1.6.0
+  documentation_uri: https://www.rubydoc.info/gems/screen-recorder/1.6.0
   bug_tracker_uri: https://github.com/kapoorlakshya/screen-recorder/issues
   wiki_uri: https://github.com/kapoorlakshya/screen-recorder/wiki
 post_install_message: 
@@ -237,8 +239,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Video record your computer screen using FFmpeg.
+summary: Video record and take screenshots your computer screen using FFmpeg.
 test_files: []

data/.travis.yml

@@ -1,42 +0,0 @@
-language: ruby
-cache: bundler
-branches:
-  only:
-    - /.*/
-env:
-  global:
-    - DISPLAY=":0"
-matrix:
-  include:
-    - rvm: 2.4.6
-      dist: xenial
-      env: RAKE_TASK=spec
-    - rvm: 2.4.6
-      dist: xenial
-      env: RAKE_TASK=rubocop
-    - rvm: 2.6.3
-      dist: xenial
-      env: RAKE_TASK=spec
-    - rvm: jruby-9.2.7.0
-      dist: xenial
-      jdk: openjdk8
-      env: RAKE_TASK=spec JAVA_OPTS="-Djava.security.egd=file:/dev/./urandom"
-    - rvm: 2.6.3
-      os: osx
-      osx_image: xcode11
-      env: RAKE_TASK=spec
-addons:
-  firefox: latest
-  chrome: stable
-  apt:
-    packages:
-      - ffmpeg
-  homebrew:
-    packages:
-      - ffmpeg
-before_script:
-  - bash support/start_xvfb.sh
-  - bash support/start_test_reporter.sh
-script: bundle exec rake $RAKE_TASK
-after_script:
-  - bash support/stop_test_reporter.sh

data/appveyor.yml

@@ -1,39 +0,0 @@
-build: off
-cache:
-  - vendor/bundle
-environment:
-  matrix:
-    - RUBY_VERSION: Ruby24
-      RUBY_BIN: ruby
-      RAKE_TASK: spec
-      SCRIPT_CONTEXT: bundle exec
-    - RUBY_VERSION: Ruby24
-      RUBY_BIN: ruby
-      RAKE_TASK: rubocop
-      SCRIPT_CONTEXT: bundle exec
-    - RUBY_VERSION: Ruby26
-      RUBY_BIN: ruby
-      RAKE_TASK: spec
-      SCRIPT_CONTEXT: bundle exec
-    - RUBY_VERSION: jruby-9.2.7.0
-      RUBY_BIN: jruby
-      RAKE_TASK: spec
-      SCRIPT_CONTEXT: jruby -G -S
-install:
-  - ps: |
-      if ($env:RUBY_BIN -eq 'jruby')
-      {
-        support\install_jruby.ps1
-      }
-  - choco install ffmpeg
-  - set PATH=C:\%RUBY_VERSION%\bin;%PATH%
-  - '%RUBY_BIN% -S gem update --system'
-  - '%RUBY_BIN% -S gem install bundler'
-  - '%RUBY_BIN% -S bundle install'
-before_test:
-  - ffmpeg -version
-  - '%RUBY_BIN% -v'
-  - '%RUBY_BIN% -S gem -v'
-  - '%RUBY_BIN% -S bundle -v'
-test_script:
-  - '%SCRIPT_CONTEXT% rake %RAKE_TASK%'