]> git.immae.eu Git - perso/Immae/Projets/Python/MusicSampler.git/blob - documentation_fr.md
Add comment action
[perso/Immae/Projets/Python/MusicSampler.git] / documentation_fr.md
1 [TOC]
2
3 # Music Sampler
4
5 ## Description
6
7 Music Sampler est un lecteur de musique qui permet de pré-programmer des
8 transitions musicales, qui peuvent ensuite être lancées à l'aide d'un simple
9 appui sur une touche.
10
11 ## Pré-requis et installation
12
13 (Voir la section suivante pour Windows)
14
15 - Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` (debian) :
16
17 sudo apt-get install libav-tools
18
19 Si vous utilisez la version compilée de Music Sampler (cf. plus bas pour un lien
20 de téléchargement), il n'y a rien d'autre à installer.
21
22 - Pour utiliser les sources directement, les modules suivants sont requis:
23
24 | module | version minimale | commentaire |
25 | ----------- | ---------------- | ----------------------------------------------------------------------------- |
26 | Cython | 0.24 | pour compiler Kivy |
27 | Kivy | 1.9.1 | certaines fonctionnalités nécessitent de compiler/installer avec `USE_SDL2=1` |
28 | Markdown | 2.6.6 | pour la documentation uniquement |
29 | pydub | 0.16.4 | |
30 | Pygame | 1.9.2.dev1 | utilisée par Kivy |
31 | Pygments | 2.1.3 | pour la documentation uniquement |
32 | sounddevice | 0.3.3 | |
33 | transitions | 0.4.1 | |
34 | PyYAML | 3.11 | |
35
36 Le projet est également disponible via `pip`:
37
38 pip install music_sampler
39
40 Le programme utilise les polices `Symbola` et `Ubuntu` (Regular / Bold), qui
41 doivent être disponibles, et la librairie `portaudio`:
42
43 sudo apt-get install ttf-ancient-fonts ttf-ubuntu-font-family portaudio
44
45 Pour compiler kivy avec la librairie SDL2, il faut certains paquets installés:
46
47 sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev
48
49 cf [Installation
50 Kivy](https://kivy.org/docs/installation/installation-linux.html)
51
52 ## Installation sous Windows
53
54 Le processus suivant a permis d’installer music sampler sous windows:
55
56 - [Installer python 3.7.\* (prendre la version 64bit!)](https://www.python.org/downloads/windows)
57 - Dans une invite de commande (`cmd.exe`), lancer:
58
59 pip install music_sampler
60 pip install docutils pygments pypiwin32 PySDL2 kivy.deps.sdl2 kivy.deps.glew
61
62 - [Télécharger ffmpeg (64bit, static)](https://ffmpeg.zeranoe.com/builds/)
63 et mettre le contenu du dossier `bin` dans le dossier avec les musiques
64 - [Télécharger la police Ubuntu](https://www.1001fonts.com/ubuntu-font.html)
65 et installer Ubuntu-R et Ubuntu-B (Regular et Bold) *pour tous les utilisateurs* (clic droit sur la police)
66 - [Télécharger la police Symbola](https://fontlibrary.org/en/font/symbola)
67 et l’installer *pour tous les utilisateurs* (clic droit sur la police)
68 - Écrire un fichier `run.bat` avec:
69
70 :::bash
71 @echo off
72 music_sampler
73
74 - Lancer `run.bat` pour démarrer le programme.
75
76 ## Version compilée
77
78 Une version compilée peut être créée avec pyinstaller:
79
80 :::bash
81 pyinstaller music_sampler.spec
82
83 ## Téléchargements
84
85 - Un exemple de configuration ainsi que des musiques associées à l'exemple
86 peuvent être trouvées sur
87 [owncloud](https://outils.immae.eu/owncloud/index.php/s/kSrIe15G1AiZ9YF)
88 - Une version précompilée de `music_sampler` peut également être téléchargée
89 [dans le même
90 dossier](https://outils.immae.eu/owncloud/index.php/s/kSrIe15G1AiZ9YF/download?path=%2F&files=music_sampler)
91 (attention, elle n'est pas toujours forcément à jour, lancer le programme avec
92 `-V` pour voir la version compilée)
93
94 ## Utilisation
95
96 Tout le travail consiste à préparer les transitions dans le fichier de
97 configuration `config.yml`.
98
99 Lancer ensuite le programme dans le dossier où se situe le fichier de
100 configuration (voir plus bas pour une utilisation avancée). Une fenêtre
101 représentant un clavier apparaît. Le rond orange dans le coin du clavier devient
102 vert lorsque tout est chargé, ou rouge en cas de problème. Une touche grisée et
103 barrée représente une touche non-utilisable pour le moment : soit parce que la
104 musique est en cours de chargement (au lancement du programme, cela peut prendre
105 un peu de temps sur certaines machines), soit parce qu'il y a une action en
106 cours.
107
108 Un exemple de fichier de configuration est fourni, avec un certain nombre de
109 touches et de transitions programmées (pour les trois musiques fournies), la
110 syntaxe du fichier (expliquée plus bas) se comprend aisément en le regardant. De
111 plus, certaines touches (par exemple 'ÉCHAP' pour tout arrêter) peuvent être
112 gardées d'une fois sur l'autre.
113
114 ### Actions possibles
115
116 - Cliquer sur une touche : affiche les actions associées à cette touche (dans
117 le cadre en bas à gauche).
118 - Appuyer sur une touche : déclenche les actions associées à cette touche
119 (affichées également dans le cadre en bas à gauche). Lorsqu'une touche a des
120 actions en cours, son cadre est noir. Notez qu'une action de type "jouer une
121 musique" est considérée comme terminée quand ladite musique est lancée. En
122 cas d'appui répété sur une touche, music_sampler ne relance pas les actions
123 associées à cette touche si ces actions ne sont pas terminées ; cela pour
124 éviter les "accidents".
125 - Ctrl+C ou Ctrl+Q : quitte le programme (possible aussi en cliquant
126 simplement sur la croix en haut à droite).
127 - Ctrl+R : recharge le fichier de configuration.
128
129 ### Options disponibles au lancement
130
131 Toutes les options au lancement sont facultatives ; la plupart du temps lancer
132 le programme dans le bon dossier suffit. La plupart d'entre elles peuvent être
133 définies également dans le fichier de config (à part `--config` bien sûr). Les
134 arguments en ligne de commande ont toujours la priorité.
135
136 * `-h, --help` : affiche une liste des options disponibles.
137 * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger
138 (par défaut, config.yml qui se trouve dans le dossier où est lancé
139 music_sampler).
140 * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques
141 (par défaut, le dossier courant).
142 * `--no-debug, --debug` : Affiche les informations de déboggage (désactivé par
143 défaut)
144 * `-V, --version` : affiche la version courante et quitte (utilisable
145 uniquement pour la version compilée).
146 * `-L, --language` : change la langue de l'application. Actuellement: fr, en
147 (par défaut 'fr')
148 * `--focus-warning, --no-focus-warning`: Afficher / Ne pas afficher
149 d'avertissement lorsque l'application perd le focus (activé par défaut).
150
151 Les options suivantes sont plutôt réservées à un usage avancé de music_sampler,
152 ou en cas de problème avec la configuration standard :
153
154 * `--no-builtin-mixing, --builtin-mixing` Effectue en interne le mixage des
155 sons. Par défaut, music_sampler confie le mixage au système : n'activer
156 cette option que si le système n'y parvient pas.
157 * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un
158 nombre de secondes (par défaut, "high")
159 * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames
160 pour chaque étape du mixeur. 0 (par défaut) signifie que le programme
161 choisit lui-même le nombre qui lui convient.
162 * `-f FRAME_RATE, --frame-rate FRAME_RATE` : fréquence d'échantillonnage pour
163 jouer les musiques. Par défaut : 44100
164 * `-x CHANNELS, --channels CHANNELS` : nombre de canaux par musique (2 par
165 défaut, pour une écoute stéréo)
166 * `-s SAMPLE_WIDTH, --sample-width SAMPLE_WIDTH` : largeur d'échantillonnage
167 (nombre d'octets pour chaque frame). Par défaut : 2.
168 * `--device DEVICE` : sélectionne le périphérique de son.
169 * `--list-devices` : Affiche la liste des périphériques de son disponibles.
170 * `-- ARGS` : Arguments à passer à la librairie Kivy.
171
172 ## Configurer les touches
173
174 **ATTENTION : le format du fichier de configuration est susceptible d'évoluer,
175 sans garantie de rétrocompatibilité.**
176
177 Le fichier config.yml utilise la syntaxe yaml. Les catégories et sous-catégories
178 sont gérées par l'indentation par des espaces (mais PAS par des tabulations !).
179 le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne
180 est ignoré.
181
182 En cas d'erreur dans le fichier de configuration, un message d'erreur s'affiche
183 dans le terminal. Selon la "gravité" de l'erreur, music_sampler se lance en
184 ignorant les actions erronées (en colorant éventuellement la touche en noir), ou
185 ne se lance pas du tout.
186
187 Le fichier contient plusieurs sections :
188
189 :::yaml
190 config:
191 ...
192
193 aliases:
194 ...
195
196 music_properties:
197 ...
198
199 key_properties:
200 ...
201
202 keys:
203 ...
204
205
206 ### `config`
207
208 La section config permet d'enregistrer les paramètres habituellement donnés en
209 ligne de commande. Les '-' dans le nom du paramètre long doivent être remplacés
210 par des '_' (par exemple '--music-path' -> 'music_path'). Pour les switches
211 (`debug`, `focus_warning`, `builtin_mixing`), utilisez la version sans le 'no-'
212 et spécifiez `true` / `false` en valeur. Notez que les arguments donnés en ligne
213 de commande sont toujours prioritaires sur les valeurs du fichier.
214
215 ### `music_properties` : propriétés des musiques
216
217 Cette section sert à définir des propriétés globales des musiques.
218
219 #### Exemples
220
221 :::yaml
222 "music1.mp3":
223 name: My favorite music
224 gain: 1.4
225 La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est
226 chargée à 140% de son volume normal.
227
228 :::yaml
229 "music2.mp3":
230 gain: 0.7
231
232 La musique "music2.mp3" est chargée à 70% de son volume normal.
233
234 #### Liste des options possibles
235 - `name: My music` La musique sera désignée (dans les actions, dans le
236 terminal) comme "My music" au lieu du chemin du fichier. Par exemple le cadre
237 des actions affichera "starting « My music » at volume 100%". Attention, cela
238 ne fait pas office d'alias dans le fichier de configuration (voir la section
239 *aliases*).
240 - `gain: x` Charge la musique avec un gain de x (multiplicatif). Utiliser la
241 commande "volume" pour changer ponctuellement le volume (0 à 100%) au cours de
242 l'écoute.
243
244 ### `key_properties` : affichage et propriétés des touches
245
246 Cette section sert à décrire l'affichage à l'écran des touches : couleur et
247 texte. Par défaut, une touche "attribuée" à une ou plusieurs actions s'affiche
248 en vert.
249
250 #### Exemples
251
252 :::yaml
253 'ESC':
254 description:
255 -
256 - STOP !
257 color: [255, 0, 0]
258 repeat_delay: 2
259
260 La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la
261 deuxième ligne. Si on appuie deux fois sur la même touche à moins de deux
262 secondes d'intervalle, le second appui est ignoré.
263
264 #### Liste des options possibles
265 - `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut
266 mettre un tiret pour une ligne de texte (pas de retour à la ligne
267 automatique). La première ligne correspond à celle de la lettre associée à la
268 touche, aussi il vaut mieux souvent la laisser vide, ou ne mettre que très peu
269 de texte (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on
270 peut compter 3 lignes (incluant la première) pour une touche "standard".
271 - `color: [r, g, b]` : la couleur de la touche. r, g et b sont les proportions
272 de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
273 - `repeat_delay: x` (par défaut : 0) : délai de "sécurité" en cas d'appuis
274 successifs sur la touche. La touche est désactivée (grisée et barrée) pendant
275 toute la durée des actions puis le délai de x secondes.
276 - `actions: liste`: Liste des actions à effectuer en appuyant sur la touche.
277
278 ### Propriété `common`
279
280 Une entrée spéciale `common` s'applique à toutes les touches. Les propriétés
281 définies dans cette entrée peuvent être modifiées individuellement.
282
283 ### `keys` : actions sur les touches
284
285 Cette section sert à décrire, pour chaque touche, la liste des actions
286 successives. Notez que la plupart des actions (hors `wait` et quelques cas
287 particuliers, voir plus bas) sont quasi-instantanées.
288
289 *Cette section est obsolète et remplacée par une clé `actions` contenant une
290 liste dans la section `key_properties` pour chaque touche.*
291
292 #### Exemples
293
294 :::yaml
295 'a':
296 - play:
297 file: "music1.mp3"
298 volume: 70
299 start_at: 10
300 - wait:
301 duration: 5
302 - stop:
303 file: "music1.mp3"
304 fade_out: 2
305
306 Lance la musique "music1.mp3" à 70% de son volume max, à 10 secondes du début,
307 puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
308
309 :::yaml
310 'b':
311 - stop:
312 file: "music1.mp3"
313 fade_out: 5
314 wait: false
315 - play:
316 file: "music2.mp3"
317 fade_in: 5
318
319 Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
320
321 :::yaml
322 'c':
323 - stop:
324 file: "music1.mp3"
325 fade_out: 5
326 wait: true
327 - wait:
328 duration: 2
329 - play:
330 file: "music2.mp3"
331 - seek:
332 file: "music2.mp3"
333 delta: false
334 value: 60
335 Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du
336 fondu, puis attend encore deux secondes et lance la musique "music2.mp3", au
337 temps d'une minute.
338
339 :::yaml
340 'd':
341 - volume:
342 file: "music1.mp3"
343 value: 50
344 - play:
345 file: "noise.mp3"
346 loop: 1
347 - wait:
348 file: "noise.mp3"
349 - volume:
350 file: "music1.mp3"
351 value: 100
352
353 Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par
354 dessus (deux fois). Le volume revient à la normale une fois que les deux écoutes
355 du son "noise" sont terminées.
356
357 :::yaml
358 'e':
359 - pause:
360 file: "music1.mp3"
361 - wait:
362 duration: 10
363 - unpause:
364 file: "music1.mp3"
365 - seek:
366 file: "music1.mp3"
367 delta: true
368 value: 5
369
370 Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en
371 avançant de 5 secondes dans la musique.
372
373 #### Liste des actions possibles:
374 - `comment`: ne fait aucune action, mais affiche un message dans la zone des actions
375 * `message: "some text"` le message à afficher
376 - `play` : joue une musique. music_sampler ne joue qu'une musique à la fois : si
377 la musique demandée est déjà en train d'être jouée, elle n'est pas relancée ou
378 jouée "par dessus". Paramètres :
379 * `file: "music.mp3"` précise la musique jouée (chemin relatif).
380 * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x
381 secondes.
382 * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de
383 son volume max.
384 * `loop: x` (facultatif, défaut : 0) la musique doit être répétée x fois.
385 Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de
386 répétitions, donc pour lire trois fois la musique, mettre `loop: 2`.
387 * `start_at: x` (facultatif, défaut : 0) la musique démarre à x secondes du
388 début.
389 * `restart_if_running: true/false` (facultatif, défaut : false) la musique
390 est éventuellement stoppée et redémarrée si nécessaire
391 - `stop` : arrête une musique donnée. Paramètres :
392 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune
393 musique n'est précisée, le `stop` s'applique à toutes les musiques.
394 * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
395 * `wait: true/false` (facultatif, par défaut : false) dans le cas d'un
396 fondu, attendre la durée du fondu pour faire les actions suivantes. Si la
397 musique s'arrêtait naturellement avant la fin du fondu, l'attente se
398 termine lorsque la musique se termine naturellement. Lorsque plusieurs
399 musiques sont stoppées en fondu, le `wait` n'attend que la dernière
400 musique de la playlist (qui peut se terminer naturellement avant les
401 autres).
402 * `set_wait_id: name` (facultatif, inutile lorsque `wait` est à false) donne
403 l'identifiant `name` à l'attente de fin du fondu (voir `interrupt_wait`).
404 L'identifiant peut être n'importe quelle chaîne de caractère.
405 - `volume` : change le volume d'une musique donnée. Paramètres :
406 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique
407 n'est précisée, la modification s'applique au volume global.
408 * `delta: true/false` (facultatif, par défaut : false) le volume doit il
409 être précisé en absolu (false), ou en relatif (true), voir plus bas.
410 * `value: x` Si delta est à false, met le volume à x% du volume max (x doit
411 être entre 0 et 100). Ce facteur est appliqué à la musique déjà chargée en
412 mémoire (voir section "propriétés"), donc le 100% fait référence au volume
413 de chargement.
414 Si delta est à true, applique un modificateur de x% au volume (x doit être un
415 entier signé). Notez qu'une action "+10%" relative ne correspond pas à un
416 pourcentage du volume actuel, mais du volume "de référence" 100%. Ainsi,
417 effectuer +10% et -10% en relatif revient bien à 100%.
418 * `fade: x` (facultatif) le changement de volume est appliqué en fondu sur x
419 secondes. Il n'y a pas d'attente de la fin du fondu pour lancer les
420 actions suivantes : au besoin, rajouter un `wait` à la main.
421 - `pause` : met en pause une musique. Paramètres :
422 * `file: "music.mp3"` (facultatif) précise la musique à mettre en pause. Si
423 non précisé, s'applique à toutes les musiques.
424 - `unpause` : relance une musique mise en pause (là où elle en était).
425 Paramètres :
426 * `file: "music.mp3"` (facultatif) précise la musique à relancer. Si non
427 précisé, s'applique à toutes les musiques.
428 - `wait` : attend un temps donné. Paramètres :
429 * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
430 * `duration: x` (facultatif) attend x secondes. Si `file` et `duration` sont
431 précisés, l'attente dure jusqu'à la fin de la musique PUIS la durée donnée
432 par `duration`.
433 * `set_wait_id: name` (facultatif) donne l'identifiant `name` à l'attente
434 (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne
435 de caractère.
436 Notez une fois encore que `wait` est quasiment la seule action qui attend
437 d'avoir terminé pour lancer la commande suivante, toutes les autres sont lancées
438 successivement mais sans attendre (donc presque simultanément) : ne pas hésiter
439 à rajouter des commandes d'attente partout où c'est nécessaire.
440 - `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
441 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique
442 n'est précisée, l'action s'applique à toutes les musiques.
443 * `delta: true/false` (facultatif, défaut : false) Si `delta` est true, le
444 temps est relatif. Si delta est false, le temps est absolu, voir plus bas.
445 * `value: x` Si `delta` est true, alors fait avancer de x secondes dans la
446 musique (reculer si x est négatif). Si delta est false, alors la lecture
447 se place à x secondes à partir du début. Si la musique est en train de
448 faire un fondu (au départ, ou changement de volume), le fondu se "termine
449 automatiquement" : et la musique est immédiatement au volume final voulu.
450 Si la musique est en train de se terminer en fondu, le "seek" est ignoré
451 (un fondu de fin considère la musique comme déjà terminée). En cas de
452 `loop`, si le déplacement est relatif la musique peut éventuellement
453 passer à la répétition suivante / précédente; sinon, le déplacement se
454 fait dans la répétition courante.
455 - `stop_all_actions:` Interrompt toutes les actions en cours et à faire. Notez
456 qu'une musique lancée (y compris avec une option `loop`) est considérée comme
457 une action "déjà terminée", et ne sera donc pas interrompue (utiliser `stop`
458 sans arguments pour stopper toutes les musiques en écoute). Paramètre :
459 * `other_only: true/false` (facultatif, défaut : false) : si `other_only`
460 est true, la commande interrompt uniquement les actions des *autres*
461 touches. Sinon, cette commande interrompt également les actions de la
462 touche actuelle ; dans ce cas il est inutile de mettre des actions à la
463 suite de celle-ci puisqu'elles seront systématiquement interrompues.
464 - `interrupt_wait`: interrompt l'attente (de `wait` ou fin d'un fondu avec
465 attente) et passe directement à l'action suivante. Paramètre :
466 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à stopper
467 (défini par `set_wait_id`, voir les actions `wait` et `stop`). Si absent,
468 interrompt toutes les attentes.
469 - `pause_wait`: met une attente en pause (uniquement pour une attente ayant une
470 durée définie). La touche qui attend cet événement ne continuera pas tant que
471 l'attente n'est pas reprise. Paramètres :
472 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à mettre en
473 pause. Si absent, met en pause toutes les attentes compatibles.
474 - `unpause_wait`: reprend une attente en pause (uniquement pour une attente
475 ayant une durée définie). Le compte à rebours reprendra pour la touche
476 correspondante en train d'attendre. Paramètres:
477 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à reprendre.
478 Si absent, reprend toutes les attentes compatibles.
479 - `reset_wait`: réinitialise une attente (uniquement pour une attente ayant une
480 durée définie). Si l'attente est en pause, le compte à rebours ne recommencera
481 au début que lorsque l'attente sera reprise. Paramètres:
482 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à
483 réinitialiser. Si absent, réinitialise toutes les attentes compatibles.
484 - `run_command` : lance une commande. Paramètres :
485 * `command: my_command` : précise la commande à lancer.
486 * `wait: true/false` (facultatif, défaut : false) : si `wait` est true,
487 attend que la commande ait fini de s'exécuter.
488
489 ### `aliases` : définir des alias
490
491 Il est possible de définir des alias pour les différents paramètres. Ces alias
492 sont internes au fichier de configuration ; pour afficher un "joli" nom d'une
493 musique, voir plutôt "music_properties".
494
495 La syntaxe est la suivante:
496
497 :::yaml
498 aliases:
499 alias1:
500 param: value
501 alias2:
502 param1: value1
503 param2: value2
504
505 On utilise ensuite, dans le fichier de configuration, `include: alias1` ou
506 `include: [alias1, alias2]` à la place de `param: value`. Dans le cas de
507 plusieurs aliases inclus contenant des éléments identiques, seul le dernier est
508 pris en compte. Dans tous les cas, les alias ne sont *pas* prioritaires par
509 rapport aux éventuels paramètres définis là où ils sont inclus. Voir les
510 exemples ci-dessous.
511
512 #### Exemples
513
514 :::yaml
515 aliases:
516 music1:
517 file: "path/to/my/favourite/music.mp3"
518
519 keys:
520 'a':
521 play:
522 include: music1
523
524 `music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À
525 chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut
526 écrire à la place `include: music1`. Attention, dans la section
527 "music_properties", les alias ne fonctionnent pas, et il faut écrire le nom du
528 fichier complet.
529
530 :::yaml
531 aliases:
532 blue:
533 color: [0, 0, 255]
534
535 keys_properties:
536 'a':
537 description:
538 -
539 - blue key
540 include: blue
541
542 `blue` est un alias pour la couleur `[0, 0, 255]`. À chaque fois qu'on veut
543 écrire `color: [0, 0, 255]`, on peut écrire `include: blue` à la place.
544
545 :::yaml
546 aliases:
547 long_time:
548 duration: 42
549
550 keys:
551 'b':
552 wait:
553 include: long_time
554 play:
555 file: "music1.mp3"
556
557 `long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration:
558 42`, on peut écrire `include: long_time`.
559
560 ## Problèmes possibles
561
562 Sont listés ci-dessous une liste de problèmes rencontrés, avec des solutions
563 proposées. Si vous en découvrez d'autre, contactez l'auteur pour les ajouter à
564 la liste.
565
566 * Le programme se lance et s'arrête tout de suite.
567
568 Il s'agit généralement d'une erreur de syntaxe dans le fichier de config. Dans
569 ce cas, le terminal doit afficher quelques détails sur l'erreur en question (au
570 moins la ligne correspondante).
571
572 * La musique "grésille" affreusement.
573
574 Il peut s'agir d'un problème de latence (avec certains ordinateurs un peu
575 lents). Essayez de changer la latence (par exemple, 0.1 seconde)
576
577 * Impossible de jouer plus d'une musique à la fois.
578
579 Le système n'arrive pas à mixer les musiques par lui-même. Vous pouvez essayer
580 de regarder la liste des périphériques de son (`--list-devices`) puis en
581 sélectionner un autre si disponible. Vous pouvez aussi essayer le mixeur intégré
582 à music_sampler, mais les résultats ne sont pas toujours très fluides (ne pas
583 hésiter à jouer avec les paramètres avancés comme latency et blocksize).
584
585 Si votre système utilise PulseAudio, il peut s'agir d'un problème de
586 configuration du plugin ALSA. Dans ce cas, essayez de mettre la configuration
587 suivante dans `/etc/asound.conf`, puis redémarrer la machine (solution empirique
588 qui semble avoir fonctionné, sans garantie !):
589
590 pcm.!default {
591 type pulse
592 fallback "sysdefault"
593 hint {
594 show on
595 description "Default ALSA Output (currently PulseAudio Sound Server)"
596 }
597 }
598
599 ctl.!default {
600 type pulse
601 fallback "sysdefault"
602 }
603
604 * La console affiche une erreur :
605
606 Exception in thread Thread-1:
607 Traceback (most recent call last):
608 File "threading.py", line 914, in _bootstrap_inner
609 File "threading.py", line 862, in run
610 File "kivy/input/providers/mtdev.py", line 219, in _thread_run
611 File "kivy/lib/mtdev.py", line 131, in __init__
612 PermissionError: [Errno 13] Permission denied: '/dev/input/event6'
613
614 C'est une erreur de permission d'accès à un périphérique, généré par la
615 librairie kivy. Elle peut être ignorée et n'aura pas d'incidence.
616
617 * Pour d'autres problèmes ou bugs à reporter, voir le [Bug
618 Tracker](https://git.immae.eu/mantisbt/view_all_bug_page.php?project_id=1&sort=status%2Clast_updated&dir=ASC%2CDESC)
619
620 ## Divers
621
622 Les extraits de musiques proposés en exemples proviennent de
623 [Jamendo](https://jamendo.com). Les musiques (complètes) sont disponibles en
624 libre téléchargement pour un usage non commercial :
625
626 [Short Blues](https://www.jamendo.com/track/340173/short-blues)
627
628 [To the Fantasy war](https://www.jamendo.com/track/778560/to-the-fantasy-war)
629
630 Le bruit de crocodile provient de
631 [Universal-Soundbank](http://www.universal-soundbank.com/).
632
633 Cet outil a été développé à l'origine pour faciliter la gestion du son pour les
634 spectacles de la compagnie circassienne [Les pieds
635 jaloux](http://piedsjaloux.fr/). N'ayant pas d'ingénieur son, les artistes
636 eux-mêmes peuvent alors gérer leur musique lorsqu'ils ne sont pas sur scène :
637 d'où la nécessité de préparer les transitions à l'avance et, au moment de la
638 représentation, de réduire l'interaction avec la machine au minimum (une
639 touche).