ffmpeg 0.2.5

data/lib/ffmpeg/video_options.rb

@@ -0,0 +1,197 @@
+module FFMpeg
+  module VideoOptions
+    #
+    # Set frame size. The format is `wxh' (ffserver default = 160x128, ffmpeg default = same as source).
+    # The following abbreviations are recognized:
+    #
+    #   'sqcif'
+    #       128x96
+    #   'qcif'
+    #       176x144
+    #   'cif'
+    #       352x288
+    #   '4cif'
+    #       704x576
+    #   'qqvga'
+    #       160x120
+    #   'qvga'
+    #       320x240
+    #   'vga'
+    #       640x480
+    #   'svga'
+    #       800x600
+    #   'xga'
+    #       1024x768
+    #   'uxga'
+    #       1600x1200
+    #   'qxga'
+    #       2048x1536
+    #   'sxga'
+    #       1280x1024
+    #   'qsxga'
+    #       2560x2048
+    #   'hsxga'
+    #       5120x4096
+    #   'wvga'
+    #       852x480
+    #   'wxga'
+    #       1366x768
+    #   'wsxga'
+    #       1600x1024
+    #   'wuxga'
+    #       1920x1200
+    #   'woxga'
+    #       2560x1600
+    #   'wqsxga'
+    #       3200x2048
+    #   'wquxga'
+    #       3840x2400
+    #   'whsxga'
+    #       6400x4096
+    #   'whuxga'
+    #       7680x4800
+    #   'cga'
+    #       320x200
+    #   'ega'
+    #       640x350
+    #   'hd480'
+    #       852x480
+    #   'hd720'
+    #       1280x720
+    #   'hd1080'
+    #       1920x1080
+    #
+    def resolution(resolution)
+      FFMpegCommand << "-s #{resolution}"
+    end
+    
+    # Set the video bitrate in bit/s (default = 200 kb/s or '200k').
+    def video_bitrate(bitrate)
+      FFMpegCommand << "-vb #{bitrate}"
+    end
+    
+    # Set the number of video frames to record.
+    def video_frames(number)
+      FFMpegCommand << "-vframes #{number}"
+    end
+    
+    # Set frame rate (Hz value, fraction or abbreviation), (default = 25).
+    def framerate(fps)
+      FFMpegCommand << "-r #{fps}"
+    end
+    
+    # Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
+    def aspect(aspect)
+      FFMpegCommand << "-aspect #{aspect}"
+    end
+
+    # Set top crop band size (in pixels).
+    def crop_top(size)
+      FFMpegCommand << "-croptop #{size}"
+    end
+
+    # Set bottom crop band size (in pixels).
+    def crop_bottom(size)
+      FFMpegCommand << "-cropbottom #{size}"
+    end
+
+    # Set left crop band size (in pixels).
+    def crop_left(size)
+      FFMpegCommand << "-cropleft #{size}"
+    end
+
+    # Set right crop band size (in pixels).
+    def crop_right(size)
+      FFMpegCommand << "-cropright #{size}"
+    end
+
+    # Set top pad band size (in pixels).
+    def pad_top(size)
+      FFMpegCommand << "-padtop #{size}"
+    end
+
+    # Set bottom pad band size (in pixels).
+    def pad_bottom(size)
+      FFMpegCommand << "-padbottom #{size}"
+    end
+
+    # Set left pad band size (in pixels).
+    def pad_left(size)
+      FFMpegCommand << "-padleft #{size}"
+    end
+
+    # Set right pad band size (in pixels).
+    def pad_right(size)
+      FFMpegCommand << "-padright #{size}"
+    end
+
+    # Set color of padded bands. The value for padcolor is expressed as a six digit hexadecimal number where the first
+    # two digits represent red, the middle two digits green and last two digits blue (default = 000000 (black)).
+    def pad_color(color)
+      FFMpegCommand << "-padcolor #{color}"
+    end
+
+    # Disable video recording.
+    def disable_video
+      FFMpegCommand << "-vn"
+    end
+
+    # Set video bitrate tolerance (in bits, default 4000k). Has a minimum value of: (target_bitrate/target_framerate).
+    # In 1-pass mode, bitrate tolerance specifies how far ratecontrol is willing to deviate from the target average
+    # bitrate value. This is not related to min/max bitrate. Lowering tolerance too much has an adverse effect on
+    # quality.
+    def video_bitrate_tolerance(tolerance)
+      FFMpegCommand << "-bt #{tolerance}"
+    end
+
+    # Set max video bitrate (in bit/s). Requires -bufsize to be set.
+    def video_maximum_bitrate(bitrate)
+      FFMpegCommand << "-maxrate #{bitrate}"
+    end
+
+    # Set min video bitrate (in bit/s). Most useful in setting up a CBR encode:
+    # ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
+    # It is of little use elsewise.
+    def video_minimum_bitrate(bitrate)
+      FFMpegCommand << "-minrate #{bitrate}"
+    end
+
+    # Set video buffer verifier buffer size (in bits).
+    def video_buffer_size(size)
+      FFMpegCommand << "-bufsize #{size}"
+    end
+
+    # `-vcodec codec'
+    # Force video codec to codec. Use the copy special value to tell that the raw codec data must be copied as is.
+    def video_codec(codec)
+      FFMpegCommand << "-vcodec #{codec}"
+    end
+
+    # Use same video quality as source (implies VBR).
+    def same_video_quality
+      FFMpegCommand << "-sameq"
+    end
+
+    # Select the pass number (1 or 2). It is used to do two-pass video encoding. The statistics of the video are
+    # recorded in the first pass into a log file (see also the option -passlogfile), and in the second pass that log
+    # file is used to generate the video at the exact requested bitrate. On pass 1, you may just deactivate audio and
+    # set output to null, examples for Windows and Unix:
+    #
+    # ffmpeg -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y NUL
+    # ffmpeg -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y /dev/null
+    def video_pass(index)
+      FFMpegCommand << "-pass #{index}"
+    end
+
+    # Set two-pass log file name prefix to prefix, the default file name prefix is "ffmpeg2pass". The complete file
+    # name will be `PREFIX-N.log', where N is a number specific to the output stream.
+    def video_pass_logfile(prefix)
+      FFMpegCommand << "-passlogfile #{prefix}"
+    end
+
+    # Add a new video stream to the current output stream.
+    def new_video
+      FFMpegCommand << "-newvideo"
+    end
+  end
+end

data/rdoc/classes/FFMpeg.html

@@ -0,0 +1,250 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: FFMpeg</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">FFMpeg</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/ffmpeg/audio_options_rb.html">
+                lib/ffmpeg/audio_options.rb
+                </a>
+        <br />
+                <a href="../files/lib/ffmpeg/class_methods_rb.html">
+                lib/ffmpeg/class_methods.rb
+                </a>
+        <br />
+                <a href="../files/lib/ffmpeg/helper_methods_rb.html">
+                lib/ffmpeg/helper_methods.rb
+                </a>
+        <br />
+                <a href="../files/lib/ffmpeg/main_options_rb.html">
+                lib/ffmpeg/main_options.rb
+                </a>
+        <br />
+                <a href="../files/lib/ffmpeg/meta_data_rb.html">
+                lib/ffmpeg/meta_data.rb
+                </a>
+        <br />
+                <a href="../files/lib/ffmpeg/video_advanced_options_rb.html">
+                lib/ffmpeg/video_advanced_options.rb
+                </a>
+        <br />
+                <a href="../files/lib/ffmpeg/video_options_rb.html">
+                lib/ffmpeg/video_options.rb
+                </a>
+        <br />
+                <a href="../files/lib/ffmpeg_rb.html">
+                lib/ffmpeg.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000006">convert</a>&nbsp;&nbsp;
+      <a href="#M000007">ffmpeg_path</a>&nbsp;&nbsp;
+      <a href="#M000005">included</a>&nbsp;&nbsp;
+      <a href="#M000008">run</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name"><a href="FFMpeg/HelperMethods.html">HelperMethods</a></span>
+        <span class="include-name"><a href="FFMpeg/MainOptions.html">MainOptions</a></span>
+        <span class="include-name"><a href="FFMpeg/VideoOptions.html">VideoOptions</a></span>
+        <span class="include-name"><a href="FFMpeg/VideoAdvancedOptions.html">VideoAdvancedOptions</a></span>
+        <span class="include-name"><a href="FFMpeg/AudioOptions.html">AudioOptions</a></span>
+        <span class="include-name"><a href="FFMpeg/MetaData.html">MetaData</a></span>
+      </div>
+    </div>
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="FFMpeg/AudioOptions.html" class="link">FFMpeg::AudioOptions</a><br />
+Module <a href="FFMpeg/ClassMethods.html" class="link">FFMpeg::ClassMethods</a><br />
+Module <a href="FFMpeg/HelperMethods.html" class="link">FFMpeg::HelperMethods</a><br />
+Module <a href="FFMpeg/MainOptions.html" class="link">FFMpeg::MainOptions</a><br />
+Module <a href="FFMpeg/MetaData.html" class="link">FFMpeg::MetaData</a><br />
+Module <a href="FFMpeg/VideoAdvancedOptions.html" class="link">FFMpeg::VideoAdvancedOptions</a><br />
+Module <a href="FFMpeg/VideoOptions.html" class="link">FFMpeg::VideoOptions</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="FFMpeg.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('FFMpeg.src/M000005.html');return false;">
+          <span class="method-name">included</span><span class="method-args">(klass)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+When mixed into a class, extend it with the <a
+href="FFMpeg/ClassMethods.html">ClassMethods</a> module
+</p>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="FFMpeg.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('FFMpeg.src/M000006.html');return false;">
+          <span class="method-name">convert</span><span class="method-args">(from_file, to_file = {}) {|if block_given?| ...}</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Sets up an FFmpegCommand for converting files:
+</p>
+<pre>
+ convert &quot;file1.ext&quot;, :to =&gt; &quot;file2.ext&quot; do
+   seek       &quot;00:03:00&quot;
+   duration   &quot;01:10:00&quot;
+   resolution &quot;800x600&quot;
+ end
+</pre>
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="FFMpeg.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('FFMpeg.src/M000007.html');return false;">
+          <span class="method-name">ffmpeg_path</span><span class="method-args">(path)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Explicitly set ffmpeg path
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="FFMpeg.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('FFMpeg.src/M000008.html');return false;">
+          <span class="method-name">run</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Runs ffmpeg
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/FFMpeg.src/M000005.html

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>included (FFMpeg)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/ffmpeg.rb, line 23</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">klass</span>)
+    <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">ClassMethods</span>
+    
+    <span class="ruby-comment cmt">#</span>
+    <span class="ruby-comment cmt"># Everytime a method is added to the</span>
+    <span class="ruby-comment cmt"># class, check for conflicts with existing</span>
+    <span class="ruby-comment cmt"># module methods</span>
+    <span class="ruby-comment cmt">#</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">method_added</span>(<span class="ruby-identifier">name</span>)
+      <span class="ruby-identifier">check_method</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">method_checking_enabled?</span>
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>