ffmpeg-screenrecorder 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85788e1924b1350003ba607d5cec470878cb2ecc49a5cf53d5508c4604cb38d
-  data.tar.gz: b438f32841d00eb3c6d3b6a996379f61a9c5e1c4a74335729bd6fc725bf23bae
+  metadata.gz: a9440c4355488a734176f7c2f1efed255cb4ccb48b5a92ef3ca266597af1ee95
+  data.tar.gz: ce51483334355bc4768c655b6bbc644eca9ea9ccc9bea6402a3855bd4032923f
 SHA512:
-  metadata.gz: f36dafd064d1363b8dd5c42e39c2b840bc6a68db1cc7d42b8c65a667b78e45140c304a47581350a32913a79e6860f34d82778cb89510ec4c1f5925b35f22ee8f
-  data.tar.gz: 98763086b2b600ee80cc319b0b5a86bd598aa5e561f309c929afc613ae002caccf535ebb0d00050ad1a75380fd2d87f3e44b106dd13304571b2d13b5499f6a88
+  metadata.gz: 1884a94f4f2725cbdc2e61d323c0b2fab850e5e5d44552f96f9066a0dc4b51076d13f1f4a3de442189187ddb3f5cd9d6ea44466fcff62b20a84e20a4aa66787c
+  data.tar.gz: 859acd8e9f125033e7971c9d021cde9960b04123ce9b63c4f40ecc6af45a33b3cb34d7711e4d9ddd1a27e4aa5a0bfc88d6776946bb5dcafb6d9082531f9173c0

data/README.md

@@ -2,12 +2,35 @@
 
 Ruby gem to record your computer screen - desktop or specific application/window - using [FFMPEG](https://www.ffmpeg.org/).
 
-## Support
+## Windows Only
 
-Only supports Windows OS as of version `1.0.0-beta2`.
+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`.
 
 ## Installation
 
+[Download](https://www.ffmpeg.org/download.html), extract and add the location of `ffmpeg.exe` to your ENV `PATH` variable. Make sure you can execute ffmpeg:
+
+    C:\Users\Lakshya Kapoor>ffmpeg -version
+    ffmpeg version N-92132-g0a41a8bf29 Copyright (c) 2000-2018 the FFmpeg developers
+    built with gcc 8.2.1 (GCC) 20180813
+    configuration: --enable-gpl --enable-version3 --enable-sdl2 --enable-fontconfig --enable-g
+    nutls --enable-iconv --enable-libass --enable-libbluray --enable-libfreetype --enable-libm
+    p3lame --enable-libopencore-amrnb --enable-libopencore-amrwb --enable-libopenjpeg --enable
+    -libopus --enable-libshine --enable-libsnappy --enable-libsoxr --enable-libtheora --enable
+    -libtwolame --enable-libvpx --enable-libwavpack --enable-libwebp --enable-libx264 --enable
+    -libx265 --enable-libxml2 --enable-libzimg --enable-lzma --enable-zlib --enable-gmp --enab
+    le-libvidstab --enable-libvorbis --enable-libvo-amrwbenc --enable-libmysofa --enable-libsp
+    eex --enable-libxvid --enable-libaom --enable-libmfx --enable-amf --enable-ffnvcodec --ena
+    ble-cuvid --enable-d3d11va --enable-nvenc --enable-nvdec --enable-dxva2 --enable-avisynth
+    libavutil      56. 19.101 / 56. 19.101
+    libavcodec     58. 32.100 / 58. 32.100
+    libavformat    58. 18.104 / 58. 18.104
+    libavdevice    58.  4.105 / 58.  4.105
+    libavfilter     7. 33.100 /  7. 33.100
+    libswscale      5.  2.100 /  5.  2.100
+    libswresample   3.  2.100 /  3.  2.100
+    libpostproc    55.  2.100 / 55.  2.100
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -69,9 +92,13 @@ opts      = { output:    'ffmpeg-screenrecorder-firefox.mp4',
 # Stop recording
 @recorder.stop
 
-# Recording file will be available: ffmpeg-screenrecorder-output.mp4
+browser.quit 
 ```
 
+<b>Note</b>:
+1. Always stop the recording before closing the application. Otherwise, ffmpeg will not exit gracefully and may produce an invalid video file.
+2. If you're launching multiple applications or testing an application at different window sizes, recording the `desktop` is a better option.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/ffmpeg-screenrecorder.gemspec

@@ -3,14 +3,14 @@ $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.version = '1.0.0.beta3'
   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'
+                     ' - 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

data/lib/ffmpeg/recorder_options.rb

@@ -1,42 +1,71 @@
 module FFMPEG
+  # @since 1.0.0-beta2
   class RecorderOptions
 
     def initialize(options)
       @options = verify_options options
     end
 
+    #
+    # Returns given recording format
+    #
     def format
       @options[:format]
     end
 
+    #
+    # Returns given framerate
+    #
     def framerate
       @options[:framerate]
     end
 
+    #
+    # Returns given input file or infile
+    #
     def infile
       @options[:infile]
     end
 
+    #
+    # Returns given output filepath
+    #
     def output
       @options[:output]
     end
 
+    #
+    # Returns given values that are optional
+    #
     def advanced
       @options[:advanced]
     end
 
+    #
+    # Returns given log filename
+    #
     def log
       @options[:log]
     end
 
+    #
+    # Returns given log_level
+    #
     def log_level
       @options[:log_level]
     end
 
+    #
+    # Returns all given options
+    #
     def all
       @options
     end
 
+    #
+    # Returns a String with all options parsed as a String,
+    # ready for the ffmpeg process to use
+    #
     def parsed
       vals = "-f #{@options[:format]} "
       vals << "-r #{@options[:framerate]} "
@@ -49,7 +78,8 @@ module FFMPEG
     private
 
     #
-    # Verifies the required options are provided
+    # Verifies the required options are provided and returns
+    # the given options Hash
     #
     def verify_options(options)
       missing_options = required_options.select { |req| options[req].nil? }
@@ -60,7 +90,7 @@ module FFMPEG
     end
 
     #
-    # Returns Array of require options a Symbols
+    # Returns Array of required options sa Symbols
     #
     def required_options
       # -f format
@@ -85,8 +115,10 @@ module FFMPEG
     end
 
     #
-    # Determines if the ffmpeg output will be to a log
-    # file based on given options.
+    # 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.
     #
     def ffmpeg_log_to(file)
       return " 2> #{file}" if file

data/lib/ffmpeg/screenrecorder.rb

@@ -4,6 +4,7 @@ require_relative 'recorder_options'
 require_relative 'windows'
 
 module FFMPEG
+  # @since 1.0.0-beta1
   class Screenrecorder
     extend Windows
 
@@ -16,6 +17,9 @@ module FFMPEG
       initialize_logger(@options.log_level || Logger::ERROR)
     end
 
+    #
+    # Starts the recording
+    #
     def start
       @video     = nil # New file
       start_time = Time.now
@@ -25,6 +29,9 @@ module FFMPEG
       FFMPEG.logger.info 'Recording...'
     end
 
+    #
+    # Stops the recording
+    #
     def stop
       FFMPEG.logger.debug 'Stopping ffmpeg.exe...'
       elapsed = kill_ffmpeg
@@ -35,6 +42,10 @@ module FFMPEG
 
     private
 
+    #
+    # Launches the ffmpeg binary using a generated command based on
+    # the given options.
+    #
     def start_ffmpeg
       FFMPEG.logger.debug "Command: #{command}"
       process = IO.popen(command, 'r+')
@@ -42,6 +53,9 @@ module FFMPEG
       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)
@@ -49,6 +63,9 @@ module FFMPEG
       elapsed
     end
 
+    #
+    # Initializes the logger with the given log level.
+    #
     def initialize_logger(level)
       FFMPEG.logger.progname  = 'FFMPEG'
       FFMPEG.logger.level     = level
@@ -58,11 +75,19 @@ module FFMPEG
       FFMPEG.logger.debug 'Logger initialized.'
     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

data/lib/ffmpeg/windows.rb

@@ -1,18 +1,34 @@
 module FFMPEG
+  # @since 1.0.0-beta2
   module Windows
 
+    #
+    # Returns a list of available window titles for the given application (process) name.
+    #
     def window_titles(application)
       FFMPEG.logger.debug "Retrieving available windows for: #{application}"
       WindowGrabber.new.available_windows_for application
     end
 
+    # @since 1.0.0-beta2
     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)
-        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
+        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 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
   end # module Windows
 end # module FFMPEG

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffmpeg-screenrecorder
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Lakshya Kapoor
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Ruby gem to record your computer screen - desktop or specific application/window
-  - using [FFMPEG](https://www.ffmpeg.org/).
+  - using FFMPEG (https://www.ffmpeg.org).
 email:
 - kapoorlakshya@gmail.com
 executables: []
@@ -145,7 +145,7 @@ files:
 - lib/ffmpeg/recorder_options.rb
 - lib/ffmpeg/screenrecorder.rb
 - lib/ffmpeg/windows.rb
-homepage: https://github.com/kapoorlakshya/ffmpeg-screenrecorder
+homepage: http://github.com/kapoorlakshya/ffmpeg-screenrecorder
 licenses:
 - MIT
 metadata: {}