Reverb control metadata parser extension to support early reflections (2e820810) · Commits · IVAS Codec Public Collaboration / IVAS Codec

lib_com/options.h

+4 −1

Original line number	Diff line number	Diff line
		@@ -141,7 +141,10 @@
		#endif
		#define DISABLE_ADAP_RES_COD_TMP /* temporary fix for IVAS-403, disables adaptive residual coding */
		/#define FIX_I4_OL_PITCH/ /* fix open-loop pitch used for EVS core switching */
		#define CONTROL_METADATA_REVERB /* Philips: renderer configuration change to binary format */
		#define CONTROL_METADATA_REVERB /* Philips: reverb configuration change to binary format */
		#ifdef CONTROL_METADATA_REVERB
		#define CONTROL_METADATA_EARLY_REFLECTIONS /* Philips/Qualcomm: early reflections extension to reverb configuration */
		#endif
		#define COMMAND_LINE_OPTION_LATE_REVERB /* Philips: late reverb command line option */
		#define FIX_ISM_DTX_CNG_BWIDTH_ALT /* VA: issue 396 - alternative fix for bw changes on CNG frames in ISM DTX for objects that use the decoder-side noise estimation */

lib_util/render_config_reader.c

+371 −11

Original line number	Diff line number	Diff line
		@@ -48,6 +48,8 @@
		#define MAX_LINE_LENGTH ( 1024 )
		#define MAX_ITEM_LENGTH ( 64 )
		#define N_REVERB_VECTORS ( 3 )
		#else
		#define N_ABS_COEFFS ( 6 )
		#endif

		#define SHORTEST_REV_DEL_LINE ( 0.015f )
		@@ -84,13 +86,26 @@ typedef enum _FREQ_GRID_MODE
		FREQ_GRID_MODE_DEFAULT_BANDING = 2
		} FREQ_GRID_MODE;

		#ifdef CONTROL_METADATA_EARLY_REFLECTIONS
		typedef struct
		{
		IVAS_VECTOR3 dimensions; /* Room dimensions [m] */
		FrequencyGrid pFG; / Pointer to a frequency grid for absorption coeffs */
		float ( pAbsCoeff )[N_ABS_COEFFS]; / Absorption coeffs table pointer */
		IVAS_VECTOR3 pListenerOrigin; / Listener origin */
		} EarlyReflectionsConfig;
		#endif

		typedef struct
		{
		uint32_t id; /* Acoustic environment ID */
		FrequencyGrid pFG; / Pointer into Frequency grids table */
		FrequencyGrid pFG; / Pointer into Frequency grids table for late reverb coeffs */
		float pRT60; / RT60 table */
		float pDSR; / DSR table */
		float preDelay; /* Pre-delay */
		#ifdef CONTROL_METADATA_EARLY_REFLECTIONS
		EarlyReflectionsConfig pEarlyReflections; / Early reflections configuration */
		#endif
		} AcousticEnv;

		struct RenderConfigReader
		@@ -121,6 +136,11 @@ typedef enum _RC_LUT
		RC_LUT_FREQ,
		RC_LUT_FREQ_HOP,
		RC_LUT_DSR,
		RC_LUT_METERS,
		RC_LUT_HECTOMETERS,
		RC_LUT_KILOMETERS,
		RC_LUT_CENTIMETERS,
		RC_LUT_ABSORPTION
		} RC_LUT;

		/------------------------------------------------------------------------------------------
		@@ -223,9 +243,9 @@ const float lutFreq_Value[] = {
		const uint16_t lutFreq_Code[] = { 35, 14, 15, 9, 12, 13, 0, 26, 27, 1, 24, 25, 14, 30, 31, 15, 28, 29, 12, 18, 19, 13, 16, 17, 10, 22, 23, 11, 20, 21, 2, 16, 138, 139, 68 };
		const uint8_t lutFreq_Len[] = { 6, 6, 6, 4, 6, 6, 4, 6, 6, 4, 6, 6, 4, 6, 6, 4, 6, 6, 4, 6, 6, 4, 6, 6, 4, 6, 6, 4, 6, 6, 4, 5, 8, 8, 7 };

		const float lutFreqHop_Value[] = { 1.090507733f, 1.104089514f, 1.122462048f, 1.148698355f, 1.189207115f, 1.25992105f, 1.414213562f, 2.0f, 4.0f };
		const uint16_t lutFreqHop_Code[] = { 12, 13, 2, 3, 0, 1, 1, 2, 7 };
		const uint8_t lutFreqHop_Len[] = { 4, 4, 4, 4, 4, 2, 4, 2, 3 };
		const float lutFreqHop_Value[] = { 1.059463094f, 1.122462048f, 1.189207115f, 1.259921050f, 1.414213562f, 2.0f, 4.0f };
		const uint16_t lutFreqHop_Code[] = { 2, 3, 0, 1, 1, 3, 2 };
		const uint8_t lutFreqHop_Len[] = { 4, 4, 4, 2, 4, 2, 2 };

		const float lutDsr_Value[] = {
		-150.0f, -149.0f, -148.0f, -147.0f, -146.0f, -145.0f, -144.0f, -143.0f, -142.0f, -141.0f,
		@@ -265,6 +285,96 @@ const uint8_t lutDsr_Len[] = {
		8
		};

		const float lutMeters_Value[] = {
		0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f,
		10.0f, 11.0f, 12.0f, 13.0f, 14.0f, 15.0f, 16.0f, 17.0f, 18.0f, 19.0f,
		20.0f, 21.0f, 22.0f, 23.0f, 24.0f, 25.0f, 26.0f, 27.0f, 28.0f, 29.0f,
		30.0f, 31.0f, 32.0f, 33.0f, 34.0f, 35.0f, 36.0f, 37.0f, 38.0f, 39.0f,
		40.0f, 41.0f, 42.0f, 43.0f, 44.0f, 45.0f, 46.0f, 47.0f, 48.0f, 49.0f,
		50.0f, 51.0f, 52.0f, 53.0f, 54.0f, 55.0f, 56.0f, 57.0f, 58.0f, 59.0f,
		60.0f, 61.0f, 62.0f, 63.0f, 64.0f, 65.0f, 66.0f, 67.0f, 68.0f, 69.0f,
		70.0f, 71.0f, 72.0f, 73.0f, 74.0f, 75.0f, 76.0f, 77.0f, 78.0f, 79.0f,
		80.0f, 81.0f, 82.0f, 83.0f, 84.0f, 85.0f, 86.0f, 87.0f, 88.0f, 89.0f,
		90.0f, 91.0f, 92.0f, 93.0f, 94.0f, 95.0f, 96.0f, 97.0f, 98.0f, 99.0f
		};

		const uint16_t lutMeters_Code[] = {
		61, 50, 51, 48, 49, 54, 55, 52, 53, 10,
		11, 8, 9, 14, 15, 12, 13, 2, 3, 0,
		1, 6, 7, 4, 5, 26, 27, 24, 25, 30,
		31, 28, 29, 18, 19, 16, 17, 22, 23, 20,
		21, 42, 43, 40, 41, 46, 47, 44, 45, 16,
		68, 69, 142, 143, 140, 141, 154, 155, 152, 153,
		158, 159, 156, 157, 146, 147, 144, 145, 150, 151,
		148, 149, 234, 235, 232, 233, 238, 239, 236, 237,
		226, 227, 224, 225, 230, 231, 228, 229, 250, 251,
		248, 249, 254, 255, 252, 253, 242, 243, 240, 241
		};

		const uint8_t lutMeters_Len[] = {
		6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
		6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
		6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
		6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
		6, 6, 6, 6, 6, 6, 6, 6, 6, 5,
		7, 7, 8, 8, 8, 8, 8, 8, 8, 8,
		8, 8, 8, 8, 8, 8, 8, 8, 8, 8,
		8, 8, 8, 8, 8, 8, 8, 8, 8, 8,
		8, 8, 8, 8, 8, 8, 8, 8, 8, 8,
		8, 8, 8, 8, 8, 8, 8, 8, 8, 8
		};

		const float lutHectometers_Value[] = { 0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f };
		const uint16_t lutHectometers_Code[] = { 0, 1, 6, 7, 4, 5, 6, 7, 4, 5 };
		const uint8_t lutHectometers_Len[] = { 3, 3, 3, 3, 3, 3, 4, 4, 4, 4 };

		const float lutKilometers_Value[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f, 10.0f };
		const uint16_t lutKilometers_Code[] = { 2, 3, 1, 0, 7, 5, 4, 13, 25, 24 };
		const uint8_t lutKilometers_Len[] = { 2, 3, 3, 3, 3, 4, 4, 4, 5, 5 };

		const float lutCentimeters_Value[] = {
		0.0f, 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f, 9.0f,
		10.0f, 11.0f, 12.0f, 13.0f, 14.0f, 15.0f, 16.0f, 17.0f, 18.0f, 19.0f,
		20.0f, 21.0f, 22.0f, 23.0f, 24.0f, 25.0f, 26.0f, 27.0f, 28.0f, 29.0f,
		30.0f, 31.0f, 32.0f, 33.0f, 34.0f, 35.0f, 36.0f, 37.0f, 38.0f, 39.0f,
		40.0f, 41.0f, 42.0f, 43.0f, 44.0f, 45.0f, 46.0f, 47.0f, 48.0f, 49.0f,
		50.0f, 51.0f, 52.0f, 53.0f, 54.0f, 55.0f, 56.0f, 57.0f, 58.0f, 59.0f,
		60.0f, 61.0f, 62.0f, 63.0f, 64.0f, 65.0f, 66.0f, 67.0f, 68.0f, 69.0f,
		70.0f, 71.0f, 72.0f, 73.0f, 74.0f, 75.0f, 76.0f, 77.0f, 78.0f, 79.0f,
		80.0f, 81.0f, 82.0f, 83.0f, 84.0f, 85.0f, 86.0f, 87.0f, 88.0f, 89.0f,
		90.0f, 91.0f, 92.0f, 93.0f, 94.0f, 95.0f, 96.0f, 97.0f, 98.0f, 99.0f
		};

		const uint16_t lutCentimeters_Code[] = {
		50, 51, 48, 49, 54, 55, 52, 53, 42, 43,
		40, 41, 46, 47, 44, 45, 34, 35, 32, 33,
		38, 39, 36, 37, 58, 59, 56, 57, 62, 63,
		60, 61, 50, 51, 48, 49, 54, 55, 52, 53,
		10, 11, 8, 9, 14, 15, 12, 13, 2, 3,
		0, 1, 6, 7, 4, 5, 26, 27, 24, 25,
		30, 31, 28, 29, 18, 19, 16, 17, 22, 23,
		20, 21, 42, 43, 40, 41, 46, 47, 44, 45,
		34, 35, 32, 33, 38, 39, 36, 37, 122, 123,
		120, 121, 126, 127, 124, 125, 58, 59, 56, 57
		};

		const uint8_t lutCentimeters_Len[] = {
		6, 6, 6, 6, 6, 6, 6, 6, 7, 7,
		7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
		7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
		7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
		7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
		7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
		7, 7, 7, 7, 7, 7, 7, 7, 7, 7,
		7, 7, 6, 6, 6, 6, 6, 6, 6, 6,
		6, 6, 6, 6, 6, 6, 6, 6, 7, 7,
		7, 7, 7, 7, 7, 7, 6, 6, 6, 6
		};

		const float lutAbsorption_Value[] = { 0.0f, 0.1f, 0.2f, 0.3f, 0.4f, 0.5f, 0.6f, 0.7f, 0.8f, 0.9f, 1.0f };
		const uint16_t lutAbsorption_Code[] = { 6, 4, 5, 6, 7, 7, 4, 5, 2, 3, 0 };
		const uint8_t lutAbsorption_Len[] = { 3, 3, 3, 4, 4, 3, 4, 4, 4, 4, 3 };

		/------------------------------------------------------------------------------------------
		* Default frequency grids
		------------------------------------------------------------------------------------------/
		@@ -470,6 +580,36 @@ static ivas_error read_code_word(
		pLengths = lutDsr_Len;
		size = sizeof lutDsr_Len / sizeof( uint8_t );
		break;
		case RC_LUT_METERS:
		pValues = lutMeters_Value;
		pCodes = lutMeters_Code;
		pLengths = lutMeters_Len;
		size = sizeof lutMeters_Len / sizeof( uint8_t );
		break;
		case RC_LUT_HECTOMETERS:
		pValues = lutHectometers_Value;
		pCodes = lutHectometers_Code;
		pLengths = lutHectometers_Len;
		size = sizeof lutHectometers_Len / sizeof( uint8_t );
		break;
		case RC_LUT_KILOMETERS:
		pValues = lutKilometers_Value;
		pCodes = lutKilometers_Code;
		pLengths = lutKilometers_Len;
		size = sizeof lutKilometers_Len / sizeof( uint8_t );
		break;
		case RC_LUT_CENTIMETERS:
		pValues = lutCentimeters_Value;
		pCodes = lutCentimeters_Code;
		pLengths = lutCentimeters_Len;
		size = sizeof lutCentimeters_Len / sizeof( uint8_t );
		break;
		case RC_LUT_ABSORPTION:
		pValues = lutAbsorption_Value;
		pCodes = lutAbsorption_Code;
		pLengths = lutAbsorption_Len;
		size = sizeof lutAbsorption_Len / sizeof( uint8_t );
		break;
		case RC_LUT_INVALID:
		default:
		return IVAS_ERR_INVALID_RENDER_CONFIG;
		@@ -671,6 +811,106 @@ static ivas_error get_dsr(
		return IVAS_ERR_OK;
		}

		/-----------------------------------------------------------------------------------------
		* Function get_distance()
		* Gets a distance value (in meters)
		-----------------------------------------------------------------------------------------/

		static ivas_error get_distance(
		RenderConfigReader this, / i/o : Render config reader handle */
		uint16_t isSmall, /* i : Flag indicating a small distance */
		float pResult / o : Distance value */
		)
		{
		ivas_error error;
		float value;
		uint32_t flag;

		if ( ( error = read_code_word( this, RC_LUT_METERS, pResult ) ) != IVAS_ERR_OK )
		{
		return error;
		}

		if ( isSmall == false )
		{
		/* addHectometers flag */
		if ( ( error = read_bits( this, &flag, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}

		if ( flag == true )
		{
		/* Hectometers */
		if ( ( error = read_code_word( this, RC_LUT_HECTOMETERS, &value ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		pResult += value 100.0f;

		/* addKilometers flag */
		if ( ( error = read_bits( this, &flag, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}

		while ( flag == true )
		{
		/* Kilometers */
		if ( ( error = read_code_word( this, RC_LUT_KILOMETERS, &value ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		pResult += value 1000.0f;

		/* addKilometers flag */
		if ( ( error = read_bits( this, &flag, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		}
		}

		/* addCentimeters flag */
		if ( ( error = read_bits( this, &flag, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( flag == true )
		{
		/* Centimeters */
		/* Kilometers */
		if ( ( error = read_code_word( this, RC_LUT_CENTIMETERS, &value ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		pResult += value 0.01f;
		}
		}

		return IVAS_ERR_OK;
		}

		/-----------------------------------------------------------------------------------------
		* Function get_absorption()
		* Gets an absorption value
		-----------------------------------------------------------------------------------------/

		static ivas_error get_absorption(
		RenderConfigReader this, / i/o : Render config reader handle */
		float pResult / o : Distance value */
		)
		{
		ivas_error error;

		if ( ( error = read_code_word( this, RC_LUT_ABSORPTION, pResult ) ) != IVAS_ERR_OK )
		{
		return error;
		}

		return IVAS_ERR_OK;
		}

		#else
		/-----------------------------------------------------------------------------------------
		* Function read_bool()
		@@ -971,7 +1211,10 @@ ivas_error RenderConfigReader_read(
		{
		uint32_t file_size;
		uint32_t value;
		uint32_t i, n, m;
		#ifdef CONTROL_METADATA_EARLY_REFLECTIONS
		uint32_t signx, signy, k;
		#endif
		uint32_t i, m, n;
		ivas_error error;
		float freqHop;
		uint32_t gridLen;
		@@ -992,6 +1235,20 @@ ivas_error RenderConfigReader_read(
		fread( pRenderConfigReader->pBitstream, sizeof( uint8_t ), file_size, pRenderConfigReader->pConfigFile );
		pRenderConfigReader->length = file_size;

		/****************************/
		/* Read the presence flag */
		/****************************/
		if ( ( error = read_bits( pRenderConfigReader, &value, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}

		/* Just return in case no acoustic environment data available */
		if ( value == false )
		{
		return IVAS_ERR_OK;
		}

		/****************************/
		/* Read the frequency grids */
		/****************************/
		@@ -1241,6 +1498,98 @@ ivas_error RenderConfigReader_read(
		return IVAS_ERR_INVALID_RENDER_CONFIG;
		}
		}

		#ifdef CONTROL_METADATA_EARLY_REFLECTIONS
		/* Has early reflections */
		if ( ( error = read_bits( pRenderConfigReader, &value, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( value == true )
		{
		if ( ( pRenderConfigReader->pAE[n].pEarlyReflections = (EarlyReflectionsConfig *) malloc( sizeof( EarlyReflectionsConfig ) ) ) == NULL )
		{
		return IVAS_ERR_FAILED_ALLOC;
		}

		/* Room sizes */
		if ( ( error = get_distance( pRenderConfigReader, true, &pRenderConfigReader->pAE[n].pEarlyReflections->dimensions.x ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( ( error = get_distance( pRenderConfigReader, true, &pRenderConfigReader->pAE[n].pEarlyReflections->dimensions.y ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( ( error = get_distance( pRenderConfigReader, true, &pRenderConfigReader->pAE[n].pEarlyReflections->dimensions.z ) ) != IVAS_ERR_OK )
		{
		return error;
		}

		/* Frequency grid ID */
		if ( ( error = get_count_or_index( pRenderConfigReader, &value ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		pRenderConfigReader->pAE[n].pEarlyReflections->pFG = &pRenderConfigReader->pFG[value];

		/* Absorption coefficients */
		if ( ( pRenderConfigReader->pAE[n].pEarlyReflections->pAbsCoeff = malloc( pRenderConfigReader->pAE[n].pEarlyReflections->pFG->nrBands * sizeof( float[N_ABS_COEFFS] ) ) ) == NULL )
		{
		return IVAS_ERR_FAILED_ALLOC;
		}

		for ( m = 0; m < pRenderConfigReader->pAE[n].pEarlyReflections->pFG->nrBands; m++ )
		{
		for ( k = 0; k < N_ABS_COEFFS; k++ )
		{
		if ( ( error = get_absorption( pRenderConfigReader, &pRenderConfigReader->pAE[n].pEarlyReflections->pAbsCoeff[m][k] ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		}
		}

		/* Has listener origin */
		if ( ( error = read_bits( pRenderConfigReader, &value, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}

		if ( value == true )
		{
		if ( ( pRenderConfigReader->pAE[n].pEarlyReflections->pListenerOrigin = malloc( sizeof( IVAS_VECTOR3 ) ) ) == NULL )
		{
		return IVAS_ERR_FAILED_ALLOC;
		}

		if ( ( error = read_bits( pRenderConfigReader, &signx, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( ( error = read_bits( pRenderConfigReader, &signy, 1 ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( ( error = get_distance( pRenderConfigReader, true, &pRenderConfigReader->pAE[n].pEarlyReflections->pListenerOrigin->x ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( signx == 0 )
		{
		pRenderConfigReader->pAE[n].pEarlyReflections->pListenerOrigin->x *= -1.0f;
		}
		if ( ( error = get_distance( pRenderConfigReader, true, &pRenderConfigReader->pAE[n].pEarlyReflections->pListenerOrigin->y ) ) != IVAS_ERR_OK )
		{
		return error;
		}
		if ( signy == 0 )
		{
		pRenderConfigReader->pAE[n].pEarlyReflections->pListenerOrigin->y *= -1.0f;
		}
		}
		}
		#endif
		}

		/* Cleanup */
		@@ -1517,7 +1866,7 @@ void RenderConfigReader_close(
		)
		{
		#ifdef CONTROL_METADATA_REVERB
		uint16_t n;
		uint32_t n;
		#endif

		if ( ppRenderConfigReader == NULL \|\| *ppRenderConfigReader == NULL )
		@@ -1529,6 +1878,17 @@ void RenderConfigReader_close(
		/* Free the acoustic environments */
		for ( n = 0; n < ( *ppRenderConfigReader )->nAE; n++ )
		{
		#ifdef CONTROL_METADATA_EARLY_REFLECTIONS
		if ( ( *ppRenderConfigReader )->pAE[n].pEarlyReflections != NULL )
		{
		if ( ( *ppRenderConfigReader )->pAE[n].pEarlyReflections->pListenerOrigin != NULL )
		{
		free( ( *ppRenderConfigReader )->pAE[n].pEarlyReflections->pListenerOrigin );
		}
		free( ( *ppRenderConfigReader )->pAE[n].pEarlyReflections->pAbsCoeff );
		free( ( *ppRenderConfigReader )->pAE[n].pEarlyReflections );
		}
		#endif
		free( ( *ppRenderConfigReader )->pAE[n].pRT60 );
		free( ( *ppRenderConfigReader )->pAE[n].pDSR );
		}