frames 0.0.1

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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  #- ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in frames.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 brookemckim
+
+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,48 @@
+# Frames
+
+Uses ffprobe to analyze video files frame by frame. 
+
+Use Cases:
+
+* List all P/B/I frames of a video file.
+* List all key frames of a video file.
+* Analyze DTS/PTS of each frame.
+
+## Prerequisites
+
+[ffprobe](http://ffmpeg.org/ffprobe.html)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'frames'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install frames
+
+## Usage
+
+```
+# Point the analyzer to your video file.
+frame_analyzer = Frames::Anaylzer.new("/Users/bmckim/Desktop/sample.avi")
+
+# Get an Array of each frame.
+frame_analyzer.frames
+
+# Want the raw ffprobe output?
+frame.probe
+```
+
+## 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,13 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => [:test]
+task :spec => [:test]

data/frames.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frames/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "frames"
+  gem.version       = Frames::VERSION
+  gem.authors       = ["brookemckim"]
+  gem.email         = ["brooke.mckim@gmail.com"]
+  gem.description   = %q{Uses ffprobe to retrieve metadata about each frame of a video.}
+  gem.summary       = %q{Analyze video metadata frame by frame.}
+  gem.homepage      = "http://github.com/brookemckim/frames"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'mocha'
+end
+

data/lib/frames/analyzer.rb

@@ -0,0 +1,41 @@
+module Frames
+  class FileError < StandardError; end
+
+  # Public: Run ffprobe on a file and analyze the frames from the output.
+  #
+  # file - The file to be anaylzed
+  #
+  # Examples
+  #
+  #   analyzer = Anaylzer.new("/Users/bmckim/Desktop/sample.avi")
+  #   analyzer.frames
+  #   # => [...]
+  class Analyzer
+    def initialize(file)
+      @file = String(file)
+    end
+
+    # Public: Returns the Array of Frames.
+    def frames
+      @frames ||= constructor.frames
+    end
+
+    # Public: Probe the video file.
+    #
+    # Returns String of raw output from ffprobe.
+    def probe
+      output = `ffprobe -show_frames "#{@file}" 2>/dev/null`
+
+      if $? == 0
+        output
+      else
+        raise FileError, "File does not exist or ffprobe was unable to read it"
+      end
+    end
+
+    # Internal: Create FrameConstructor from ffprobe raw output.
+    def constructor
+      FrameConstructor.new(probe)
+    end
+  end
+end

data/lib/frames/frame.rb

@@ -0,0 +1,19 @@
+# Internal: Takes a hash of video/audio frame attributes and makes them 
+# getters on an object.
+module Frames
+  class Frame
+    def initialize(attrs = {})
+      attrs.each do |k,v|
+        self.instance_variable_set(:"@#{k}", v)
+      end
+    end
+
+    attr_reader :media_type, :key_frame, :pkt_pts, :pkt_pts_time, :pkt_dts,
+      :pkt_dts_time, :pkt_duration, :pkt_duration_time, :pkt_pos,
+      :sample_fmt, :nb_samples, :channels, :channel_layout, :width, :height,
+      :sample_aspect_ratio, :pict_type, :coded_picture_number,
+      :display_picture_number, :interlaced_frame, :top_field_first,
+      :repeat_pict, :reference
+  end
+end
+

data/lib/frames/frame_constructor.rb

@@ -0,0 +1,63 @@
+# Internal: Converts raw output from ffprobe into an Array of Frames.
+#
+# Examples
+#
+#   fc = FrameConstructor.new(`ffprobe -show_frames /path/to/video.mp4`)
+#   fc.frames # => [<Frame>,<Frame>]
+module Frames
+  class FrameConstructor
+    def initialize(ffprobe_output)
+      @raw_output = ffprobe_output
+    end
+
+    # Internal: Maps Array of hashes from output into Array Frame objects.
+    def frames
+      frame_hashes.map { |h| Frame.new(h) }
+    end
+
+    # Internal: Converts each raw frame into Hash.
+    #
+    # Returns Array of Hashes.
+    def frame_hashes
+      hashes = []
+
+      split_raw_frames.each do |frame|
+        hashes << raw_frame_to_hash(frame)
+      end
+
+      hashes
+    end
+
+    # Internal: Splits ffprobe output into seperate frames.
+    #
+    # Returns Array of raw ffprobe frames.
+    def split_raw_frames
+      @raw_output.split('[/FRAME]').take_while { |f|
+        f['[FRAME']
+      }
+    end
+
+    private
+
+      # Internal: Parses ffprobe frame metadata into hash.
+      #
+      # Returns Hash of frame attributes.
+      def raw_frame_to_hash(raw_frame)
+        hash_of_raw_frames = {}
+
+        raw_frame
+          .split("\n")
+          .delete_if { |value| !value['='] }
+          .each do |attribute|
+            attribute_array = attribute.split('=')
+            key = attribute_array[0]
+            value = attribute_array[1]
+
+            hash_of_raw_frames.merge!(key.to_sym => value)
+          end
+
+        hash_of_raw_frames
+      end
+  end
+end
+

data/lib/frames/version.rb

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

data/lib/frames.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'frames/version'
+require 'frames/analyzer'
+require 'frames/frame'
+require 'frames/frame_constructor'
+
+module Frames
+
+end

data/spec/frames/analyzer_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Frames::Analyzer do
+  describe 'when video file is valid' do
+    before do
+      @analyzer = Frames::Analyzer.new('/path/to_video.mp4')
+
+      constructor = mock('constructor', :frames => 'framesgohere')
+      @analyzer.stubs(:probe)
+      @analyzer.stubs(:constructor).returns(constructor)
+    end
+
+    describe '#frames' do
+      it 'sets frames to value from the frame constructor' do
+        @analyzer.frames.must_equal 'framesgohere'
+      end
+    end
+  end
+end

data/spec/frames/frame_constuctor_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Frames::FrameConstructor do
+  before do
+    @single_raw_output = <<EOF
+[FRAME]\nmedia_type=video\nkey_frame=0\npkt_pts=N/A\npkt_pts_time=N/A\npkt_dts=N/A\npkt_dts_time=N/A\npkt_pos=6218536\nwidth=522\nheight=282\npix_fmt=yuv420p\nsample_aspect_ratio=1:1\npict_type=P\ncoded_picture_number=860\ndisplay_picture_number=0\ninterlaced_frame=0\ntop_field_first=0\nrepeat_pict=0\nreference=3\n[/FRAME]\n
+EOF
+
+    @multiple_raw_output = <<EOF
+[FRAME]\nmedia_type=video\nkey_frame=0\npkt_pts=N/A\npkt_pts_time=N/A\npkt_dts=N/A\npkt_dts_time=N/A\npkt_pos=6218536\nwidth=522\nheight=282\npix_fmt=yuv420p\nsample_aspect_ratio=1:1\npict_type=P\ncoded_picture_number=860\ndisplay_picture_number=0\ninterlaced_frame=0\ntop_field_first=0\nrepeat_pict=0\nreference=3\n[/FRAME]\n
+[FRAME]\nmedia_type=video\nkey_frame=0\npkt_pts=855\npkt_pts_time=35.660625\npkt_dts=855\npkt_dts_time=35.660625\npkt_pos=6196580\nwidth=522\nheight=282\npix_fmt=yuv420p\nsample_aspect_ratio=1:1\npict_type=B\ncoded_picture_number=855\ndisplay_picture_number=0\ninterlaced_frame=0\ntop_field_first=0\nrepeat_pict=0\nreference=0\n[/FRAME]
+EOF
+    @frame_constructor = Frames::FrameConstructor.new(@multiple_raw_output)
+  end
+
+  describe '#frames' do
+    it 'converts raw output to Array of frames' do
+      frames = @frame_constructor.frames
+
+      frames.must_be_instance_of(Array)
+
+      frames.size.must_equal 2
+      frames.each { |f| f.must_be_instance_of(Frames::Frame) }
+    end
+  end
+
+  describe '#from_hashes' do
+    it 'returns Array of formatted frames' do
+      @frame_constructor.stubs(:raw_frame_to_hash).returns({})
+
+      @frame_constructor.frame_hashes.must_equal [{},{}]
+    end
+  end
+
+  describe '#split_raw_frames' do
+    it 'splits the raw frames' do
+      @frame_constructor.split_raw_frames.size.must_equal 2
+    end
+  end
+
+  describe '#raw_frame_to_hash' do
+    it 'converts raw output frame to hash' do
+      frame_hash = @frame_constructor.send('raw_frame_to_hash', @single_raw_output)
+      expected_frame_hash = {
+        media_type: 'video',
+        key_frame: '0',
+        pkt_pts: 'N/A',
+        pkt_pts_time: 'N/A',
+        pkt_dts: 'N/A',
+        pkt_dts_time: 'N/A',
+        pkt_pos: '6218536',
+        width: '522',
+        height: '282',
+        pix_fmt: 'yuv420p',
+        sample_aspect_ratio: '1:1',
+        pict_type: 'P',
+        coded_picture_number: '860',
+        display_picture_number: '0',
+        interlaced_frame: '0',
+        top_field_first: '0',
+        repeat_pict: '0',
+        reference: '3'
+      }
+
+      frame_hash.must_equal expected_frame_hash
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'mocha'
+
+require 'frames'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: frames
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- brookemckim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses ffprobe to retrieve metadata about each frame of a video.
+email:
+- brooke.mckim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- frames.gemspec
+- lib/frames.rb
+- lib/frames/analyzer.rb
+- lib/frames/frame.rb
+- lib/frames/frame_constructor.rb
+- lib/frames/version.rb
+- spec/frames/analyzer_spec.rb
+- spec/frames/frame_constuctor_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/brookemckim/frames
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Analyze video metadata frame by frame.
+test_files:
+- spec/frames/analyzer_spec.rb
+- spec/frames/frame_constuctor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: