Commit 244fb2c6 authored by Yaowu Xu's avatar Yaowu Xu Committed by Gerrit Code Review

Merge "Update README"

parents cfea7dd7 700d00bc
README - 23 March 2015
README - 22 March 2016
Welcome to the WebM VP8/VP9 Codec SDK!
Welcome to the AOM Codec SDK!
COMPILING THE APPLICATIONS/LIBRARIES:
The build system used is similar to autotools. Building generally consists of
......@@ -33,13 +33,13 @@ COMPILING THE APPLICATIONS/LIBRARIES:
$ mkdir build
$ cd build
$ ../libvpx/configure <options>
$ ../libaom/configure <options>
$ make
3. Configuration options
The 'configure' script supports a number of options. The --help option can be
used to get a list of supported options:
$ ../libvpx/configure --help
$ ../libaom/configure --help
4. Cross development
For cross development, the most notable option is the --target option. The
......@@ -114,7 +114,7 @@ COMPILING THE APPLICATIONS/LIBRARIES:
toolchain, the following command could be used (note, POSIX SH syntax, adapt
to your shell as necessary):
$ CROSS=mipsel-linux-uclibc- ../libvpx/configure
$ CROSS=mipsel-linux-uclibc- ../libaom/configure
In addition, the executables to be invoked can be overridden by specifying the
environment variables: CC, AR, LD, AS, STRIP, NM. Additional flags can be
......@@ -125,15 +125,15 @@ COMPILING THE APPLICATIONS/LIBRARIES:
This defaults to config.log. This should give a good indication of what went
wrong. If not, contact us for support.
VP8/VP9 TEST VECTORS:
AOM TEST VECTORS:
The test vectors can be downloaded and verified using the build system after
running configure. To specify an alternate directory the
LIBVPX_TEST_DATA_PATH environment variable can be used.
LIBAOM_TEST_DATA_PATH environment variable can be used.
$ ./configure --enable-unit-tests
$ LIBVPX_TEST_DATA_PATH=../libvpx-test-data make testdata
$ LIBAOM_TEST_DATA_PATH=../libaom-test-data make testdata
SUPPORT
This library is an open source project supported by its community. Please
please email webm-discuss@webmproject.org for help.
please email aomediacodec-chair@jointdevelopment.kavi.com for help.
......@@ -343,12 +343,12 @@ CLEAN-OBJS += $(BUILD_PFX)vpx_version.h
## libvpx test directives
##
ifeq ($(CONFIG_UNIT_TESTS),yes)
LIBVPX_TEST_DATA_PATH ?= .
LIBAOM_TEST_DATA_PATH ?= .
include $(SRC_PATH_BARE)/test/test.mk
LIBVPX_TEST_SRCS=$(addprefix test/,$(call enabled,LIBVPX_TEST_SRCS))
LIBVPX_TEST_BIN=./test_libvpx$(EXE_SFX)
LIBVPX_TEST_DATA=$(addprefix $(LIBVPX_TEST_DATA_PATH)/,\
LIBVPX_TEST_DATA=$(addprefix $(LIBAOM_TEST_DATA_PATH)/,\
$(call enabled,LIBVPX_TEST_DATA))
libvpx_test_data_url=http://downloads.webmproject.org/test_data/libvpx/$(1)
......@@ -375,7 +375,7 @@ testdata:: $(LIBVPX_TEST_DATA)
echo "Checking test data:";\
for f in $(call enabled,LIBVPX_TEST_DATA); do\
grep $$f $(SRC_PATH_BARE)/test/test-data.sha1 |\
(cd $(LIBVPX_TEST_DATA_PATH); $${sha1sum} -c);\
(cd $(LIBAOM_TEST_DATA_PATH); $${sha1sum} -c);\
done; \
else\
echo "Skipping test data integrity check, sha1sum not found.";\
......@@ -540,10 +540,10 @@ TEST_BIN_PATH := $(addsuffix /$(TGT_OS:win64=x64)/Release, $(TEST_BIN_PATH))
endif
utiltest utiltest-no-data-check:
$(qexec)$(SRC_PATH_BARE)/test/vpxdec.sh \
--test-data-path $(LIBVPX_TEST_DATA_PATH) \
--test-data-path $(LIBAOM_TEST_DATA_PATH) \
--bin-path $(TEST_BIN_PATH)
$(qexec)$(SRC_PATH_BARE)/test/vpxenc.sh \
--test-data-path $(LIBVPX_TEST_DATA_PATH) \
--test-data-path $(LIBAOM_TEST_DATA_PATH) \
--bin-path $(TEST_BIN_PATH)
utiltest: testdata
else
......@@ -567,7 +567,7 @@ EXAMPLES_BIN_PATH := $(TGT_OS:win64=x64)/Release
endif
exampletest exampletest-no-data-check: examples
$(qexec)$(SRC_PATH_BARE)/test/examples.sh \
--test-data-path $(LIBVPX_TEST_DATA_PATH) \
--test-data-path $(LIBAOM_TEST_DATA_PATH) \
--bin-path $(EXAMPLES_BIN_PATH)
exampletest: testdata
else
......
......@@ -146,7 +146,7 @@ class VP9NewEncodeDecodePerfTest
}
virtual void BeginPassHook(unsigned int /*pass*/) {
const std::string data_path = getenv("LIBVPX_TEST_DATA_PATH");
const std::string data_path = getenv("LIBAOM_TEST_DATA_PATH");
const std::string path_to_source = data_path + "/" + kNewEncodeOutputFile;
outfile_ = fopen(path_to_source.c_str(), "wb");
ASSERT_TRUE(outfile_ != NULL);
......
......@@ -19,7 +19,7 @@
# $VP8_IVF_FILE and $VP9_IVF_FILE are required.
decode_to_md5_verify_environment() {
if [ ! -e "${VP8_IVF_FILE}" ] || [ ! -e "${VP9_IVF_FILE}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -19,7 +19,7 @@
# $VP8_IVF_FILE and $VP9_IVF_FILE are required.
decode_with_drops_verify_environment() {
if [ ! -e "${VP8_IVF_FILE}" ] || [ ! -e "${VP9_IVF_FILE}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -18,7 +18,7 @@
# Environment check: $YUV_RAW_INPUT is required.
resize_util_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -19,7 +19,7 @@
# $LIBVPX_BIN_PATH.
set_maps_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
if [ -z "$(vpx_tool_path set_maps)" ]; then
......
......@@ -19,7 +19,7 @@
# $VP8_IVF_FILE and $VP9_IVF_FILE are required.
simple_decoder_verify_environment() {
if [ ! -e "${VP8_IVF_FILE}" ] || [ ! -e "${VP9_IVF_FILE}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -18,7 +18,7 @@
# Environment check: $YUV_RAW_INPUT is required.
simple_encoder_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -118,12 +118,12 @@ test_env_var_dir() {
}
# This script requires that the LIBVPX_BIN_PATH, LIBVPX_CONFIG_PATH, and
# LIBVPX_TEST_DATA_PATH variables are in the environment: Confirm that
# LIBAOM_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() {
test_env_var_dir "LIBVPX_BIN_PATH" \
&& test_env_var_dir "LIBVPX_CONFIG_PATH" \
&& test_env_var_dir "LIBVPX_TEST_DATA_PATH"
&& test_env_var_dir "LIBAOM_TEST_DATA_PATH"
}
# Greps vpx_config.h in LIBVPX_CONFIG_PATH for positional parameter one, which
......@@ -293,7 +293,7 @@ cat << EOF
\$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.
\$LIBAOM_TEST_DATA_PATH and then the current directory.
EOF
}
......@@ -302,7 +302,7 @@ EOF
vpx_test_check_environment() {
if [ -z "${LIBVPX_BIN_PATH}" ] || \
[ -z "${LIBVPX_CONFIG_PATH}" ] || \
[ -z "${LIBVPX_TEST_DATA_PATH}" ]; then
[ -z "${LIBAOM_TEST_DATA_PATH}" ]; then
return 1
fi
}
......@@ -330,7 +330,7 @@ while [ -n "$1" ]; do
exit
;;
--test-data-path)
LIBVPX_TEST_DATA_PATH="$2"
LIBAOM_TEST_DATA_PATH="$2"
shift
;;
--prefix)
......@@ -358,7 +358,7 @@ done
# 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:-.}"
LIBAOM_TEST_DATA_PATH="${LIBAOM_TEST_DATA_PATH:-.}"
# Create a temporary directory for output files, and a trap to clean it up.
if [ -n "${TMPDIR}" ]; then
......@@ -383,19 +383,19 @@ if [ "$(is_windows_target)" = "yes" ]; then
fi
# Variables shared by tests.
VP8_IVF_FILE="${LIBVPX_TEST_DATA_PATH}/vp80-00-comprehensive-001.ivf"
VP9_IVF_FILE="${LIBVPX_TEST_DATA_PATH}/vp90-2-09-subpixel-00.ivf"
VP8_IVF_FILE="${LIBAOM_TEST_DATA_PATH}/vp80-00-comprehensive-001.ivf"
VP9_IVF_FILE="${LIBAOM_TEST_DATA_PATH}/vp90-2-09-subpixel-00.ivf"
VP9_WEBM_FILE="${LIBVPX_TEST_DATA_PATH}/vp90-2-00-quantizer-00.webm"
VP9_FPM_WEBM_FILE="${LIBVPX_TEST_DATA_PATH}/vp90-2-07-frame_parallel-1.webm"
VP9_LT_50_FRAMES_WEBM_FILE="${LIBVPX_TEST_DATA_PATH}/vp90-2-02-size-32x08.webm"
VP9_WEBM_FILE="${LIBAOM_TEST_DATA_PATH}/vp90-2-00-quantizer-00.webm"
VP9_FPM_WEBM_FILE="${LIBAOM_TEST_DATA_PATH}/vp90-2-07-frame_parallel-1.webm"
VP9_LT_50_FRAMES_WEBM_FILE="${LIBAOM_TEST_DATA_PATH}/vp90-2-02-size-32x08.webm"
YUV_RAW_INPUT="${LIBVPX_TEST_DATA_PATH}/hantro_collage_w352h288.yuv"
YUV_RAW_INPUT="${LIBAOM_TEST_DATA_PATH}/hantro_collage_w352h288.yuv"
YUV_RAW_INPUT_WIDTH=352
YUV_RAW_INPUT_HEIGHT=288
Y4M_NOSQ_PAR_INPUT="${LIBVPX_TEST_DATA_PATH}/park_joy_90p_8_420_a10-1.y4m"
Y4M_720P_INPUT="${LIBVPX_TEST_DATA_PATH}/niklas_1280_720_30.y4m"
Y4M_NOSQ_PAR_INPUT="${LIBAOM_TEST_DATA_PATH}/park_joy_90p_8_420_a10-1.y4m"
Y4M_720P_INPUT="${LIBAOM_TEST_DATA_PATH}/niklas_1280_720_30.y4m"
# Setup a trap function to clean up after tests complete.
trap cleanup EXIT
......@@ -403,7 +403,7 @@ trap cleanup EXIT
vlog "$(basename "${0%.*}") test configuration:
LIBVPX_BIN_PATH=${LIBVPX_BIN_PATH}
LIBVPX_CONFIG_PATH=${LIBVPX_CONFIG_PATH}
LIBVPX_TEST_DATA_PATH=${LIBVPX_TEST_DATA_PATH}
LIBAOM_TEST_DATA_PATH=${LIBAOM_TEST_DATA_PATH}
VP8_IVF_FILE=${VP8_IVF_FILE}
VP9_IVF_FILE=${VP9_IVF_FILE}
VP9_WEBM_FILE=${VP9_WEBM_FILE}
......
......@@ -18,7 +18,7 @@
# Environment check: $YUV_RAW_INPUT is required.
twopass_encoder_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -24,22 +24,22 @@
namespace libvpx_test {
// Helper macros to ensure LIBVPX_TEST_DATA_PATH is a quoted string.
// Helper macros to ensure LIBAOM_TEST_DATA_PATH is a quoted string.
// These are undefined right below GetDataPath
// NOTE: LIBVPX_TEST_DATA_PATH MUST NOT be a quoted string before
// NOTE: LIBAOM_TEST_DATA_PATH MUST NOT be a quoted string before
// Stringification or the GetDataPath will fail at runtime
#define TO_STRING(S) #S
#define STRINGIFY(S) TO_STRING(S)
// A simple function to encapsulate cross platform retrieval of test data path
static std::string GetDataPath() {
const char *const data_path = getenv("LIBVPX_TEST_DATA_PATH");
const char *const data_path = getenv("LIBAOM_TEST_DATA_PATH");
if (data_path == NULL) {
#ifdef LIBVPX_TEST_DATA_PATH
#ifdef LIBAOM_TEST_DATA_PATH
// In some environments, we cannot set environment variables
// Instead, we set the data path by using a preprocessor symbol
// which can be set from make files
return STRINGIFY(LIBVPX_TEST_DATA_PATH);
return STRINGIFY(LIBAOM_TEST_DATA_PATH);
#else
return ".";
#endif
......
......@@ -19,7 +19,7 @@
vp8_multi_resolution_encoder_verify_environment() {
if [ "$(vpx_config_option_enabled CONFIG_MULTI_RES_ENCODING)" = "yes" ]; then
if [ ! -e "${YUV_RAW_INPUT}" ]; then
elog "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
elog "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
local readonly app="vp8_multi_resolution_encoder"
......
......@@ -18,7 +18,7 @@
# Environment check: $YUV_RAW_INPUT is required.
vp8cx_set_ref_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -18,7 +18,7 @@
# Environment check: $YUV_RAW_INPUT is required.
vp9_spatial_svc_encoder_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
}
......
......@@ -18,7 +18,7 @@
# Environment check: $YUV_RAW_INPUT is required.
vpx_tsvc_encoder_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
echo "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
echo "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
if [ "$(vpx_config_option_enabled CONFIG_TEMPORAL_DENOISING)" != "yes" ]; then
......
......@@ -19,7 +19,7 @@ vpxdec_verify_environment() {
if [ ! -e "${VP8_IVF_FILE}" ] || [ ! -e "${VP9_WEBM_FILE}" ] || \
[ ! -e "${VP9_FPM_WEBM_FILE}" ] || \
[ ! -e "${VP9_LT_50_FRAMES_WEBM_FILE}" ] ; then
elog "Libvpx test data must exist in LIBVPX_TEST_DATA_PATH."
elog "Libvpx test data must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
if [ -z "$(vpx_tool_path vpxdec)" ]; then
......
......@@ -20,13 +20,13 @@ readonly TEST_FRAMES=10
# Environment check: Make sure input is available.
vpxenc_verify_environment() {
if [ ! -e "${YUV_RAW_INPUT}" ]; then
elog "The file ${YUV_RAW_INPUT##*/} must exist in LIBVPX_TEST_DATA_PATH."
elog "The file ${YUV_RAW_INPUT##*/} must exist in LIBAOM_TEST_DATA_PATH."
return 1
fi
if [ "$(vpxenc_can_encode_vp9)" = "yes" ]; then
if [ ! -e "${Y4M_NOSQ_PAR_INPUT}" ]; then
elog "The file ${Y4M_NOSQ_PAR_INPUT##*/} must exist in"
elog "LIBVPX_TEST_DATA_PATH."
elog "LIBAOM_TEST_DATA_PATH."
return 1
fi
fi
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment