Commit 696e52a
committed
kkroening#1: split operators into modules
1 parent efbfd9f commit 696e52a
11 files changed
Lines changed: 346 additions & 326 deletions
File tree
- doc/html
- _sources
- ffmpeg
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,9 +1,4 @@ | |||
| 1 | - .. ffmpeg-python documentation master file, created by | ||
| 2 | - sphinx-quickstart on Sat May 27 14:30:53 2017. | ||
| 3 | - You can adapt this file completely to your liking, but it should at least | ||
| 4 | - contain the root `toctree` directive. | ||
| 5 | - | ||
| 6 | - Welcome to ffmpeg-python's documentation! | ||
| 1 | + ffmpeg-python: Python bindings for FFmpeg | ||
| 7 | 2 | ========================================= | |
| 8 | 3 | ||
| 9 | 4 | .. toctree:: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -84,14 +84,12 @@ <h2 id="F">F</h2> | |||
| 84 | 84 | <table style="width: 100%" class="indextable genindextable"><tr> | |
| 85 | 85 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 86 | 86 | <li><a href="index.html#module-ffmpeg">ffmpeg (module)</a> | |
| 87 | - </li> | ||
| 88 | - <li><a href="index.html#ffmpeg.file_input">file_input() (in module ffmpeg)</a> | ||
| 89 | 87 | </li> | |
| 90 | 88 | </ul></td> | |
| 91 | 89 | <td style="width: 33%; vertical-align: top;"><ul> | |
| 92 | - <li><a href="index.html#ffmpeg.file_output">file_output() (in module ffmpeg)</a> | ||
| 90 | + <li><a href="index.html#ffmpeg.file_input">file_input() (in module ffmpeg)</a> | ||
| 93 | 91 | </li> | |
| 94 | - <li><a href="index.html#ffmpeg.fluent">fluent() (in module ffmpeg)</a> | ||
| 92 | + <li><a href="index.html#ffmpeg.file_output">file_output() (in module ffmpeg)</a> | ||
| 95 | 93 | </li> | |
| 96 | 94 | </ul></td> | |
| 97 | 95 | </tr></table> | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,7 +6,7 @@ | |||
| 6 | 6 | <head> | |
| 7 | 7 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| 8 | 8 | ||
| 9 | - <title>Welcome to ffmpeg-python’s documentation! — ffmpeg-python documentation</title> | ||
| 9 | + <title>ffmpeg-python: Python bindings for FFmpeg — ffmpeg-python documentation</title> | ||
| 10 | 10 | ||
| 11 | 11 | <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> | |
| 12 | 12 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | |
@@ -41,125 +41,91 @@ | |||
| 41 | 41 | <div class="bodywrapper"> | |
| 42 | 42 | <div class="body" role="main"> | |
| 43 | 43 | ||
| 44 | - <div class="section" id="welcome-to-ffmpeg-python-s-documentation"> | ||
| 45 | - <h1>Welcome to ffmpeg-python’s documentation!<a class="headerlink" href="#welcome-to-ffmpeg-python-s-documentation" title="Permalink to this headline">¶</a></h1> | ||
| 44 | + <div class="section" id="ffmpeg-python-python-bindings-for-ffmpeg"> | ||
| 45 | + <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg-python-python-bindings-for-ffmpeg" title="Permalink to this headline">¶</a></h1> | ||
| 46 | 46 | <div class="toctree-wrapper compound"> | |
| 47 | 47 | </div> | |
| 48 | - <span class="target" id="module-ffmpeg"></span><p>ffmpeg-python: Python bindings for FFmpeg</p> | ||
| 49 | - <dl class="function"> | ||
| 48 | + <span class="target" id="module-ffmpeg"></span><dl class="function"> | ||
| 50 | 49 | <dt id="ffmpeg.colorchannelmixer"> | |
| 51 | 50 | <code class="descclassname">ffmpeg.</code><code class="descname">colorchannelmixer</code><span class="sig-paren">(</span><em>parent</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.colorchannelmixer" title="Permalink to this definition">¶</a></dt> | |
| 52 | - <dd><p>FIXME</p> | ||
| 51 | + <dd><p>Adjust video input frames by re-mixing color channels.</p> | ||
| 52 | + <p><a class="reference external" href="https://ffmpeg.org/ffmpeg-filters.html#toc-colorchannelmixer">FFmpeg colorchannelmixer filter</a></p> | ||
| 53 | 53 | </dd></dl> | |
| 54 | 54 | ||
| 55 | 55 | <dl class="function"> | |
| 56 | 56 | <dt id="ffmpeg.concat"> | |
| 57 | 57 | <code class="descclassname">ffmpeg.</code><code class="descname">concat</code><span class="sig-paren">(</span><em>*parents</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.concat" title="Permalink to this definition">¶</a></dt> | |
| 58 | - <dd><p>FIXME</p> | ||
| 59 | - </dd></dl> | ||
| 58 | + <dd></dd></dl> | ||
| 60 | 59 | ||
| 61 | 60 | <dl class="function"> | |
| 62 | 61 | <dt id="ffmpeg.drawbox"> | |
| 63 | 62 | <code class="descclassname">ffmpeg.</code><code class="descname">drawbox</code><span class="sig-paren">(</span><em>parent</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>color</em>, <em>thickness=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.drawbox" title="Permalink to this definition">¶</a></dt> | |
| 64 | - <dd><p>FIXME</p> | ||
| 65 | - </dd></dl> | ||
| 66 | - | ||
| 67 | - <dl class="function"> | ||
| 68 | - <dt id="ffmpeg.file_input"> | ||
| 69 | - <code class="descclassname">ffmpeg.</code><code class="descname">file_input</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.file_input" title="Permalink to this definition">¶</a></dt> | ||
| 70 | - <dd><p>Input from a file.</p> | ||
| 71 | - <p>Corresponds to ffmpeg <cite>-i</cite> option.</p> | ||
| 72 | - <dl class="docutils"> | ||
| 73 | - <dt>Args:</dt> | ||
| 74 | - <dd>filename: Input filename</dd> | ||
| 75 | - </dl> | ||
| 76 | - </dd></dl> | ||
| 77 | - | ||
| 78 | - <dl class="function"> | ||
| 79 | - <dt id="ffmpeg.file_output"> | ||
| 80 | - <code class="descclassname">ffmpeg.</code><code class="descname">file_output</code><span class="sig-paren">(</span><em>parent</em>, <em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.file_output" title="Permalink to this definition">¶</a></dt> | ||
| 81 | - <dd><p>FIXME</p> | ||
| 82 | - </dd></dl> | ||
| 83 | - | ||
| 84 | - <dl class="function"> | ||
| 85 | - <dt id="ffmpeg.fluent"> | ||
| 86 | - <code class="descclassname">ffmpeg.</code><code class="descname">fluent</code><span class="sig-paren">(</span><em>node_classes=set([<class ‘ffmpeg.nodes.Node’>])</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.fluent" title="Permalink to this definition">¶</a></dt> | ||
| 87 | - <dd><p>Decorator to make function show up as an instance method on specified node classes.</p> | ||
| 88 | - <table class="docutils field-list" frame="void" rules="none"> | ||
| 89 | - <col class="field-name" /> | ||
| 90 | - <col class="field-body" /> | ||
| 91 | - <tbody valign="top"> | ||
| 92 | - <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_classes</strong> – list of node classes</td> | ||
| 93 | - </tr> | ||
| 94 | - </tbody> | ||
| 95 | - </table> | ||
| 96 | - </dd></dl> | ||
| 97 | - | ||
| 98 | - <dl class="function"> | ||
| 99 | - <dt id="ffmpeg.get_args"> | ||
| 100 | - <code class="descclassname">ffmpeg.</code><code class="descname">get_args</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.get_args" title="Permalink to this definition">¶</a></dt> | ||
| 101 | - <dd><p>FIXME</p> | ||
| 102 | - </dd></dl> | ||
| 63 | + <dd></dd></dl> | ||
| 103 | 64 | ||
| 104 | 65 | <dl class="function"> | |
| 105 | 66 | <dt id="ffmpeg.hflip"> | |
| 106 | 67 | <code class="descclassname">ffmpeg.</code><code class="descname">hflip</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.hflip" title="Permalink to this definition">¶</a></dt> | |
| 107 | - <dd><p>FIXME</p> | ||
| 108 | - </dd></dl> | ||
| 68 | + <dd></dd></dl> | ||
| 109 | 69 | ||
| 110 | 70 | <dl class="function"> | |
| 111 | 71 | <dt id="ffmpeg.hue"> | |
| 112 | 72 | <code class="descclassname">ffmpeg.</code><code class="descname">hue</code><span class="sig-paren">(</span><em>parent</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.hue" title="Permalink to this definition">¶</a></dt> | |
| 113 | - <dd><p>FIXME</p> | ||
| 114 | - </dd></dl> | ||
| 115 | - | ||
| 116 | - <dl class="function"> | ||
| 117 | - <dt id="ffmpeg.merge_outputs"> | ||
| 118 | - <code class="descclassname">ffmpeg.</code><code class="descname">merge_outputs</code><span class="sig-paren">(</span><em>*parents</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.merge_outputs" title="Permalink to this definition">¶</a></dt> | ||
| 119 | - <dd><p>FIXME</p> | ||
| 120 | - </dd></dl> | ||
| 73 | + <dd></dd></dl> | ||
| 121 | 74 | ||
| 122 | 75 | <dl class="function"> | |
| 123 | 76 | <dt id="ffmpeg.overlay"> | |
| 124 | 77 | <code class="descclassname">ffmpeg.</code><code class="descname">overlay</code><span class="sig-paren">(</span><em>main_parent</em>, <em>overlay_parent</em>, <em>eof_action=’repeat’</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.overlay" title="Permalink to this definition">¶</a></dt> | |
| 125 | - <dd><p>FIXME</p> | ||
| 126 | - </dd></dl> | ||
| 127 | - | ||
| 128 | - <dl class="function"> | ||
| 129 | - <dt id="ffmpeg.overwrite_output"> | ||
| 130 | - <code class="descclassname">ffmpeg.</code><code class="descname">overwrite_output</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.overwrite_output" title="Permalink to this definition">¶</a></dt> | ||
| 131 | - <dd><p>FIXME</p> | ||
| 132 | - </dd></dl> | ||
| 133 | - | ||
| 134 | - <dl class="function"> | ||
| 135 | - <dt id="ffmpeg.run"> | ||
| 136 | - <code class="descclassname">ffmpeg.</code><code class="descname">run</code><span class="sig-paren">(</span><em>parent</em>, <em>cmd=’ffmpeg’</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.run" title="Permalink to this definition">¶</a></dt> | ||
| 137 | - <dd><p>FIXME</p> | ||
| 138 | - </dd></dl> | ||
| 78 | + <dd></dd></dl> | ||
| 139 | 79 | ||
| 140 | 80 | <dl class="function"> | |
| 141 | 81 | <dt id="ffmpeg.setpts"> | |
| 142 | 82 | <code class="descclassname">ffmpeg.</code><code class="descname">setpts</code><span class="sig-paren">(</span><em>parent</em>, <em>expr</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.setpts" title="Permalink to this definition">¶</a></dt> | |
| 143 | - <dd><p>FIXME</p> | ||
| 144 | - </dd></dl> | ||
| 83 | + <dd></dd></dl> | ||
| 145 | 84 | ||
| 146 | 85 | <dl class="function"> | |
| 147 | 86 | <dt id="ffmpeg.trim"> | |
| 148 | 87 | <code class="descclassname">ffmpeg.</code><code class="descname">trim</code><span class="sig-paren">(</span><em>parent</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.trim" title="Permalink to this definition">¶</a></dt> | |
| 149 | - <dd><p>FIXME</p> | ||
| 150 | - </dd></dl> | ||
| 88 | + <dd></dd></dl> | ||
| 151 | 89 | ||
| 152 | 90 | <dl class="function"> | |
| 153 | 91 | <dt id="ffmpeg.vflip"> | |
| 154 | 92 | <code class="descclassname">ffmpeg.</code><code class="descname">vflip</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.vflip" title="Permalink to this definition">¶</a></dt> | |
| 155 | - <dd><p>FIXME</p> | ||
| 156 | - </dd></dl> | ||
| 93 | + <dd></dd></dl> | ||
| 157 | 94 | ||
| 158 | 95 | <dl class="function"> | |
| 159 | 96 | <dt id="ffmpeg.zoompan"> | |
| 160 | 97 | <code class="descclassname">ffmpeg.</code><code class="descname">zoompan</code><span class="sig-paren">(</span><em>parent</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.zoompan" title="Permalink to this definition">¶</a></dt> | |
| 161 | - <dd><p>FIXME</p> | ||
| 162 | - </dd></dl> | ||
| 98 | + <dd></dd></dl> | ||
| 99 | + | ||
| 100 | + <dl class="function"> | ||
| 101 | + <dt id="ffmpeg.file_input"> | ||
| 102 | + <code class="descclassname">ffmpeg.</code><code class="descname">file_input</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.file_input" title="Permalink to this definition">¶</a></dt> | ||
| 103 | + <dd></dd></dl> | ||
| 104 | + | ||
| 105 | + <dl class="function"> | ||
| 106 | + <dt id="ffmpeg.file_output"> | ||
| 107 | + <code class="descclassname">ffmpeg.</code><code class="descname">file_output</code><span class="sig-paren">(</span><em>parent</em>, <em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.file_output" title="Permalink to this definition">¶</a></dt> | ||
| 108 | + <dd></dd></dl> | ||
| 109 | + | ||
| 110 | + <dl class="function"> | ||
| 111 | + <dt id="ffmpeg.merge_outputs"> | ||
| 112 | + <code class="descclassname">ffmpeg.</code><code class="descname">merge_outputs</code><span class="sig-paren">(</span><em>*parents</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.merge_outputs" title="Permalink to this definition">¶</a></dt> | ||
| 113 | + <dd></dd></dl> | ||
| 114 | + | ||
| 115 | + <dl class="function"> | ||
| 116 | + <dt id="ffmpeg.overwrite_output"> | ||
| 117 | + <code class="descclassname">ffmpeg.</code><code class="descname">overwrite_output</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.overwrite_output" title="Permalink to this definition">¶</a></dt> | ||
| 118 | + <dd></dd></dl> | ||
| 119 | + | ||
| 120 | + <dl class="function"> | ||
| 121 | + <dt id="ffmpeg.get_args"> | ||
| 122 | + <code class="descclassname">ffmpeg.</code><code class="descname">get_args</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.get_args" title="Permalink to this definition">¶</a></dt> | ||
| 123 | + <dd></dd></dl> | ||
| 124 | + | ||
| 125 | + <dl class="function"> | ||
| 126 | + <dt id="ffmpeg.run"> | ||
| 127 | + <code class="descclassname">ffmpeg.</code><code class="descname">run</code><span class="sig-paren">(</span><em>parent</em>, <em>cmd=’ffmpeg’</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.run" title="Permalink to this definition">¶</a></dt> | ||
| 128 | + <dd></dd></dl> | ||
| 163 | 129 | ||
| 164 | 130 | </div> | |
| 165 | 131 | <div class="section" id="indices-and-tables"> | |
@@ -179,7 +145,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe | |||
| 179 | 145 | <div class="sphinxsidebarwrapper"> | |
| 180 | 146 | <h3><a href="#">Table Of Contents</a></h3> | |
| 181 | 147 | <ul> | |
| 182 | - <li><a class="reference internal" href="#">Welcome to ffmpeg-python’s documentation!</a></li> | ||
| 148 | + <li><a class="reference internal" href="#">ffmpeg-python: Python bindings for FFmpeg</a></li> | ||
| 183 | 149 | <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> | |
| 184 | 150 | </ul> | |
| 185 | 151 | <div class="relations"> | |
Binary file not shown.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments