Documenting the parse-arguments.sh

scripts/export-build-variables.sh

@@ -5,9 +5,9 @@ function max() {
 export ANDROID_ABI=$1
 
 if [ $ANDROID_ABI = "arm64-v8a" ] || [ $ANDROID_ABI = "x86_64" ] ; then
-  export ANDROID_PLATFORM=$(max ${MIN_SDK_ARG} 21)
+  export ANDROID_PLATFORM=$(max ${DESIRED_ANDROID_API_LEVEL} 21)
 else
-  export ANDROID_PLATFORM=${MIN_SDK_ARG}
+  export ANDROID_PLATFORM=${DESIRED_ANDROID_API_LEVEL}
 fi
 
 export TOOLCHAIN_PATH=${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/${HOST_TAG}

scripts/parse-arguments.sh

@@ -1,34 +1,40 @@
-# TODO Add desctiption of in and out params
+# This script parses arguments that were passed to ffmpeg-android-maker.sh
+# and exports a bunch of varables that are used elsewhere.
 
+# Local variables with default values. Can be overridden with specific arguments
+# See the end of this file for more description
 EXTERNAL_LIBRARIES=()
-
 SOURCE_TYPE=TAR
 SOURCE_VALUE="4.2.1"
+API_LEVEL=16
 
-MIN_SDK=16
-
-for i in "$@"
+for artument in "$@"
 do
-case $i in
-    --min-sdk=*)
-      MIN_SDK="${i#*=}"
+  case $artument in
+    # Use this value as Android platform version during compilation.
+    --android-api-level=*)
+      API_LEVEL="${artument#*=}"
       shift
     ;;
+    # Checkout the particular tag in the FFmpeg's git repository
     --source-git-tag=*)
       SOURCE_TYPE=GIT_TAG
-      SOURCE_VALUE="${i#*=}"
+      SOURCE_VALUE="${artument#*=}"
       shift
     ;;
+    # Checkout the particular branch in the FFmpeg's git repository
     --source-git-branch=*)
       SOURCE_TYPE=GIT_BRANCH
-      SOURCE_VALUE="${i#*=}"
+      SOURCE_VALUE="${artument#*=}"
       shift
     ;;
+    # Download the particular tar archive by its version
     --source-tar=*)
       SOURCE_TYPE=TAR
-      SOURCE_VALUE="${i#*=}"
+      SOURCE_VALUE="${artument#*=}"
       shift
     ;;
+    # Arguments below enable certain external libraries to build into FFmpeg
     --enable-libaom)
       EXTERNAL_LIBRARIES+=( "libaom" )
       shift
@@ -42,23 +48,45 @@ case $i in
       shift
     ;;
     *)
-      echo "Unknown argument $i"
+      echo "Unknown argument $artument"
     ;;
-esac
+  esac
 done
 
+# Saving the information FFmpeg's source code downloading
 export FFMPEG_SOURCE_TYPE=$SOURCE_TYPE
 export FFMPEG_SOURCE_VALUE=$SOURCE_VALUE
+
+# A list of external libraries to build into the FFMpeg
+# Elements from this list are used for strings substitution
 export FFMPEG_EXTERNAL_LIBRARIES=${EXTERNAL_LIBRARIES[@]}
 
-export MIN_SDK_ARG=${MIN_SDK}
+# Desired Android API level to use during compilation
+# Will be replaced with 21 for 64bit ABIs if the value is less than 21
+export DESIRED_ANDROID_API_LEVEL=${API_LEVEL}
 
-# Download sources for all libraries
+# Essential directories
+
+# The root of the project
 export BASE_DIR="$( cd "$( dirname "$0" )" && pwd )"
+# Directory that contains source code for FFmpeg and its dependencies
+# Each library has its own subdirectory
+# Multiple versions of the same library can be stored inside librarie's directory
 export SOURCES_DIR=${BASE_DIR}/sources
+# Directory to place some statistics about the build.
+# Currently - the info about Text Relocations
 export STATS_DIR=${BASE_DIR}/stats
+# Directory that contains helper scripts and
+# scripts to download and build FFmpeg and each dependency separated by subdirectories
 export SCRIPTS_DIR=${BASE_DIR}/scripts
+# The directory to use by Android project
+# All FFmpeg's libraries and headers are copied there
 export OUTPUT_DIR=${BASE_DIR}/output
+
+# Directory to use as a place to build/install FFmpeg and its dependencies
 BUILD_DIR=${BASE_DIR}/build
+# Separate directory to build FFmpeg to
 export BUILD_DIR_FFMPEG=$BUILD_DIR/ffmpeg
+# All external libraries are installed to a single root
+# to make easier referencing them when FFmpeg is being built.
 export BUILD_DIR_EXTERNAL=$BUILD_DIR/external