ffmpeg-screenrecorder 1.0.0.beta4 → 1.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 857bc0e6533ccdb8dcc9c0c82cae13028e205173f14997177f2638f5a93ae65e
-  data.tar.gz: 774c93d3e295012d242b1df752460880d93b01a41abc86812e37fa389788293a
+  metadata.gz: 2a72ed1c811611468b93f3a1677b651881834c3e94aa52582564a1bdee2aba60
+  data.tar.gz: cfce5bdfe5c575a77b7bf12d994a58c406ede56b529704ce5c9ac9d157e72d72
 SHA512:
-  metadata.gz: 780bf876cff8c52ef37db709ba971ca4b80a2eab4422cbc6e8ee211bd363e103563217b7d8ab246f614c7d445d62895756ee078dab465bc2fbf644503f460d54
-  data.tar.gz: 185f4b69f1932a88d1332f72db132e4ad8d46ff7457ae5a034119ebfe750efd13e8723d4395e691f86e5ea557928fdb1891d5c016939cb8c297c838d6f346730
+  metadata.gz: 6e74b55cb1c1e6cd0e72a4a7d59e8f171b81627102f17a17ee3020c74e672ef0c1df4b0bd1a3c4d577406209d5802d8b6fb009b07266917f9709f84ff02c3f5c
+  data.tar.gz: 06125f14582ae639177ceed36295de452479b6abb76f70654cb71168ca46dac4210c7b43a9c05e5133cd55b8b27aa40baf46920012b4b3f4994563d2c47eb68a

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
-
-gemspec
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,12 +1,12 @@
-# FFMPEG::Screenrecorder
+# FFMPEG::ScreenRecorder
 
 [![Gem Version](https://badge.fury.io/rb/ffmpeg-screenrecorder.svg)](https://badge.fury.io/rb/ffmpeg-screenrecorder)
 
 Ruby gem to record your computer screen - desktop or specific application/window - using [FFmpeg](https://www.ffmpeg.org/).
 
-## Windows Only
+## Compatibility
 
-Only supports Windows as of version `1.0.0-beta3`. Linux and macOS support will be added before the final release of `v1.0.0`.
+Supports Windows and Linux as of version `1.0.0-beta5`. macOS support will be added before the final release of `v1.0.0`.
 
 ## Installation
 
@@ -57,7 +57,7 @@ opts      = { output:    'ffmpeg-screenrecorder-desktop.mp4',
               framerate: 30.0,
               device:    'gdigrab',
               log:       'ffmpeg-screenrecorder-log.txt' }
-@recorder = FFMPEG::Screenrecorder.new(opts)
+@recorder = FFMPEG::ScreenRecorder.new(opts)
 
 # Start recording
 @recorder.start
@@ -70,13 +70,13 @@ opts      = { output:    'ffmpeg-screenrecorder-desktop.mp4',
 # Recording file will be available: ffmpeg-screenrecorder-desktop.mp4
 ```
 
-##### Record Specific Application/Window
+##### Record Specific Application/Window - gdigrab (Windows) Only
 ```
 require 'watir'
 
 browser = Watir::Browser.new :firefox
 
-FFMPEG::Screenrecorder.window_titles('firefox') # Name of exe
+FFMPEG::RecordingRegions.fetch('firefox') # Name of exe
 #=> "Mozilla Firefox"
 
 opts      = { output:    'ffmpeg-screenrecorder-firefox.mp4',
@@ -84,7 +84,7 @@ opts      = { output:    'ffmpeg-screenrecorder-firefox.mp4',
               framerate: 30.0,
               device:    'gdigrab',
               log:       'ffmpeg-screenrecorder-firefox.txt' }
-@recorder = FFMPEG::Screenrecorder.new(opts)
+@recorder = FFMPEG::ScreenRecorder.new(opts)
 
 # Start recording
 @recorder.start

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/ffmpeg-screenrecorder.gemspec

@@ -1,32 +1,32 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ffmpeg/version'
-
-Gem::Specification.new do |spec|
-  spec.name    = 'ffmpeg-screenrecorder'
-  spec.version = FFMPEG::Screenrecorder::VERSION
-  spec.authors = ['Lakshya Kapoor']
-  spec.email   = ['kapoorlakshya@gmail.com']
-
-  spec.summary     = 'Record your computer screen using ffmpeg via Ruby.'
-  spec.description = 'Ruby gem to record your computer screen - desktop or specific application/window' \
-                     ' - using FFmpeg (https://www.ffmpeg.org).'
-  spec.homepage    = 'http://github.com/kapoorlakshya/ffmpeg-screenrecorder'
-  spec.license     = 'MIT'
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'pry-byebug', '~> 3.6'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'watir', '~> 6.0'
-  spec.add_development_dependency 'webdrivers', '~> 3.0'
-
-  spec.add_runtime_dependency 'os', '~> 0.9.0'
-  spec.add_runtime_dependency 'streamio-ffmpeg', '~> 1.0'
-end
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffmpeg/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'ffmpeg-screenrecorder'
+  spec.version = FFMPEG::ScreenRecorder::VERSION
+  spec.authors = ['Lakshya Kapoor']
+  spec.email   = ['kapoorlakshya@gmail.com']
+
+  spec.summary     = 'Record your computer screen using ffmpeg via Ruby.'
+  spec.description = 'Ruby gem to record your computer screen - desktop or specific application/window' \
+                     ' - using FFmpeg (https://www.ffmpeg.org).'
+  spec.homepage    = 'http://github.com/kapoorlakshya/ffmpeg-screenrecorder'
+  spec.license     = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'watir', '~> 6.0'
+  spec.add_development_dependency 'webdrivers', '~> 3.0'
+
+  spec.add_runtime_dependency 'os', '~> 0.9.0'
+  spec.add_runtime_dependency 'streamio-ffmpeg', '~> 1.0'
+end

data/lib/ffmpeg/recorder_errors.rb

@@ -0,0 +1,10 @@
+module FFMPEG
+  # @since 1.0.0-beta5
+  module RecorderErrors
+    # @since 1.0.0-beta3
+    class ApplicationNotFound < StandardError; end
+
+    # @since 1.0.0-beta5
+    class DependencyNotFound < StandardError; end
+  end
+end

data/lib/ffmpeg/recorder_options.rb

@@ -1,7 +1,6 @@
 module FFMPEG
   # @since 1.0.0-beta2
   class RecorderOptions
-
     def initialize(options)
       @options = verify_options options
     end
@@ -10,7 +9,7 @@ module FFMPEG
     # Returns given recording format
     #
     def format
-      @options[:format]
+      determine_format
     end
 
     #
@@ -67,10 +66,10 @@ module FFMPEG
     # ready for the ffmpeg process to use
     #
     def parsed
-      vals = "-f #{@options[:format]} "
+      vals = "-f #{determine_format} "
       vals << "-r #{@options[:framerate]} "
       vals << advanced_options if @options[:advanced]
-      vals << "-i #{determine_infile @options[:infile]} "
+      vals << "-i #{determine_infile} "
       vals << @options[:output]
       vals << ffmpeg_log_to(@options[:log]) # If provided
     end
@@ -93,11 +92,12 @@ module FFMPEG
     # Returns Array of required options sa Symbols
     #
     def required_options
-      # -f format
       # -r framerate
       # -i input
       # output
-      %i[format framerate infile output]
+      return %i[framerate infile output] unless OS.linux?
+
+      %i[framerate output] # Linux
     end
 
     #
@@ -108,9 +108,9 @@ module FFMPEG
       raise(ArgumentError, ':advanced cannot be empty.') if options[:advanced].empty?
 
       arr = []
-      options[:advanced].each { |k, v|
+      options[:advanced].each do |k, v|
         arr.push "-#{k} #{v}"
-      }
+      end
       arr.join(' ') + ' '
     end
 
@@ -122,7 +122,8 @@ module FFMPEG
     #
     def ffmpeg_log_to(file)
       return " 2> #{file}" if file
-      ' > nul 2>&1' # No log file given
+
+      '> nul 2>&1' # No log file given
     end
 
     #
@@ -130,9 +131,31 @@ module FFMPEG
     # Adds title= qualifier to infile parameter
     # unless the user is recording the desktop.
     #
-    def determine_infile(opt)
-      return opt if opt == 'desktop'
-      %Q("title=#{opt}")
+    def determine_infile
+      # x11grab doesn't support window capture
+      return ':0.0' if OS.linux?
+
+      return @options[:infile] if @options[:infile] == 'desktop'
+
+      # Windows only
+      %("title=#{@options[:infile]}")
+    end
+
+    #
+    # Returns format based on the current OS.
+    #
+    def determine_format
+      return @options[:format] if @options[:format]
+
+      if OS.windows?
+        'gdigrab'
+      elsif OS.linux?
+        'x11grab'
+      elsif OS.mac?
+        'avfoundation'
+      else
+        raise NotImplementedError, 'Your OS is not supported.'
+      end
     end
   end
-end
+end

data/lib/ffmpeg/recording_regions.rb

@@ -1,11 +1,10 @@
 module FFMPEG
   # @since 1.0.0-beta4
   module RecordingRegions
-
     #
     # Returns a list of available window titles for the given application (process) name.
     #
-    def window_titles(application)
+    def self.fetch(application)
       FFMPEG.logger.debug "Retrieving available windows for: #{application}"
       WindowGrabber.new.available_windows_for application
     end
@@ -18,17 +17,39 @@ module FFMPEG
       # 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?
+
+        raise NotImplementedError, 'Your OS is not supported.'
+      end
+
+      private
+
+      def windows_os(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: ', '') } # Make it user friendly
+        raise RecorderErrors::ApplicationNotFound, "No open windows found for: #{application}.exe" if final_list.empty?
 
-        raise ApplicationNotFound, "No open windows found for: #{application}.exe" if final_list.empty?
         final_list
       end
-    end
 
-    # @since 1.0.0-beta3
-    class ApplicationNotFound < StandardError; end
+      def linux_os(application)
+        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
+        raise RecorderErrors::ApplicationNotFound, "No open windows found for: #{application}" if final_list.empty?
+
+        final_list
+      end
+
+      def wmctrl_installed?
+        !`which wmctrl`.empty? # "" when not found
+      end
+    end
   end # module Windows
 end # module FFMPEG

data/lib/ffmpeg/screenrecorder.rb

@@ -1,13 +1,12 @@
 require 'streamio-ffmpeg'
 require 'os'
+require_relative 'recorder_errors'
 require_relative 'recorder_options'
 require_relative 'recording_regions'
 
 module FFMPEG
-  # @since 1.0.0-beta1
-  class Screenrecorder
-    extend RecordingRegions
-
+  # @since 1.0.0-beta
+  class ScreenRecorder
     attr_reader :options, :video
 
     def initialize(options = {})
@@ -47,7 +46,10 @@ module FFMPEG
     # the given options.
     #
     def start_ffmpeg
+      raise RecorderErrors::DependencyNotFound, 'ffmpeg binary not found.' unless ffmpeg_exists?
+
       FFMPEG.logger.debug "Command: #{command}"
+      puts "Command: #{command}" # @todo Remove this after debugging
       process = IO.popen(command, 'r+')
       sleep(1.5) # Takes ~1.5s on average to initialize
       process
@@ -96,5 +98,16 @@ module FFMPEG
       FFMPEG.logger.debug "IO#eof? #{@process.eof?}"
       Time.now - start
     end
+
+    #
+    # Returns true if ffmpeg binary is found.
+    #
+    def ffmpeg_exists?
+      return !`which ffmpeg`.empty? if OS.linux? # "" if not found
+
+      return !`where ffmpeg`.empty? if OS.windows?
+
+      true # @todo Check on windows
+    end
   end # class Recorder
 end # module FFMPEG

data/lib/ffmpeg/version.rb

@@ -1,5 +1,5 @@
 module FFMPEG
-  class Screenrecorder
-    VERSION = '1.0.0.beta4'.freeze
+  class ScreenRecorder
+    VERSION = '1.0.0.beta5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffmpeg-screenrecorder
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.0.beta5
 platform: ruby
 authors:
 - Lakshya Kapoor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,6 +142,7 @@ files:
 - bin/setup
 - ffmpeg-screenrecorder.gemspec
 - lib/ffmpeg.rb
+- lib/ffmpeg/recorder_errors.rb
 - lib/ffmpeg/recorder_options.rb
 - lib/ffmpeg/recording_regions.rb
 - lib/ffmpeg/screenrecorder.rb