8000 Add FFmpeg installation instructions (#642) · iDNA420/ffmpeg-python@cb9d400 · GitHub
[go: up one dir, main page]

Skip to content

Commit cb9d400

Browse files
kkroeningzibdiedigitalcircuits
authored
Add FFmpeg installation instructions (kkroening#642)
Co-authored-by: digitalcircuits <59550818+digitalcircuits@users.noreply.github.com> Co-authored-by: digitalcircuits <digitalcircuits@github>
1 parent 29b6f09 commit cb9d400

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,11 @@ Real-world signal graphs can get a heck of a lot more complex, but `ffmpeg-pytho
8181

8282
## Installation
8383

84+
### Installing `ffmpeg-python`
85+
8486
The latest version of `ffmpeg-python` can be acquired via a typical pip install:
8587

86-
```
88+
```bash
8789
pip install ffmpeg-python
8890
```
8991

@@ -93,6 +95,24 @@ git clone git@github.com:kkroening/ffmpeg-python.git
9395
pip install -e ./ffmpeg-python
9496
```
9597

98+
> **Note**: `ffmpeg-python` makes no attempt to download/install FFmpeg, as `ffmpeg-python` is merely a pure-Python wrapper - whereas FFmpeg installation is platform-dependent/environment-specific, and is thus the responsibility of the user, as described below.
99+
100+
### Installing FFmpeg
101+
102+
Before using `ffmpeg-python`, FFmpeg must be installed and accessible via the `$PATH` environment variable.
103+
104+
There are a variety of ways to install FFmpeg, such as the [official download links](https://ffmpeg.org/download.html), or using your package manager of choice (e.g. `sudo apt install ffmpeg` on Debian/Ubuntu, `brew install ffmpeg` on OS X, etc.).
105+
106+
Regardless of how FFmpeg is installed, you can check if your environment path is set correctly by running the `ffmpeg` command from the terminal, in which case the version information should appear, as in the following example (truncated for brevity):
107+
108+
```
109+
$ ffmpeg
110+
ffmpeg version 4.2.4-1ubuntu0.1 Copyright (c) 2000-2020 the FFmpeg developers
111+
built with gcc 9 (Ubuntu 9.3.0-10ubuntu2)
112+
```
113+
114+
> **Note**: The actual version information displayed here may vary from one system to another; but if a message such as `ffmpeg: command not found` appears instead of the version information, FFmpeg is not properly installed.
115+
96116
## [Examples](https://github.com/kkroening/ffmpeg-python/tree/master/examples)
97117

98118
When in doubt, take a look at the [examples](https://github.com/kkroening/ffmpeg-python/tree/master/examples) to see if there's something that's close to whatever you're trying to do.
@@ -197,7 +217,7 @@ When in doubt, refer to the [existing filters](https://github.com/kkroening/ffmp
197217

198218
**Why do I get an import/attribute/etc. error from `import ffmpeg`?**
199219

200-
Make sure you ran `pip install ffmpeg-python` and not `pip install ffmpeg` or `pip install python-ffmpeg`.
220+
Make sure you ran `pip install ffmpeg-python` and _**not**_ `pip install ffmpeg` (wrong) or `pip install python-ffmpeg` (also wrong).
201221

202222
**Why did my audio stream get dropped?**
203223

0 commit comments

Comments
 (0)
0