screenshot_generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc45676b2096d9d1ac542d9e69c4a2491dae98ea
+  data.tar.gz: 90edf5253fffb6edaa668cc0824927dc68c29349
+SHA512:
+  metadata.gz: 866854e0a4210f882315cdb4c6fa5f7fd92d73f771f7e5751b5d689dec888d4e01a0598dce3d0bb35edbcfdb3511fa185cc838e12369c10331ab9c527a040821
+  data.tar.gz: 59e420d241994def73a32944cda3dfc6178fe0c0ce534b2dfa99623480e826e9c05564bf64bf40bcd8ed2103e81b05516c79ef78a1a8365371b3f18ead7928f6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,12 @@
+DO WHAT THE FUCK YOU WANT TO + BEER/PIZZA PUBLIC LICENSE
+Version 1, May 2011
+
+Copyright (C) 2011 Tom Lea
+
+
+DO WHAT THE FUCK YOU WANT TO + BEER/PIZZA PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. You just DO WHAT THE FUCK YOU WANT TO.
+1. If you make a substantial amount of money by exercising clause 0,
+   you should consider buying the author a beer or a pizza.

data/README.md

@@ -0,0 +1,32 @@
+# ScreenshotGenerator
+
+It makes pictures of your videos using ffmpg, and ruby.
+
+## Installation
+```bash
+gem install screenshot_generator
+```
+
+## Usage
+```ruby
+# Capture that lovely view from 3 hours into your 6 hour holiday video.
+ScreenshotGenerator.extract_frame("holiday.mp4", 60*60*3, "the-car-park.jpg")
+
+# Take 20 frames spread evenly around your holiday video, so you can sample the
+# majesty of the same beach, from 20 different angles.
+ScreenshotGenerator.extract_multi("holiday.mp4", "pictures-for-firends/", 20)
+
+# Capture the three interesting bits of your holiday video.
+vid = ScreenshotGenerator.new("holiday.mp4")
+vid.extract_frame(60*60*2+8, "base-jumping.jpg")
+vid.extract_frame(vid.length - 30, "end-credits.jpg")
+```
+
+## Additional usage
+Although not thoroughly tested, it is theoretically possible that this library
+could be used to take screen shots of videos that are neither holiday related,
+nor dull.
+
+## Licence
+WTFBPPL: http://tomlea.co.uk/WTFBPPL.txt
+

data/Rakefile

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

data/lib/screenshot_generator.rb

@@ -0,0 +1,77 @@
+require "screenshot_generator/version"
+
+class ScreenshotGenerator
+  # Helper method for fetching a single frame
+  def self.extract_frame(video, *args)
+    new(video).extract_frame(*args)
+  end
+
+  def self.extract_multi(video, *args)
+    new(video).extract_multi(*args)
+  end
+
+  def initialize(video, size: '640x400')
+    @video = video
+    @size = size
+    raise ArgumentError, "Video does not exist" unless File.exist? @video
+  end
+
+  attr_reader :video, :size
+
+  def extract_frame(offset, path)
+    raise ArgumentError, "File already exists" if File.exist? path
+    offset = format_offset(offset)
+    ffmpeg(
+      "-loglevel", "error",
+      "-ss", offset,
+      "-i", video,
+      "-frames:v", 1,
+      "-s", size,
+      path
+    )
+  end
+
+
+  def extract_multi(dir, count)
+    dir = Pathname.new(dir)
+    0.upto(count) do |index|
+      path = dir + "#{index}.jpg"
+      segment_size = length / (count + 2)
+      offset = (index + 1) * segment_size
+      extract_frame(offset, path)
+    end
+  end
+
+  def length
+    @length ||= get_length
+  end
+
+protected
+
+  def ffmpeg(*args)
+    options = [self.class.ffmpeg, *args].map(&:to_s)
+    options.push(:err=>[:child, :out])
+    IO.popen(options) {|io| return io.read }
+    raise "ffmpeg comamnd #{options.inspect} failed" unless $?.success?
+  end
+
+  def self.ffmpeg
+    @ffmpeg ||= `which ffmpeg`.chomp
+  end
+
+  def get_length
+    output = ffmpeg("-i", video, "-frames", 1)
+    if output =~ /Duration:\s*([0-9:.]+)/
+      h,m,s = $1.split(":").map(&:to_i)
+      h*60^2 + m*60 + s
+    else
+      60
+    end
+  end
+
+  def format_offset(v)
+    m, s = v.divmod(60)
+    h, m = m.divmod(60)
+    "%02i:%02i:%02i" % [h, m, s]
+  end
+end

data/lib/screenshot_generator/version.rb

@@ -0,0 +1,3 @@
+class ScreenshotGenerator
+  VERSION = "0.0.1"
+end

data/screenshot_generator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'screenshot_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "screenshot_generator"
+  spec.version       = ScreenshotGenerator::VERSION
+  spec.authors       = ["Tom Lea"]
+  spec.email         = ["commit@tomlea.co.uk"]
+  spec.summary       = %q{A simple wrapper around FFMpeg for extracing screen shots}
+  spec.homepage      = ""
+  spec.license       = "WTFBPPL"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "chunky_png"
+end

data/spec/features/image_generation_spec.rb

@@ -0,0 +1,101 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require "screenshot_generator"
+require "rspec"
+
+require "chunky_png"
+
+describe ScreenshotGenerator do
+  let(:test_video){ "spec/fixtures/test-video.mov" }
+  let(:tmpfile){ "tmp/test_frame.png" }
+
+  describe ".extract_frame" do
+    it "extracts a frame from the video" do
+      expect(color_for_frame(0)).to be :red
+      expect(color_for_frame(1)).to be :green
+      expect(color_for_frame(2)).to be :blue
+    end
+
+    it "raises an ArgumentError if the video does not exist" do
+      expect{
+        ScreenshotGenerator.extract_frame("/tmp/does-not-exist.mp4", 0, "/dev/null")
+      }.to raise_error ArgumentError
+    end
+
+    it "errors is the output file already exists" do
+      expect{
+        ScreenshotGenerator.extract_frame(test_video, 0, __FILE__)
+      }.to raise_error ArgumentError
+    end
+  end
+
+  describe "#length" do
+    it "knows how long the video is" do
+      expect(ScreenshotGenerator.new(test_video).length).to eq 18
+    end
+  end
+
+  describe ".extract_multi" do
+    it "calls extract_frame for each needed frame" do
+      in_a_temp_dir do |dir|
+        ScreenshotGenerator.extract_multi(test_video, dir, 5)
+        0.upto(5) do |i|
+          %x{convert #{dir + "#{i}.jpg"} #{dir + "#{i}.png"}} 
+        end
+        expect(color_for_image(dir + "0.png")).to be :blue
+        expect(color_for_image(dir + "1.png")).to be :black
+        expect(color_for_image(dir + "2.png")).to be :green
+        expect(color_for_image(dir + "3.png")).to be :white
+        expect(color_for_image(dir + "4.png")).to be :red
+        expect(color_for_image(dir + "5.png")).to be :blue
+      end
+    end
+  end
+
+  def color_for_image(path)
+    rgb(ChunkyPNG::Image.from_file(path)[50,50]).classify
+  end
+
+  def color_for_frame(i)
+    ScreenshotGenerator.extract_frame(test_video, i, tmpfile)
+    color_for_image(tmpfile)
+  ensure
+    File.unlink tmpfile if File.exists?(tmpfile)
+  end
+
+  def in_a_temp_dir
+    dir = Pathname.new("tmp/working")
+    FileUtils.mkdir_p dir
+    yield dir
+  ensure
+    FileUtils.rm_r dir
+  end
+
+  Color = Struct.new(:r, :g, :b) do
+    def classify
+      if r > 250 and g > 250 and b > 250
+        :white
+      elsif r < 5 and g > 250 and b < 5
+        :green
+      elsif r > 250 and g < 5 and b < 5
+        :red
+      elsif r < 5 and g < 5 and b > 250
+        :blue
+      elsif r < 5 and g < 5 and b < 5
+        :black
+      else
+        raise "I don't know the color #{self.inspect}"
+      end
+    end
+  end
+
+  def rgb(color)
+    Color.new(
+      ChunkyPNG::Color.r(color),
+      ChunkyPNG::Color.g(color),
+      ChunkyPNG::Color.b(color)
+    )
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: screenshot_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Lea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- commit@tomlea.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/screenshot_generator.rb
+- lib/screenshot_generator/version.rb
+- screenshot_generator.gemspec
+- spec/features/image_generation_spec.rb
+- spec/fixtures/test-video.mov
+homepage: ''
+licenses:
+- WTFBPPL
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A simple wrapper around FFMpeg for extracing screen shots
+test_files:
+- spec/features/image_generation_spec.rb
+- spec/fixtures/test-video.mov