video-sprites 0.0.1.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43859ff5512d89e5dbefb3e3eff88c9660af15a9
+  data.tar.gz: e8feed13b4c139db06e452795cf24619a729b52a
+SHA512:
+  metadata.gz: 90166c4cc92205cedfe25d6a72bd10b4f96698db08c5eea9d2271b55cbbe6f46cb1ff03c3fb2c428f2faaee67ad3f6e9d48815575a1c07e01f158308da4946e2
+  data.tar.gz: 5d1a34832889aacd3720711e18884da2f980aaf4670e62b958169b7940984e69ee7c67bae068def6001a6449b6b529e85eaa690a90fac4bda4e9b1e3dcfbce4e

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.DS_Store

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in video-sprites.gemspec
+gemspec
+'slop'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jason Ronallo
+
+MIT License
+
+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,49 @@
+# Video Sprites
+
+Exports thumbnail images, thumbnail sprite image, and a WebVTT metadata file with synced media fragment URLs to thumbnails within the sprite. 
+
+## Installation
+
+```ruby
+gem install 'video-sprites'
+```
+
+## Requirements
+
+- ffmpeg
+- imagemagick (montage)
+
+## Usage
+
+```shell
+video-sprites --help
+```
+
+```shell
+video-sprites --seconds 5 --width 200 --columns 5 --input . --output ./output
+```
+
+## Test Media Sources
+
+https://www.youtube.com/watch?v=dTCEDG9h9AA
+
+https://www.youtube.com/watch?v=9AGisNPUBqM
+
+https://www.youtube.com/watch?v=Z9To9NOLEPI
+
+https://www.youtube.com/watch?v=Ww4WrcjAOlo
+
+https://www.youtube.com/watch?v=wz-eInv9f7g
+
+## TODO
+
+- Consider adding an option to change the output filename.
+- Optionally allow for scene change detection and variable length cues. How difficult would this be?
+- Should the first timestamp after the first cue not be on the second but be a fractional second instead?
+
+## Authors
+
+- Ashley Blewer
+- Jay Brown 
+- Jason Ronallo
+- Nicholas Zoss

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/video-sprites

