Merge branch 'main' into 1809_basop_PortFlp1510 (d32190da) · Commits · SA4 / Audio / IVAS BASOP

.gitlab-ci.yml

+124 −20

Original line number	Diff line number	Diff line
		variables:
		TESTV_DIR: "/usr/local/testv"
		LTV_DIR: "/usr/local/ltv"
		EVS_BE_TEST_DIR_BASOP: "/usr/local/be_2_evs_basop"
		FLOAT_REF_BRANCH: "ivas-float-update"
		BUILD_OUTPUT: "build_output.txt"
		SCRIPTS_DIR: "/usr/local/scripts"
		EXIT_CODE_NON_BE: 123
		EXIT_CODE_FAIL: 1
		LONG_TEST_SUITE: "tests/codec_be_on_mr_nonselection tests/renderer --param_file scripts/config/self_test_ltv.prm --use_ltv"
		LONG_TEST_SUITE_NO_RENDERER: "tests/codec_be_on_mr_nonselection --param_file scripts/config/self_test_ltv.prm --use_ltv"
		SHORT_TEST_SUITE: "tests/codec_be_on_mr_nonselection"
		SHORT_TEST_SUITE_ENCODER: "tests/codec_be_on_mr_nonselection/test_param_file.py --param_file scripts/config/self_test_basop_encoder.prm"
		LONG_TEST_SUITE_ENCODER: "tests/codec_be_on_mr_nonselection/test_param_file.py --param_file scripts/config/self_test_ltv_basop_encoder.prm"
		TEST_SUITE: ""
		DISABLE_HRTF_MODEL_TESTS: ""
		# DISABLE_HRTF_MODEL_TESTS: "-k not model" #enable this declaration to disable HRTF model from file tests
		# note: GitLab cannot reference variables defined by users in the include ref:, we need to use a YAML anchor for this
		# see https://docs.gitlab.com/ci/yaml/includes/#use-variables-with-include for more information
		IVAS_CODEC_CI_REF: &IVAS_CODEC_CI_REF main

		# These path variables are used by the pytest calls.
		# They can be overwritten in the job templates to e.g. only test encoder or decoder in the chain
		@@ -100,6 +87,9 @@ workflow:
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'pytest-compare-long'
		variables:
		IVAS_PIPELINE_NAME: 'Run comparison tools against float ref (long test vectors): $CI_COMMIT_BRANCH'
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'pytest-compare-long-fx-fx'
		variables:
		IVAS_PIPELINE_NAME: 'Run comparison tools against float ref FX-FX (long test vectors): $CI_COMMIT_BRANCH'
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'pytest-compare-to-input'
		variables:
		IVAS_PIPELINE_NAME: 'Run comparison tools against input (pass-through only): $CI_COMMIT_BRANCH'
		@@ -121,6 +111,9 @@ workflow:
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'voip-be-test'
		variables:
		IVAS_PIPELINE_NAME: 'Voip BE test on $CI_COMMIT_BRANCH'
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'renderer-framesize-be'
		variables:
		IVAS_PIPELINE_NAME: 'Renderer framesize BE test on $CI_COMMIT_BRANCH'
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == 'peaq-enc-passthrough'
		variables:
		IVAS_PIPELINE_NAME: 'PEAQ encoder pass-through test: $CI_COMMIT_BRANCH'
		@@ -419,6 +412,15 @@ stages:
		- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
		when: never

		.rules-pytest-long-fx-fx:
		rules:
		- if: $PYTEST_MLD_LONG_FX_FX # Set by scheduled pipeline
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == "pytest-compare-long-fx-fx"
		- if: $CI_PIPELINE_SOURCE == 'push'
		when: never
		- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
		when: never

		.rules-coverage:
		rules:
		- if: $COVERAGE_TEST # Set by scheduled pipeline
		@@ -518,14 +520,15 @@ stages:
		.test-job-linux-needs-testv-dir:
		extends: .test-job-linux
		before_script:
		- *update-scripts-repo
		- !reference [ .job-linux, before_script ]
		- bash "${CI_PROJECT_DIR}"/ivas-codec-ci/snippets/basop/update-scripts-repo.sh
		- if [ ! -d "$TESTV_DIR" ]; then mkdir -p $TESTV_DIR; fi
		- cp -r scripts/testv/* $TESTV_DIR/

		.ivas-pytest-anchor: &ivas-pytest-anchor
		stage: test
		needs: ["build-codec-linux-make"]
		timeout: "360 minutes"
		timeout: "15 hours"
		variables:
		# keep "mld" in artifact name for backwards compatibility reasons
		CSV_ARTIFACT_NAME: "mld--$CI_JOB_NAME-$CI_JOB_ID--sha-$CI_COMMIT_SHORT_SHA.csv"
		@@ -1659,6 +1662,63 @@ check-regressions-short-dec--10db:
		- rm -rf tests/dut tests/ref
		<<: *check-regressions-pytest-anchor

		check-be-between-renderer-framesizes:
		extends:
		- .test-job-linux
		# - .rules-pytest-to-main-short
		rules:
		- if: $CI_PIPELINE_SOURCE == 'web' && $MANUAL_PIPELINE_TYPE == "renderer-framesize-be"
		stage: test
		needs: ["build-codec-linux-make"]
		script:
		- bash "${CI_PROJECT_DIR}"/ivas-codec-ci/snippets/disable-limiter.sh
		- make clean
		- make -j
		- echo "$SHORT_TEST_SUITE"

		- bash "${CI_PROJECT_DIR}"/ivas-codec-ci/snippets/basop/build-float-ref-and-dut-binaries.sh
		- python3 ci/remove_unsupported_testcases.py $PRM_FILES

		- exit_code=0
		- python3 -m pytest tests/codec_be_on_mr_nonselection --tb=no -v --ref_encoder_path ./IVAS_cod_ref --ref_decoder_path ./IVAS_dec --update_ref 1 --html=report-20ms.html --self-contained-html --junit-xml=report-junit-20ms.xml \|\| exit_code=$?

		- exit_code5=0
		- exit_code10=0
		- python3 -m pytest tests/codec_be_on_mr_nonselection --tb=no -v --ref_encoder_path ./IVAS_cod_ref --ref_decoder_path ./IVAS_dec --html=report-5ms.html --self-contained-html --junit-xml=report-junit-5ms.xml --dut_fr 5 --decoder_only \|\| exit_code5=$?
		- python3 -m pytest tests/codec_be_on_mr_nonselection --tb=no -v --ref_encoder_path ./IVAS_cod_ref --ref_decoder_path ./IVAS_dec --html=report-10ms.html --self-contained-html --junit-xml=report-junit-10ms.xml --dut_fr 10 --decoder_only \|\| exit_code10=$?

		- zero_errors5=$(cat report-junit-5ms.xml \| grep -c 'errors="0"') \|\| true
		- zero_errors10=$(cat report-junit-10ms.xml \| grep -c 'errors="0"') \|\| true
		- zero_errors=1

		- *print-results-banner
		- echo "!! Encoder command lines are in the 20ms log files only !!!"
		- if [ $exit_code -ne 0 ]; then echo "20 ms framesize run already failed with errors."; zero_errors=0; fi
		- if [ $zero_errors5 != 1 ]; then echo "run error with 5ms rendering encountered"; zero_errors=0 ; fi
		- if [ $zero_errors10 != 1 ]; then echo "run error with 10ms rendering encountered"; zero_errors=0 ; fi
		- if [ $zero_errors != 1 ]; then exit $EXIT_CODE_FAIL; fi
		- if [ $exit_code5 -ne 0 ]; then echo "Non-bitexact cases encountered with 5ms rendering!"; exit_code=1; fi
		- if [ $exit_code10 -ne 0 ]; then echo "Non-bitexact cases encountered with 10ms rendering!"; exit_code=1; fi
		- if [ $exit_code -ne 0 ]; then exit $EXIT_CODE_FAIL; fi
		artifacts:
		name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--stage-$CI_JOB_STAGE--results"
		expire_in: 1 week
		when: always
		expose_as: "pytest 5ms and 10ms vs 20ms results"
		paths:
		- report-junit-5ms.xml
		- report-5ms.html
		- report-junit-10ms.xml
		- report-10ms.html
		- report-junit-20ms.xml
		- report-20ms.html
		reports:
		junit:
		- report-junit-5ms.xml
		- report-junit-10ms.xml
		- report-junit-20ms.xml


		# ---------------------------------------------------------------
		# Short test jobs for running from web interface or schedule
		# ---------------------------------------------------------------
		@@ -1902,6 +1962,49 @@ ivas-pytest-compare_ref-long-dec-lev+10:
		- SPLIT_COMPARISON="true"
		<<: *ivas-pytest-anchor

		ivas-pytest-compare_ref-long-fx-fx:
		extends:
		- .rules-pytest-long-fx-fx
		- .test-job-linux
		tags:
		- ivas-linux
		before_script:
		- USE_LTV=1
		- REF_ENCODER_PATH=./$DUT_ENCODER_PATH
		- TEST_SUITE="$LONG_TEST_SUITE_NO_RENDERER"
		- LEVEL_SCALING=1.0
		- SPLIT_COMPARISON="true"
		<<: *ivas-pytest-anchor

		ivas-pytest-compare_ref-long-fx-fx-lev-10:
		extends:
		- .rules-pytest-long-fx-fx
		- .test-job-linux
		tags:
		- ivas-linux
		before_script:
		- USE_LTV=1
		- REF_ENCODER_PATH=./$DUT_ENCODER_PATH
		- TEST_SUITE="$LONG_TEST_SUITE_NO_RENDERER"
		- LEVEL_SCALING=0.3162
		- SPLIT_COMPARISON="true"
		<<: *ivas-pytest-anchor

		ivas-pytest-compare_ref-long-fx-fx-lev+10:
		extends:
		- .rules-pytest-long-fx-fx
		- .test-job-linux
		tags:
		- ivas-linux
		before_script:
		- USE_LTV=1
		- REF_ENCODER_PATH=./$DUT_ENCODER_PATH
		- TEST_SUITE="$LONG_TEST_SUITE_NO_RENDERER"
		- LEVEL_SCALING=3.162
		- SPLIT_COMPARISON="true"
		<<: *ivas-pytest-anchor


		ivas-smoke-test-saturation:
		extends:
		- .rules-pytest-saturation-smoke-test
		@@ -2690,8 +2793,9 @@ pages:
		rules:
		- if: $UPDATE_PAGES
		script:
		- *print-common-info
		- *update-scripts-repo
		- !reference [ .job-linux, before_script ]
		- bash "${CI_PROJECT_DIR}"/ivas-codec-ci/snippets/print-common-info.sh
		- bash "${CI_PROJECT_DIR}"/ivas-codec-ci/snippets/basop/update-scripts-repo.sh
		- python3 ci/setup_pages.py
		- ls
		- ls -lh public

.gitlab-ci/variables.yml

+2 −0

Original line number	Diff line number	Diff line
		@@ -54,6 +54,7 @@ variables:
		- 'pytest-compare'
		- 'pytest-compare-enc-dmx'
		- 'pytest-compare-long'
		- 'pytest-compare-long-fx-fx'
		- 'pytest-compare-to-input'
		- 'pytest-saturation-smoke-test'
		- 'evs-26444'
		@@ -62,4 +63,5 @@ variables:
		- 'complexity'
		- 'coverage'
		- 'voip-be-test'
		- 'renderer-framesize-be'
		- 'peaq-enc-passthrough'

apps/decoder.c

+95 −0

Original line number	Diff line number	Diff line
		@@ -2830,7 +2830,14 @@ static ivas_error decodeVoIP(
		}
		vec_pos_update = ( vec_pos_update + 1 ) % vec_pos_len;
		frame++;
		#ifdef NONBE_FIX_864_JBM_RENDER_FRAMESIZE
		if ( vec_pos_update == 0 )
		{
		systemTime_ms += vec_pos_len * systemTimeInc_ms;
		}
		#else
		systemTime_ms += systemTimeInc_ms;
		#endif

		#ifdef WMOPS
		update_mem();
		@@ -2838,6 +2845,94 @@ static ivas_error decodeVoIP(
		#endif
		}


		#ifdef NONBE_FIX_864_JBM_RENDER_FRAMESIZE
		int16_t nSamplesFlushed = 0;

		/* decode and get samples */
		#ifdef SPLIT_REND_WITH_HEAD_ROT
		if ( ( error = IVAS_DEC_Flush( hIvasDec, nOutSamples, IVAS_DEC_PCM_INT16, (void *) pcmBuf, &nSamplesFlushed ) ) != IVAS_ERR_OK )
		#else
		if ( ( error = IVAS_DEC_Flush( hIvasDec, nOutSamples, pcmBuf, &nSamplesFlushed ) ) != IVAS_ERR_OK )
		#endif
		{
		fprintf( stderr, "\nError in IVAS_DEC_VoIP_Flush: %s\n", IVAS_DEC_GetErrorMessage( error ) );
		goto cleanup;
		}

		if ( nSamplesFlushed )
		{
		/* Write current frame */
		if ( ( error = AudioFileWriter_write( afWriter, pcmBuf, nSamplesFlushed * nOutChannels ) ) != IVAS_ERR_OK )
		{
		fprintf( stderr, "\nOutput audio file writer error\n" );
		goto cleanup;
		}

		/* Write ISm metadata to external file(s) */
		if ( decodedGoodFrame && arg.outputConfig == IVAS_AUDIO_CONFIG_EXTERNAL )
		{
		if ( bsFormat == IVAS_DEC_BS_OBJ \|\| bsFormat == IVAS_DEC_BS_MASA_ISM \|\| bsFormat == IVAS_DEC_BS_SBA_ISM )
		{
		if ( ( error = IVAS_DEC_GetNumObjects( hIvasDec, &numObj ) ) != IVAS_ERR_OK )
		{
		fprintf( stderr, "\nError in IVAS_DEC_GetNumObjects: %s\n", IVAS_DEC_GetErrorMessage( error ) );
		goto cleanup;
		}

		for ( i = 0; i < numObj; ++i )
		{
		IVAS_ISM_METADATA IsmMetadata;

		if ( ( error = IVAS_DEC_GetObjectMetadata( hIvasDec, &IsmMetadata, 0, i ) ) != IVAS_ERR_OK )
		{
		fprintf( stderr, "\nError in IVAS_DEC_GetObjectMetadata: %s\n", IVAS_DEC_GetErrorMessage( error ) );
		goto cleanup;
		}

		if ( ( IsmFileWriter_writeFrame( IsmMetadata, ismWriters[i] ) ) != IVAS_ERR_OK )
		{
		fprintf( stderr, "\nError writing ISM metadata to file %s\n", IsmFileWriter_getFilePath( ismWriters[i] ) );
		goto cleanup;
		}
		}
		}

		if ( bsFormat == IVAS_DEC_BS_MASA \|\| bsFormat == IVAS_DEC_BS_MASA_ISM )
		{
		IVAS_MASA_DECODER_EXT_OUT_META_HANDLE hMasaExtOutMeta;
		#ifdef NONBE_FIX_984_OMASA_EXT_OUTPUT
		int16_t fullDelayNumSamples[3];
		float delayMs;

		/* delayNumSamples is zeroed, and delayNumSamples_orig is updated only on first good frame, so need to re-fetch delay info */
		if ( ( error = IVAS_DEC_GetDelay( hIvasDec, fullDelayNumSamples, &delayTimeScale ) ) != IVAS_ERR_OK )
		{
		fprintf( stderr, "\nUnable to get delay of decoder: %s\n", ivas_error_to_string( error ) );
		}
		#endif
		if ( ( error = IVAS_DEC_GetMasaMetadata( hIvasDec, &hMasaExtOutMeta, 0 ) ) != IVAS_ERR_OK )
		{
		fprintf( stderr, "\nError in IVAS_DEC_GetMasaMetadata: %s\n", IVAS_DEC_GetErrorMessage( error ) );
		goto cleanup;
		}

		#ifdef NONBE_FIX_984_OMASA_EXT_OUTPUT
		delayMs = (float) ( fullDelayNumSamples[0] ) / (float) ( delayTimeScale );
		if ( ( error = MasaFileWriter_writeFrame( masaWriter, hMasaExtOutMeta, &delayMs ) ) != IVAS_ERR_OK )
		#else
		if ( ( error = MasaFileWriter_writeFrame( masaWriter, hMasaExtOutMeta ) ) != IVAS_ERR_OK )
		#endif
		{
		fprintf( stderr, "\nError writing MASA metadata to file: %s\n", MasaFileWriter_getFilePath( masaWriter ) );
		goto cleanup;
		}
		}
		}
		}
		#endif


		/------------------------------------------------------------------------------------------
		* Add zeros at the end to have equal length of synthesized signals
		------------------------------------------------------------------------------------------/

apps/encoder.c

+1 −6

Original line number	Diff line number	Diff line
		@@ -758,12 +758,7 @@ int main(
		}

		/* * Encode one frame * */
		if ( ( error = IVAS_ENC_EncodeFrameToSerial( hIvasEnc, pcmBuf, pcmBufSize, bitStream, &numBits
		#ifdef DBG_BITSTREAM_ANALYSIS
		,
		frame
		#endif
		) ) != IVAS_ERR_OK )
		if ( ( error = IVAS_ENC_EncodeFrameToSerial( hIvasEnc, pcmBuf, pcmBufSize, bitStream, &numBits ) ) != IVAS_ERR_OK )
		{
		fprintf( stderr, "\nencodeFrame failed: %s\n\n", IVAS_ENC_GetErrorMessage( error ) );
		goto cleanup;

apps/renderer.c

+35 −0

Original line number	Diff line number	Diff line
		@@ -3555,6 +3555,41 @@ static void parseCombinedFormatInput(
		return;
		}

		static void parseCombinedFormatInput(
		InputConfig *inConfig,
		char **configString )
		{
		IVAS_AUDIO_CONFIG audioConfig;
		audioConfig = parseAudioConfig( *configString );

		if ( audioConfig == IVAS_AUDIO_CONFIG_FOA \|\| audioConfig == IVAS_AUDIO_CONFIG_HOA2 \|\| audioConfig == IVAS_AUDIO_CONFIG_HOA3 )
		{
		/* OSBA */
		inConfig->numAmbisonicsBuses = 1;
		inConfig->ambisonicsBuses[0].audioConfig = audioConfig;
		inConfig->ambisonicsBuses[0].inputChannelIndex = inConfig->numAudioObjects;
		inConfig->ambisonicsBuses[0].gain_dB = -6.f;
		*configString += 4;

		/* Modify input gain for objects too */
		for ( int16_t i = 0; i < inConfig->numAudioObjects; ++i )
		{
		inConfig->audioObjects[i].gain_dB = -6.f;
		}
		}
		else if ( audioConfig == IVAS_AUDIO_CONFIG_MASA1 \|\| audioConfig == IVAS_AUDIO_CONFIG_MASA2 )
		{
		/* OMASA */
		inConfig->numMasaBuses = 1;
		inConfig->masaBuses[0].audioConfig = audioConfig;
		inConfig->masaBuses[0].inputChannelIndex = inConfig->numAudioObjects;
		inConfig->masaBuses[0].gain_dB = 0.0f;
		*configString += 5;
		}

		return;
		}

		static ivas_error parseCustomLayoutFile(
		const char *filePath,
		IVAS_CUSTOM_LS_DATA *pLsSetupCustom )