screen-recorder 1.1.0 → 1.2.0

data/lib/screen-recorder/desktop.rb

@@ -1,41 +1,41 @@
-# @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
+# @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

data/lib/screen-recorder/errors.rb

@@ -1,10 +1,10 @@
-module ScreenRecorder
-  # @since 1.0.0-beta5
-  module Errors
-    # @since 1.0.0-beta3
-    class ApplicationNotFound < StandardError; end
-
-    # @since 1.0.0-beta5
-    class DependencyNotFound < StandardError; end
-  end
+module ScreenRecorder
+  # @since 1.0.0-beta5
+  module Errors
+    # @since 1.0.0-beta3
+    class ApplicationNotFound < StandardError; end
+
+    # @since 1.0.0-beta5
+    class DependencyNotFound < StandardError; end
+  end
 end

data/lib/screen-recorder/options.rb

@@ -1,151 +1,168 @@
-# @since 1.0.0-beta11
-module ScreenRecorder
-  # @since 1.0.0-beta11
-  class Options
-    DEFAULT_LOG_FILE       = 'ffmpeg.log'.freeze
-    DEFAULT_FPS            = 15.0
-    DEFAULT_INPUT_PIX_FMT  = 'uyvy422'.freeze # For macOS / avfoundation
-    DEFAULT_OUTPUT_PIX_FMT = 'yuv420p'.freeze
-
-    def initialize(options)
-      TypeChecker.check options, Hash
-      TypeChecker.check options[:advanced], Hash if options[:advanced]
-      @options = verify_options options
-      advanced[:framerate] ||= DEFAULT_FPS
-      advanced[:log]       ||= DEFAULT_LOG_FILE
-      advanced[:pix_fmt]   ||= DEFAULT_OUTPUT_PIX_FMT
-    end
-
-    #
-    # Returns given input file or input
-    #
-    def input
-      @options[:input]
-    end
-
-    #
-    # Returns capture device in use
-    #
-    def capture_device
-      determine_capture_device
-    end
-
-    #
-    # Returns given output filepath
-    #
-    def output
-      @options[:output]
-    end
-
-    #
-    # Returns given values that are optional
-    #
-    def advanced
-      @options[:advanced] ||= {}
-    end
-
-    #
-    # Returns given framerate
-    #
-    def framerate
-      advanced[:framerate]
-    end
-
-    #
-    # Returns given log filename
-    #
-    def log
-      advanced[:log]
-    end
-
-    #
-    # Returns all given options
-    #
-    def all
-      @options
-    end
-
-    #
-    # Returns a String with all options parsed and
-    # ready for the ffmpeg process to use
-    #
-    def parsed
-      vals = "-f #{capture_device} "
-      vals << "-pix_fmt #{DEFAULT_INPUT_PIX_FMT} " if OS.mac? # Input pixel format
-      vals << advanced_options unless advanced.empty?
-      vals << "-i #{input} "
-      vals << "-pix_fmt #{advanced[:pix_fmt]} " if advanced[:pix_fmt] # Output pixel format
-      # Fix for using yuv420p
-      # @see https://www.reck.dk/ffmpeg-libx264-height-not-divisible-by-2/
-      vals << '-vf "scale=trunc(iw/2)*2:trunc(ih/2)*2" ' if advanced[:pix_fmt] == 'yuv420p'
-      vals << output
-      vals << ffmpeg_log_to(log)
-    end
-
-    private
-
-    #
-    # Verifies the required options are provided and returns
-    # 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? }
-      err             = "Required options are missing: #{missing_options}"
-      raise(ArgumentError, err) unless missing_options.empty?
-
-      options
-    end
-
-    #
-    # Returns Array of required options as Symbols
-    #
-    def required_options
-      %i[input output]
-    end
-
-    #
-    # Returns advanced options parsed and ready for ffmpeg to receive.
-    #
-    def advanced_options
-      arr = []
-
-      # Log file and output pixel format is handled separately
-      # at the end of the command
-      advanced.reject { |k, _| %i[log pix_fmt].include? k }
-        .each do |k, v|
-        arr.push "-#{k} #{v}"
-      end
-      arr.join(' ') + ' '
-    end
-
-    #
-    # Returns logging command with user given log file
-    # from options or the default file.
-    #
-    def ffmpeg_log_to(file)
-      file ||= DEFAULT_LOG_FILE
-      " 2> #{file}"
-    end
-
-    #
-    # Returns input capture device based on user given value or the current OS.
-    #
-    def determine_capture_device
-      # User given capture device or format
-      # @see https://www.ffmpeg.org/ffmpeg.html#Main-options
-      return advanced[:f] if advanced[:f]
-      return advanced[:fmt] if advanced[:fmt]
-
-      if OS.windows?
-        'gdigrab'
-      elsif OS.linux?
-        'x11grab'
-      elsif OS.mac?
-        'avfoundation'
-      else
-        raise NotImplementedError, 'Your OS is not supported.'
-      end
-    end
-  end
-end
+# @since 1.0.0-beta11
+#
+# @api private
+module ScreenRecorder
+  # @since 1.0.0-beta11
+  class Options
+    attr_reader :all
+
+    DEFAULT_LOG_FILE          = 'ffmpeg.log'.freeze
+    DEFAULT_FPS               = 15.0
+    DEFAULT_MAC_INPUT_PIX_FMT = 'uyvy422'.freeze # For avfoundation
+    DEFAULT_PIX_FMT           = 'yuv420p'.freeze
+    YUV420P_SCALING           = '"scale=trunc(iw/2)*2:trunc(ih/2)*2"'.freeze
+
+    def initialize(options)
+      # @todo Consider using OpenStruct
+      @all                 = verify_options options
+      advanced[:input]     = default_advanced_input.merge(advanced_input)
+      advanced[:output]    = default_advanced_output.merge(advanced_output)
+      advanced[:log] ||= DEFAULT_LOG_FILE
+
+      # Fix for using yuv420p pixel format for output
+      # @see https://www.reck.dk/ffmpeg-libx264-height-not-divisible-by-2/
+      advanced_output[:vf] = YUV420P_SCALING if advanced_output[:pix_fmt] == 'yuv420p'
+    end
+
+    #
+    # Returns given input file or input
+    #
+    def input
+      @all[:input]
+    end
+
+    #
+    # Returns capture device in use
+    #
+    def capture_device
+      determine_capture_device
+    end
+
+    #
+    # Returns given output filepath
+    #
+    def output
+      @all[:output]
+    end
+
+    #
+    # Returns given values that are optional
+    #
+    def advanced
+      @all[:advanced] ||= {}
+    end
+
+    #
+    # Returns given framerate
+    #
+    def framerate
+      ScreenRecorder.logger.warn '#framerate will not be available in the next release. Use #advanced instead.'
+      advanced[:output][:framerate]
+    end
+
+    #
+    # Returns given log filename
+    #
+    def log
+      advanced[:log]
+    end
+
+    #
+    # Returns a String with all options parsed and
+    # ready for the ffmpeg process to use
+    #
+    def parsed
+      vals = "-f #{capture_device} "
+      vals << parse_advanced(advanced_input)
+      vals << "-i #{input} "
+      vals << parse_advanced(advanced_output)
+      vals << parse_advanced(advanced)
+      vals << output
+    end
+
+    private
+
+    #
+    # Verifies the required options are provided and returns
+    # the given options Hash. Raises ArgumentError if all required
+    # options are not present in the given Hash.
+    #
+    def verify_options(options)
+      TypeChecker.check options, Hash
+      TypeChecker.check options[:advanced], Hash if options[:advanced]
+      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
+
+    def advanced_input
+      advanced[:input] ||= {}
+    end
+
+    def advanced_output
+      advanced[:output] ||= {}
+    end
+
+    def default_advanced_input
+      {
+        pix_fmt: OS.mac? ? DEFAULT_MAC_INPUT_PIX_FMT : nil
+      }
+    end
+
+    def default_advanced_output
+      {
+        pix_fmt:   DEFAULT_PIX_FMT,
+        framerate: advanced[:framerate] || DEFAULT_FPS
+      }
+    end
+
+    #
+    # Returns Array of required options as Symbols
+    #
+    def required_options
+      %i[input output]
+    end
+
+    #
+    # Returns given Hash parsed and ready for ffmpeg to receive.
+    #
+    def parse_advanced(opts)
+      # @todo Replace arr with opts.each_with_object([])
+      arr = []
+      # Do not parse input/output and log as they're placed separately in #parsed
+      opts.reject { |k, _| %i[input output log].include? k }
+        .each do |k, v|
+        arr.push "-#{k} #{v}" unless v.nil? # Ignore blank params
+      end
+      arr.join(' ') + ' '
+    end
+
+    #
+    # Returns input capture device based on user given value or the current OS.
+    #
+    def determine_capture_device
+      # User given capture device or format
+      # @see https://www.ffmpeg.org/ffmpeg.html#Main-options
+      return advanced[:f] if advanced[:f]
+
+      return advanced[:fmt] if advanced[:fmt]
+
+      os_specific_capture_device
+    end
+
+    #
+    # Returns input capture device for current OS.
+    #
+    def os_specific_capture_device
+      return 'gdigrab' if OS.windows?
+
+      return 'x11grab' if OS.linux?
+
+      return 'avfoundation' if OS.mac?
+
+      raise NotImplementedError, 'Your OS is not supported.'
+    end
+  end
+end

