ffmpeg-screenrecorder 1.0.0.beta5 → 1.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a72ed1c811611468b93f3a1677b651881834c3e94aa52582564a1bdee2aba60
-  data.tar.gz: cfce5bdfe5c575a77b7bf12d994a58c406ede56b529704ce5c9ac9d157e72d72
+  metadata.gz: 2c62a747ed63c6178eace85bc00839f1d1812f13eb2c024df6341fa7c9550ac5
+  data.tar.gz: 340337ba29b6f447a77c9c721645aa5cc572c38082db63433e0e73fc70872919
 SHA512:
-  metadata.gz: 6e74b55cb1c1e6cd0e72a4a7d59e8f171b81627102f17a17ee3020c74e672ef0c1df4b0bd1a3c4d577406209d5802d8b6fb009b07266917f9709f84ff02c3f5c
-  data.tar.gz: 06125f14582ae639177ceed36295de452479b6abb76f70654cb71168ca46dac4210c7b43a9c05e5133cd55b8b27aa40baf46920012b4b3f4994563d2c47eb68a
+  metadata.gz: f09d8655ffa42956ec4bfabafa38d742986f9f73781885d190e2b8598156dfe2f7dd70748059a0a6685f6f0b27b87e03af7bc4716c2f614616abb7b86209f261
+  data.tar.gz: 4a8db4f7460bc9dbcae758730bb79a5355ea3ecafe4ffb6f8902d090e8dc4e0e9f4f617a0b3fb2e2571e7ec9ce1d5ffc1ce23da1e1804ea1baa931f887b31abb

data/.gitignore

@@ -15,6 +15,7 @@ Gemfile.lock # Part of best practice
 /spec/reports/
 /tmp/
 /webdrivers_bin
+*.log
 
 Gemfile.lock
 

data/README.md

@@ -54,9 +54,7 @@ Or install it yourself as:
 ```
 opts      = { output:    'ffmpeg-screenrecorder-desktop.mp4',
               input:     'desktop',
-              framerate: 30.0,
-              device:    'gdigrab',
-              log:       'ffmpeg-screenrecorder-log.txt' }
+              framerate: 30.0 }
 @recorder = FFMPEG::ScreenRecorder.new(opts)
 
 # Start recording
@@ -67,7 +65,10 @@ opts      = { output:    'ffmpeg-screenrecorder-desktop.mp4',
 # Stop recording
 @recorder.stop
 
-# Recording file will be available: ffmpeg-screenrecorder-desktop.mp4
+# Recorded file
+@recorder.video #=> 'ffmpeg-screenrecorder-desktop.mp4'
+
+# ffmpeg log will be stored in 'ffmpeg.log'
 ```
 
 ##### Record Specific Application/Window - gdigrab (Windows) Only
@@ -82,7 +83,6 @@ FFMPEG::RecordingRegions.fetch('firefox') # Name of exe
 opts      = { output:    'ffmpeg-screenrecorder-firefox.mp4',
               input:     'Mozilla Firefox',
               framerate: 30.0,
-              device:    'gdigrab',
               log:       'ffmpeg-screenrecorder-firefox.txt' }
 @recorder = FFMPEG::ScreenRecorder.new(opts)
 

data/lib/ffmpeg/recorder_options.rb

@@ -1,6 +1,8 @@
 module FFMPEG
   # @since 1.0.0-beta2
   class RecorderOptions
+    DEFAULT_LOG_FILE = 'ffmpeg.log'
+
     def initialize(options)
       @options = verify_options options
     end
@@ -44,7 +46,7 @@ module FFMPEG
     # Returns given log filename
     #
     def log
-      @options[:log]
+      @options[:log] || DEFAULT_LOG_FILE
     end
 
     #
@@ -115,15 +117,12 @@ module FFMPEG
     end
 
     #
-    # Returns portion of the command which determines
-    # if the ffmpeg output will be logged to a file
-    # or completely ignored based on if the user
-    # provides a log filepath in the options.
+    # Returns logging command with user given log file
+    # from options or the default file.
     #
     def ffmpeg_log_to(file)
-      return " 2> #{file}" if file
-
-      '> nul 2>&1' # No log file given
+      file ||= DEFAULT_LOG_FILE
+      " 2> #{file}"
     end
 
     #

data/lib/ffmpeg/recording_regions.rb

@@ -1,55 +1,64 @@
-module FFMPEG
-  # @since 1.0.0-beta4
-  module RecordingRegions
-    #
-    # Returns a list of available window titles for the given application (process) name.
-    #
-    def self.fetch(application)
-      FFMPEG.logger.debug "Retrieving available windows for: #{application}"
-      WindowGrabber.new.available_windows_for application
-    end
-
-    # @since 1.0.0-beta4
-    class WindowGrabber
-      #
-      # 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?
-
-        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' }
-        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?
-
-        final_list
-      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
+module FFMPEG
+  # @since 1.0.0-beta4
+  module RecordingRegions
+    #
+    # Returns a list of available window titles for the given application (process) name.
+    #
+    def self.fetch(application)
+      FFMPEG.logger.debug "Retrieving available windows for: #{application}"
+      WindowGrabber.new.available_windows_for application
+    end
+
+    # @since 1.0.0-beta4
+    class WindowGrabber
+      #
+      # 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?
+
+        raise NotImplementedError, 'Your OS is not supported.'
+      end
+
+      private
+
+      #
+      # Returns list of windows for Microsoft Windows
+      #
+      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' }
+        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?
+
+        final_list
+      end
+
+      #
+      # Returns list of windows for Linux
+      #
+      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
+
+      #
+      # Returns true if wmctrl is installed
+      #
+      def wmctrl_installed?
+        !`which wmctrl`.empty? # "" when not found
+      end
+    end
+  end # module Windows
 end # module FFMPEG

data/lib/ffmpeg/screenrecorder.rb

@@ -13,7 +13,7 @@ module FFMPEG
       @options = RecorderOptions.new(options)
       @video   = nil
       @process = nil
-      initialize_logger(@options.log_level || Logger::ERROR)
+      initialize_logger(@options.log_level)
     end
 
     #
@@ -49,7 +49,6 @@ module 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
@@ -63,6 +62,11 @@ 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)
+      raise FFMPEG::Error, err_line
     end
 
     #
@@ -70,7 +74,7 @@ module FFMPEG
     #
     def initialize_logger(level)
       FFMPEG.logger.progname  = 'FFmpeg'
-      FFMPEG.logger.level     = level
+      FFMPEG.logger.level     = level || Logger::ERROR
       FFMPEG.logger.formatter = proc do |severity, time, progname, msg|
         "#{time.strftime('%F %T')} #{progname} - #{severity} - #{msg}\n"
       end
@@ -107,7 +111,20 @@ module FFMPEG
 
       return !`where ffmpeg`.empty? if OS.windows?
 
-      true # @todo Check on windows
+      true
+    end
+
+    #
+    # Returns lines from the log file
+    #
+    def get_lines_from_log(count = 2, position = :last)
+      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 # class Recorder
 end # module FFMPEG

data/lib/ffmpeg/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffmpeg-screenrecorder
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0.beta6
 platform: ruby
 authors:
 - Lakshya Kapoor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-26 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler