Commit 00c1f94e authored by Dominik Weckbecker's avatar Dominik Weckbecker 💬
Browse files

add descriptions to function arguments in lib_util/ambi_convert.c and lib_util/ambi_convert.h

parent d29a4cd2

lib_util/ambi_convert.c

+21 −3
Original line number Diff line number Diff line
@@ -117,7 +117,13 @@ static const int16_t REORDER_ACN_SID[AMBI_MAX_CHANNELS] = { 0, 
    API functions for the conversion

   ---------------------------------- */



int16_t convert_ambi_format( float *in[], float *out[], int16_t order, AMBI_FMT in_format, AMBI_FMT out_format )

int16_t convert_ambi_format( 

	float *in[],                 /* i: input ambisonics channels  */

	float *out[],                /* o: output ambisonics channels */

	int16_t order,               /* i: ambisonics order           */

	AMBI_FMT in_format,          /* i: input ambisonics format    */

	AMBI_FMT out_format          /* i: output ambisonics format   */

)

{



    float tmp[AMBI_MAX_CHANNELS * L_FRAME48k];
@@ -255,7 +261,13 @@ int16_t convert_ambi_format( float *in[], float *out[], int16_t order, AMBI_FMT 
    return 0;

}



int16_t renormalize_channels( float *in[], float *out[], int16_t order, AMBI_CHANNEL_NORM in_format, AMBI_CHANNEL_NORM out_format )

int16_t renormalize_channels( 

	float *in[],                  /* i: input ambisonics channels  */

	float *out[],                 /* o: output ambisonics channels */

	int16_t order,                /* i: ambisonics order           */

	AMBI_CHANNEL_NORM in_format,  /* i: input ambisonics format    */

	AMBI_CHANNEL_NORM out_format  /* i: output ambisonics format   */

)

{

    int16_t n_chan = ( order + 1 ) * ( order + 1 );

    int16_t i_chan, i;
@@ -318,7 +330,13 @@ int16_t renormalize_channels( float *in[], float *out[], int16_t order, AMBI_CHA 
    return 0;

}



int16_t reorder_channels( float *in[], float *out[], int16_t order, AMBI_CHANNEL_ORDER in_format, AMBI_CHANNEL_ORDER out_format )

int16_t reorder_channels( 

	float *in[],                  /* i: input ambisonics channels  */

	float *out[],                 /* o: output ambisonics channels */

	int16_t order,                /* i: ambisonics order           */

	AMBI_CHANNEL_ORDER in_format, /* i: input ambisonics format    */

	AMBI_CHANNEL_ORDER out_format /* i: output ambisonics format   */

)

{

    int16_t n_chan = ( order + 1 ) * ( order + 1 );

    int16_t i_chan, i;

lib_util/ambi_convert.h

+23 −6
Original line number Diff line number Diff line
@@ -63,10 +63,27 @@ typedef enum 
    AMBI_CHANNEL_ORDER_SID

} AMBI_CHANNEL_ORDER;



int16_t convert_ambi_format( float *in[], float *out[], int16_t order, AMBI_FMT in_format, AMBI_FMT out_format );



int16_t renormalize_channels( float *in[], float *out[], int16_t order, AMBI_CHANNEL_NORM in_format, AMBI_CHANNEL_NORM out_format );



int16_t reorder_channels( float *in[], float *out[], int16_t order, AMBI_CHANNEL_ORDER in_format, AMBI_CHANNEL_ORDER out_format );



int16_t convert_ambi_format(

	float *in[],                 /* i: input ambisonics channels  */

	float *out[],                /* o: output ambisonics channels */

	int16_t order,               /* i: ambisonics order           */

	AMBI_FMT in_format,          /* i: input ambisonics format    */

	AMBI_FMT out_format          /* i: output ambisonics format   */

);



int16_t renormalize_channels(

	float *in[],                  /* i: input ambisonics channels  */

	float *out[],                 /* o: output ambisonics channels */

	int16_t order,                /* i: ambisonics order           */

	AMBI_CHANNEL_NORM in_format,  /* i: input ambisonics format    */

	AMBI_CHANNEL_NORM out_format  /* i: output ambisonics format   */

);



int16_t reorder_channels(

	float *in[],                  /* i: input ambisonics channels  */

	float *out[],                 /* o: output ambisonics channels */

	int16_t order,                /* i: ambisonics order           */

	AMBI_CHANNEL_ORDER in_format, /* i: input ambisonics format    */

	AMBI_CHANNEL_ORDER out_format /* i: output ambisonics format   */

);

#endif