rtranscoder 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.1 / 2008-01-28
+
+* Fixed show-stopping bug:
+  * <tt>lib/rtranscoder/ffmpeg/ffmpeg.rb</tt> was requiring:
+    <tt>lib/rtransocder/ffmpeg/extensions.rb</tt> which no longer exists.
+* Fixed typos in <tt>exmaples/</tt>.
+* Added examples to <tt>README.txt</tt>.
+
 == 0.1.0 / 2008-01-27
 
 * Many bug fixes.

data/README.txt

@@ -26,6 +26,88 @@ to Ruby classes and methods for your convenience.
 
   $ sudo gem install rtranscoder
 
+== EXAMPLES:
+
+* Encode a video to FLV.
+
+    require 'rtranscoder/ffmpeg'
+
+    include RTranscoder
+
+    FFmpeg.encode do |ffmpeg|
+      ffmpeg.input = 'video.avi'
+      ffmpeg.audio_sampling_rate = 22.050.kHz
+      ffmpeg.audio_bitrate = 32 # kbit/s
+      ffmpeg.video_frame_size = '320x240'
+      ffmpeg.output_format = :flv
+      ffmpeg.output = 'video.flv'
+    end
+
+  Equivalent to:
+
+      $ ffmpeg -i video.avi -ar 22050 -ab 32 -f flv -s 320x240 video.flv
+
+* Encode an input AVI file using the x264 codec.
+
+    require 'rtranscoder/mencoder'
+
+    include RTranscoder
+
+    MEncoder.encode do |mencoder|
+      mencoder.input = 'input.avi'
+      mencoder.quiet = true
+
+      # x264 settings
+      mencoder.output_video_codec = :x264
+      mencoder.x264enc.bitrate = 3000
+      mencoder.x264enc.nr = 2000
+
+      # faac settings
+      mencoder.output_audio_codec = :faac
+      mencoder.faac.br = 32
+      mencoder.faac.tns = true
+
+      mencoder.output = 'output.mp4'
+    end
+
+  Equivalent to:
+
+    $ mencoder input.avi -o output.mp4 -queit -ovc x264 -x264encopts \
+      bitrate=3000:nr=2000 -oac faac -faacopts br=32:tns
+
+* Extracts frame starting at 00:00:03 for 00:00:01.
+
+    require 'rtranscoder/ffmpeg'
+
+    include RTranscoder
+
+    FFmpeg.encode do |ffmpeg|
+      ffmpeg.input = 'video.flv'
+      ffmpeg.disable_audio = true
+      ffmpeg.record_start_time = '00:00:03'
+      ffmpeg.record_for = '00:00:01'
+      ffmpeg.fps = 1
+      ffmpeg.overwrite_output_files = true
+      ffmpeg.video_frame_size = '320x240'
+      ffmpeg.output = 'video_thumbnail_%d.jpg'
+    end
+
+  Or even simplier...
+
+    require 'rtranscoder/ffmpeg'
+
+    RTranscoder.thumbnail(:video => 'video.flv',
+                          :start => '00:00:03',
+			  :length => '00:00:01',
+			  :width => 320,
+			  :height => 240,
+			  :image => 'video_thumbnail_%d.jpg')
+
+  Both equivalent to:
+
+      $ ffmpeg -i video.flv -an -ss 00:00:03 -t 00:00:01 -r 1 -y \
+        -s 320x240 video_thumbnail_%d.jpg
+
 == LICENSE:
 
 The MIT License

data/examples/encode_flv.rb

@@ -3,9 +3,7 @@ require 'rtranscoder/ffmpeg'
 include RTranscoder
 
 #
-# Encodes a video to FLV.
-# Equivalent to:
-#   $ ffmpeg -i video.avi -ar 22050 -ab 32 -f flv -s 320x240 video.flv
+# Encode an video to FLV.
 #
 FFmpeg.encode do |ffmpeg|
   ffmpeg.input = 'video.avi'
@@ -15,3 +13,8 @@ FFmpeg.encode do |ffmpeg|
   ffmpeg.output_format = :flv
   ffmpeg.output = 'video.flv'
 end
+
+#
+# Equivalent to:
+#   $ ffmpeg -i video.avi -ar 22050 -ab 32 -f flv -s 320x240 video.flv
+#

data/examples/thumbnail.rb

@@ -3,10 +3,7 @@ require 'rtranscoder/ffmpeg'
 include RTranscoder
 
 #
-# Extracts a frame at 00:00:03.
-# Equivlanent to:
-#   $ ffmpeg -i video.flv -an -ss 00:00:03 -t 00:00:01 -r 1 -y -s 320x240
-#     video_thumbnail.jpg
+# Extracts frame starting at 00:00:03 for 00:00:01.
 #
 FFmpeg.encode do |ffmpeg|
   ffmpeg.input = 'video.flv'
@@ -16,7 +13,7 @@ FFmpeg.encode do |ffmpeg|
   ffmpeg.fps = 1
   ffmpeg.overwrite_output_files = true
   ffmpeg.video_frame_size = '320x240'
-  ffmpeg.output = 'video_thumbnail%d.jpg'
+  ffmpeg.output = 'video_thumbnail_%d.jpg'
 end
 
 #
@@ -27,4 +24,10 @@ RTranscoder.thumbnail(:video => 'video.flv',
                       :length => '00:00:01',
                       :width => 320,
                       :height => 240,
-                      :image => 'thumb%d.jpg')
+                      :image => 'video_thumbnail_%d.jpg')
+
+#
+# Both equivalent to:
+#   $ ffmpeg -i video.flv -an -ss 00:00:03 -t 00:00:01 -r 1 -y \
+#     -s 320x240 video_thumbnail_%d.jpg
+#

data/lib/rtranscoder/ffmpeg/ffmpeg.rb

@@ -1,5 +1,4 @@
 require 'rtranscoder/ffmpeg/ffmpeg_task'
-require 'rtranscoder/ffmpeg/extensions'
 require 'rtranscoder/extensions'
 
 require 'rprogram/program'

data/lib/rtranscoder/version.rb

@@ -1,3 +1,3 @@
 module RTranscoder
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: rtranscoder
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2008-01-27 00:00:00 -08:00
+  version: 0.1.1
+date: 2008-01-28 00:00:00 -08:00
 summary: A Rubyful interface to various transcoding utilities using the RProgram library.
 require_paths: 
 - lib