ffmpeg-screenrecorder 1.0.0.beta9 → 1.0.0.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12cfdba9f1cb9d3296d231d3cc1c6262ff6f2350a1bd79db2d66db3e12d06e09
-  data.tar.gz: a8be75c4fe64a40eff487fdc9345f612f185f21c1df7f81f31944a07913af72c
+  metadata.gz: 362b8478473163a4c1b072b4bd556560dbad3fd6f50f258e6f6fbebdfb01955c
+  data.tar.gz: c9f64e399242f570bf87e0dd1483b92e2bd63c17e8ec97aebe2686067f446f8c
 SHA512:
-  metadata.gz: 116ffbcc5f2532a017f5d5fe02d2d44759301ad8955d91e6711fe186941a33064f82fecb03c92f10a12436e6159b0015c8449ddfd2fa439d5aa51b510bc673e2
-  data.tar.gz: 57867328f8e57dac849f63ba0be69f45fa365a8e6036c38e0c422b3dc3fd43f74b4a07321267cd7452d3ee460ba66d72f35d60764686fbf47240a7d28366fec9
+  metadata.gz: 44287d64e556d2ae9ae720c55d9fddeb19acb9085943b083bc88c8eac6c15cebd97ef40f085d01d12a21bddbd4501a2e0eed2036aca5a0f2a8d44f5a52f2ba4c
+  data.tar.gz: f94b1e95dd4adb95f3b8f1e0c3f7c374c55009f9afafeef37475aefffb43a0c592c6dd8f27cf152ffad1a9df955a1a78df1730904ac36774352d73de58c59232

data/.rubocop.yml

@@ -44,4 +44,7 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 
 TrailingBlankLines:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
   Enabled: false

data/CHANGES.md

