documentation: added new features + aliases + 'misc' section

diff --git a/documentation_fr.md b/documentation_fr.md
index c5298a5c0e94e16538632f4d46b74c22834a0f28..bd42e5573f44cf25a505d10424fa58492c1cfc0f 100644 (file)
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -4,8 +4,7 @@
 
 ## Description
 
-Music Sampler permet de pré-programmer des transitions musicales, qui peuvent ensuite être lancées à l'aide d'un simple appui sur une touche.
-
+Music Sampler est un lecteur de musique qui permet de pré-programmer des transitions musicales, qui peuvent ensuite être lancées à l'aide d'un simple appui sur une touche.
 
 ## Pré-requis et installation
 
@@ -18,12 +17,35 @@ Si vous utilisez la version compilée de Music Sampler, il n'y a pas d'installat
 
 ## Utilisation
 
-Tout le travail consiste à préparer les transitions dans le fichier de configuration config.yml
+Tout le travail consiste à préparer les transitions dans le fichier de configuration config.yml.
 
-Lancer ensuite le programme dans le dossier où se situe le fichier. Une fenêtre représentant un clavier apparaît. Les touches programmées apparaissent d'abord légèrement grisées, lorsque les musiques associées sont en cours de chargement, ou pas encore chargées. Le rond orange dans le coin du clavier devient vert lorsque tout est chargé.
+Lancer ensuite le programme dans le dossier où se situe le fichier de configuration (voir plus bas pour une utilisation avancée). Une fenêtre représentant un clavier apparaît. Les touches programmées apparaissent d'abord légèrement grisées, lorsque les musiques associées sont en cours de chargement, ou pas encore chargées. Le rond orange dans le coin du clavier devient vert lorsque tout est chargé.
 
 Appuyer sur une touche déclenche les actions associées à cette touche (affichées dans le cadre en bas à gauche). Cliquer sur la touche affiche les actions associées à la touche mais ne les déclenche pas. Les deux autres cadres montrent respectivement un historique des touches appuyées et la liste des musiques en train d'être jouées.
 
+Un exemple de fichier de configuration est fourni, avec un certain nombre de touches et de transitions programmées (pour les trois musiques fournies), la syntaxe du fichier (expliquée plus bas) se comprend aisément en le regardant. De plus, certaines touches (par exemple 'ÉCHAP' pour tout arrêter) peuvent être gardées d'une fois sur l'autre.
+
+### Options disponibles au lancement
+
+Toutes les options au lancement sont facultatives ; la plupart du temps lancer le programme dans le bon dossier suffit.
+
+  * `-h, --help` : affiche une liste des options disponibles.
+  * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger (par défaut, config.yml qui se trouve dans le dossier où est lancé music_sampler).
+  * `-d, --debug` : Affiche les informations de débuggage (désactivé par défaut)
+  * `-V, --version` : affiche la version courante et quitte (utilisable uniquement pour la version compilée).
+
+Les options suivantes sont plutôt réservées à un usage avancé de music_sampler, ou en cas de problème avec la configuration standard :
+
+  * `-m, --builtin-mixing` Effectue en interne le mixage des sons. Par défaut, music_sampler confie le mixage au système : n'activer cette option que si le système n'y parvient pas.
+  * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un nombre de secondes (par défaut, "high")
+  * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames pour chaque étape du mixeur. 0 (par défaut) signifie que le programme choisit lui-même le nombre qui lui convient.
+  * `-f FRAME_RATE, --frame-rate FRAME_RATE` : fréquence d'échantillonnage pour jouer les musiques. Par défaut : 44100
+  * `-x CHANNELS, --channels CHANNELS` : nombre de canaux par musique (2 par défaut, pour une écoute stéréo)
+  * `-s SAMPLE_WIDTH, --sample-width SAMPLE_WIDTH` : largeur d'échantillonnage (nombre d'octets pour chaque frame). Par défaut : 2.
+  * `--device DEVICE` : sélectionne le périphérique de son.
+  * `--list-devices` : Affiche la liste des périphériques de son disponibles.
+  * `-- ARGS` : Arguments à passer à la librairie Kivy.
+
 ## Configurer les touches
 
 Le fichier config.yml utilise la syntaxe yaml. Les catégories et sous-catégories sont gérées par l'indentation par des espaces (mais PAS par des tabulations !).
@@ -176,6 +198,7 @@ Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en a
     * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques.
     * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
     * `wait: true/false` (facultatif, par défaut : false) dans le cas d'un fondu, attendre la durée du fondu pour faire les actions suivantes. Si la musique s'arrêtait naturellement avant la fin du fondu, l'attente se termine lorsque la musique se termine naturellement. FIXME
+    * `set_wait_id: name` (facultatif, inutile lorsque `wait` est à false) donne l'identifiant `name` à l'attente de fin du fondu (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne de caractère.
 - `volume` : change le volume d'une musique donnée. Paramètres :
     * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global.
     * `delta: true/false` (facultatif, par défaut : false) le volume doit il être précisé en absolu (false), ou en relatif (true), voir plus bas.
@@ -191,17 +214,29 @@ Notez qu'une action "+10%" relative ne correspond pas à un pourcentage du volum
 - `wait` : attend un temps donné. Paramètres :
     * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
     * `duration: x` (facultatif) attend x secondes. Si `file` et `duration` sont précisés, l'attente dure jusqu'à la fin de la musique PUIS la durée donnée par `duration`.
-Notez une fois enore que `wait` est quasiment la seule action qui attend d'avoir terminé pour lancer la commane suivante, toutes les autres sont lancées successivement mais sans attendre (donc presque simultanément) : ne pas hésiter à rajouter des commandes d'attente partout où c'est nécessaire.
+    * `set_wait_id: name` (facultatif, inutile lorsque `wait` est à false) donne l'identifiant `name` à l'attente (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne de caractère.
+Notez une fois enore que `wait` est quasiment la seule action qui attend d'avoir terminé pour lancer la commande suivante, toutes les autres sont lancées successivement mais sans attendre (donc presque simultanément) : ne pas hésiter à rajouter des commandes d'attente partout où c'est nécessaire.
 - `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
     * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
     * `delta: true/false` (facultatif, défaut : false) Si delta est true, le temps est relatif. Si delta est false, le temps est absolu, voir plus bas.
     * `value: x` Si delta est true, alors fait avancer de x secondes dans la musique (reculer si x est négatif). Si delta est false, alors la lecture se place à x secondes à partir du début. Si la musique est en train de faire un fondu (au départ, ou changement de volume), le fondu se "termine automatiquement" : et la musique est immédiatement au volume final voulu. Si la musique est en train de se terminer en fondu, le "seek" est ignoré (un fondu de fin considère la musique comme déjà terminée).
-    * `stop_all_actions:` Interrompt toutes les actions en cours et à faire.
+- `stop_all_actions:` Interrompt toutes les actions en cours et à faire.
+- `interrupt_wait`: Interrompt l'attente (de `wait` ou fin d'un fondu avec attente) et passe directement à l'action suivante. Paramètre :
+    * `wait_id: name` : précise l'identifiant du `wait` à stopper (défini par `set_wait_id`, voir les actions `wait` et `stop`).
 
 ### `aliases` : définir des alias
 
 Il est possible de définir des alias pour les différents paramètres. Ces alias sont internes au fichier de configuration, pour afficher un "joli" nom d'une musique, voir plutôt "file: properties".
 
+La syntaxe est la suivante:
+    :::yaml
+    aliases:
+      alias1:
+        param: value
+      alias2:
+        param: value
+
+On utilise ensuite, dans le fichier de configuration, `include: alias1` à la place de `param: value`. Voir les exemples ci-dessous.
 
 #### Exemples
 
@@ -244,3 +279,35 @@ Il est possible de définir des alias pour les différents paramètres. Ces alia
           file: "music1.mp3"
 
 `long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration: 42`, on peut écrire `include: long_time`.
+
+## Problèmes possibles
+
+Sont listés ci-dessous une liste de problèmes rencontrés, avec des solutions proposées. Si vous en découvrez d'autre, contactez l'auteur pour les ajouter à la liste.
+
+ * Le programme se lance et s'arrête tout de suite.
+
+Il s'agit généralement d'une erreur de syntaxe dans le fichier de config. Dans ce cas, le terminal doit afficher quelques détails sur l'erreur en question (au moins la ligne correspondante). Si besoin, relancer avec -d (débug) pour avoir plus de détails.
+
+ * La musique "grésille" affreusement.
+
+Il peut s'agir d'un problème de latence (avec certains ordinateurs un peu lents). Essayez de changer la latence (par exemple, 0.1 seconde)
+
+  * Impossible de jouer plus d'une musique à la fois.
+
+Le système n'arrive pas à mixer les musiques par lui-même. Vous pouvez essayer de regarder la liste des périphériques de son (`--list-devices`) puis en sélectionner un autre si disponible. Vous pouvez aussi essayer le mixeur intégré à music_sampler, mais les résultats ne sont pas toujours très fluides (ne pas hésiter à jouer avec les paramètres avancés comme latency et blocksize).
+
+## Divers
+
+Les extraits de musiques proposés en exemples proviennent de [Jamendo](https://jamendo.com). Les musiques (complètes) sont disponibles en libre téléchargement pour un usage non commercial :
+
+[Short Blues](https://www.jamendo.com/track/340173/short-blues)
+
+[To the Fantasy war](https://www.jamendo.com/track/778560/to-the-fantasy-war)
+
+Le bruit de crocodile provient de [Universal-Soundbank](http://www.universal-soundbank.com/).
+
+Cet outil a été développé à l'origine pour faciliter la gestion du son pour les spectacles de la compagnie circassienne [Les pieds jaloux](http://piedsjaloux.fr/). N'ayant pas d'ingénieur son, les artistes eux-mêmes peuvent alors gérer leur musique lorsqu'ils ne sont pas sur scène : d'où la nécessité de préparer les transitions à l'avance et, au moment de la représentation, de réduire l'interaction avec la machine au minimum (une touche).
+
+## Contact
+
+Blabla