screen-recorder 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c04070110a0bb4d14c22683e2e226f68a2245ec8d0ae5ebf098e8a028fc22050
-  data.tar.gz: eac8f6a6036d62a7634fd61b77a0a864ea589aa3b4d2d5e1693f6a813692d4cd
+  metadata.gz: 45346a64b3fbf881ad0e84d86b60071870c88ceb4903c887b8986523cd9cbc54
+  data.tar.gz: 9534f82f4a2f777beedd390f4bc684947f5a1439eb0c7cd197d4a5fca53a87ac
 SHA512:
-  metadata.gz: 1cd22bbff801124ed2e3c42d94aa50cf8f568b473dcdff045e150bf25e543d0ff81d7d8a99da78ef2e6d8fffb5e57bc8d00a291dec4b72c7abe8f37453bf5e2e
-  data.tar.gz: ca1af2f484ca9e360dcf94096f7066013e9fe645471c36173d417c589c1cbe12d533bc1269ae44f27fe17a61252a2e1ede833ce9dfc45bcf9daaaeb038866f18
+  metadata.gz: b41efb69403ff6739d94f43a663366fb50532bf5289b62fcdea478539299d7e1031f492ae0bda43db8a5e228b42205c585e9e9e29b85609e0eebda283b0c151b
+  data.tar.gz: 00f30237b8c76aa88ee19333c2c84cb43e9170bc0df3caa6b89a0591b78852ef4483709dbe00869c4672ef754ef8fa67f626ad42593a797eef4e653848217317

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+### 1.6.0 (2021-08-22)
+* Match "childprocess" gem version to `selenium-webdriver`. Closes [#99](https://github.com/kapoorlakshya/screen-recorder/issues/99).
+* Add support for screenshot resolution. Closes [#98](https://github.com/kapoorlakshya/screen-recorder/issues/98).
+
 ### 1.5.0 (2021-03-23)
 * Relax "os" gem version to minor level ([#97](https://github.com/kapoorlakshya/screen-recorder/pull/97)). Thanks, [hlascelles](https://github.com/hlascelles)!
 

data/README.md

@@ -166,6 +166,13 @@ window_title = ScreenRecorder::('chrome').first
 @recorder.screenshot('after-recording.png')
 browser.quit 
 ```
+
+You can even specify a custom capture resolution:
+
+```rb
+@recorder.screenshot('screenshot.png', '1024x768')
+```
+
 #### Video Output
 
 Once the recorder is stopped, you can view the video metadata or transcode

data/lib/screen-recorder.rb

@@ -78,5 +78,6 @@ require 'screen-recorder/errors'
 require 'screen-recorder/options'
 require 'screen-recorder/titles'
 require 'screen-recorder/common'
+require 'screen-recorder/screenshot'
 require 'screen-recorder/desktop'
 require 'screen-recorder/window'

data/lib/screen-recorder/common.rb

@@ -40,20 +40,6 @@ module ScreenRecorder
       @video = prepare_video unless exit_code == 1
     end
 
-    #
-    # Takes a screenshot in the current context (input) - desktop or current window
-    #
-    def screenshot(filename)
-      process   = execute_command(screenshot_cmd(filename))
-      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
-
     #
     # Discards the recorded file. Useful in automated testing
     # when a test passes and the recorded file is no longer
@@ -124,14 +110,6 @@ module ScreenRecorder
       "#{ffmpeg_bin} #{@options.parsed}"
     end
 
-    #
-    # Parameters to capture a single frame
-    #
-    def screenshot_cmd(filename)
-      # -f overwrites existing file
-      "#{ffmpeg_bin} -f #{options.capture_device} -i #{options.input} -framerate 1 -frames:v 1 #{filename}"
-    end
-
     #
     # Returns true if ffmpeg binary is found.
     #

data/lib/screen-recorder/desktop.rb

@@ -2,6 +2,8 @@
 module ScreenRecorder
   # @since 1.0.0-beta11
   class Desktop < Common
+    include Screenshot
+
     DEFAULT_INPUT_WIN = 'desktop'.freeze
     DEFAULT_INPUT_LINUX = ':0'.freeze
     DEFAULT_INPUT_MAC = '1'.freeze

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.5.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.
     #

data/screen-recorder.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'watir', '~> 6.0'
   spec.add_development_dependency 'webdrivers', '~> 4.0'
 
-  spec.add_runtime_dependency 'childprocess', '>= 1.0', '< 4.0' # Roughly match Selenium
+  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.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Lakshya Kapoor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -145,7 +145,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,7 +155,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
@@ -209,6 +209,7 @@ 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
@@ -219,8 +220,8 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/kapoorlakshya/screen-recorder/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/kapoorlakshya/screen-recorder/tree/v1.5.0
-  documentation_uri: https://www.rubydoc.info/gems/screen-recorder/1.5.0
+  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: