aboutsummaryrefslogtreecommitdiff
path: root/documentation_fr.md
diff options
context:
space:
mode:
authorDenise sur Lya <sekhmet@lya>2016-07-26 18:02:03 +0200
committerIsmaël Bouya <ismael.bouya@normalesup.org>2016-07-26 21:42:54 +0200
commitd8c3ae04cd6af07d5cdc68e09441bb4df2bbde02 (patch)
tree48be0f0c1c07dfa342f855facd0fe05e2b0dcf34 /documentation_fr.md
parent62bce32f6174f6a38f09b7203c0b72a6a174c51e (diff)
downloadMusicSampler-d8c3ae04cd6af07d5cdc68e09441bb4df2bbde02.tar.gz
MusicSampler-d8c3ae04cd6af07d5cdc68e09441bb4df2bbde02.tar.zst
MusicSampler-d8c3ae04cd6af07d5cdc68e09441bb4df2bbde02.zip
doc: added new features
Diffstat (limited to 'documentation_fr.md')
-rw-r--r--documentation_fr.md30
1 files changed, 16 insertions, 14 deletions
diff --git a/documentation_fr.md b/documentation_fr.md
index bd42e55..1544cc5 100644
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -25,6 +25,8 @@ Appuyer sur une touche déclenche les actions associées à cette touche (affich
25 25
26Un 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. 26Un 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.
27 27
28En cas d'appui successif sur une touche, music_sampler ne relance pas les actions associées à cette touche si ces actions ne sont pas terminées ; cela pour éviter les "accidents".
29
28### Options disponibles au lancement 30### Options disponibles au lancement
29 31
30Toutes les options au lancement sont facultatives ; la plupart du temps lancer le programme dans le bon dossier suffit. 32Toutes les options au lancement sont facultatives ; la plupart du temps lancer le programme dans le bon dossier suffit.
@@ -49,7 +51,9 @@ Les options suivantes sont plutôt réservées à un usage avancé de music_samp
49## Configurer les touches 51## Configurer les touches
50 52
51Le 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 !). 53Le 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 !).
52le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne est ignoré. 54le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne est ignoré.
55
56En cas d'erreur dans le fichier de configuration, un message d'erreur s'affiche dans le terminal. Selon la "gravité" de l'erreur, music_sampler se lance en ignorant les actions erronnées (en colorant éventuellement la touche en noir), ou ne se lance pas du tout.
53 57
54Le fichier contient plusieurs sections : 58Le fichier contient plusieurs sections :
55 59
@@ -111,7 +115,7 @@ La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la
111 115
112### `keys` : actions sur les touches 116### `keys` : actions sur les touches
113 117
114Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez que la plupart des commandes (hors `wait` et quelques cas particuliers, voir plus bas), les actions sont exécutées les unes à la suite des autres, sans attendre que la précédente soit terminée. 118Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez que la plupart des commandes (hors `wait` et quelques cas particuliers, voir plus bas), les actions sont exécutées les unes à la suite des autres, sans attendre que la précédente soit terminée (donc quasi-simultanément).
115 119
116 120
117#### Exemples 121#### Exemples
@@ -121,13 +125,14 @@ Cette section sert à décrire, pour chaque touche, la liste des actions success
121 - play: 125 - play:
122 file: "music1.mp3" 126 file: "music1.mp3"
123 volume: 70 127 volume: 70
128 start_at: 10
124 - wait: 129 - wait:
125 duration: 5 130 duration: 5
126 - stop: 131 - stop:
127 file: "music1.mp3" 132 file: "music1.mp3"
128 fade_out: 2 133 fade_out: 2
129 134
130Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes. 135Lance la musique "music1.mp3" à 70% de son volume max, à 10 secondes du début, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
131 136
132 :::yaml 137 :::yaml
133 'b': 138 'b':
@@ -171,7 +176,7 @@ Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fond
171 file: "music1.mp3" 176 file: "music1.mp3"
172 value: 100 177 value: 100
173 178
174Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (deux fois). Le volume revient à la normale une fois que le son "noise" est terminé. 179Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (deux fois). Le volume revient à la normale une fois que les deux écoutes du son "noise" sont terminées.
175 180
176 :::yaml 181 :::yaml
177 'e': 182 'e':
@@ -189,11 +194,12 @@ Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par de
189Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en avançant de 5 secondes dans la musique. 194Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en avançant de 5 secondes dans la musique.
190 195
191#### Liste des actions possibles: 196#### Liste des actions possibles:
192- `play` : joue une musique. Paramètres : 197- `play` : joue une musique. music_sampler ne joue qu'une musique à la fois : si la musique demandée est déjà en train d'être jouée, elle n'est pas relancée ou jouée "par dessus". Paramètres :
193 * `file: "music.mp3"` précise la musique jouée (chemin relatif). 198 * `file: "music.mp3"` précise la musique jouée (chemin relatif).
194 * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x secondes. 199 * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x secondes.
195 * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de son volume max (x doit être entre 0 et 100). Pour jouer une musique à plus de 100%, voir la section "file: properties". 200 * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de son volume max (x doit être entre 0 et 100). Pour jouer une musique à plus de 100%, voir la section "file: properties".
196 * `loop: x` (facultatif, défaut : 0) la musique doit être répétée x fois. Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de répétitions, donc pour lire trois fois la musique, mettre `loop: 2`. 201 * `loop: x` (facultatif, défaut : 0) la musique doit être répétée x fois. Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de répétitions, donc pour lire trois fois la musique, mettre `loop: 2`.
202 * `start_at: x` (facultatif, défaut : 0) la musique démarre à x secondes du début.
197- `stop` : arrête une musique donnée. Paramètres : 203- `stop` : arrête une musique donnée. Paramètres :
198 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques. 204 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques.
199 * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes. 205 * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
@@ -220,13 +226,13 @@ Notez une fois enore que `wait` est quasiment la seule action qui attend d'avoir
220 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques. 226 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
221 * `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. 227 * `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.
222 * `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). 228 * `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).
223- `stop_all_actions:` Interrompt toutes les actions en cours et à faire. 229- `stop_all_actions:` Interrompt toutes les actions en cours et à faire. Notez qu'une musique lancée (y compris avec une option `loop`) est considérée comme une action "déjà terminée", et ne sera donc pas interrompue (utiliser `stop` sans arguments pour stopper toutes les musiques en écoute). La commande interrompt également les options à faire de cette même touche, il est donc inutile de programmer des actions à la suite de celle-ci.
224- `interrupt_wait`: Interrompt l'attente (de `wait` ou fin d'un fondu avec attente) et passe directement à l'action suivante. Paramètre : 230- `interrupt_wait`: Interrompt l'attente (de `wait` ou fin d'un fondu avec attente) et passe directement à l'action suivante. Paramètre :
225 * `wait_id: name` : précise l'identifiant du `wait` à stopper (défini par `set_wait_id`, voir les actions `wait` et `stop`). 231 * `wait_id: name` : précise l'identifiant du `wait` à stopper (défini par `set_wait_id`, voir les actions `wait` et `stop`). Pour interrompre plusieurs `wait` d'un seul coup, il faut mettre plusieurs `interrupt_wait`.
226 232
227### `aliases` : définir des alias 233### `aliases` : définir des alias
228 234
229Il 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". 235Il 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 "music_properties".
230 236
231La syntaxe est la suivante: 237La syntaxe est la suivante:
232 :::yaml 238 :::yaml
@@ -250,7 +256,7 @@ On utilise ensuite, dans le fichier de configuration, `include: alias1` à la pl
250 play: 256 play:
251 include: music1 257 include: music1
252 258
253`music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut écrire à la place `include: music1`. Attention, dans la section "file_properties", les alias ne fonctionnent pas, et il faut écrire le nom du fichier complet. 259`music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut écrire à la place `include: music1`. Attention, dans la section "music_properties", les alias ne fonctionnent pas, et il faut écrire le nom du fichier complet.
254 260
255 :::yaml 261 :::yaml
256 aliases: 262 aliases:
@@ -286,7 +292,7 @@ Sont listés ci-dessous une liste de problèmes rencontrés, avec des solutions
286 292
287 * Le programme se lance et s'arrête tout de suite. 293 * Le programme se lance et s'arrête tout de suite.
288 294
289Il 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. 295Il 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).
290 296
291 * La musique "grésille" affreusement. 297 * La musique "grésille" affreusement.
292 298
@@ -307,7 +313,3 @@ Les extraits de musiques proposés en exemples proviennent de [Jamendo](https://
307Le bruit de crocodile provient de [Universal-Soundbank](http://www.universal-soundbank.com/). 313Le bruit de crocodile provient de [Universal-Soundbank](http://www.universal-soundbank.com/).
308 314
309Cet 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). 315Cet 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).
310
311## Contact
312
313Blabla