ffmpeg-screenrecorder 1.0.0.beta7 → 1.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a472f64b6ba70b1f6b74ca6023f97ceba33c8d9977e8c6df2263513b60520af8
-  data.tar.gz: 33355f5984cca8c017ed1ec5dbfa065478bf3c512a7a40927a660bed4687c2f2
+  metadata.gz: b93c3e8b673ad688449c8af7a13f3b936f6f9c0665d9b265e0a4ffd5d5820018
+  data.tar.gz: 9fc25d97554efee3a142bbadaf4699220221dacec0e7e6158484593be13f206d
 SHA512:
-  metadata.gz: 32b9efa443e4ee7c7e25c8fd61fe173c207efa31c00cb41c3cbff8177014149a166a11d4560790a09337d5763870ebf8c8555f9362e4fe85b2b7dd7cc9c1b80e
-  data.tar.gz: 92d7c4b4f3c5db9fe021a0938353abb5979ba9bf4aff6f1607d16fb8b23f08145b01cf01ff94ce302f3809e8623f8bc45efc7f6a5c3a54fee1fea12c838c73bc
+  metadata.gz: fa97bae768e73ad1175005d9e13a51874d443e692c539b3cd329fd6a412f84bb5c00e9bb07c2683b198a79ef7d8876c57be0d71b3e8ee30ebb9141fbd2d42e19
+  data.tar.gz: 9fa3025ffae72d29381d0342f88fa938e6800374e967d4e741f47df201ec820e5e289ba57a1277eba61b332720c95a8fba8e4a79ce7350c20c6ec80b265b3d94

data/.rubocop.yml

@@ -42,3 +42,6 @@ Style/Documentation:
 # SupportedStyles: when_needed, always, never
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+TrailingBlankLines:
+  Enabled: false

data/.travis.yml

@@ -1,7 +1,23 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.6
+---
+sudo: required
+os:
+  - linux
+language: ruby
+cache: bundler
+branches:
+  only:
+    - master
+rvm:
+  - 2.5.3
+addons:
+  firefox: latest
+before_install:
+  - gem update --system
+  - gem install bundler
+  - bundle update
+before_script:
+  - sudo add-apt-repository -y ppa:mc3man/trusty-media
+  - sudo apt-get update
+  - sudo apt-get install -y ffmpeg
+  - ffmpeg -hwaccels
+  - echo $DISPLAY

data/CHANGES.md

@@ -0,0 +1,24 @@
+### 1.0.0.beta8 (2019-01-03)
+
+* Fix a bug where the gem was incorrectly configured to be required as `ffmpeg/screenrecorder` instead of `ffmpeg-screenrecorder`.
+* `ScreenRecorder#start` now returns the IO process object in case the user has a use case for it.
+* `RecordingRegion#fetch` now logs a warning that `x11grab` for Linux does not supporting window recording.
+* :warning: Parameter `infile` is now `input` to make it more intuitive.
+g
+### 1.0.0.beta7 (2018-12-23)
+
+* Fix bug in RecorderOptions where an incorrect object was referenced to read the user provided options.
+
+### 1.0.0.beta6 (2018-12-3)
+
+* Stopping the screenrecorder now prints the failure reason given by the ffmpeg binary when `#stop` fails (Issue #7).
+* Log file is now defaulted to `ffmpeg.log` instead of redirecting to nul.
+* `log_level` now defaults to `Logger::ERROR` instead of `Logger::INFO`.
+
+### 1.0.0.beta5 (2018-11-26)
+
+* `Screenrecorder` class is now `ScreenRecorder`.
+* Add support for Linux.
+* Now an exception raised if the gem fails to find `ffmpeg`.
+* Fix a bug where a file named `nul` was created instead of directing the output to `NUL`.
+* Fix a bug where `RecordingRegions#window_titles` was not returning anything because of missing return keyword.

data/README.md

@@ -2,6 +2,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)
 
 Ruby gem to record your computer screen - desktop or specific application/window - using [FFmpeg](https://www.ffmpeg.org/).
 
@@ -11,9 +12,13 @@ Supports Windows and Linux as of version `1.0.0-beta5`. macOS support will be ad
 
 ## Installation
 
-[Download](https://www.ffmpeg.org/download.html), extract and add the location of `ffmpeg.exe` to your ENV `PATH` variable. Make sure you can execute ffmpeg:
+On Microsoft Windows, [download](https://www.ffmpeg.org/download.html#build-windows), extract and add the location of `/bin` to your ENV `PATH` variable. 
 
-    C:\Users\Lakshya Kapoor>ffmpeg -version
+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
@@ -34,7 +39,7 @@ Supports Windows and Linux as of version `1.0.0-beta5`. macOS support will be ad
     libswresample   3.  2.100 /  3.  2.100
     libpostproc    55.  2.100 / 55.  2.100
 
-Add this line to your application's Gemfile:
+Next, add this line to your application's Gemfile:
 
 ```ruby
 gem 'ffmpeg-screenrecorder'
@@ -50,29 +55,52 @@ Or install it yourself as:
 
 ## Usage
 
+#### Required Options
+
+- `:input` - `desktop` or application window name
+- `:output` - Output file location/name
+- `:framerate` - Capture FPS
+
+#### Advanced Options
+
+- `:log`  - Defaults to `ffmpeg.log`
+- `:log_level` for this 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.
+
+<b>Example</b>:
+
+```
+opts = { input:     'desktop',
+         output:    'recorder-test.mp4',
+         framerate: 30,
+         log:       'recorder.log',
+         log_level: Logger::DEBUG, # For gem
+         advanced:  { loglevel: 'level+debug' } # For FFmpeg
+}
+```
+
 ##### Record Desktop
 
 ```
-opts      = { output:    'ffmpeg-screenrecorder-desktop.mp4',
-              input:     'desktop',
+opts      = { input:     'desktop',
+              output:    'screenrecorder-desktop.mp4',
               framerate: 30.0 }
 @recorder = FFMPEG::ScreenRecorder.new(opts)
 
 # Start recording
-@recorder.start
+@recorder.start #=> #<IO:fd 5>
 
 # ... Run tests or whatever you want to record
 
 # Stop recording
-@recorder.stop
+@recorder.stop #=> #<FFMPEG::Movie...>
 
 # Recorded file
-@recorder.video #=> 'ffmpeg-screenrecorder-desktop.mp4'
-
-# ffmpeg log will be stored in 'ffmpeg.log'
+@recorder.video #=> #<FFMPEG::Movie...>
 ```
 
-##### Record Specific Application/Window - Windows Only
+##### Record Application Window - Microsoft Windows (`gdigrab`) Only
 ```
 require 'watir'
 
@@ -81,10 +109,10 @@ browser = Watir::Browser.new :firefox
 FFMPEG::RecordingRegions.fetch('firefox') # Name of exe
 #=> ["Mozilla Firefox"]
 
-opts      = { output:    'ffmpeg-screenrecorder-firefox.mp4',
-              input:     FFMPEG::RecordingRegions.fetch('firefox').first,
+opts      = { input:     FFMPEG::RecordingRegions.fetch('firefox').first,
+              output:    'screenrecorder-firefox.mp4',
               framerate: 30.0,
-              log:       'ffmpeg-screenrecorder-firefox.txt' }
+              log:       'screenrecorder-firefox.log' }
 @recorder = FFMPEG::ScreenRecorder.new(opts)
 
 # Start recording
@@ -101,19 +129,28 @@ browser.quit
 ```
 
 <b>Note</b>:
-1. 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.
-2. If you're launching multiple applications or testing an application at different window sizes, recording the `desktop` is a better option.
+- 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.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. 
 
 ## Contributing
 
-Bug reports and pull requests are welcome. Please follow the Ruby style guide here: https://github.com/rubocop-hq/ruby-style-guide
+Bug reports and pull requests are welcome. 
+
+- Please update the specs for your code changes and run them locally with `bundle exec rake spec`.
+- Follow the Ruby style guide and format your code - https://github.com/rubocop-hq/ruby-style-guide
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+![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 get your free account [here](https://saucelabs.com/open-source).

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'ffmpeg/screenrecorder'
+require 'ffmpeg-screenrecorder'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/ffmpeg-screenrecorder.rb

@@ -0,0 +1,3 @@
+require 'streamio-ffmpeg'
+require 'os'
+require 'ffmpeg/screenrecorder'

data/lib/ffmpeg/recorder_options.rb

@@ -22,10 +22,10 @@ module FFMPEG
     end
 
     #
-    # Returns given input file or infile
+    # Returns given input file or input
     #
-    def infile
-      @options[:infile]
+    def input
+      @options[:input]
     end
 
     #
@@ -71,7 +71,7 @@ module FFMPEG
       vals = "-f #{determine_format} "
       vals << "-r #{@options[:framerate]} "
       vals << advanced_options if @options[:advanced]
-      vals << "-i #{determine_infile} "
+      vals << "-i #{determine_input} "
       vals << @options[:output]
       vals << ffmpeg_log_to(@options[:log]) # If provided
     end
@@ -97,7 +97,7 @@ module FFMPEG
       # -r framerate
       # -i input
       # output
-      return %i[framerate infile output] unless OS.linux?
+      return %i[framerate input output] unless OS.linux?
 
       %i[framerate output] # Linux
     end
@@ -126,18 +126,18 @@ module FFMPEG
     end
 
     #
-    # Returns final infile parameter.
-    # Adds title= qualifier to infile parameter
+    # Returns final input parameter.
+    # Adds title= qualifier to input parameter
     # unless the user is recording the desktop.
     #
-    def determine_infile
+    def determine_input
       # x11grab doesn't support window capture
       return ':0.0' if OS.linux?
 
-      return @options[:infile] if @options[:infile] == 'desktop'
+      return @options[:input] if @options[:input] == 'desktop'
 
       # Windows only
-      %("title=#{@options[:infile]}")
+      %("title=#{@options[:input]}")
     end
 
     #

data/lib/ffmpeg/recording_regions.rb

@@ -14,11 +14,10 @@ module FFMPEG
       #
       # Returns a cleaned up list of available window titles
       # for the given application (process) name.
-      # Note: Only supports Windows OS as of version beta2.
       #
       def available_windows_for(application)
-        return windows_os(application) if OS.windows?
-        return linux_os(application) if OS.linux?
+        return windows_os_window(application) if OS.windows?
+        return linux_os_window(application) if OS.linux?
 
         raise NotImplementedError, 'Your OS is not supported.'
       end
@@ -26,12 +25,12 @@ module FFMPEG
       private
 
       #
-      # Returns list of windows for Microsoft Windows
+      # Returns list of windows when using Microsoft Windows
       #
-      def windows_os(application)
+      def windows_os_window(application)
         raw_list   = `tasklist /v /fi "imagename eq #{application}.exe" /fo list | findstr  Window`
-                     .split("\n")
-                     .reject { |title| title == 'Window Title: N/A' }
+                       .split("\n")
+                       .reject { |title| title == 'Window Title: N/A' }
         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?
 
@@ -39,15 +38,16 @@ module FFMPEG
       end
 
       #
-      # Returns list of windows for Linux
+      # Returns list of windows when using Linux
       #
-      def linux_os(application)
+      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?
 
         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
+                       .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?
 
         final_list

data/lib/ffmpeg/screenrecorder.rb

@@ -1,5 +1,3 @@
-require 'streamio-ffmpeg'
-require 'os'
 require_relative 'recorder_errors'
 require_relative 'recorder_options'
 require_relative 'recording_regions'
@@ -26,6 +24,7 @@ module FFMPEG
       elapsed    = Time.now - start_time
       FFMPEG.logger.debug "Process started in #{elapsed}s"
       FFMPEG.logger.info 'Recording...'
+      @process
     end
 
     #
@@ -62,10 +61,9 @@ module FFMPEG
       elapsed = wait_for_io_eof(5)
       @process.close_write # Close IO
       elapsed
-
     rescue Errno::EPIPE
       # Gets last line from log file
-      err_line = get_lines_from_log(count = 2, :last)
+      err_line = get_lines_from_log(:last, 2)
       raise FFMPEG::Error, err_line
     end
 
@@ -117,7 +115,7 @@ module FFMPEG
     #
     # Returns lines from the log file
     #
-    def get_lines_from_log(count = 2, position = :last)
+    def get_lines_from_log(position = :last, count = 2)
       f = File.open(options.log)
       lines = f.readlines
       lines = lines.last(count) if position == :last

data/lib/ffmpeg/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffmpeg-screenrecorder
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta7
+  version: 1.0.0.beta8
 platform: ruby
 authors:
 - Lakshya Kapoor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,7 +142,7 @@ files:
 - bin/console
 - bin/setup
 - ffmpeg-screenrecorder.gemspec
-- lib/ffmpeg.rb
+- lib/ffmpeg-screenrecorder.rb
 - lib/ffmpeg/recorder_errors.rb
 - lib/ffmpeg/recorder_options.rb
 - lib/ffmpeg/recording_regions.rb

data/lib/ffmpeg.rb

@@ -1 +0,0 @@
-require 'ffmpeg/screenrecorder'