ffmpeg-screenrecorder 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a02c5c9cc4db8684c4a6f3f2f557b0857089c488ef26fc0f6986d7db32ff95cf
+  data.tar.gz: 03c1e725b98ed53f12d954ad084cf86ebfe41514319ebe14e58aec091029809a
+SHA512:
+  metadata.gz: 9c3582ca908bb205de16bf887db6750574b5ade7ad3d83e57bb4aada8a092715a121a8681dbcbf3676cce70ec711545a2472d6e46234e6015232b6c0f1af5237
+  data.tar.gz: 2226a59c6416d4d54a60313e849f09fdff30f6efda276678256b3799b56667d91f126793794c6bf44b72c32005eb8122e058cee88056f42edae033d0ae537f5c

data/.gitignore

@@ -0,0 +1,102 @@
+Gemfile.lock # Part of best practice
+
+# Created by https://www.gitignore.io/api/rubymine+all
+
+### RubyMine+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+# User-specific stuff
+.idea/
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### RubyMine+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+
+# End of https://www.gitignore.io/api/rubymine+all

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,44 @@
+Style/EndOfLine:
+  EnforcedStyle: lf
+
+Metrics/LineLength:
+  Max: 120
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 18
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Lakshya Kapoor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# FFMPEG::Screenrecorder
+
+Ruby gem to record your computer screen using [FFMPEG](https://www.ffmpeg.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ffmpeg-screenrecorder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffmpeg-screenrecorder
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kapoorlakshya/ffmpeg-screenrecorder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ffmpeg/screenrecorder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +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

data/ffmpeg-screenrecorder.gemspec

@@ -0,0 +1,30 @@
+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

data/lib/ffmpeg.rb

@@ -0,0 +1 @@
+require 'ffmpeg/screenrecorder'

data/lib/ffmpeg/screenrecorder.rb

@@ -0,0 +1,111 @@
+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

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: ffmpeg-screenrecorder
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Lakshya Kapoor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: streamio-ffmpeg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A ruby gem based on streamio-ffmpeg gem to record your computer screen
+  in various formats.
+email:
+- kapoorlakshya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ffmpeg-screenrecorder.gemspec
+- lib/ffmpeg.rb
+- lib/ffmpeg/screenrecorder.rb
+homepage: https://github.com/kapoorlakshya/ruby-ffmpeg_screenrecorder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Record your computer screen using ffmpeg via Ruby.
+test_files: []