fix comments in fluid_check_linked_mod_path()

This commit is contained in:
jjceresa 2019-07-14 12:27:35 +02:00
parent fb95fce202
commit c23c891d18

View file

@ -1496,7 +1496,7 @@ fluid_is_mod_in_path(fluid_mod_t *path[], int count, fluid_mod_t *mod)
* with, mod2 being the modulator at the beginning of the path. * with, mod2 being the modulator at the beginning of the path.
* This case occurs when a modulator doesn't exist at m6 destination index * This case occurs when a modulator doesn't exist at m6 destination index
* for example (CC->m2-->m6-->?). * for example (CC->m2-->m6-->?).
* This case occurs also if a modulator exist at m6 destination index * This case occurs also if a modulator exists at m6 destination index
* (e.g CC->m2-->m6-->m3->...) and this modulator (e.g m3) have source src1 not * (e.g CC->m2-->m6-->m3->...) and this modulator (e.g m3) have source src1 not
* linked. Two messages are displayed to show the later case: * linked. Two messages are displayed to show the later case:
* fluidsynth: warning: invalid destination zone-name/mod3. * fluidsynth: warning: invalid destination zone-name/mod3.
@ -1513,18 +1513,19 @@ fluid_is_mod_in_path(fluid_mod_t *path[], int count, fluid_mod_t *mod)
* fluidsynth: warning: path without destination zone-name/mod2. * fluidsynth: warning: path without destination zone-name/mod2.
* First message indicates that m6 is a modulator already encountered. * First message indicates that m6 is a modulator already encountered.
* Second message indicates the modulator at the beginning of the path (e.g m2). * Second message indicates the modulator at the beginning of the path (e.g m2).
* When a path is circulars, all modulators from the start to the one * When a path is circular, all modulators from the start to the one
* already encontered are marked invalid (amount = 0). (e.g m2,m6,m3,m8). * already encontered are marked invalid (amount = 0). (e.g m2,m6,m3,m8).
* *
* When finished, path table contains: * When finished, path table contains:
* - valid discovered modulators paths (or not). * - no path or
* - incomplete invalid path (with amount set to 0). * - valid complete paths (amount not set to 0) or
* - invalid incomplete paths (with amount set to 0).
* *
* Other incomplete linked modulators path are isolated. * Other incomplete linked modulator paths are isolated.
* Isolated modulators mx have source src1 linked, with no others modulators * Isolated path starts with modulator mx having source src1 linked, with no
* connected to mx. * others modulators connected to mx.
* These isolated modulators are still in list_mod but not in path. They should be * These isolated modulator paths are still in list_mod but not in path table.
* marked invalid later. * They should be marked invalid later.
* *
* *
* @param zone_name, zone's name * @param zone_name, zone's name
@ -1541,7 +1542,7 @@ fluid_is_mod_in_path(fluid_mod_t *path[], int count, fluid_mod_t *mod)
* This index must be 0 at first call. On return, it indicates the number of linked * This index must be 0 at first call. On return, it indicates the number of linked
* modulators stored in path (for all linked paths found). * modulators stored in path (for all linked paths found).
* *
* @return TRUE if at least one valid linked modulators path exists, * @return TRUE if at least one linked modulators path exists (complete/incomplete),
* FALSE otherwise. * FALSE otherwise.
*/ */
static int static int