ffsplitter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9544a8a00210da89af516422706274002610c6eb
+  data.tar.gz: 4d0f063c8deb2fd37ca5c697743a644f073626ea
+SHA512:
+  metadata.gz: cbb8063f2907f1e776e7f95c09685e73f96642e216adb7a0247e964546fff7bc9e935e565d0795fc6e3c6bdfde7e10afa56db95eae197105eb947df8304d2cb1
+  data.tar.gz: a0192b0d962f4ae8aee208dacf7a719db6b2852d8ae870858164ea431775abad24ac2d98398493f60eeedb2d000bb3a352dd8157ab89a919f09c87820597f119

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kevin Rockwood
+
+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,22 @@
+# FFSplitter
+
+TODO: Write a gem description
+
+## Installation
+
+    gem install ffsplitter
+
+## Usage
+
+Given the video file `my-video.mp4`
+And `my-video.mp4` has embedded chapter markers
+When I execute `ffsplitter my-video.mp4`
+Then `.mp4` files will be created for each chapter
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/bin/ffsplitter

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'ffsplitter'
+FFSplitter::CLI.run(ARGV)

data/ffsplitter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffsplitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ffsplitter"
+  spec.version       = FFSplitter::VERSION
+  spec.authors       = ["Kevin Rockwood"]
+  spec.email         = ["kevin@rockwood.me"]
+  spec.description   = %q{Split video files into chapters}
+  spec.summary       = %q{ffsplitter will split a video file by its chapters}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_dependency "virtus", "~> 1.0.0.rc2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/ffsplitter/chapter.rb

@@ -0,0 +1,53 @@
+require 'virtus'
+
+module FFSplitter
+  class ChapterList
+
+    include Enumerable
+
+    def initialize
+      @chapters = []
+    end
+
+    def each(&block)
+      @chapters.each { |c| yield c }
+    end
+
+    def add(chapter)
+      chapter.list = self
+      @chapters << chapter
+    end
+  end
+
+  class Chapter
+    include Virtus.model
+
+    attribute :start_frames, Integer, default: 0
+    attribute :end_frames, Integer, default: 0
+    attribute :timebase, Float, default: 1/30000
+    attribute :title, String
+
+    attr_accessor :list
+
+    def start_time
+      timebase * start_frames
+    end
+
+    def end_time
+      timebase * end_frames
+    end
+
+    def filename
+      "#{track} #{title.lstrip}"
+    end
+
+    def index
+      return 0 if list.nil?
+      list.find_index(self)
+    end
+
+    def track
+      (index + 1).to_s.rjust(2, '0')
+    end
+  end
+end

data/lib/ffsplitter/command_runner.rb

@@ -0,0 +1,7 @@
+module FFSplitter
+  class CommandRunner
+    def self.run(command)
+      `#{command}`
+    end
+  end
+end

data/lib/ffsplitter/ffmpeg.rb

@@ -0,0 +1,26 @@
+module FFSplitter
+  class FFMpeg
+    attr_accessor :filename, :runner
+
+    def initialize(filename)
+      self.filename = filename
+      self.runner = CommandRunner
+    end
+
+    def encode(chapters)
+      chapters.each do |chapter|
+        runner.run(chapter_command(chapter))
+      end
+    end
+
+    def read_metadata
+      runner.run("ffmpeg -i #{filename} -v quiet -f ffmetadata -")
+    end
+
+    private
+
+    def chapter_command(chapter)
+      "ffmpeg -ss #{chapter.start_time} -i #{filename} -to #{chapter.end_time} -c copy '#{chapter.filename}.mp4'"
+    end
+  end
+end

data/lib/ffsplitter/metadata_parser.rb

@@ -0,0 +1,33 @@
+module FFSplitter
+  class MetadataParser
+    def self.parse(metadata)
+      chapter_list = ChapterList.new
+      chapter = nil
+
+      metadata.split("\n").each do |line|
+        if line =~ /CHAPTER/
+          chapter = Chapter.new
+        end
+
+        if line =~ /TIMEBASE=(\d+)\/(\d+)/
+          chapter.timebase = $1.to_f / $2.to_f
+        end
+
+        if line =~ /START=(\d+)/
+          chapter.start_frames = $1
+        end
+
+        if line =~ /END=(\d+)/
+          chapter.end_frames = $1
+        end
+
+        if chapter && line =~ /title=(.*)/
+          chapter.title = $1
+          chapter_list.add(chapter)
+        end
+      end
+
+      chapter_list
+    end
+  end
+end

