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
11 ## Pré-requis et installation
13 - Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` (debian) :
15 sudo apt-get install libav-tools
17 Si vous utilisez la version compilée de Music Sampler (cf. plus bas pour un lien
18 de téléchargement), il n'y a rien d'autre à installer.
20 - Pour utiliser les sources directement, les modules suivants sont requis:
22 | module | version minimale | commentaire |
23 | ----------- | ---------------- | ----------------------------------------------------------------------------- |
24 | Cython | 0.24 | pour compiler Kivy |
25 | Kivy | 1.9.1 | certaines fonctionnalités nécessitent de compiler/installer avec `USE_SDL2=1` |
26 | Markdown | 2.6.6 | pour la documentation uniquement |
28 | Pygame | 1.9.2.dev1 | utilisée par Kivy |
29 | Pygments | 2.1.3 | pour la documentation uniquement |
30 | sounddevice | 0.3.3 | |
31 | transitions | 0.4.1 | |
34 Le projet est également disponible via `pip`:
36 pip install music_sampler
38 Le programme utilise les polices `Symbola` et `Ubuntu` (Regular / Bold), qui
39 doivent être disponibles, et la librairie `portaudio`:
41 sudo apt-get install ttf-ancient-fonts ttf-ubuntu-font-family portaudio
43 Pour compiler kivy avec la librairie SDL2, il faut certains paquets installés:
45 sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev
48 Kivy](https://kivy.org/docs/installation/installation-linux.html)
52 Une version compilée peut être créée avec pyinstaller:
55 pyinstaller music_sampler.spec
59 - Un exemple de configuration ainsi que des musiques associées à l'exemple
60 peuvent être trouvées sur
61 [owncloud](https://outils.immae.eu/owncloud/index.php/s/kSrIe15G1AiZ9YF)
62 - Une version précompilée de `music_sampler` peut également être téléchargée
64 dossier](https://outils.immae.eu/owncloud/index.php/s/kSrIe15G1AiZ9YF/download?path=%2F&files=music_sampler)
65 (attention, elle n'est pas toujours forcément à jour, lancer le programme avec
66 `-V` pour voir la version compilée)
70 Tout le travail consiste à préparer les transitions dans le fichier de
71 configuration `config.yml`.
73 Lancer ensuite le programme dans le dossier où se situe le fichier de
74 configuration (voir plus bas pour une utilisation avancée). Une fenêtre
75 représentant un clavier apparaît. Le rond orange dans le coin du clavier devient
76 vert lorsque tout est chargé, ou rouge en cas de problème. Une touche grisée et
77 barrée représente une touche non-utilisable pour le moment : soit parce que la
78 musique est en cours de chargement (au lancement du programme, cela peut prendre
79 un peu de temps sur certaines machines), soit parce qu'il y a une action en
82 Un exemple de fichier de configuration est fourni, avec un certain nombre de
83 touches et de transitions programmées (pour les trois musiques fournies), la
84 syntaxe du fichier (expliquée plus bas) se comprend aisément en le regardant. De
85 plus, certaines touches (par exemple 'ÉCHAP' pour tout arrêter) peuvent être
86 gardées d'une fois sur l'autre.
90 - Cliquer sur une touche : affiche les actions associées à cette touche (dans
91 le cadre en bas à gauche).
92 - Appuyer sur une touche : déclenche les actions associées à cette touche
93 (affichées également dans le cadre en bas à gauche). Lorsqu'une touche a des
94 actions en cours, son cadre est noir. Notez qu'une action de type "jouer une
95 musique" est considérée comme terminée quand ladite musique est lancée. En
96 cas d'appui répété sur une touche, music_sampler ne relance pas les actions
97 associées à cette touche si ces actions ne sont pas terminées ; cela pour
98 éviter les "accidents".
99 - Ctrl+C ou Ctrl+Q : quitte le programme (possible aussi en cliquant
100 simplement sur la croix en haut à droite).
101 - Ctrl+R : recharge le fichier de configuration.
103 ### Options disponibles au lancement
105 Toutes les options au lancement sont facultatives ; la plupart du temps lancer
106 le programme dans le bon dossier suffit. La plupart d'entre elles peuvent être
107 définies également dans le fichier de config (à part `--config` bien sûr). Les
108 arguments en ligne de commande ont toujours la priorité.
110 * `-h, --help` : affiche une liste des options disponibles.
111 * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger
112 (par défaut, config.yml qui se trouve dans le dossier où est lancé
114 * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques
115 (par défaut, le dossier courant).
116 * `--no-debug, --debug` : Affiche les informations de déboggage (désactivé par
118 * `-V, --version` : affiche la version courante et quitte (utilisable
119 uniquement pour la version compilée).
120 * `-L, --language` : change la langue de l'application. Actuellement: fr, en
122 * `--focus-warning, --no-focus-warning`: Afficher / Ne pas afficher
123 d'avertissement lorsque l'application perd le focus (activé par défaut).
125 Les options suivantes sont plutôt réservées à un usage avancé de music_sampler,
126 ou en cas de problème avec la configuration standard :
128 * `--no-builtin-mixing, --builtin-mixing` Effectue en interne le mixage des
129 sons. Par défaut, music_sampler confie le mixage au système : n'activer
130 cette option que si le système n'y parvient pas.
131 * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un
132 nombre de secondes (par défaut, "high")
133 * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames
134 pour chaque étape du mixeur. 0 (par défaut) signifie que le programme
135 choisit lui-même le nombre qui lui convient.
136 * `-f FRAME_RATE, --frame-rate FRAME_RATE` : fréquence d'échantillonnage pour
137 jouer les musiques. Par défaut : 44100
138 * `-x CHANNELS, --channels CHANNELS` : nombre de canaux par musique (2 par
139 défaut, pour une écoute stéréo)
140 * `-s SAMPLE_WIDTH, --sample-width SAMPLE_WIDTH` : largeur d'échantillonnage
141 (nombre d'octets pour chaque frame). Par défaut : 2.
142 * `--device DEVICE` : sélectionne le périphérique de son.
143 * `--list-devices` : Affiche la liste des périphériques de son disponibles.
144 * `-- ARGS` : Arguments à passer à la librairie Kivy.
146 ## Configurer les touches
148 **ATTENTION : le format du fichier de configuration est susceptible d'évoluer,
149 sans garantie de rétrocompatibilité.**
151 Le fichier config.yml utilise la syntaxe yaml. Les catégories et sous-catégories
152 sont gérées par l'indentation par des espaces (mais PAS par des tabulations !).
153 le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne
156 En cas d'erreur dans le fichier de configuration, un message d'erreur s'affiche
157 dans le terminal. Selon la "gravité" de l'erreur, music_sampler se lance en
158 ignorant les actions erronées (en colorant éventuellement la touche en noir), ou
159 ne se lance pas du tout.
161 Le fichier contient plusieurs sections :
182 La section config permet d'enregistrer les paramètres habituellement donnés en
183 ligne de commande. Les '-' dans le nom du paramètre long doivent être remplacés
184 par des '_' (par exemple '--music-path' -> 'music_path'). Pour les switches
185 (`debug`, `focus_warning`, `builtin_mixing`), utilisez la version sans le 'no-'
186 et spécifiez `true` / `false` en valeur. Notez que les arguments donnés en ligne
187 de commande sont toujours prioritaires sur les valeurs du fichier.
189 ### `music_properties` : propriétés des musiques
191 Cette section sert à définir des propriétés globales des musiques.
197 name: My favorite music
199 La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est
200 chargée à 140% de son volume normal.
206 La musique "music2.mp3" est chargée à 70% de son volume normal.
208 #### Liste des options possibles
209 - `name: My music` La musique sera désignée (dans les actions, dans le
210 terminal) comme "My music" au lieu du chemin du fichier. Par exemple le cadre
211 des actions affichera "starting « My music » at volume 100%". Attention, cela
212 ne fait pas office d'alias dans le fichier de configuration (voir la section
214 - `gain: x` Charge la musique avec un gain de x (multiplicatif). Utiliser la
215 commande "volume" pour changer ponctuellement le volume (0 à 100%) au cours de
218 ### `key_properties` : affichage et propriétés des touches
220 Cette section sert à décrire l'affichage à l'écran des touches : couleur et
221 texte. Par défaut, une touche "attribuée" à une ou plusieurs actions s'affiche
234 La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la
235 deuxième ligne. Si on appuie deux fois sur la même touche à moins de deux
236 secondes d'intervalle, le second appui est ignoré.
238 #### Liste des options possibles
239 - `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut
240 mettre un tiret pour une ligne de texte (pas de retour à la ligne
241 automatique). La première ligne correspond à celle de la lettre associée à la
242 touche, aussi il vaut mieux souvent la laisser vide, ou ne mettre que très peu
243 de texte (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on
244 peut compter 3 lignes (incluant la première) pour une touche "standard".
245 - `color: [r, g, b]` : la couleur de la touche. r, g et b sont les proportions
246 de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
247 - `repeat_delay: x` (par défaut : 0) : délai de "sécurité" en cas d'appuis
248 successifs sur la touche. La touche est désactivée (grisée et barrée) pendant
249 toute la durée des actions puis le délai de x secondes.
251 ### Propriété `common`
253 Une entrée spéciale `common` s'applique à toutes les touches. Les propriétés
254 définies dans cette entrée peuvent être modifiées individuellement.
256 ### `keys` : actions sur les touches
258 Cette section sert à décrire, pour chaque touche, la liste des actions
259 successives. Notez que la plupart des actions (hors `wait` et quelques cas
260 particuliers, voir plus bas) sont quasi-instantanées.
277 Lance la musique "music1.mp3" à 70% de son volume max, à 10 secondes du début,
278 puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
290 Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
306 Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du
307 fondu, puis attend encore deux secondes et lance la musique "music2.mp3", au
324 Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par
325 dessus (deux fois). Le volume revient à la normale une fois que les deux écoutes
326 du son "noise" sont terminées.
341 Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en
342 avançant de 5 secondes dans la musique.
344 #### Liste des actions possibles:
345 - `play` : joue une musique. music_sampler ne joue qu'une musique à la fois : si
346 la musique demandée est déjà en train d'être jouée, elle n'est pas relancée ou
347 jouée "par dessus". Paramètres :
348 * `file: "music.mp3"` précise la musique jouée (chemin relatif).
349 * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x
351 * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de
353 * `loop: x` (facultatif, défaut : 0) la musique doit être répétée x fois.
354 Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de
355 répétitions, donc pour lire trois fois la musique, mettre `loop: 2`.
356 * `start_at: x` (facultatif, défaut : 0) la musique démarre à x secondes du
358 * `restart_if_running: true/false` (facultatif, défaut : false) la musique
359 est éventuellement stoppée et redémarrée si nécessaire
360 - `stop` : arrête une musique donnée. Paramètres :
361 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune
362 musique n'est précisée, le `stop` s'applique à toutes les musiques.
363 * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
364 * `wait: true/false` (facultatif, par défaut : false) dans le cas d'un
365 fondu, attendre la durée du fondu pour faire les actions suivantes. Si la
366 musique s'arrêtait naturellement avant la fin du fondu, l'attente se
367 termine lorsque la musique se termine naturellement. Lorsque plusieurs
368 musiques sont stoppées en fondu, le `wait` n'attend que la dernière
369 musique de la playlist (qui peut se terminer naturellement avant les
371 * `set_wait_id: name` (facultatif, inutile lorsque `wait` est à false) donne
372 l'identifiant `name` à l'attente de fin du fondu (voir `interrupt_wait`).
373 L'identifiant peut être n'importe quelle chaîne de caractère.
374 - `volume` : change le volume d'une musique donnée. Paramètres :
375 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique
376 n'est précisée, la modification s'applique au volume global.
377 * `delta: true/false` (facultatif, par défaut : false) le volume doit il
378 être précisé en absolu (false), ou en relatif (true), voir plus bas.
379 * `value: x` Si delta est à false, met le volume à x% du volume max (x doit
380 être entre 0 et 100). Ce facteur est appliqué à la musique déjà chargée en
381 mémoire (voir section "propriétés"), donc le 100% fait référence au volume
383 Si delta est à true, applique un modificateur de x% au volume (x doit être un
384 entier signé). Notez qu'une action "+10%" relative ne correspond pas à un
385 pourcentage du volume actuel, mais du volume "de référence" 100%. Ainsi,
386 effectuer +10% et -10% en relatif revient bien à 100%.
387 * `fade: x` (facultatif) le changement de volume est appliqué en fondu sur x
388 secondes. Il n'y a pas d'attente de la fin du fondu pour lancer les
389 actions suivantes : au besoin, rajouter un `wait` à la main.
390 - `pause` : met en pause une musique. Paramètres :
391 * `file: "music.mp3"` (facultatif) précise la musique à mettre en pause. Si
392 non précisé, s'applique à toutes les musiques.
393 - `unpause` : relance une musique mise en pause (là où elle en était).
395 * `file: "music.mp3"` (facultatif) précise la musique à relancer. Si non
396 précisé, s'applique à toutes les musiques.
397 - `wait` : attend un temps donné. Paramètres :
398 * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
399 * `duration: x` (facultatif) attend x secondes. Si `file` et `duration` sont
400 précisés, l'attente dure jusqu'à la fin de la musique PUIS la durée donnée
402 * `set_wait_id: name` (facultatif) donne l'identifiant `name` à l'attente
403 (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne
405 Notez une fois encore que `wait` est quasiment la seule action qui attend
406 d'avoir terminé pour lancer la commande suivante, toutes les autres sont lancées
407 successivement mais sans attendre (donc presque simultanément) : ne pas hésiter
408 à rajouter des commandes d'attente partout où c'est nécessaire.
409 - `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
410 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique
411 n'est précisée, l'action s'applique à toutes les musiques.
412 * `delta: true/false` (facultatif, défaut : false) Si `delta` est true, le
413 temps est relatif. Si delta est false, le temps est absolu, voir plus bas.
414 * `value: x` Si `delta` est true, alors fait avancer de x secondes dans la
415 musique (reculer si x est négatif). Si delta est false, alors la lecture
416 se place à x secondes à partir du début. Si la musique est en train de
417 faire un fondu (au départ, ou changement de volume), le fondu se "termine
418 automatiquement" : et la musique est immédiatement au volume final voulu.
419 Si la musique est en train de se terminer en fondu, le "seek" est ignoré
420 (un fondu de fin considère la musique comme déjà terminée). En cas de
421 `loop`, si le déplacement est relatif la musique peut éventuellement
422 passer à la répétition suivante / précédente; sinon, le déplacement se
423 fait dans la répétition courante.
424 - `stop_all_actions:` Interrompt toutes les actions en cours et à faire. Notez
425 qu'une musique lancée (y compris avec une option `loop`) est considérée comme
426 une action "déjà terminée", et ne sera donc pas interrompue (utiliser `stop`
427 sans arguments pour stopper toutes les musiques en écoute). Paramètre :
428 * `other_only: true/false` (facultatif, défaut : false) : si `other_only`
429 est true, la commande interrompt uniquement les actions des *autres*
430 touches. Sinon, cette commande interrompt également les actions de la
431 touche actuelle ; dans ce cas il est inutile de mettre des actions à la
432 suite de celle-ci puisqu'elles seront systématiquement interrompues.
433 - `interrupt_wait`: interrompt l'attente (de `wait` ou fin d'un fondu avec
434 attente) et passe directement à l'action suivante. Paramètre :
435 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à stopper
436 (défini par `set_wait_id`, voir les actions `wait` et `stop`). Si absent,
437 interrompt toutes les attentes.
438 - `pause_wait`: met une attente en pause (uniquement pour une attente ayant une
439 durée définie). La touche qui attend cet événement ne continuera pas tant que
440 l'attente n'est pas reprise. Paramètres :
441 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à mettre en
442 pause. Si absent, met en pause toutes les attentes compatibles.
443 - `unpause_wait`: reprend une attente en pause (uniquement pour une attente
444 ayant une durée définie). Le compte à rebours reprendra pour la touche
445 correspondante en train d'attendre. Paramètres:
446 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à reprendre.
447 Si absent, reprend toutes les attentes compatibles.
448 - `reset_wait`: réinitialise une attente (uniquement pour une attente ayant une
449 durée définie). Si l'attente est en pause, le compte à rebours ne recommencera
450 au début que lorsque l'attente sera reprise. Paramètres:
451 * `wait_id: name` (facultatif) précise l'identifiant du `wait` à
452 réinitialiser. Si absent, réinitialise toutes les attentes compatibles.
453 - `run_command` : lance une commande. Paramètres :
454 * `command: my_command` : précise la commande à lancer.
455 * `wait: true/false` (facultatif, défaut : false) : si `wait` est true,
456 attend que la commande ait fini de s'exécuter.
458 ### `aliases` : définir des alias
460 Il est possible de définir des alias pour les différents paramètres. Ces alias
461 sont internes au fichier de configuration ; pour afficher un "joli" nom d'une
462 musique, voir plutôt "music_properties".
464 La syntaxe est la suivante:
474 On utilise ensuite, dans le fichier de configuration, `include: alias1` ou
475 `include: [alias1, alias2]` à la place de `param: value`. Dans le cas de
476 plusieurs aliases inclus contenant des éléments identiques, seul le dernier est
477 pris en compte. Dans tous les cas, les alias ne sont *pas* prioritaires par
478 rapport aux éventuels paramètres définis là où ils sont inclus. Voir les
486 file: "path/to/my/favourite/music.mp3"
493 `music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À
494 chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut
495 écrire à la place `include: music1`. Attention, dans la section
496 "music_properties", les alias ne fonctionnent pas, et il faut écrire le nom du
511 `blue` est un alias pour la couleur `[0, 0, 255]`. À chaque fois qu'on veut
512 écrire `color: [0, 0, 255]`, on peut écrire `include: blue` à la place.
526 `long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration:
527 42`, on peut écrire `include: long_time`.
529 ## Problèmes possibles
531 Sont listés ci-dessous une liste de problèmes rencontrés, avec des solutions
532 proposées. Si vous en découvrez d'autre, contactez l'auteur pour les ajouter à
535 * Le programme se lance et s'arrête tout de suite.
537 Il s'agit généralement d'une erreur de syntaxe dans le fichier de config. Dans
538 ce cas, le terminal doit afficher quelques détails sur l'erreur en question (au
539 moins la ligne correspondante).
541 * La musique "grésille" affreusement.
543 Il peut s'agir d'un problème de latence (avec certains ordinateurs un peu
544 lents). Essayez de changer la latence (par exemple, 0.1 seconde)
546 * Impossible de jouer plus d'une musique à la fois.
548 Le système n'arrive pas à mixer les musiques par lui-même. Vous pouvez essayer
549 de regarder la liste des périphériques de son (`--list-devices`) puis en
550 sélectionner un autre si disponible. Vous pouvez aussi essayer le mixeur intégré
551 à music_sampler, mais les résultats ne sont pas toujours très fluides (ne pas
552 hésiter à jouer avec les paramètres avancés comme latency et blocksize).
554 Si votre système utilise PulseAudio, il peut s'agir d'un problème de
555 configuration du plugin ALSA. Dans ce cas, essayez de mettre la configuration
556 suivante dans `/etc/asound.conf`, puis redémarrer la machine (solution empirique
557 qui semble avoir fonctionné, sans garantie !):
561 fallback "sysdefault"
564 description "Default ALSA Output (currently PulseAudio Sound Server)"
570 fallback "sysdefault"
573 * La console affiche une erreur :
575 Exception in thread Thread-1:
576 Traceback (most recent call last):
577 File "threading.py", line 914, in _bootstrap_inner
578 File "threading.py", line 862, in run
579 File "kivy/input/providers/mtdev.py", line 219, in _thread_run
580 File "kivy/lib/mtdev.py", line 131, in __init__
581 PermissionError: [Errno 13] Permission denied: '/dev/input/event6'
583 C'est une erreur de permission d'accès à un périphérique, généré par la
584 librairie kivy. Elle peut être ignorée et n'aura pas d'incidence.
586 * Pour d'autres problèmes ou bugs à reporter, voir le [Bug
587 Tracker](https://git.immae.eu/mantisbt/view_all_bug_page.php?project_id=1&sort=status%2Clast_updated&dir=ASC%2CDESC)
591 Les extraits de musiques proposés en exemples proviennent de
592 [Jamendo](https://jamendo.com). Les musiques (complètes) sont disponibles en
593 libre téléchargement pour un usage non commercial :
595 [Short Blues](https://www.jamendo.com/track/340173/short-blues)
597 [To the Fantasy war](https://www.jamendo.com/track/778560/to-the-fantasy-war)
599 Le bruit de crocodile provient de
600 [Universal-Soundbank](http://www.universal-soundbank.com/).
602 Cet outil a été développé à l'origine pour faciliter la gestion du son pour les
603 spectacles de la compagnie circassienne [Les pieds
604 jaloux](http://piedsjaloux.fr/). N'ayant pas d'ingénieur son, les artistes
605 eux-mêmes peuvent alors gérer leur musique lorsqu'ils ne sont pas sur scène :
606 d'où la nécessité de préparer les transitions à l'avance et, au moment de la
607 représentation, de réduire l'interaction avec la machine au minimum (une
projects / perso / Immae / Projets / Python / MusicSampler.git / blob