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 transitions musicales, qui peuvent ensuite être lancées à l'aide d'un simple appui sur une touche.
   8
   9 ## Pré-requis et installation
  10
  11 Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` :
  12
  13     :::bash
  14     sudo apt-get install libav-tools
  15
  16 Si vous utilisez la version compilée de Music Sampler, il n'y a rien d'autre à installer.
  17
  18 ## Version compilée
  19
  20 Une version compilée peut être créée avec pyinstaller:
  21
  22     :::bash
  23     pyinstaller music_sampler.spec
  24
  25 ## Utilisation
  26
  27 Tout le travail consiste à préparer les transitions dans le fichier de configuration config.yml.
  28
  29 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. Le rond orange dans le coin du clavier devient vert lorsque tout est chargé, ou rouge en cas de problème. Une touche grisée et barrée représente une touche non-utilisable pour le moment : soit parce que la musique est en cours de chargement (au lancement du programme, cela peut prendre un peu de temps sur certaines machines), soit parce qu'il y a une action en cours.
  30
  31 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.
  32
  33 ### Actions possibles
  34
  35   - Cliquer sur une touche : affiche les actions associées à cette touche (dans le cadre en bas à gauche).
  36   - Appuyer sur une touche : déclenche les actions associées à cette touche (affichées également dans le cadre en bas à gauche). Lorsqu'une touche a des actions en cours, son cadre est noir. Notez qu'une action de type "jouer une musique" est considérée comme terminée quand ladite musique est lancée.
  37 En cas d'appui répété 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".
  38   - Ctrl+C ou Ctrl+Q : quitte le programme (possible aussi en cliquant simplement sur la croix en haut à droite).
  39   - Ctrl+R : recharge le fichier de configuration.
  40
  41 ### Options disponibles au lancement
  42
  43 Toutes les options au lancement sont facultatives ; la plupart du temps lancer le programme dans le bon dossier suffit.
  44
  45   * `-h, --help` : affiche une liste des options disponibles.
  46   * `-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).
  47   * `-p MUSIC_PATH, --music-path MUSIC_PATH` : précise le chemin des musiques (par défaut, le dossier courant).
  48   * `-d, --debug` : Affiche les informations de déboggage (désactivé par défaut)
  49   * `-V, --version` : affiche la version courante et quitte (utilisable uniquement pour la version compilée).
  50
  51 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 :
  52
  53   * `-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.
  54   * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un nombre de secondes (par défaut, "high")
  55   * `-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.
  56   * `-f FRAME_RATE, --frame-rate FRAME_RATE` : fréquence d'échantillonnage pour jouer les musiques. Par défaut : 44100
  57   * `-x CHANNELS, --channels CHANNELS` : nombre de canaux par musique (2 par défaut, pour une écoute stéréo)
  58   * `-s SAMPLE_WIDTH, --sample-width SAMPLE_WIDTH` : largeur d'échantillonnage (nombre d'octets pour chaque frame). Par défaut : 2.
  59   * `--device DEVICE` : sélectionne le périphérique de son.
  60   * `--list-devices` : Affiche la liste des périphériques de son disponibles.
  61   * `-- ARGS` : Arguments à passer à la librairie Kivy.
  62
  63 ## Configurer les touches
  64
  65 **ATTENTION : le format du fichier de configuration est susceptible d'évoluer, sans garantie de rétrocompatibilité.**
  66
  67 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 !).
  68 le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne est ignoré.
  69
  70 En 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 erronées (en colorant éventuellement la touche en noir), ou ne se lance pas du tout.
  71
  72 Le fichier contient plusieurs sections :
  73
  74     :::yaml
  75     aliases:
  76       ...
  77
  78     music_properties:
  79       ...
  80
  81     key_properties:
  82       ...
  83
  84     keys:
  85       ...
  86
  87
  88 ### `music_properties` : propriétés des musiques
  89
  90 Cette section sert à définir des propriétés globales des musiques.
  91
  92 #### Exemples
  93
  94     :::yaml
  95       "music1.mp3":
  96         name: My favorite music
  97         gain: 1.4
  98 La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est chargée à 140% de son volume normal.
  99
 100     :::yaml
 101       "music2.mp3":
 102         gain: 0.7
 103
 104 La musique "music2.mp3" est chargée à 70% de son volume normal.
 105
 106 #### Liste des options possibles
 107 - `name: My music` La musique sera désignée  (dans les actions, dans le terminal) comme "My music" au lieu du chemin du fichier. Par exemple le cadre des actions affichera "starting « My music » at volume 100%". Attention, cela ne fait pas office d'alias dans le fichier de configuration (voir la section *aliases*).
 108 - `gain: x` Charge la musique avec un gain de x (multiplicatif). Utiliser la commande "volume" pour changer ponctuellement le volume (0 à 100%) au cours de l'écoute.
 109
 110 ### `key_properties` : affichage et propriétés des touches
 111
 112 Cette section sert à décrire l'affichage à l'écran des touches : couleur et texte. Par défaut, une touche "attribuée" à une ou plusieurs actions s'affiche en vert.
 113
 114 #### Exemples
 115
 116     :::yaml
 117       'ESC':
 118         description:
 119           -
 120           - STOP !
 121         color: [255, 0, 0]
 122         repeat_delay: 2
 123
 124 La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne. Si on appuie deux fois sur la même touche à moins de deux secondes d'intervalle, le second appui est ignoré.
 125
 126 #### Liste des options possibles
 127 - `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut mettre un tiret pour une ligne de texte (pas de retour à la ligne automatique). La première ligne correspond à celle de la lettre associée à la touche, aussi il vaut mieux souvent la laisser vide, ou ne mettre que très peu de texte (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on peut compter 3 lignes (incluant la première) pour une touche "standard".
 128 - `color: [r, g, b]` : la couleur de la touche. r, g et b sont les proportions de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
 129 - `repeat_delay: x` (par défaut : 0) : délai de "sécurité" en cas d'appuis successifs sur la touche. La touche est désactivée (grisée et barrée) pendant toute la durée des actions puis le délai de x secondes.
 130
 131 ### `keys` : actions sur les touches
 132
 133 Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez que la plupart des actions (hors `wait` et quelques cas particuliers, voir plus bas) sont quasi-instantanées.
 134
 135
 136 #### Exemples
 137
 138     :::yaml
 139     'a':
 140       - play:
 141           file: "music1.mp3"
 142           volume: 70
 143           start_at: 10
 144       - wait:
 145           duration: 5
 146       - stop:
 147           file: "music1.mp3"
 148           fade_out: 2
 149
 150 Lance 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.
 151
 152     :::yaml
 153     'b':
 154       - stop:
 155           file: "music1.mp3"
 156           fade_out: 5
 157           wait: false
 158       - play:
 159           file: "music2.mp3"
 160           fade_in: 5
 161
 162 Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
 163
 164     :::yaml
 165     'c':
 166       - stop:
 167           file: "music1.mp3"
 168           fade_out: 5
 169           wait: true
 170       - wait:
 171           duration: 2
 172       - play:
 173           file: "music2.mp3"
 174       - seek:
 175           file: "music2.mp3"
 176           delta: false
 177           value: 60
 178 Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend encore deux secondes et lance la musique "music2.mp3", au temps d'une minute.
 179
 180     :::yaml
 181     'd':
 182       - volume:
 183           file: "music1.mp3"
 184           value: 50
 185       - play:
 186           file: "noise.mp3"
 187           loop: 1
 188       - wait:
 189           file: "noise.mp3"
 190       - volume:
 191           file: "music1.mp3"
 192           value: 100
 193
 194 Baisse 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.
 195
 196     :::yaml
 197     'e':
 198       - pause:
 199           file: "music1.mp3"
 200       - wait:
 201           duration: 10
 202       - unpause:
 203           file: "music1.mp3"
 204       - seek:
 205           file: "music1.mp3"
 206           delta: true
 207           value: 5
 208
 209 Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en avançant de 5 secondes dans la musique.
 210
 211 #### Liste des actions possibles:
 212 - `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 :
 213     * `file: "music.mp3"` précise la musique jouée (chemin relatif).
 214     * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x secondes.
 215     * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de son volume max.
 216     * `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`.
 217     * `start_at: x` (facultatif, défaut : 0) la musique démarre à x secondes du début.
 218     * `restart_if_running: true/false` (facultatif, défaut : false) la musique est éventuellement stoppée et redémarrée si nécessaire
 219 - `stop` : arrête une musique donnée. Paramètres :
 220     * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques.
 221     * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
 222     * `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. Lorsque plusieurs musiques sont stoppées en fondu, le `wait` n'attend que la dernière musique de la playlist (qui peut se terminer naturellement avant les autres).
 223     * `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.
 224 - `volume` : change le volume d'une musique donnée. Paramètres :
 225     * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global.
 226     * `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.
 227     * `value: x` Si delta est à false, met le volume à x% du volume max (x doit être entre 0 et 100).
 228 Ce facteur est appliqué à la musique déjà chargée en mémoire (voir section "propriétés"), donc le 100% fait référence au volume de chargement.
 229 Si delta est à true, applique un modificateur de x% au volume (x doit être un entier signé).
 230 Notez qu'une action "+10%" relative ne correspond pas à un pourcentage du volume actuel, mais du volume "de référence" 100%. Ainsi, effectuer +10% et -10% en relatif revient bien à 100%.
 231     * `fade: x` (facultatif) le changement de volume est appliqué en fondu sur x secondes. Il n'y a pas d'attente de la fin du fondu pour lancer les actions suivantes : au besoin, rajouter un `wait` à la main.
 232 - `pause` : met en pause une musique. Paramètres :
 233     * `file: "music.mp3"` (facultatif) précise la musique à mettre en pause. Si non précisé, s'applique à toutes les musiques.
 234 - `unpause` : relance une musique mise en pause (là où elle en était). Paramètres :
 235     * `file: "music.mp3"` (facultatif) précise la musique à relancer. Si non précisé, s'applique à toutes les musiques.
 236 - `wait` : attend un temps donné. Paramètres :
 237     * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
 238     * `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`.
 239     * `set_wait_id: name` (facultatif) donne l'identifiant `name` à l'attente (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne de caractère.
 240 Notez une fois encore 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.
 241 - `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
 242     * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
 243     * `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.
 244     * `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). En cas de `loop`, si le déplacement est relatif la musique peut éventuellement passer à la répétition suivante / précédente; sinon, le déplacement se fait dans la répétition courante.
 245 - `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). Paramètre :
 246     * `other_only: true/false` (facultatif, défaut : false) : si `other_only` est true, la commande interrompt uniquement les actions des *autres* touches. Sinon, cette commande interrompt également les actions de la touche actuelle ; dans ce cas il est inutile de mettre des actions à la suite de celle-ci puisqu'elles seront systématiquement interrompues.
 247 - `interrupt_wait`: interrompt l'attente (de `wait` ou fin d'un fondu avec attente) et passe directement à l'action suivante. Paramètre :
 248     * `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`.
 249 - `run_command` : lance une commande. Paramètres :
 250     * `command: my_command` : précise la commande à lancer.
 251     * `wait: true/false` (facultatif, défaut : false) : si `wait` est true, attend que la commande ait fini de s'exécuter.
 252
 253 ### `aliases` : définir des alias
 254
 255 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 "music_properties".
 256
 257 La syntaxe est la suivante:
 258
 259     :::yaml
 260     aliases:
 261       alias1:
 262         param: value
 263       alias2:
 264         param1: value1
 265         param2: value2
 266
 267 On utilise ensuite, dans le fichier de configuration, `include: alias1` ou `include: [alias1, alias2]` à la place de `param: value`. Dans le cas de plusieurs aliases inclus contenant des éléments identiques, seul le dernier est pris en compte. Dans tous les cas, les alias ne sont *pas* prioritaires par rapport aux éventuels paramètres définis là où ils sont inclus. Voir les exemples ci-dessous.
 268
 269 #### Exemples
 270
 271     :::yaml
 272     aliases:
 273       music1:
 274         file: "path/to/my/favourite/music.mp3"
 275
 276     keys:
 277       'a':
 278         play:
 279           include: music1
 280
 281 `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.
 282
 283     :::yaml
 284     aliases:
 285       blue:
 286         color: [0, 0, 255]
 287
 288     keys_properties:
 289       'a':
 290         description:
 291           -
 292           - blue key
 293         include: blue
 294
 295 `blue` est un alias pour la couleur `[0, 0, 255]`. À chaque fois qu'on veut écrire `color: [0, 0, 255]`, on peut écrire `include: blue` à la place.
 296
 297     :::yaml
 298     aliases:
 299       long_time:
 300         duration: 42
 301
 302     keys:
 303       'b':
 304         wait:
 305           include: long_time
 306         play:
 307           file: "music1.mp3"
 308
 309 `long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration: 42`, on peut écrire `include: long_time`.
 310
 311 ## Problèmes possibles
 312
 313 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.
 314
 315  * Le programme se lance et s'arrête tout de suite.
 316
 317 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).
 318
 319  * La musique "grésille" affreusement.
 320
 321 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)
 322
 323   * Impossible de jouer plus d'une musique à la fois.
 324
 325 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).
 326
 327 Si votre système utilise PulseAudio, il peut s'agir d'un problème de configuration du plugin ALSA. Dans ce cas, essayez de mettre la configuration suivante dans `/etc/asound.conf`, puis redémarrer la machine (solution empirique qui semble avoir fonctionné, sans garantie !):
 328
 329     pcm.!default {
 330       type pulse
 331       fallback "sysdefault"
 332       hint {
 333         show on
 334         description "Default ALSA Output (currently PulseAudio Sound Server)"
 335       }
 336     }
 337
 338     ctl.!default {
 339       type pulse
 340       fallback "sysdefault"
 341     }
 342
 343   * Pour d'autres problèmes ou bugs à reporter, voir le [Bug Tracker](https://git.immae.eu/mantisbt/view_all_bug_page.php?project_id=1)
 344 ## Divers
 345
 346 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 :
 347
 348 [Short Blues](https://www.jamendo.com/track/340173/short-blues)
 349
 350 [To the Fantasy war](https://www.jamendo.com/track/778560/to-the-fantasy-war)
 351
 352 Le bruit de crocodile provient de [Universal-Soundbank](http://www.universal-soundbank.com/).
 353
 354 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).