Skip to content

Latest commit

 

History

History
176 lines (134 loc) · 10.3 KB

README.md

File metadata and controls

176 lines (134 loc) · 10.3 KB

homebrew-ffmpeg

GH Actions CI

This is a 3rd party tap for Homebrew. It provides a formula for ffmpeg which includes options for enabling additional features and libraries.

Contents:

Installation and usage

In order to use this tap, you need to install Homebrew.

Then, to run a default installation, run:

brew tap homebrew-ffmpeg/ffmpeg
brew install homebrew-ffmpeg/ffmpeg/ffmpeg

Note: If you already have ffmpeg installed from Homebrew core, you will receive an error. You need to first run brew uninstall ffmpeg before you can use this tap.

Installing with options

To see the list of supported options for this formula, run:

brew options homebrew-ffmpeg/ffmpeg/ffmpeg

Then, you can run:

brew install homebrew-ffmpeg/ffmpeg/ffmpeg --with-<option1> --with-<option2> ...

If you really wish to install all the available options, you can run:

brew install homebrew-ffmpeg/ffmpeg/ffmpeg $(brew options homebrew-ffmpeg/ffmpeg/ffmpeg --compact)

Note that this may install libraries for which you need extra SDKs installed, such as --with-decklink, or libraries which have to be installed before running the formula, such as --with-chromaprint.

Installing latest Git version (HEAD)

FFmpeg recommends installing the latest Git master version over a release. This formula builds the latest release by default, but you can install the latest Git version by adding the --HEAD option:

brew install homebrew-ffmpeg/ffmpeg/ffmpeg --HEAD

Please note that we don't generally provide support HEAD builds, since they may cause issues with other Homebrew-supplied formulae.

Updating

To update Homebrew and upgrade the formula to the most recent stable release:

brew update && brew upgrade homebrew-ffmpeg/ffmpeg/ffmpeg

Or, if you are using the HEAD version and want to update to the latest commit:

brew update && brew upgrade homebrew-ffmpeg/ffmpeg/ffmpeg --fetch-HEAD

Included libraries

This formula installs the following libraries by default:

Dependency Description
libaom AV1 encoder
fontconfig Font access library
freetype Freetype font engine
frei0r frei0r filters
lame LAME MP3 encoder
libass ASS subtitle support
libvorbis Vorbis encoder
libvpx VP8 and VP9 encoder
opus Opus encoder
rtmpdump RTMP dumping support
sdl2 Simple DirectMedia Layer
snappy Snappy compression support
theora Theora encoder
x264 x264 H.264 encoder
x265 x265 HEVC encoder
xz XZ compression support

This formula features the following libraries optionally:

Dependency Description Remarks
chromaprint Chromaprint audio fingerprinting library See the workaround in the Troubleshooting section.
decklink Enable DeckLink support The DeckLink SDK has to be installed before running the FFmpeg formula. One possibility is to use:
brew install amiaopensource/amiaos/decklinksdk

In addition, if you experience difficulties on macOS, make sure you follow these directions.
fdk-aac Fraunhofer FDK AAC library
game-music-emu Enable Game Music Emu (GME) support
harfbuzz Enable OpenType text shaping engine (libharfbuzz)
jack Jack audio device support
jpeg-xl JPEG XL support
libaribcaption Enable handling of ARIB STD-B24 based broadcast captions
libaribb24 Enable decoding ARIB/ISDB captions
libbluray libbluray support
libbs2b libbs2b support
libcaca libcaca support
libflite Enable text to speech synthesis support via Flite Flite has to be installed before running the FFmpeg formula.
libgsm libgsm support
libmodplug Enable module/tracker files as inputs via libmodplug
libopenmpt Enable module/tracker files as inputs via libopenmpt
librist RIST support
librsvg SVG files as inputs via librsvg
libsoxr soxr resample library
libssh SFTP protocol via libssh
libvidstab vid.stab support for video stabilization
libvmaf VMAF video quality metric
libxml2 libxml2 library
libzvbi Enable decoding of DVB teletext pages and DVB teletext subtitles The ZVBI library has to be installed before running the FFmpeg formula. It can be obtained from this tap via brew tap lescanauxdiscrets/tap && brew install lescanauxdiscrets/tap/zvbi.
opencore-amr Opencore AMR NR/WB audio format
openh264 OpenH264 library
openjpeg JPEG 2000 image format
openssl SSL support
openvino OpenVINO support
rav1e AV1 encoding via librav1e
svt-av1 Scalable Video Technology for AV1 (encoder and decoder)
rtmpdump rtmpdump support
rubberband rubberband library
speex speex support
srt SRT library
tesseract tesseract OCR engine
two-lame two-lame support
webp libwebp to encode WEBP images
xvid xvid support
zeromq libzeromq to receive commands sent through a libzeromq client
zimg z.lib zimg library

Troubleshooting

In general, please note that we only provide support for current macOS versions that still receive security updates. Beta or pre-release versions as well as legacy versions are not supported.

When installing a piece of SOFTWARE which is using this FFmpeg distribution, then you may get the following error:

==> Installing dependencies for SOFTWARE: ffmpeg
Error: ffmpeg is already installed from homebrew-ffmpeg/ffmpeg!
Please `brew uninstall ffmpeg` first."

Here is a workaround:

brew uninstall ffmpeg
brew install SOFTWARE
brew uninstall --ignore-dependencies ffmpeg
brew install homebrew-ffmpeg/ffmpeg/ffmpeg --with-YOUR-OPTIONS

Issues

To report issues, please file an issue on GitHub. Please include the full command line you have tested and the full terminal output you got with. Please note that we will only be able to help with issues that are exclusive to this tap and for OS which are officially supported.

If the problem is reproducible with the homebrew-core version of ffmpeg, please file it on their tracker.

Maintainers

  • Reto Kromer (@retokromer)
  • Werner Robitza (@slhck)