jani-strip_maker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03ee0c4fbbd4347afa94cf4dc071b507ad2d4e49
+  data.tar.gz: e205e30e1df539998f1da5ee444ab2f35af57fce
+SHA512:
+  metadata.gz: 92c50a0e7c3270bf160a574ab890ce457299996c4e72751869127c331cd209f1a473123ad9ed2f839fabc0e5ef745293490d33399b1491f5aad5358020e99ece
+  data.tar.gz: e4ae15f349eb76fe5d64334df5bdcdfccb778f57210a64394c684cdb0d1dadf2e1fb1a4808e733df2bfc5cdb0a838d7aab3ea510b4f77fafb5960d40b5921178

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/.travis.yml

@@ -0,0 +1,11 @@
+before_install:
+  - sudo apt-get -y update
+  - sudo apt-get -y install libavformat-dev
+  - sudo apt-get -y install ffmpeg
+language: ruby
+rvm:
+  - 2.1.3
+
+addons:
+   code_climate:
+     repo_token: eb25f6f747b9bf0542c5c320abc3acfc76ff0b7437b287251ab7a0d93257d1db

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jani-strip_maker.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", require: nil
+
+unless ENV["CI"]
+  gem 'guard-rspec', require: false
+end

data/Guardfile

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shin'ichi Ohno
+
+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,51 @@
+# Jani::StripMaker
+
+[![Build Status](https://travis-ci.org/shin1ohno/jani-strip_maker.svg?branch=master)](https://travis-ci.org/shin1ohno/jani-strip_maker)
+[![Code Climate](https://codeclimate.com/github/shin1ohno/jani-strip_maker/badges/gpa.svg)](https://codeclimate.com/github/shin1ohno/jani-strip_maker)
+[![Test Coverage](https://codeclimate.com/github/shin1ohno/jani-strip_maker/badges/coverage.svg)](https://codeclimate.com/github/shin1ohno/jani-strip_maker)
+[![Dependency Status](https://gemnasium.com/shin1ohno/jani-strip_maker.svg)](https://gemnasium.com/shin1ohno/jani-strip_maker)
+
+You can use cli
+
+```bash
+./strip_maker from_movie_to_strips --input_file path_to_file --fps N --height N --width N
+```
+
+or you can use from ruby code
+
+```ruby
+# build encode option
+transcode_options = Jani::StripMaker::TranscodeOptions.new
+transcode_options.fps = 15
+transcode_options.width = 320
+transcode_options.fps = 180
+
+# Get strip files in current directory from movie file
+Jani::StripMaker::Movie.new(
+  "path/to/movieFile.mov", transcode_options
+).to_strips.each(&:write)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jani-strip_maker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jani-strip_maker
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jani-strip_maker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/strip_maker

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "rubygems"
+# Prepares the $LOAD_PATH by adding to it lib directories of all gems in the
+# project's bundle:
+require "bundler/setup"
+require "jani/strip_maker/cli"
+
+Jani::StripMaker::CLI.start(ARGV)

data/jani-strip_maker.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jani/strip_maker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jani-strip_maker"
+  spec.version       = Jani::StripMaker::VERSION
+  spec.authors       = ["Shin'ichi Ohno"]
+  spec.email         = ["shin1ohno@me.com"]
+  spec.summary       = "Make jani strip from movie file"
+  spec.description   = "Make jani(https://github.com/shin1ohno/jani) strip from movie file."
+  spec.homepage      = "https://github.com/shin1ohno/jani-strip_maker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = "strip_maker"
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rmagick", "2.13.2"
+  spec.add_dependency "streamio-ffmpeg", "1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-collection_matchers"
+end

data/lib/jani/strip_maker/cli.rb

@@ -0,0 +1,20 @@
+require "thor"
+require "jani/strip_maker/movie"
+require "jani/strip_maker/transcode_options"
+
+class Jani::StripMaker::CLI < Thor
+  desc "from_movie_to_strips INPUT_FILE", "convert movie file into jani formatted strip images"
+  option :fps, type: :numeric, required: true
+  option :width, type: :numeric, required: true
+  option :height, type: :numeric, required: true
+  option :input_file, type: :string, default: true
+
+  def from_movie_to_strips
+    transcode_options = Jani::StripMaker::TranscodeOptions.new
+    transcode_options.fps = options[:fps]
+    transcode_options.width = options[:width]
+    transcode_options.height = options[:height]
+    movie = Jani::StripMaker::Movie.new(movie_filepath: options[:input_file], transcode_options: transcode_options)
+    movie.to_strips.map(&:write)
+  end
+end

data/lib/jani/strip_maker/frame_list.rb

@@ -0,0 +1,39 @@
+require "jani/strip_maker"
+require "jani/strip_maker/strip"
+require "RMagick"
+
+class Jani::StripMaker::FrameList
+  include Magick
+  extend Forwardable
+
+  attr_reader :images
+
+  def initialize(images: [])
+    @images = images.dup
+  end
+
+  def append_image(image)
+    @images << image
+  end
+
+  def append_image_with_filename(filename)
+    append_image(Image.read(filename)[0])
+  end
+
+  def to_strips
+    [].tap do |strips|
+      index = 1
+      while !@images.empty?
+        strip = Jani::StripMaker::Strip.new(index: index)
+        until @images.empty? || strip.big_enough?
+          strip.append_frame(@images.shift)
+        end
+        strips << strip
+        index = index + 1
+        next
+      end
+    end
+  end
+
+  def_delegators :@images, :+, :-, :<<, :[], :at, :[]=, :empty?, :each, :each_with_index, :include?, :all?, :any?, :sort, :uniq, :select, :collect, :find
+end

data/lib/jani/strip_maker/movie.rb

@@ -0,0 +1,46 @@
+require "tmpdir"
+require "jani/strip_maker/frame_list"
+
+class Jani::StripMaker::Movie
+  FILE_NAME_PATTERN = "frame%4d"
+  FILE_NAME_EXTENTION = "jpg"
+
+  include Magick
+
+  def initialize(movie_filepath: movie_filepath, transcode_options: transcode_options)
+    @movie_filepath = (movie_filepath)
+    @transcode_options = transcode_options
+    @_frame_list = []
+  end
+
+  def to_frame_list
+    return @_frame_list unless @_frame_list.empty?
+    movie_full_path = movie_full_path()
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do |dir|
+        execute_ffmpeg_command(movie_full_path)
+        images = ImageList.new(*Dir.glob("*\.#{FILE_NAME_EXTENTION}"))
+        # TODO: raise error if images is empty
+        @_frame_list = Jani::StripMaker::FrameList.new(images: images)
+      end
+    end
+  end
+
+  def to_strips
+    to_frame_list().to_strips()
+  end
+
+  private
+
+  def execute_ffmpeg_command(movie_full_path)
+    if system("ffmpeg -i #{movie_full_path} #{@transcode_options.to_ffmpeg_options} #{FILE_NAME_PATTERN}.#{FILE_NAME_EXTENTION}")
+      # OK. Do nothing
+    else
+      # TODO: raise error
+    end
+  end
+
+  def movie_full_path
+    File.expand_path(@movie_filepath)
+  end
+end

data/lib/jani/strip_maker/strip.rb

@@ -0,0 +1,59 @@
+require "RMagick"
+
+class Jani::StripMaker::Strip
+  include Magick
+
+  FILE_NAME_DIGITS = 4
+  FILE_EXTENTION = "jpg"
+
+  def initialize(images:[] , index: 1)
+    @frame_images = images.dup
+    @index = index
+  end
+
+  def big_enough?
+    return false if frames_count.zero?
+    pixels / frames_count * (frames_count + 1) > Jani::StripMaker::MAX_PIXELS_FOR_MOBILE_SAFARI
+  end
+
+  def write(filename = nil)
+    name = filename || filename()
+    to_rmagic_image_list.append(true).write(name)
+  end
+
+  def append_frame(frame_image)
+    @frame_images << frame_image
+  end
+
+  def to_metadata
+    {
+      index: @index,
+      frames_count: frames_count
+    }
+  end
+
+  private
+
+  def pixels
+    image = @frame_images[0]
+    return 0 unless image
+    image.columns * image.rows * frames_count
+    # To be precise, this should be like below,
+    # but we can assume all frame has same dimension
+    # @frame_images.inject(0) do |pixels, image|
+    #   pixels + image.columns * image.rows
+    # end
+  end
+
+  def frames_count
+    @frame_images.count
+  end
+
+  def to_rmagic_image_list
+    ImageList.new.concat(@frame_images).tap { |list| list.scene = 0 }
+  end
+
+  def filename
+    "#{@index.to_s.rjust(FILE_NAME_DIGITS, "0")}.#{FILE_EXTENTION}"
+  end
+end

data/lib/jani/strip_maker/transcode_options.rb

@@ -0,0 +1,21 @@
+class Jani::StripMaker::TranscodeOptions
+  attr_accessor :fps, :width, :height
+
+  def to_ffmpeg_options
+    [to_bitrate_option(), to_scale_option(), to_fps_option()].join(" ")
+  end
+
+  private
+
+  def to_bitrate_option
+    "-b:v 50000k"
+  end
+
+  def to_scale_option
+    "-vf scale=#{@height}:#{@width}"
+  end
+
+  def to_fps_option
+    "-r #{@fps}"
+  end
+end

data/lib/jani/strip_maker/version.rb

@@ -0,0 +1,5 @@
+module Jani
+  module StripMaker
+    VERSION = "1.0.0"
+  end
+end

data/lib/jani/strip_maker.rb

@@ -0,0 +1,7 @@
+require "jani/strip_maker/version"
+
+module Jani
+  module StripMaker
+    MAX_PIXELS_FOR_MOBILE_SAFARI = 1024 * 1024 * 3
+  end
+end

data/spec/jani/strip_maker/frame_list_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'jani/strip_maker/frame_list'
+include Magick
+
+describe Jani::StripMaker::FrameList do
+  let(:images) { [] }
+  let(:frame_list) { Jani::StripMaker::FrameList.new(images: images) }
+
+  context "by default" do
+    let(:frame_list) { Jani::StripMaker::FrameList.new() }
+
+    it "has no images" do
+      expect(frame_list.images).to be_empty
+    end
+  end
+
+  context "when initialize with images" do
+    let(:images) do
+      [].tap do |images|
+        rand(10).times { images << Image.new(1,1) }
+      end
+    end
+
+    it "has images" do
+      expect(frame_list.images).to eq(images)
+      expect(frame_list.images).to have(images.count).items
+    end
+  end
+
+  describe "#append_image" do
+    subject { frame_list.images }
+    let(:image) { Image.new(1,1) }
+
+    it "appends image to list" do
+      frame_list.append_image(image)
+      expect(subject).to eq([image])
+    end
+  end
+
+  describe "#append_image_with_filename" do
+    subject { frame_list.images[0] }
+    let(:image_file_name) { "spec/fixtures/images/100x100.jpg" }
+
+    it "appends image to list" do
+      frame_list.append_image_with_filename(image_file_name)
+      expect(subject).to be_a_kind_of(Image)
+      expect(subject.columns).to eq(100)
+      expect(subject.rows).to eq(100)
+    end
+  end
+
+  describe "#to_strips" do
+    subject { frame_list.to_strips }
+    let(:images) do
+      [].tap do |images|
+        1000.times { images << Image.new(100,100) }
+      end
+    end
+
+    it "splits into 4 strips" do
+      expect(subject.map(&:to_metadata)).to eq(
+        [
+          {:index=>1, :frames_count=>314},
+          {:index=>2, :frames_count=>314},
+          {:index=>3, :frames_count=>314},
+          {:index=>4, :frames_count=>58}
+        ]
+      )
+    end
+  end
+end

data/spec/jani/strip_maker/movie_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+require "jani/strip_maker/movie"
+require "jani/strip_maker/transcode_options"
+
+describe Jani::StripMaker::Movie do
+  let(:transcode_options) do
+    Jani::StripMaker::TranscodeOptions.new.tap do |options|
+      options.fps = 15
+      options.width = 320
+      options.height = 180
+    end
+  end
+
+  let(:movie) { Jani::StripMaker::Movie.new(movie_filepath: "spec/fixtures/movies/kuro.mov", transcode_options: transcode_options) }
+
+  describe "#to_frame_list" do
+    it "retunrs FrameList" do
+      transcoded = movie.to_frame_list
+      expect(transcoded).to be_a_kind_of(Jani::StripMaker::FrameList)
+      expect(transcoded).not_to be_empty
+    end
+  end
+
+  describe "#to_strips" do
+    it "retunrs strips" do
+      strips = movie.to_strips
+      expect(strips).not_to be_empty
+      expect(strips[0]).to be_a_kind_of(Jani::StripMaker::Strip)
+      expect(strips).to have(3).items
+    end
+  end
+end

data/spec/jani/strip_maker/strip_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'jani/strip_maker/strip'
+include Magick
+
+describe Jani::StripMaker::Strip do
+  let(:images_count) { rand(10) + 10 }
+  let(:strip) { Jani::StripMaker::Strip.new(images: images) }
+
+  let(:images) do
+    [].tap do |images|
+      images_count.times { images << Image.new(1,1) }
+    end
+  end
+
+  describe "#pixels (private)" do
+    subject { strip.send(:pixels) }
+
+    it "sums all images pixels up" do
+      expect(subject).to eq(images_count * 1 * 1)
+    end
+  end
+
+  describe "#big_enough?" do
+    context "when pixels is below limit" do
+      it { expect(strip).not_to be_big_enough }
+    end
+
+    context "when pixels equals limit" do
+      before { stub_const("Jani::StripMaker::MAX_PIXELS_FOR_MOBILE_SAFARI", images_count + 1) }
+      it { expect(strip).not_to be_big_enough }
+    end
+
+    context "when pixels is below limit" do
+      before { stub_const("Jani::StripMaker::MAX_PIXELS_FOR_MOBILE_SAFARI", images_count) }
+      it { expect(strip).to be_big_enough }
+    end
+  end
+end

data/spec/jani/strip_maker_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Jani::StripMaker do
+  it 'has a version number' do
+    expect(Jani::StripMaker::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec/collection_matchers'
+require 'jani/strip_maker'
+require "codeclimate-test-reporter"
+
+if ENV["CI"]
+  CodeClimate::TestReporter.start
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: jani-strip_maker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shin'ichi Ohno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+- !ruby/object:Gem::Dependency
+  name: streamio-ffmpeg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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: Make jani(https://github.com/shin1ohno/jani) strip from movie file.
+email:
+- shin1ohno@me.com
+executables:
+- strip_maker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/strip_maker
+- jani-strip_maker.gemspec
+- lib/jani/strip_maker.rb
+- lib/jani/strip_maker/cli.rb
+- lib/jani/strip_maker/frame_list.rb
+- lib/jani/strip_maker/movie.rb
+- lib/jani/strip_maker/strip.rb
+- lib/jani/strip_maker/transcode_options.rb
+- lib/jani/strip_maker/version.rb
+- spec/fixtures/images/100x100.jpg
+- spec/fixtures/movies/kuro.mov
+- spec/jani/strip_maker/frame_list_spec.rb
+- spec/jani/strip_maker/movie_spec.rb
+- spec/jani/strip_maker/strip_spec.rb
+- spec/jani/strip_maker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shin1ohno/jani-strip_maker
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Make jani strip from movie file
+test_files:
+- spec/fixtures/images/100x100.jpg
+- spec/fixtures/movies/kuro.mov
+- spec/jani/strip_maker/frame_list_spec.rb
+- spec/jani/strip_maker/movie_spec.rb
+- spec/jani/strip_maker/strip_spec.rb
+- spec/jani/strip_maker_spec.rb
+- spec/spec_helper.rb