yamdi 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Changelog.mdown

@@ -0,0 +1,3 @@
+== 0.1.0 (January 22, 2011)
+
+* Initial version of gem supporting reading of metadata attributes from flv files. [Bob Burbach]

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "nokogiri", "~> 1.4.4"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  nokogiri (~> 1.4.4)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bob Burbach
+
+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.rdoc

@@ -0,0 +1,82 @@
+= yamdi
+
+Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi). You'll need yamdi installed in order for the gem to be of any use. If you are on OSX I recommend using homebrew (brew install yamdi).
+
+The Yamdi command line tool expects to receive a path to an flv file and will return XML file of the extracted metadata that we then wrap in a ruby object and use to expose the metadata.
+
+The current gem version only supports the reading of metadata. The command line tool also supports the writing of the metadata into a new .flv file but this is not yet supported in this gem.
+
+
+== Usage
+
+  @metadata = Yamdi.new('path/to/file.flv')
+
+  @metadata.duration #=> 6.02
+
+  @metadata.key_frames.each do |key_frame|
+    key_frame.time     #=> 5.87
+    key_frame.location #=> 13467
+  end
+
+=== Paperclip Processor
+
+You can also use Yamdi in a Paperclip processor. I've provided a simple example in lib/paperclip_processors/metadata_extractor.rb
+
+This is useful for adding things like video duration to your db when a user uploads a video.
+
+== Supported methods
+
+duration          :: float, in seconds
+                  
+has_keyframes?    :: boolean
+has_video?        :: boolean
+has_audio?        :: boolean
+has_metadata?     :: boolean
+has_cue_points?   :: boolean
+can_seek_to_end?  :: boolean
+                  
+audio_codec_id    :: integer
+audio_sample_rate :: integer
+audio_data_rate   :: integer
+audio_sample_size :: integer
+audio_delay       :: float, in seconds
+
+stereo?           :: boolean
+
+video_codec_id    :: integer
+frame_rate        :: float, in seconds
+video_data_rate   :: integer
+
+height            :: integer
+width             :: integer
+
+data_size         :: integer
+audio_size        :: integer
+video_size        :: integer
+file_size         :: integer
+
+last_timestamp             :: float, in seconds
+last_video_frame_timestamp :: float, in seconds
+last_key_frame_timestamp   :: float, in seconds
+last_key_frame_location    :: integer
+
+key_frames :: Array of key frame data, each item contains the following
+- time     :: float, in seconds
+- location :: integer
+  
+
+== Contributing to yamdi
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Bob Burbach. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "yamdi"
+  gem.homepage = "http://github.com/peregrinator/yamdi"
+  gem.license = "MIT"
+  gem.summary = %Q{Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi).}
+  gem.description = %Q{Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi). You'll need yamdi installed in order for the gem to be of any use. If you are on OSX I recommend using homebrew (brew install yamdi).}
+  gem.email = "bob.burbach@gmail.com"
+  gem.authors = ["Bob Burbach"]
+  
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'nokogiri', '~> 1.4.4'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yamdi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/paperclip_processors/metadata_extractor.rb

@@ -0,0 +1,16 @@
+module Paperclip
+  class MetadataExtractor < Paperclip::Processor
+    def make
+      # get the metadata from Yamdi
+      metadata = Yamdi.new(file.path)
+      
+      # add values to the attachment instance (for db persistence, etc)
+      # assumes duration is a column in the table this attachment is being
+      # added to.
+      attachment.instance.duration = metadata.duration
+      
+      # always return a reference to the file when done
+      file
+    end
+  end
+end

data/lib/yamdi.rb

