Hint: In case of any errors (such as option not recognized) during installation, please see the known issues and limitations.
The subsequent sections of this page outline the GIFT-Grab features.
All features are disabled by default.
Desired GIFT-Grab features must be enabled WHEN CALLING pip install gift-grab.
Enabling a feature requires appending one or more pip --install-options to pip install gift-grab.
For instance to install GIFT-Grab with support for reading video files and video encoding with HEVC:
pip install gift-grab --install-option="--files" --install-option="--hevc"
As this route installs the GIFT-Grab Python API, it requires Python and Boost.Python, in addition to the dependencies of the desired GIFT-Grab features.
The dependencies for each feature are listed alongside the required pip install option(s) below.
Please also note that due to incompatibilities in the relevant dependencies' licences, options requiring proprietary libraries are mutually exclusive with options requiring GPL libraries. These are marked with "makes GIFT-Grab undistributable" and "upgrades GIFT-Grab licence to GPL" respectively below. If mutually exclusive options are activated, installation will fail.
Please also note that GIFT-Grab has been tested only against specific versions of its dependencies.
--install-option="--files" (requires FFmpeg)
You can enable one or more of the codecs listed below for encoding video files.
--install-option="--xvid" (requires OpenCV)
--install-option="--hevc" (requires FFmpeg, pkg-config and kvazaar)
In addition, also the following two BSD-3-incompatible options are available:
--install-option="--hevc" --install-option="--enable-gpl" --install-option="--x265": use x265 instead of kvazaar (requires FFmpeg, pkg-config and x265), upgrades GIFT-Grab licence to GPL--install-option="--hevc" --install-option="--enable-nonfree" --install-option="--nvenc": hardware-accelerated HEVC (requires a supported GPU, FFmpeg, pkg-config and NVENC), makes GIFT-Grab undistributable
--install-option="--vp9" (requires FFmpeg, pkg-config and libvpx)
--install-option="--epiphan-dvi2pcie-duo" (requires OpenCV and libVLC)
OpenCV and libVLC are needed for capturing in the BGRA and I420 colour spaces respectively.
Both options are active by default.
Append --install-option="--no-bgra" or --install-option="--no-i420" to deactivate the respective option.
Also Epiphan Video Grabber SDK can be used instead of libVLC:
--install-option="--epiphan-dvi2pcie-duo" --install-option="--enable-nonfree" --install-option="--epiphansdk" (requires zlib, pthreads and Epiphan Video Grabber SDK).
This option makes GIFT-Grab undistributable.
--install-option="--blackmagic-decklink-sdi-4k" --install-option="--enable-nonfree" (requires Blackmagic Desktop Video SDK)
This currently works only with the UYVY and BGRA colour spaces (both active by default). This option makes GIFT-Grab undistributable.
--install-option="--blackmagic-decklink-4k-extreme-12g" --install-option="--enable-nonfree" (requires Blackmagic Desktop Video SDK)
This currently works only with the UYVY and BGRA colour spaces (both active by default). This option makes GIFT-Grab undistributable.
--install-option="--network-sources" (requires OpenCV and libVLC)
OpenCV and libVLC are needed for capturing in the BGRA and I420 colour spaces respectively.
Both options are active by default.
Append --install-option="--no-bgra" or --install-option="--no-i420" to deactivate the respective option.
--install-option="--numpy" (requires Python and Boost.Python 1.63 or newer)