ffmpeg-screenrecorder 1.0.0.beta → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a02c5c9cc4db8684c4a6f3f2f557b0857089c488ef26fc0f6986d7db32ff95cf
-  data.tar.gz: 03c1e725b98ed53f12d954ad084cf86ebfe41514319ebe14e58aec091029809a
+  metadata.gz: e85788e1924b1350003ba607d5cec470878cb2ecc49a5cf53d5508c4604cb38d
+  data.tar.gz: b438f32841d00eb3c6d3b6a996379f61a9c5e1c4a74335729bd6fc725bf23bae
 SHA512:
-  metadata.gz: 9c3582ca908bb205de16bf887db6750574b5ade7ad3d83e57bb4aada8a092715a121a8681dbcbf3676cce70ec711545a2472d6e46234e6015232b6c0f1af5237
-  data.tar.gz: 2226a59c6416d4d54a60313e849f09fdff30f6efda276678256b3799b56667d91f126793794c6bf44b72c32005eb8122e058cee88056f42edae033d0ae537f5c
+  metadata.gz: f36dafd064d1363b8dd5c42e39c2b840bc6a68db1cc7d42b8c65a667b78e45140c304a47581350a32913a79e6860f34d82778cb89510ec4c1f5925b35f22ee8f
+  data.tar.gz: 98763086b2b600ee80cc319b0b5a86bd598aa5e561f309c929afc613ae002caccf535ebb0d00050ad1a75380fd2d87f3e44b106dd13304571b2d13b5499f6a88

data/.gitignore

@@ -14,6 +14,7 @@ Gemfile.lock # Part of best practice
 /pkg/
 /spec/reports/
 /tmp/
+/webdrivers_bin
 
 Gemfile.lock
 

data/.rubocop.yml

@@ -1,5 +1,5 @@
 Style/EndOfLine:
-  EnforcedStyle: lf
+  EnforcedStyle: crlf
 
 Metrics/LineLength:
   Max: 120

data/README.md

@@ -1,6 +1,10 @@
 # FFMPEG::Screenrecorder
 
-Ruby gem to record your computer screen using [FFMPEG](https://www.ffmpeg.org/).
+Ruby gem to record your computer screen - desktop or specific application/window - using [FFMPEG](https://www.ffmpeg.org/).
+
+## Support
+
+Only supports Windows OS as of version `1.0.0-beta2`.
 
 ## Installation
 
@@ -20,7 +24,53 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+##### Record Desktop
+
+```
+opts               = { output:        'ffmpeg-screenrecorder-output.mp4',
+                       input:         'desktop',
+                       framerate:     30.0,
+                       device:        'gdigrab',
+                       log:           'ffmpeg-screenrecorder-log.txt' }
+@recorder = FFMPEG::Screenrecorder.new(opts)
+
+# Start recording
+@recorder.start
+
+# ... Run tests or whatever you want to record
+
+# Stop recording
+@recorder.stop
+
+# Recording file will be available: ffmpeg-screenrecorder-output.mp4
+```
+
+##### Record Specific Application/Window
+```
+require 'watir'
+
+browser = Watir::Browser.new :firefox
+
+FFMPEG::Screenrecorder.window_titles('firefox') # Name of exe
+#=> "Mozilla Firefox"
+
+opts      = { output:    'ffmpeg-screenrecorder-firefox.mp4',
+              input:     'Mozilla Firefox',
+              framerate: 30.0,
+              device:    'gdigrab',
+              log:       'ffmpeg-screenrecorder-firefox.txt' }
+@recorder = FFMPEG::Screenrecorder.new(opts)
+
+# Start recording
+@recorder.start
+
+# ... Run tests or whatever you want to record
+
+# Stop recording
+@recorder.stop
+
+# Recording file will be available: ffmpeg-screenrecorder-output.mp4
+```
 
 ## Development
 

data/ffmpeg-screenrecorder.gemspec

@@ -1,30 +1,31 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |spec|
-  spec.name    = 'ffmpeg-screenrecorder'
-  spec.version = '1.0.0.beta'
-  spec.authors = ['Lakshya Kapoor']
-  spec.email   = ['kapoorlakshya@gmail.com']
-
-  spec.summary     = 'Record your computer screen using ffmpeg via Ruby.'
-  spec.description = 'A ruby gem based on streamio-ffmpeg gem to record your computer screen in various formats.'
-  spec.homepage    = 'https://github.com/kapoorlakshya/ruby-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)
+
+Gem::Specification.new do |spec|
+  spec.name    = 'ffmpeg-screenrecorder'
+  spec.version = '1.0.0.beta2'
+  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    = 'https://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_options.rb

@@ -0,0 +1,106 @@
+module FFMPEG
+  class RecorderOptions
+
+    def initialize(options)
+      @options = verify_options options
+    end
+
+    def format
+      @options[:format]
+    end
+
+    def framerate
+      @options[:framerate]
+    end
+
+    def infile
+      @options[:infile]
+    end
+
+    def output
+      @options[:output]
+    end
+
+    def advanced
+      @options[:advanced]
+    end
+
+    def log
+      @options[:log]
+    end
+
+    def log_level
+      @options[:log_level]
+    end
+
+    def all
+      @options
+    end
+
+    def parsed
+      vals = "-f #{@options[:format]} "
+      vals << "-r #{@options[:framerate]} "
+      vals << advanced_options if @options[:advanced]
+      vals << "-i #{determine_infile @options[:infile]} "
+      vals << @options[:output]
+      vals << ffmpeg_log_to(@options[:log]) # If provided
+    end
+
+    private
+
+    #
+    # Verifies the required options are provided
+    #
+    def verify_options(options)
+      missing_options = required_options.select { |req| options[req].nil? }
+      err             = "Required options are missing: #{missing_options}"
+      raise(ArgumentError, err) unless missing_options.empty?
+
+      options
+    end
+
+    #
+    # Returns Array of require options a Symbols
+    #
+    def required_options
+      # -f format
+      # -r framerate
+      # -i input
+      # output
+      %i[format framerate infile output]
+    end
+
+    #
+    # Returns advanced options parsed and ready for ffmpeg to receive.
+    #
+    def advanced_options
+      return nil unless @options[:advanced]
+      raise(ArgumentError, ':advanced cannot be empty.') if options[:advanced].empty?
+
+      arr = []
+      options[:advanced].each { |k, v|
+        arr.push "-#{k} #{v}"
+      }
+      arr.join(' ') + ' '
+    end
+
+    #
+    # Determines if the ffmpeg output will be to a log
+    # file based on given options.
+    #
+    def ffmpeg_log_to(file)
+      return " 2> #{file}" if file
+      ' > nul 2>&1' # No log file given
+    end
+
+    #
+    # Returns final infile parameter.
+    # 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}")
+    end
+  end
+end

data/lib/ffmpeg/screenrecorder.rb

@@ -1,111 +1,75 @@
-require 'streamio-ffmpeg'
-require 'os'
-
-module FFMPEG
-  class Screenrecorder
-    attr_reader :opts, :output, :process_id
-
-    def initialize(opts = {})
-      @opts       = default_config.merge opts
-      @output     = opts[:output]
-      @video_file = nil
-      @process_id = nil
-      init_logger(opts[:logging_level])
-    end
-
-    def opts=(new_opts)
-      @opts   = default_config.merge new_opts
-      @output = opts[:output]
-      init_logger(opts[:logging_level]) if FFMPEG.logger.level != opts[:logging_level]
-    end
-
-    def start
-      FFMPEG.logger.debug "Starting: #{command}"
-      @video_file = nil # New file
-      @process_id = start_ffmpeg
-      FFMPEG.logger.info 'Recording...'
-      @process_id
-    end
-
-    def stop
-      FFMPEG.logger.debug 'Stopping ffmpeg.exe...'
-      # msg = Process.kill('INT', @process_id)
-      # Process.detach(@process_id)
-      msg = kill_ffmpeg
-      FFMPEG.logger.debug msg
-      FFMPEG.logger.debug 'Stopped ffmpeg.exe'
-      FFMPEG.logger.info 'Recording complete.'
-      msg
-    end
-
-    # def inputs(application)
-    #   FFMPEG.logger.debug "Retrieving available windows from: #{application}"
-    #   available_inputs_by application
-    # end
-
-    def video_file
-      @video_file ||= Movie.new(output)
-    end
-
-    private
-
-    def default_config
-      { input:     'desktop',
-        framerate: 15,
-        device:    'gdigrab',
-        log:       'ffmpeg_recorder_log.txt' }
-    end
-
-    def start_ffmpeg
-      spawn(command)
-      pid = `powershell (Get-Process ffmpeg).id`.to_i
-      raise 'ffmpeg failed to start.' if pid.zero?
-      pid
-    end
-
-    def kill_ffmpeg
-      `TASKKILL /f /im ffmpeg.exe`
-    end
-
-    def init_logger(level)
-      FFMPEG.logger.progname  = 'FFMPEG::Recorder'
-      FFMPEG.logger.level     = level
-      FFMPEG.logger.formatter = proc do |severity, time, progname, msg|
-        "#{time.strftime('%F %T')} #{progname} - #{severity} - #{msg}\n"
-      end
-      FFMPEG.logger.debug "Logger initialized."
-    end
-
-    def command
-      "#{FFMPEG.ffmpeg_binary} -y " \
-      "#{extra_opts}" \
-      "-f #{opts[:device]} " \
-      "-framerate #{opts[:framerate]} " \
-      "-i #{opts[:input]} " \
-      "#{opts[:output]} " \
-      "2> #{opts[:log]}"
-    end
-
-    def extra_opts
-      return nil unless opts[:extra_opts]
-      raise ':extra_opts cannot be empty.' if opts[:extra_opts].empty?
-
-      arr = []
-      opts[:extra_opts].each { |k, v|
-        arr.push "-#{k} #{v}"
-      }
-      ' ' + arr.join(' ') + ' '
-    end
-
-    # def available_inputs_by(application)
-    #   `tasklist /v /fi "imagename eq #{application}.exe" /fo list | findstr  Window`
-    #     .split("\n")
-    #     .reject { |title| title == 'Window Title: N/A' }
-    # end
-    #
-    # def input
-    #   return opts[:input] if opts[:input] == 'desktop'
-    #   %Q(title="#{opts[:input].gsub('Window Title: ', '')}")
-    # end
-  end # class Recorder
-end # module FFMPEG
+require 'streamio-ffmpeg'
+require 'os'
+require_relative 'recorder_options'
+require_relative 'windows'
+
+module FFMPEG
+  class Screenrecorder
+    extend Windows
+
+    attr_reader :options, :video
+
+    def initialize(options = {})
+      @options = RecorderOptions.new(options)
+      @video   = nil
+      @process = nil
+      initialize_logger(@options.log_level || Logger::ERROR)
+    end
+
+    def start
+      @video     = nil # New file
+      start_time = Time.now
+      @process   = start_ffmpeg
+      elapsed    = Time.now - start_time
+      FFMPEG.logger.debug "Process started in #{elapsed}s"
+      FFMPEG.logger.info 'Recording...'
+    end
+
+    def stop
+      FFMPEG.logger.debug 'Stopping ffmpeg.exe...'
+      elapsed = kill_ffmpeg
+      FFMPEG.logger.debug "Stopped ffmpeg.exe in #{elapsed}s"
+      FFMPEG.logger.info 'Recording complete.'
+      @video = Movie.new(options.output)
+    end
+
+    private
+
+    def start_ffmpeg
+      FFMPEG.logger.debug "Command: #{command}"
+      process = IO.popen(command, 'r+')
+      sleep(1.5) # Takes ~1.5s on average to initialize
+      process
+    end
+
+    def kill_ffmpeg
+      @process.puts 'q' # Gracefully exit ffmpeg
+      elapsed = wait_for_io_eof(5)
+      @process.close_write # Close IO
+      elapsed
+    end
+
+    def initialize_logger(level)
+      FFMPEG.logger.progname  = 'FFMPEG'
+      FFMPEG.logger.level     = level
+      FFMPEG.logger.formatter = proc do |severity, time, progname, msg|
+        "#{time.strftime('%F %T')} #{progname} - #{severity} - #{msg}\n"
+      end
+      FFMPEG.logger.debug 'Logger initialized.'
+    end
+
+    def command
+      cmd = "#{FFMPEG.ffmpeg_binary} -y "
+      cmd << @options.parsed
+    end
+
+    def wait_for_io_eof(timeout)
+      start = Time.now
+      Timeout.timeout(timeout) do
+        sleep(0.1) until @process.eof?
+      end
+      FFMPEG.logger.debug "IO#eof? #{@process.eof?}"
+      Time.now - start
+    end
+  end # class Recorder
+end # module FFMPEG

data/lib/ffmpeg/windows.rb

@@ -0,0 +1,18 @@
+module FFMPEG
+  module Windows
+
+    def window_titles(application)
+      FFMPEG.logger.debug "Retrieving available windows for: #{application}"
+      WindowGrabber.new.available_windows_for application
+    end
+
+    class WindowGrabber
+      def available_windows_for(application)
+        list = `tasklist /v /fi "imagename eq #{application}.exe" /fo list | findstr  Window`
+                 .split("\n")
+                 .reject { |title| title == 'Window Title: N/A' }
+        list.map { |i| i.gsub('Window Title: ', '') } # Make it user friendly
+      end
+    end
+  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.beta
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Lakshya Kapoor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-27 00:00:00.000000000 Z
+date: 2018-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,8 +122,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: A ruby gem based on streamio-ffmpeg gem to record your computer screen
-  in various formats.
+description: Ruby gem to record your computer screen - desktop or specific application/window
+  - using [FFMPEG](https://www.ffmpeg.org/).
 email:
 - kapoorlakshya@gmail.com
 executables: []
@@ -142,8 +142,10 @@ files:
 - bin/setup
 - ffmpeg-screenrecorder.gemspec
 - lib/ffmpeg.rb
+- lib/ffmpeg/recorder_options.rb
 - lib/ffmpeg/screenrecorder.rb
-homepage: https://github.com/kapoorlakshya/ruby-ffmpeg_screenrecorder
+- lib/ffmpeg/windows.rb
+homepage: https://github.com/kapoorlakshya/ffmpeg-screenrecorder
 licenses:
 - MIT
 metadata: {}