@@ -0,0 +1,252 @@
+#!/usr/bin/env ruby
+
+require 'slop'
+require 'fileutils'
+
+# remove all JPEG and VTT files, but leave the directories in place.
+def remove_files(output_directory, verbose)
+  deadfiles = Dir.glob(File.join(output_directory, '**', '*.jpg'))
+  puts "list of dead files will be #{deadfiles}" if verbose
+  deadfiles.each do | deadfile |
+    puts "removing file #{deadfile}" if verbose
+    File.unlink(deadfile)
+  end
+  deadfiles = Dir.glob(File.join(output_directory, '**', '*.vtt'))
+  puts "list of dead files will be #{deadfiles}" if verbose
+  deadfiles.each do | deadfile |
+    puts "removing file #{deadfile}" if verbose
+    File.unlink(deadfile)
+  end
+end
+
+# Format a WebVTT timestamp according to the specification using hours, minutes, seconds, and fractional seconds.
+def timestamp(total_seconds)
+  seconds = total_seconds % 60
+  minutes = (total_seconds / 60) % 60
+  hours = total_seconds / (60 * 60)
+
+  format("%02d:%02d:%02d.000", hours, minutes, seconds)
+end
+
+opts = Slop.new strict: true do
+  banner 'Usage: video-sprites [options]'
+  on 'i', 'input=', 'Input file or directory', required: true
+  on 'o', 'output=', 'Output file or directory', argument: :optional
+  on 's', 'seconds=', 'Seconds interval between snapshots', argument: :optional, as: Integer, default: 5
+  on 'w', 'width=', 'Width of each thumbnail', argument: :optional, as: Integer, default: 200
+  on 'c', 'columns=', 'Number of columns in the image sprite', argument: :optional, as: Integer, default: 5
+  on 'r', 'rows=', 'Maximum number of rows to put into each sprite', argument: :optional, as: Integer
+  # on 'k', 'keep', 'Keep all the individual images and other intermediate artifacts.', argument: :optional
+  on 't', 'start', 'Start time to begin from in seconds or hh:mm:ss[.xxx]', argument: :optional
+  on 'd', 'duration', 'Duration of the clip to extract stills from in seconds or hh:mm:ss[.xxx] and can only be set if --start is also set.', argument: :optional
+  on 'u', 'url=', "Base url to use for webvtt", default: 'http://example.com'
+  on 'g', 'gif', "Create a GIF animation as well?"
+  on 'v', 'verbose', 'Enable verbose mode'
+  on 'z', 'clean', 'Clean up the output directory'
+  on 'h', 'help', 'Help!!!'
+end
+
+begin
+  opts.parse
+rescue Slop::Error => e
+  puts e.message
+  puts opts # print help
+  exit
+end
+
+verbose = opts[:verbose]
+input   = File.expand_path(opts[:input])
+output  = opts[:output]
+seconds  = opts[:seconds]
+columns = opts[:columns]
+width   = opts[:width]
+clean   = opts[:clean]
+
+unless File.exist?(input)
+  puts 'File or directory does not exist!'
+  exit
+end
+
+if verbose
+  puts "Input file: #{input}"
+end
+
+if File.directory?(input)
+  # TODO: Only pull in video files with this. What's the best way to do that?
+  # Should we test for whether a file is a video file or use something potentially more
+  # fragile like testing for extensions?
+  files = Dir.glob(File.join(input, '*'))
+else
+  files = [input]
+end
+
+# Since we allow for input to be either a file or a directory we need to set file paths
+# for use later appropriately.
+if output
+  output_directory = File.expand_path(output)
+  puts "output dir is #{output_directory}" if verbose
+  if File.directory?(output_directory)
+    remove_files(output_directory, verbose) if clean
+  elsif File.exist?(output_directory)
+    raise "Output directory must be a directory, was: #{output}"
+  else
+    FileUtils.mkdir_p(output_directory)
+  end
+else
+  output_directory = input
+  if File.directory?(output_directory)
+    puts "output dir is #{output_directory}" if verbose
+    remove_files(output_directory, verbose) if clean
+  else
+    output_directory = File.dirname(input)
+    puts "output dir is #{output_directory}" if verbose
+    remove_files(output_directory, verbose) if clean
+  end
+end
+
+# This is the main loop where we go through video files.
+files.each do | file |
+
+  # for repeated runs, skip any directories in this directory
+  if File.directory?(file)
+    next
+  end
+
+  puts "Processing file: #{file}" if verbose
+  extension = File.extname(file)
+  basename =  File.basename(file, extension)
+  puts "Basename is: #{basename}" if verbose
+
+  output_path = File.join(output_directory, basename)
+
+  if File.directory?(input)
+    FileUtils.mkdir_p(output_path)
+    output_file_path = File.join(output_directory, basename, basename)
+  else
+    output_file_path = File.join(output_directory, basename)
+  end
+
+  puts "#{output_file_path} output file path"
+  # FIXME: check if the files exist already and maybe don't process anything
+
+  # Use ffprobe to discover the frames per second.
+  ffprobe_cmd = 'ffprobe -i "' + "#{file}" +  '" 2>&1 | sed -n "s/.*, \(.*\) fp.*/\1/p"'
+  puts ffprobe_cmd if verbose
+  # Frames per second can be fractional so round up
+  frames_per_sec=`#{ffprobe_cmd}`.to_f.ceil.to_i
+  frames_value=frames_per_sec * seconds
+  puts "frames_per_sec #{frames_per_sec}, frames_value #{frames_value}" if verbose
+
+  # Using select allows for more exact selection of a frame at the times we want
+  ffmpeg_cmd = %Q|ffmpeg -i "#{file}" -vf select='lt(mod(n\\,#{frames_value})\\,1),fps=1/#{seconds}' |
+  if opts[:start]
+    ffmpeg_cmd += " -ss #{opts[:start]} "
+    if opts[:duration]
+      ffmpeg_cmd += " -t #{opts[:duration]} "
+    end
+  end
+  ffmpeg_cmd += %Q| "#{output_file_path}-%05d.jpg" |
+  puts ffmpeg_cmd if verbose
+  `#{ffmpeg_cmd}`
+
+  # We drop the first snapshot because it is the first frame which will either be useless or already in our poster
+  # image for the video. This also allows the WebVTT to show the thumbnail of a frame that will come some time after
+  # the time selected/clicked on.
+  jpegs = Dir.glob(output_file_path + '*.jpg').sort
+  FileUtils.rm(jpegs.first)
+  jpegs.shift
+
+  if opts[:gif]
+    `convert -delay 20 -loop 0 "#{output_file_path}*.jpg" #{output_file_path}.gif`
+  end
+
+  # Montage concatenates all the images into an image sprite.
+  # TODO: Instead of creating a single sprite take a slice of the output jpegs and create a number of different
+  # sprites.
+  slice_size = jpegs.length
+  if opts[:rows]
+    slice_size = opts[:columns] * opts[:rows]
+  end
+  jpegs.each_slice(slice_size).with_index do | jpeg_slice, index |
+    montage_files = jpeg_slice.map{|jpeg| %Q|"#{jpeg}"|}.join(" ")
+    padded_index = (index + 1).to_s.rjust(5, "0")
+    montage_cmd = %Q|montage #{montage_files} -tile #{columns}x -geometry #{width}x "#{output_file_path}-sprite-#{padded_index}.jpg"|
+    puts montage_cmd if verbose
+    `#{montage_cmd}`
+  end
+
+  # Prepare to create WebVTT file
+  if verbose
+    puts 'Processing a WebVTT file from these images:'
+    puts jpegs
+  end
+  # place all the cues into an array of hashes like this:
+  # {start: 0, end: 5, x: 0, y: 0, w: 200, h: 150}
+  cues = []
+  start = 0
+
+  # Use the first jpeg to determine the height of the resulting thumbs. We already know the width from the
+  # passed in option or the default width.
+  first_jpeg = jpegs.first
+
+  original_height = `identify -format "%h" -ping "#{first_jpeg}"`
+  original_width = `identify -format "%w" -ping "#{first_jpeg}"`
+  processed_height = (original_height.to_f / original_width.to_f * width).to_i
+  height = processed_height
+
+  # For each jpeg create a cue
+  jpegs.each_slice(slice_size) do | jpeg_slice |
+    jpeg_slice.each_with_index do |jpeg, index|
+      puts "Index: #{index}" if verbose
+      cue = {}
+
+      cue[:start] = start
+      cue[:end] = start + opts[:seconds]
+
+      cue[:x] = ((index % opts[:columns]) * opts[:width])
+      puts "x #{cue[:x]}" if verbose
+
+      cue[:y] = (index.to_f / opts[:columns].to_f).floor * height
+      puts "y #{cue[:y]}" if verbose
+
+      cue[:w] = opts[:width]
+      cue[:h] = height
+
+      start += opts[:seconds]
+      puts if verbose
+
+      cues << cue
+    end
+  end
+
+  puts cues if verbose
+
+  # Create a WebVTT file.
+  # TODO: When multiple sprites are created use the correct filename for each sprite.
+  # media fragment order: x,y,w,h
+  webvtt_file_name = output_file_path + '.vtt'
+  puts "Creating WebVTT: #{webvtt_file_name}" if verbose
+  File.open(webvtt_file_name, 'w') do |fh|
+    fh.puts "WEBVTT\n\n"
+
+    cues.each_slice(slice_size).with_index do |cue_slice, index|
+      cue_slice.each do |cue|
+        puts cue if verbose
+        start_timestamp = timestamp(cue[:start])
+        end_timestamp = timestamp(cue[:end])
+        fh.print start_timestamp
+        fh.print ' --> '
+        fh.puts end_timestamp
+
+        padded_index = (index + 1).to_s.rjust(5, "0")
+
+        url = File.join(opts[:url], basename + "-sprite-#{padded_index}.jpg#xywh=#{cue[:x]},#{cue[:y]},#{cue[:w]},#{cue[:h]}")
+
+        fh.puts url
+        fh.puts
+      end
+    end
+
+  end
+
+end

data/lib/video/sprites.rb

@@ -0,0 +1,7 @@
+require "video/sprites/version"
+
+module Video
+  module Sprites
+    # Your code goes here...
+  end
+end

data/lib/video/sprites/version.rb

@@ -0,0 +1,5 @@
+module Video
+  module Sprites
+    VERSION = "0.0.1.pre1"
+  end
+end

data/video-sprites.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'video/sprites/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "video-sprites"
+  spec.version       = Video::Sprites::VERSION
+  spec.authors       = ["Ashley Blewer, Jay Brown, Jason Ronallo, Nick Zoss"]
+  spec.email         = ["ashley.blewer@gmail.com, jlb1504@gmail.com, jronallo@gmail.com, nickzoss@yahoo.com"]
+  spec.summary       = %q{Automatically generated thumbnails for video files.}
+  spec.description   = %q{Automatically generated thumbnails and WebVTT with time synced media fragment URLs for video files.}
+  spec.homepage      = "https://github.com/jronallo/video-sprites"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").select{|file| file =~ /^test\/videos\// ? false : true}
+  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.6"
+  spec.add_development_dependency "slop", '~> 3.3', '>= 3.3.3'
+end

data/video-sprites.iml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="CompassSettings">
+    <option name="compassSupportEnabled" value="true" />
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.idea" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.7.3, ruby-2.1.3-p242) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.3.2, ruby-2.1.3-p242) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="slop (v3.3.3, ruby-2.1.3-p242) [gem]" level="application" />
+  </component>
+</module>
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: video-sprites
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre1
+platform: ruby
+authors:
+- Ashley Blewer, Jay Brown, Jason Ronallo, Nick Zoss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+description: Automatically generated thumbnails and WebVTT with time synced media
+  fragment URLs for video files.
+email:
+- ashley.blewer@gmail.com, jlb1504@gmail.com, jronallo@gmail.com, nickzoss@yahoo.com
+executables:
+- video-sprites
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/video-sprites
+- lib/video/sprites.rb
+- lib/video/sprites/version.rb
+- video-sprites.gemspec
+- video-sprites.iml
+homepage: https://github.com/jronallo/video-sprites
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Automatically generated thumbnails for video files.
+test_files: []