data/lib/screen-recorder/titles.rb

@@ -1,50 +1,53 @@
-module ScreenRecorder
-  # @since 1.0.0-beta4
-  module Titles
-    # Regex to filter out "Window Title: N/A" from Chrome extensions and "Window Title: ".
-    # This is done to remove unusable titles and to match the Ffmpeg expected input format
-    # for capturing specific windows.
-    # For example, "Window Title: Google - Mozilla Firefox" becomes "Google - Mozilla Firefox".
-    FILTERED_TITLES = %r{^Window Title:( N/A|\s+)?}.freeze
-
-    #
-    # Returns a list of available window titles for the given application (process) name.
-    #
-    def self.fetch(application)
-      ScreenRecorder.logger.debug "Retrieving available windows for: #{application}"
-      WindowGrabber.new.available_windows_for application
-    end
-
-    # @since 1.0.0-beta4
-    class WindowGrabber
-      #
-      # Returns a list of available window titles for the given application (process) name.
-      #
-      def available_windows_for(application)
-        raise NotImplementedError, 'Only Microsoft Windows (gdigrab) supports window capture.' unless OS.windows?
-
-        titles = `tasklist /v /fi "imagename eq #{application}.exe" /fo list | findstr  Window`
-                   .split("\n")
-                   .map { |i| i.gsub(FILTERED_TITLES, '') }
-                   .reject(&:empty?)
-        raise Errors::ApplicationNotFound, "No open windows found for: #{application}.exe" if titles.empty?
-
-        warn_on_mismatch(titles, application)
-        titles
-      end
-
-      private
-
-      #
-      # 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)
-        return if titles.map(&:downcase).join(',').include? application.to_s
-
-        ScreenRecorder.logger.warn "Process name and window title(s) do not match: #{titles}"
-        ScreenRecorder.logger.warn 'Please manually provide the displayed window title.'
-      end
-    end # class WindowGrabber
-  end # module Windows
+module ScreenRecorder
+  # @since 1.0.0-beta4
+  module Titles
+    # Regex to filter out "Window Title: N/A" from Chrome extensions and "Window Title: ".
+    # This is done to remove unusable titles and to match the Ffmpeg expected input format
+    # for capturing specific windows.
+    # For example, "Window Title: Google - Mozilla Firefox" becomes "Google - Mozilla Firefox".
+    FILTERED_TITLES = %r{^Window Title:( N/A|\s+)?}.freeze
+
+    #
+    # Returns a list of available window titles for the given application (process) name.
+    #
+    # @return [Array]
+    def self.fetch(application)
+      ScreenRecorder.logger.debug "Retrieving available windows for: #{application}"
+      WindowGrabber.new.available_windows_for application
+    end
+
+    # @since 1.0.0-beta4
+    #
+    # @api private
+    class WindowGrabber
+      #
+      # Returns a list of available window titles for the given application (process) name.
+      #
+      def available_windows_for(application)
+        raise NotImplementedError, 'Only Microsoft Windows (gdigrab) supports window capture.' unless OS.windows?
+
+        titles = `tasklist /v /fi "imagename eq #{application}.exe" /fo list | findstr  Window`
+                   .split("\n")
+                   .map { |i| i.gsub(FILTERED_TITLES, '') }
+                   .reject(&:empty?)
+        raise Errors::ApplicationNotFound, "No open windows found for: #{application}.exe" if titles.empty?
+
+        warn_on_mismatch(titles, application)
+        titles
+      end
+
+      private
+
+      #
+      # 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)
+        return if titles.map(&:downcase).join(',').include? application.to_s
+
+        ScreenRecorder.logger.warn "Process name and window title(s) do not match: #{titles}"
+        ScreenRecorder.logger.warn 'Please manually provide the displayed window title.'
+      end
+    end # class WindowGrabber
+  end # module Windows
 end # module FFMPEG