Index: source/libvpx/test/tools_common.sh |
=================================================================== |
--- source/libvpx/test/tools_common.sh (revision 0) |
+++ source/libvpx/test/tools_common.sh (revision 0) |
@@ -0,0 +1,437 @@ |
+#!/bin/sh |
+## |
+## Copyright (c) 2014 The WebM project authors. All Rights Reserved. |
+## |
+## Use of this source code is governed by a BSD-style license |
+## that can be found in the LICENSE file in the root of the source |
+## tree. An additional intellectual property rights grant can be found |
+## in the file PATENTS. All contributing project authors may |
+## be found in the AUTHORS file in the root of the source tree. |
+## |
+## This file contains shell code shared by test scripts for libvpx tools. |
+set -e |
+ |
+# Sets $VPX_TOOL_TEST to the name specified by positional parameter one. |
+test_begin() { |
+ VPX_TOOL_TEST="${1}" |
+} |
+ |
+# Clears the VPX_TOOL_TEST variable after confirming that $VPX_TOOL_TEST matches |
+# positional parameter one. |
+test_end() { |
+ if [ "$1" != "${VPX_TOOL_TEST}" ]; then |
+ echo "FAIL completed test mismatch!." |
+ echo " completed test: ${1}" |
+ echo " active test: ${VPX_TOOL_TEST}." |
+ return 1 |
+ fi |
+ VPX_TOOL_TEST='<unset>' |
+} |
+ |
+# Echoes the target configuration being tested. |
+test_configuration_target() { |
+ vpx_config_mk="${LIBVPX_CONFIG_PATH}/config.mk" |
+ # Find the TOOLCHAIN line, split it using ':=' as the field separator, and |
+ # print the last field to get the value. Then pipe the value to tr to consume |
+ # any leading/trailing spaces while allowing tr to echo the output to stdout. |
+ awk -F ':=' '/TOOLCHAIN/ { print $NF }' "${vpx_config_mk}" | tr -d ' ' |
+} |
+ |
+# Trap function used for failure reports and tool output directory removal. |
+# When the contents of $VPX_TOOL_TEST do not match the string '<unset>', reports |
+# failure of test stored in $VPX_TOOL_TEST. |
+cleanup() { |
+ if [ -n "${VPX_TOOL_TEST}" ] && [ "${VPX_TOOL_TEST}" != '<unset>' ]; then |
+ echo "FAIL: $VPX_TOOL_TEST" |
+ fi |
+ if [ -n "${VPX_TEST_OUTPUT_DIR}" ] && [ -d "${VPX_TEST_OUTPUT_DIR}" ]; then |
+ rm -rf "${VPX_TEST_OUTPUT_DIR}" |
+ fi |
+} |
+ |
+# Echoes the git hash portion of the VERSION_STRING variable defined in |
+# $LIBVPX_CONFIG_PATH/config.mk to stdout, or the version number string when |
+# no git hash is contained in VERSION_STRING. |
+config_hash() { |
+ vpx_config_mk="${LIBVPX_CONFIG_PATH}/config.mk" |
+ # Find VERSION_STRING line, split it with "-g" and print the last field to |
+ # output the git hash to stdout. |
+ vpx_version=$(awk -F -g '/VERSION_STRING/ {print $NF}' "${vpx_config_mk}") |
+ # Handle two situations here: |
+ # 1. The default case: $vpx_version is a git hash, so echo it unchanged. |
+ # 2. When being run a non-dev tree, the -g portion is not present in the |
+ # version string: It's only the version number. |
+ # In this case $vpx_version is something like 'VERSION_STRING=v1.3.0', so |
+ # we echo only what is after the '='. |
+ echo "${vpx_version##*=}" |
+} |
+ |
+# Echoes the short form of the current git hash. |
+current_hash() { |
+ if git --version > /dev/null 2>&1; then |
+ (cd "$(dirname "${0}")" |
+ git rev-parse --short HEAD) |
+ else |
+ # Return the config hash if git is unavailable: Fail silently, git hashes |
+ # are used only for warnings. |
+ config_hash |
+ fi |
+} |
+ |
+# Echoes warnings to stdout when git hash in vpx_config.h does not match the |
+# current git hash. |
+check_git_hashes() { |
+ hash_at_configure_time=$(config_hash) |
+ hash_now=$(current_hash) |
+ |
+ if [ "${hash_at_configure_time}" != "${hash_now}" ]; then |
+ echo "Warning: git hash has changed since last configure." |
+ fi |
+} |
+ |
+# This script requires that the LIBVPX_BIN_PATH, LIBVPX_CONFIG_PATH, and |
+# LIBVPX_TEST_DATA_PATH variables are in the environment: Confirm that |
+# the variables are set and that they all evaluate to directory paths. |
+verify_vpx_test_environment() { |
+ if [ ! -d "${LIBVPX_BIN_PATH}" ]; then |
+ echo "The LIBVPX_BIN_PATH environment variable must be set." |
+ return 1 |
+ fi |
+ if [ ! -d "${LIBVPX_CONFIG_PATH}" ]; then |
+ echo "The LIBVPX_CONFIG_PATH environment variable must be set." |
+ return 1 |
+ fi |
+ if [ ! -d "${LIBVPX_TEST_DATA_PATH}" ]; then |
+ echo "The LIBVPX_TEST_DATA_PATH environment variable must be set." |
+ return 1 |
+ fi |
+} |
+ |
+# Greps vpx_config.h in LIBVPX_CONFIG_PATH for positional parameter one, which |
+# should be a LIBVPX preprocessor flag. Echoes yes to stdout when the feature |
+# is available. |
+vpx_config_option_enabled() { |
+ vpx_config_option="${1}" |
+ vpx_config_file="${LIBVPX_CONFIG_PATH}/vpx_config.h" |
+ config_line=$(grep "${vpx_config_option}" "${vpx_config_file}") |
+ if echo "${config_line}" | egrep -q '1$'; then |
+ echo yes |
+ fi |
+} |
+ |
+# Echoes yes when output of test_configuration_target() contains win32 or win64. |
+is_windows_target() { |
+ if test_configuration_target \ |
+ | grep -q -e win32 -e win64 > /dev/null 2>&1; then |
+ echo yes |
+ fi |
+} |
+ |
+# Echoes yes to stdout when the file named by positional parameter one exists |
+# in LIBVPX_BIN_PATH, and is executable. |
+vpx_tool_available() { |
+ tool_name="${1}" |
+ if [ "$(is_windows_target)" = "yes" ]; then |
+ tool_name="${tool_name}.exe" |
+ fi |
+ [ -x "${LIBVPX_BIN_PATH}/${1}" ] && echo yes |
+} |
+ |
+# Echoes yes to stdout when vpx_config_option_enabled() reports yes for |
+# CONFIG_VP8_DECODER. |
+vp8_decode_available() { |
+ [ "$(vpx_config_option_enabled CONFIG_VP8_DECODER)" = "yes" ] && echo yes |
+} |
+ |
+# Echoes yes to stdout when vpx_config_option_enabled() reports yes for |
+# CONFIG_VP8_ENCODER. |
+vp8_encode_available() { |
+ [ "$(vpx_config_option_enabled CONFIG_VP8_ENCODER)" = "yes" ] && echo yes |
+} |
+ |
+# Echoes yes to stdout when vpx_config_option_enabled() reports yes for |
+# CONFIG_VP9_DECODER. |
+vp9_decode_available() { |
+ [ "$(vpx_config_option_enabled CONFIG_VP9_DECODER)" = "yes" ] && echo yes |
+} |
+ |
+# Echoes yes to stdout when vpx_config_option_enabled() reports yes for |
+# CONFIG_VP9_ENCODER. |
+vp9_encode_available() { |
+ [ "$(vpx_config_option_enabled CONFIG_VP9_ENCODER)" = "yes" ] && echo yes |
+} |
+ |
+# Echoes yes to stdout when vpx_config_option_enabled() reports yes for |
+# CONFIG_WEBM_IO. |
+webm_io_available() { |
+ [ "$(vpx_config_option_enabled CONFIG_WEBM_IO)" = "yes" ] && echo yes |
+} |
+ |
+# Echoes yes to stdout when vpxdec exists according to vpx_tool_available(). |
+vpxdec_available() { |
+ [ -n $(vpx_tool_available vpxdec) ] && echo yes |
+} |
+ |
+# Wrapper function for running vpxdec in noblit mode. Requires that |
+# LIBVPX_BIN_PATH points to the directory containing vpxdec. Positional |
+# parameter one is used as the input file path. Positional parameter two, when |
+# present, is interpreted as a boolean flag that means the input should be sent |
+# to vpxdec via pipe from cat instead of directly. |
+vpxdec() { |
+ input="${1}" |
+ pipe_input=${2} |
+ |
+ if [ $# -gt 2 ]; then |
+ # shift away $1 and $2 so the remaining arguments can be passed to vpxdec |
+ # via $@. |
+ shift 2 |
+ fi |
+ |
+ decoder="${LIBVPX_BIN_PATH}/vpxdec" |
+ |
+ if [ "$(is_windows_target)" = "yes" ]; then |
+ decoder="${decoder}.exe" |
+ fi |
+ |
+ if [ -z "${pipe_input}" ]; then |
+ "${decoder}" "$input" --summary --noblit "$@" > /dev/null 2>&1 |
+ else |
+ cat "${input}" | "${decoder}" - --summary --noblit "$@" > /dev/null 2>&1 |
+ fi |
+} |
+ |
+# Echoes yes to stdout when vpxenc exists according to vpx_tool_available(). |
+vpxenc_available() { |
+ [ -n $(vpx_tool_available vpxenc) ] && echo yes |
+} |
+ |
+# Wrapper function for running vpxenc. Positional parameters are interpreted as |
+# follows: |
+# 1 - codec name |
+# 2 - input width |
+# 3 - input height |
+# 4 - number of frames to encode |
+# 5 - path to input file |
+# 6 - path to output file |
+# Note: The output file path must end in .ivf to output an IVF file. |
+# 7 - extra flags |
+# Note: Extra flags currently supports a special case: when set to "-" |
+# input is piped to vpxenc via cat. |
+vpxenc() { |
+ encoder="${LIBVPX_BIN_PATH}/vpxenc" |
+ codec="${1}" |
+ width=${2} |
+ height=${3} |
+ frames=${4} |
+ input=${5} |
+ output="${VPX_TEST_OUTPUT_DIR}/${6}" |
+ extra_flags=${7} |
+ |
+ if [ "$(is_windows_target)" = "yes" ]; then |
+ encoder="${encoder}.exe" |
+ fi |
+ |
+ # Because --ivf must be within the command line to get IVF from vpxenc. |
+ if echo "${output}" | egrep -q 'ivf$'; then |
+ use_ivf=--ivf |
+ else |
+ unset use_ivf |
+ fi |
+ |
+ if [ "${extra_flags}" = "-" ]; then |
+ pipe_input=yes |
+ extra_flags=${8} |
+ else |
+ unset pipe_input |
+ fi |
+ |
+ if [ -z "${pipe_input}" ]; then |
+ "${encoder}" --codec=${codec} --width=${width} --height=${height} \ |
+ --limit=${frames} ${use_ivf} ${extra_flags} --output="${output}" \ |
+ "${input}" > /dev/null 2>&1 |
+ else |
+ cat "${input}" \ |
+ | "${encoder}" --codec=${codec} --width=${width} --height=${height} \ |
+ --limit=${frames} ${use_ivf} ${extra_flags} --output="${output}" - \ |
+ > /dev/null 2>&1 |
+ fi |
+ |
+ if [ ! -e "${output}" ]; then |
+ # Return non-zero exit status: output file doesn't exist, so something |
+ # definitely went wrong. |
+ return 1 |
+ fi |
+} |
+ |
+# Filters strings from positional parameter one using the filter specified by |
+# positional parameter two. Filter behavior depends on the presence of a third |
+# positional parameter. When parameter three is present, strings that match the |
+# filter are excluded. When omitted, strings matching the filter are included. |
+# The filtered string is echoed to stdout. |
+filter_strings() { |
+ strings=${1} |
+ filter=${2} |
+ exclude=${3} |
+ |
+ if [ -n "${exclude}" ]; then |
+ # When positional parameter three exists the caller wants to remove strings. |
+ # Tell grep to invert matches using the -v argument. |
+ exclude='-v' |
+ else |
+ unset exclude |
+ fi |
+ |
+ if [ -n "${filter}" ]; then |
+ for s in ${strings}; do |
+ if echo "${s}" | egrep -q ${exclude} "${filter}" > /dev/null 2>&1; then |
+ filtered_strings="${filtered_strings} ${s}" |
+ fi |
+ done |
+ else |
+ filtered_strings="${strings}" |
+ fi |
+ echo "${filtered_strings}" |
+} |
+ |
+# Runs user test functions passed via positional parameters one and two. |
+# Functions in positional parameter one are treated as environment verification |
+# functions and are run unconditionally. Functions in positional parameter two |
+# are run according to the rules specified in vpx_test_usage(). |
+run_tests() { |
+ env_tests="verify_vpx_test_environment ${1}" |
+ tests_to_filter="${2}" |
+ |
+ if [ "${VPX_TEST_RUN_DISABLED_TESTS}" != "yes" ]; then |
+ # Filter out DISABLED tests. |
+ tests_to_filter=$(filter_strings "${tests_to_filter}" ^DISABLED exclude) |
+ fi |
+ |
+ if [ -n "${VPX_TEST_FILTER}" ]; then |
+ # Remove tests not matching the user's filter. |
+ tests_to_filter=$(filter_strings "${tests_to_filter}" ${VPX_TEST_FILTER}) |
+ fi |
+ |
+ tests_to_run="${env_tests} ${tests_to_filter}" |
+ |
+ check_git_hashes |
+ |
+ # Run tests. |
+ for test in ${tests_to_run}; do |
+ test_begin "${test}" |
+ "${test}" |
+ [ "${VPX_TEST_VERBOSE_OUTPUT}" = "yes" ] && echo " PASS ${test}" |
+ test_end "${test}" |
+ done |
+ |
+ tested_config="$(test_configuration_target) @ $(current_hash)" |
+ echo $(basename "${0%.*}"): Done, all tests pass for ${tested_config}. |
+} |
+ |
+vpx_test_usage() { |
+cat << EOF |
+ Usage: ${0##*/} [arguments] |
+ --bin-path <path to libvpx binaries directory> |
+ --config-path <path to libvpx config directory> |
+ --filter <filter>: User test filter. Only tests matching filter are run. |
+ --run-disabled-tests: Run disabled tests. |
+ --help: Display this message and exit. |
+ --test-data-path <path to libvpx test data directory> |
+ --verbose: Verbose output. |
+ |
+ When the --bin-path option is not specified the script attempts to use |
+ \$LIBVPX_BIN_PATH and then the current directory. |
+ |
+ When the --config-path option is not specified the script attempts to use |
+ \$LIBVPX_CONFIG_PATH and then the current directory. |
+ |
+ When the -test-data-path option is not specified the script attempts to use |
+ \$LIBVPX_TEST_DATA_PATH and then the current directory. |
+EOF |
+} |
+ |
+# Returns non-zero (failure) when required environment variables are empty |
+# strings. |
+vpx_test_check_environment() { |
+ if [ -z "${LIBVPX_BIN_PATH}" ] || \ |
+ [ -z "${LIBVPX_CONFIG_PATH}" ] || \ |
+ [ -z "${LIBVPX_TEST_DATA_PATH}" ]; then |
+ return 1 |
+ fi |
+} |
+ |
+# Parse the command line. |
+while [ -n "$1" ]; do |
+ case "$1" in |
+ --bin-path) |
+ LIBVPX_BIN_PATH="$2" |
+ shift |
+ ;; |
+ --config-path) |
+ LIBVPX_CONFIG_PATH="$2" |
+ shift |
+ ;; |
+ --filter) |
+ VPX_TEST_FILTER="$2" |
+ shift |
+ ;; |
+ --run-disabled-tests) |
+ VPX_TEST_RUN_DISABLED_TESTS=yes |
+ ;; |
+ --help) |
+ vpx_test_usage |
+ exit |
+ ;; |
+ --test-data-path) |
+ LIBVPX_TEST_DATA_PATH="$2" |
+ shift |
+ ;; |
+ --verbose) |
+ VPX_TEST_VERBOSE_OUTPUT=yes |
+ ;; |
+ *) |
+ vpx_test_usage |
+ exit 1 |
+ ;; |
+ esac |
+ shift |
+done |
+ |
+# Handle running the tests from a build directory without arguments when running |
+# the tests on *nix/macosx. |
+LIBVPX_BIN_PATH="${LIBVPX_BIN_PATH:-.}" |
+LIBVPX_CONFIG_PATH="${LIBVPX_CONFIG_PATH:-.}" |
+LIBVPX_TEST_DATA_PATH="${LIBVPX_TEST_DATA_PATH:-.}" |
+ |
+# Create a temporary directory for output files, and a trap to clean it up. |
+if [ -n "${TMPDIR}" ]; then |
+ VPX_TEST_TEMP_ROOT="${TMPDIR}" |
+elif [ -n "${TEMPDIR}" ]; then |
+ VPX_TEST_TEMP_ROOT="${TEMPDIR}" |
+else |
+ VPX_TEST_TEMP_ROOT=/tmp |
+fi |
+ |
+VPX_TEST_RAND=$(awk 'BEGIN { srand(); printf "%d\n",(rand() * 32768)}') |
+VPX_TEST_OUTPUT_DIR="${VPX_TEST_TEMP_ROOT}/vpx_test_${VPX_TEST_RAND}" |
+ |
+if ! mkdir -p "${VPX_TEST_OUTPUT_DIR}" || \ |
+ [ ! -d "${VPX_TEST_OUTPUT_DIR}" ]; then |
+ echo "${0##*/}: Cannot create output directory, giving up." |
+ echo "${0##*/}: VPX_TEST_OUTPUT_DIR=${VPX_TEST_OUTPUT_DIR}" |
+ exit 1 |
+fi |
+ |
+trap cleanup EXIT |
+ |
+if [ "${VPX_TEST_VERBOSE_OUTPUT}" = "yes" ]; then |
+cat << EOF |
+$(basename "${0%.*}") test configuration: |
+ LIBVPX_BIN_PATH=${LIBVPX_BIN_PATH} |
+ LIBVPX_CONFIG_PATH=${LIBVPX_CONFIG_PATH} |
+ LIBVPX_TEST_DATA_PATH=${LIBVPX_TEST_DATA_PATH} |
+ VPX_TEST_OUTPUT_DIR=${VPX_TEST_OUTPUT_DIR} |
+ VPX_TEST_VERBOSE_OUTPUT=${VPX_TEST_VERBOSE_OUTPUT} |
+ VPX_TEST_FILTER=${VPX_TEST_FILTER} |
+ VPX_TEST_RUN_DISABLED_TESTS=${VPX_TEST_RUN_DISABLED_TESTS} |
+EOF |
+fi |
Property changes on: source/libvpx/test/tools_common.sh |
___________________________________________________________________ |
Added: svn:executable |
+ * |