screen-recorder 1.0.0 → 1.1.0

data/Rakefile

@@ -1,6 +1,11 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: %w[spec rubocop]

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/screen-recorder.rb

@@ -1,46 +1,54 @@
-require 'streamio-ffmpeg'
-require 'os'
-require 'logger'
-
-# @since 1.0.0.beta11
-module ScreenRecorder
-  #
-  # Uses user given FFMPEG binary
-  #
-  # @example
-  #   ScreenRecorder.ffmpeg_binary = 'C:\ffmpeg.exe'
-  #
-  def ffmpeg_binary=(bin)
-    FFMPEG.ffmpeg_binary = bin
-  end
-
-  #
-  # Set external logger if you want.
-  #
-  def self.logger=(log)
-    @logger = log
-  end
-
-  #
-  # ScreenRecorder.logger
-  #
-  def self.logger
-    return @logger if @logger
-    logger           = Logger.new(STDOUT)
-    logger.level     = Logger::ERROR
-    logger.progname  = 'ScreenRecorder'
-    logger.formatter = proc do |severity, time, progname, msg|
-      "#{time.strftime('%F %T')} #{progname} - #{severity} - #{msg}\n"
-    end
-    logger.debug 'Logger initialized.'
-    @logger = logger
-  end
-end
-
-require 'screen-recorder/type_checker'
-require 'screen-recorder/errors'
-require 'screen-recorder/options'
-require 'screen-recorder/titles'
-require 'screen-recorder/common'
-require 'screen-recorder/desktop'
+require 'streamio-ffmpeg'
+require 'os'
+require 'logger'
+
+# @since 1.0.0.beta11
+module ScreenRecorder
+  #
+  # Uses user given FFMPEG binary
+  #
+  # @example
+  #   ScreenRecorder.ffmpeg_binary = 'C:\ffmpeg.exe'
+  #
+  def self.ffmpeg_binary=(bin)
+    FFMPEG.ffmpeg_binary = bin
+  end
+
+  #
+  # Returns path to ffmpeg binary
+  #
+  def self.ffmpeg_binary
+    FFMPEG.ffmpeg_binary
+  end
+
+  #
+  # Set external logger if you want.
+  #
+  def self.logger=(log)
+    @logger = log
+  end
+
+  #
+  # ScreenRecorder.logger
+  #
+  def self.logger
+    return @logger if @logger
+
+    logger           = Logger.new(STDOUT)
+    logger.level     = Logger::ERROR
+    logger.progname  = 'ScreenRecorder'
+    logger.formatter = proc do |severity, time, progname, msg|
+      "#{time.strftime('%F %T')} #{progname} - #{severity} - #{msg}\n"
+    end
+    logger.debug 'Logger initialized.'
+    @logger = logger
+  end
+end
+
+require 'screen-recorder/type_checker'
+require 'screen-recorder/errors'
+require 'screen-recorder/options'
+require 'screen-recorder/titles'
+require 'screen-recorder/common'
+require 'screen-recorder/desktop'
 require 'screen-recorder/window'

data/lib/screen-recorder/common.rb

@@ -1,128 +1,147 @@
-# @since 1.0.0-beta11
-module ScreenRecorder
-  # @since 1.0.0-beta11
-  class Common
-    attr_reader :options, :video
-
-    def initialize(input:, output:, advanced: {})
-      @options = Options.new(input: input, output: output, advanced: advanced)
-      @video   = nil
-      @process = nil
-    end
-
-    #
-    # Starts the recording
-    #
-    def start
-      @video     = nil # New file
-      start_time = Time.now
-      @process   = start_ffmpeg
-      elapsed    = Time.now - start_time
-      ScreenRecorder.logger.debug "Process started in #{elapsed}s"
-      ScreenRecorder.logger.info 'Recording...'
-      @process
-    end
-
-    #
-    # Stops the recording
-    #
-    def stop
-      ScreenRecorder.logger.debug 'Stopping ffmpeg.exe...'
-      elapsed = kill_ffmpeg
-      ScreenRecorder.logger.debug "Stopped ffmpeg.exe in #{elapsed}s"
-      ScreenRecorder.logger.info 'Recording complete.'
-      @video = FFMPEG::Movie.new(options.output)
-    end
-
-    #
-    # Discards the recorded file. Useful in automated testing
-    # when a test passes and the recorded file is no longer
-    # needed.
-    #
-    def discard
-      FileUtils.rm options.output
-    end
-
-    alias_method :delete, :discard
-
-    private
-
-    #
-    # Launches the ffmpeg binary using a generated command based on
-    # the given options.
-    #
-    def start_ffmpeg
-      raise Errors::DependencyNotFound, 'ffmpeg binary not found.' unless ffmpeg_exists?
-
-      ScreenRecorder.logger.debug "Command: #{command}"
-      process = IO.popen(command, 'r+')
-      sleep(1.5) # Takes ~1.5s on average to initialize
-      process
-    end
-
-    #
-    # Sends 'q' to the ffmpeg binary to gracefully stop the process.
-    #
-    def kill_ffmpeg
-      @process.puts 'q' # Gracefully exit 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(:last, 2)
-      raise FFMPEG::Error, err_line
-    end
-
-    #
-    # Generates the command line arguments based on the given
-    # options.
-    #
-    def command
-      cmd = "#{FFMPEG.ffmpeg_binary} -y "
-      cmd << @options.parsed
-    end
-
-    #
-    # Waits for IO#eof? to return true
-    # after 'q' is sent to the ffmpeg process.
-    #
-    def wait_for_io_eof(timeout)
-      start = Time.now
-      Timeout.timeout(timeout) do
-        sleep(0.1) until @process.eof?
-      end
-      ScreenRecorder.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?
-
-      # If the user does not use FFMPEG#ffmpeg_binary=() to set the binary path,
-      # FFMPEG#ffmpeg_binary returns 'ffmpeg' assuming it must be in ENV. However,
-      # if the above two checks fail, it is not in the ENV either.
-      return false if FFMPEG.ffmpeg_binary == 'ffmpeg'
-
-      true
-    end
-
-    #
-    # Returns lines from the log file
-    #
-    def get_lines_from_log(position = :last, count = 2)
-      f     = File.open(options.log)
-      lines = f.readlines
-      lines = lines.last(count) if position == :last
-      lines = lines.first(count) if position == :first
-      f.close
-
-      lines.join(' ')
-    end
-  end
+# @since 1.0.0-beta11
+module ScreenRecorder
+  # @since 1.0.0-beta11
+  class Common
+    attr_reader :options, :video
+
+    def initialize(input:, output:, advanced: {})
+      @options = Options.new(input: input, output: output, advanced: advanced)
+      @video   = nil
+      @process = nil
+    end
+
+    #
+    # Starts the recording
+    #
+    def start
+      @video     = nil # New file
+      start_time = Time.now
+      @process   = start_ffmpeg
+      elapsed    = Time.now - start_time
+      ScreenRecorder.logger.debug "Process started in #{elapsed}s"
+      ScreenRecorder.logger.info 'Recording...'
+      @process
+    end
+
+    #
+    # Stops the recording
+    #
+    def stop
+      ScreenRecorder.logger.debug 'Stopping ffmpeg.exe...'
+      elapsed = stop_ffmpeg
+      ScreenRecorder.logger.debug "Stopped ffmpeg.exe in #{elapsed}s"
+      ScreenRecorder.logger.info 'Recording complete.'
+      @video = FFMPEG::Movie.new(options.output)
+    end
+
+    #
+    # Discards the recorded file. Useful in automated testing
+    # when a test passes and the recorded file is no longer
+    # needed.
+    #
+    def discard
+      FileUtils.rm options.output
+    end
+
+    alias delete discard
+
+    private
+
+    #
+    # Launches the ffmpeg binary using a generated command based on
+    # the given options.
+    #
+    def start_ffmpeg
+      raise Errors::DependencyNotFound, 'ffmpeg binary not found.' unless ffmpeg_exists?
+
+      ScreenRecorder.logger.debug "Command: #{command}"
+      process = IO.popen(command, 'r+')
+      sleep(1.5) # Takes ~1.5s on average to initialize
+      process
+    end
+
+    #
+    # Sends 'q' to the ffmpeg binary to gracefully stop the process.
+    # Forcefully terminates it if it takes more than 10s.
+    #
+    def stop_ffmpeg
+      @process.puts 'q' # Gracefully exit ffmpeg
+      elapsed = wait_for_io_eof(10)
+      @process.close_write # Close IO
+      elapsed
+    rescue Timeout::Error
+      ScreenRecorder.logger.error 'FFmpeg failed to stop. Force killing it...'
+      force_kill_ffmpeg
+      ScreenRecorder.logger.error "Check '#{@options.log}' for more information."
+    rescue Errno::EPIPE
+      # Gets last line from log file
+      err_line = get_lines_from_log(:last, 2)
+      raise FFMPEG::Error, err_line
+    end
+
+    #
+    # Generates the command line arguments based on the given
+    # options.
+    #
+    def command
+      cmd = "#{ScreenRecorder.ffmpeg_binary} -y "
+      cmd << @options.parsed
+    end
+
+    #
+    # Waits for IO#eof? to return true
+    # after 'q' is sent to the ffmpeg process.
+    #
+    def wait_for_io_eof(timeout)
+      start = Time.now
+      Timeout.timeout(timeout) do
+        sleep(0.1) until @process.eof?
+      end
+      ScreenRecorder.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?
+
+      # If the user does not use ScreenRecorder.ffmpeg_binary=() to set the binary path,
+      # ScreenRecorder.ffmpeg_binary returns 'ffmpeg' assuming it must be in ENV. However,
+      # if the above two checks fail, it is not in the ENV either.
+      return false if ScreenRecorder.ffmpeg_binary == 'ffmpeg'
+
+      true
+    end
+
+    #
+    # Returns lines from the log file
+    #
+    def get_lines_from_log(position = :last, count = 2)
+      f     = File.open(options.log)
+      lines = f.readlines
+      lines = lines.last(count) if position == :last
+      lines = lines.first(count) if position == :first
+      f.close
+
+      lines.join(' ')
+    end
+
+    #
+    # Force kills the ffmpeg process.
+    #
+    def force_kill_ffmpeg
+      if OS.windows?
+        pid = `powershell (Get-Process -name 'ffmpeg').Id`.strip.to_i
+        `taskkill /f /pid #{pid}`
+        return
+      end
+
+      `killall -9 ffmpeg` # Linux and macOS
+      nil
+    end
+  end
 end

