Merge branch 'AkashiSN-vaapi'

Author: markus-perl

README.md

@@ -63,14 +63,14 @@ ffmpeg-build-script is rockstable. Every commit runs against Linux and MacOS wit
 
 
 ## Requirements
-### MacOS
+### macOS
 
 * XCode 10.x or greater
 
 ### Linux
 
 * Debian >= Buster, Ubuntu => Focal Fossa, other Distributions might work too
-* build-essentials, curl is required installed
+* A development environment and curl is required
 
 ```bash
 # Debian and Ubuntu
@@ -102,9 +102,10 @@ $ ./build-ffmpeg --help
 
 ### Build in Docker (Linux)
 
-The main advantage of using Docker is the ability to reliably build without polluting the host environment. And you don't even have to install the CUDA SDK on your host!
+With Docker, FFmpeg can be built reliably without altering the host system.
+Also, there is no need to have the CUDA SDK installed outside of the Docker image.
 
-If you are running below kind of operating system and having Docker version 19.03 or higher, this is your best option.
+A Docker engine with version 19.03 or higher is required to build images based on the following distributions:
 * Ubuntu >= 16.04 (16.04, 18.04, 20.04)
 * Centos >= 7 (7, 8)
 
@@ -113,13 +114,13 @@ If you are running below kind of operating system and having Docker version 19.0
 $ export DOCKER_BUILDKIT=1
 ```
 
-2. Set the following DIST (`ubuntu` or `centos`) and VER (ubuntu: `16.04` , `18.04`, `20.04` or centos: `7`, `8`) environment variables in conjunction with your operating system.
+2. Set the DIST (`ubuntu` or `centos`) and VER (ubuntu: `16.04` , `18.04`, `20.04` or centos: `7`, `8`) environment variables to select the preferred Docker base image.
 ```bash
 $ export DIST=centos
 $ export VER=8
 ```
 
-3. Start the docker build as follows.
+3. Start the build as follows.
 ```bash
 $ sudo -E docker build --tag=ffmpeg:cuda-$DIST -f cuda-$DIST.dockerfile --build-arg VER=$VER .
 ```
@@ -139,26 +140,26 @@ libnppc.so.11 libnppicc.so.11 libnppidei.so.11 libnppig.so.11
 
 ### Build in Docker (full static ver.) (Linux)
 If you're running an operating system other than the one above, a completely static build may work.
-It's easy to do, just run the following command.
+To build a full statically linked binary inside Docker, just run the following command:
 ```bash
 $ sudo -E docker build --tag=ffmpeg:cuda-static --output type=local,dest=build -f full-static.dockerfile .
 ```
 
 ### Run with Docker (macOS, Linux)
-You can also run the entire Docker if the above two fail.
+You can also run the FFmpeg directly inside a Docker container.
 
 #### Default - Without CUDA (macOS, Linux)
-If you don't use CUDA, it's simple and runs as follows.
+If CUDA is not required, a dockerized FFmpeg build can be executed with the following command:
 
 ```bash
 $ sudo docker build --tag=ffmpeg .
 $ sudo docker run ffmpeg -i https://files.coconut.co.s3.amazonaws.com/test.mp4 -f webm -c:v libvpx -c:a libvorbis - > test.mp4
 ```
 
 #### With CUDA (Linux)
-If you use CUDA, Docker must be higher than 19.03.
+To use CUDA from inside the container, the installed Docker version must be >= 19.03.
 Install the driver and `nvidia-docker2` from [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#installing-docker-ce).
-You can perform hardware acceleration by GPU by running the following.
+You can then run FFmpeg inside Docker with GPU hardware acceleration enabled, as follows:
 ```bash
 $ sudo docker build --tag=ffmpeg:cuda -f cuda-ubuntu.dockerfile .
 $ sudo docker run --gpus all ffmpeg-cuda -hwaccel cuvid -c:v h264_cuvid -i https://files.coconut.co.s3.amazonaws.com/test.mp4 -c:v hevc_nvenc -vf scale_npp=-1:1080 - > test.mp4

build-ffmpeg

@@ -159,7 +159,7 @@ usage () {
 	echo "      --version       Display version information"
 	echo "  -b, --build         Starts the build process"
 	echo "  -c, --cleanup       Remove all working dirs"
-	echo "  -f, --full-static   Complete static build of ffmpeg (eg. glibc, pthreads etc...) **only Linux**"
+	echo "  -f, --full-static   Build a full static FFmpeg binary (eg. glibc, pthreads etc...) **only Linux**"
 	echo "                      Note: Because of the NSS (Name Service Switch), glibc does not recommend static links."
 	echo ""
 }
@@ -184,7 +184,7 @@ while (( $# > 0 )); do
 			fi
 			if [[ "$1" == "--full-static" || "$1" =~ 'f' ]]; then
 				if [[ "$OSTYPE" == "darwin"* ]]; then
-					echo "Error: full-static mode is available only Linux."
+					echo "Error: A full static binary can only be build on Linux."
 					exit 1
 				fi
 				LDEXEFLAGS="-static"
@@ -512,7 +512,7 @@ if [[ "$OSTYPE" == "linux-gnu" ]]; then
 		CONFIGURE_OPTIONS+=("--nvccflags=-gencode arch=compute_52,code=sm_52")
 	fi
 
-	# Vaapi doesn't work well with static links ffmpeg.
+	# Vaapi doesn't work well with static links FFmpeg.
 	if [ -z "$LDEXEFLAGS" ]; then
 		# If the libva development SDK is installed, enable vaapi.
 		if library_exists "libva" ; then
@@ -567,11 +567,11 @@ if [[ "$AUTOINSTALL" == "yes" ]]; then
 	if command_exists "sudo"; then
 		sudo cp "$WORKSPACE/bin/ffmpeg" "$INSTALL_FOLDER/ffmpeg"
 		sudo cp "$WORKSPACE/bin/ffprobe" "$INSTALL_FOLDER/ffprobe"
-		echo "Done. ffmpeg is now installed to your system."
+		echo "Done. FFmpeg is now installed to your system."
 	else
 		cp "$WORKSPACE/bin/ffmpeg" "$INSTALL_FOLDER/ffmpeg"
 		cp "$WORKSPACE/bin/ffprobe" "$INSTALL_FOLDER/ffprobe"
-		echo "Done. ffmpeg is now installed to your system."
+		echo "Done. FFmpeg is now installed to your system."
 	fi
 elif [[ ! "$SKIPINSTALL" == "yes" ]]; then
 	read -r -p "Install the binary to your $INSTALL_FOLDER folder? [Y/n] " response
@@ -584,7 +584,7 @@ elif [[ ! "$SKIPINSTALL" == "yes" ]]; then
 			cp "$WORKSPACE/bin/ffmpeg" "$INSTALL_FOLDER/ffmpeg"
 			cp "$WORKSPACE/bin/ffprobe" "$INSTALL_FOLDER/ffprobe"
 		fi
-		echo "Done. ffmpeg is now installed to your system."
+		echo "Done. FFmpeg is now installed to your system."
 		;;
 	esac
 fi