{"size": 2797, "ext": "scrbl", "max_stars_repo_path": "video/scribblings/installing.scrbl", "max_stars_repo_name": "AlexKnauth/video", "max_stars_repo_stars_event_min_datetime": "2017-05-22T21:38:46.000Z", "max_stars_repo_stars_event_max_datetime": "2022-03-19T15:36:58.000Z", "max_issues_repo_path": "video/scribblings/installing.scrbl", "max_issues_repo_name": "AlexKnauth/video", "max_issues_repo_issues_event_min_datetime": "2017-05-22T21:13:45.000Z", "max_issues_repo_issues_event_max_datetime": "2021-01-03T21:56:33.000Z", "max_forks_repo_path": "video/scribblings/installing.scrbl", "max_forks_repo_name": "AlexKnauth/video", "max_forks_repo_forks_event_min_datetime": "2017-05-19T20:41:57.000Z", "max_forks_repo_forks_event_max_datetime": "2021-11-19T13:56:26.000Z"}
{"max_stars_count": 123, "max_issues_count": 66, "max_forks_count": 15, "avg_line_length": 31.4269662921, "max_line_length": 75, "alphanum_fraction": 0.6993207008}
#lang reader video/scribblings/viddoclang

@;{
   Copyright 2016-2018 Leif Andersen

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
}

@title{Installing}

Video uses FFmpeg as part of its back-end. The language
includes FFmpeg for macOS and Windows. Linux (and other OS)
users will need to install FFmpeg themselves. Custom FFmpeg
builds are also an option when needed. Details are provided
for Windows/macOS/Linux.

@section{Windows}

Video for Windows comes bundled with FFmpeg. You can
optionally install a different version of FFmpeg. To install
a custom FFmpeg build, open the environment variables window
and add the path to the DLLs to the your library path. Make
sure to use at least the minimum version of FFmpeg as
documented in @secref["ffmpeg-specs"].

@section{macOS}

As with Windows, Video comes bundled with macOS. If you want
to use your own build of FFmpeg, ad the path to the dylib to
your @envvar{LD_LIBRARY_PATH}.

@section{Linux}

You need to install FFmpeg. Either from the FFmpeg website,
or from your distro's repository. See
@secref["ffmpeg-specs"] to make sure you have the correct
version installed.

@section[#:tag "ffmpeg-specs"]{FFmpeg Requirements}

Video requires at least FFmpeg 3.2, and recommends FFmpeg
3.3. The full requirements are as follows:

@margin-note{FFmpeg 4.0 support for Video is still under
 development.}


Minimum Version:

@inset-flow[
 @tabular[#:style 'boxed
          #:column-properties '(left right)
          `(("avutil" "55.58")
            ("libavcodec" "57.89")
            ("libavformat" "57.71")
            ("libavfilter" "6.82")
            ("libswscale" "4.6")
            ("libswresample" "2.7")
            ("libavdevice" "57.6"))]]

Recommended Version:

@inset-flow[
 @tabular[#:style 'boxed
          #:column-properties '(left right)
          `(("libavutil" "55.58")
            ("libavcodec" "57.89")
            ("libavformat" "57.71")
            ("libavfilter" "6.82")
            ("libswscale" "4.6")
            ("libswresample" "2.7")
            ("libavdevice" "57.6"))]]

Note that the miner version is a minimum, while the major
version is exact. Video has this requirement because major
versions of FFmpeg libraries breaks backwards compatibility.

You can test your version of FFmpeg with @exec{ffmpeg -v}.
