find_dark_intervals 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e35ab3371aeec2e94879a970e47ce498c6a8c92e
+  data.tar.gz: 324a5a1e3b5732a8a1861eef86aa66f7bb3f766b
+SHA512:
+  metadata.gz: 1c1848211409fc90b4fbb0fc5c06c792b7ea0dfbacbff6fe90f37040d3baeaae698813f3c91bf8a2ce29c84896e5fc75cf34c8dc41c52a06619ebbfccd395d16
+  data.tar.gz: a29ba0598d74df833cd7e590b98e2242829958312b7b6566a7ef6b5cdf5adf775ff1c24d353a4be4b53caf5f8cfba5cd08b5e87819d2a3c717cb3cc3db93793b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in find_dark_intervals.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    find_dark_intervals (0.1.0)
+      descriptive_statistics (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    descriptive_statistics (2.5.1)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  find_dark_intervals!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -0,0 +1,45 @@
+# Find Dark Intervals
+
+Finds sections in a video with sufficient darkness. Works without relying on
+complex machine learning solutions.
+
+## How it works
+
+1. Takes an input video file and splits it into image frames using [ffmpeg](https://www.ffmpeg.org).
+2. Computes a mean grayscale color value for each frame using [ImageMagick](https://www.imagemagick.org).
+3. Identifies sufficiently dark frames using [standard score](https://en.wikipedia.org/wiki/Standard_score).
+4. Computes start/end timeframes for dark segments and trims the original video.
+
+## What can this be used for?
+
+Quickly finding points of interest in a video that correspond to changes in
+brightness.
+
+## Installation
+
+Install it yourself as:
+
+```sh
+gem install find_dark_intervals
+```
+
+## Usage
+
+Make sure you have a recent version of `ffmpeg` and `convert` in your `PATH`.
+
+On Mac, they can be installed using Homebrew:
+
+```sh
+brew update
+brew install ffmpeg imagemagick
+```
+
+Then in `irb`, run:
+
+```rb
+require 'find_dark_intervals'
+FindDarkIntervals::IntervalsFinder.new('your/video/path.mp4').run
+```
+
+After some time, you should see a new file `<video_name>_highlights.mp4` in the
+same directory as the original video.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "find_dark_intervals"
+
+# 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__)
+
+filename = ARGV[0]
+FindDarkIntervals::IntervalsFinder.new(filename).run

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/find_dark_intervals.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "find_dark_intervals/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "find_dark_intervals"
+  spec.version       = FindDarkIntervals::VERSION
+  spec.authors       = ["Maros Hluska"]
+  spec.email         = ["mhluska@gmail.com"]
+
+  spec.summary       = 'Find dark intervals within a video'
+  spec.description   = 'Finds sections in a video with sufficient darkness using ffmpeg, ImageMagick and standard score'
+  spec.homepage      = 'https://mhluska.com'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "descriptive_statistics", "~> 2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/find_dark_intervals.rb

@@ -0,0 +1,5 @@
+module FindDarkIntervals
+end
+
+require 'find_dark_intervals/version'
+require 'find_dark_intervals/intervals_finder'

data/lib/find_dark_intervals/intervals_finder.rb

@@ -0,0 +1,162 @@
+require 'fileutils'
+require 'json'
+require 'descriptive_statistics/safe'
+
+module FindDarkIntervals
+  class IntervalsFinder
+    def initialize(filepath)
+      raise 'No filepath given' unless filepath
+      raise 'File does not exist' unless File.exist?(filepath)
+
+      # TODO: Make a parameter for this.
+      @lossless = true
+      @filepath = filepath
+    end
+
+    def run
+      make_image_frames
+      colors = get_colors
+      intervals = get_intervals(get_colors)
+      generate_video(intervals)
+    end
+
+    private
+
+    def make_image_frames
+      return if Dir.exist?(frames_dirname)
+
+      FileUtils.mkdir_p(frames_dirname)
+      run_command("ffmpeg -i #{@filepath} -r 1/1 #{frames_dirname}/\$filename%03d.jpg")
+    end
+
+    def get_colors
+      return parse_colors_file(colors_filepath) if File.exist?(colors_filepath)
+
+      colors = {}
+
+      Dir.foreach(frames_dirname) do |image_filename|
+        next if image_filename == '.' or image_filename == '..'
+        colors[no_ext(image_filename)] = run_command("convert #{frames_dirname}/#{image_filename} -colorspace Gray -format '%[fx:quantumrange*image.mean]' info:")
+      end
+
+      File.write(colors_filepath, JSON.dump(colors))
+
+      colors
+    end
+
+    def get_intervals(colors)
+      values = colors.values.extend(DescriptiveStatistics)
+      mean = values.mean
+      standard_deviation = values.standard_deviation
+
+      # 2.5 standard deviations towards mean color darkness.
+      # TODO: Make a parameter for this.
+      threshold_std = -2.5
+
+      sorted_frames = colors.keys.sort_by(&:to_i)
+
+      dark_frames = sorted_frames.select do |frame_number|
+        color = colors[frame_number]
+        z_score = z_score(color, mean, standard_deviation)
+        z_score <= threshold_std
+      end
+
+      intervals = find_sequence_boundaries(dark_frames.map(&:to_i))
+
+      intervals.map do |pair|
+        time_start = pair.first.to_f / sorted_frames.last.to_i * duration_minutes
+        time_end = pair.last.to_f / sorted_frames.last.to_i * duration_minutes
+        [time_start, time_end]
+      end
+    end
+
+    def generate_video(intervals)
+      # Segment padding in seconds.
+      # TODO: Make a parameter for this.
+      pad = 3
+      start_time = intervals.first.first.to_i
+      output = []
+
+      intervals.each_with_index do |pair, index|
+        puts "Start: #{format_time(pair.first)}, End: #{format_time(pair.last)}"
+
+        ss = pair.first.to_i
+        to = pair.last.to_i
+        output << "[0:v]trim=#{ss - start_time - pad}:#{to - start_time + pad},setpts=PTS-STARTPTS[v#{index}]"
+        output << "[0:a]atrim=#{ss - start_time - pad}:#{to - start_time + pad},asetpts=PTS-STARTPTS[a#{index}]"
+      end
+
+      concat_inputs = intervals.length.times.map { |index| "[v#{index}][a#{index}]" }.join
+
+      output <<  "#{concat_inputs}concat=n=#{intervals.length}:v=1:a=1[out]"
+
+      # See https://superuser.com/a/522853/194670.
+      lossless_args = @lossless ? '-c:v libx264 -crf 0 -preset ultrafast -c:a libmp3lame -b:a 320k' : ''
+
+      filter_complex = output.join('; ')
+
+      run_command("ffmpeg -ss #{format_time(start_time - pad)} -i #{@filepath} -filter_complex '#{filter_complex}' #{lossless_args} -map '[out]' #{highlights_filepath}")
+    end
+
+    def duration_minutes
+      @duration_minutes ||= `ffprobe -v error -show_entries format=duration -of default=noprint_wrappers=1:nokey=1 #{@filepath}`.to_f
+    end
+
+    # TODO: Move to utils.
+    def z_score(value, mean, standard_deviation)
+      standard_deviation.zero? ? 0 : (value - mean) / standard_deviation
+    end
+
+    # TODO: Move to utils.
+    def run_command(command)
+      puts "Running command: #{command}"
+      `#{command}`
+    end
+
+    # TODO: Move to utils.
+    def no_ext(filename)
+      File.basename(filename, File.extname(filename))
+    end
+
+    # TODO: Move to utils.
+    def format_time(seconds)
+      Time.at(seconds).utc.strftime("%H:%M:%S")
+    end
+
+    # TODO: Move to utils.
+    def find_sequence_boundaries(integer_sequence)
+      boundaries = []
+
+      integer_sequence.each_with_index do |number, index|
+        is_start = integer_sequence[index - 1] != number - 1
+        is_end = integer_sequence[index + 1] != number + 1
+
+        # NOTE: Exclusive results in exluding boundaries where the start is also
+        # the end aka single-frame boundaries.
+        boundaries << number if is_start ^ is_end
+      end
+
+      boundaries.each_slice(2).to_a
+    end
+
+    def parse_colors_file(colors_filepath)
+      JSON.parse(File.read(colors_filepath)).transform_values!(&:to_f)
+    end
+
+    def filename_no_ext
+      @filepath_no_ext || no_ext(@filepath)
+    end
+
+    def frames_dirname
+      File.join(File.dirname(@filepath), "#{filename_no_ext}_frames")
+    end
+
+    def highlights_filepath
+      File.join(File.dirname(@filepath), "#{filename_no_ext}_highlights.mp4")
+    end
+
+    def colors_filepath
+      File.join(frames_dirname, "#{filename_no_ext}_colors.json")
+    end
+  end
+end

data/lib/find_dark_intervals/version.rb

@@ -0,0 +1,3 @@
+module FindDarkIntervals
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: find_dark_intervals
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maros Hluska
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: descriptive_statistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !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: 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'
+description: Finds sections in a video with sufficient darkness using ffmpeg, ImageMagick
+  and standard score
+email:
+- mhluska@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- find_dark_intervals.gemspec
+- lib/find_dark_intervals.rb
+- lib/find_dark_intervals/intervals_finder.rb
+- lib/find_dark_intervals/version.rb
+homepage: https://mhluska.com
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Find dark intervals within a video
+test_files: []