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.
108 * `-h, --help` : affiche une liste des options disponibles.
109 * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger
110 (par défaut, config.yml qui se trouve dans le dossier où est lancé
112 * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques
113 (par défaut, le dossier courant).
114 * `-d, --debug` : Affiche les informations de déboggage (désactivé par défaut)
115 * `-V, --version` : affiche la version courante et quitte (utilisable
116 uniquement pour la version compilée).
117 * `-L, --language` : change la langue de l'application. Actuellement: fr, en
119 * `--no-focus-warning`: Ne pas afficher d'avertissement lorsque l'application
122 Les options suivantes sont plutôt réservées à un usage avancé de music_sampler,
123 ou en cas de problème avec la configuration standard :
125 * `-m, --builtin-mixing` Effectue en interne le mixage des sons. Par défaut,
126 music_sampler confie le mixage au système : n'activer cette option que si le
127 système n'y parvient pas.
128 * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un
129 nombre de secondes (par défaut, "high")
130 * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames
131 pour chaque étape du mixeur. 0 (par défaut) signifie que le programme
132 choisit lui-même le nombre qui lui convient.
133 * `-f FRAME_RATE, --frame-rate FRAME_RATE` : fréquence d'échantillonnage pour
134 jouer les musiques. Par défaut : 44100
135 * `-x CHANNELS, --channels CHANNELS` : nombre de canaux par musique (2 par
136 défaut, pour une écoute stéréo)
137 * `-s SAMPLE_WIDTH, --sample-width SAMPLE_WIDTH` : largeur d'échantillonnage
138 (nombre d'octets pour chaque frame). Par défaut : 2.
139 * `--device DEVICE` : sélectionne le périphérique de son.
140 * `--list-devices` : Affiche la liste des périphériques de son disponibles.
141 * `-- ARGS` : Arguments à passer à la librairie Kivy.
143 ## Configurer les touches
145 **ATTENTION : le format du fichier de configuration est susceptible d'évoluer,
146 sans garantie de rétrocompatibilité.**
148 Le fichier config.yml utilise la syntaxe yaml. Les catégories et sous-catégories
149 sont gérées par l'indentation par des espaces (mais PAS par des tabulations !).
150 le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne
153 En cas d'erreur dans le fichier de configuration, un message d'erreur s'affiche
154 dans le terminal. Selon la "gravité" de l'erreur, music_sampler se lance en
155 ignorant les actions erronées (en colorant éventuellement la touche en noir), ou
156 ne se lance pas du tout.
158 Le fichier contient plusieurs sections :
174 ### `music_properties` : propriétés des musiques
176 Cette section sert à définir des propriétés globales des musiques.
182 name: My favorite music
184 La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est
185 chargée à 140% de son volume normal.
191 La musique "music2.mp3" est chargée à 70% de son volume normal.
193 #### Liste des options possibles
194 - `name: My music` La musique sera désignée (dans les actions, dans le
195 terminal) comme "My music" au lieu du chemin du fichier. Par exemple le cadre
196 des actions affichera "starting « My music » at volume 100%". Attention, cela
197 ne fait pas office d'alias dans le fichier de configuration (voir la section
199 - `gain: x` Charge la musique avec un gain de x (multiplicatif). Utiliser la
200 commande "volume" pour changer ponctuellement le volume (0 à 100%) au cours de
203 ### `key_properties` : affichage et propriétés des touches
205 Cette section sert à décrire l'affichage à l'écran des touches : couleur et
206 texte. Par défaut, une touche "attribuée" à une ou plusieurs actions s'affiche
219 La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la
220 deuxième ligne. Si on appuie deux fois sur la même touche à moins de deux
221 secondes d'intervalle, le second appui est ignoré.
223 #### Liste des options possibles
224 - `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut
225 mettre un tiret pour une ligne de texte (pas de retour à la ligne
226 automatique). La première ligne correspond à celle de la lettre associée à la
227 touche, aussi il vaut mieux souvent la laisser vide, ou ne mettre que très peu
228 de texte (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on
229 peut compter 3 lignes (incluant la première) pour une touche "standard".
230 - `color: [r, g, b]` : la couleur de la touche. r, g et b sont les proportions
231 de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
232 - `repeat_delay: x` (par défaut : 0) : délai de "sécurité" en cas d'appuis
233 successifs sur la touche. La touche est désactivée (grisée et barrée) pendant
234 toute la durée des actions puis le délai de x secondes.
236 ### `keys` : actions sur les touches
238 Cette section sert à décrire, pour chaque touche, la liste des actions
239 successives. Notez que la plupart des actions (hors `wait` et quelques cas
240 particuliers, voir plus bas) sont quasi-instantanées.
257 Lance la musique "music1.mp3" à 70% de son volume max, à 10 secondes du début,
258 puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
270 Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
286 Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du
287 fondu, puis attend encore deux secondes et lance la musique "music2.mp3", au
304 Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par
305 dessus (deux fois). Le volume revient à la normale une fois que les deux écoutes
306 du son "noise" sont terminées.
321 Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en
322 avançant de 5 secondes dans la musique.
324 #### Liste des actions possibles:
325 - `play` : joue une musique. music_sampler ne joue qu'une musique à la fois : si
326 la musique demandée est déjà en train d'être jouée, elle n'est pas relancée ou
327 jouée "par dessus". Paramètres :
328 * `file: "music.mp3"` précise la musique jouée (chemin relatif).
329 * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x
331 * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de
333 * `loop: x` (facultatif, défaut : 0) la musique doit être répétée x fois.
334 Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de
335 répétitions, donc pour lire trois fois la musique, mettre `loop: 2`.
336 * `start_at: x` (facultatif, défaut : 0) la musique démarre à x secondes du
338 * `restart_if_running: true/false` (facultatif, défaut : false) la musique
339 est éventuellement stoppée et redémarrée si nécessaire
340 - `stop` : arrête une musique donnée. Paramètres :
341 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune
342 musique n'est précisée, le `stop` s'applique à toutes les musiques.
343 * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
344 * `wait: true/false` (facultatif, par défaut : false) dans le cas d'un
345 fondu, attendre la durée du fondu pour faire les actions suivantes. Si la
346 musique s'arrêtait naturellement avant la fin du fondu, l'attente se
347 termine lorsque la musique se termine naturellement. Lorsque plusieurs
348 musiques sont stoppées en fondu, le `wait` n'attend que la dernière
349 musique de la playlist (qui peut se terminer naturellement avant les
351 * `set_wait_id: name` (facultatif, inutile lorsque `wait` est à false) donne
352 l'identifiant `name` à l'attente de fin du fondu (voir `interrupt_wait`).
353 L'identifiant peut être n'importe quelle chaîne de caractère.
354 - `volume` : change le volume d'une musique donnée. Paramètres :
355 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique
356 n'est précisée, la modification s'applique au volume global.
357 * `delta: true/false` (facultatif, par défaut : false) le volume doit il
358 être précisé en absolu (false), ou en relatif (true), voir plus bas.
359 * `value: x` Si delta est à false, met le volume à x% du volume max (x doit
360 être entre 0 et 100). Ce facteur est appliqué à la musique déjà chargée en
361 mémoire (voir section "propriétés"), donc le 100% fait référence au volume
363 Si delta est à true, applique un modificateur de x% au volume (x doit être un
364 entier signé). Notez qu'une action "+10%" relative ne correspond pas à un
365 pourcentage du volume actuel, mais du volume "de référence" 100%. Ainsi,
366 effectuer +10% et -10% en relatif revient bien à 100%.
367 * `fade: x` (facultatif) le changement de volume est appliqué en fondu sur x
368 secondes. Il n'y a pas d'attente de la fin du fondu pour lancer les
369 actions suivantes : au besoin, rajouter un `wait` à la main.
370 - `pause` : met en pause une musique. Paramètres :
371 * `file: "music.mp3"` (facultatif) précise la musique à mettre en pause. Si
372 non précisé, s'applique à toutes les musiques.
373 - `unpause` : relance une musique mise en pause (là où elle en était).
375 * `file: "music.mp3"` (facultatif) précise la musique à relancer. Si non
376 précisé, s'applique à toutes les musiques.
377 - `wait` : attend un temps donné. Paramètres :
378 * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
379 * `duration: x` (facultatif) attend x secondes. Si `file` et `duration` sont
380 précisés, l'attente dure jusqu'à la fin de la musique PUIS la durée donnée
382 * `set_wait_id: name` (facultatif) donne l'identifiant `name` à l'attente
383 (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne
385 Notez une fois encore que `wait` est quasiment la seule action qui attend
386 d'avoir terminé pour lancer la commande suivante, toutes les autres sont lancées
387 successivement mais sans attendre (donc presque simultanément) : ne pas hésiter
388 à rajouter des commandes d'attente partout où c'est nécessaire.
389 - `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
390 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique
391 n'est précisée, l'action s'applique à toutes les musiques.
392 * `delta: true/false` (facultatif, défaut : false) Si `delta` est true, le
393 temps est relatif. Si delta est false, le temps est absolu, voir plus bas.
394 * `value: x` Si `delta` est true, alors fait avancer de x secondes dans la
395 musique (reculer si x est négatif). Si delta est false, alors la lecture
396 se place à x secondes à partir du début. Si la musique est en train de
397 faire un fondu (au départ, ou changement de volume), le fondu se "termine
398 automatiquement" : et la musique est immédiatement au volume final voulu.
399 Si la musique est en train de se terminer en fondu, le "seek" est ignoré
400 (un fondu de fin considère la musique comme déjà terminée). En cas de
401 `loop`, si le déplacement est relatif la musique peut éventuellement
402 passer à la répétition suivante / précédente; sinon, le déplacement se
403 fait dans la répétition courante.
404 - `stop_all_actions:` Interrompt toutes les actions en cours et à faire. Notez
405 qu'une musique lancée (y compris avec une option `loop`) est considérée comme
406 une action "déjà terminée", et ne sera donc pas interrompue (utiliser `stop`
407 sans arguments pour stopper toutes les musiques en écoute). Paramètre :
408 * `other_only: true/false` (facultatif, défaut : false) : si `other_only`
409 est true, la commande interrompt uniquement les actions des *autres*
410 touches. Sinon, cette commande interrompt également les actions de la
411 touche actuelle ; dans ce cas il est inutile de mettre des actions à la
412 suite de celle-ci puisqu'elles seront systématiquement interrompues.
413 - `interrupt_wait`: interrompt l'attente (de `wait` ou fin d'un fondu avec
414 attente) et passe directement à l'action suivante. Paramètre :
415 * `wait_id: name` : précise l'identifiant du `wait` à stopper (défini par
416 `set_wait_id`, voir les actions `wait` et `stop`). Pour interrompre
417 plusieurs `wait` d'un seul coup, il faut mettre plusieurs
419 - `run_command` : lance une commande. Paramètres :
420 * `command: my_command` : précise la commande à lancer.
421 * `wait: true/false` (facultatif, défaut : false) : si `wait` est true,
422 attend que la commande ait fini de s'exécuter.
424 ### `aliases` : définir des alias
426 Il est possible de définir des alias pour les différents paramètres. Ces alias
427 sont internes au fichier de configuration ; pour afficher un "joli" nom d'une
428 musique, voir plutôt "music_properties".
430 La syntaxe est la suivante:
440 On utilise ensuite, dans le fichier de configuration, `include: alias1` ou
441 `include: [alias1, alias2]` à la place de `param: value`. Dans le cas de
442 plusieurs aliases inclus contenant des éléments identiques, seul le dernier est
443 pris en compte. Dans tous les cas, les alias ne sont *pas* prioritaires par
444 rapport aux éventuels paramètres définis là où ils sont inclus. Voir les
452 file: "path/to/my/favourite/music.mp3"
459 `music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À
460 chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut
461 écrire à la place `include: music1`. Attention, dans la section
462 "music_properties", les alias ne fonctionnent pas, et il faut écrire le nom du
477 `blue` est un alias pour la couleur `[0, 0, 255]`. À chaque fois qu'on veut
478 écrire `color: [0, 0, 255]`, on peut écrire `include: blue` à la place.
492 `long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration:
493 42`, on peut écrire `include: long_time`.
495 ## Problèmes possibles
497 Sont listés ci-dessous une liste de problèmes rencontrés, avec des solutions
498 proposées. Si vous en découvrez d'autre, contactez l'auteur pour les ajouter à
501 * Le programme se lance et s'arrête tout de suite.
503 Il s'agit généralement d'une erreur de syntaxe dans le fichier de config. Dans
504 ce cas, le terminal doit afficher quelques détails sur l'erreur en question (au
505 moins la ligne correspondante).
507 * La musique "grésille" affreusement.
509 Il peut s'agir d'un problème de latence (avec certains ordinateurs un peu
510 lents). Essayez de changer la latence (par exemple, 0.1 seconde)
512 * Impossible de jouer plus d'une musique à la fois.
514 Le système n'arrive pas à mixer les musiques par lui-même. Vous pouvez essayer
515 de regarder la liste des périphériques de son (`--list-devices`) puis en
516 sélectionner un autre si disponible. Vous pouvez aussi essayer le mixeur intégré
517 à music_sampler, mais les résultats ne sont pas toujours très fluides (ne pas
518 hésiter à jouer avec les paramètres avancés comme latency et blocksize).
520 Si votre système utilise PulseAudio, il peut s'agir d'un problème de
521 configuration du plugin ALSA. Dans ce cas, essayez de mettre la configuration
522 suivante dans `/etc/asound.conf`, puis redémarrer la machine (solution empirique
523 qui semble avoir fonctionné, sans garantie !):
527 fallback "sysdefault"
530 description "Default ALSA Output (currently PulseAudio Sound Server)"
536 fallback "sysdefault"
539 * La console affiche une erreur :
541 Exception in thread Thread-1:
542 Traceback (most recent call last):
543 File "threading.py", line 914, in _bootstrap_inner
544 File "threading.py", line 862, in run
545 File "kivy/input/providers/mtdev.py", line 219, in _thread_run
546 File "kivy/lib/mtdev.py", line 131, in __init__
547 PermissionError: [Errno 13] Permission denied: '/dev/input/event6'
549 C'est une erreur de permission d'accès à un périphérique, généré par la
550 librairie kivy. Elle peut être ignorée et n'aura pas d'incidence.
552 * Pour d'autres problèmes ou bugs à reporter, voir le [Bug
553 Tracker](https://git.immae.eu/mantisbt/view_all_bug_page.php?project_id=1&sort=status%2Clast_updated&dir=ASC%2CDESC)
557 Les extraits de musiques proposés en exemples proviennent de
558 [Jamendo](https://jamendo.com). Les musiques (complètes) sont disponibles en
559 libre téléchargement pour un usage non commercial :
561 [Short Blues](https://www.jamendo.com/track/340173/short-blues)
563 [To the Fantasy war](https://www.jamendo.com/track/778560/to-the-fantasy-war)
565 Le bruit de crocodile provient de
566 [Universal-Soundbank](http://www.universal-soundbank.com/).
568 Cet outil a été développé à l'origine pour faciliter la gestion du son pour les
569 spectacles de la compagnie circassienne [Les pieds
570 jaloux](http://piedsjaloux.fr/). N'ayant pas d'ingénieur son, les artistes
571 eux-mêmes peuvent alors gérer leur musique lorsqu'ils ne sont pas sur scène :
572 d'où la nécessité de préparer les transitions à l'avance et, au moment de la
573 représentation, de réduire l'interaction avec la machine au minimum (une