video_sprites 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff00cddcb56e85f7007f4bb2e72a170ad45558ed
+  data.tar.gz: 2b16074efb0f73297c96ed11ac123a9633e87834
+SHA512:
+  metadata.gz: d3f5c637742386b98cfdd6602f0f620fe59ab0491ff149952c737f12bc7140fa0245b56ef95ab64d6ab7400781a09a7a77062cdc0b903c98a3fd7ab20dc6fee4
+  data.tar.gz: ea99033ea838ef2abe6941aa934f329e81ce2445b777f5a780a04f35da2bb41eee8b3c185725ff4135b944973c13449df851b3a10200ded61d3ef85a6fa1092d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vagrant/
+/.byebug_history
+/.imdone

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in video_sprites.gemspec
+gemspec
+
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 North Carolina State University
+
+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,76 @@
+# VideoSprites
+
+Creates thumbnail sprite images and a WebVTT metadata file that can be used within several HTML5 video players to show preview thumbnails when hovering over the video time rail.
+
+The initial version [video-sprites](https://github.com/jronallo/video-sprites) was written during an [AMIA](http://www.amianet.org/) hack day by Ashley Blewer, Jay Brown, Jason Ronallo, and Nicholas Zoss. This version improves on the CLI and allows it to be used as a module in other projects.
+
+## Requirements
+
+- ffmpeg
+- Imagemagick (convert and montage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'video_sprites'
+```
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install video_sprites`
+
+## Usage
+
+See usage with: `videosprites help process`
+
+Try it out with the defaults on one of the test videos in this repository under test/videos:
+`videosprites process test/videos/GibraltarVotesToRemainBritish1967-51sec.mp4 tmp/gibraltar`
+
+Or create sprites that better match your use case:
+`videosprites process test/videos/GibraltarVotesToRemainBritish1967-51sec.mp4 tmp/gibraltar2 --seconds=5 --width=150 --columns=3 --group=6`
+
+You can also make an animated GIF from all the selected frames using the same size as the thumbnails by adding the `--gif` option.
+
+To use the project as a module in your own video processing workflow you can use it like this:
+
+```ruby
+input_file = '/path/to/video.mp4'
+output_directory = '/path/to/tmp/gibraltar2'
+options = {
+  seconds: 10,
+  width: 160,
+  columns: 4,
+  group: 20,
+  gif: false
+}
+processor = VideoSprites::Processor.new(input_file, output_directory, options)
+processor.process
+```
+
+## Players
+
+The following players provide a way to use WebVTT files and images sprites. Note that the WebVTT and thumbnails provided by VideoSprites may not have been tested in all players. Please file an issue if you find an incompatibility with any player.
+
+- [JW Player](https://support.jwplayer.com/customer/portal/articles/1407439-adding-preview-thumbnails)
+- [THEOplayer](https://support.theoplayer.com/hc/en-us/articles/207460505-Preview-Thumbnails)
+- [Radiant Media Player](https://www.radiantmediaplayer.com/docs/3.0/preview-thumbnails.html)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/video_sprites.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/Vagrantfile

@@ -0,0 +1,76 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "boxcutter/centos72"
+
+  config.vm.synced_folder '.', '/vagrant' #, type: 'nfs', mount_options: ['nolock', 'rw', 'vers=3', 'tcp', 'actimeo=2']
+
+  config.vm.provider "virtualbox" do |vb|
+    vb.linked_clone = true
+    vb.memory = 1024
+    vb.cpus = 1
+  end
+
+  config.vm.provision "ansible_local" do |ansible|
+    ansible.playbook = 'ansible/development-playbook.yml'
+    ansible.inventory_path = 'ansible/development.ini'
+    ansible.limit = 'all'
+    # ansible.verbose = 'vvvv'
+  end
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  # config.vm.box_check_update = false
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  # config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+  #   vb.memory = "1024"
+  # end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
+  # such as FTP and Heroku are also available. See the documentation at
+  # https://docs.vagrantup.com/v2/push/atlas.html for more information.
+  # config.push.define "atlas" do |push|
+  #   push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
+  # end
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  # config.vm.provision "shell", inline: <<-SHELL
+  #   apt-get update
+  #   apt-get install -y apache2
+  # SHELL
+end

data/ansible/development-playbook.yml

@@ -0,0 +1,15 @@
+---
+- hosts: video_sprites
+  become: yes
+  become_method: sudo
+  become_user: root
+  remote_user: root
+  gather_facts: yes
+  roles:
+    - role: basic-setup
+    - role: ffmpeg
+      build_dir: /root/ffmpeg_build
+      source_dir: /root/ffmpeg_sources
+    - role: rvm_io.rvm1-ruby
+      rvm1_rubies:
+        - 2.3.3

data/ansible/development.ini

@@ -0,0 +1,2 @@
+[video_sprites]
+localhost ansible_connection=local 

data/ansible/roles/basic-setup/tasks/main.yml

@@ -0,0 +1,35 @@
+---
+- name: install epel-release
+  yum:
+    name: epel-release
+    state: present
+- name: install git repo
+  yum:
+    name: http://opensource.wandisco.com/centos/6/git/x86_64/wandisco-git-release-6-1.noarch.rpm
+    state: present
+- name: install required packages
+  yum:
+    pkg: "{{item}}"
+    state: present
+    update_cache: yes
+  with_items:
+    - git
+    - curl
+    - zlib
+    - zlib-devel
+    - gcc-c++
+    - readline
+    - readline-devel
+    - libyaml-devel
+    - libffi-devel
+    - openssl-devel
+    - make
+    - bzip2
+    - autoconf
+    - automake
+    - libtool
+    - bison
+    - vim
+    - htop
+    - tree
+    - ImageMagick

data/ansible/roles/ffmpeg/defaults/main.yml

@@ -0,0 +1,6 @@
+---
+bin_dir:      "/usr/local/bin"
+lib_dir:      "/usr/local/lib"
+
+build_dir:    "/home/vagrant/ffmpeg_build"
+source_dir:   "/home/vagrant/ffmpeg_sources"

data/ansible/roles/ffmpeg/tasks/ff-libraries.yml

@@ -0,0 +1,21 @@
+---
+- name: remove yum packaged ffmpeg
+  become: yes
+  yum: name=ffmpeg state=absent
+
+- name: Install dependencies
+  yum: name={{ item }} state=present
+  with_items:
+    - autoconf
+    - automake
+    - cmake
+    - freetype-devel
+    - gcc
+    - gcc-c++
+    - git
+    - libtool
+    - make
+    - mercurial
+    - nasm
+    - pkgconfig
+    - zlib-devel

data/ansible/roles/ffmpeg/tasks/ffmpeg.yml

@@ -0,0 +1,18 @@
+---
+- name: GIT clone | ffmpeg
+  git: repo=git://source.ffmpeg.org/ffmpeg.git
+       dest={{ source_dir }}/ffmpeg
+       accept_hostkey=yes
+       depth=1
+
+- name: Compile | ffmpeg
+  shell: "export PATH=/usr/local/bin/:$PATH && {{ item }}"
+  args:
+    chdir: "{{ source_dir }}/ffmpeg"
+    creates: "{{ bin_dir }}/ffmpeg"
+  with_items:
+    - PKG_CONFIG_PATH="{{ build_dir }}/lib/pkgconfig" ./configure --prefix={{ build_dir }} --extra-cflags="-I{{ build_dir }}/include" --extra-ldflags="-L{{ build_dir }}/lib" --bindir={{ bin_dir }} --pkg-config-flags="--static" --enable-gpl --enable-nonfree --enable-libfdk-aac --enable-libfreetype --enable-libmp3lame --enable-libopus --enable-libvorbis --enable-libvpx --enable-libx264 --enable-libx265
+    - make
+    - make install
+    - make distclean
+    - hash -r

data/ansible/roles/ffmpeg/tasks/libfdk_aac.yml

@@ -0,0 +1,19 @@
+---
+# AAC audio encoder
+- name: GIT clone | libfdk_aac
+  git: repo=git://git.code.sf.net/p/opencore-amr/fdk-aac
+       dest={{ source_dir }}/libfdk_aac
+       accept_hostkey=yes
+       depth=1
+
+- name: Compile | libfdk_aac
+  shell: "export PATH=/usr/local/bin/:$PATH && {{ item }}"
+  args:
+    chdir: "{{ source_dir }}/libfdk_aac"
+    creates: "{{ bin_dir }}/libfdk_aac"
+  with_items:
+    - autoreconf -fiv
+    - ./configure --prefix={{ build_dir }} --disable-shared
+    - make
+    - make install
+    - make distclean

data/ansible/roles/ffmpeg/tasks/libmp3lame.yml

@@ -0,0 +1,20 @@
+---
+# - name: libmp3lame | Download
+#   get_url: url=http://downloads.sourceforge.net/project/lame/lame/3.99/lame-3.99.5.tar.gz dest={{ source_dir }}/libmp3lame.tar.gz
+
+- name: libmp3lame | Unarchive
+  unarchive:
+    src: http://downloads.sourceforge.net/project/lame/lame/3.99/lame-3.99.5.tar.gz
+    dest: "{{ source_dir }}"
+    copy: no
+
+- name: Compile | libmp3lame
+  shell: "export PATH=/usr/local/bin/:$PATH && {{ item }}"
+  args:
+    chdir: "{{ source_dir }}/lame-3.99.5"
+    creates: "{{ bin_dir }}/lame-3.99.5"
+  with_items:
+    - ./configure --prefix={{ build_dir }} --bindir={{ bin_dir }} --disable-shared --enable-nasm
+    - make
+    - make install
+    - make distclean

data/ansible/roles/ffmpeg/tasks/libogg.yml

@@ -0,0 +1,18 @@
+---
+# Ogg bitstream library. Required by libtheora and libvorbis.
+- name: libogg | Unarchive
+  unarchive:
+    src: http://downloads.xiph.org/releases/ogg/libogg-1.3.2.tar.gz
+    dest: "{{ source_dir }}"
+    copy: no
+
+- name: Compile | libogg
+  shell: "export PATH=/usr/local/bin/:$PATH && {{ item }}"
+  args:
+    chdir: "{{ source_dir }}/libogg-1.3.2"
+    creates: "{{ bin_dir }}/libogg-1.3.2"
+  with_items:
+    - ./configure --prefix={{ build_dir }} --disable-shared
+    - make
+    - make install
+    - make distclean

data/ansible/roles/ffmpeg/tasks/libopus.yml

@@ -0,0 +1,20 @@
+---
+# Opus audio decoder and encoder
+# 2016-05-21 Changed from using git:// URI to using HTTP
+- name: GIT clone | libopus
+  git: repo=http://git.opus-codec.org/opus.git
+       dest={{ source_dir }}/libopus
+      #  depth=1
+      #  accept_hostkey=yes
+
+- name: Compile | libopus
+  shell: "export PATH=/usr/local/bin/:$PATH && {{ item }}"
+  args:
+    chdir: "{{ source_dir }}/libopus"
+    creates: "{{ bin_dir }}/libopus"
+  with_items:
+    - autoreconf -fiv
+    - ./configure --prefix={{ build_dir }} --disable-shared
+    - make
+    - make install
+    - make distclean

data/ansible/roles/ffmpeg/tasks/libvorbis.yml

@@ -0,0 +1,18 @@
+---
+# Vorbis audio encoder. Requires libogg.
+- name: libvorbis | Unarchive
+  unarchive:
+    src: http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.4.tar.gz
+    dest: "{{ source_dir }}"
+    copy: no
+
+- name: Compile | libvorbis
+  shell: "export PATH=/usr/local/bin/:$PATH && {{ item }}"
+  args:
+    chdir: "{{ source_dir }}/libvorbis-1.3.4"
+    creates: "{{ bin_dir }}/libvorbis-1.3.4"
+  with_items:
+    - LDFLAGS="-L{{ build_dir }}/lib" CPPFLAGS="-I{{ build_dir }}/include" ./configure --prefix="{{ build_dir }}" --with-ogg="{{ build_dir }}" --disable-shared
+    - make
+    - make install
+    - make distclean

data/ansible/roles/ffmpeg/tasks/libvpx.yml

@@ -0,0 +1,18 @@
+---
+# VP8/VP9 video encoder
+- name: GIT clone | libvpx
+  git: repo=https://chromium.googlesource.com/webm/libvpx.git
+       dest={{ source_dir }}/libvpx
+       accept_hostkey=yes
+       depth=1
+
+- name: Compile | libvpx
+  shell: "export PATH=/usr/local/bin/:$PATH && {{ item }}"
+  args:
+    chdir: "{{ source_dir }}/libvpx"
+    creates: "{{ bin_dir }}/libvpx"
+  with_items:
+    - ./configure --prefix={{ build_dir }} --disable-examples
+    - make
+    - make install
+    - make distclean