Commit ca21bc66 authored by thomas dettbarn's avatar thomas dettbarn
Browse files

documented the format of the input and output samples for the ambi_converter as Q0 in the comments.

parent 566649a4

lib_util/ambi_convert.c

+15 −15
Original line number Diff line number Diff line
@@ -129,8 +129,8 @@ static const int16_t REORDER_ACN_SID[AMBI_MAX_CHANNELS] = { 0, 
--------------------------------------------------------------------------*/



AMBI_CONVERT_ERROR convert_ambi_format(

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

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

    Word16 *in[],       /* i: input ambisonics channels, Q0  */

    Word16 *out[],      /* o: output ambisonics channels, Q0 */

    int16_t order,      /* i: ambisonics order               */

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

    AMBI_FMT out_format /* i: output ambisonics format       */
@@ -335,8 +335,8 @@ AMBI_CONVERT_ERROR convert_ambi_format( 
--------------------------------------------------------------------------*/



AMBI_CONVERT_ERROR renormalize_channels(

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

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

    Word16 *in[],                /* i: input ambisonics channels, Q0  */

    Word16 *out[],               /* o: output ambisonics channels, Q0 */

    int16_t order,               /* i: ambisonics order               */

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

    AMBI_CHANNEL_NORM out_format /* i: output ambisonics format       */
@@ -433,8 +433,8 @@ AMBI_CONVERT_ERROR renormalize_channels( 
--------------------------------------------------------------------------*/



AMBI_CONVERT_ERROR reorder_channels(

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

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

    Word16 *in[],                 /* i: input ambisonics channels, Q0  */

    Word16 *out[],                /* o: output ambisonics channels, Q0 */

    int16_t order,                /* i: ambisonics order               */

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

    AMBI_CHANNEL_ORDER out_format /* i: output ambisonics format       */

lib_util/ambi_convert.h

+15 −15
Original line number Diff line number Diff line
@@ -78,24 +78,24 @@ typedef enum 
} AMBI_CONVERT_ERROR;



AMBI_CONVERT_ERROR convert_ambi_format(

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

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

    Word16 *in[],       /* i: input ambisonics channels, Q0  */

    Word16 *out[],      /* o: output ambisonics channels, Q0 */

    int16_t order,      /* i: ambisonics order               */

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

    AMBI_FMT out_format /* i: output ambisonics format       */

);



AMBI_CONVERT_ERROR renormalize_channels(

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

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

    Word16 *in[],                /* i: input ambisonics channels, Q0  */

    Word16 *out[],               /* o: output ambisonics channels, Q0 */

    int16_t order,               /* i: ambisonics order               */

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

    AMBI_CHANNEL_NORM out_format /* i: output ambisonics format       */

);



AMBI_CONVERT_ERROR reorder_channels(

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

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

    Word16 *in[],                 /* i: input ambisonics channels, Q0  */

    Word16 *out[],                /* o: output ambisonics channels, Q0 */

    int16_t order,                /* i: ambisonics order               */

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

    AMBI_CHANNEL_ORDER out_format /* i: output ambisonics format       */