Merge with main (3ee2585f) · Commits · IVAS Codec Public Collaboration / IVAS Codec

.gitlab-ci.yml

+81 −60

Original line number	Diff line number	Diff line
		@@ -44,6 +44,52 @@ stages:
		.get-previous-merge-commit-sha: &get-previous-merge-commit-sha
		- previous_merge_commit=$(git --no-pager log --merges HEAD~1 -n 1 --pretty=format:%H)

		.merge_request_comparison_setup: &merge_request_comparison_setup
		### build test binaries, initial clean for paranoia reasons
		- make clean
		- mkdir build
		- cd build
		- cmake ..
		- make -j
		- mv IVAS_cod ../IVAS_cod_test
		- mv IVAS_dec ../IVAS_dec_test
		- cd ..
		- rm -rf build/*

		### store the current commit hash
		- source_branch_commit_sha=$(git rev-parse HEAD)

		### checkout version to compare against
		# first delete local target branch to avoid conflicts when branch is cached and there are merge conflicts during fetching
		# depending on chaching, the branch may not be there, so prevent failure of this command -> should maybe be done smarter later
		- git branch -D $CI_MERGE_REQUEST_TARGET_BRANCH_NAME \|\| true
		# needed when depth is lower than the number of commits in the branch
		- git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME:$CI_MERGE_REQUEST_TARGET_BRANCH_NAME

		### compare to last target branch commit before pipeline was created
		- target_commit=$(git log $CI_MERGE_REQUEST_TARGET_BRANCH_NAME -1 --oneline --before=${CI_PIPELINE_CREATED_AT} --format=%H)
		- git checkout $target_commit

		### build reference binaries
		- cd build
		- cmake ..
		- make -j
		- mv IVAS_cod ../IVAS_cod_ref
		- mv IVAS_dec ../IVAS_dec_ref
		- cd ..

		# rename test binaries back
		- mv IVAS_cod_test IVAS_cod
		- mv IVAS_dec_test IVAS_dec

		### re-checkout the commit from the source branch to have up-to-date self_test.py and scripts/testv (and actually everything)
		- git checkout $source_branch_commit_sha

		.merge-request-comparison-check: &merge-request-comparison-check
		- if [ $zero_errors != 1 ]; then echo "Run errors encountered!"; exit $EXIT_CODE_FAIL; fi
		- if [ $exit_code -eq 1 ] && [ $non_be_flag == 0 ]; then echo "Non-bitexact cases without non-BE tag encountered!"; exit $EXIT_CODE_FAIL; fi
		- if [ $exit_code -eq 1 ] && [ $non_be_flag != 0 ]; then echo "Non-bitexact cases with non-BE tag encountered"; exit $EXIT_CODE_NON_BE; fi
		- exit 0

		# ---------------------------------------------------------------
		# Job templates
		@@ -275,7 +321,7 @@ asan-on-merge-request-linux:


		# compare bit exactness between target and source branch
		pytest-on-merge-request:
		ivas-pytest-on-merge-request:
		extends:
		- .test-job-linux
		- .rules-merge-request
		@@ -284,85 +330,62 @@ pytest-on-merge-request:
		timeout: "10 minutes"
		script:
		- *print-common-info
		### build test binaries, initial clean for paranoia reasons
		- make clean
		- mkdir build
		- cd build
		- cmake ..
		- make -j
		- mv IVAS_cod ../IVAS_cod_test
		- mv IVAS_dec ../IVAS_dec_test
		- cd ..
		- rm -rf build/*

		### store the current commit hash
		- source_branch_commit_sha=$(git rev-parse HEAD)

		### checkout version to compare against
		# first delete local target branch to avoid conflicts when branch is cached and there are merge conflicts during fetching
		# depending on chaching, the branch may not be there, so prevent failure of this command -> should maybe be done smarter later
		- git branch -D $CI_MERGE_REQUEST_TARGET_BRANCH_NAME \|\| true
		# needed when depth is lower than the number of commits in the branch
		- git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME:$CI_MERGE_REQUEST_TARGET_BRANCH_NAME

		### compare to last target branch commit before pipeline was created
		- target_commit=$(git log $CI_MERGE_REQUEST_TARGET_BRANCH_NAME -1 --oneline --before=${CI_PIPELINE_CREATED_AT} --format=%H)
		- git checkout $target_commit

		### build reference binaries
		- cd build
		- cmake ..
		- make -j
		- mv IVAS_cod ../IVAS_cod_ref
		- mv IVAS_dec ../IVAS_dec_ref
		- cd ..

		### re-checkout the commit from the source branch to have up-to-date test scripts and test vectors (and actually everything)
		- git checkout $source_branch_commit_sha
		- *merge_request_comparison_setup

		# some helper variables - "\|\| true" to prevent failures from grep not finding anything
		- evs_non_be_flag=$(echo $CI_MERGE_REQUEST_TITLE \| grep -c --ignore-case "\[evs[ -]non[ -]be\]") \|\| true
		- non_be_flag=$(echo $CI_MERGE_REQUEST_TITLE \| grep -c --ignore-case "\[non[ -]*be\]") \|\| true
		- expected_nonbe_1=0
		- expected_nonbe_2=0
		- fail_1=0
		- fail_2=0

		### prepare pytest
		# create short test vectors
		- python3 tests/create_short_testvectors.py
		# rename test binaries back
		- mv IVAS_cod_test IVAS_cod
		- mv IVAS_dec_test IVAS_dec
		# create references
		- python3 -m pytest tests -v --update_ref 1 -m create_ref
		- python3 -m pytest tests -v --update_ref 1 -m create_ref_part2
		- python3 -m pytest tests/test_param_file.py -v --update_ref 1 -m create_ref --param_file scripts/config/self_test_evs.prm

		### run pytest
		- exit_code=0
		- python3 -m pytest tests -v --junit-xml=report-junit.xml \|\| exit_code=$?
		- zero_errors=$(cat report-junit.xml \| grep -c 'errors="0"') \|\| true

		- if [ $zero_errors != 1 ]; then echo "Run errors in pytest"; fail_1=1; fi
		- *merge-request-comparison-check

		allow_failure:
		exit_codes:
		- 123
		artifacts:
		name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--stage-$CI_JOB_STAGE--results"
		when: always
		paths:
		- report-junit.xml
		expose_as: 'pytest ivas results'
		reports:
		junit:
		- report-junit.xml

		evs-pytest-on-merge-request:
		extends:
		- .test-job-linux
		- .rules-merge-request
		stage: compare
		needs: [ "build-codec-linux-cmake", "codec-smoke-test" ]
		timeout: "10 minutes"
		script:
		- *print-common-info
		- *merge_request_comparison_setup

		- if [ $exit_code -eq 1 ] && [ $non_be_flag == 0 ]; then echo "pytest run had failures without non-BE tag encountered"; fail_1=1; fi
		- if [ $exit_code -eq 1 ] && [ $non_be_flag != 0 ]; then echo "pytest run had failures with non-BE tag encountered"; expected_nonbe_1=1; fi
		# some helper variables - "\|\| true" to prevent failures from grep not finding anything
		- non_be_flag=$(echo $CI_MERGE_REQUEST_TITLE \| grep -c --ignore-case "\[evs[ -]non[ -]be\]") \|\| true

		### prepare pytest
		# create references
		- python3 -m pytest tests/test_param_file.py -v --update_ref 1 -m create_ref --param_file scripts/config/self_test_evs.prm

		### run pytest for EVS cases
		- exit_code=0
		- python3 -m pytest tests/test_param_file.py -v --param_file scripts/config/self_test_evs.prm --junit-xml=report-junit-evs.xml \|\| exit_code=$?
		- zero_errors=$(cat report-junit-evs.xml \| grep -c 'errors="0"') \|\| true

		- if [ $zero_errors != 1 ]; then echo "Run errors in pytest for EVS"; fail_2=1; fi

		- if [ $exit_code -eq 1 ] && [ $evs_non_be_flag == 0 ]; then echo "Non-bitexact EVS cases without EVS-non-BE tag encountered"; fail_2=1; fi
		- if [ $exit_code -eq 1 ] && [ $evs_non_be_flag != 0 ]; then echo "Non-bitexact EVS cases with EVS-non-BE tag encountered"; expected_nonbe_2=1; fi

		# Check results from both tests
		- if [ $fail_1 -eq 1 ] \|\| [ $fail_2 -eq 1 ]; then exit $EXIT_CODE_FAIL; fi
		- if [ $expected_nonbe_1 -eq 1 ] \|\| [ $expected_nonbe_2 -eq 1 ]; then exit $EXIT_CODE_NON_BE; fi
		- exit 0
		- *merge-request-comparison-check

		allow_failure:
		exit_codes:
		@@ -371,12 +394,10 @@ pytest-on-merge-request:
		name: "mr-$CI_MERGE_REQUEST_IID--sha-$CI_COMMIT_SHORT_SHA--stage-$CI_JOB_STAGE--results"
		when: always
		paths:
		- report-junit.xml
		- report-junit-evs.xml
		expose_as: 'pytest results'
		expose_as: 'pytest evs results'
		reports:
		junit:
		- report-junit.xml
		- report-junit-evs.xml

apps/encoder.c

+19 −0

Original line number	Diff line number	Diff line
		@@ -120,7 +120,11 @@ typedef struct
		const char *ca_config_file;
		bool mimeOutput;

		#ifdef AGC_ENABLE_FOR_LBR
		IVAS_ENC_AGC agc;
		#else
		bool agc;
		#endif
		bool pca;
		#ifdef DEBUG_FOA_AGC
		FILE agcBitstream; / temporary */
		@@ -870,7 +874,11 @@ static void initArgStruct( EncArguments *arg )
		arg->ca_config_file = NULL;
		arg->mimeOutput = false;

		#ifdef AGC_ENABLE_FOR_LBR
		arg->agc = IVAS_ENC_AGC_UNDEFINED;
		#else
		arg->agc = IVAS_DEFAULT_AGC;
		#endif
		arg->pca = false;
		#ifdef DEBUG_FOA_AGC
		arg->agcBitstream = NULL;
		@@ -1381,7 +1389,11 @@ static bool parseCmdlIVAS_enc(
		i++;
		if ( i < argc - 4 )
		{
		#ifdef AGC_ENABLE_FOR_LBR
		arg->agc = ( atoi( argv[i] ) ) ? IVAS_ENC_AGC_ENABLED : IVAS_ENC_AGC_DISABLED;
		#else
		arg->agc = (int16_t) atoi( argv[i] );
		#endif
		if ( argv[i] == NULL \|\| atoi( argv[i] ) < 0 \|\| atoi( argv[i] ) > 1 )
		{
		fprintf( stderr, "Error: wrong adaptive gain control option specified (%d), expected 0 or 1\n\n", (int32_t) atoi( argv[i] ) );
		@@ -1636,7 +1648,14 @@ static void usage_enc( void )
		#ifdef DEBUG_SBA
		fprintf( stdout, "-tag : Tag name for intermediate debug files\n" );
		#endif
		#ifdef AGC_ENABLE_FOR_LBR
		fprintf( stdout, "-agc op : SBA Adaptive gain control, op = (0, 1). \n" );
		fprintf( stdout, " By default op is 1 (activated) for bitrates between 24400 and 32000,\n" );
		fprintf( stdout, " otherwise it is 0 (deactivated) for all other bitrates\n" );
		#else
		fprintf( stdout, "-agc op : SBA Adaptive gain control, op = (0, 1), by default op is 0 or deactivated\n" );
		#endif

		fprintf( stdout, "-bypass mode : SBA PCA by-pass, mode = (1, 2), 1 = PCA off, 2 = signal adaptive, default is 1\n" );
		#ifdef DEBUGGING
		fprintf( stdout, "-force T : Force specific mode, T = (speech, music, ACELP, GSC, TCX, HQ),\n" );

lib_com/ivas_agc_com.c

+29 −0

Original line number	Diff line number	Diff line
		@@ -40,6 +40,9 @@
		#endif
		#include <math.h>
		#include "wmops.h"
		#ifdef AGC_TUNING_IMPROVEMENT
		#include "prot.h"
		#endif

		/------------------------------------------------------------------------------------------
		* Local constants
		@@ -47,6 +50,11 @@

		#define SQRKMAX ( 1.5f )
		#define NBITS_DIFFG ( 2 )
		#ifdef AGC_TUNING_IMPROVEMENT
		#define DBSTEP ( -6.f ) /* desired dB step value in dB*/
		#define ABS_EMIN_MAX ( 3 )
		#define MAXATTEXP ( 1 ) /* the desired maximum attenuation exponent range per frame*/
		#endif

		/-----------------------------------------------------------------------------------------
		* Function ivas_agc_initWindowFunc()
		@@ -60,12 +68,22 @@ void ivas_agc_initWindowFunc(
		{
		int16_t i;
		float N;
		#ifdef AGC_TUNING_IMPROVEMENT
		float a;
		#endif

		N = (float) ( length - 1 );
		#ifdef AGC_TUNING_IMPROVEMENT
		a = 0.5f * ( 1.f - powf( 10.f, DBSTEP / 20.f ) );
		#endif

		for ( i = 0; i < length; i++ )
		{
		#ifdef AGC_TUNING_IMPROVEMENT
		pWinFunc[i] = 1.f + a * ( cosf( EVS_PI * i / N ) - 1.f );
		#else
		pWinFunc[i] = 0.75f + 0.25f * cosf( EVS_PI * i / N );
		#endif
		}

		return;
		@@ -89,7 +107,11 @@ void ivas_agc_calcGainParams(

		nbits = NBITS_DIFFG;

		#ifdef AGC_TUNING_IMPROVEMENT
		absEmin = max( ABS_EMIN_MAX, (uint16_t) ceilf( logf( ceilf( SQRKMAX numCoeffs ) ) * INV_LOG_2 ) );
		#else
		absEmin = (uint16_t) ceilf( logf( ceilf( SQRKMAX numCoeffs ) ) * INV_LOG_2 );
		#endif

		totExp = *absEmin + AGC_EMAX + 1;
		betaE = (uint16_t) ceilf( logf( totExp ) INV_LOG_2 );
		@@ -98,10 +120,17 @@ void ivas_agc_calcGainParams(

		if ( nbits > 0 )
		{
		#ifdef AGC_TUNING_IMPROVEMENT
		Bm = min( AGC_BITS_PER_CH - 1, NBITS_DIFFG );
		#else
		Bm = NBITS_DIFFG;
		#endif
		}

		*maxAttExp = ( (uint16_t) powf( 2, Bm ) ) - 2;
		#ifdef AGC_TUNING_IMPROVEMENT
		maxAttExp = min( MAXATTEXP, maxAttExp );
		#endif

		return;
		}

lib_com/ivas_cnst.h

+4 −0

Original line number	Diff line number	Diff line
		@@ -1319,7 +1319,11 @@ typedef enum
		#define PANNING_ELE_RESOLUTION 5

		#define EFAP_MAX_CHAN_NUM 5 /* Maximum number of channels that constitute a polygon, 4 or 5 */
		#ifdef ALLRAD_OPTIM
		#define EFAP_MAX_POLY_SET 50 /* Upper bound on number of polygons; with a Speaker setup of 16.0, we obtain 44 polygons/triangles in the matlab implementation. */
		#else
		#define EFAP_MAX_POLY_SET 70 /* Upper bound on number of polygons; with a Speaker setup of 26.0, we obtain 54 polygons/triangles in the matlab implementation. */
		#endif

		#define EFAP_MODE_EFAP 0 /* EFAP Panning */
		#define EFAP_MODE_EFIP 1 /* EFIP Panning */

lib_com/ivas_prot.h

+10 −1

Original line number	Diff line number	Diff line
		@@ -44,7 +44,9 @@
		#include "ivas_stat_dec.h"
		#include "ivas_stat_com.h"
		#include "ivas_error_utils.h"

		#ifdef AGC_ENABLE_FOR_LBR
		#include "lib_enc.h"
		#endif

		/* clang-format off */

		@@ -3770,6 +3772,13 @@ void ivas_sba_prototype_renderer(
		);

		/* AGC */
		#ifdef AGC_ENABLE_FOR_LBR
		int16_t ivas_agc_enc_get_enablement_flag(
		IVAS_ENC_AGC agc_configuration, /* i : configuration used when encoder was initialised from cmd line */
		int16_t nchan_transport /* i : number of transport channels */
		);
		#endif

		ivas_error ivas_spar_agc_enc_open(
		ivas_agc_enc_state_t *hAgcEnc, / i/o: AGC decoder handle */
		const int32_t input_Fs, /* i : input sampling rate */