Merge branch 'main' into 708-aeid-command-line-options-robustness (76641541) · Commits · IVAS Codec Public Collaboration / IVAS Codec

.gitlab-ci.yml

+56 −85

Original line number	Diff line number	Diff line
		@@ -38,10 +38,11 @@ workflow:
		stages:
		- .pre
		- maintenance
		- prevalidate
		- build
		- test
		- compare
		- validate
		- postvalidate
		- deploy

		# ---------------------------------------------------------------
		@@ -133,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
		# ---------------------------------------------------------------
		@@ -179,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
		@@ -236,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
		@@ -370,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:
		@@ -392,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:
		@@ -414,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
		@@ -530,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
		@@ -611,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
		@@ -674,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
		@@ -726,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
		@@ -770,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
		@@ -783,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:
		@@ -830,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
		@@ -841,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:
		@@ -857,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:
		@@ -1256,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
		@@ -1272,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 ---

		@@ -1457,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=$?
		@@ -1522,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

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_scheduled_sanitizer_test.py

+2 −0

Original line number	Diff line number	Diff line
		@@ -115,6 +115,8 @@ def run_check(in_format: str, out_formats: list, tests: list, run_fec: bool = Tr
		DURATION,
		"-p",
		CFG,
		"-z",
		"console",
		"--checks",
		*tests,
		"-m",

ci/smoke_test.sh

+10 −9

Original line number	Diff line number	Diff line
		@@ -57,6 +57,7 @@ cfg=./scripts/config/ci_linux.json
		dly_profile=./scripts/dly_error_profiles/dly_error_profile_10.dat
		ism_md_cmd="--metadata_files /usr/local/ltv/ltvISM1.csv /usr/local/ltv/ltvISM2.csv /usr/local/ltv/ltvISM3.csv /usr/local/ltv/ltvISM4.csv"
		duration_arg="-U 1:2"
		verbosity_cmd="-z console"

		if [ $BUILD -eq 1 ];then
		# Enable memory macros to find unbalanced memory allocations/deallocations
		@@ -84,37 +85,37 @@ echo "\n======================= 0. preparing combined format test inputs =======
		ism_modes=$(./scripts/runIvasCodec.py -l \| grep ^ISM)
		non_ism_modes=$(./scripts/runIvasCodec.py -l \| grep -v ^ISM)
		echo "\n======================= 1. non-ism modes no FEC =======================\n\n"
		./scripts/runIvasCodec.py -m $non_ism_modes -p $cfg $duration_arg $WORKERS \| tee smoke_test_output.txt
		./scripts/runIvasCodec.py $verbosity_cmd -m $non_ism_modes -p $cfg $duration_arg $WORKERS \| tee smoke_test_output.txt
		echo "\n======================= 2. ism modes no FEC =======================\n\n"
		./scripts/runIvasCodec.py -m $ism_modes -p $cfg $duration_arg $WORKERS $ism_md_cmd \| tee smoke_test_output.txt
		./scripts/runIvasCodec.py $verbosity_cmd -m $ism_modes -p $cfg $duration_arg $WORKERS $ism_md_cmd \| tee smoke_test_output.txt
		# run the decoding again, but with 15% frame loss
		echo "\n======================= 3. all modes with FEC =======================\n\n"
		./scripts/runIvasCodec.py -p $cfg $duration_arg $WORKERS -D="-fec 15" --decoder_only \| tee smoke_test_output_plc.txt
		./scripts/runIvasCodec.py $verbosity_cmd -p $cfg $duration_arg $WORKERS -D="-fec 15" --decoder_only \| tee smoke_test_output_plc.txt

		# run JBM modes - EXT is excluded as not supported yet
		# OMASA disabled for now
		modes_with_no_ext_out=$(./scripts/runIvasCodec.py -l \| grep -v ^MASA \| grep -v ^ISM \| grep -v OMASA)
		modes_with_ext_out=$(./scripts/runIvasCodec.py -l \| grep 'MASA\\|ISM' \| grep -v ^ISM+ \| grep -v OMASA)
		echo "\n======================= 4. JBM, modes with no EXT =======================\n\n"
		./scripts/runIvasCodec.py -m $modes_with_no_ext_out -p $cfg $duration_arg $WORKERS --decoder_only --jbm_file $dly_profile \| tee smoke_test_output_jbm_noEXT.txt
		./scripts/runIvasCodec.py $verbosity_cmd -m $modes_with_no_ext_out -p $cfg $duration_arg $WORKERS --decoder_only --jbm_file $dly_profile \| tee smoke_test_output_jbm_noEXT.txt
		echo "\n======================= 5. JBM, modes with EXT =======================\n\n"
		./scripts/runIvasCodec.py -m $modes_with_ext_out -p $cfg $duration_arg $WORKERS --decoder_only --jbm_file $dly_profile --oc BINAURAL BINAURAL_ROOM_IR mono stereo FOA HOA3 5_1 7_1_4 \| tee -a smoke_test_output_jbm_noEXT.txt
		./scripts/runIvasCodec.py $verbosity_cmd -m $modes_with_ext_out -p $cfg $duration_arg $WORKERS --decoder_only --jbm_file $dly_profile --oc BINAURAL BINAURAL_ROOM_IR mono stereo FOA HOA3 5_1 7_1_4 \| tee -a smoke_test_output_jbm_noEXT.txt

		# run all modes with binaural output using external files
		modes_with_bin_out="SBA PlanarSBA MASA MC ISM1 ISM2 ISM3 ISM4"
		modes_with_bin_out="FOA HOA2 HOA3 PlanarFOA PlanarHOA2 PlanarHOA3 MASA MC ISM1 ISM2 ISM3 ISM4"
		bin_out_modes="BINAURAL BINAURAL_ROOM_IR"

		echo "\n======================= 6. binaural out with HRTF files - WB =======================\n\n"
		wb_modes=$(./scripts/runIvasCodec.py -l -C $modes_with_bin_out \| grep _wb_)
		hrtf_wb="../scripts/binauralRenderer_interface/binaural_renderers_hrtf_data/ivas_binaural_16kHz.bin"
		./scripts/runIvasCodec.py -p $cfg -m $wb_modes $duration_arg $WORKERS -D="-hrtf ${hrtf_wb}" --decoder_only --oc $bin_out_modes \| tee -a smoke_test_output_hrtf.txt
		./scripts/runIvasCodec.py $verbosity_cmd -p $cfg -m $wb_modes $duration_arg $WORKERS -D="-hrtf ${hrtf_wb}" --decoder_only --oc $bin_out_modes \| tee -a smoke_test_output_hrtf.txt

		echo "\n======================= 7. binaural out with HRTF files - SWB =======================\n\n"
		swb_modes=$(./scripts/runIvasCodec.py -l -C $modes_with_bin_out \| grep _swb_)
		hrtf_swb="../scripts/binauralRenderer_interface/binaural_renderers_hrtf_data/ivas_binaural_32kHz.bin"
		./scripts/runIvasCodec.py -p $cfg -m $swb_modes $duration_arg $WORKERS -D="-hrtf ${hrtf_swb}" --decoder_only --oc $bin_out_modes \| tee -a smoke_test_output_hrtf.txt
		./scripts/runIvasCodec.py $verbosity_cmd -p $cfg -m $swb_modes $duration_arg $WORKERS -D="-hrtf ${hrtf_swb}" --decoder_only --oc $bin_out_modes \| tee -a smoke_test_output_hrtf.txt

		echo "\n======================= 8. binaural out with HRTF files - FB =======================\n\n"
		fb_modes=$(./scripts/runIvasCodec.py -l -C $modes_with_bin_out \| grep _fb_)
		hrtf_fb="../scripts/binauralRenderer_interface/binaural_renderers_hrtf_data/ivas_binaural_48kHz.bin"
		./scripts/runIvasCodec.py -p $cfg -m $fb_modes $duration_arg $WORKERS -D="-hrtf ${hrtf_fb}" --decoder_only --oc $bin_out_modes \| tee -a smoke_test_output_hrtf.txt
		./scripts/runIvasCodec.py $verbosity_cmd -p $cfg -m $fb_modes $duration_arg $WORKERS -D="-hrtf ${hrtf_fb}" --decoder_only --oc $bin_out_modes \| tee -a smoke_test_output_hrtf.txt

scripts/config/ivas_modes.json

+684 −30

File changed.

Preview size limit exceeded, changes collapsed.