Skip to content

install.rst

Latest commit

 

History

History
72 lines (50 loc) · 2.92 KB

install.rst

File metadata and controls

72 lines (50 loc) · 2.92 KB

Installation

To use :py:mod:`ffmpegio`, the package must be installed on Python as well as having the FFmpeg binary files at a location :py:mod:`ffmpegio` can find.

Install the :py:mod:`ffmpegio` package via pip. There are two options: ffmpegio and ffmpegio-core.

pip install ffmpegio

This option installs the ffmpegio and ffmpegio_plugin_numpy packages so that the media data I/O are performed with numpy.ndarray objects. Naturally, ffmpegio_plugin_numpy requires numpy dependency. For use cases in which media data I/O is not needed, it unnecessarily bloats the site-package install. In such case, use the core-only install:

pip install ffmpegio-core

This option only installs the ffmpegio package without numpy dependency. While media I/O functions (e.g., open(), video.read(), and audio.write()) are still available, the data are represented binary a dict object containing bytes data.

Install FFmpeg program

The installation of FFmpeg is platform dependent. For Ubuntu/Debian Linux,

sudo apt install ffmpeg

and for MacOS,

brew install ffmpeg

no other actions are needed as these commands will place the FFmpeg executables on the system path.

For Windows, it is a bit more complicated.

  1. Download pre-built packages from the links available on the FFmpeg's Download page.

  2. Unzip the content and place the files in one of the following directories:

    Auto-detectable FFmpeg folder path

    Example

    %PROGRAMFILES%\ffmpeg

    C:\Program Files\ffmpeg

    %PROGRAMFILES(X86)%\ffmpeg

    C:\Program Files (x86)\ffmpeg

    %USERPROFILE%\ffmpeg

    C:\Users\john\ffmpeg

    %APPDATA%\ffmpeg

    C:\Users\john\AppData\Roaming\ffmpeg

    %APPDATA%\programs\ffmpeg

    C:\Users\john\AppData\Roaming\programs\ffmpeg

    %LOCALAPPDATA%\ffmpeg

    C:\Users\john\AppData\Local\ffmpeg

    %LOCALAPPDATA%\programs\ffmpeg

    C:\Users\john\AppData\Local\programs\ffmpeg

    Keep the internal structure intact, i.e., the executables must be found at ffmpeg\bin\ffmpeg.exe and ffmpeg\bin\ffprobe.exe.

    There are two other alternative. First, the FFmpeg binaries could be placed on the Python's current working directory (i.e., os.getcwd()). Second, they could be placed in an arbitrary location and use :py:func:`ffmpegio.set_path` to specify the location. The latter feature is especially useful when ffmpegio is bundled in a package (e.g., PyInstaller).