Commit 3a3dd65e authored by Dominik Weckbecker's avatar Dominik Weckbecker 💬
Browse files

add more detailes functions descriptions

parent a256c3a3
Loading
Loading
Loading
Loading
Loading
+18 −0
Original line number Diff line number Diff line
@@ -117,6 +117,12 @@ static const int16_t REORDER_ACN_SID[AMBI_MAX_CHANNELS] = { 0,
    API functions for the conversion
   ---------------------------------- */

/*-------------------------------------------------------------------------*
* convert_ambi_format()
*
* Convert signal between ACN-SN3D and other common ambisonics conventions
--------------------------------------------------------------------------*/

int16_t convert_ambi_format(
    float *in[],        /* i: input ambisonics channels  */
    float *out[],       /* o: output ambisonics channels */
@@ -261,6 +267,12 @@ int16_t convert_ambi_format(
    return 0;
}

/*-------------------------------------------------------------------------*
* renormalize_channels()
*
* Rescale audio channels according to the selected ambisonics convention
--------------------------------------------------------------------------*/

int16_t renormalize_channels(
    float *in[],                 /* i: input ambisonics channels  */
    float *out[],                /* o: output ambisonics channels */
@@ -330,6 +342,12 @@ int16_t renormalize_channels(
    return 0;
}

/*-------------------------------------------------------------------------*
* reorder_channels()
*
* Reorder channels according to the selected ambisonics convention
--------------------------------------------------------------------------*/

int16_t reorder_channels(
    float *in[],                  /* i: input ambisonics channels  */
    float *out[],                 /* o: output ambisonics channels */