data/lib/ffsplitter/splitter.rb

@@ -0,0 +1,12 @@
+module FFSplitter
+  class Splitter
+    def self.split_via_ffmpeg(filename)
+      split(FFMpeg.new(filename))
+    end
+
+    def self.split(codec)
+      chapter_list = MetadataParser.parse(codec.read_metadata)
+      codec.encode(chapter_list)
+    end
+  end
+end

data/lib/ffsplitter/version.rb

@@ -0,0 +1,3 @@
+module FFSplitter
+  VERSION = "0.0.1"
+end

data/lib/ffsplitter.rb

@@ -0,0 +1,27 @@
+require "ffsplitter/version"
+require "ffsplitter/metadata_parser"
+require "ffsplitter/chapter"
+require "ffsplitter/command_runner"
+require "ffsplitter/ffmpeg"
+require "ffsplitter/splitter"
+
+module FFSplitter
+  class CLI
+    def self.run(argv = ARGV)
+      new(argv).run
+    end
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      if @argv.empty?
+        puts "WTF mate?"
+        exit(1)
+      else
+        Splitter.split_via_ffmpeg(@argv[0])
+      end
+    end
+  end
+end

data/spec/chapter_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module FFSplitter
+  describe ChapterList do
+    describe "#add" do
+      let(:chapter_list) { ChapterList.new }
+      let!(:chapter1) { Chapter.new(title: "Chapter One") }
+      let!(:chapter2) { Chapter.new(title: "Chapter Two") }
+      before do
+        chapter_list.add(chapter1)
+        chapter_list.add(chapter2)
+      end
+      it "adds chapters to its collection" do
+        expect(chapter_list.count).to eq(2)
+        expect(chapter_list).to include(chapter1)
+        expect(chapter_list).to include(chapter2)
+      end
+      it "sets the chapter's list" do
+        expect(chapter1.list).to eq(chapter_list)
+      end
+    end
+  end
+
+  describe Chapter do
+    describe "#start_time, #end_time" do
+      let(:chapter){ Chapter.new(start_frames: 100, end_frames: 200, timebase: 0.5) }
+      it "calculates based on frames and timebase" do
+        expect(chapter.start_time).to eq(50)
+        expect(chapter.end_time).to eq(100)
+      end
+    end
+
+    describe "filename" do
+      let(:chapter){ Chapter.new(title: "   test title") }
+      it "prettys up the chapter title" do
+        expect(chapter.filename).to eq("01 test title")
+      end
+    end
+
+    describe "#index" do
+      let(:chapter) { Chapter.new }
+      context "without a list" do
+        it "returns 0" do
+          expect(chapter.index).to eq(0)
+        end
+      end
+      context "with a list" do
+        let(:chapter_list) { ChapterList.new }
+        before do
+          chapter_list.add Chapter.new
+          chapter_list.add chapter
+        end
+        it "returns the index" do
+          expect(chapter.index).to eq(1)
+        end
+      end
+    end
+  end
+end

data/spec/ffmpeg_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module FFSplitter
+  describe FFMpeg do
+    let(:ffmpeg){ FFMpeg.new("test.mp4") }
+    let(:runner) { double("runner") }
+    before { ffmpeg.runner = runner }
+
+    describe "#encode" do
+      let(:chapter_list) { ChapterList.new }
+      let(:chapter) { Chapter.new(start_frames: 10, end_frames: 20, timebase: 1, title: "title") }
+      before { chapter_list.add(chapter) }
+      it "encodes the chapters" do
+        expect(runner).to receive(:run).with "ffmpeg -ss 10.0 -i test.mp4 -to 20.0 -c copy '01 title.mp4'"
+        ffmpeg.encode(chapter_list)
+      end
+    end
+
+    describe "#read_metadata" do
+      it "reads the metadata" do
+        expect(runner).to receive(:run).with("ffmpeg -i test.mp4 -v quiet -f ffmetadata -")
+        ffmpeg.read_metadata
+      end
+    end
+  end
+end

data/spec/fixtures/metadata_fixtures.rb

@@ -0,0 +1,28 @@
+module FFSplitter
+  module MetadataFixtures
+    MULTICHAPTER = <<-EOF
+      ;FFMETADATA1
+      major_brand=M4V
+      minor_version=1
+      compatible_brands=M4V M4A mp42isom
+      title=2013-10-02 Sandra Poon
+      composer=Kevin Rockwood
+      [CHAPTER]
+      TIMEBASE=1/30000
+      START=0
+      END=2321319
+      title=Ludwig van Beethoven - Piano Trio in D Major, Op. 70 No. 1 ("Ghost Trio")
+      [CHAPTER]
+      TIMEBASE=1/30000
+      START=2321319
+      END=15450435
+      title=-   I. Allegro vivace e con brio
+      [CHAPTER]
+      TIMEBASE=1/30000
+      START=15450435
+      END=15451436
+      title=-   II. Largo assai ed espressivo
+    EOF
+
+  end
+end

data/spec/metadata_parser_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'fixtures/metadata_fixtures'
+
+module FFSplitter
+  describe MetadataParser do
+    describe ".parse" do
+      context "with a single chapter" do
+        let(:metadata) do
+          <<-EOF
+            [CHAPTER]
+            TIMEBASE=1/2
+            START=100
+            END=200
+            title=Ludwig van Beethoven - Piano Trio in D Major
+          EOF
+        end
+        let(:chapters){ MetadataParser.parse(metadata) }
+        it "parses the chapters as an array" do
+          expect(chapters.count).to eq(1)
+        end
+
+        it "calculates the timebase" do
+          expect(chapters.first[:timebase]).to eq(0.5)
+        end
+
+        it "sets the start_frames" do
+          expect(chapters.first[:start_frames]).to eq(100)
+        end
+
+        it "sets the end_frames" do
+          expect(chapters.first[:end_frames]).to eq(200)
+        end
+
+        it "parses the title" do
+          expect(chapters.first[:title]).to eq("Ludwig van Beethoven - Piano Trio in D Major")
+        end
+      end
+
+      context "with multiple chapters" do
+        let(:metadata) do
+          <<-EOF
+            [CHAPTER]
+            title=Chapter One
+            [CHAPTER]
+            title=Chapter Two
+          EOF
+        end
+        let(:chapters){ MetadataParser.parse(metadata) }
+        it "parses all the chapters" do
+          expect(chapters.count).to eq(2)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'ffsplitter'

data/spec/splitter_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module FFSplitter
+  describe Splitter do
+    describe ".split!" do
+      let(:codec) { double('Codec') }
+      let(:metadata) do
+        <<-EOF
+          [CHAPTER]
+          title=Chapter One
+        EOF
+      end
+      it "parses and encodes" do
+        expect(codec).to receive(:read_metadata).and_return(metadata)
+        expect(codec).to receive(:encode).with(an_instance_of(ChapterList))
+        Splitter.split(codec)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: ffsplitter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Rockwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Split video files into chapters
+email:
+- kevin@rockwood.me
+executables:
+- ffsplitter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ffsplitter
+- ffsplitter.gemspec
+- lib/ffsplitter.rb
+- lib/ffsplitter/chapter.rb
+- lib/ffsplitter/command_runner.rb
+- lib/ffsplitter/ffmpeg.rb
+- lib/ffsplitter/metadata_parser.rb
+- lib/ffsplitter/splitter.rb
+- lib/ffsplitter/version.rb
+- spec/chapter_spec.rb
+- spec/ffmpeg_spec.rb
+- spec/fixtures/metadata_fixtures.rb
+- spec/metadata_parser_spec.rb
+- spec/spec_helper.rb
+- spec/splitter_spec.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: ffsplitter will split a video file by its chapters
+test_files:
+- spec/chapter_spec.rb
+- spec/ffmpeg_spec.rb
+- spec/fixtures/metadata_fixtures.rb
+- spec/metadata_parser_spec.rb
+- spec/spec_helper.rb
+- spec/splitter_spec.rb