@@ -1,3 +1,24 @@
+### 1.0.0.beta10 (2019-02-05)
+* Fixed an edge case in Microsoft Windows specific implementation of
+`WindowTitles#fetch` where processes with mismatching names and window
+titles, such as process `"Calculator.exe"` with window title `"CicMarshalWnd"`,
+were omitted ([#35](https://github.com/kapoorlakshya/ffmpeg-screenrecorder/issues/35)).
+This fix also prints a warning when this mismatch occurs.
+* The fix for #35 introduces a mild inconvenience when using
+applications like Chrome, which spawn a new process per window or
+extension. `#fetch` now returns titles for these additional processes
+with the visible window (web page) title. In a future release, you will
+be able to use something like `full_match: true` to prevent this.
+* Fixed bug in Linux specific `WindowTitles#fetch` implementation where
+the filter by application name logic was removed. This filter is required
+on Linux here because `wmctrl` returns all open window titles unlike
+Microsoft Windows where `taskmgr` allows us get window titles by process
+name.
+* On Linux, you are now required to provide the `input` as `"desktop"`
+or a display number, such as `":0.0"`. Run `echo $DISPLAY` to check your display number.
+* QOL improvements - Type checking of inputs, spec cleanup, added more
+tests, and fixed rubocop warnings.
+
 ### 1.0.0.beta9 (2019-01-22)
 
 * :warning: `FFMPEG::RecordingRegions` is now `FFMPEG::WindowTitles`, so the module name is true to the function it provides.

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/ffmpeg-screenrecorder.svg)](https://badge.fury.io/rb/ffmpeg-screenrecorder)
 ![https://rubygems.org/gems/ffmpeg-screenrecorder](https://ruby-gem-downloads-badge.herokuapp.com/ffmpeg-screenrecorder?type=total)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/kapoorlakshya/ffmpeg-screenrecorder/master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a176dc755e06a23e5db8/maintainability)](https://codeclimate.com/github/kapoorlakshya/ffmpeg-screenrecorder/maintainability)
 
 Ruby gem to record your computer screen - desktop or specific application/window - using [FFmpeg](https://www.ffmpeg.org/).
 
@@ -12,33 +13,18 @@ Supports Windows and Linux as of version `1.0.0-beta5`. macOS support will be ad
 
 ## Installation
 
-On Microsoft Windows, [download](https://www.ffmpeg.org/download.html#build-windows), extract and add the location of `/bin` to your ENV `PATH` variable.  If you want to use `libx264`, download
-[this build](https://ffmpeg.zeranoe.com/builds/) instead.
-
-For Linux, follow instructions here - https://ffmpeg.org/download.html#build-linux
-
-Once installed, make sure ffmpeg is found:
-
-    $ ffmpeg -version
-    ffmpeg version N-92132-g0a41a8bf29 Copyright (c) 2000-2018 the FFmpeg developers
-    built with gcc 8.2.1 (GCC) 20180813
-    configuration: --enable-gpl --enable-version3 --enable-sdl2 --enable-fontconfig --enable-g
-    nutls --enable-iconv --enable-libass --enable-libbluray --enable-libfreetype --enable-libm
-    p3lame --enable-libopencore-amrnb --enable-libopencore-amrwb --enable-libopenjpeg --enable
-    -libopus --enable-libshine --enable-libsnappy --enable-libsoxr --enable-libtheora --enable
-    -libtwolame --enable-libvpx --enable-libwavpack --enable-libwebp --enable-libx264 --enable
-    -libx265 --enable-libxml2 --enable-libzimg --enable-lzma --enable-zlib --enable-gmp --enab
-    le-libvidstab --enable-libvorbis --enable-libvo-amrwbenc --enable-libmysofa --enable-libsp
-    eex --enable-libxvid --enable-libaom --enable-libmfx --enable-amf --enable-ffnvcodec --ena
-    ble-cuvid --enable-d3d11va --enable-nvenc --enable-nvdec --enable-dxva2 --enable-avisynth
-    libavutil      56. 19.101 / 56. 19.101
-    libavcodec     58. 32.100 / 58. 32.100
-    libavformat    58. 18.104 / 58. 18.104
-    libavdevice    58.  4.105 / 58.  4.105
-    libavfilter     7. 33.100 /  7. 33.100
-    libswscale      5.  2.100 /  5.  2.100
-    libswresample   3.  2.100 /  3.  2.100
-    libpostproc    55.  2.100 / 55.  2.100
+#### 1. Setup FFmpeg
+
+| OS                | Download                                                                       |
+|-------------------|--------------------------------------------------------------------------------|
+| Microsoft Windows | [ffmpeg.org#build-windows](https://www.ffmpeg.org/download.html#build-windows) or [libx264 enabled build](https://ffmpeg.zeranoe.com/builds/) |
+| Linux             | [ffmpeg.org#build-linux](https://ffmpeg.org/download.html#build-linux) |
+| macOS             | [ffmpeg.org#build-mac](https://www.ffmpeg.org/download.html#build-mac) |
+
+Add location of the `ffmpeg/bin` folder to `PATH` environment variable if using Microsoft Windows ([instructions](https://windowsloop.com/install-ffmpeg-windows-10/)).
+Alternatively, you can define the location using `FFMPEG.ffmpeg_binary='/path/to/binary'` in your project.
+
+#### 2. Install gem
 
 Next, add this line to your application's Gemfile:
 
@@ -48,65 +34,57 @@ gem 'ffmpeg-screenrecorder'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install ffmpeg-screenrecorder
-
-Require it in your project and start using the gem:
-
-    require ffmpeg-screenrecorder
-
-## Usage
-
-#### Required Options
-
-- `:input` - `'desktop'` or application window name
-- `:output` - Output file location/name
-- `:framerate` - Capture FPS
-
-#### Advanced Options
+```bash
+$ gem install ffmpeg-screenrecorder --pre
+```
 
-- `:log`  - Defaults to `ffmpeg.log`
-- `:log_level` for this gem
+#### 3. Require gem
 
-All other FFmpeg options can be passed through the `advanced` key. This feature is yet to be fully tested, so please feel free to report any bugs or request a feature.
+Require this gem in your project and start using the gem:
 
-```
-opts = { input:     'desktop',
-         output:    'recorder-test.mp4',
-         framerate: 15,
-         log:       'recorder.log',
-         log_level: Logger::DEBUG, # For gem
-         advanced: { loglevel: 'level+debug', # For FFmpeg
-                     video_size:  '640x480',
-                     show_region: '1' }
-}
+```ruby
+require 'ffmpeg-screenrecorder'
 ```
 
 ##### Record Desktop
 
-```
+```ruby
 opts      = { input:     'desktop',
-              output:    'screenrecorder-desktop.mp4',
+              output:    'recording.mp4',
               framerate: 15.0 }
 @recorder = FFMPEG::ScreenRecorder.new(opts)
-
-# Start recording
-@recorder.start #=> #<IO:fd 5>
+@recorder.start
 
 # ... Run tests or whatever you want to record
 
-# Stop recording
-@recorder.stop #=> #<FFMPEG::Movie...>
+@recorder.stop
 
-# Recorded file
-@recorder.video #=> #<FFMPEG::Movie...>
+# Recorded file metadata
+@recorder.video
+#=> #<FFMPEG::Movie:0x00000000067e0a08
+    @path="screenrecorder-desktop.mp4",
+    @container="mov,mp4,m4a,3gp,3g2,mj2",
+    @duration=5.0,
+    @time=0.0,
+    @creation_time=nil,
+    @bitrate=1051,
+    @rotation=nil,
+    @video_stream="h264 (High 4:4:4 Predictive) (avc1 / 0x31637661), yuv444p, 2560x1440, 1048 kb/s, 15 fps, 15 tbr, 15360 tbn, 30 tbc (default)",
+    @audio_stream=nil,
+    @video_codec="h264 (High 4:4:4 Predictive) (avc1 / 0x31637661)", @colorspace="yuv444p",
+    @video_bitrate=1048,
+    @resolution="2560x1440">
 ```
 
-##### Record Application Window - Microsoft Windows (`gdigrab`) Only
-```
+##### Record Application Window
+
+```ruby
 require 'watir'
 
 browser = Watir::Browser.new :firefox
@@ -115,33 +93,62 @@ FFMPEG::WindowTitles.fetch('firefox') # Name of exe
 #=> ["Mozilla Firefox"]
 
 opts      = { input:     FFMPEG::WindowTitles.fetch('firefox').first,
-              output:    'screenrecorder-firefox.mp4',
-              framerate: 15.0,
-              log:       'screenrecorder-firefox.log' }
+              output:    'recording.mp4',
+              framerate: 15.0 }
 @recorder = FFMPEG::ScreenRecorder.new(opts)
-
-# Start recording
 @recorder.start
 
 # Run tests or whatever you want to record
-browser.goto 'watir.com'
-browser.link(text: 'News').wait_until_present.click
 
-# Stop recording
 @recorder.stop
-
 browser.quit 
 ```
 
-<b>Note</b>:
-- Always stop the recording before closing the application. Otherwise, ffmpeg will force exit as soon as the window disappears and may produce an invalid video file.
-- If you're launching multiple applications or testing an application at different window sizes, recording the `desktop` is a better option.
+<b>Limitations</b>:
+- Only works on Microsoft Windows (gdigrab).
+- `#fetch` only returns titles from currently active (visible) windows.
+- `#fetch` may return `ArgumentError (invalid byte sequence in UTF-8)`
+for a window title with non `UTF-8` characters.
+See [#38](https://github.com/kapoorlakshya/ffmpeg-screenrecorder/issues/38)
+for workaround.
+- Always stop the recording before closing the application. Otherwise,
+ffmpeg will force exit as soon as the window disappears and may produce
+an invalid video file.
+- If you're launching multiple applications or testing an application
+at different window sizes, recording the `desktop` is a better option.
+
+#### Options
 
-## Demo
+- `:input` - `'desktop'` or application window name
+- `:output` - Output file location/name
+- `:framerate` - Capture FPS
+- `:log`  - Defaults to `ffmpeg.log`
+- `:log_level` for this gem. Default: ERROR
+
+All other FFmpeg options can be passed through the `advanced` key. This feature is yet to be fully tested, so please feel free to report any bugs or request a feature.
+
+```ruby
+opts = { input:     'desktop',
+         output:    'recorder-test.mp4',
+         framerate: 15,
+         log:       'recorder.log',
+         log_level: Logger::DEBUG, # For gem
+         advanced: { loglevel: 'level+debug', # For FFmpeg
+                     video_size:  '640x480',
+                     show_region: '1' }
+}
 
-You can find example video recordings here - [https://kapoorlakshya.github.io/introducing-ffmpeg-screenrecorder](https://kapoorlakshya.github.io/introducing-ffmpeg-screenrecorder)
+#
+# Command to FFmpeg:
+#
+# ffmpeg -y -f gdigrab -r 15 -loglevel level+debug -video_size 640x480
+#   -show_region 1 -i desktop recorder-test.mp4 2> recorder.log
+```
 
-Cucumber + Watir based example - [kapoorlakshya/cucumber-watir-test-recorder-example](https://github.com/kapoorlakshya/cucumber-watir-test-recorder-example)
+## Demo
+
+You can find example video recordings [here](https://kapoorlakshya.github.io/introducing-ffmpeg-screenrecorder).
+Cucumber + Watir based example is [here](https://github.com/kapoorlakshya/cucumber-watir-test-recorder-example).
 
 ## Development
 
@@ -162,6 +169,12 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Credits
 
+[![Streamio](http://d253c4ja9jigvu.cloudfront.net/assets/small-logo.png)](http://streamio.com)
+
+This gem is based on the [streamio-ffmpeg](https://github.com/streamio/streamio-ffmpeg) gem.
+<br />
+<br />
+
 ![SauceLabs Logo](https://saucelabs.com/content/images/logo.png)
 
 Thanks to [SauceLabs](https://saucelabs.com) for providing me with a free account. If you manage an open source project, you can apply for a free account [here](https://saucelabs.com/open-source).

data/lib/ffmpeg/recorder_options.rb

@@ -4,12 +4,8 @@ module FFMPEG
     DEFAULT_LOG_FILE = 'ffmpeg.log'.freeze
 
     def initialize(options)
-      raise ArgumentError, "Expected Hash, given: #{options.class}" unless options.is_a? Hash
-
-      if options[:advanced]
-        raise ArgumentError, "Expected Hash, given: #{options.class}" unless options[:advanced].is_a? Hash
-      end
-
+      TypeChecker.check options, Hash
+      TypeChecker.check options[:advanced], Hash if options[:advanced]
       @options = verify_options options
     end
 
@@ -86,7 +82,8 @@ module FFMPEG
 
     #
     # Verifies the required options are provided and returns
-    # the given options Hash
+    # the given options Hash. Raises ArgumentError if all required
+    # options are not present in the given Hash.
     #
     def verify_options(options)
       missing_options = required_options.select { |req| options[req].nil? }
@@ -100,12 +97,7 @@ module FFMPEG
     # Returns Array of required options sa Symbols
     #
     def required_options
-      # -r framerate
-      # -i input
-      # output
-      return %i[framerate input output] unless OS.linux?
-
-      %i[framerate output] # Linux
+      %i[framerate input output]
     end
 
     #
@@ -138,7 +130,11 @@ module FFMPEG
     #
     def determine_input
       # x11grab doesn't support window capture
-      return ':99' if OS.linux?
+      if OS.linux?
+        return ':0.0' if @options[:input] == 'desktop'
+
+        return @options[:input] # User given display number
+      end
 
       return @options[:input] if @options[:input] == 'desktop'
 

data/lib/ffmpeg/screenrecorder.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require_relative 'type_checker'
 require_relative 'recorder_errors'
 require_relative 'recorder_options'
 require_relative 'window_titles'

data/lib/ffmpeg/type_checker.rb

@@ -0,0 +1,12 @@
+module FFMPEG
+  # @since 1.0.0.beta10
+  module TypeChecker
+    #
+    # Compares the given object's type (class) to the desired object type.
+    # Raises an ArgumentError if the object is not of desired type.
+    #
+    def self.check(obj, klass)
+      raise ArgumentError, "Expected #{klass}, given: #{obj.class}" unless obj.is_a? klass
+    end
+  end
+end

data/lib/ffmpeg/version.rb

@@ -1,5 +1,5 @@
 module FFMPEG
   class ScreenRecorder
-    VERSION = '1.0.0.beta9'.freeze
+    VERSION = '1.0.0.beta10'.freeze
   end
 end

data/lib/ffmpeg/window_titles.rb

@@ -1,6 +1,8 @@
 module FFMPEG
   # @since 1.0.0-beta4
   module WindowTitles
+    IGNORED_WINDOW_TITLES = %r{^Window Title:( N/A|\s+)?} # From Chrome extensions
+
     #
     # Returns a list of available window titles for the given application (process) name.
     #
@@ -25,32 +27,33 @@ module FFMPEG
       private
 
       #
-      # Returns list of windows when using Microsoft Windows
+      # Returns list of window titles in FFmpeg expected format when using Microsoft Windows
       #
       def windows_os_window(application)
-        raw_list   = `tasklist /v /fi "imagename eq #{application}.exe" /fo list | findstr  Window`
-                       .split("\n")
-                       .select { |t| t.match?(/#{application}/i) } # Narrow down to given application
-        final_list = raw_list.map { |i| i.gsub('Window Title: ', '') } # Match ffmpeg expected format
-        raise RecorderErrors::ApplicationNotFound, "No open windows found for: #{application}.exe" if final_list.empty?
+        titles = `tasklist /v /fi "imagename eq #{application}.exe" /fo list | findstr  Window`
+                   .split("\n")
+                   .map { |i| i.gsub(IGNORED_WINDOW_TITLES, '') }
+                   .reject(&:empty?)
+        raise RecorderErrors::ApplicationNotFound, "No open windows found for: #{application}.exe" if titles.empty?
 
-        final_list
+        warn_on_mismatch(titles, application)
+        titles
       end
 
       #
-      # Returns list of windows when using Linux
+      # Returns list of window titles in FFmpeg expected format when using Linux
       #
       def linux_os_window(application)
-        FFMPEG.logger.warn 'Note: Default capture device x11grab on Linux does not support window recording.'
-        raise DependencyNotFound, 'wmctrl is not installed. Run: sudo apt-get install wmctrl.' unless wmctrl_installed?
+        FFMPEG.logger.warn 'Default capture device on Linux (x11grab) does not support window recording.'
+        raise DependencyNotFound, 'wmctrl is not installed. Run: sudo apt install wmctrl.' unless wmctrl_installed?
 
-        final_list = `wmctrl -l | awk '{$3=""; $2=""; $1=""; print $0}'` # Returns all open windows
-                       .split("\n")
-                       .map(&:strip)
-                       .select { |t| t.match?(/#{application}/i) } # Narrow down to given application
-        raise RecorderErrors::ApplicationNotFound, "No open windows found for: #{application}" if final_list.empty?
+        titles = `wmctrl -l | awk '{$3=""; $2=""; $1=""; print $0}'` # Returns all open windows
+                   .split("\n")
+                   .map(&:strip)
+                   .select { |t| t.match?(/#{application}/i) } # Narrow down to given application
+        raise RecorderErrors::ApplicationNotFound, "No open windows found for: #{application}" if titles.empty?
 
-        final_list
+        titles
       end
 
       #
@@ -59,6 +62,17 @@ module FFMPEG
       def wmctrl_installed?
         !`which wmctrl`.empty? # "" when not found
       end
-    end
+
+      #
+      # Prints a warning if the retrieved list of window titles does no include
+      # the given application process name, which applications commonly do.
+      #
+      def warn_on_mismatch(titles, application)
+        unless titles.map(&:downcase).join(',').include? application.to_s
+          FFMPEG.logger.warn "Process name and window title(s) do not match: #{titles}"
+          FFMPEG.logger.warn "Please manually provide the displayed window title."
+        end
+      end
+    end # class WindowGrabber
   end # module Windows
 end # module FFMPEG

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffmpeg-screenrecorder
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta9
+  version: 1.0.0.beta10
 platform: ruby
 authors:
 - Lakshya Kapoor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -132,6 +132,7 @@ files:
 - lib/ffmpeg/recorder_errors.rb
 - lib/ffmpeg/recorder_options.rb
 - lib/ffmpeg/screenrecorder.rb
+- lib/ffmpeg/type_checker.rb
 - lib/ffmpeg/version.rb
 - lib/ffmpeg/window_titles.rb
 homepage: http://github.com/kapoorlakshya/ffmpeg-screenrecorder