streamio-ffmpeg 0.8.2 → 0.8.3

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 0.8.3 2011-09-01
+
+* Parameters now come in the order of codecs, presets, others so that we can override the presets
+* Added encoding option keyframe_interval to set number of frames between i-frames (aka GOP size)
+* Streamio (sponsor of this project) have launched new awesome pricing @ http://streamio.com
+
 == 0.8.2 2011-08-19
 
 * Path to ffmpeg binary can now be specified (thanks jonathandean)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Streamio Networks AB
+Copyright (c) 2011 Streamio AB
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,140 @@
+Streamio FFMPEG
+===============
+
+Simple yet powerful wrapper around the ffmpeg command for reading metadata and transcoding movies.
+
+All work on this project is sponsored by the online video platform [Streamio](http://streamio.com).
+
+[![Streamio](http://d253c4ja9jigvu.cloudfront.net/assets/small-logo.png)](http://streamio.com)
+
+Installation
+------------
+
+    (sudo) gem install streamio-ffmpeg
+
+This version is tested against ffmpeg 0.8. So no guarantees with earlier (or much later) versions. Output and input standards have inconveniently changed rather a lot between versions of ffmpeg. My goal is to keep this library in sync with new versions of ffmpeg as they come along.
+
+Usage
+-----
+
+### Require the gem
+
+``` ruby
+require 'rubygems'
+require 'streamio-ffmpeg'
+```
+
+### Reading Metadata
+
+``` ruby
+movie = FFMPEG::Movie.new("path/to/movie.mov")
+
+movie.duration # 7.5 (duration of the movie in seconds)
+movie.bitrate # 481 (bitrate in kb/s)
+movie.size # 455546 (filesize in bytes)
+
+movie.video_stream # "h264, yuv420p, 640x480 [PAR 1:1 DAR 4:3], 371 kb/s, 16.75 fps, 15 tbr, 600 tbn, 1200 tbc" (raw video stream info)
+movie.video_codec # "h264"
+movie.colorspace # "yuv420p"
+movie.resolution # "640x480"
+movie.width # 640 (width of the movie in pixels)
+movie.height # 480 (height of the movie in pixels)
+movie.frame_rate # 16.72 (frames per second)
+
+movie.audio_stream # "aac, 44100 Hz, stereo, s16, 75 kb/s" (raw audio stream info)
+movie.audio_codec # "aac"
+movie.audio_sample_rate # 44100
+movie.audio_channels # 2
+
+movie.valid? # true (would be false if ffmpeg fails to read the movie)
+```
+
+### Transcoding
+
+First argument is the output file path.
+
+``` ruby
+movie.transcode("tmp/movie.mp4") # Default ffmpeg settings for mp4 format
+```
+
+Keep track of progress with an optional block.
+
+``` ruby
+movie.transcode(movie.mp4") { |progress| puts progress } # 0.2 ... 0.5 ... 1.0
+```
+
+Give custom command line options with a string.
+
+``` ruby
+movie.transcode("movie.mp4", "-ac aac -vc libx264 -ac 2 ...")
+```
+
+Use the EncodingOptions parser for humanly readable transcoding options. Below you'll find most of the supported options. Note that the :custom key will be used as is without modification so use it for any tricky business you might need.
+
+``` ruby
+options = {:video_codec => "libx264", :frame_rate => 10, :resolution => "320x240", :video_bitrate => 300, :video_bitrate_tolerance => 100,
+           :croptop => 60, :cropbottom => 60, :cropleft => 10, :cropright => 10, :aspect => 1.333333, :keyframe_interval => 90,
+           :audio_codec => "libfaac", :audio_bitrate => 32, :audio_sample_rate => 22050, :audio_channels => 1,
+           :threads => 2,
+           :custom => "-flags +loop -cmp +chroma -partitions +parti4x4+partp8x8 -flags2 +mixed_refs -me_method umh -subq 6 -refs 6 -rc_eq 'blurCplx^(1-qComp)' -coder 0 -me_range 16 -g 250 -keyint_min 25 -sc_threshold 40 -i_qfactor 0.71 -qcomp 0.6 -qmin 10 -qmax 51 -qdiff 4 -level 21"}
+movie.transcode("movie.mp4", options)
+```
+
+The transcode function returns a Movie object for the encoded file.
+
+``` ruby
+transcoded_movie = movie.transcode("tmp/movie.flv")
+
+transcoded_movie.video_codec # "flv"
+transcoded_movie.audio_codec # "mp3"
+```
+
+Aspect ratio is added to encoding options automatically if none is specified.
+
+``` ruby
+options = {:resolution => "320x180"} # Will add -aspect 1.77777777777778 to ffmpeg
+```
+
+Preserve aspect ratio on width or height by using the preserve_aspect_ratio transcoder option.
+
+``` ruby
+widescreen_movie = FFMPEG::Movie.new("path/to/widescreen_movie.mov")
+
+options = {:resolution => "320x240"}
+
+transcoder_options = {:preserve_aspect_ratio => :width}
+widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 320x180
+
+transcoder_options = {:preserve_aspect_ratio => :height}
+widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 426x240
+```
+
+For constant bitrate encoding use video_min_bitrate and video_max_bitrate with buffer_size.
+
+``` ruby
+options = {:video_min_bitrate => 600, :video_max_bitrate => 600, :buffer_size => 2000}
+movie.transcode("movie.flv", options)
+```
+
+Use ffpreset files to avoid headaches when encoding with libx264 (http://www.ffmpeg.org/ffmpeg-doc.html#SEC13).
+
+``` ruby
+options = {:video_codec => "libx264", :video_preset => "medium"} # audio_preset and file_preset also availible
+movie.transcode("movie.mp4", options) # encodes video using libx264-medium.ffpreset
+```
+
+Specify the path to ffmpeg
+--------------------------
+
+By default, streamio assumes that the ffmpeg binary is available in the execution path and named ffmpeg and so will run commands that look something like "ffmpeg -i /path/to/input.file ...". Use the FFMPEG.ffmpeg_binary setter to specify the full path to the binary if necessary:
+
+``` ruby
+FFMPEG.ffmpeg_binary = '/usr/local/bin/ffmpeg'
+```
+
+This will cause the same command to run as "/usr/local/bin/ffmpeg -i /path/to/input.file ..." instead.
+
+Copyright
+---------
+
+Copyright (c) 2011 Streamio AB. See LICENSE for details.

data/lib/ffmpeg/encoding_options.rb

@@ -9,8 +9,12 @@ module FFMPEG
         send("convert_#{key}", value) if value && supports_option?(key)
       end
       
-      # put the preset parameters last
-      params = params.reject { |p| p =~ /\-.pre/ } + params.select { |p| p =~ /\-.pre/ }
+      # codecs should go before the presets so that the files will be matched successfully
+      # all other parameters go after so that we can override whatever is in the preset
+      codecs = params.select { |p| p =~ /codec/ }
+      presets = params.select { |p| p =~ /\-.pre/ }
+      other = params - codecs - presets
+      params = codecs + presets + other
       
       params_string = params.join(" ")
       params_string << " #{convert_aspect(calculate_aspect)}" if calculate_aspect?
@@ -128,6 +132,10 @@ module FFMPEG
       "-fpre #{value}"
     end
     
+    def convert_keyframe_interval(value)
+      "-g #{value}"
+    end
+    
     def convert_custom(value)
       value
     end

data/lib/ffmpeg/version.rb

@@ -1,3 +1,3 @@
 module FFMPEG
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streamio-ffmpeg
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
+date: 2011-09-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152909420 !ruby/object:Gem::Requirement
+  requirement: &2160926780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2152909420
+  version_requirements: *2160926780
 description: Simple yet powerful wrapper around ffmpeg to get metadata from movies
   and do transcoding.
 email:
@@ -35,7 +35,7 @@ files:
 - lib/ffmpeg/transcoder.rb
 - lib/ffmpeg/version.rb
 - lib/streamio-ffmpeg.rb
-- README.rdoc
+- README.md
 - LICENSE
 - CHANGELOG
 homepage: http://github.com/streamio/streamio-ffmpeg
@@ -52,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 951887406957158189
+      hash: -1357797066708853074
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 951887406957158189
+      hash: -1357797066708853074
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6

data/README.rdoc

@@ -1,107 +0,0 @@
-= Streamio FFMPEG
-
-Simple yet powerful wrapper around the ffmpeg command for reading metadata and transcoding movies.
-
-== Installation
-
-  (sudo) gem install streamio-ffmpeg
-
-This version is tested against ffmpeg 0.8. So no guarantees with earlier (or much later) versions. Output and input standards have inconveniently changed rather a lot between versions of ffmpeg. My goal is to keep this library in sync with new versions of ffmpeg as they come along.
-
-== Usage
-
-=== Require the gem
-
-  require 'rubygems'
-  require 'streamio-ffmpeg'
-
-=== Reading Metadata
-
-  movie = FFMPEG::Movie.new("path/to/movie.mov")
-  
-  movie.duration # 7.5 (duration of the movie in seconds)
-  movie.bitrate # 481 (bitrate in kb/s)
-  movie.size # 455546 (filesize in bytes)
-  
-  movie.video_stream # "h264, yuv420p, 640x480 [PAR 1:1 DAR 4:3], 371 kb/s, 16.75 fps, 15 tbr, 600 tbn, 1200 tbc" (raw video stream info)
-  movie.video_codec # "h264"
-  movie.colorspace # "yuv420p"
-  movie.resolution # "640x480"
-  movie.width # 640 (width of the movie in pixels)
-  movie.height # 480 (height of the movie in pixels)
-  movie.frame_rate # 16.72 (frames per second)
-  
-  movie.audio_stream # "aac, 44100 Hz, stereo, s16, 75 kb/s" (raw audio stream info)
-  movie.audio_codec # "aac"
-  movie.audio_sample_rate # 44100
-  movie.audio_channels # 2
-  
-  movie.valid? # true (would be false if ffmpeg fails to read the movie)
-  
-=== Transcoding
-
-First argument is the output file path.
-  
-  movie.transcode("tmp/movie.mp4") # Default ffmpeg settings for mp4 format
-
-Keep track of progress with an optional block.
-
-  movie.transcode(movie.mp4") { |progress| puts progress } # 0.2 ... 0.5 ... 1.0
-
-Give custom command line options with a string.
-
-  movie.transcode("movie.mp4", "-ac aac -vc libx264 -ac 2 ...")
-
-Use the EncodingOptions parser for humanly readable transcoding options. Below you'll find most of the supported options. Note that the :custom key will be used as is without modification so use it for any tricky business you might need.
-
-  options = {:video_codec => "libx264", :frame_rate => 10, :resolution => "320x240", :video_bitrate => 300, :video_bitrate_tolerance => 100,
-             :croptop => 60, :cropbottom => 60, :cropleft => 10, :cropright => 10, :aspect => 1.333333,
-             :audio_codec => "libfaac", :audio_bitrate => 32, :audio_sample_rate => 22050, :audio_channels => 1,
-             :threads => 2,
-             :custom => "-flags +loop -cmp +chroma -partitions +parti4x4+partp8x8 -flags2 +mixed_refs -me_method umh -subq 6 -refs 6 -rc_eq 'blurCplx^(1-qComp)' -coder 0 -me_range 16 -g 250 -keyint_min 25 -sc_threshold 40 -i_qfactor 0.71 -qcomp 0.6 -qmin 10 -qmax 51 -qdiff 4 -level 21"}
-  movie.transcode("movie.mp4", options)
-
-The transcode function returns a Movie object for the encoded file.
-
-  transcoded_movie = movie.transcode("tmp/movie.flv")
-  
-  transcoded_movie.video_codec # "flv"
-  transcoded_movie.audio_codec # "mp3"
-  
-Aspect ratio is added to encoding options automatically if none is specified.
-
-  options = {:resolution => 320x180} # Will add -aspect 1.77777777777778 to ffmpeg
-
-Preserve aspect ratio on width or height by using the preserve_aspect_ratio transcoder option.
-
-  widescreen_movie = FFMPEG::Movie.new("path/to/widescreen_movie.mov")
-  
-  options = {:resolution => 320x240}
-  
-  transcoder_options = {:preserve_aspect_ratio => :width}
-  widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 320x180
-  
-  transcoder_options = {:preserve_aspect_ratio => :height}
-  widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 426x240
-
-For constant bitrate encoding use video_min_bitrate and video_max_bitrate with buffer_size.
-
-  options = {:video_min_bitrate => 600, :video_max_bitrate => 600, :buffer_size => 2000}
-  movie.transcode("movie.flv", options)
-
-Use ffpreset files to avoid headaches when encoding with libx264 (http://www.ffmpeg.org/ffmpeg-doc.html#SEC13).
-
-  options = {:video_codec => "libx264", :video_preset => "medium"} # audio_preset and file_preset also availible
-  movie.transcode("movie.mp4", options) # encodes video using libx264-medium.ffpreset
-
-== Specify the path to ffmpeg
-
-By default, streamio assumes that the ffmpeg binary is available in the execution path and named ffmpeg and so will run commands that look something like "ffmpeg -i /path/to/input.file ...". Use the FFMPEG.ffmpeg_binary setter to specify the full path to the binary if necessary:
-
-  FFMPEG.ffmpeg_binary = '/usr/local/bin/ffmpeg'
-
-This will cause the same command to run as "/usr/local/bin/ffmpeg -i /path/to/input.file ..." instead.
-
-== Copyright
-
-Copyright (c) 2010 Streamio Networks AB. See LICENSE for details.