@@ -0,0 +1,150 @@
+require 'tempfile'
+require 'ostruct'
+
+class Yamdi
+  
+  def initialize(flv_path)
+    @metadata = Nokogiri.parse( parse(flv_path) )
+  end
+  
+  def parse(flv_path)
+    temp_file = Tempfile.new('yamdi_tmp')
+    `yamdi -i #{flv_path} -x #{temp_file.path}`
+    contents = temp_file.read
+    temp_file.close
+    contents
+  end
+  
+  def duration
+    @metadata.xpath("//duration").inner_text.to_f
+  end
+  
+  def has_keyframes?
+    boolean @metadata.xpath("//hasKeyframes").inner_text
+  end
+  
+  def has_video?
+    boolean @metadata.xpath("//hasVideo").inner_text
+  end
+  
+  def has_audio?
+    boolean @metadata.xpath("//hasAudio").inner_text
+  end
+  
+  def has_metadata?
+    boolean @metadata.xpath("//hasMetadata").inner_text
+  end
+  
+  def has_cue_points?
+    boolean @metadata.xpath("//hasCuePoints").inner_text
+  end
+  
+  def can_seek_to_end?
+    boolean @metadata.xpath("//canSeekToEnd").inner_text
+  end
+  
+  def audio_codec_id
+    @metadata.xpath("//audiocodecid").inner_text.to_i
+  end
+  
+  def audio_sample_rate
+    @metadata.xpath("//audiosamplerate").inner_text.to_i
+  end
+  
+  def audio_data_rate
+    @metadata.xpath("//audiodatarate").inner_text.to_i
+  end
+  
+  def audio_sample_size
+    @metadata.xpath("//audiosamplesize").inner_text.to_i
+  end
+  
+  def audio_delay
+    @metadata.xpath("//audiodelay").inner_text.to_f
+  end
+  
+  def stereo?
+    boolean @metadata.xpath("//stereo").inner_text
+  end
+  
+  def video_codec_id
+    @metadata.xpath("//videocodecid").inner_text.to_i
+  end
+  
+  def frame_rate
+    @metadata.xpath("//framerate").inner_text.to_f
+  end
+  
+  def video_data_rate
+    @metadata.xpath("//videodatarate").inner_text.to_i
+  end
+  
+  def height
+    @metadata.xpath("//height").inner_text.to_i
+  end
+  
+  def width
+    @metadata.xpath("//width").inner_text.to_i
+  end
+  
+  def data_size
+    @metadata.xpath("//datasize").inner_text.to_i
+  end
+  
+  def audio_size
+    @metadata.xpath("//audiosize").inner_text.to_i
+  end
+  
+  def video_size
+    @metadata.xpath("//videosize").inner_text.to_i
+  end
+  
+  def file_size
+    @metadata.xpath("//filesize").inner_text.to_i
+  end
+  
+  def last_timestamp
+    @metadata.xpath("//lasttimestamp").inner_text.to_f
+  end
+  
+  def last_video_frame_timestamp
+    @metadata.xpath("//lastvideoframetimestamp").inner_text.to_f
+  end
+  
+  def last_key_frame_timestamp
+    @metadata.xpath("//lastkeyframetimestamp").inner_text.to_f
+  end
+  
+  def last_key_frame_location
+    @metadata.xpath("//lastkeyframelocation").inner_text.to_i
+  end
+  
+  def key_frames
+    times_data_xml = @metadata.xpath("//keyframes/times/value")
+    times = []
+    times_data_xml.children.each do |el|
+      times << el.inner_text.to_f
+    end
+    
+    file_positions_xml = @metadata.xpath("//keyframes/filepositions/value")
+    file_positions = []
+    file_positions_xml.children.each do |el|
+      file_positions << el.inner_text.to_i
+    end
+    
+    count = 0
+    key_frames = []
+    while count < times.size do
+      key_frames << OpenStruct.new(:time => times[count], :file_position => file_positions[count])
+      count = count + 1
+    end
+    
+    key_frames
+  end
+  
+  private
+  
+  def boolean(string)
+    string == 'true' ? true : (string == 'false' ? false : string)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'yamdi'
+require 'nokogiri'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/yamdi_spec.rb

@@ -0,0 +1,141 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Yamdi" do
+  it "expects the yamdi command line tool to be installed" do
+    system `which yamdi`
+    $?.exitstatus.should eq(1)
+  end
+  
+  let(:flv_path) { File.join(File.dirname(__FILE__), 'files', 'sample.flv') }
+  
+  before(:all) do
+    @yamdi = Yamdi.new(flv_path)
+  end
+  
+  it "#duration returns the duration of the flv file" do
+    @yamdi.duration.should eq(6.06)
+  end
+  
+  it "#has_keyframes? returns hasKeyframes" do
+    @yamdi.has_keyframes?.should eq(true)
+  end
+  
+  it "#has_video? returns hasVideo" do
+    @yamdi.has_video?.should eq(true)
+  end
+  
+  it "#has_audio? returns hasAudio" do
+    @yamdi.has_audio?.should eq(true)
+  end
+  
+  it "#has_metadata? returns hasMetadata" do
+    @yamdi.has_metadata?.should eq(true)
+  end
+  
+  it "#has_cue_points? returns hasCuePoints" do
+    @yamdi.has_cue_points?.should eq(false)
+  end
+  
+  it "#can_seek_to_end? returns canSeekToEnd" do
+    @yamdi.can_seek_to_end?.should eq(true)
+  end
+  
+  it "#audio_codec_id returns audiocodecid" do
+    @yamdi.audio_codec_id.should eq(2)
+  end
+  
+  it "#audio_sample_rate returns audiosamplerate" do
+    @yamdi.audio_sample_rate.should eq(3)
+  end
+  
+  it "#audio_data_rate returns audiodatarate" do
+    @yamdi.audio_data_rate.should eq(94)
+  end
+  
+  it "#audio_sample_size returns audiosamplesize" do
+    @yamdi.audio_sample_size.should eq(1)
+  end
+  
+  it "#audio_delay returns audiodelay" do
+    @yamdi.audio_delay.should eq(0.00)
+  end
+  
+  it "#stereo? returns stereo" do
+    @yamdi.stereo?.should eq(true)
+  end
+  
+  it "#video_codec_id returns videocodecid" do
+    @yamdi.video_codec_id.should eq(4)
+  end
+  
+  it "#frame_rate returns framerate" do
+    @yamdi.frame_rate.should eq(0.33)
+  end
+  
+  it "#video_data_rate returns videodatarate" do
+    @yamdi.video_data_rate.should eq(14)
+  end
+  
+  it "#height returns height" do
+    @yamdi.height.should eq(288)
+  end
+  
+  it "#width returns height" do
+    @yamdi.width.should eq(360)
+  end
+  
+  it "#data_size returns datasize" do
+    @yamdi.data_size.should eq(88470)
+  end
+  
+  it "#audio_size returns audiosize" do
+    @yamdi.audio_size.should eq(75958)
+  end
+  
+  it "#video_size returns videosize" do
+    @yamdi.video_size.should eq(11572)
+  end
+  
+  it "#file_size returns filesize" do
+    @yamdi.file_size.should eq(89137)
+  end
+  
+  it "#last_timestamp returns lasttimestamp" do
+    @yamdi.last_timestamp.should eq(6.06)
+  end
+  
+  it "#last_video_frame_timestamp returns lastvideoframetimestamp" do
+    @yamdi.last_video_frame_timestamp.should eq(6.04)
+  end
+  
+  it "#last_key_frame_timestamp returns lastkeyframetimestamp" do
+    @yamdi.last_key_frame_timestamp.should eq(6.04)
+  end
+  
+  it "#last_key_frame_location returns lastkeyframelocation" do
+    @yamdi.last_key_frame_location.should eq(83017)
+  end
+  
+  context "key frames" do
+    before(:all) do
+      @key_frame_1 = @yamdi.key_frames.first
+      @key_frame_2 = @yamdi.key_frames.last
+    end
+    
+    it "returns an array of key frame open structs" do
+       @yamdi.key_frames.class.should eq(Array)
+       @yamdi.key_frames.first.class.should eq(OpenStruct)
+       @yamdi.key_frames.last.class.should eq(OpenStruct)
+    end
+    
+    it "returns the proper time values" do
+      @key_frame_1.time.should eq(0.04)
+      @key_frame_2.time.should eq(6.04)
+    end
+    
+    it "returns the proper file position values" do
+      @key_frame_1.file_position.should eq(1327)
+      @key_frame_2.file_position.should eq(83017)
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: yamdi
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bob Burbach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id006
+description: Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi). You'll need yamdi installed in order for the gem to be of any use. If you are on OSX I recommend using homebrew (brew install yamdi).
+email: bob.burbach@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Changelog.mdown
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/paperclip_processors/metadata_extractor.rb
+- lib/yamdi.rb
+- spec/files/sample.flv
+- spec/spec_helper.rb
+- spec/yamdi_spec.rb
+has_rdoc: true
+homepage: http://github.com/peregrinator/yamdi
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi).
+test_files: 
+- spec/spec_helper.rb
+- spec/yamdi_spec.rb