-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathinstall.html
More file actions
184 lines (164 loc) · 9.45 KB
/
install.html
File metadata and controls
184 lines (164 loc) · 9.45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation — python-ffmpegio 0.11.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=048f17f8" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=f3b36f1a"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
python-ffmpegio
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#install-ffmpeg-program">Install FFmpeg program</a><ul>
<li><a class="reference internal" href="#code-ffmpeg-downloader">::code::<cite>ffmpeg-downloader</cite></a></li>
<li><a class="reference internal" href="#code-static-ffmpeg">::code::<cite>static-ffmpeg</cite></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">python-ffmpegio</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/install.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="installation">
<span id="install"></span><h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
<p>To use <code class="xref py py-mod docutils literal notranslate"><span class="pre">ffmpegio</span></code>, the package must be installed on Python as well as
having the FFmpeg binary files at a location <code class="xref py py-mod docutils literal notranslate"><span class="pre">ffmpegio</span></code> can find. In addition,
optional external packages can be installed to enable the <code class="code docutils literal notranslate"><span class="pre">ffmpegio</span></code> features that interact
with them.</p>
<p>Install the <code class="xref py py-mod docutils literal notranslate"><span class="pre">ffmpegio</span></code> package via <code class="code docutils literal notranslate"><span class="pre">pip</span></code>.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>ffmpegio
</pre></div>
</div>
<section id="install-ffmpeg-program">
<h2>Install FFmpeg program<a class="headerlink" href="#install-ffmpeg-program" title="Link to this heading"></a></h2>
<p>There are two platform independent approaches to install FFmpeg for the use in Python:</p>
<section id="code-ffmpeg-downloader">
<h3>::code::<cite>ffmpeg-downloader</cite><a class="headerlink" href="#code-ffmpeg-downloader" title="Link to this heading"></a></h3>
</section>
<section id="code-static-ffmpeg">
<h3>::code::<cite>static-ffmpeg</cite><a class="headerlink" href="#code-static-ffmpeg" title="Link to this heading"></a></h3>
<p>The installation of FFmpeg is platform dependent. For Ubuntu/Debian Linux,</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>ffmpeg
</pre></div>
</div>
<p>and for MacOS,</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew<span class="w"> </span>install<span class="w"> </span>ffmpeg
</pre></div>
</div>
<p>no other actions are needed as these commands will place the FFmpeg executables
on the system path.</p>
<p>For Windows, it is a bit more complicated.</p>
<ol class="arabic">
<li><p>Download pre-built packages from the links available on the <a class="reference external" href="https://ffmpeg.org/download.html#build-windows">FFmpeg’s Download page</a>.</p></li>
<li><p>Unzip the content and place the files in one of the following directories:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Auto-detectable FFmpeg folder path</p></th>
<th class="head"><p>Example</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">%PROGRAMFILES%\ffmpeg</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">C:\Program</span> <span class="pre">Files\ffmpeg</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">%PROGRAMFILES(X86)%\ffmpeg</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">C:\Program</span> <span class="pre">Files</span> <span class="pre">(x86)\ffmpeg</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">%USERPROFILE%\ffmpeg</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">C:\Users\john\ffmpeg</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\ffmpeg</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">C:\Users\john\AppData\Roaming\ffmpeg</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\programs\ffmpeg</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">C:\Users\john\AppData\Roaming\programs\ffmpeg</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">%LOCALAPPDATA%\ffmpeg</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">C:\Users\john\AppData\Local\ffmpeg</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">%LOCALAPPDATA%\programs\ffmpeg</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">C:\Users\john\AppData\Local\programs\ffmpeg</span></code></p></td>
</tr>
</tbody>
</table>
<p>Keep the internal structure intact, i.e., the executables must be found at
<code class="docutils literal notranslate"><span class="pre">ffmpeg\bin\ffmpeg.exe</span></code> and <code class="docutils literal notranslate"><span class="pre">ffmpeg\bin\ffprobe.exe</span></code>.</p>
<p>There are two other alternative. First, the FFmpeg binaries could be placed on the
Python’s current working directory (i.e., <code class="code docutils literal notranslate"><span class="pre">os.getcwd()</span></code>). Second, they could
be placed in an arbitrary location and use <a class="reference internal" href="basicio.html#ffmpegio.set_path" title="ffmpegio.set_path"><code class="xref py py-func docutils literal notranslate"><span class="pre">ffmpegio.set_path()</span></code></a> to
specify the location. The latter feature is especially useful when <cite>ffmpegio</cite> is
bundled in a package (e.g., PyInstaller).</p>
</li>
</ol>
</section>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021-2022, Takeshi (Kesh) Ikuma, Louisiana State University Health Sciences Center.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>