update as per latest main (48824236) · Commits · IVAS Codec Public Collaboration / IVAS Codec

.gitlab-ci.yml

+110 −90

Original line number	Diff line number	Diff line
		@@ -12,6 +12,13 @@ variables:
		EXIT_CODE_FAIL: 1
		PROCESSING_SCRIPTS_BIN_DIR: "/test-bin"
		TESTS_DIR_CODEC_BE_ON_MR: "tests/codec_be_on_mr_nonselection"
		MANUAL_PIPELINE_TYPE:
		description: "Type for the manual pipeline run. Use 'test-be-release' to run BE test against release codec."
		value: 'default'
		options:
		- 'default'
		- 'test-be-release'


		default:
		interruptible: true # Make all jobs by default interruptible
		@@ -31,10 +38,11 @@ workflow:
		stages:
		- .pre
		- maintenance
		- prevalidate
		- build
		- test
		- compare
		- validate
		- postvalidate
		- deploy

		# ---------------------------------------------------------------
		@@ -126,6 +134,14 @@ stages:
		- sed -i.bak -e "s/\/\[[:space:]]$#define[[:space:]]SPLIT_REND_WITH_HEAD_ROT$[[:space:]]\*\//\1/g" ./lib_com/options.h
		- sed -i.bak -e "s/\/\/[[:space:]]$#define[[:space:]]SPLIT_REND_WITH_HEAD_ROT$/\1/g" ./lib_com/options.h

		.get-commits-behind-count: &get-commits-behind-count
		- echo $CI_COMMIT_SHA
		- echo $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
		- commits_behind_count=$(git rev-list --count $CI_COMMIT_SHA..origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME)

		.check-commits-behind-count-in-compare-jobs: &check-commits-behind-count-in-compare-jobs
		- if [ $commits_behind_count -ne 0 ]; then echo "Your branch is not up-to-date with main -> Compare tests will not run as they can contain false negatives this way.\nMain might have changed during your pipeline run. Run 'git merge origin/main' to update."; exit 1; fi

		# ---------------------------------------------------------------
		# Job templates
		# ---------------------------------------------------------------
		@@ -143,6 +159,8 @@ stages:
		when: never
		- if: $CI_PIPELINE_SOURCE == 'trigger' # Don't run triggered pipeline by default
		when: never
		- if: $MANUAL_PIPELINE_TYPE == 'test-be-release' # Skip all the normal jobs when testing manually against release codec
		when: never
		- when: on_success

		.rules-merge-request:
		@@ -170,11 +188,13 @@ stages:
		.build-job-linux:
		stage: build
		timeout: "4 minutes"
		needs: []
		tags:
		- ivas-linux

		.build-job-windows:
		stage: build
		needs: []
		timeout: "4 minutes"
		tags:
		- ivas-windows
		@@ -227,19 +247,28 @@ uninterruptible:
		# Validation jobs
		# ---------------------------------------------------------------

		check-if-branch-is-up-to-date-with-main:
		branch-is-up-to-date-with-main-pre:
		extends:
		- .rules-merge-request
		stage: validate
		stage: prevalidate
		needs: []
		tags:
		- ivas-linux
		script:
		- echo $CI_COMMIT_SHA
		- echo $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
		- commits_behind_count=$(git rev-list --count $CI_COMMIT_SHA..origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME)
		- *get-commits-behind-count
		- echo $commits_behind_count
		- if [ $commits_behind_count -eq 0 ]; then exit 0; else echo "Your branch is behind main, run 'git merge origin/main' to update."; exit 1; fi;

		branch-is-up-to-date-with-main-post:
		extends:
		- .rules-merge-request
		stage: postvalidate
		tags:
		- ivas-linux
		script:
		- *get-commits-behind-count
		- echo $commits_behind_count
		- if [ $commits_behind_count -eq 0 ]; then exit 0; else exit 1; fi;
		- if [ $commits_behind_count -eq 0 ]; then exit 0; else echo "Your branch is behind main, possibly main changed during your pipeline run, run 'git merge origin/main' to update." exit 1; fi;

		# ---------------------------------------------------------------
		# Build jobs
		@@ -326,15 +355,20 @@ codec-smoke-test:
		- .rules-merge-request
		timeout: "10 minutes"
		stage: test
		needs: ["build-codec-linux-cmake"]
		needs: ["build-codec-linux-cmake", "build-codec-linux-make", "build-codec-instrumented-linux", "build-codec-sanitizers-linux"]
		script:
		- *print-common-info
		# LTV update needed as ltv ISM metadata files are used
		- *update-ltv-repo
		- bash ci/smoke_test.sh
		### analyze for failures
		- if cat smoke_test_output.txt \| grep -c "failed"; then echo "Smoke test without PLC failed"; exit 1; fi
		- if cat smoke_test_output_plc.txt \| grep -c "failed"; then echo "Smoke test with PLC failed"; exit 1; fi
		- if cat smoke_test_output_jbm_noEXT.txt \| grep -c "failed"; then echo "Smoke test JBM part failed"; exit 1; fi
		- if cat smoke_test_output_hrtf.txt \| grep -c "failed"; then echo "Smoke test with external hrtf files failed"; exit 1; fi
		- if ! [ -s smoke_test_output.txt ] \|\| ! [ -s smoke_test_output_plc.txt ] \|\| ! [ -s smoke_test_output_jbm_noEXT.txt ] \|\| ! [ -s smoke_test_output_hrtf.txt ]; then echo "Error in smoke test"; exit 1; fi
		- ret_val=0
		- if cat smoke_test_output.txt \| grep -c "failed"; then echo "Smoke test without PLC failed"; ret_val=1; fi
		- if cat smoke_test_output_plc.txt \| grep -c "failed"; then echo "Smoke test with PLC failed"; ret_val=1; fi
		- if cat smoke_test_output_jbm_noEXT.txt \| grep -c "failed"; then echo "Smoke test JBM part failed"; ret_val=1; fi
		- if cat smoke_test_output_hrtf.txt \| grep -c "failed"; then echo "Smoke test with external hrtf files failed"; ret_val=1; fi
		- exit $ret_val
		artifacts:
		name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--stage-$CI_JOB_STAGE--results"
		expire_in: 1 week
		@@ -356,7 +390,7 @@ codec-msan:
		- *print-common-info
		- make clean
		- make -j CLANG=1
		- python3 scripts/self_test.py --create \| tee test_output.txt
		- python3 scripts/self_test.py -z console --create \| tee test_output.txt
		- run_errors=$(cat test_output.txt \| grep -ic "run errors") \|\| true
		- if [ $run_errors != 0 ] ; then echo "Run errors in self_test.py with Clang memory-sanitizer"; exit 1; fi
		artifacts:
		@@ -378,7 +412,7 @@ codec-asan:
		- *print-common-info
		- make clean
		- make -j CLANG=2
		- python3 scripts/self_test.py --create \| tee test_output.txt
		- python3 scripts/self_test.py -z console --create \| tee test_output.txt
		- run_errors=$(cat test_output.txt \| grep -ic "run errors") \|\| true
		- if [ $run_errors != 0 ] ; then echo "Run errors in self_test.py with Clang address-sanitizer"; exit 1; fi
		artifacts:
		@@ -400,7 +434,7 @@ codec-usan:
		- *print-common-info
		- make clean
		- make -j CLANG=3
		- UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1 python3 scripts/self_test.py --create
		- UBSAN_OPTIONS=suppressions=scripts/ubsan.supp,report_error_type=1 python3 scripts/self_test.py -z console --create
		- grep_exit_code=0
		- grep UndefinedBehaviorSanitizer scripts/ref/logs/* \|\| grep_exit_code=$?
		- if [ $grep_exit_code != 1 ] ; then echo "Run errors in self_test.py with Clang undefined-behavior-sanitizer"; exit 1; fi
		@@ -516,6 +550,8 @@ renderer-pytest-on-merge-request:
		stage: compare
		script:
		- *print-common-info
		- *get-commits-behind-count
		- *check-commits-behind-count-in-compare-jobs

		# some helper variables - "\|\| true" to prevent failures from grep not finding anything
		# write to temporary file as workaround for failures observed with piping echo
		@@ -597,6 +633,8 @@ split-rendering-pytest-on-merge-request:
		stage: compare
		script:
		- *print-common-info
		- *get-commits-behind-count
		- *check-commits-behind-count-in-compare-jobs

		# some helper variables - "\|\| true" to prevent failures from grep not finding anything
		# write to temporary file as workaround for failures observed with piping echo
		@@ -660,6 +698,8 @@ ivas-pytest-on-merge-request:
		timeout: "10 minutes"
		script:
		- *print-common-info
		- *get-commits-behind-count
		- *check-commits-behind-count-in-compare-jobs
		- *merge-request-comparison-setup-codec

		# some helper variables - "\|\| true" to prevent failures from grep not finding anything
		@@ -712,6 +752,8 @@ evs-pytest-on-merge-request:
		timeout: "10 minutes"
		script:
		- *print-common-info
		- *get-commits-behind-count
		- *check-commits-behind-count-in-compare-jobs
		- *merge-request-comparison-setup-codec

		# some helper variables - "\|\| true" to prevent failures from grep not finding anything
		@@ -756,8 +798,8 @@ voip-be-on-merge-request:
		extends:
		- .test-job-linux-needs-testv-dir
		- .rules-merge-request
		stage: compare # Or should it be test? Comparison is done within one git revision
		needs: ["build-codec-linux-make", codec-smoke-test]
		stage: test
		needs: ["build-codec-linux-make", "codec-smoke-test"]
		timeout: "10 minutes"
		script:
		- *print-common-info
		@@ -769,7 +811,7 @@ clang-format-check:
		- .rules-merge-request
		variables:
		ARTIFACT_BASE_NAME: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--formatting-fix"
		stage: validate
		stage: prevalidate
		needs: []
		timeout: "5 minutes"
		script:
		@@ -816,7 +858,7 @@ check-first-frame-is-sid:
		tags:
		- ivas-linux
		stage: test
		# needs: ["build-codec-linux-cmake"]
		needs: ["build-codec-linux-cmake"]
		script:
		- *print-common-info
		- *update-ltv-repo
		@@ -827,13 +869,16 @@ check-first-frame-is-sid:
		- make -j

		# TODO: for some MASA modes, we currently do not have testvectors that actually trigger DTX
		# SBA is run separately to use shorter part of file
		# SBA modes are run separately to use shorter part of file
		- exit_code_no_sba=0
		- exit_code_sba=0
		- modes=$(scripts/runIvasCodec.py -l \| grep dtx \| grep -v MASA \| grep -v SBA)
		- scripts/runIvasCodec.py -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 500 -U 0:20 \|\| exit_code_no_sba=$?
		- modes=$(scripts/runIvasCodec.py -l \| grep dtx \| grep SBA)
		- scripts/runIvasCodec.py -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 500 -U 70:80 \|\| exit_code_sba=$?
		- modes=$(scripts/runIvasCodec.py -l \| grep dtx \| grep -v MASA \| grep -vE "FOA\|HOA" )
		- scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 200 -U 0:20 \|\| exit_code_no_sba=$?
		- modes=$(scripts/runIvasCodec.py -l \| grep dtx \| grep -E "HOA")
		- scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 100 -U 70:80 \|\| exit_code_sba=$?
		# need to do FOA separately as VAD apparently behaves differently there
		- modes=$(scripts/runIvasCodec.py -l \| grep dtx \| grep "FOA")
		- scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 100 -U 75:110 \|\| exit_code_sba=$?
		- if [ $exit_code_no_sba -ne 0 ] \|\| [ $exit_code_sba -ne 0 ]; then exit 1; fi
		artifacts:
		paths:
		@@ -843,50 +888,11 @@ check-first-frame-is-sid:
		expose_as: "logs-sidstart"
		expire_in: "5 days"

		selection-test-processing:
		extends:
		- .test-job-linux-needs-testv-dir
		- .rules-merge-request
		tags:
		- processing-scripts-linux
		stage: test
		needs: ["build-codec-linux-make"]
		script:
		# get processing script code
		- git clone https://forge.3gpp.org/rep/ivas-codec-pc/ivas-processing-scripts.git --single-branch -b main

		- mkdir -p ivas-processing-scripts/tests/data/testv
		- cp -r scripts/testv/* ivas-processing-scripts/tests/data/testv/

		# copy binaries into local bin dir, those should take precendence over PATH
		- cp $PROCESSING_SCRIPTS_BIN_DIR/* ivas-processing-scripts/ivas_processing_scripts/bin/
		# for testing with native binaries
		- rm ivas-processing-scripts/ivas_processing_scripts/bin/IVAS*.exe
		- rm ivas-processing-scripts/ivas_processing_scripts/bin/EVS*.exe

		# build codec and put into bin dir
		- make -j
		- cp ./IVAS_* ivas-processing-scripts/ivas_processing_scripts/bin/

		# patch the use_windows_codec_binaries key (weird folding is needed so colons are accepted)
		- >
		sed -i "s/use_windows_codec_binaries: true/use_windows_codec_binaries: false/" ivas-processing-scripts/experiments/selection//config/.yml

		# run experiments test
		- cd ivas-processing-scripts
		- python3 -m pytest tests/test_experiments.py::test_generate_test_items -n auto \| tee log.txt
		artifacts:
		paths:
		- ivas-processing-scripts/experiments/selection//proc_output/.log
		- log.txt
		when: on_failure
		expire_in: 1 week

		lc3plus-ensure-no-code-changes:
		extends:
		- .test-job-linux
		- .rules-merge-request
		stage: validate
		stage: postvalidate
		needs: []
		timeout: "5 minutes"
		script:
		@@ -1034,6 +1040,40 @@ codec-comparison-on-main-push:
		reports:
		junit: report-junit.xml


		# ---------------------------------------------------------------
		# Manual jobs
		# ---------------------------------------------------------------

		test-be-to-release:
		stage: test
		tags:
		- ivas-windows
		resource_group: ivas-be-to-release-test-resource
		timeout: "20 minutes"
		rules:
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'test-be-release'
		script:

		- echo "$CI_COMMIT_BRANCH"
		- MSBuild.exe .\Workspace_msvc\Workspace_msvc.sln /property:Configuration=Debug /p:Platform=win32 /m \| tee -variable winoutdata
		- $winoutdata \| Out-File $BUILD_OUTPUT -Encoding Utf8
		- ("& python ci/check_for_warnings.py '$BUILD_OUTPUT'") \| Invoke-Expression
		- ("exit $LASTEXITCODE") \| Invoke-Expression

		# path to release candidate refs defined in config.toml

		- echo "Placeholder for BE test to release script"
		- mkdir logs

		artifacts:
		name: "test-be-to-release--sha-$CI_COMMIT_SHORT_SHA--results"
		when: always
		expire_in: 1 week
		paths:
		- logs/
		expose_as: "test-be-to-release results"

		# ---------------------------------------------------------------
		# Scheduled jobs on main
		# ---------------------------------------------------------------
		@@ -1208,15 +1248,15 @@ sanitizer-test-mc-7_1_4:
		- .sanitizer-test-template
		timeout: 6 hours

		sanitizer-test-sba:
		sanitizer-test-hoa3:
		extends: .sanitizer-test-schedule-C
		rules:
		- if: $SANITIZER_SCHEDULE_C
		script:
		- *update-ltv-repo
		- python3 ci/run_scheduled_sanitizer_test.py SBA $OUT_FORMATS_CHANNEL_BASED $OUT_FORMATS_SCENE_BASED $OUT_FORMATS_BINAURAL --tests $SANITIZER_TESTS
		- python3 ci/run_scheduled_sanitizer_test.py HOA3 $OUT_FORMATS_CHANNEL_BASED $OUT_FORMATS_SCENE_BASED $OUT_FORMATS_BINAURAL --tests $SANITIZER_TESTS

		sanitizer-test-planarsba:
		sanitizer-test-planarhoa3:
		extends: .sanitizer-test-schedule-C
		rules:
		- if: $SANITIZER_SCHEDULE_C
		@@ -1224,7 +1264,7 @@ sanitizer-test-planarsba:
		start_in: 6 hours
		script:
		- *update-ltv-repo
		- python3 ci/run_scheduled_sanitizer_test.py PlanarSBA $OUT_FORMATS_CHANNEL_BASED $OUT_FORMATS_SCENE_BASED $OUT_FORMATS_BINAURAL --tests $SANITIZER_TESTS
		- python3 ci/run_scheduled_sanitizer_test.py PlanarHOA3 $OUT_FORMATS_CHANNEL_BASED $OUT_FORMATS_SCENE_BASED $OUT_FORMATS_BINAURAL --tests $SANITIZER_TESTS

		### --- sanitizer schedule D ---

		@@ -1288,6 +1328,7 @@ coverage-test-on-main-scheduled:
		timeout: 2 hours
		script:
		- *print-common-info
		- *update-ltv-repo
		- make GCOV=1 -j
		- cp IVAS_rend IVAS_rend_ref # Copy exec to be able to run renderer script
		- python3 tests/create_short_testvectors.py
		@@ -1408,7 +1449,7 @@ complexity-sba-hoa3-in-hoa3-out:
		- *print-common-info
		- *update-ltv-repo
		- *complexity-measurements-setup
		- in_format=SBA
		- in_format=HOA3
		- out_format=HOA3
		- bash ci/complexity_measurements/getWmops.sh "$in_format" "$out_format"
		- ret_val=$?
		@@ -1473,27 +1514,6 @@ complexity-StereoDmxEVS-stereo-in-mono-out:
		# Other jobs
		# ---------------------------------------------------------------

		upload-selection-BE-log:
		rules:
		- if: $UPLOAD_SELECTION_BE_RESULTS && $CI_PIPELINE_SOURCE == 'trigger'
		when: always
		timeout: 5 minutes
		tags:
		- ericsson-windows-runner
		script:
		- cp -r $SELECTION_BE_RESULT ./selection-BE-result
		- Get-Content -Path selection-BE-result/public_log--sha-*.txt
		- $has_failed_debugging_active = (Select-String -Path selection-BE-result/public_log--sha-*.txt -Pattern '^FAILED tests' -CaseSensitive).Line
		- Get-Content -Path selection-BE-result/public_log_DEBUGGING_inactive--sha-*.txt
		- $has_failed_debugging_inactive = (Select-String -Path selection-BE-result/public_log_DEBUGGING_inactive--sha-*.txt -Pattern '^FAILED tests' -CaseSensitive).Line
		- If($has_failed_debugging_active -or $has_failed_debugging_inactive) {exit -1}
		artifacts:
		paths:
		- selection-BE-result/public_log--sha-*.txt
		- selection-BE-result/public_log_DEBUGGING_inactive--sha-*.txt
		when: always
		expire_in: 1 week

		# job that sets up gitlab pages website
		pages:
		stage: deploy

apps/decoder.c

+389 −1587

File changed.

Preview size limit exceeded, changes collapsed.

apps/renderer.c

+16 −135

File changed.

Preview size limit exceeded, changes collapsed.

ci/ivas_voip_be_test.sh

+3 −2

Original line number	Diff line number	Diff line
		@@ -63,6 +63,7 @@ fi
		modes=('SBA_b128_wb_cbr' 'MC_7_1_b96_fb_cbr' 'ISM2_b48_fb_cbr')
		output_formats=('STEREO' 'FOA' '7_1' 'HOA3')
		limit_input_to_x_seconds=30
		verbosity_cmd="-z console"

		cfg=./scripts/config/ci_linux.json
		dly_profile=./scripts/dly_error_profiles/dly_error_profile_0.dat
		@@ -71,8 +72,8 @@ output_dir_default="out"
		output_dir_voip="out_voip"

		# Run the same modes in VoIP and non-VoIP mode with a neutral delay profile
		./scripts/runIvasCodec.py -p $cfg $WORKERS -U $limit_input_to_x_seconds -m "${modes[@]}" --oc "${output_formats[@]}" -o $output_dir_default \| tee voip_be_test_output.txt
		./scripts/runIvasCodec.py -p $cfg $WORKERS -U $limit_input_to_x_seconds -m "${modes[@]}" --oc "${output_formats[@]}" -o $output_dir_voip -J "$dly_profile" \| tee -a voip_be_test_output.txt
		./scripts/runIvasCodec.py $verbosity_cmd -p $cfg $WORKERS -U $limit_input_to_x_seconds -m "${modes[@]}" --oc "${output_formats[@]}" -o $output_dir_default \| tee voip_be_test_output.txt
		./scripts/runIvasCodec.py $verbosity_cmd -p $cfg $WORKERS -U $limit_input_to_x_seconds -m "${modes[@]}" --oc "${output_formats[@]}" -o $output_dir_voip -J "$dly_profile" \| tee -a voip_be_test_output.txt

		# Check if Python scripts above failed. They return status 0 even when running a mode fails, so we have to parse log file
		if grep -iq failed voip_be_test_output.txt ; then

ci/run_evs_be_test.py

+1 −1

Original line number	Diff line number	Diff line
		@@ -54,7 +54,7 @@ def main():

		result_dict = dict()
		# run first part in parallel
		with concurrent.futures.ThreadPoolExecutor(max_workers=4) as executor:
		with concurrent.futures.ThreadPoolExecutor() as executor:
		executor.map(
		run_file, README_FILES_PARALLEL, BIN_PATHS, [result_dict] * len(README_FILES_PARALLEL)
		)