Merge branch 'main' into 'generated-condition-renaming' (90e256cb) · Commits · IVAS Codec Public Collaboration / IVAS Processing Scripts

.gitlab-ci.yml

+34 −3

Original line number	Diff line number	Diff line
		@@ -6,6 +6,16 @@ default:
		interruptible: true


		workflow:
		rules:
		# see https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines
		- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
		when: never
		- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
		- if: $CI_PIPELINE_SOURCE == 'push'
		- if: $CI_PIPELINE_SOURCE == 'web' # for testing


		stages:
		- check
		- test
		@@ -14,10 +24,10 @@ stages:

		# print some info on the runner setup
		.print-common-info: &print-common-info
		- echo "--------------------------------------------\n"
		- echo "--------------------------------------------"
		- python3 --version
		- pip3 freeze \| grep "numpy\\|scipy\\|YAML\\|pytest\\|black\\|isort\\|flake8"
		- echo "--------------------------------------------\n\n"
		- echo "--------------------------------------------"


		# script anchor for updating the codec repo
		@@ -26,7 +36,12 @@ stages:
		# NOTE: CODEC_DIR has to be in PATH
		- cd $CODEC_DIR
		# make sure that we are at latest main
		- git pull
		# TODO: temporarily use the RC1a tag
		- git restore .
		- git checkout 20230511-RC1a-listening-tests
		- echo "--------------------------------------------"
		- echo "Building codec on commit $(git rev-parse HEAD --short)"
		- echo "--------------------------------------------"
		# only builds if code has actually changed
		- make -j
		- cd $dir
		@@ -57,9 +72,23 @@ test_audiotools_convert:
		- *print-common-info
		- python3 -m pytest -n auto tests/test_audiotools_convert.py

		# run the test configs for the selection experiments
		experiments:
		stage: test
		tags:
		- linux
		script:
		- *print-common-info
		- *get-codec-binaries
		- python3 -m pytest -n auto tests/test_experiments.py

		# run some test configs for item creation
		test_processing:
		stage: test
		rules:
		- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
		- if: $CI_PIPELINE_SOURCE == 'push'
		when: never
		tags:
		- linux
		script:
		@@ -73,6 +102,7 @@ test_processing:

		lint:
		stage: analyze
		needs: []
		tags:
		- linux
		allow_failure: true
		@@ -81,6 +111,7 @@ lint:

		format:
		stage: analyze
		needs: []
		variables:
		ARTIFACT_BASE_NAME: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--formatting-fix"
		ARTIFACT_FOLDER: "formatting-patch"

README.md

+6 −3

Original line number	Diff line number	Diff line
		@@ -239,10 +239,13 @@ input:
		# preamble_noise: true
		### Additive background noise
		# background_noise:
		### REQUIRED: SNR for background noise in dB
		### SNR for background noise in dB; REQUIRED for prerecorded background noise and ignored for low level noise
		# snr: 10
		### REQUIRED: Path to background noise, must have same format and sampling rate as input signal(s)
		### REQUIRED: Either background noise path or low level noise flag
		### Path to background noise, must have same format and sampling rate as input signal(s); default = null
		# background_noise_path: ".../noise.wav"
		### Flag for using low level [-4,+4] background noise; default = false
		# low_level_noise: true
		```

		</details>
		@@ -513,7 +516,7 @@ The following additional executables are needed for the different processing ste

		\| Processing step \| Executable \| Where to find \|
		\|-------------------------------------------------\|-----------------------\|-------------------------------------------------------------------------------------------------------------\|
		\| Loudness measurement and adjustment \| bs1770demo \| https://github.com/openitu/STL \|
		\| Loudness measurement and adjustment \| bs1770demo \| https://github.com/ErikNorvell-Ericsson/STL (Note branch) \|
		\| MNRU \| p50fbmnru \| https://github.com/openitu/STL \|
		\| ESDRU \| esdru \| https://github.com/openitu/STL \|
		\| Frame error pattern application \| eid-xor \| https://github.com/openitu/STL \|

examples/TEMPLATE.yml

+5 −2

Original line number	Diff line number	Diff line
		@@ -110,10 +110,13 @@ input:
		# preamble_noise: true
		### Additive background noise
		# background_noise:
		### REQUIRED: SNR for background noise in dB
		### SNR for background noise in dB; REQUIRED for prerecorded background noise and ignored for low level noise
		# snr: 10
		### REQUIRED: Path to background noise, must have same format and sampling rate as input signal(s)
		### REQUIRED: Either background noise path or low level noise flag
		### Path to background noise, must have same format and sampling rate as input signal(s); default = null
		# background_noise_path: ".../noise.wav"
		### Flag for using low level [-4,+4] background noise; default = false
		# low_level_noise: true

		#################################################
		### Bitstream processing

experiments/selection/BS1534-1a/config/BS1534-1a.yml

0 → 100644

+96 −0

Original line number	Diff line number	Diff line
		---
		################################################
		# General configuration
		################################################

		name: BS1534-1a
		master_seed: 5
		prerun_seed: 2

		input_path: "experiments/selection/BS1534-1a/proc_input"
		output_path: "experiments/selection/BS1534-1a/proc_output"

		################################################
		### Input configuration
		################################################
		input:
		fmt: "STEREO"
		fs: 48000

		################################################
		### Pre-processing on individual items
		################################################
		preprocessing:
		mask: "20KBP"
		loudness: -26
		window: 100

		################################################
		### Pre-processing on whole signal(s)
		################################################
		preprocessing_2:
		concatenate_input: true
		# concatenation_order: []
		preamble: 10000
		preamble_noise: true

		#################################################
		### Bitstream processing
		#################################################

		################################################
		### Configuration for conditions under test
		################################################
		conditions_to_generate:
		### Reference and anchor conditions ##########################
		c01:
		type: ref
		c02:
		type: lp7k

		### EVS condition ################################
		c03:
		type: evs
		bitrates:
		- 24400
		cod:
		opts: ["-max_band", "FB"]
		dec:
		c04:
		type: evs
		bitrates:
		- 32000
		cod:
		opts: ["-max_band", "FB"]
		dec:
		c05:
		type: evs
		bitrates:
		- 48000
		cod:
		opts: ["-max_band", "FB"]
		dec:

		### IVAS condition ###############################
		c06:
		type: ivas
		bitrates:
		- 48000
		cod:
		dec:
		fmt: "STEREO"
		c7:
		type: ivas
		bitrates:
		- 64000
		cod:
		dec:
		fmt: "STEREO"

		################################################
		### Post-processing
		################################################
		postprocessing:
		fmt: "STEREO"
		fs: 48000
		loudness: -26

experiments/selection/BS1534-1b/config/BS1534-1b.yml

0 → 100644

+111 −0

Original line number	Diff line number	Diff line
		---
		################################################
		# General configuration
		################################################

		name: BS1534-1b
		master_seed: 5
		prerun_seed: 2

		input_path: "experiments/selection/BS1534-1b/proc_input"
		output_path: "experiments/selection/BS1534-1b/proc_output"

		################################################
		### Input configuration
		################################################
		input:
		fmt: "STEREO"
		fs: 48000

		################################################
		### Pre-processing on individual items
		################################################
		preprocessing:
		mask: "20KBP"
		loudness: -26
		window: 100

		################################################
		### Pre-processing on whole signal(s)
		################################################
		preprocessing_2:
		concatenate_input: true
		# concatenation_order: []
		preamble: 10000
		preamble_noise: true

		#################################################
		### Bitstream processing
		#################################################

		################################################
		### Configuration for conditions under test
		################################################
		conditions_to_generate:
		### Reference and anchor conditions ##########################
		c01:
		type: ref
		c02:
		type: lp7k

		### EVS condition ################################
		c03:
		type: evs
		bitrates:
		- 48000
		cod:
		opts: ["-max_band", "FB"]
		dec:
		tx:
		type: "FER"
		error_rate: 5
		c04:
		type: evs
		bitrates:
		- 64000
		cod:
		opts: ["-max_band", "FB"]
		dec:
		tx:
		type: "FER"
		error_rate: 5
		c05:
		type: evs
		bitrates:
		- 96000
		cod:
		opts: ["-max_band", "FB"]
		dec:
		tx:
		type: "FER"
		error_rate: 5

		### IVAS condition ###############################
		c06:
		type: ivas
		bitrates:
		- 96000
		cod:
		dec:
		fmt: "STEREO"
		tx:
		type: "FER"
		error_rate: 5
		c7:
		type: ivas
		bitrates:
		- 128000
		cod:
		dec:
		fmt: "STEREO"
		tx:
		type: "FER"
		error_rate: 5

		################################################
		### Post-processing
		################################################
		postprocessing:
		fmt: "STEREO"
		fs: 48000
		loudness: -26