data/lib/screen-recorder/desktop.rb

@@ -1,31 +1,41 @@
-# @since 1.0.0-beta11
-module ScreenRecorder
-  # @since 1.0.0-beta11
-  class Desktop < Common
-    DEFAULT_INPUT_LINUX = ':0.0'.freeze
-    DEFAULT_INPUT_WIN   = 'desktop'.freeze
-
-    #
-    # Desktop recording specific initializer.
-    #
-    def initialize(input: 'desktop', output:, advanced: {})
-      super(input: determine_input(input), output: output, advanced: advanced)
-    end
-
-    private
-
-    #
-    # Returns FFmpeg expected input value based on current OS
-    #
-    def determine_input(val)
-      if OS.linux?
-        return DEFAULT_INPUT_LINUX if val == 'desktop'
-
-        return val # Custom $DISPLAY number in Linux
-      end
-      return DEFAULT_INPUT_WIN if OS.windows?
-
-      raise ArgumentError, "Unsupported input type: '#{val}'. Expected: 'desktop'"
-    end
-  end
+# @since 1.0.0-beta11
+module ScreenRecorder
+  # @since 1.0.0-beta11
+  class Desktop < Common
+    DEFAULT_INPUT_WIN   = 'desktop'.freeze
+    DEFAULT_INPUT_LINUX = ':0'.freeze
+    DEFAULT_INPUT_MAC   = '1'.freeze
+
+    #
+    # Desktop recording specific initializer.
+    #
+    def initialize(input: input_by_os, output:, advanced: {})
+      super(input: determine_input(input), output: output, advanced: advanced)
+    end
+
+    private
+
+    #
+    # Returns default input value for current OS
+    #
+    def input_by_os
+      return DEFAULT_INPUT_WIN if OS.windows?
+
+      return DEFAULT_INPUT_LINUX if OS.linux?
+
+      return DEFAULT_INPUT_MAC if OS.mac?
+
+      raise NotImplementedError, 'Your OS is not supported. Feel free to create an Issue on GitHub.'
+    end
+
+    #
+    # Returns FFmpeg expected input based on user given value or
+    # default for the current OS.
+    #
+    def determine_input(val)
+      return val if val
+
+      input_by_os
+    end
+  end
 end