git.sesse.net Git - casparcg/blob - build/html/producers/ffmpeg.html

   1
   2
   3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6
   7 <html xmlns="http://www.w3.org/1999/xhtml">
   8   <head>
   9     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10
  11     <title>1. FFMPEG Producer &mdash; CasparCG 2.0 documentation</title>
  12
  13     <link rel="stylesheet" href="../_static/default.css" type="text/css" />
  14     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  15
  16     <script type="text/javascript">
  17       var DOCUMENTATION_OPTIONS = {
  18         URL_ROOT:    '../',
  19         VERSION:     '2.0',
  20         COLLAPSE_INDEX: false,
  21         FILE_SUFFIX: '.html',
  22         HAS_SOURCE:  true
  23       };
  24     </script>
  25     <script type="text/javascript" src="../_static/jquery.js"></script>
  26     <script type="text/javascript" src="../_static/underscore.js"></script>
  27     <script type="text/javascript" src="../_static/doctools.js"></script>
  28     <script type="text/javascript" src="../_static/sidebar.js"></script>
  29     <link rel="search" type="application/opensearchdescription+xml"
  30           title="Search within CasparCG 2.0 documentation"
  31           href="../_static/opensearch.xml"/>
  32     <link rel="author" title="About these documents" href="../about.html" />
  33     <link rel="copyright" title="Copyright" href="../copyright.html" />
  34     <link rel="top" title="CasparCG 2.0 documentation" href="../index.html" />
  35     <link rel="up" title="Producers" href="index.html" />
  36     <link rel="next" title="2. Flash Producer" href="flash.html" />
  37     <link rel="prev" title="Producers" href="index.html" />
  38
  39
  40   </head>
  41   <body>
  42     <div class="related">
  43       <h3>Navigation</h3>
  44       <ul>
  45         <li class="right" style="margin-right: 10px">
  46           <a href="../genindex.html" title="General Index"
  47              accesskey="I">index</a></li>
  48         <li class="right" >
  49           <a href="flash.html" title="2. Flash Producer"
  50              accesskey="N">next</a> |</li>
  51         <li class="right" >
  52           <a href="index.html" title="Producers"
  53              accesskey="P">previous</a> |</li>
  54         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
  55
  56           <li><a href="index.html" accesskey="U">Producers</a> &raquo;</li>
  57       </ul>
  58     </div>
  59
  60     <div class="document">
  61       <div class="documentwrapper">
  62         <div class="bodywrapper">
  63           <div class="body">
  64
  65   <div class="section" id="ffmpeg-producer">
  66 <h1>1. FFMPEG Producer<a class="headerlink" href="#ffmpeg-producer" title="Permalink to this headline">¶</a></h1>
  67 <div class="section" id="supported-media">
  68 <h2>1.1. Supported Media<a class="headerlink" href="#supported-media" title="Permalink to this headline">¶</a></h2>
  69 <p>The ffmpeg producer supports all files that the &#8220;ffmpeg&#8221; library (www.ffmpeg.org) can play.</p>
  70 </div>
  71 <div class="section" id="filters">
  72 <h2>1.2. Filters<a class="headerlink" href="#filters" title="Permalink to this headline">¶</a></h2>
  73 <p>The ffmpeg producer supports &#8220;libavfilter&#8221; filters through the &#8220;FILTER&#8221; parameter.</p>
  74 </div>
  75 <div class="section" id="diagnostics">
  76 <h2>1.3. Diagnostics<a class="headerlink" href="#diagnostics" title="Permalink to this headline">¶</a></h2>
  77 <p>ffmpeg[<em>filename</em> | <em>video-mode</em> | <em>file-frame-number</em> / <em>file-nb-frames</em>]</p>
  78 <table border="1" class="docutils">
  79 <colgroup>
  80 <col width="21%" />
  81 <col width="67%" />
  82 <col width="11%" />
  83 </colgroup>
  84 <thead valign="bottom">
  85 <tr class="row-odd"><th class="head">Graph</th>
  86 <th class="head">Description</th>
  87 <th class="head">Scale</th>
  88 </tr>
  89 </thead>
  90 <tbody valign="top">
  91 <tr class="row-even"><td>frame-time</td>
  92 <td>Time spent decoding the current frame.</td>
  93 <td>fps/2</td>
  94 </tr>
  95 <tr class="row-odd"><td>buffer-count</td>
  96 <td>Number of input packets buffered.</td>
  97 <td>100</td>
  98 </tr>
  99 <tr class="row-even"><td>buffer-size</td>
 100 <td>Size of buffered input packets.</td>
 101 <td>64MB</td>
 102 </tr>
 103 <tr class="row-odd"><td>underflow</td>
 104 <td>Frame was not ready in time and is skipped.</td>
 105 <td>N/A</td>
 106 </tr>
 107 <tr class="row-even"><td>seek</td>
 108 <td>Input has seeked.</td>
 109 <td>N/A</td>
 110 </tr>
 111 </tbody>
 112 </table>
 113 </div>
 114 <div class="section" id="parameters">
 115 <h2>1.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
 116 <div class="section" id="loop">
 117 <h3>1.4.1. LOOP<a class="headerlink" href="#loop" title="Permalink to this headline">¶</a></h3>
 118 <p>Sets whether file will loop.</p>
 119 <p>Syntax:</p>
 120 <div class="highlight-python"><div class="highlight"><pre><span class="p">{</span><span class="n">LOOP</span><span class="p">}</span>
 121 </pre></div>
 122 </div>
 123 <p>Example:</p>
 124 <div class="highlight-python"><pre>&lt;&lt; PLAY 1-1 MOVIE LOOP</pre>
 125 </div>
 126 </div>
 127 <div class="section" id="seek">
 128 <h3>1.4.2. SEEK<a class="headerlink" href="#seek" title="Permalink to this headline">¶</a></h3>
 129 <p>Sets the start of the file. This point will be used while looping.</p>
 130 <p>Syntax:</p>
 131 <div class="highlight-python"><div class="highlight"><pre><span class="n">SEEK</span> <span class="p">[</span><span class="n">frames</span><span class="p">:</span><span class="nb">int</span><span class="p">]</span>
 132 </pre></div>
 133 </div>
 134 <p>Example:</p>
 135 <div class="highlight-python"><pre>&lt;&lt; PLAY 1-1 MOVIE SEEK 100 LOOP</pre>
 136 </div>
 137 </div>
 138 <div class="section" id="start-casparcg-2-1">
 139 <h3>1.4.3. START (CasparCG 2.1)<a class="headerlink" href="#start-casparcg-2-1" title="Permalink to this headline">¶</a></h3>
 140 <p>Sets the start of the file. This point will be used while looping.</p>
 141 <p>Syntax:</p>
 142 <div class="highlight-python"><div class="highlight"><pre><span class="n">START</span> <span class="p">[</span><span class="n">frames</span><span class="p">:</span><span class="nb">int</span><span class="p">]</span>
 143 </pre></div>
 144 </div>
 145 <p>Example:</p>
 146 <div class="highlight-python"><pre>&lt;&lt; PLAY 1-1 MOVIE START 100 LOOP</pre>
 147 </div>
 148 </div>
 149 <div class="section" id="length">
 150 <h3>1.4.4. LENGTH<a class="headerlink" href="#length" title="Permalink to this headline">¶</a></h3>
 151 <p>Sets the end of the file.</p>
 152 <p>Syntax:</p>
 153 <div class="highlight-python"><div class="highlight"><pre><span class="n">LENGTH</span> <span class="p">[</span><span class="n">frames</span><span class="p">:</span><span class="nb">int</span><span class="p">]</span>
 154 </pre></div>
 155 </div>
 156 <p>Example:</p>
 157 <div class="highlight-python"><pre>&lt;&lt; PLAY 1-1 MOVIE LENGTH 100</pre>
 158 </div>
 159 </div>
 160 <div class="section" id="filter">
 161 <h3>1.4.5. FILTER<a class="headerlink" href="#filter" title="Permalink to this headline">¶</a></h3>
 162 <p>Configures libavfilter which will be used.</p>
 163 <p>Syntax:</p>
 164 <div class="highlight-python"><div class="highlight"><pre><span class="n">FILTER</span> <span class="p">[</span><span class="n">libavfilter</span><span class="o">-</span><span class="n">parameters</span><span class="p">:</span><span class="n">string</span><span class="p">]</span>
 165 </pre></div>
 166 </div>
 167 <p>Example:</p>
 168 <div class="highlight-python"><pre>&lt;&lt; PLAY 1-1 MOVIE FILTER hflip:yadif=0:0</pre>
 169 </div>
 170 </div>
 171 </div>
 172 <div class="section" id="functions">
 173 <h2>1.5. Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
 174 <div class="section" id="id1">
 175 <h3>1.5.1. LOOP<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
 176 <p>Sets whether file will loop.</p>
 177 <p>Syntax:</p>
 178 <div class="highlight-python"><div class="highlight"><pre><span class="n">LOOP</span> <span class="p">[</span><span class="n">loop</span><span class="p">:</span><span class="mi">0</span><span class="o">|</span><span class="mi">1</span><span class="p">]</span>
 179 </pre></div>
 180 </div>
 181 <p>Returns</p>
 182 <blockquote>
 183 <div>The value of LOOP after the command have completed.</div></blockquote>
 184 <p>Example:</p>
 185 <div class="highlight-python"><pre>&lt;&lt; CALL 1-1 LOOP 1
 186 &lt;&lt; CALL 1-1 LOOP   // Queries without changing.
 187 &gt;&gt; 1</pre>
 188 </div>
 189 </div>
 190 <div class="section" id="id2">
 191 <h3>1.5.2. SEEK<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
 192 <p>Seeks in the file.</p>
 193 <p>Syntax:</p>
 194 <div class="highlight-python"><div class="highlight"><pre><span class="n">SEEK</span> <span class="p">[</span><span class="n">frames</span><span class="p">:</span><span class="nb">int</span><span class="p">]</span>
 195 </pre></div>
 196 </div>
 197 <p>Returns</p>
 198 <blockquote>
 199 <div>Nothing.</div></blockquote>
 200 <p>Example:</p>
 201 <div class="highlight-python"><pre>&lt;&lt; CALL 1-1 SEEK 200</pre>
 202 </div>
 203 </div>
 204 <div class="section" id="id3">
 205 <h3>1.5.3. START (CasparCG 2.1)<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
 206 <p>Sets the start of the file. This point will be used while looping.</p>
 207 <p>Syntax:</p>
 208 <div class="highlight-python"><div class="highlight"><pre><span class="n">START</span> <span class="p">[</span><span class="n">frames</span><span class="p">:</span><span class="nb">int</span><span class="p">]</span>
 209 </pre></div>
 210 </div>
 211 <p>Example:</p>
 212 <div class="highlight-python"><pre>&lt;&lt; CALL 1-1 START 100</pre>
 213 </div>
 214 </div>
 215 <div class="section" id="length-casparcg-2-1">
 216 <h3>1.5.4. LENGTH (CasparCG 2.1)<a class="headerlink" href="#length-casparcg-2-1" title="Permalink to this headline">¶</a></h3>
 217 <p>Sets the end of the file.</p>
 218 <p>Syntax:</p>
 219 <div class="highlight-python"><div class="highlight"><pre><span class="n">LENGTH</span> <span class="p">[</span><span class="n">frames</span><span class="p">:</span><span class="nb">int</span><span class="p">]</span>
 220 </pre></div>
 221 </div>
 222 <p>Example:</p>
 223 <div class="highlight-python"><pre>&lt;&lt; CALL 1-1 LENGTH 100P</pre>
 224 </div>
 225 </div>
 226 </div>
 227 </div>
 228
 229
 230           </div>
 231         </div>
 232       </div>
 233       <div class="sphinxsidebar">
 234         <div class="sphinxsidebarwrapper">
 235   <h3><a href="../contents.html">Table Of Contents</a></h3>
 236   <ul>
 237 <li><a class="reference internal" href="#">1. FFMPEG Producer</a><ul>
 238 <li><a class="reference internal" href="#supported-media">1.1. Supported Media</a></li>
 239 <li><a class="reference internal" href="#filters">1.2. Filters</a></li>
 240 <li><a class="reference internal" href="#diagnostics">1.3. Diagnostics</a></li>
 241 <li><a class="reference internal" href="#parameters">1.4. Parameters</a><ul>
 242 <li><a class="reference internal" href="#loop">1.4.1. LOOP</a></li>
 243 <li><a class="reference internal" href="#seek">1.4.2. SEEK</a></li>
 244 <li><a class="reference internal" href="#start-casparcg-2-1">1.4.3. START (CasparCG 2.1)</a></li>
 245 <li><a class="reference internal" href="#length">1.4.4. LENGTH</a></li>
 246 <li><a class="reference internal" href="#filter">1.4.5. FILTER</a></li>
 247 </ul>
 248 </li>
 249 <li><a class="reference internal" href="#functions">1.5. Functions</a><ul>
 250 <li><a class="reference internal" href="#id1">1.5.1. LOOP</a></li>
 251 <li><a class="reference internal" href="#id2">1.5.2. SEEK</a></li>
 252 <li><a class="reference internal" href="#id3">1.5.3. START (CasparCG 2.1)</a></li>
 253 <li><a class="reference internal" href="#length-casparcg-2-1">1.5.4. LENGTH (CasparCG 2.1)</a></li>
 254 </ul>
 255 </li>
 256 </ul>
 257 </li>
 258 </ul>
 259
 260   <h4>Previous topic</h4>
 261   <p class="topless"><a href="index.html"
 262                         title="previous chapter">Producers</a></p>
 263   <h4>Next topic</h4>
 264   <p class="topless"><a href="flash.html"
 265                         title="next chapter">2. Flash Producer</a></p>
 266 <h3>This Page</h3>
 267 <ul class="this-page-menu">
 268   <li><a href="../bugs.html">Report a Bug</a></li>
 269   <li><a href="../_sources/producers/ffmpeg.txt"
 270          rel="nofollow">Show Source</a></li>
 271 </ul>
 272
 273 <div id="searchbox" style="display: none">
 274   <h3>Quick search</h3>
 275     <form class="search" action="../search.html" method="get">
 276       <input type="text" name="q" />
 277       <input type="submit" value="Go" />
 278       <input type="hidden" name="check_keywords" value="yes" />
 279       <input type="hidden" name="area" value="default" />
 280     </form>
 281     <p class="searchtip" style="font-size: 90%">
 282     Enter search terms or a module, class or function name.
 283     </p>
 284 </div>
 285 <script type="text/javascript">$('#searchbox').show(0);</script>
 286         </div>
 287       </div>
 288       <div class="clearer"></div>
 289     </div>
 290     <div class="related">
 291       <h3>Navigation</h3>
 292       <ul>
 293         <li class="right" style="margin-right: 10px">
 294           <a href="../genindex.html" title="General Index"
 295              >index</a></li>
 296         <li class="right" >
 297           <a href="flash.html" title="2. Flash Producer"
 298              >next</a> |</li>
 299         <li class="right" >
 300           <a href="index.html" title="Producers"
 301              >previous</a> |</li>
 302         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 303
 304           <li><a href="index.html" >Producers</a> &raquo;</li>
 305       </ul>
 306     </div>
 307     <div class="footer">
 308     &copy; <a href="../copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
 309     <br />
 310     <a href="http://www.python.org/psf/donations/">Please donate.</a>
 311     <br />
 312     Last updated on Mar 13, 2012.
 313     <a href="../bugs.html">Found a bug</a>?
 314     <br />
 315     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 316     </div>
 317
 318   </body>
 319 </html>