Merge branch 'main' into 862-ubsan-out-of-bound-error-in-spar-for-osba-bitrate-switching-with-plc (d3d93a27) · Commits · IVAS Codec Public Collaboration / IVAS Codec

.gitlab-ci.yml

+2 −1

Original line number	Diff line number	Diff line
		@@ -995,8 +995,9 @@ check-first-frame-is-sid:
		- exit_code_foa=0

		# run all modes and cut bitstream to start with an SID. Use stereo output to limit runtime, test is only about decoding
		- ism_md_cmd="--ism_metadata_files /usr/local/ltv/ltvISM1.csv /usr/local/ltv/ltvISM2.csv /usr/local/ltv/ltvISM3.csv /usr/local/ltv/ltvISM4.csv"
		- modes=$(scripts/runIvasCodec.py -l \| grep dtx \| 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 --oc stereo \|\| exit_code_no_sba=$?
		- scripts/runIvasCodec.py -z console -p scripts/config/ci_linux_sidstart_test.json -m $modes -s --bs_length 200 -U 0:20 --oc stereo $ism_md_cmd \|\| 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 --oc stereo \|\| exit_code_hoa=$?
		- modes=$(scripts/runIvasCodec.py -l \| grep dtx \| grep "FOA")

ci/run_scheduled_sanitizer_test.py

+2 −2

Original line number	Diff line number	Diff line
		@@ -110,8 +110,8 @@ def get_modes(in_format: str) -> list:
		def get_md_file_command(in_format: str) -> list:

		cmd = list()
		if in_format.startswith("ISM"):
		cmd.append("--metadata_files")
		if "ISM" in in_format:
		cmd.append("--ism_metadata_files")
		md_filename = "/usr/local/ltv/ltvISM{}.csv"
		n = int(in_format[-1])
		cmd.extend([md_filename.format(i) for i in range(1, n + 1)])

ci/smoke_test.sh

+1 −1

Original line number	Diff line number	Diff line
		@@ -53,7 +53,7 @@ fi

		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"
		ism_md_cmd="--ism_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"

scripts/README.md

+37 −36

Original line number	Diff line number	Diff line
		@@ -110,57 +110,58 @@ Given output directories have a certain structure to avoid to much cluttering
		The different scripts share a common set of command line options:
		```
		-h, --help show this help message and exit
		-C [FORMAT [FORMAT ...]], --formats [FORMAT [FORMAT ...]]
		List of IVAS formats to run, default all (for possible
		choices get a list with -L
		-m [MODE [MODE ...]], --modes [MODE [MODE ...]]
		List of IVAS modes to run, default all (for possible
		choices get a list with -l
		--oc [OC_DICT [OC_DICT ...]]
		List of output formats, either a space separated list
		or a json string in single quotes
		-z [{silent,console,progress,debug,info,warning,error,critical}], --loglevel [{silent,console,progress,debug,info,warning,error,critical}]
		Either show with minimal output (default, 'silent'), or reroute log messages with levels higher than LEVEL to the console
		-g LOGFILE, --logfile LOGFILE
		log file
		-t MAX_WORKERS, --max_workers MAX_WORKERS
		use multithreading with MAX_WORKERS threads (default: number of CPUs available at the machine)
		-C [FORMAT ...], --formats [FORMAT ...]
		List of IVAS formats to run, default all (for possible choices get a list with -L
		-m [MODE ...], --modes [MODE ...]
		List of IVAS modes to run, default all (for possible choices get a list with -l
		--oc [OC_DICT ...] List of output formats, either a space separated list or a json string in single quotes
		-E "-opt1 opt2", --enc_options "-opt1 opt2"
		Additional command line options for the encoder
		(always use it in the form -E="-o -opt ...")
		Additional command line options for the encoder (always use it in the form -E="-o -opt ...")
		-D "-opt1 opt2", --dec_options "-opt1 opt2"
		Additional command line options for the decoder
		(always use it in the form -D="-o -opt ...")
		Additional command line options for the decoder (always use it in the form -D="-o -opt ...")
		--format_file FORMAT_FILE
		File name for the IVAS ivas_format dictionary to use
		(default: ivas_modes.json)
		-I [ITEM [ITEM ...]], --items [ITEM [ITEM ...]]
		List of items to be coded, allows for explicit
		definition of metadata files by grouping an item
		together with its metadata files in square brackets
		[ITEM,METADATAFILE,...]
		--metadata_files [MDFILE [MDFILE ...]]
		List of common metadata files
		-z [{silent,debug,info,warning,error,critical}], --silent [{silent,debug,info,warning,error,critical}]
		Either show with minimal output (default, 'silent'),
		or reroute log messages with levels higher than LEVEL
		to the console
		-S SRIN, --srin SRIN Input sample rate for the encoder
		File name for the IVAS ivas_format dictionary to use (default: ivas_modes_v2.json)
		-I [ITEM ...], --items [ITEM ...]
		List of items to be coded, allows for explicit definition of metadata files by grouping an item together with its metadata files in square brackets [ITEM,METADATAFILE,...]
		--ism_metadata_files [ISM_MDFILE ...]
		List of ISM metadata files
		--masa_metadata_file MASA_MDFILE
		MASA metadata file
		-S SRIN, --srin SRIN Input sample rate for the encoder (either in Hz or kHz)
		-R SROUT, --srout SROUT
		Output sample rate for the decoder
		Output sample rate for the decoder (either in Hz or kHz)
		-p CONFIG, --config CONFIG
		select site-related config as CONFIG.json
		-t [MAX_WORKERS], --max_workers [MAX_WORKERS]
		use multithreading with MAX_WORKERS threads (default:
		number of CPUs available at the machine)
		-l, --list_modes list all supported IVAS ivas_formats
		-L, --list_formats list all supported IVAS formats
		-U LIMIT_DURATION, --limit_duration LIMIT_DURATION
		limit dUration of input file to X seconds
		limit dUration by specifying start and end of input signal in seconds. Can be either a single float value (will be interpreted as length), or by giving as start: (will be interpreted as start), or by giving as start:end
		-f FER_FILE, --fer_file FER_FILE
		frame error pattern file
		-y BER_FILE, --ber_file BER_FILE
		bit error pattern file
		-J JBM_FILE, --jbm_file JBM_FILE
		jbm file
		-i INDIR, --indir INDIR
		Directory for items to be coded, either a single
		directory or a json string for different directories
		with the input formats as keys
		Directory for items to be coded, either a single directory or a json string for different directories with the input formats as keys
		--decoder_only only run the decoder
		-x FILTER_REGEX, --filter FILTER_REGEX
		Regex for filtering modes
		-s, --sidstart Cut bitstreams until the first SID frame before decoding
		-s, --sidstart Cut frames from the beginning of the encoded bit stream until the first SID frame
		--bs_length BS_LENGTH
		Cut bitstream to this (maximum) length. Is applied AFTER --sidstart processing, if this is given
		--info Ouput debug info in subfolders of /res (use with caution, this can generate a huge amount of data)
		--sofa SOFA Directory for the group B binaural renderer to look for SOFA files
		-e ENC, --enc ENC Encoder binary name (default ./IVAS_cod)
		-d DEC, --dec DEC Decoder binary name (default ./IVAS_dec)
		--fail_log_dir FAIL_LOG_DIR
		Move logs of failed modes to dir (default none)
		```

		Some notable difference exits to similar command line options of `runEvsCodec.pl` and a few new ones are added:

scripts/config/ivas_modes.json

+12 −30

Original line number	Diff line number	Diff line
		@@ -4967,7 +4967,7 @@
		"table_name": "OMASA ISM1 2TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 2,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,
		@@ -5042,7 +5042,7 @@
		"table_name": "OMASA ISM1 2TC @{table_bitrate} RS {bandwidth}",
		"nummetadata": 2,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": true,
		@@ -5081,7 +5081,7 @@
		"table_name": "OMASA ISM1 1TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 2,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,
		@@ -5129,8 +5129,7 @@
		"table_name": "OMASA ISM2 2TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 3,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,
		@@ -5204,8 +5203,7 @@
		"table_name": "OMASA ISM2 2TC @{table_bitrate} RS {bandwidth}",
		"nummetadata": 3,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": true,
		@@ -5243,8 +5241,7 @@
		"table_name": "OMASA ISM2 1TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 3,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,
		@@ -5293,9 +5290,7 @@
		"table_name": "OMASA ISM3 2TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 4,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM3.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,
		@@ -5369,9 +5364,7 @@
		"table_name": "OMASA ISM3 2TC @{table_bitrate} RS {bandwidth}",
		"nummetadata": 4,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM3.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": true,
		@@ -5409,9 +5402,7 @@
		"table_name": "OMASA ISM3 1TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 4,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM3.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,
		@@ -5460,10 +5451,7 @@
		"table_name": "OMASA ISM4 2TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 5,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM3.csv",
		"{item}_ISM4.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,
		@@ -5537,10 +5525,7 @@
		"table_name": "OMASA ISM4 2TC @{table_bitrate} RS {bandwidth}",
		"nummetadata": 5,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM3.csv",
		"{item}_ISM4.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": true,
		@@ -5578,10 +5563,7 @@
		"table_name": "OMASA ISM4 1TC @{table_bitrate} kbps {bandwidth}",
		"nummetadata": 5,
		"metadatafilenames": [
		"{item}_ISM1.csv",
		"{item}_ISM2.csv",
		"{item}_ISM3.csv",
		"{item}_ISM4.csv",
		"{item}_ISM{mdi}.csv",
		"{item}.met"
		],
		"rs": false,